chiark / gitweb /
zsh-completion: remove duplicate function
[elogind.git] / man / systemd.xml
index 06d2ecf6f8ae7886894a71f8662bb662e1b5babe..e0e8d37a90ade54c1788838a6cbc0f796db2b9b3 100644 (file)
@@ -21,7 +21,8 @@
   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>
                 <citerefentry><refentrytitle>telinit</refentrytitle><manvolnum>8</manvolnum></citerefentry>
                 for more information.</para>
 
-                <para>When run as system instance, systemd interprets
-                the configuration file
-                <filename>system.conf</filename>, otherwise
-                <filename>user.conf</filename>. See
+                <para>When run as a system instance, systemd interprets the
+                configuration file <filename>system.conf</filename> and the
+                files in <filename>system.conf.d</filename> directories; when
+                run as a user instance, systemd interprets the configuration
+                file <filename>user.conf</filename> and the files in
+                <filename>user.conf.d</filename> directories. See
                 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                 for more information.</para>
         </refsect1>
                 <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>
 
                                 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
-                                activate on startup. If not specified
+                                activate on startup. If not specified,
                                 defaults to
                                 <filename>default.target</filename>.</para></listitem>
                         </varlistentry>
                                 target. Argument must be one of
                                 <option>console</option>,
                                 <option>journal</option>,
-                                <option>syslog</option>,
                                 <option>kmsg</option>,
                                 <option>journal-or-kmsg</option>,
-                                <option>syslog-or-kmsg</option>,
                                 <option>null</option>.</para></listitem>
                         </varlistentry>
                         <varlistentry>
 
                                 <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>,
 
                                 <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>
                                 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>
 
                 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                 however some are created automatically from other
                 configuration, dynamically from system state or
-                programmatically at runtime. Units may be 'active'
-                (meaning started, bound, plugged in, ...  depending on
-                the unit type, see below), or 'inactive' (meaning
+                programmatically at runtime. Units may be "active"
+                (meaning started, bound, plugged in, ..., depending on
+                the unit type, see below), or "inactive" (meaning
                 stopped, unbound, unplugged, ...), as well as in the
                 process of being activated or deactivated,
                 i.e. between the two states (these states are called
-                'activating', 'deactivating'). A special 'failed'
-                state is available as well which is very similar to
-                'inactive' and is entered when the service failed in
+                "activating", "deactivating"). A special "failed"
+                state is available as well, which is very similar to
+                "inactive" and is entered when the service failed in
                 some way (process returned error code on exit, or
                 crashed, or an operation timed out). If this state is
-                entered the cause will be logged, for later
+                entered, the cause will be logged, for later
                 reference. Note that the various unit types may have a
                 number of additional substates, which are mapped to
                 the five generalized unit states described
                         <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>
 
                 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>
 
                 <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>
                 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>
                 <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>
 
                                 received the systemd manager will log
                                 its complete state in human readable
                                 form. The data logged is the same as
-                                printed by <command>systemctl
+                                printed by <command>systemd-analyze
                                 dump</command>.</para></listitem>
                         </varlistentry>
 
                                 <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
-                                <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+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>
-                                (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>
-                                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>
                                 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>
 
                                 <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
-                                crashes. Otherwise no core dump is
+                                crashes. Otherwise, no core dump is
                                 created. Defaults to
                                 <option>true</option>.</para></listitem>
                         </varlistentry>
                                 <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
-                                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
                                 <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>
                                 <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>false</option>.</para></listitem>
+                                <constant>auto</constant>.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
                                 <term><varname>systemd.setenv=</varname></term>
 
                                 <listitem><para>Takes a string
-                                argument in the form
-                                VARIABLE=VALUE. May be used to set
-                                environment variables for the init
-                                process and all its children at boot
-                                time. May be used more than once to
-                                set multiple variables. If the equal
-                                sign and variable are missing it unsets
-                                an environment variable which might be
-                                passed in from the initial ram
-                                disk.</para></listitem>
+                                argument in the form VARIABLE=VALUE.
+                                May be used to set default environment
+                                variables to add to forked child processes.
+                                May be used more than once to set multiple
+                                variables.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
 
                         <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>
-                                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>
+                                <term><varname>rescue</varname></term>
                                 <term><varname>single</varname></term>
                                 <term><varname>s</varname></term>
                                 <term><varname>S</varname></term>
         <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>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>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>