man/systemd.scope.xml

   1 <?xml version='1.0'?> <!--*-nxml-*-->
   2 <?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
   3 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   4 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   5
   6 <!--
   7 This file is part of systemd.
   8
   9 Copyright 2013 Zbigniew Jędrzejewski-Szmek
  10
  11 systemd is free software; you can redistribute it and/or modify it
  12 under the terms of the GNU Lesser General Public License as published by
  13 the Free Software Foundation; either version 2.1 of the License, or
  14 (at your option) any later version.
  15
  16 systemd is distributed in the hope that it will be useful, but
  17 WITHOUT ANY WARRANTY; without even the implied warranty of
  18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19 Lesser General Public License for more details.
  20
  21 You should have received a copy of the GNU Lesser General Public License
  22 along with systemd; If not, see <http://www.gnu.org/licenses/>.
  23 -->
  24
  25 <refentry id="systemd.scope">
  26   <refentryinfo>
  27     <title>systemd.scope</title>
  28     <productname>systemd</productname>
  29
  30     <authorgroup>
  31       <author>
  32         <contrib>Developer</contrib>
  33         <firstname>Lennart</firstname>
  34         <surname>Poettering</surname>
  35         <email>lennart@poettering.net</email>
  36       </author>
  37     </authorgroup>
  38   </refentryinfo>
  39
  40   <refmeta>
  41     <refentrytitle>systemd.scope</refentrytitle>
  42     <manvolnum>5</manvolnum>
  43   </refmeta>
  44
  45   <refnamediv>
  46     <refname>systemd.scope</refname>
  47     <refpurpose>Scope unit configuration</refpurpose>
  48   </refnamediv>
  49
  50   <refsynopsisdiv>
  51     <para><filename><replaceable>scope</replaceable>.scope</filename></para>
  52   </refsynopsisdiv>
  53
  54   <refsect1>
  55     <title>Description</title>
  56
  57     <para>A unit configuration file whose name ends in
  58     <literal>.scope</literal> encodes information about a unit created
  59     by systemd to encapsulate processes launched not by systemd
  60     itself. This management is performed by creating a node in the
  61     control group tree. Processes are moved into the scope by means
  62     of the DBus API.
  63     <command>systemd-run <option>--scope</option></command> can be
  64     used to easily launch a command in a new scope unit.</para>
  65
  66     <para>See
  67     <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
  68     for the common options of all unit configuration
  69     files. The common configuration items are configured
  70     in the generic [Unit] and [Install] sections. The
  71     scope specific configuration options are configured in
  72     the [Scope] section. Currently, only generic cgroup settings
  73     as described in
  74     <citerefentry><refentrytitle>systemd.cgroup</refentrytitle><manvolnum>7</manvolnum></citerefentry> are allowed.
  75     </para>
  76
  77     <para>Unless <varname>DefaultDependencies=false</varname>
  78     is used, scope units will implicitly have dependencies of
  79     type <varname>Conflicts=</varname> and
  80     <varname>Before=</varname> on
  81     <filename>shutdown.target</filename>. These ensure
  82     that scope units are removed prior to system
  83     shutdown. Only scope units involved with early boot or
  84     late system shutdown should disable this option.
  85     </para>
  86   </refsect1>
  87
  88   <refsect1>
  89     <title>See Also</title>
  90     <para>
  91       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  92       <citerefentry><refentrytitle>systemd-run</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  93       <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
  94       <citerefentry><refentrytitle>systemd.cgroup</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
  95       <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
  96       <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>.
  97     </para>
  98   </refsect1>
  99
 100 </refentry>