path: simplify recheck logic

[elogind.git] / man / systemctl.xml

diff --git a/man/systemctl.xml b/man/systemctl.xml
index 844d218877ad37c6aea5313d221436ce4b1c364b..e9e3371ba8d00e6c1613aa28be77369f54b2b953 100644 (file)
--- a/man/systemctl.xml
+++ b/man/systemctl.xml
@@ -126,6 +126,15 @@
                                 they are set or not.</para></listitem>
                         </varlistentry>
 
                                 they are set or not.</para></listitem>
                         </varlistentry>
 

+                        <varlistentry>
+                                <term><option>--failed</option></term>
+
+                                <listitem><para>When listing units,
+                                show only failed units. Do not confuse
+                                with
+                                <option>--fail</option>.</para></listitem>
+                        </varlistentry>
+

                         <varlistentry>
                                 <term><option>--full</option></term>
 
                         <varlistentry>
                                 <term><option>--full</option></term>
 


@@ -144,7 +153,24 @@
                                 unfinished job, fail the command. If
                                 this is not specified the requested
                                 operation will replace the pending job,
                                 unfinished job, fail the command. If
                                 this is not specified the requested
                                 operation will replace the pending job,

-                                if necessary.</para></listitem>
+                                if necessary. Do not confuse
+                                with
+                                <option>--failed</option>.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--ignore-dependencies</option></term>
+
+                                <listitem><para>When enqueuing a new
+                                job ignore all its dependencies and
+                                execute it immediately. If passed no
+                                required units of the unit passed will
+                                be pulled in, and no ordering
+                                dependencies will be honoured. This is
+                                mostly a debugging and rescue tool for
+                                the administrator and should not be
+                                used by
+                                applications.</para></listitem>

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


@@ -154,7 +180,7 @@
                                 <listitem><para>Suppress output to
                                 STDOUT in
                                 <command>snapshot</command>,
                                 <listitem><para>Suppress output to
                                 STDOUT in
                                 <command>snapshot</command>,

-                                <command>check</command>,
+                                <command>is-active</command>,

                                 <command>enable</command> and
                                 <command>disable</command>.</para></listitem>
                         </varlistentry>
                                 <command>enable</command> and
                                 <command>disable</command>.</para></listitem>
                         </varlistentry>


@@ -170,6 +196,13 @@
                                 argument it is only verified and
                                 enqueued.</para></listitem> </varlistentry>
 
                                 argument it is only verified and
                                 enqueued.</para></listitem> </varlistentry>
 

+                        <varlistentry>
+                                <term><option>--no-pager</option></term>
+
+                               <listitem><para>Do not pipe output into a
+                               pager.</para></listitem>
+                       </varlistentry>
+

                         <varlistentry>
                                 <term><option>--system</option></term>
 
                         <varlistentry>
                                 <term><option>--system</option></term>
 


@@ -224,7 +257,7 @@
                                 <listitem><para>When used with
                                 <command>enable</command> and
                                 <command>disable</command>, operate on the
                                 <listitem><para>When used with
                                 <command>enable</command> and
                                 <command>disable</command>, operate on the

-                                global user configuŕation
+                                global user configuration

                                 directory, thus enabling or disabling
                                 a unit file globally for all future
                                 logins of all users.</para></listitem>
                                 directory, thus enabling or disabling
                                 a unit file globally for all future
                                 logins of all users.</para></listitem>


@@ -257,7 +290,7 @@
                                 <command>systemctl</command> will
                                 query the user on the terminal for the
                                 necessary secrets. Use this option to
                                 <command>systemctl</command> will
                                 query the user on the terminal for the
                                 necessary secrets. Use this option to

-                                switch this behaviour off. In this
+                                switch this behavior off. In this

                                 case the password must be supplied by
                                 some other means (for example
                                 graphical password agents) or the
                                 case the password must be supplied by
                                 some other means (for example
                                 graphical password agents) or the


@@ -271,13 +304,11 @@
                                 <command>kill</command>, choose the
                                 mode how to kill the selected
                                 processes. Must be one of
                                 <command>kill</command>, choose the
                                 mode how to kill the selected
                                 processes. Must be one of

-                                <option>control-group</option>,
-                                <option>process-group</option> or
+                                <option>control-group</option> or

                                 <option>process</option> to select
                                 whether to kill the entire control
                                 <option>process</option> to select
                                 whether to kill the entire control

-                                group, the process group or only the
-                                selected process itself. If ommitted
-                                defaults to
+                                group or only the selected process
+                                itself. If omitted defaults to

                                 <option>control-group</option> if
                                 <option>--kill-who=all</option> is
                                 set, or <option>process</option>
                                 <option>control-group</option> if
                                 <option>--kill-who=all</option> is
                                 set, or <option>process</option>


