systemctl: Add SYSTEMD_PAGER for setting the pager to use in systemctl

[elogind.git] / man / systemctl.xml

diff --git a/man/systemctl.xml b/man/systemctl.xml
index 2fa448874b279baee35a91a15725dce470a641e7..2fd2b7bd7819a0e5474b9cf584096de60ba5f72e 100644 (file)
--- a/man/systemctl.xml
+++ b/man/systemctl.xml
@@ -44,7 +44,7 @@
 
         <refnamediv>
                 <refname>systemctl</refname>
 
         <refnamediv>
                 <refname>systemctl</refname>

-                <refpurpose>Control the systemd system and session manager</refpurpose>
+                <refpurpose>Control the systemd system and service manager</refpurpose>

         </refnamediv>
 
         <refsynopsisdiv>
         </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>
                 <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>
         </refsect1>
 
         <refsect1>


@@ -76,6 +76,13 @@
                                 text and exits.</para></listitem>
                         </varlistentry>
 
                                 text and exits.</para></listitem>
                         </varlistentry>
 

+                        <varlistentry>
+                                <term><option>--version</option></term>
+
+                                <listitem><para>Prints a short version
+                                string and exits.</para></listitem>
+                        </varlistentry>
+

                         <varlistentry>
                                 <term><option>--type=</option></term>
                                 <term><option>-t</option></term>
                         <varlistentry>
                                 <term><option>--type=</option></term>
                                 <term><option>-t</option></term>


@@ -119,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>
 


@@ -137,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>


@@ -147,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>


@@ -163,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>
 


@@ -171,10 +211,10 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term><option>--session</option></term>
+                                <term><option>--user</option></term>

 
                                 <listitem><para>Talk to the systemd
 
                                 <listitem><para>Talk to the systemd

-                                session manager of the calling user.</para></listitem>
+                                manager of the calling user.</para></listitem>

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


@@ -217,10 +257,10 @@
                                 <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 session configuŕation
+                                global user configuration

                                 directory, thus enabling or disabling
                                 a unit file globally for all future
                                 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>
                         </varlistentry>
 
                         <varlistentry>


@@ -234,6 +274,29 @@
                                 changes.</para></listitem>
                         </varlistentry>
 
                                 changes.</para></listitem>
                         </varlistentry>
 

+                        <varlistentry>
+                                <term><option>--no-ask-password</option></term>
+
+                                <listitem><para>When used with
+                                <command>start</command> and related
+                                commands, disables asking for
+                                passwords. Background services may
+                                require input of a password or
+                                passphrase string, for example to
+                                unlock system hard disks or
+                                cryptographic certificates. Unless
+                                this option is specified and the
+                                command is invoked from a terminal
+                                <command>systemctl</command> will
+                                query the user on the terminal for the
+                                necessary secrets. Use this option to
+                                switch this behavior off. In this
+                                case the password must be supplied by
+                                some other means (for example
+                                graphical password agents) or the
+                                service might fail.</para></listitem>
+                        </varlistentry>
+

                         <varlistentry>
                                 <term><option>--kill-mode=</option></term>
 
                         <varlistentry>
                                 <term><option>--kill-mode=</option></term>
 


@@ -241,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>


@@ -266,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>
 


@@ -319,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. Specify a hostname, or
+                                username and hostname separated 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>


@@ -384,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>


@@ -439,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


@@ -539,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


@@ -568,11 +661,11 @@
 
                                 <para>Depending on whether
                                 <option>--system</option>,
 
                                 <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,
                                 <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>
                                 users. Note that in the latter case no
                                 systemd daemon configuration is
                                 reloaded.</para>


@@ -611,9 +704,9 @@
                                 <option>--quiet</option>.</para>
                                 </listitem>
 
                                 <option>--quiet</option>.</para>
                                 </listitem>
 

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

                                 <option>--system</option>,
                                 <option>--system</option>,

-                                <option>--session</option>,
+                                <option>--user</option>,

                                 <option>--global</option> in a similar
                                 way as
                                 <command>enable</command>.</para>
                                 <option>--global</option> in a similar
                                 way as
                                 <command>enable</command>.</para>


@@ -670,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>


@@ -726,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


@@ -781,16 +874,6 @@
                                 configuration will stay
                                 accessible.</para></listitem>
                         </varlistentry>
                                 configuration will stay
                                 accessible.</para></listitem>
                         </varlistentry>

-                        <varlistentry>
-                                <term><command>daemon-exit</command></term>
-
-                                <listitem><para>Ask the systemd
-                                manager to quit. This is only
-                                supported for session managers
-                                (i.e. in conjunction with the
-                                <option>--session</option> option) and
-                                will fail otherwise.</para></listitem>
-                        </varlistentry>

                         <varlistentry>
                                 <term><command>show-environment</command></term>
 
                         <varlistentry>
                                 <term><command>show-environment</command></term>
 


@@ -823,7 +906,34 @@
                                 is only removed if it has the
                                 specified value.</para></listitem>
                         </varlistentry>
                                 is only removed if it has the
                                 specified value.</para></listitem>
                         </varlistentry>

+                        <varlistentry>
+                                <term><command>default</command></term>

 
 

