chiark / gitweb /
'@' is an 'ampersat' not an 'ampersand'; let's call it 'at symbol'
[elogind.git] / man / systemctl.xml
index cdf4f5cd2901587a4f6c7cee4ff9298848f0af7d..5adee45163b3bcc61c9585ef2fb9878ec24e8290 100644 (file)
@@ -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>
                                 <term><option>-p</option></term>
 
                                 <listitem><para>When showing
                                 <term><option>-p</option></term>
 
                                 <listitem><para>When showing
-                                unit/job/manager information, limit
+                                unit/job/manager properties, limit
                                 display to certain properties as
                                 specified as argument. If not
                                 specified all set properties are
                                 display to certain properties as
                                 specified as argument. If not
                                 specified all set properties are
                                 <listitem><para>When listing units,
                                 show all units, regardless of their
                                 state, including inactive units. When
                                 <listitem><para>When listing units,
                                 show all units, regardless of their
                                 state, including inactive units. When
-                                showing unit/job/manager information,
+                                showing unit/job/manager properties,
                                 show all properties regardless whether
                                 they are set or not.</para></listitem>
                         </varlistentry>
 
                                 show all properties regardless whether
                                 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>
 
                                 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>
                                 <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>
                                 enqueued and <command>systemctl</command> will
                                 wait until it is completed. By passing this
                                 argument it is only verified and
                                 enqueued and <command>systemctl</command> will
                                 wait until it is completed. By passing this
                                 argument it is only verified and
-                                enqueued.</para></listitem> </varlistentry>
+                                enqueued.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--no-legend</option></term>
+
+                               <listitem><para>Do not print a legend, i.e.
+                                the column headers and the footer with hints.
+                               </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>
                         </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>
                                 <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>
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>
-                                <term><option>--kill-mode=</option></term>
+                                <term><option>--no-ask-password</option></term>
 
                                 <listitem><para>When used with
 
                                 <listitem><para>When used with
-                                <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>process</option> to select
-                                whether to kill the entire control
-                                group, the process group or only the
-                                selected process itself. If ommitted
-                                defaults to
-                                <option>control-group</option> if
-                                <option>--kill-who=all</option> is
-                                set, or <option>process</option>
-                                otherwise. You probably never need to
-                                use this switch.</para></listitem>
+                                <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>
                         </varlistentry>
 
                         <varlistentry>
                                 <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>
 
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>
-                                <term><option>--defaults</option></term>
+                                <term><option>--root=</option></term>
+
+                                <listitem><para>When used with
+                                <command>enable</command>/<command>disable</command>/<command>is-enabled</command> (and
+                                related commands), use alternative
+                                root path when looking for unit
+                                files.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--runtime</option></term>
 
                                 <listitem><para>When used with
 
                                 <listitem><para>When used with
-                                <command>disable</command>, ensures
-                                that only the symlinks created by
-                                <command>enable</command> are removed,
-                                not all symlinks pointing to the unit
-                                file that shall be
-                                disabled.</para></listitem>
+                                <command>enable</command>/<command>disable</command>/<command>is-enabled</command> (and related commands), make
+                                changes only temporarily, so that they
+                                are dropped on the next reboot. This
+                                will have the effect that changes are
+                                not made in subdirectories of
+                                <filename>/etc</filename> but in
+                                <filename>/run</filename>, with
+                                identical immediate effects, however,
+                                since the latter is lost on reboot,
+                                the changes are lost
+                                too.</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>
 
                         </varlistentry>
                 </variablelist>
 
 
                                 <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>
                                 <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
                                 command.</para></listitem>
                         </varlistentry>
 
                                 command.</para></listitem>
                         </varlistentry>
 
+                        <varlistentry>
+                                <term><command>list-unit-files</command></term>
+
+                                <listitem><para>List installed unit files.
+                                </para></listitem>
+                        </varlistentry>
+
                         <varlistentry>
                                 <term><command>enable [NAME...]</command></term>
 
                         <varlistentry>
                                 <term><command>enable [NAME...]</command></term>
 
                                 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
 
                                 <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>
                                 configuration directory, and hence
                                 undoes the changes made by
                                 <command>enable</command>. Note
                                 configuration directory, and hence
                                 undoes the changes made by
                                 <command>enable</command>. Note
-                                however that this by default removes
+                                however that this removes
                                 all symlinks to the unit files
                                 (i.e. including manual additions), not
                                 just those actually created by
                                 all symlinks to the unit files
                                 (i.e. including manual additions), not
                                 just those actually created by
-                                <command>enable</command>. If only the
-                                symlinks that are suggested by default
-                                shall be removed, pass
-                                <option>--defaults</option>. This
+                                <command>enable</command>. This call
                                 implicitly reloads the systemd daemon
                                 configuration after completing the
                                 disabling of the units. Note that this
                                 implicitly reloads the systemd daemon
                                 configuration after completing the
                                 disabling of the units. Note that this
                                 <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>
                                 (as with
                                 <command>enable</command>). Returns an
                                 exit code of 0 if at least one is
                                 (as with
                                 <command>enable</command>). Returns an
                                 exit code of 0 if at least one is
-                                enabled, non-zero
-                                otherwise.</para></listitem>
+                                enabled, non-zero otherwise. Prints
+                                the current enable status. To suppress
+                                this output use
+                                <option>--quiet</option>.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><command>reenable [NAME...]</command></term>
+
+                                <listitem><para>Reenable one or more
+                                unit files, as specified on the
+                                command line. This is a combination of
+                                <command>disable</command> and
+                                <command>enable</command> and is
+                                useful to reset the symlinks a unit is
+                                enabled with to the defaults
+                                configured in the
+                                <literal>[Install]</literal> section
+                                of the unit file.</para>
+                                </listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><command>preset [NAME...]</command></term>
+
+                                <listitem><para>Reset one or more unit
+                                files, as specified on the command
+                                line, to the defaults configured in a
+                                preset file. This has the same effect
+                                as <command>disable</command> or
+                                <command>enable</command>, depending
+                                how the unit is listed in the preset
+                                files.</para>
+                                </listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><command>mask [NAME...]</command></term>
+
+                                <listitem><para>Mask one or more unit
+                                files, as specified on the command
+                                line. This will link these units to
+                                <filename>/dev/null</filename>, making
+                                it impossible to start them. This is a stronger version
+                                of <command>disable</command>, since
+                                it prohibits all kinds of activation
+                                of the unit, including manual
+                                activation. Use this option with
+                                care.</para>
+                                </listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><command>unmask [NAME...]</command></term>
+
+                                <listitem><para>Unmask one or more
+                                unit files, as specified on the
+                                command line. This will undo the
+                                effect of
+                                <command>mask</command>.</para>
+                                </listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><command>link [NAME...]</command></term>
+
+                                <listitem><para>Link a unit file that
+                                is not in the unit file search paths
+                                into the unit file search path. This
+                                requires an absolute path to a unit
+                                file. The effect of this can be undone
+                                with <command>disable</command>. The
+                                effect of this command is that a unit
+                                file is available for
+                                <command>start</command> and other
+                                commands although it isn't installed
+                                directly in the unit search
+                                path.</para>
+                                </listitem>
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>
                                 <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>
-                        </varlistentry>
-                        <varlistentry>
-                                <term><command>monitor</command></term>
-
-                                <listitem><para>Monitor unit/job
-                                changes. This is mostly useful for
-                                debugging purposes and prints a line
-                                each time systemd loads or unloads a
-                                unit configuration file, or a unit
-                                property changes.</para></listitem>
+                                IDs. If no job id is specified, cancel all pending jobs.</para></listitem>
                         </varlistentry>
                         <varlistentry>
                                 <term><command>dump</command></term>
                         </varlistentry>
                         <varlistentry>
                                 <term><command>dump</command></term>
 
                                 <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 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
                                 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>
                                 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>
                                 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>
                                 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>
 
                                 <listitem><para>Ask the systemd
                                 manager to quit. This is only
 
                                 <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
                                 (i.e. in conjunction with the
-                                <option>--session</option> option) and
+                                <option>--user</option> option) and
                                 will fail otherwise.</para></listitem>
                         </varlistentry>
                 </variablelist>
                                 will fail otherwise.</para></listitem>
                         </varlistentry>
                 </variablelist>
                 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>
                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemadm</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
         <refsect1>
                 <title>See Also</title>
                 <para>
                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemadm</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>systemd-loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                         <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>