@@ -296,22 +327,22 @@
                                 <option>all</option> to select whether
                                 to kill only the main process of the
                                 unit, the control process or all
                                 <option>all</option> to select whether
                                 to kill only the main process of the
                                 unit, the control process or all

-                                processes of the unit. If ommitted
+                                processes of the unit. If omitted

                                 defaults to
                                 <option>all</option>.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
                                 defaults to
                                 <option>all</option>.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>

-                                <term><option>---signal=</option></term>
+                                <term><option>--signal=</option></term>

                                 <term><option>-s</option></term>
 
                                 <listitem><para>When used with
                                 <command>kill</command>, choose which
                                 signal to send to selected
                                 processes. Must be one of the well
                                 <term><option>-s</option></term>
 
                                 <listitem><para>When used with
                                 <command>kill</command>, choose which
                                 signal to send to selected
                                 processes. Must be one of the well

-                                know signal specifiers such as
+                                known signal specifiers such as

                                 SIGTERM, SIGINT or SIGSTOP. If
                                 SIGTERM, SIGINT or SIGSTOP. If

-                                ommitted defaults to
+                                omitted defaults to

                                 <option>SIGTERM</option>.</para></listitem>
                         </varlistentry>
 
                                 <option>SIGTERM</option>.</para></listitem>
                         </varlistentry>
 


@@ -349,6 +380,27 @@
                                 file that shall be
                                 disabled.</para></listitem>
                         </varlistentry>
                                 file that shall be
                                 disabled.</para></listitem>
                         </varlistentry>

+
+                        <varlistentry>
+                                <term><option>-H</option></term>
+                                <term><option>--host</option></term>
+
+                                <listitem><para>Execute operation
+                                remotely. Specifiy a hostname, or
+                                username and hostname seperated by @,
+                                to connect to. This will use SSH to
+                                talk to the remote systemd
+                                instance.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>-P</option></term>
+                                <term><option>--privileged</option></term>
+
+                                <listitem><para>Acquire privileges via
+                                PolicyKit before executing the
+                                operation.</para></listitem>
+                        </varlistentry>

                 </variablelist>
 
                 <para>The following commands are understood:</para>
                 </variablelist>
 
                 <para>The following commands are understood:</para>


@@ -414,23 +466,34 @@
 
                                 <listitem><para>Restart one or more
                                 units specified on the command
 
                                 <listitem><para>Restart one or more
                                 units specified on the command

-                                line. If the units are not running yet
-                                the operation will
-                                fail.</para></listitem>
+                                line if the units are running. Do
+                                nothing if units are not running.
+                                Note that for compatibility
+                                with Red Hat init scripts
+                                <command>condrestart</command> is
+                                equivalent to this command.</para></listitem>

                         </varlistentry>
                         <varlistentry>
                                 <term><command>reload-or-restart [NAME...]</command></term>
                         </varlistentry>
                         <varlistentry>
                                 <term><command>reload-or-restart [NAME...]</command></term>

+
+                                <listitem><para>Reload one or more
+                                units if they support it. If not,
+                                restart them instead. If the units
+                                are not running yet they will be
+                                started.</para></listitem>
+                        </varlistentry>
+                        <varlistentry>

                                 <term><command>reload-or-try-restart [NAME...]</command></term>
 
                                 <listitem><para>Reload one or more
                                 units if they support it. If not,
                                 <term><command>reload-or-try-restart [NAME...]</command></term>
 
                                 <listitem><para>Reload one or more
                                 units if they support it. If not,

-                                restart them instead. Note that for
-                                compatibility with SysV and Red Hat
-                                init scripts
-                                <command>force-reload</command> and
-                                <command>condrestart</command> may be
-                                used as equivalent commands to
-                                <command>reload-or-try-restart</command>.</para></listitem>
+                                restart them instead. Do nothing if
+                                the units are not running. Note that
+                                for compatibility with SysV init
+                                scripts
+                                <command>force-reload</command> is
+                                equivalent to this
+                                command.</para></listitem>

                         </varlistentry>
                         <varlistentry>
                                 <term><command>isolate [NAME]</command></term>
                         </varlistentry>
                         <varlistentry>
                                 <term><command>isolate [NAME]</command></term>


@@ -469,7 +532,7 @@
                                 <term><command>is-active [NAME...]</command></term>
 
                                 <listitem><para>Check whether any of
                                 <term><command>is-active [NAME...]</command></term>
 
                                 <listitem><para>Check whether any of

