chiark / gitweb /
NEWS: mention set-log-level, --user, --system
[elogind.git] / man / systemd.xml
index 24b442cb16c60d84b265afa70c94f3989006afdc..b4b4845305544fb77264afe7c6c6521e62f936b3 100644 (file)
@@ -45,7 +45,7 @@
         <refnamediv>
                 <refname>systemd</refname>
                 <refname>init</refname>
-                <refpurpose>systemd System and Service Manager</refpurpose>
+                <refpurpose>systemd system and service manager</refpurpose>
         </refnamediv>
 
         <refsynopsisdiv>
@@ -78,7 +78,7 @@
                 the configuration file
                 <filename>system.conf</filename>, otherwise
                 <filename>user.conf</filename>. See
-                <citerefentry><refentrytitle>systemd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                 for more information.</para>
         </refsect1>
 
                                 <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>
 
                                 <term><option>--system</option></term>
                                 <term><option>--user</option></term>
 
-                                <listitem><para>Tell systemd to run a
-                                system instance (resp. user
-                                instance), even if the process ID is
-                                not 1 (resp. is 1), i.e. systemd is
-                                not (resp. is) run as init process.
+                                <listitem><para>For <option>--system</option>,
+                                tell systemd to run a
+                                system instance, even if the process ID is
+                                not 1, i.e. systemd is not run as init process.
+                                <option>--user</option> does the opposite,
+                                running a user instance even if the process
+                                ID is 1.
                                 Normally it should not be necessary to
                                 pass these options, as systemd
                                 automatically detects the mode it is
                                 <term><option>--default-standard-error=</option></term>
 
                                 <listitem><para>Sets the default
-                                output resp. error output for all
-                                services and sockets, i.e. controls
+                                output or error output for all
+                                services and sockets, respectively. That is, controls
                                 the default for
                                 <option>StandardOutput=</option>
-                                resp. <option>StandardError=</option>
+                                and <option>StandardError=</option>
                                 (see
                                 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                                 for details). Takes one of
 
                 <para>Systemd contains native implementations of
                 various tasks that need to be executed as part of the
-                boot process. For example, it sets the host name or
+                boot process. For example, it sets the hostname or
                 configures the loopback network device. It also sets
                 up and mounts various API file systems, such as
                 <filename>/sys</filename> or
                 command line. For details see the <ulink
                 url="http://www.freedesktop.org/wiki/Software/systemd/Generators">Generators
                 Specification</ulink>.</para>
+
+                <para>Systems which invoke systemd in a container
+                or initrd environment should implement the
+                <ulink
+                url="http://www.freedesktop.org/wiki/Software/systemd/ContainerInterface">Container
+                Interface</ulink> or <ulink
+                url="http://www.freedesktop.org/wiki/Software/systemd/InitrdInterface">initrd
+                Interface</ulink> specifications, respectively.</para>
         </refsect1>
 
         <refsect1>
                                 <command>disable</command> commands of
                                 the
                                 <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
-                                tool.</para></listitem>
+                                tool. Full list of directories is provided in
+                                <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
+                                </para></listitem>
                         </varlistentry>
                 </variablelist>
 
                                 tool can handle both global (i.e. for
                                 all users) and private (for one user)
                                 enabling/disabling of
-                                units.</para></listitem>
+                                units. Full list of directories is provided in
+                                <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
+                                </para></listitem>
                         </varlistentry>
                 </variablelist>
 
 
                 <variablelist>
                         <varlistentry>
-                                <term>SIGTERM</term>
+                                <term><constant>SIGTERM</constant></term>
 
                                 <listitem><para>Upon receiving this
                                 signal the systemd system manager
                         </varlistentry>
 
                         <varlistentry>
-                                <term>SIGINT</term>
+                                <term><constant>SIGINT</constant></term>
 
                                 <listitem><para>Upon receiving this
                                 signal the systemd system manager will
 
                                 <para>systemd user managers
                                 treat this signal the same way as
-                                SIGTERM.</para></listitem>
+                                <constant>SIGTERM</constant>.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
-                                <term>SIGWINCH</term>
+                                <term><constant>SIGWINCH</constant></term>
 
                                 <listitem><para>When this signal is
                                 received the systemd system manager
                         </varlistentry>
 
                         <varlistentry>
-                                <term>SIGPWR</term>
+                                <term><constant>SIGPWR</constant></term>
 
                                 <listitem><para>When this signal is
                                 received the systemd manager
                         </varlistentry>
 
                         <varlistentry>
-                                <term>SIGUSR1</term>
+                                <term><constant>SIGUSR1</constant></term>
 
                                 <listitem><para>When this signal is
                                 received the systemd manager will try
                         </varlistentry>
 
                         <varlistentry>
-                                <term>SIGUSR2</term>
+                                <term><constant>SIGUSR2</constant></term>
 
                                 <listitem><para>When this signal is
                                 received the systemd manager will log
                         </varlistentry>
 
                         <varlistentry>
-                                <term>SIGHUP</term>
+                                <term><constant>SIGHUP</constant></term>
 
                                 <listitem><para>Reloads the complete
                                 daemon configuration. This is mostly
                         </varlistentry>
 
                         <varlistentry>
-                                <term>SIGRTMIN+0</term>
+                                <term><constant>SIGRTMIN+0</constant></term>
 
                                 <listitem><para>Enters default mode, starts the
                                 <filename>default.target</filename>
                         </varlistentry>
 
                         <varlistentry>
-                                <term>SIGRTMIN+1</term>
+                                <term><constant>SIGRTMIN+1</constant></term>
 
                                 <listitem><para>Enters rescue mode,
                                 starts the
                         </varlistentry>
 
                         <varlistentry>
-                                <term>SIGRTMIN+2</term>
+                                <term><constant>SIGRTMIN+2</constant></term>
 
                                 <listitem><para>Enters emergency mode,
                                 starts the
                         </varlistentry>
 
                         <varlistentry>
-                                <term>SIGRTMIN+3</term>
+                                <term><constant>SIGRTMIN+3</constant></term>
 
                                 <listitem><para>Halts the machine,
                                 starts the
                         </varlistentry>
 
                         <varlistentry>
-                                <term>SIGRTMIN+4</term>
+                                <term><constant>SIGRTMIN+4</constant></term>
 
                                 <listitem><para>Powers off the machine,
                                 starts the
                         </varlistentry>
 
                         <varlistentry>
-                                <term>SIGRTMIN+5</term>
+                                <term><constant>SIGRTMIN+5</constant></term>
 
                                 <listitem><para>Reboots the machine,
                                 starts the
                         </varlistentry>
 
                         <varlistentry>
-                                <term>SIGRTMIN+6</term>
+                                <term><constant>SIGRTMIN+6</constant></term>
 
                                 <listitem><para>Reboots the machine via kexec,
                                 starts the
                         </varlistentry>
 
                         <varlistentry>
-                                <term>SIGRTMIN+13</term>
+                                <term><constant>SIGRTMIN+13</constant></term>
 
                                 <listitem><para>Immediately halts the machine.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
-                                <term>SIGRTMIN+14</term>
+                                <term><constant>SIGRTMIN+14</constant></term>
 
                                 <listitem><para>Immediately powers off the machine.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
-                                <term>SIGRTMIN+15</term>
+                                <term><constant>SIGRTMIN+15</constant></term>
 
                                 <listitem><para>Immediately reboots the machine.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
-                                <term>SIGRTMIN+16</term>
+                                <term><constant>SIGRTMIN+16</constant></term>
 
                                 <listitem><para>Immediately reboots the machine with kexec.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
-                                <term>SIGRTMIN+20</term>
+                                <term><constant>SIGRTMIN+20</constant></term>
 
                                 <listitem><para>Enables display of
                                 status messages on the console, as
                         </varlistentry>
 
                         <varlistentry>
