journalctl: unify ellipsation handling between journalctl and systemctl

[elogind.git] / man / systemd.service.xml

diff --git a/man/systemd.service.xml b/man/systemd.service.xml
index f43201dc7e9b9501a1f36631d657c63ce846a75f..59ecf810fb82bebeb1497848df55ba27fe6a52b1 100644 (file)
--- a/man/systemd.service.xml
+++ b/man/systemd.service.xml
@@ -160,7 +160,7 @@
                                 complete and all communication
                                 channels set up. The child continues
                                 to run as the main daemon
                                 complete and all communication
                                 channels set up. The child continues
                                 to run as the main daemon

-                                process. This is the behaviour of
+                                process. This is the behavior of

                                 traditional UNIX daemons. If this
                                 setting is used, it is recommended to
                                 also use the
                                 traditional UNIX daemons. If this
                                 setting is used, it is recommended to
                                 also use the


@@ -171,7 +171,7 @@
                                 soon as the parent process
                                 exits.</para>
 
                                 soon as the parent process
                                 exits.</para>
 

-                                <para>Behaviour of
+                                <para>Behavior of

                                 <option>oneshot</option> is similar
                                 to <option>simple</option>, however
                                 it is expected that the process has to
                                 <option>oneshot</option> is similar
                                 to <option>simple</option>, however
                                 it is expected that the process has to


@@ -180,7 +180,7 @@
                                 is particularly useful for this type
                                 of service.</para>
 
                                 is particularly useful for this type
                                 of service.</para>
 

-                                <para>Behaviour of
+                                <para>Behavior of

                                 <option>dbus</option> is similar to
                                 <option>simple</option>, however it is
                                 expected that the daemon acquires a
                                 <option>dbus</option> is similar to
                                 <option>simple</option>, however it is
                                 expected that the daemon acquires a


@@ -197,7 +197,7 @@
                                 <varname>BusName=</varname> is
                                 specified.</para>
 
                                 <varname>BusName=</varname> is
                                 specified.</para>
 

-                                <para>Behaviour of
+                                <para>Behavior of

                                 <option>notify</option> is similar to
                                 <option>simple</option>, however it is
                                 expected that the daemon sends a
                                 <option>notify</option> is similar to
                                 <option>simple</option>, however it is
                                 expected that the daemon sends a


@@ -216,7 +216,7 @@
                                 not set, it will be implicitly set to
                                 <option>main</option>.</para>
 
                                 not set, it will be implicitly set to
                                 <option>main</option>.</para>
 

-                                <para>Behaviour of
+                                <para>Behavior of

                                 <option>idle</option> is very similar
                                 to <option>simple</option>, however
                                 actual execution of a the service
                                 <option>idle</option> is very similar
                                 to <option>simple</option>, however
                                 actual execution of a the service


@@ -356,16 +356,32 @@
                                 argument (i.e. the program to execute)
                                 may not be a variable, and must be a
                                 literal and absolute path
                                 argument (i.e. the program to execute)
                                 may not be a variable, and must be a
                                 literal and absolute path

-                                name.</para></listitem>
+                                name.</para>
+
+                                <para>Note that this setting does not
+                                directly support shell command
+                                lines. If shell command lines are to
+                                be used they need to be passed
+                                explicitly to a shell implementation
+                                of some kind. Example:
+                                <literal>ExecStart=/bin/sh -c 'dmesg | tac'</literal></para>
+
+                                <para>For services run by a user
+                                instance of systemd the special
+                                environment variable
+                                <literal>MANAGERPID</literal> is set
+                                to the PID of the systemd
+                                instance.</para>
+                                </listitem>

                         </varlistentry>
 
                         <varlistentry>
                                 <term><varname>ExecStartPre=</varname></term>
                                 <term><varname>ExecStartPost=</varname></term>
                                 <listitem><para>Additional commands
                         </varlistentry>
 
                         <varlistentry>
                                 <term><varname>ExecStartPre=</varname></term>
                                 <term><varname>ExecStartPost=</varname></term>
                                 <listitem><para>Additional commands

-                                that are executed before (resp. after)
+                                that are executed before or after

                                 the command in
                                 the command in

