man/systemd.scope.xml

   1 <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4
   5 <!--
   6   SPDX-License-Identifier: LGPL-2.1+
   7
   8   Copyright © 2013 Zbigniew Jędrzejewski-Szmek
   9 -->
  10
  11 <refentry id="systemd.scope">
  12   <refentryinfo>
  13     <title>systemd.scope</title>
  14     <productname>systemd</productname>
  15
  16     <authorgroup>
  17       <author>
  18         <contrib>Developer</contrib>
  19         <firstname>Lennart</firstname>
  20         <surname>Poettering</surname>
  21         <email>lennart@poettering.net</email>
  22       </author>
  23     </authorgroup>
  24   </refentryinfo>
  25
  26   <refmeta>
  27     <refentrytitle>systemd.scope</refentrytitle>
  28     <manvolnum>5</manvolnum>
  29   </refmeta>
  30
  31   <refnamediv>
  32     <refname>systemd.scope</refname>
  33     <refpurpose>Scope unit configuration</refpurpose>
  34   </refnamediv>
  35
  36   <refsynopsisdiv>
  37     <para><filename><replaceable>scope</replaceable>.scope</filename></para>
  38   </refsynopsisdiv>
  39
  40   <refsect1>
  41     <title>Description</title>
  42
  43     <para>Scope units are not configured via unit configuration files,
  44     but are only created programmatically using the bus interfaces of
  45     systemd. They are named similar to filenames. A unit whose name
  46     ends in <literal>.scope</literal> refers to a scope unit. Scopes
  47     units manage a set of system processes. Unlike service units, scope
  48     units manage externally created processes, and do not fork off
  49     processes on its own.</para>
  50
  51     <para>The main purpose of scope units is grouping worker processes
  52     of a system service for organization and for managing resources.</para>
  53
  54     <para><command>systemd-run <option>--scope</option></command> may
  55     be used to easily launch a command in a new scope unit from the
  56     command line.</para>
  57
  58     <para>See the <ulink
  59     url="https://www.freedesktop.org/wiki/Software/systemd/ControlGroupInterface/">New
  60     Control Group Interfaces</ulink> for an introduction on how to make
  61     use of scope units from programs.</para>
  62   </refsect1>
  63
  64   <refsect1>
  65     <title>Automatic Dependencies</title>
  66
  67     <refsect2>
  68       <title>Implicit Dependencies</title>
  69
  70       <para>Implicit dependencies may be added as result of
  71       resource control parameters as documented in
  72       <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
  73     </refsect2>
  74
  75     <refsect2>
  76       <title>Default Dependencies</title>
  77
  78       <para>The following dependencies are added unless
  79       <varname>DefaultDependencies=no</varname> is set:</para>
  80
  81       <itemizedlist>
  82         <listitem><para>Scope units will automatically have dependencies of
  83         type <varname>Conflicts=</varname> and
  84         <varname>Before=</varname> on
  85         <filename>shutdown.target</filename>. These ensure
  86         that scope units are removed prior to system
  87         shutdown. Only scope units involved with early boot or
  88         late system shutdown should disable
  89         <varname>DefaultDependencies=</varname> option.</para></listitem>
  90       </itemizedlist>
  91     </refsect2>
  92   </refsect1>
  93
  94   <refsect1>
  95     <title>See Also</title>
  96     <para>
  97       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  98       <citerefentry><refentrytitle>systemd-run</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  99       <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 100       <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 101       <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 102       <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>.
 103     </para>
 104   </refsect1>
 105
 106 </refentry>