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   This file is part of systemd.
   7
   8   Copyright 2013 Zbigniew Jędrzejewski-Szmek
   9
  10   systemd is free software; you can redistribute it and/or modify it
  11   under the terms of the GNU Lesser General Public License as published by
  12   the Free Software Foundation; either version 2.1 of the License, or
  13   (at your option) any later version.
  14
  15   systemd is distributed in the hope that it will be useful, but
  16   WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18   Lesser General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public License
  21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  22 -->
  23
  24 <refentry id="systemd.scope">
  25   <refentryinfo>
  26     <title>systemd.scope</title>
  27     <productname>systemd</productname>
  28
  29     <authorgroup>
  30       <author>
  31         <contrib>Developer</contrib>
  32         <firstname>Lennart</firstname>
  33         <surname>Poettering</surname>
  34         <email>lennart@poettering.net</email>
  35       </author>
  36     </authorgroup>
  37   </refentryinfo>
  38
  39   <refmeta>
  40     <refentrytitle>systemd.scope</refentrytitle>
  41     <manvolnum>5</manvolnum>
  42   </refmeta>
  43
  44   <refnamediv>
  45     <refname>systemd.scope</refname>
  46     <refpurpose>Scope unit configuration</refpurpose>
  47   </refnamediv>
  48
  49   <refsynopsisdiv>
  50     <para><filename><replaceable>scope</replaceable>.scope</filename></para>
  51   </refsynopsisdiv>
  52
  53   <refsect1>
  54     <title>Description</title>
  55
  56     <para>Scope units are not configured via unit configuration files,
  57     but are only created programmatically using the bus interfaces of
  58     systemd. They are named similar to filenames. A unit whose name
  59     ends in <literal>.scope</literal> refers to a scope unit. Scopes
  60     units manage a set of system processes. Unlike service units, scope
  61     units manage externally created processes, and do not fork off
  62     processes on its own.</para>
  63
  64     <para>The main purpose of scope units is grouping worker processes
  65     of a system service for organization and for managing resources.</para>
  66
  67     <para><command>systemd-run <option>--scope</option></command> may
  68     be used to easily launch a command in a new scope unit from the
  69     command line.</para>
  70
  71     <para>See the <ulink
  72     url="https://www.freedesktop.org/wiki/Software/systemd/ControlGroupInterface/">New
  73     Control Group Interfaces</ulink> for an introduction on how to make
  74     use of scope units from programs.</para>
  75   </refsect1>
  76
  77   <refsect1>
  78     <title>Automatic Dependencies</title>
  79
  80     <para>Unless <varname>DefaultDependencies=false</varname>
  81     is used, scope units will implicitly have dependencies of
  82     type <varname>Conflicts=</varname> and
  83     <varname>Before=</varname> on
  84     <filename>shutdown.target</filename>. These ensure
  85     that scope units are removed prior to system
  86     shutdown. Only scope units involved with early boot or
  87     late system shutdown should disable this option.
  88     </para>
  89
  90     <para>Additional implicit dependencies may be added as result of
  91     resource control parameters as documented in
  92     <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
  93
  94   </refsect1>
  95
  96   <refsect1>
  97     <title>See Also</title>
  98     <para>
  99       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 100       <citerefentry><refentrytitle>systemd-run</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 101       <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 102       <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 103       <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 104       <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>.
 105     </para>
 106   </refsect1>
 107
 108 </refentry>