+                                <listitem><para>Enter default
+                                mode. This is mostly equivalent to
+                                <command>start
+                                default.target</command>.</para></listitem>
+                        </varlistentry>
+                        <varlistentry>
+                                <term><command>rescue</command></term>
+
+                                <listitem><para>Enter rescue
+                                mode. This is mostly equivalent to
+                                <command>isolate
+                                rescue.target</command> but also
+                                prints a wall message to all
+                                users.</para></listitem>
+                        </varlistentry>
+                        <varlistentry>
+                                <term><command>emergency</command></term>
+
+                                <listitem><para>Enter emergency
+                                mode. This is mostly equivalent to
+                                <command>isolate
+                                emergency.target</command> but also
+                                prints a wall message to all
+                                users.</para></listitem>
+                        </varlistentry>

                         <varlistentry>
                                 <term><command>halt</command></term>
 
                         <varlistentry>
                                 <term><command>halt</command></term>
 


@@ -831,7 +941,14 @@
                                 system. This is mostly equivalent to
                                 <command>start halt.target</command>
                                 but also prints a wall message to all
                                 system. This is mostly equivalent to
                                 <command>start halt.target</command>
                                 but also prints a wall message to all

-                                users.</para></listitem>
+                                users.  If
+                                combined with <option>--force</option>
+                                shutdown of all running services is
+                                skipped, however all processes are killed
+                                and all file systems are unmounted or
+                                mounted read-only, immediately
+                                followed by the
+                                system halt.</para></listitem>

                         </varlistentry>
                         <varlistentry>
                                 <term><command>poweroff</command></term>
                         </varlistentry>
                         <varlistentry>
                                 <term><command>poweroff</command></term>


@@ -841,7 +958,14 @@
                                 equivalent to <command>start
                                 poweroff.target</command> but also
                                 prints a wall message to all
                                 equivalent to <command>start
                                 poweroff.target</command> but also
                                 prints a wall message to all

-                                users.</para></listitem>
+                                users. If
+                                combined with <option>--force</option>
+                                shutdown of all running services is
+                                skipped, however all processes are killed
+                                and all file systems are unmounted or
+                                mounted read-only, immediately
+                                followed by the
+                                powering off.</para></listitem>

                         </varlistentry>
                         <varlistentry>
                                 <term><command>reboot</command></term>
                         </varlistentry>
                         <varlistentry>
                                 <term><command>reboot</command></term>


@@ -851,35 +975,40 @@
                                 equivalent to <command>start
                                 reboot.target</command> but also
                                 prints a wall message to all
                                 equivalent to <command>start
                                 reboot.target</command> but also
                                 prints a wall message to all

-                                users.</para></listitem>
-                        </varlistentry>
-                        <varlistentry>
-                                <term><command>default</command></term>
-
-                                <listitem><para>Enter default
-                                mode. This is mostly equivalent to
-                                <command>start
-                                default.target</command>.</para></listitem>
+                                users. If
+                                combined with <option>--force</option>
+                                shutdown of all running services is
+                                skipped, however all processes are killed
+                                and all file systems are unmounted or
+                                mounted read-only, immediately
+                                followed by the
+                                reboot.</para></listitem>

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

-                                <term><command>rescue</command></term>
+                                <term><command>kexec</command></term>

 
 

-                                <listitem><para>Enter rescue
-                                mode. This is mostly equivalent to
-                                <command>isolate
-                                rescue.target</command> but also
-                                prints a wall message to all
-                                users.</para></listitem>
+                                <listitem><para>Shut down and reboot
+                                the system via kexec. This is mostly
+                                equivalent to <command>start
+                                kexec.target</command> but also prints
+                                a wall message to all users. If
+                                combined with <option>--force</option>
+                                shutdown of all running services is
+                                skipped, however all processes are killed
+                                and all file systems are unmounted or
+                                mounted read-only, immediately
+                                followed by the
+                                reboot.</para></listitem>

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

-                                <term><command>emergency</command></term>
+                                <term><command>exit</command></term>

 
 

-                                <listitem><para>Enter emergency
-                                mode. This is mostly equivalent to
-                                <command>isolate
-                                emergency.target</command> but also
-                                prints a wall message to all
-                                users.</para></listitem>
+                                <listitem><para>Ask the systemd
+                                manager to quit. This is only
+                                supported for user service managers
+                                (i.e. in conjunction with the
+                                <option>--user</option> option) and
+                                will fail otherwise.</para></listitem>

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


@@ -892,6 +1021,22 @@
                 code otherwise.</para>
         </refsect1>
 
                 code otherwise.</para>
         </refsect1>
 

+        <refsect1>
+                <title>Environment</title>
+
+                <variablelist>
+                        <varlistentry>
+                                <term><varname>$SYSTEMD_PAGER</varname></term>
+                                <listitem><para>Pager to use when
+                                <option>--no-pager</option> is not given;
+                                overrides <varname>$PAGER</varname>.  Setting
+                                this to an empty string or the value
+                                <literal>cat</literal> is equivalent to passing
+                                <option>--no-pager</option>.</para></listitem>
+                        </varlistentry>
+                </variablelist>
+        </refsect1>
+

         <refsect1>
                 <title>See Also</title>
                 <para>
         <refsect1>
                 <title>See Also</title>
                 <para>