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