Commit 62adf224 authored by Lennart Poettering's avatar Lennart Poettering

man: various man page updates

parent af65a091
This diff is collapsed.
......@@ -87,6 +87,17 @@
<para>If an path unit is beneath another mount
point in the file system hierarchy, a dependency
between both units is created automatically.</para>
<para>Unless <varname>DefaultDependencies=</varname>
is set to <option>false</option>, path units will
implicitly have dependencies of type
<varname>Conflicts=</varname> and
<varname>Before=</varname> on
<filename>shutdown.target</filename>. These ensure
that path units are terminated cleanly prior to system
shutdown. Only path units involved with early boot or
late system shutdown should disable this
option.</para>
</refsect1>
<refsect1>
......
......@@ -64,27 +64,44 @@
<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for the common options of all unit configuration
files. The common configuration items are configured
in the generic [Unit] and [Install] sections. The
service specific configuration options are configured
in the [Service] section.</para>
in the generic <literal>[Unit]</literal> and
<literal>[Install]</literal> sections. The service
specific configuration options are configured in the
<literal>[Service]</literal> section.</para>
<para>Additional options are listed in
<citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
which define the execution environment the commands
are executed in.</para>
<para>Unless <varname>DefaultDependencies=</varname>
is set to <option>false</option>, service units will
implicitly have dependencies of type
<varname>Requires=</varname> and
<varname>After=</varname> on
<filename>basic.target</filename> as well as
dependencies of type <varname>Conflicts=</varname> and
<varname>Before=</varname> on
<filename>shutdown.target</filename>. These ensure
that normal service units pull in basic system
initialization, and are terminated cleanly prior to
system shutdown. Only services involved with early
boot or late system shutdown should disable this
option.</para>
</refsect1>
<refsect1>
<title>Options</title>
<para>Service files must include a [Service] section,
which carries information about the service and the
process it supervises. A number of options that may be
used in this section are shared with other unit
types. These options are documented in
<para>Service files must include a
<literal>[Service]</literal> section, which carries
information about the service and the process it
supervises. A number of options that may be used in
this section are shared with other unit types. These
options are documented in
<citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>. The
options specific to the [Service] section of service
units are the following:</para>
options specific to the <literal>[Service]</literal>
section of service units are the following:</para>
<variablelist>
<varlistentry>
......@@ -143,14 +160,18 @@
<para>Behaviour of
<option>dbus</option> is similar to
<option>simple</option>, however it
is expected that the daemon acquires a
<option>simple</option>, however it is
expected that the daemon acquires a
name on the D-Bus bus, as configured
by
<varname>BusName=</varname>. systemd
will proceed starting follow-up units
after the D-Bus bus name has been
acquired.</para>
acquired. Service units with this
option configured implicitly have
dependencies on the
<filename>dbus.target</filename>
unit.</para>
<para>Behaviour of
<option>notify</option> is similar to
......@@ -163,10 +184,13 @@
starting follow-up units after this
notification message has been sent. If
this option is used
<option>NotifyAccess=</option> (see
<varname>NotifyAccess=</varname> (see
below) must be set to open access to
the notification socket provided by
systemd.</para>
systemd. If
<varname>NotifyAccess=</varname> is not
set, it will be implicitly set to
<option>main</option>.</para>
</listitem>
</varlistentry>
......@@ -220,11 +244,12 @@
services. This option may not be
specified more than once. Optionally,
if the absolute file name is prefixed
with @, the second token will be
passed as argv[0] to the executed
process, followed by the further
arguments specified. Unless
<option>Type=forking</option> is set,
with <literal>@</literal>, the second
token will be passed as
<literal>argv[0]</literal> to the
executed process, followed by the
further arguments specified. Unless
<varname>Type=forking</varname> is set,
the process started via this command
line will be considered the main
process of the
......@@ -312,7 +337,7 @@
forcibly via SIGTERM, and after
another delay of this time with
SIGKILL. (See
<option>KillMode=</option>
<varname>KillMode=</varname>
below.) Takes a unit-less value in seconds, or a
time span value such as "5min
20s". Pass 0 to disable the timeout
......@@ -450,7 +475,7 @@
<para>Processes will first be
terminated via SIGTERM. If then after
a delay (configured via the
<option>TimeoutSec=</option> option)
<varname>TimeoutSec=</varname> option)
processes still remain, the
termination request is repeated with
the SIGKILL signal. See
......
......@@ -95,6 +95,21 @@
which services are instantiated for each incoming
connection.</para>
<para>Unless <varname>DefaultDependencies=</varname>
is set to <option>false</option>, socket units will
implicitly have dependencies of type
<varname>Requires=</varname> and
<varname>After=</varname> on
<filename>sysinit.target</filename> as well as
dependencies of type <varname>Conflicts=</varname> and
<varname>Before=</varname> on
<filename>shutdown.target</filename>. These ensure
that socket units pull in basic system
initialization, and are terminated cleanly prior to
system shutdown. Only sockets involved with early
boot or late system shutdown should disable this
option.</para>
<para>Socket units may be used to implement on-demand
starting of services, as well as parallelized starting
of services.</para>
......
......@@ -51,6 +51,7 @@
<para><filename>basic.target</filename>,
<filename>ctrl-alt-del.target</filename>,
<filename>@SPECIAL_DBUS_SERVICE@</filename>,
<filename>dbus.target</filename>,
<filename>default.target</filename>,
<filename>display-manager.service</filename>,
<filename>emergency.service</filename>,
......@@ -78,8 +79,8 @@
<filename>sockets.target</filename>,
<filename>swap.target</filename>,
<filename>sysinit.target</filename>,
<filename>syslog.target</filename>,
<filename>@SPECIAL_SYSLOG_SERVICE@</filename>,
<filename>syslog.target</filename>,
<filename>systemd-initctl.service</filename>,
<filename>systemd-initctl.socket</filename>,
<filename>systemd-logger.service</filename>,
......@@ -141,6 +142,28 @@
up systemd will connect to it
and register its
service.</para>
<para>Units should generally
avoid depending on this unit
directly and instead refer to
the
<filename>dbus.target</filename>
unit instead, which pulls this
one in directly or indirectly
via socket-based activation.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>dbus.target</filename></term>
<listitem>
<para>Administrators should
ensure that this target pulls
in a service unit with the
name or alias of
<filename>@SPECIAL_DBUS_SERVICE@</filename>
(or a socket unit that
activates this
service).</para>
</listitem>
</varlistentry>
<varlistentry>
......@@ -522,28 +545,6 @@
files.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>syslog.target</filename></term>
<listitem>
<para>systemd automatically
adds dependencies of type
After for this target unit to
all SysV init script service
units with an LSB header
referring to the
<literal>$syslog</literal>
facility.</para>
<para>Administrators should
ensure that this target pulls
in a service unit with the
name or alias of
<filename>@SPECIAL_SYSLOG_SERVICE@</filename>
(or a socket unit that
activates this
service).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>sysinit.target</filename></term>
<listitem>
......@@ -571,11 +572,37 @@
and use it for logging if it
has been configured for
that.</para>
<para>Applications should
generally not depend on this
service, and depend on
<para>Units should generally
avoid depending on this unit
directly and instead refer to
the
<filename>syslog.target</filename>
instead.</para>
unit instead, which pulls this
one in directly or indirectly
via socket-based activation.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><filename>syslog.target</filename></term>
<listitem>
<para>systemd automatically
adds dependencies of type
After for this target unit to
all SysV init script service
units with an LSB header
referring to the
<literal>$syslog</literal>
facility.</para>
<para>Administrators should
ensure that this target pulls
in a service unit with the
name or alias of
<filename>@SPECIAL_SYSLOG_SERVICE@</filename>
(or a socket unit that
activates this
service).</para>
</listitem>
</varlistentry>
<varlistentry>
......
......@@ -76,12 +76,22 @@
dependencies between units. Among other things, target
units are a more flexible replacement for SysV
runlevels in the classic SysV init system. (And for
compatibility reasons there exist special
compatibility reasons special
target units such as
<filename>runlevel3.target</filename> which are used by
<filename>runlevel3.target</filename> exist which are used by
the SysV runlevel compatibility code in systemd. See
<citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>
for details).</para>
<para>Unless
<varname>DefaultDependencies=</varname> is set to
<option>false</option>, target units will
implicitly complement all configured dependencies of type
<varname>Wants=</varname>,
<varname>Requires=</varname>,
<varname>RequiresOverridable=</varname> with
dependencies of type <varname>After=</varname>.
</para>
</refsect1>
<refsect1>
......
......@@ -76,6 +76,17 @@
matching service <filename>foo.service</filename>. The
unit to activate may be controlled by
<varname>Unit=</varname> (see below).</para>
<para>Unless <varname>DefaultDependencies=</varname>
is set to <option>false</option>, timer units will
implicitly have dependencies of type
<varname>Conflicts=</varname> and
<varname>Before=</varname> on
<filename>shutdown.target</filename>. These ensure
that timer units are stopped cleanly prior to system
shutdown. Only timer units involved with early boot or
late system shutdown should disable this
option.</para>
</refsect1>
<refsect1>
......
......@@ -215,10 +215,10 @@
<varlistentry>
<term><varname>Description=</varname></term>
<listitem><para>A free-form string
describing the unit. This is intended for use
in UIs wanting to show
descriptive information along with the
unit name.</para></listitem>
describing the unit. This is intended
for use in UIs to show descriptive
information along with the unit
name.</para></listitem>
</varlistentry>
<varlistentry>
......@@ -451,6 +451,34 @@
<option>false</option>.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>DefaultDependencies=</varname></term>
<listitem><para>Takes a boolean
argument. If <option>true</option>
(the default), a few default
dependencies will implicitly be
created for the unit. The actual
dependencies created depend on the
unit type. For example, for service
units, these dependencies ensure that
the service is started only after
basic system initialization is
complete and is properly terminated on
system shutdown. See the respective
man pages for details. Generally, only
services involved with early boot or
late shutdown should set this option
to <option>false</option>. It is
highly recommended to leave this
option enabled for the majority of
common units. If set to
<option>false</option> this option
does not disable all implicit
dependencies, just non-essential
ones.</para></listitem>
</varlistentry>
</variablelist>
<para>Unit file may include a [Install] section, which
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment