man: document the new "rescue" kernel command line option

[elogind.git] / man / systemd.xml

diff --git a/man/systemd.xml b/man/systemd.xml
index 32bca0b607bd00f34e6a6ad8221d7016d1ebd43c..bf7a7a6f67209c7dc4384d1e3c9af46ef1b191b4 100644 (file)
--- a/man/systemd.xml
+++ b/man/systemd.xml
@@ -21,7 +21,8 @@
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 

-<refentry id="systemd">
+<refentry id="systemd"
+          xmlns:xi="http://www.w3.org/2001/XInclude">

 
         <refentryinfo>
                 <title>systemd</title>
 
         <refentryinfo>
                 <title>systemd</title>


@@ -88,19 +89,6 @@
                 <para>The following options are understood:</para>
 
                 <variablelist>
                 <para>The following options are understood:</para>
 
                 <variablelist>

-                        <varlistentry>
-                                <term><option>-h</option></term>
-                                <term><option>--help</option></term>
-
-                                <listitem><para>Prints a short help
-                                text and exits.</para></listitem>
-                        </varlistentry>
-                        <varlistentry>
-                                <term><option>--version</option></term>
-
-                                <listitem><para>Prints a systemd version
-                                identifier and exits.</para></listitem>
-                        </varlistentry>

                         <varlistentry>
                                 <term><option>--test</option></term>
 
                         <varlistentry>
                                 <term><option>--test</option></term>
 


@@ -118,25 +106,11 @@
                                 configuration items understood in unit
                                 definition files.</para></listitem>
                         </varlistentry>
                                 configuration items understood in unit
                                 definition files.</para></listitem>
                         </varlistentry>

-                        <varlistentry>
-                                <term><option>--introspect=</option></term>
-
-                                <listitem><para>Extract D-Bus
-                                interface introspection data. This is
-                                mostly useful at install time
-                                to generate data suitable for the
-                                D-Bus interfaces
-                                repository. Optionally the interface
-                                name for the introspection data may be
-                                specified. If omitted, the
-                                introspection data for all interfaces
-                                is dumped.</para></listitem>
-                        </varlistentry>

                         <varlistentry>
                                 <term><option>--unit=</option></term>
 
                                 <listitem><para>Set default unit to
                         <varlistentry>
                                 <term><option>--unit=</option></term>
 
                                 <listitem><para>Set default unit to

-                                activate on startup. If not specified
+                                activate on startup. If not specified,

                                 defaults to
                                 <filename>default.target</filename>.</para></listitem>
                         </varlistentry>
                                 defaults to
                                 <filename>default.target</filename>.</para></listitem>
                         </varlistentry>


@@ -206,10 +180,8 @@
                                 target. Argument must be one of
                                 <option>console</option>,
                                 <option>journal</option>,
                                 target. Argument must be one of
                                 <option>console</option>,
                                 <option>journal</option>,

-                                <option>syslog</option>,

                                 <option>kmsg</option>,
                                 <option>journal-or-kmsg</option>,
                                 <option>kmsg</option>,
                                 <option>journal-or-kmsg</option>,

-                                <option>syslog-or-kmsg</option>,

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


@@ -217,7 +189,7 @@
 
                                 <listitem><para>Set log level. As
                                 argument this accepts a numerical log
 
                                 <listitem><para>Set log level. As
                                 argument this accepts a numerical log

-                                level or the well-known <citerefentry><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+                                level or the well-known <citerefentry project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>

                                 symbolic names (lowercase):
                                 <option>emerg</option>,
                                 <option>alert</option>,
                                 symbolic names (lowercase):
                                 <option>emerg</option>,
                                 <option>alert</option>,


@@ -233,7 +205,7 @@
 
                                 <listitem><para>Highlight important
                                 log messages. Argument is a boolean
 
                                 <listitem><para>Highlight important
                                 log messages. Argument is a boolean

-                                value. If the argument is omitted it
+                                value. If the argument is omitted, it

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


@@ -278,6 +250,9 @@
                                 to
                                 <option>inherit</option>.</para></listitem>
                         </varlistentry>
                                 to
                                 <option>inherit</option>.</para></listitem>
                         </varlistentry>

+
+                        <xi:include href="standard-options.xml" xpointer="help" />
+                        <xi:include href="standard-options.xml" xpointer="version" />

                 </variablelist>
         </refsect1>
 
                 </variablelist>
         </refsect1>
 


@@ -374,7 +349,7 @@
                         <listitem><para>Slice units may be used to
                         group units which manage system processes
                         (such as service and scope units) in a
                         <listitem><para>Slice units may be used to
                         group units which manage system processes
                         (such as service and scope units) in a

-                        hierachial tree for resource management
+                        hierarchical tree for resource management

                         purposes. See
                         <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para></listitem>
 
                         purposes. See
                         <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para></listitem>
 


@@ -407,7 +382,7 @@
                 and ordering dependencies are placed between two
                 units. Also note that the majority of dependencies are
                 implicitly created and maintained by systemd. In most
                 and ordering dependencies are placed between two
                 units. Also note that the majority of dependencies are
                 implicitly created and maintained by systemd. In most

-                cases it should be unnecessary to declare additional
+                cases, it should be unnecessary to declare additional

                 dependencies manually, however it is possible to do
                 this.</para>
 
                 dependencies manually, however it is possible to do
                 this.</para>
 


@@ -429,7 +404,7 @@
                 <filename>multi-user.target</filename> (for limited
                 console-only boots for use in embedded or server
                 environments, or similar; a subset of
                 <filename>multi-user.target</filename> (for limited
                 console-only boots for use in embedded or server
                 environments, or similar; a subset of

-                graphical.target). However it is at the discretion of
+                graphical.target). However, it is at the discretion of

                 the administrator to configure it as an alias to any
                 other target unit. See
                 <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>
                 the administrator to configure it as an alias to any
                 other target unit. See
                 <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>


@@ -447,7 +422,7 @@
                 file system hierarchy (beneath
                 <filename>/sys/fs/cgroup/systemd/</filename>), or in tools
                 such as
                 file system hierarchy (beneath
                 <filename>/sys/fs/cgroup/systemd/</filename>), or in tools
                 such as

-                <citerefentry><refentrytitle>ps</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+                <citerefentry project='man-pages'><refentrytitle>ps</refentrytitle><manvolnum>1</manvolnum></citerefentry>

                 (<command>ps xawf -eo pid,user,cgroup,args</command>
                 is particularly useful to list all processes and the
                 systemd units they belong to.).</para>
                 (<command>ps xawf -eo pid,user,cgroup,args</command>
                 is particularly useful to list all processes and the
                 systemd units they belong to.).</para>


@@ -494,7 +469,7 @@
                 <filename>/proc</filename>.</para>
 
                 <para>For more information about the concepts and
                 <filename>/proc</filename>.</para>
 
                 <para>For more information about the concepts and

-                ideas behind systemd please refer to the <ulink
+                ideas behind systemd, please refer to the <ulink

                 url="http://0pointer.de/blog/projects/systemd.html">Original
                 Design Document</ulink>.</para>
 
                 url="http://0pointer.de/blog/projects/systemd.html">Original
                 Design Document</ulink>.</para>
 


@@ -867,26 +842,21 @@
                                 <term><constant>SIGRTMIN+26</constant></term>
                                 <term><constant>SIGRTMIN+27</constant></term>
                                 <term><constant>SIGRTMIN+28</constant></term>
                                 <term><constant>SIGRTMIN+26</constant></term>
                                 <term><constant>SIGRTMIN+27</constant></term>
                                 <term><constant>SIGRTMIN+28</constant></term>

-                                <term><constant>SIGRTMIN+29</constant></term>

 
                                 <listitem><para>Sets the log level to
 
                                 <listitem><para>Sets the log level to

-                                <literal>journal-or-kmsg</literal>
-                                (or <literal>console</literal> on
+                                <literal>journal-or-kmsg</literal> (or
+                                <literal>console</literal> on

                                 <constant>SIGRTMIN+27</constant>,
                                 <literal>kmsg</literal> on
                                 <constant>SIGRTMIN+27</constant>,
                                 <literal>kmsg</literal> on

-                                <constant>SIGRTMIN+28</constant>,
-                                or <literal>syslog-or-kmsg</literal>
-                                on <constant>SIGRTMIN+29</constant>), as
+                                <constant>SIGRTMIN+28</constant>), as

                                 controlled via
                                 <varname>systemd.log_target=journal-or-kmsg</varname>
                                 controlled via
                                 <varname>systemd.log_target=journal-or-kmsg</varname>

-                                (or <varname>systemd.log_target=console</varname>
-                                on <constant>SIGRTMIN+27</constant>,
+                                (or
+                                <varname>systemd.log_target=console</varname>
+                                on <constant>SIGRTMIN+27</constant> or

                                 <varname>systemd.log_target=kmsg</varname>
                                 <varname>systemd.log_target=kmsg</varname>

-                                on <constant>SIGRTMIN+28</constant>,
-                                or
-                                <varname>systemd.log_target=syslog-or-kmsg</varname>
-                                on <constant>SIGRTMIN+29</constant>) on
-                                the kernel command
+                                on <constant>SIGRTMIN+28</constant>)
+                                on the kernel command

                                 line.</para></listitem>
                         </varlistentry>
                 </variablelist>
                                 line.</para></listitem>
                         </varlistentry>
                 </variablelist>


@@ -1022,7 +992,7 @@
                                 option prefixed with
                                 <literal>rd.</literal> is honored
                                 only in the initial RAM disk (initrd),
                                 option prefixed with
                                 <literal>rd.</literal> is honored
                                 only in the initial RAM disk (initrd),

-                                while the one that isn't prefixed only
+                                while the one that is not prefixed only

                                 in the main system.</para></listitem>
                         </varlistentry>
 
                                 in the main system.</para></listitem>
                         </varlistentry>
 


@@ -1030,9 +1000,9 @@
                                 <term><varname>systemd.dump_core=</varname></term>
 
                                 <listitem><para>Takes a boolean
                                 <term><varname>systemd.dump_core=</varname></term>
 
                                 <listitem><para>Takes a boolean

-                                argument. If <option>true</option>
+                                argument. If <option>true</option>,

                                 systemd dumps core when it
                                 systemd dumps core when it

-                                crashes. Otherwise no core dump is
+                                crashes. Otherwise, no core dump is

                                 created. Defaults to
                                 <option>true</option>.</para></listitem>
                         </varlistentry>
                                 created. Defaults to
                                 <option>true</option>.</para></listitem>
                         </varlistentry>


@@ -1041,9 +1011,9 @@
                                 <term><varname>systemd.crash_shell=</varname></term>
 
                                 <listitem><para>Takes a boolean
                                 <term><varname>systemd.crash_shell=</varname></term>
 
                                 <listitem><para>Takes a boolean

-                                argument. If <option>true</option>
+                                argument. If <option>true</option>,

                                 systemd spawns a shell when it
                                 systemd spawns a shell when it

-                                crashes. Otherwise no shell is
+                                crashes. Otherwise, no shell is

                                 spawned. Defaults to
                                 <option>false</option>, for security
                                 reasons, as the shell is not protected
                                 spawned. Defaults to
                                 <option>false</option>, for security
                                 reasons, as the shell is not protected


@@ -1065,7 +1035,7 @@
                                 <term><varname>systemd.confirm_spawn=</varname></term>
 
                                 <listitem><para>Takes a boolean
                                 <term><varname>systemd.confirm_spawn=</varname></term>
 
                                 <listitem><para>Takes a boolean

-                                argument. If <option>true</option>
+                                argument. If <option>true</option>,

                                 asks for confirmation when spawning
                                 processes. Defaults to
                                 <option>false</option>.</para></listitem>
                                 asks for confirmation when spawning
                                 processes. Defaults to
                                 <option>false</option>.</para></listitem>


@@ -1075,14 +1045,20 @@
                                 <term><varname>systemd.show_status=</varname></term>
 
                                 <listitem><para>Takes a boolean
                                 <term><varname>systemd.show_status=</varname></term>
 
                                 <listitem><para>Takes a boolean

-                                argument. If <option>true</option>
-                                shows terse service status updates on
-                                the console during bootup. Defaults to
+                                argument or the constant
+                                <constant>auto</constant>. If
+                                <option>true</option>, shows terse
+                                service status updates on the console
+                                during bootup.
+                                <constant>auto</constant> behaves like
+                                <option>false</option> until a service
+                                fails or there is a significant delay
+                                in boot. Defaults to

                                 <option>true</option>, unless
                                 <option>quiet</option> is passed as
                                 kernel command line option in which
                                 case it defaults to
                                 <option>true</option>, unless
                                 <option>quiet</option> is passed as
                                 kernel command line option in which
                                 case it defaults to

-                                <option>false</option>.</para></listitem>
+                                <constant>auto</constant>.</para></listitem>

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


@@ -1150,15 +1126,18 @@
 
                         <varlistentry>
                                 <term><varname>emergency</varname></term>
 
                         <varlistentry>
                                 <term><varname>emergency</varname></term>

+                                <term><varname>-b</varname></term>

 
                                 <listitem><para>Boot into emergency
                                 mode. This is equivalent to
                                 <varname>systemd.unit=emergency.target</varname>
 
                                 <listitem><para>Boot into emergency
                                 mode. This is equivalent to
                                 <varname>systemd.unit=emergency.target</varname>

-                                and provided for compatibility
-                                reasons and to be easier to type.</para></listitem>
+                                and provided for compatibility reasons
+                                and to be easier to
+                                type.</para></listitem>

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

+                                <term><varname>rescue</varname></term>

                                 <term><varname>single</varname></term>
                                 <term><varname>s</varname></term>
                                 <term><varname>S</varname></term>
                                 <term><varname>single</varname></term>
                                 <term><varname>s</varname></term>
                                 <term><varname>S</varname></term>


@@ -1280,6 +1259,7 @@
         <refsect1>
                 <title>See Also</title>
                 <para>
         <refsect1>
                 <title>See Also</title>
                 <para>

+                        The <ulink url="http://www.freedesktop.org/wiki/Software/systemd/">systemd Homepage</ulink>,

                         <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,


@@ -1289,9 +1269,9 @@
                         <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>5</manvolnum></citerefentry>,

-                        <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+                        <citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

                         <citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry>,

-                        <citerefentry><refentrytitle>bootup</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
+                        <citerefentry project='man-pages'><refentrytitle>bootup</refentrytitle><manvolnum>7</manvolnum></citerefentry>,

                         <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>
                 </para>
         </refsect1>
                         <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>
                 </para>
         </refsect1>