-                                the specified units is active
+                                the specified units are active

                                 (i.e. running). Returns an exit code
                                 0 if at least one is active, non-zero
                                 otherwise. Unless
                                 (i.e. running). Returns an exit code
                                 0 if at least one is active, non-zero
                                 otherwise. Unless


@@ -569,7 +632,7 @@
                                 administrator is free to make
                                 additional changes manually, by
                                 placing or removing symlinks in the
                                 administrator is free to make
                                 additional changes manually, by
                                 placing or removing symlinks in the

-                                directory. This is particular useful
+                                directory. This is particularly useful

                                 to create configurations that deviate
                                 from the suggested default
                                 installation. In this case the
                                 to create configurations that deviate
                                 from the suggested default
                                 installation. In this case the


@@ -641,7 +704,7 @@
                                 <option>--quiet</option>.</para>
                                 </listitem>
 
                                 <option>--quiet</option>.</para>
                                 </listitem>
 

-                                <para>This command honours
+                                <para>This command honors

                                 <option>--system</option>,
                                 <option>--user</option>,
                                 <option>--global</option> in a similar
                                 <option>--system</option>,
                                 <option>--user</option>,
                                 <option>--global</option> in a similar


@@ -700,7 +763,7 @@
                                 <listitem><para>Cancel one or more
                                 jobs specified on the command line by
                                 their numeric job
                                 <listitem><para>Cancel one or more
                                 jobs specified on the command line by
                                 their numeric job

-                                IDs. If not job id is specified cancels all jobs that are pending.</para></listitem>
+                                IDs. If no job id is specified, cancel all pending jobs.</para></listitem>

                         </varlistentry>
                         <varlistentry>
                                 <term><command>monitor</command></term>
                         </varlistentry>
                         <varlistentry>
                                 <term><command>monitor</command></term>


@@ -756,7 +819,7 @@
 
                                 <para>A snapshot refers to a saved
                                 state of the systemd manager. It is
 
                                 <para>A snapshot refers to a saved
                                 state of the systemd manager. It is

-                                implemented itself as unit that is
+                                implemented itself as a unit that is

                                 generated dynamically with this
                                 command and has dependencies on all
                                 units active at the time. At a later
                                 generated dynamically with this
                                 command and has dependencies on all
                                 units active at the time. At a later


@@ -881,8 +944,8 @@
                                 users.  If
                                 combined with <option>--force</option>
                                 shutdown of all running services is
                                 users.  If
                                 combined with <option>--force</option>
                                 shutdown of all running services is

-                                skipped, however all processes killed
-                                and all file systems unmounted or
+                                skipped, however all processes are killed
+                                and all file systems are unmounted or

                                 mounted read-only, immediately
                                 followed by the
                                 system halt.</para></listitem>
                                 mounted read-only, immediately
                                 followed by the
                                 system halt.</para></listitem>


@@ -898,8 +961,8 @@
                                 users. If
                                 combined with <option>--force</option>
                                 shutdown of all running services is
                                 users. If
                                 combined with <option>--force</option>
                                 shutdown of all running services is

-                                skipped, however all processes killed
-                                and all file systems unmounted or
+                                skipped, however all processes are killed
+                                and all file systems are unmounted or

                                 mounted read-only, immediately
                                 followed by the
                                 powering off.</para></listitem>
                                 mounted read-only, immediately
                                 followed by the
                                 powering off.</para></listitem>


@@ -915,8 +978,8 @@
                                 users. If
                                 combined with <option>--force</option>
                                 shutdown of all running services is
                                 users. If
                                 combined with <option>--force</option>
                                 shutdown of all running services is

-                                skipped, however all processes killed
-                                and all file systems unmounted or
+                                skipped, however all processes are killed
+                                and all file systems are unmounted or

                                 mounted read-only, immediately
                                 followed by the
                                 reboot.</para></listitem>
                                 mounted read-only, immediately
                                 followed by the
                                 reboot.</para></listitem>


@@ -931,8 +994,8 @@
                                 a wall message to all users. If
                                 combined with <option>--force</option>
                                 shutdown of all running services is
                                 a wall message to all users. If
                                 combined with <option>--force</option>
                                 shutdown of all running services is

-                                skipped, however all processes killed
-                                and all file systems unmounted or
+                                skipped, however all processes are killed
+                                and all file systems are unmounted or

                                 mounted read-only, immediately
                                 followed by the
                                 reboot.</para></listitem>
                                 mounted read-only, immediately
                                 followed by the
                                 reboot.</para></listitem>