chiark / gitweb /
man: numerous updates to document updated systemctl behaviour
[elogind.git] / man / systemctl.xml
index 63598723bbc27875950bb9fd9935825ff6f2fa5b..cdf4f5cd2901587a4f6c7cee4ff9298848f0af7d 100644 (file)
                                 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>--no-block</option></term>
 
-                               <listitem><para>Do not synchronously wait for
-                               the requested operation to finish. If this is
-                               not specified the job will be verified,
-                               enqueued and <command>systemctl</command> will
-                               wait until it is completed. By passing this
-                               argument it is only verified and
-                               enqueued.</para></listitem> </varlistentry>
+                                <listitem><para>Do not synchronously wait for
+                                the requested operation to finish. If this is
+                                not specified the job will be verified,
+                                enqueued and <command>systemctl</command> will
+                                wait until it is completed. By passing this
+                                argument it is only verified and
+                                enqueued.</para></listitem> </varlistentry>
 
                         <varlistentry>
                                 <term><option>--system</option></term>
                                 changes.</para></listitem>
                         </varlistentry>
 
+                        <varlistentry>
+                                <term><option>--kill-mode=</option></term>
+
+                                <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>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--kill-who=</option></term>
+
+                                <listitem><para>When used with
+                                <command>kill</command>, choose which
+                                processes to kill. Must be one of
+                                <option>main</option>,
+                                <option>control</option> or
+                                <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
+                                defaults to
+                                <option>all</option>.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <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
+                                SIGTERM, SIGINT or SIGSTOP. If
+                                ommitted defaults to
+                                <option>SIGTERM</option>.</para></listitem>
+                        </varlistentry>
+
                         <varlistentry>
                                 <term><option>--force</option></term>
+                                <term><option>-f</option></term>
 
                                 <listitem><para>When used with
                                 <command>enable</command>, override any
                                 existing conflicting
                                 symlinks.</para></listitem>
+
+                                <listitem><para>When used with
+                                <command>halt</command>,
+                                <command>poweroff</command>,
+                                <command>reboot</command> or
+                                <command>kexec</command> execute
+                                selected operation without shutting
+                                down all units. However, all processes
+                                will be killed forcibly and all file
+                                systems are unmounted or remounted
+                                read-only. This is hence a drastic but
+                                relatively safe option to request an
+                                immediate reboot.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
                                 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                                 for details.</para></listitem>
                         </varlistentry>
+                        <varlistentry>
+                                <term><command>kill [NAME...]</command></term>
+
+                                <listitem><para>Send a signal to one
+                                or more processes of the unit. Use
+                                <option>--kill-who=</option> to select
+                                which process to kill. Use
+                                <option>--kill-mode=</option> to
+                                select the kill mode and
+                                <option>--signal=</option> to select
+                                the signal to send.</para></listitem>
+                        </varlistentry>
                         <varlistentry>
                                 <term><command>is-active [NAME...]</command></term>
 
                                 does not have the effect that any of
                                 the units enabled are also started at
                                 the same time. If this is desired a
-                                seperate <command>start</command>
+                                separate <command>start</command>
                                 command must be invoked for the
                                 unit.</para>
 
                                 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>
 
                                 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>
 
                                 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 killed
+                                and all file systems unmounted or
+                                mounted read-only, immediately
+                                followed by the
+                                system halt.</para></listitem>
                         </varlistentry>
                         <varlistentry>
                                 <term><command>poweroff</command></term>
                                 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 killed
+                                and all file systems unmounted or
+                                mounted read-only, immediately
+                                followed by the
+                                powering off.</para></listitem>
                         </varlistentry>
                         <varlistentry>
                                 <term><command>reboot</command></term>
                                 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 killed
+                                and all file systems unmounted or
+                                mounted read-only, immediately
+                                followed by the
+                                reboot.</para></listitem>
                         </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 killed
+                                and all file systems unmounted or
+                                mounted read-only, immediately
+                                followed by the
+                                reboot.</para></listitem>
                         </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 session managers
+                                (i.e. in conjunction with the
+                                <option>--session</option> option) and
+                                will fail otherwise.</para></listitem>
                         </varlistentry>
                 </variablelist>