chiark / gitweb /
path: simplify recheck logic
[elogind.git] / man / systemctl.xml
index 10e0f82441368eb8460b260e7692fbbb96963bd5..e9e3371ba8d00e6c1613aa28be77369f54b2b953 100644 (file)
@@ -44,7 +44,7 @@
 
         <refnamediv>
                 <refname>systemctl</refname>
-                <refpurpose>Control the systemd system and session manager</refpurpose>
+                <refpurpose>Control the systemd system and service manager</refpurpose>
         </refnamediv>
 
         <refsynopsisdiv>
@@ -59,7 +59,7 @@
                 <para><command>systemctl</command> may be used to
                 introspect and control the state of the
                 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
-                system and session manager.</para>
+                system and service manager.</para>
         </refsect1>
 
         <refsect1>
                                 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>
 
                                 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>
                                 <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>
                                 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>
 
                         <varlistentry>
-                                <term><option>--session</option></term>
+                                <term><option>--user</option></term>
 
                                 <listitem><para>Talk to the systemd
-                                session manager of the calling user.</para></listitem>
+                                manager of the calling user.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
                                 <listitem><para>When used with
                                 <command>enable</command> and
                                 <command>disable</command>, operate on the
-                                global session configuĊ•ation
+                                global user configuration
                                 directory, thus enabling or disabling
                                 a unit file globally for all future
-                                sessions of all users.</para></listitem>
+                                logins of all users.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
                                 <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
                                 <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
-                                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>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>
-                                <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
-                                know signal specifiers such as
+                                known signal specifiers such as
                                 SIGTERM, SIGINT or SIGSTOP. If
-                                ommitted defaults to
+                                omitted defaults to
                                 <option>SIGTERM</option>.</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>
 
                                 <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>
+
+                                <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,
-                                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>
                                 <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
                                 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
 
                                 <para>Depending on whether
                                 <option>--system</option>,
-                                <option>--session</option> or
+                                <option>--user</option> or
                                 <option>--global</option> is specified
                                 this enables the unit for the system,
-                                for sessions of the calling user only
-                                or for all future session of all
+                                for the calling user only
+                                or for all future logins of all
                                 users. Note that in the latter case no
                                 systemd daemon configuration is
                                 reloaded.</para>
                                 <option>--quiet</option>.</para>
                                 </listitem>
 
-                                <para>This command honours
+                                <para>This command honors
                                 <option>--system</option>,
-                                <option>--session</option>,
+                                <option>--user</option>,
                                 <option>--global</option> in a similar
                                 way as
                                 <command>enable</command>.</para>
                                 <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>
 
                                 <para>A snapshot refers to a saved
                                 state of the systemd manager. It is
-                                implemented itself as unit that is
+                                implemented itself as unit that is
                                 generated dynamically with this
                                 command and has dependencies on all
                                 units active at the time. At a later
                                 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>
                                 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>
                                 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>
                                 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>
 
                                 <listitem><para>Ask the systemd
                                 manager to quit. This is only
-                                supported for session managers
+                                supported for user service managers
                                 (i.e. in conjunction with the
-                                <option>--session</option> option) and
+                                <option>--user</option> option) and
                                 will fail otherwise.</para></listitem>
                         </varlistentry>
                 </variablelist>