-                                <varname>ExecStart=</varname>. Multiple
+                                <varname>ExecStart=</varname>, respectively. Multiple

                                 command lines may be concatenated in a
                                 single directive, by separating them
                                 by semicolons (these semicolons must
                                 command lines may be concatenated in a
                                 single directive, by separating them
                                 by semicolons (these semicolons must


@@ -398,12 +414,12 @@
                                 variable substitution is supported
                                 here following the same scheme as for
                                 <varname>ExecStart=</varname>. One
                                 variable substitution is supported
                                 here following the same scheme as for
                                 <varname>ExecStart=</varname>. One

-                                special environment variable is set:
-                                if known <literal>$MAINPID</literal> is
-                                set to the main process of the
-                                daemon, and may be used for command
-                                lines like the following:
-                                <command>/bin/kill -HUP
+                                additional special environment
+                                variables is set: if known
+                                <literal>$MAINPID</literal> is set to
+                                the main process of the daemon, and
+                                may be used for command lines like the
+                                following: <command>/bin/kill -HUP

                                 $MAINPID</command>.</para></listitem>
                         </varlistentry>
 
                                 $MAINPID</command>.</para></listitem>
                         </varlistentry>
 


@@ -463,27 +479,49 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term><varname>TimeoutSec=</varname></term>
+                                <term><varname>TimeoutStartSec=</varname></term>

                                 <listitem><para>Configures the time to
                                 <listitem><para>Configures the time to

-                                wait for start-up and stop. If a
+                                wait for start-up. If a

                                 daemon service does not signal
                                 start-up completion within the
                                 daemon service does not signal
                                 start-up completion within the

-                                configured time the service will be
+                                configured time, the service will be

                                 considered failed and be shut down
                                 considered failed and be shut down

-                                again. If a service is asked to stop
-                                but does not terminate in the
-                                specified time it will be terminated
+                                again.
+                                Takes a unit-less value in seconds, or a
+                                time span value such as "5min
+                                20s". Pass 0 to disable the timeout
+                                logic. Defaults to 90s, except when
+                                <varname>Type=oneshot</varname> is
+                                used in which case the timeout
+                                is disabled by default.
+                                </para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><varname>TimeoutStopSec=</varname></term>
+                                <listitem><para>Configures the time to
+                                wait for stop. If a service is asked
+                                to stop but does not terminate in the
+                                specified time, it will be terminated

                                 forcibly via SIGTERM, and after
                                 another delay of this time with
                                 forcibly via SIGTERM, and after
                                 another delay of this time with

-                                SIGKILL. (See
+                                SIGKILL (See

                                 <varname>KillMode=</varname>
                                 <varname>KillMode=</varname>

-                                in <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>) Takes a unit-less value in seconds, or a
+                                in <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
+                                Takes a unit-less value in seconds, or a

                                 time span value such as "5min
                                 20s". Pass 0 to disable the timeout
                                 time span value such as "5min
                                 20s". Pass 0 to disable the timeout

-                                logic. Defaults to
-                                90s, except when <varname>Type=oneshot</varname> is
-                                used in which case the timeout
-                                is disabled by default.</para></listitem>
+                                logic. Defaults to 90s.
+                                </para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><varname>TimeoutSec=</varname></term>
+                                <listitem><para>A shorthand for configuring
+                                both <varname>TimeoutStartSec=</varname>
+                                and <varname>TimeoutStopSec=</varname>
+                                to the specified value.
+                                </para></listitem>

                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>


@@ -557,6 +595,49 @@
                                 hit a timeout.</para></listitem>
                         </varlistentry>
 
                                 hit a timeout.</para></listitem>
                         </varlistentry>
 

+                        <varlistentry>
+                                <term><varname>SuccessExitStatus=</varname></term>
+                                <listitem><para>Takes a list of exit
+                                status definitions that when returned
+                                by the main service process will be
+                                considered successful termination, in
+                                addition to the normal successful exit
+                                code 0 and the signals SIGHUP, SIGINT,
+                                SIGTERM and SIGPIPE. Exit status
+                                definitions can either be numeric exit
+                                codes or termination signal names, and
+                                are separated by spaces. Example:
+                                "<literal>SuccessExitStatus=1 2 8
+                                SIGKILL</literal>", ensures that exit
+                                codes 1, 2, 8 and the termination
+                                signal SIGKILL are considered clean
+                                service
+                                terminations.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><varname>RestartPreventExitStatus=</varname></term>
+                                <listitem><para>Takes a list of exit
+                                status definitions that when returned
+                                by the main service process will
+                                prevent automatic service restarts
+                                regardless of the restart setting
+                                configured with
+                                <varname>Restart=</varname>. Exit
+                                status definitions can either be
+                                numeric exit codes or termination
+                                signal names, and are separated by
+                                spaces. Defaults to the empty list, so
+                                that by default no exit status is
+                                excluded from the configured restart
+                                logic. Example:
+                                "<literal>RestartPreventExitStatus=1 6
+                                SIGABRT</literal>", ensures that exit
+                                codes 1 and 6 and the termination signal
+                                SIGABRT will not result in automatic
+                                service restarting.</para></listitem>
+                        </varlistentry>
+

                         <varlistentry>
                                 <term><varname>PermissionsStartOnly=</varname></term>
                                 <listitem><para>Takes a boolean
                         <varlistentry>
                                 <term><varname>PermissionsStartOnly=</varname></term>
                                 <listitem><para>Takes a boolean