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