-                                <term>SIGRTMIN+21</term>
+                                <term><constant>SIGRTMIN+21</constant></term>
 
                                 <listitem><para>Disables display of
                                 status messages on the console, as
                         </varlistentry>
 
                         <varlistentry>
-                                <term>SIGRTMIN+22</term>
-                                <term>SIGRTMIN+23</term>
+                                <term><constant>SIGRTMIN+22</constant></term>
+                                <term><constant>SIGRTMIN+23</constant></term>
 
                                 <listitem><para>Sets the log level to
                                 <literal>debug</literal>
-                                (resp. <literal>info</literal> on
-                                <literal>SIGRTMIN+23</literal>), as
+                                (or <literal>info</literal> on
+                                <constant>SIGRTMIN+23</constant>), as
                                 controlled via
                                 <varname>systemd.log_level=debug</varname>
-                                (resp. <varname>systemd.log_level=info</varname>
-                                on <literal>SIGRTMIN+23</literal>) on
+                                (or <varname>systemd.log_level=info</varname>
+                                on <constant>SIGRTMIN+23</constant>) on
                                 the kernel command
                                 line.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
-                                <term>SIGRTMIN+26</term>
-                                <term>SIGRTMIN+27</term>
-                                <term>SIGRTMIN+28</term>
-                                <term>SIGRTMIN+29</term>
+                                <term><constant>SIGRTMIN+24</constant></term>
+
+                                <listitem><para>Immediately exits the
+                                manager (only available for --user
+                                instances).</para></listitem>
+                        </varlistentry>
+
+                        <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>
-                                (resp. <literal>console</literal> on
-                                <literal>SIGRTMIN+27</literal>;
-                                resp. <literal>kmsg</literal> on
-                                <literal>SIGRTMIN+28</literal>;
-                                resp. <literal>syslog-or-kmsg</literal>
-                                on <literal>SIGRTMIN+29</literal>), as
+                                (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
                                 controlled via
                                 <varname>systemd.log_target=journal-or-kmsg</varname>
-                                (resp. <varname>systemd.log_target=console</varname>
-                                on <literal>SIGRTMIN+27</literal>;
-                                resp. <varname>systemd.log_target=kmsg</varname>
-                                on <literal>SIGRTMIN+28</literal>;
-                                resp
+                                (or <varname>systemd.log_target=console</varname>
+                                on <constant>SIGRTMIN+27</constant>,
+                                <varname>systemd.log_target=kmsg</varname>
+                                on <constant>SIGRTMIN+28</constant>,
+                                or
                                 <varname>systemd.log_target=syslog-or-kmsg</varname>
-                                on <literal>SIGRTMIN+29</literal>) on
+                                on <constant>SIGRTMIN+29</constant>) on
                                 the kernel command
                                 line.</para></listitem>
                         </varlistentry>
         <refsect1>
                 <title>Environment</title>
 
-                <variablelist>
+                <variablelist class='environment-variables'>
                         <varlistentry>
                                 <term><varname>$SYSTEMD_LOG_LEVEL</varname></term>
                                 <listitem><para>systemd reads the
                 <filename>/proc/cmdline</filename>
                 instead.</para></footnote>:</para>
 
-                <variablelist>
+                <variablelist class='kernel-commandline-options'>
                         <varlistentry>
                                 <term><varname>systemd.unit=</varname></term>
                                 <term><varname>rd.systemd.unit=</varname></term>
                                 <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>
                                 for details about these units. The
                                 option prefixed with
-                                <literal>rd.</literal> is honoured
+                                <literal>rd.</literal> is honored
                                 only in the initial RAM disk (initrd),
                                 while the one that isn't prefixed only
                                 in the main system.</para></listitem>
                                 argument. If positive systemd
                                 activates the specified virtual
                                 terminal when it crashes. Defaults to
-                                <literal>-1</literal>.</para></listitem>
+                                <constant>-1</constant>.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
                                 <term><varname>systemd.default_standard_output=</varname></term>
                                 <term><varname>systemd.default_standard_error=</varname></term>
                                 <listitem><para>Controls default
-                                standard output/error output for
+                                standard output and error output for
                                 services, with the same effect as the
                                 <option>--default-standard-output=</option>
-                                resp. <option>--default-standard-error=</option>
+                                and <option>--default-standard-error=</option>
                                 command line arguments described
-                                above.</para></listitem>
+                                above, respectively.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
                                 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 unsets
+                                sign and variable are missing it unsets
                                 an environment variable which might be
                                 passed in from the initial ram
                                 disk.</para></listitem>
                         <varlistentry>
                                 <term><varname>quiet</varname></term>
 
-                                <listitem><para>If passed turns off
+                                <listitem><para>Turn off
                                 status output at boot, much like
                                 <varname>systemd.show_status=false</varname>
                                 would. Note that this option is also
                                 read by the kernel itself and disables
-                                kernel log output to the
-                                kernel. Passing this option hence
-                                turns off the usual output from both
-                                the system manager and the
+                                kernel log output. Passing this option
+                                hence turns off the usual output from
+                                both the system manager and the kernel.
+                                </para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><varname>debug</varname></term>
+
+                                <listitem><para>Turn on debugging
+                                output. This is equivalent to
+                                <varname>systemd.log_level=debug</varname>.
+                                Note that this option is also read by
+                                the kernel itself and enables kernel
+                                debug output.  Passing this option
+                                hence turns on the debug output from
+                                both the system manager and the
                                 kernel.</para></listitem>
                         </varlistentry>
 
                                 <term><varname>5</varname></term>
 
                                 <listitem><para>Boot into the
-                                specified legacy SysV runlevel. This
-                                is equivalent to
+                                specified legacy SysV runlevel. These
+                                are equivalent to
                                 <varname>systemd.unit=runlevel2.target</varname>,
                                 <varname>systemd.unit=runlevel3.target</varname>,
                                 <varname>systemd.unit=runlevel4.target</varname>,
-                                resp. <varname>systemd.unit=runlevel5.target</varname>
+                                and <varname>systemd.unit=runlevel5.target</varname>, respectively,
                                 and provided for compatibility reasons
                                 and to be easier to
                                 type.</para></listitem>
 
                                 <listitem><para>Daemon status
                                 notification socket. This is an
-                                AF_UNIX datagram socket and is used to
+                                <constant>AF_UNIX</constant> datagram socket and is used to
                                 implement the daemon notification
                                 logic as implemented by
                                 <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para></listitem>
                                 <listitem><para>Used internally by the
                                 <citerefentry><refentrytitle>shutdown</refentrytitle><manvolnum>8</manvolnum></citerefentry>
                                 tool to implement delayed
-                                shutdowns. This is an AF_UNIX datagram
+                                shutdowns. This is an <constant>AF_UNIX</constant> datagram
                                 socket.</para></listitem>
                         </varlistentry>
 
                                 communication channel between
                                 <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                                 and the systemd process. This is an
-                                AF_UNIX stream socket. This interface
+                                <constant>AF_UNIX</constant> stream socket. This interface
                                 is private to systemd and should not
                                 be used in external
                                 projects.</para></listitem>
         <refsect1>
                 <title>See Also</title>
                 <para>
-                        <citerefentry><refentrytitle>systemd.conf</refentrytitle><manvolnum>5</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>,
-                        <citerefentry><refentrytitle>systemadm</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemd-notify</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
-                        <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>7</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><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
-                        <citerefentry><refentrytitle>bootup</refentrytitle><manvolnum>7</manvolnum></citerefentry>
+                        <citerefentry><refentrytitle>bootup</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>
                 </para>
         </refsect1>