man: extend manual page documentation
This commit is contained in:
Lennart Poettering
parent
5ec7ed4ec6
commit
7874bcd602
12
Makefile.am
12
Makefile.am
|
|
@ -319,7 +319,9 @@ dist_man_MANS = \
|
|||
man/halt.8 \
|
||||
man/shutdown.8 \
|
||||
man/systemd-install.1 \
|
||||
man/pam_systemd.8
|
||||
man/pam_systemd.8 \
|
||||
man/systemadm.1 \
|
||||
man/systemctl.1
|
||||
|
||||
nodist_man_MANS = \
|
||||
man/systemd.special.7
|
||||
|
|
@ -339,7 +341,9 @@ dist_noinst_DATA = \
|
|||
man/halt.html \
|
||||
man/shutdown.html \
|
||||
man/systemd-install.html \
|
||||
man/pam_systemd.html
|
||||
man/pam_systemd.html \
|
||||
man/systemadm.html \
|
||||
man/systemctl.html
|
||||
|
||||
nodist_noinst_DATA = \
|
||||
man/systemd.special.html
|
||||
|
|
@ -362,7 +366,9 @@ EXTRA_DIST += \
|
|||
man/halt.xml \
|
||||
man/shutdown.xml \
|
||||
man/systemd-install.xml \
|
||||
man/pam_systemd.xml
|
||||
man/pam_systemd.xml \
|
||||
man/systemadm.xml \
|
||||
man/systemctl.xml
|
||||
|
||||
systemd_SOURCES = \
|
||||
src/main.c
|
||||
|
|
|
|||
|
|
@ -173,7 +173,8 @@
|
|||
<para>
|
||||
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>shutdown</refentrytitle><manvolnum>8</manvolnum></citerefentry>
|
||||
<citerefentry><refentrytitle>shutdown</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
|||
|
|
@ -207,6 +207,10 @@
|
|||
tools like
|
||||
<citerefentry><refentrytitle>screen</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
|
||||
|
||||
<para>If the options are omitted they default to
|
||||
<option>create-session=1</option>,
|
||||
<option>kill-session=0</option>,
|
||||
<option>kill-user=0</option>.</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
|
|
|
|||
|
|
@ -159,6 +159,26 @@
|
|||
become a NOP.</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Environment</title>
|
||||
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><varname>$LISTEN_PID</varname></term>
|
||||
<term><varname>$LISTEN_FDS</varname></term>
|
||||
|
||||
<listitem><para>Set by the init system
|
||||
for supervised processes that use
|
||||
socket-based activation. This
|
||||
environment variable specifies the
|
||||
data
|
||||
<function>sd_listen_fds()</function>
|
||||
parses. See above for
|
||||
details.</para></listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>See Also</title>
|
||||
|
||||
|
|
|
|||
|
|
@ -227,6 +227,24 @@
|
|||
become a NOP.</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Environment</title>
|
||||
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><varname>$NOTIFY_SOCKET</varname></term>
|
||||
|
||||
<listitem><para>Set by the init system
|
||||
for supervised processes for status
|
||||
and start-up completion
|
||||
notification. This environment variable
|
||||
specifies the socket
|
||||
<function>sd_notify()</function> talks
|
||||
to. See above for details.</para></listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Examples</title>
|
||||
|
||||
|
|
|
|||
|
|
@ -148,7 +148,8 @@
|
|||
<para>
|
||||
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>halt</refentrytitle><manvolnum>8</manvolnum></citerefentry>
|
||||
<citerefentry><refentrytitle>halt</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,111 @@
|
|||
<?xml version='1.0'?> <!--*-nxml-*-->
|
||||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
|
||||
|
||||
<!--
|
||||
This file is part of systemd.
|
||||
|
||||
Copyright 2010 Lennart Poettering
|
||||
|
||||
systemd is free software; you can redistribute it and/or modify it
|
||||
under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation; either version 2 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
systemd is distributed in the hope that it will be useful, but
|
||||
WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with systemd; If not, see <http://www.gnu.org/licenses/>.
|
||||
-->
|
||||
|
||||
<refentry id="systemadm">
|
||||
|
||||
<refentryinfo>
|
||||
<title>systemadm</title>
|
||||
<productname>systemd</productname>
|
||||
|
||||
<authorgroup>
|
||||
<author>
|
||||
<contrib>Developer</contrib>
|
||||
<firstname>Lennart</firstname>
|
||||
<surname>Poettering</surname>
|
||||
<email>lennart@poettering.net</email>
|
||||
</author>
|
||||
</authorgroup>
|
||||
</refentryinfo>
|
||||
|
||||
<refmeta>
|
||||
<refentrytitle>systemadm</refentrytitle>
|
||||
<manvolnum>1</manvolnum>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>systemadm</refname>
|
||||
<refpurpose>Graphical frontend for the systemd system
|
||||
and session manager</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv>
|
||||
<cmdsynopsis>
|
||||
<command>systemadm <arg choice="opt" rep="repeat">OPTIONS</arg></command>
|
||||
</cmdsynopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<para><command>systemadm</command> is a graphical
|
||||
frontend for the systemd system and session manager
|
||||
and allows introspection and control of
|
||||
systemd.</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Options</title>
|
||||
|
||||
<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>--system</option></term>
|
||||
|
||||
<listitem><para>Connect to the systemd
|
||||
system
|
||||
manager. (Default)</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>--session</option></term>
|
||||
|
||||
<listitem><para>Connect to the systemd
|
||||
session manager of the calling
|
||||
user.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
</variablelist>
|
||||
|
||||
<para>In addition to this a number of of parameters
|
||||
common to all Gtk+ programs are supported.</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>See Also</title>
|
||||
<para>
|
||||
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
|
|
@ -0,0 +1,458 @@
|
|||
<?xml version='1.0'?> <!--*-nxml-*-->
|
||||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
|
||||
|
||||
<!--
|
||||
This file is part of systemd.
|
||||
|
||||
Copyright 2010 Lennart Poettering
|
||||
|
||||
systemd is free software; you can redistribute it and/or modify it
|
||||
under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation; either version 2 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
systemd is distributed in the hope that it will be useful, but
|
||||
WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with systemd; If not, see <http://www.gnu.org/licenses/>.
|
||||
-->
|
||||
|
||||
<refentry id="systemd-install">
|
||||
|
||||
<refentryinfo>
|
||||
<title>systemctl</title>
|
||||
<productname>systemd</productname>
|
||||
|
||||
<authorgroup>
|
||||
<author>
|
||||
<contrib>Developer</contrib>
|
||||
<firstname>Lennart</firstname>
|
||||
<surname>Poettering</surname>
|
||||
<email>lennart@poettering.net</email>
|
||||
</author>
|
||||
</authorgroup>
|
||||
</refentryinfo>
|
||||
|
||||
<refmeta>
|
||||
<refentrytitle>systemctl</refentrytitle>
|
||||
<manvolnum>1</manvolnum>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>systemctl</refname>
|
||||
<refpurpose>Control the systemd system and session manager</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv>
|
||||
<cmdsynopsis>
|
||||
<command>systemctl <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">COMMAND</arg> <arg choice="opt" rep="repeat">NAME</arg></command>
|
||||
</cmdsynopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<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>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Options</title>
|
||||
|
||||
<para>The following options are understood:</para>
|
||||
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><option>--help</option></term>
|
||||
<term><option>--h</option></term>
|
||||
|
||||
<listitem><para>Prints a short help
|
||||
text and exits.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>--type=</option></term>
|
||||
|
||||
<listitem><para>When listing units,
|
||||
limit display to certain unit
|
||||
types. If not specified units of all
|
||||
types will be shown. The argument
|
||||
should be a unit type name such as
|
||||
<option>service</option>,
|
||||
<option>socket</option> and
|
||||
similar.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>--all</option></term>
|
||||
|
||||
<listitem><para>When listing units,
|
||||
show all units, regardless of their
|
||||
state, including inactive
|
||||
units.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>--replace</option></term>
|
||||
|
||||
<listitem><para>If the requested
|
||||
operation conflicts with an exisiting
|
||||
unfinished operation, replace the
|
||||
existing operation by the requested
|
||||
operation. If this is not specified
|
||||
the requested operation will
|
||||
fail.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>--system</option></term>
|
||||
|
||||
<listitem><para>Talk to the systemd
|
||||
system manager. (Default)</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>--session</option></term>
|
||||
|
||||
<listitem><para>Talk to the systemd
|
||||
session manager of the calling user.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>--block</option></term>
|
||||
|
||||
<listitem><para>Synchronously wait for
|
||||
the requested operation to
|
||||
finish.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>--no-wall</option></term>
|
||||
|
||||
<listitem><para>Don't send wall
|
||||
message before
|
||||
halt, power-off, reboot.</para></listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
||||
<para>The following commands are understood:</para>
|
||||
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><command>list-units</command></term>
|
||||
|
||||
<listitem><para>List known units.</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>list-jobs</command></term>
|
||||
|
||||
<listitem><para>List jobs that are in progress.</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>clear-jobs</command></term>
|
||||
|
||||
<listitem><para>Cancel all jobs that are in progress.</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>load [NAME...]</command></term>
|
||||
|
||||
<listitem><para>Load one or more units
|
||||
specified on the command line. This
|
||||
will simply load their configuration
|
||||
from disk, but not start them. To
|
||||
start them you need to use the
|
||||
<command>start</command> command which
|
||||
will implicitly load a unit that has
|
||||
not been loaded yet. Note that systemd
|
||||
garbage collects loaded units that are
|
||||
not active or referenced by an active
|
||||
unit. This means that units loaded
|
||||
this way will usually not stay loaded
|
||||
for long. Also note that this command
|
||||
cannot be used to reload unit
|
||||
configuration. Use the
|
||||
<command>daemon-reload</command>
|
||||
command for that. All in all this
|
||||
command is of little use except for
|
||||
debugging.</para>
|
||||
<para>This command should not be
|
||||
confused with the
|
||||
<command>daemon-reload</command> or
|
||||
<command>reload</command>
|
||||
commands.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><command>cancel [JOB...]</command></term>
|
||||
|
||||
<listitem><para>Cancel one or more
|
||||
jobs specified on the command line by
|
||||
their numeric job
|
||||
IDs.</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>start [NAME...]</command></term>
|
||||
|
||||
<listitem><para>Start one or more
|
||||
units specified on the command
|
||||
line.</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>stop [NAME...]</command></term>
|
||||
|
||||
<listitem><para>Stop one or more units
|
||||
specified on the command
|
||||
line.</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>restart [NAME...]</command></term>
|
||||
|
||||
<listitem><para>Restart one or more
|
||||
units specified on the command
|
||||
line.</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>reload [NAME...]</command></term>
|
||||
|
||||
<listitem><para>Asks all services
|
||||
whose units are listed on the command
|
||||
line to reload their
|
||||
configuration. Note that this will
|
||||
reload the daemon configuration
|
||||
itself, not the unit configuration
|
||||
file of systemd. If you want systemd
|
||||
to reload the configuration file of a
|
||||
unit use the
|
||||
<command>daemon-reload</command>
|
||||
command. In other words: for the
|
||||
example case of Apache, this will
|
||||
reload Apache's
|
||||
<filename>httpd.conf</filename> in the
|
||||
web server, not the
|
||||
<filename>apache.service</filename>
|
||||
systemd unit file. </para> <para>This
|
||||
command should not be confused with
|
||||
the <command>daemon-reload</command>
|
||||
or <command>load</command>
|
||||
commands.</para></listitem>
|
||||
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>isolate [NAME]</command></term>
|
||||
|
||||
<listitem><para>Start the unit
|
||||
specified on the command line and its
|
||||
dependencies and stop all
|
||||
others.</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>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>dump</command></term>
|
||||
|
||||
<listitem><para>Dump server
|
||||
status. This will output a (usually
|
||||
very long) human readable manager
|
||||
status dump. Its format is subject to
|
||||
change without notice and should not
|
||||
be parsed by
|
||||
applications.</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>snapshot [NAME]</command></term>
|
||||
|
||||
<listitem><para>Create a snapshot. If
|
||||
a snapshot name is specified the new
|
||||
snapshot will be named after it. If
|
||||
none is specified an automatic
|
||||
snapshot name is generated. In either
|
||||
case the snapshot name used is printed
|
||||
to STDOUT.</para>
|
||||
|
||||
<para>A snapshot refers to a saved
|
||||
state of the systemd manager. It 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
|
||||
time the user may return to this state
|
||||
by using the
|
||||
<command>isolate</command> command on
|
||||
the snapshot unit.</para></listitem>
|
||||
|
||||
<para>Snapshots are only useful for
|
||||
saving and restoring which units are
|
||||
running or are stopped, they do not
|
||||
save/restore any other
|
||||
state. Snapshots are dynamic and lost
|
||||
on reboot.</para>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>daemon-reload</command></term>
|
||||
|
||||
<listitem><para>Reload systemd manager
|
||||
configuration. This will reload all
|
||||
unit files and recreate the entire
|
||||
dependency tree. While the daemon is
|
||||
reloaded all sockets systemd listens
|
||||
on on behalf of user configuration will
|
||||
stay accessible.</para> <para>This
|
||||
command should not be confused with
|
||||
the <command>load</command> or
|
||||
<command>reload</command>
|
||||
commands.</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>daemon-reexec</command></term>
|
||||
|
||||
<listitem><para>Reexecute the systemd
|
||||
manager. This will serialize the
|
||||
manager state, reexecute the process
|
||||
and deserialize the state again. This
|
||||
command is of little use except for
|
||||
debugging and package
|
||||
upgrades. Sometimes it might be
|
||||
helpful as a heavy-weight
|
||||
<command>daemon-reload</command>. While
|
||||
the daemon is reexecuted all sockets
|
||||
systemd listens on on behalf of user
|
||||
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>
|
||||
|
||||
<listitem><para>Dump the systemd
|
||||
manager environment block. The
|
||||
environment block will be dumped in
|
||||
straight-forward form suitable for
|
||||
sourcing into a shell script. This
|
||||
environment block will be passed to
|
||||
all processes the manager
|
||||
spawns.</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>set-environment [NAME=VALUE...]</command></term>
|
||||
|
||||
<listitem><para>Set one or more
|
||||
systemd manager environment variables,
|
||||
as specified on the command
|
||||
line.</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>unset-environment [NAME...]</command></term>
|
||||
|
||||
<listitem><para>Unset one or more
|
||||
systemd manager environment
|
||||
variables. If only a variable name is
|
||||
specified it will be removed
|
||||
regardless of its value. If a variable
|
||||
and a value are specified the variable
|
||||
is only removed if it has the
|
||||
specified value.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><command>halt</command></term>
|
||||
|
||||
<listitem><para>Shut down and halt the
|
||||
system. This is mostly equivalent to
|
||||
<command>start halt.target</command>
|
||||
but also prints a wall message to all
|
||||
users.</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>poweroff</command></term>
|
||||
|
||||
<listitem><para>Shut down and
|
||||
power-off the system. This is mostly
|
||||
equivalent to <command>start
|
||||
poweroff.target</command> but also
|
||||
prints a wall message to all
|
||||
users.</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><command>reboot</command></term>
|
||||
|
||||
<listitem><para>Shut down and
|
||||
reboot the system. This is mostly
|
||||
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>
|
||||
</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.service</command> but also
|
||||
prints a wall message to all
|
||||
users.</para></listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Exit status</title>
|
||||
|
||||
<para>On success 0 is returned, a non-zero failure
|
||||
code otherwise.</para>
|
||||
</refsect1>
|
||||
|
||||
<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.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
371
man/systemd.xml
371
man/systemd.xml
|
|
@ -122,9 +122,9 @@
|
|||
|
||||
<listitem><para>Dump understood unit
|
||||
configuration items. This outputs a
|
||||
terse list of configuration items
|
||||
understood in unit definition
|
||||
files.</para></listitem>
|
||||
terse but complete list of
|
||||
configuration items understood in unit
|
||||
definition files.</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>--confirm-spawn</option></term>
|
||||
|
|
@ -192,32 +192,362 @@
|
|||
it defaults to
|
||||
<option>true</option>.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Directories</title>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Signal</title>
|
||||
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><filename>SIGTERM</filename></term>
|
||||
<term>System unit directories</term>
|
||||
|
||||
<listitem><para>systemd serializes its
|
||||
state, reexecutes itself and
|
||||
deserializes the saved state
|
||||
again. This is mostly equivalent to
|
||||
<command>systemctl
|
||||
daemon-reexec</command>.</para></listitem>
|
||||
<listitem><para>The systemd system
|
||||
manager reads unit configuration from
|
||||
various directories. Packages that
|
||||
want to install unit files shall place
|
||||
them in the directory returned by
|
||||
<command>pkg-config systemd
|
||||
--variable=systemdsystemunitdir</command>. Other
|
||||
directories checked are
|
||||
<filename>/usr/local/share/systemd/system</filename>
|
||||
and
|
||||
<filename>/usr/share/systemd/system</filename>. User
|
||||
configuration always takes
|
||||
precedence. <command>pkg-config
|
||||
systemd
|
||||
--variable=systemdsystemconfdir</command>
|
||||
returns the path of the system
|
||||
configuration directory. Packages
|
||||
should alter this directory only with
|
||||
the
|
||||
<citerefentry><refentrytitle>systemd-install</refentrytitle><manvolnum>1</manvolnum></citerefentry>
|
||||
tool.</para></listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>Session unit directories</term>
|
||||
|
||||
<listitem><para>Similar rules apply
|
||||
for the session unit
|
||||
directories. However, here the <ulink
|
||||
url="http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html">XDG
|
||||
Base Directory specification</ulink>
|
||||
is followed to find
|
||||
units. Applications should place their
|
||||
unit files in the directory returned
|
||||
by <command>pkg-config systemd
|
||||
--variable=systemdsessionunitdir</command>. Global
|
||||
configuration is done in the
|
||||
directory reported by
|
||||
<command>pkg-config systemd
|
||||
--variable=systemdsessionconfdir</command>. The
|
||||
<citerefentry><refentrytitle>systemd-install</refentrytitle><manvolnum>1</manvolnum></citerefentry>
|
||||
tool can handle both global (i.e. for
|
||||
all users) and private (for one user)
|
||||
enabling/disabling of
|
||||
units.</para></listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>SysV init scripts directory</term>
|
||||
|
||||
<listitem><para>The location of the
|
||||
SysV init script directory varies
|
||||
between distributions. If systemd
|
||||
cannot find a native unit file for a
|
||||
requested service it will look for a
|
||||
SysV init script of the same name
|
||||
(with the
|
||||
<filename>.service</filename> suffix
|
||||
removed).</para></listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>SysV runlevel link farm directory</term>
|
||||
|
||||
<listitem><para>The location of the
|
||||
SysV runlevel link farm directory
|
||||
varies between distributions. systemd
|
||||
will take the link farm into account
|
||||
when figuring out whether a service
|
||||
shall be enabled. Note that a service
|
||||
unit with a native unit configuration
|
||||
file can be started by activating it
|
||||
in the SysV runlevel link
|
||||
farm.</para></listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Signals</title>
|
||||
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>SIGTERM</term>
|
||||
|
||||
<listitem><para>Upon receiving this
|
||||
signal the systemd system manager
|
||||
serializes its state, reexecutes
|
||||
itself and deserializes the saved
|
||||
state again. This is mostly equivalent
|
||||
to <command>systemctl
|
||||
daemon-reexec</command>.</para>
|
||||
|
||||
<para>systemd session managers will
|
||||
start the
|
||||
<filename>exit.target</filename> unit
|
||||
when this signal is received. This is
|
||||
mostly equivalent to
|
||||
<command>systemctl --session start
|
||||
exit.target</command>.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>SIGINT</term>
|
||||
|
||||
<listitem><para>Upon receiving this
|
||||
signal the systemd system manager will
|
||||
start the
|
||||
<filename>ctrl-alt-del.target</filename> unit. This
|
||||
is mostly equivalent to
|
||||
<command>systemctl start
|
||||
ctl-alt-del.target</command>.</para>
|
||||
|
||||
<para>systemd session managers
|
||||
treat this signal the same way as
|
||||
SIGTERM.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>SIGWINCH</term>
|
||||
|
||||
<listitem><para>When this signal is
|
||||
received the systemd system manager
|
||||
will start the
|
||||
<filename>kbrequest.target</filename>
|
||||
unit. This is mostly equivalent to
|
||||
<command>systemctl start
|
||||
kbrequest.target</command>.</para>
|
||||
|
||||
<para>This signal is ignored by
|
||||
systemd session
|
||||
managers.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>SIGPWR</term>
|
||||
|
||||
<listitem><para>When this signal is
|
||||
received the systemd manager
|
||||
will start the
|
||||
<filename>sigpwr.target</filename>
|
||||
unit. This is mostly equivalent to
|
||||
<command>systemctl start
|
||||
sigpwr.target</command>.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>SIGUSR1</term>
|
||||
|
||||
<listitem><para>When this signal is
|
||||
received the systemd manager will try
|
||||
to reconnect to the D-Bus
|
||||
bus.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>SIGUSR2</term>
|
||||
|
||||
<listitem><para>When this signal is
|
||||
received the systemd manager will log
|
||||
its complete state in human readable
|
||||
form. The data logged is the same as
|
||||
printed by <command>systemctl
|
||||
dump</command>.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>SIGHUP</term>
|
||||
|
||||
<listitem><para>Reloads the complete
|
||||
daemon configuration. This is mostly
|
||||
equivalent to <command>systemctl
|
||||
daemon-reload</command>.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>SIGRTMIN+0</term>
|
||||
|
||||
<listitem><para>Enters default mode, starts the
|
||||
<filename>default.target</filename>
|
||||
unit. This is mostly equivalent to
|
||||
<command>systemctl start
|
||||
default.target</command>.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>SIGRTMIN+1</term>
|
||||
|
||||
<listitem><para>Enters rescue mode,
|
||||
starts the
|
||||
<filename>rescue.target</filename>
|
||||
unit. This is mostly equivalent to
|
||||
<command>systemctl isolate
|
||||
rescue.target</command>.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>SIGRTMIN+2</term>
|
||||
|
||||
<listitem><para>Enters emergency mode,
|
||||
starts the
|
||||
<filename>emergency.service</filename>
|
||||
unit. This is mostly equivalent to
|
||||
<command>systemctl isolate
|
||||
emergency.service</command>.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>SIGRTMIN+3</term>
|
||||
|
||||
<listitem><para>Halts the machine,
|
||||
starts the
|
||||
<filename>halt.target</filename>
|
||||
unit. This is mostly equivalent to
|
||||
<command>systemctl start
|
||||
halt.target</command>.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>SIGRTMIN+4</term>
|
||||
|
||||
<listitem><para>Powers off the machine,
|
||||
starts the
|
||||
<filename>poweroff.target</filename>
|
||||
unit. This is mostly equivalent to
|
||||
<command>systemctl start
|
||||
poweroff.target</command>.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>SIGRTMIN+5</term>
|
||||
|
||||
<listitem><para>Reboots the machine,
|
||||
starts the
|
||||
<filename>reboot.target</filename>
|
||||
unit. This is mostly equivalent to
|
||||
<command>systemctl start
|
||||
reboot.target</command>.</para></listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Environment</title>
|
||||
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><varname>$SYSTEMD_LOG_LEVEL</varname></term>
|
||||
<listitem><para>systemd reads the
|
||||
log level from this environment
|
||||
variable. This can be overriden with
|
||||
<option>--log-level=</option>.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><varname>$SYSTEMD_LOG_TARGET</varname></term>
|
||||
<listitem><para>systemd reads the
|
||||
log target from this environment
|
||||
variable. This can be overriden with
|
||||
<option>--log-target=</option>.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><varname>$SYSTEMD_LOG_COLOR</varname></term>
|
||||
<listitem><para>Controls whether
|
||||
systemd highlights important log
|
||||
messages. This can be overriden with
|
||||
<option>--log-color=</option>.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><varname>$SYSTEMD_LOG_LOCATION</varname></term>
|
||||
<listitem><para>Controls whether
|
||||
systemd prints the code location along
|
||||
with log messages. This can be
|
||||
overriden with
|
||||
<option>--log-location=</option>.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><varname>$XDG_CONFIG_HOME</varname></term>
|
||||
<term><varname>$XDG_CONFIG_DIRS</varname></term>
|
||||
<term><varname>$XDG_DATA_HOME</varname></term>
|
||||
<term><varname>$XDG_DATA_DIRS</varname></term>
|
||||
|
||||
<listitem><para>The systemd session
|
||||
manager uses these variables in
|
||||
accordance to the <ulink
|
||||
url="http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html">XDG
|
||||
Base Directory specification</ulink>
|
||||
to find its configuration.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><varname>$SYSTEMD_UNIT_PATH</varname></term>
|
||||
|
||||
<listitem><para>Controls where systemd
|
||||
looks for unit
|
||||
files.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><varname>$SYSTEMD_SYSVINIT_PATH</varname></term>
|
||||
|
||||
<listitem><para>Controls where systemd
|
||||
looks for SysV init scripts.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><varname>$SYSTEMD_SYSVRCND_PATH</varname></term>
|
||||
|
||||
<listitem><para>Controls where systemd
|
||||
looks for SysV init script runlevel link
|
||||
farms.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><varname>$LISTEN_PID</varname></term>
|
||||
<term><varname>$LISTEN_FDS</varname></term>
|
||||
|
||||
<listitem><para>Set by systemd for
|
||||
supervised processes during
|
||||
socket-based activation. See
|
||||
<citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry>
|
||||
for more information.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><varname>$NOTIFY_SOCKET</varname></term>
|
||||
|
||||
<listitem><para>Set by systemd for
|
||||
supervised processes for status and
|
||||
start-up completion notification. See
|
||||
<citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>
|
||||
for more information.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Sockets and FIFOs</title>
|
||||
|
|
@ -278,11 +608,18 @@
|
|||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>See Also</title>
|
||||
<para>
|
||||
<citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>systemadm</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>systemd-install</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>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>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
|||
|
|
@ -187,7 +187,8 @@
|
|||
<title>See Also</title>
|
||||
<para>
|
||||
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
|
||||
<citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue