picnoir
/
Systemd
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

man: add more formatting markup

This commit is contained in:
Zbigniew Jędrzejewski-Szmek 2013-06-29 12:09:14 -04:00
parent e9dd9f9547
commit 05cc726731
20 changed files with 104 additions and 92 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
man/daemon.xml
View File

@ -92,7 +92,7 @@
best done by iterating through the best done by iterating through the
available signals up to the limit of available signals up to the limit of
_NSIG and resetting them to _NSIG and resetting them to
SIG_DFL.</para></listitem> <constant>SIG_DFL</constant>.</para></listitem>
<listitem><para>Reset the signal mask <listitem><para>Reset the signal mask
using using
@ -237,11 +237,11 @@
to implement the following:</para> to implement the following:</para>
<orderedlist> <orderedlist>
<listitem><para>If SIGTERM is <listitem><para>If <constant>SIGTERM</constant> is
received, shut down the daemon and received, shut down the daemon and
exit cleanly.</para></listitem> exit cleanly.</para></listitem>
<listitem><para>If SIGHUP is received, <listitem><para>If <constant>SIGHUP</constant> is received,
reload the configuration files, if reload the configuration files, if
this applies.</para></listitem> this applies.</para></listitem>

19
man/hostnamectl.xml
View File

@ -129,7 +129,7 @@
<listitem><para>Execute the operation <listitem><para>Execute the operation
remotely. Specify a hostname, or remotely. Specify a hostname, or
username and hostname separated by @, username and hostname separated by <literal>@</literal>,
to connect to. This will use SSH to to connect to. This will use SSH to
talk to a remote talk to a remote
system.</para></listitem> system.</para></listitem>
@ -178,20 +178,21 @@
hostname will be simplified in regards hostname will be simplified in regards
to the character set used before the to the character set used before the
latter are updated. This is done by latter are updated. This is done by
replacing spaces with "-" and removing replacing spaces with
<literal>-</literal> and removing
special characters. This ensures that special characters. This ensures that
the pretty and the static hostname are the pretty and the static hostname are
always closely related while still always closely related while still
following the validity rules of the following the validity rules of the
specific name. This simplification of specific name. This simplification of
the hostname string is not done if the hostname string is not done if
only the transient and/or static only the transient and/or static host
hostnames are set, and the pretty names are set, and the pretty host
hostname is left untouched. Pass the name is left untouched. Pass the empty
empty string "" as the hostname to string <literal></literal> as the
reset the selected hostnames to their hostname to reset the selected
default (usually "localhost"). hostnames to their default (usually
</para></listitem> <literal>localhost</literal>).</para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>

2
man/localectl.xml
View File

@ -124,7 +124,7 @@
<listitem><para>Execute the operation <listitem><para>Execute the operation
remotely. Specify a hostname, or remotely. Specify a hostname, or
username and hostname separated by @, username and hostname separated by <literal>@</literal>,
to connect to. This will use SSH to to connect to. This will use SSH to
talk to a remote talk to a remote
system.</para></listitem> system.</para></listitem>

24
man/loginctl.xml
View File

@ -158,9 +158,11 @@
which signal to send to selected which signal to send to selected
processes. Must be one of the well processes. Must be one of the well
known signal specifiers, such as known signal specifiers, such as
SIGTERM, SIGINT or SIGSTOP. If omitted, <constant>SIGTERM</constant>,
defaults to <constant>SIGINT</constant> or
<option>SIGTERM</option>.</para></listitem> <constant>SIGSTOP</constant>. If
omitted defaults to
<constant>SIGTERM</constant>.</para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -169,7 +171,7 @@
<listitem><para>Execute operation <listitem><para>Execute operation
remotely. Specify a hostname, or remotely. Specify a hostname, or
username and hostname separated by @, username and hostname separated by <literal>@</literal>,
to connect to. This will use SSH to to connect to. This will use SSH to
talk to the remote login manager talk to the remote login manager
instance.</para></listitem> instance.</para></listitem>
@ -415,12 +417,14 @@
attach at least one graphics card to a attach at least one graphics card to a
previously unused seat name. Seat previously unused seat name. Seat
names may consist only of a-z, A-Z, names may consist only of a-z, A-Z,
0-9, "-" and "_" and must be prefixed 0-9, <literal>-</literal> and
with "seat". To drop assignment of a <literal>_</literal> and must be
device to a specific seat, just prefixed with <literal>seat</literal>.
reassign it to a different seat, or To drop assignment of a device to a
use specific seat, just reassign it to a
<command>flush-devices</command>.</para></listitem> different seat, or use
<command>flush-devices</command>.
</para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>

11
man/sd_id128_to_string.xml
View File

@ -72,14 +72,15 @@
formats a 128-bit ID as a character string. It expects formats a 128-bit ID as a character string. It expects
the ID and a string array capable of storing 33 the ID and a string array capable of storing 33
characters. The ID will be formatted as 32 lowercase characters. The ID will be formatted as 32 lowercase
hexadecimal digits and be terminated by a NUL hexadecimal digits and be terminated by a
byte.</para> <constant>NUL</constant> byte.</para>
<para><function>sd_id128_from_string()</function> <para><function>sd_id128_from_string()</function>
implements the reverse operation: it takes a 33 implements the reverse operation: it takes a 33
character string with 32 hexadecimal digits character string with 32 hexadecimal digits (either
(either lowercase or uppercase, terminated by NUL) and lowercase or uppercase, terminated by
parses them back into a 128-bit ID returned in <constant>NUL</constant>) and parses them back into a
128-bit ID returned in
<parameter>ret</parameter>. Alternatively, this call <parameter>ret</parameter>. Alternatively, this call
can also parse a 37-character string with a 128-bit ID can also parse a 37-character string with a 128-bit ID
formatted as RFC UUID.</para> formatted as RFC UUID.</para>

11
man/sd_is_fifo.xml
View File

@ -102,8 +102,9 @@
<para><function>sd_is_fifo()</function> may be called <para><function>sd_is_fifo()</function> may be called
to check whether the specified file descriptor refers to check whether the specified file descriptor refers
to a FIFO or pipe. If the <parameter>path</parameter> to a FIFO or pipe. If the <parameter>path</parameter>
parameter is not NULL, it is checked whether the FIFO parameter is not <constant>NULL</constant>, it is
is bound to the specified file system path.</para> checked whether the FIFO is bound to the specified
file system path.</para>
<para><function>sd_is_socket()</function> may be <para><function>sd_is_socket()</function> may be
called to check whether the specified file descriptor called to check whether the specified file descriptor
@ -149,9 +150,9 @@
<para><function>sd_is_mq()</function> may be called to <para><function>sd_is_mq()</function> may be called to
check whether the specified file descriptor refers to check whether the specified file descriptor refers to
a POSIX message queue. If the a POSIX message queue. If the
<parameter>path</parameter> parameter is not NULL, it <parameter>path</parameter> parameter is not
is checked whether the message queue is bound to the <constant>NULL</constant>, it is checked whether the
specified name.</para> message queue is bound to the specified name.</para>
</refsect1> </refsect1>
<refsect1> <refsect1>

2
man/sd_notify.xml
View File

@ -220,7 +220,7 @@
<constant>AF_UNIX</constant> socket referenced in the <constant>AF_UNIX</constant> socket referenced in the
<varname>$NOTIFY_SOCKET</varname> environment <varname>$NOTIFY_SOCKET</varname> environment
variable. If the first character of variable. If the first character of
<varname>$NOTIFY_SOCKET</varname> is @ the string is <varname>$NOTIFY_SOCKET</varname> is <literal>@</literal> the string is
understood as Linux abstract namespace socket. The understood as Linux abstract namespace socket. The
datagram is accompanied by the process credentials of datagram is accompanied by the process credentials of
the sending daemon, using SCM_CREDENTIALS.</para> the sending daemon, using SCM_CREDENTIALS.</para>

7
man/sd_seat_get_active.xml
View File

@ -93,9 +93,10 @@
a seat, if there is any. Returns the session a seat, if there is any. Returns the session
identifier and the user identifier of the Unix user identifier and the user identifier of the Unix user
the session is belonging to. Either the session or the the session is belonging to. Either the session or the
user identifier parameter can be passed NULL, in user identifier parameter can be passed
case only one of the parameters shall be queried. The <constant>NULL</constant>, in case only one of the
returned string needs to be freed with the libc parameters shall be queried. The returned string needs
to be freed with the libc
<citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry> <citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
call after use.</para> call after use.</para>

6
man/systemctl.xml
View File

@ -382,8 +382,8 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
<listitem> <listitem>
<para>When used with <command>kill</command>, choose which <para>When used with <command>kill</command>, choose which
signal to send to selected processes. Must be one of the signal to send to selected processes. Must be one of the
well known signal specifiers such as SIGTERM, SIGINT or well known signal specifiers such as <constant>SIGTERM</constant>, <constant>SIGINT</constant> or
SIGSTOP. If omitted defaults to <constant>SIGSTOP</constant>. If omitted defaults to
<option>SIGTERM</option>.</para> <option>SIGTERM</option>.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -453,7 +453,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
<listitem> <listitem>
<para>Execute operation remotely. Specify a hostname, or <para>Execute operation remotely. Specify a hostname, or
username and hostname separated by @, to connect to. This username and hostname separated by <literal>@</literal>, to connect to. This
will use SSH to talk to the remote systemd will use SSH to talk to the remote systemd
instance.</para> instance.</para>
</listitem> </listitem>

23
man/systemd.exec.xml
View File

@ -326,15 +326,16 @@
<para>The argument passed should be an <para>The argument passed should be an
absolute filename or wildcard absolute filename or wildcard
expression, optionally prefixed with expression, optionally prefixed with
"-", which indicates that if the file <literal>-</literal>, which indicates
does not exist it won't be read and no that if the file does not exist it
error or warning message is logged. won't be read and no error or warning
This option may be specified more than message is logged. This option may be
once in which case all specified files specified more than once in which case
are read. If the empty string is all specified files are read. If the
assigned to this option the list of empty string is assigned to this
file to read is reset, all prior option the list of file to read is
assignments have no effect.</para> reset, all prior assignments have no
effect.</para>
<para>The files listed with this <para>The files listed with this
directive will be read shortly before directive will be read shortly before
@ -1184,10 +1185,10 @@
<term><varname>IgnoreSIGPIPE=</varname></term> <term><varname>IgnoreSIGPIPE=</varname></term>
<listitem><para>Takes a boolean <listitem><para>Takes a boolean
argument. If true, causes SIGPIPE to be argument. If true, causes <constant>SIGPIPE</constant> to be
ignored in the executed ignored in the executed
process. Defaults to true because process. Defaults to true because
SIGPIPE generally is useful only in <constant>SIGPIPE</constant> generally is useful only in
shell pipelines.</para></listitem> shell pipelines.</para></listitem>
</varlistentry> </varlistentry>

8
man/systemd.kill.xml
View File

@ -115,14 +115,14 @@
<option>control-group</option>.</para> <option>control-group</option>.</para>
<para>Processes will first be <para>Processes will first be
terminated via SIGTERM (unless the terminated via <constant>SIGTERM</constant> (unless the
signal to send is changed via signal to send is changed via
<varname>KillSignal=</varname>). If <varname>KillSignal=</varname>). If
then after a delay (configured via the then after a delay (configured via the
<varname>TimeoutSec=</varname> option) <varname>TimeoutSec=</varname> option)
processes still remain, the processes still remain, the
termination request is repeated with termination request is repeated with
the SIGKILL signal (unless this is the <constant>SIGKILL</constant> signal (unless this is
disabled via the disabled via the
<varname>SendSIGKILL=</varname> <varname>SendSIGKILL=</varname>
option). See option). See
@ -135,14 +135,14 @@
<term><varname>KillSignal=</varname></term> <term><varname>KillSignal=</varname></term>
<listitem><para>Specifies which signal <listitem><para>Specifies which signal
to use when killing a to use when killing a
service. Defaults to SIGTERM. service. Defaults to <constant>SIGTERM</constant>.
</para></listitem> </para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>SendSIGKILL=</varname></term> <term><varname>SendSIGKILL=</varname></term>
<listitem><para>Specifies whether to <listitem><para>Specifies whether to
send SIGKILL to remaining processes send <constant>SIGKILL</constant> to remaining processes
after a timeout, if the normal after a timeout, if the normal
shutdown procedure left processes of shutdown procedure left processes of
the service around. Takes a boolean the service around. Takes a boolean

4
man/systemd.mount.xml
View File

@ -249,8 +249,8 @@
will be considered failed and be shut will be considered failed and be shut
down again. All commands still running down again. All commands still running
will be terminated forcibly via will be terminated forcibly via
SIGTERM, and after another delay of <constant>SIGTERM</constant>, and after another delay of
this time with SIGKILL. (See this time with <constant>SIGKILL</constant>. (See
<option>KillMode=</option> in <option>KillMode=</option> in
<citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>.) <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>.)
Takes a unit-less value in seconds, or Takes a unit-less value in seconds, or

14
man/systemd.service.xml
View File

@ -529,9 +529,9 @@
wait for stop. If a service is asked wait for stop. If a service is asked
to stop but does not terminate in the to stop but does not terminate in the
specified time, it will be terminated specified time, it will be terminated
forcibly via SIGTERM, and after forcibly via <constant>SIGTERM</constant>, and after
another delay of this time with another delay of this time with
SIGKILL (See <constant>SIGKILL</constant> (See
<varname>KillMode=</varname> <varname>KillMode=</varname>
in <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>). in <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
Takes a unit-less value in seconds, or a Takes a unit-less value in seconds, or a
@ -620,7 +620,7 @@
exits cleanly. exits cleanly.
In this context, a clean exit means In this context, a clean exit means
an exit code of 0, or one of the signals an exit code of 0, or one of the signals
SIGHUP, SIGINT, SIGTERM, or SIGPIPE, and <constant>SIGHUP</constant>, <constant>SIGINT</constant>, <constant>SIGTERM</constant>, or <constant>SIGPIPE</constant>, and
additionally, exit statuses and signals additionally, exit statuses and signals
specified in <varname>SuccessExitStatus=</varname>. specified in <varname>SuccessExitStatus=</varname>.
If set to <option>on-failure</option> If set to <option>on-failure</option>
@ -657,15 +657,15 @@
by the main service process will be by the main service process will be
considered successful termination, in considered successful termination, in
addition to the normal successful exit addition to the normal successful exit
code 0 and the signals SIGHUP, SIGINT, code 0 and the signals <constant>SIGHUP</constant>, <constant>SIGINT</constant>,
SIGTERM and SIGPIPE. Exit status <constant>SIGTERM</constant> and <constant>SIGPIPE</constant>. Exit status
definitions can either be numeric exit definitions can either be numeric exit
codes or termination signal names, codes or termination signal names,
separated by spaces. Example: separated by spaces. Example:
<literal>SuccessExitStatus=1 2 8 <literal>SuccessExitStatus=1 2 8
SIGKILL</literal>, ensures that exit <constant>SIGKILL</constant></literal>, ensures that exit
codes 1, 2, 8 and the termination codes 1, 2, 8 and the termination
signal SIGKILL are considered clean signal <constant>SIGKILL</constant> are considered clean
service terminations. This option may service terminations. This option may
appear more than once in which case appear more than once in which case
the list of successful exit statuses the list of successful exit statuses

20
man/systemd.socket.xml
View File

@ -156,16 +156,18 @@
can be written in various formats:</para> can be written in various formats:</para>
<para>If the address starts with a <para>If the address starts with a
slash (/), it is read as file system slash (<literal>/</literal>), it is read as file system
socket in the <constant>AF_UNIX</constant> socket socket in the <constant>AF_UNIX</constant> socket
family.</para> family.</para>
<para>If the address starts with an <para>If the address starts with an at
at symbol (@) it is read as abstract symbol (<literal>@</literal>) it is read as abstract
namespace socket in the <constant>AF_UNIX</constant> namespace socket in the
family. The @ is replaced with a NUL <constant>AF_UNIX</constant>
character before binding. For details family. The <literal>@</literal> is
see replaced with a
<constant>NUL</constant> character
before binding. For details see
<citerefentry><refentrytitle>unix</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para> <citerefentry><refentrytitle>unix</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para>
<para>If the address string is a <para>If the address string is a
@ -657,8 +659,8 @@
will be considered failed and be shut will be considered failed and be shut
down again. All commands still running, down again. All commands still running,
will be terminated forcibly via will be terminated forcibly via
SIGTERM, and after another delay of <constant>SIGTERM</constant>, and after another delay of
this time with SIGKILL. (See this time with <constant>SIGKILL</constant>. (See
<option>KillMode=</option> in <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>.) <option>KillMode=</option> in <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>.)
Takes a unit-less value in seconds, or Takes a unit-less value in seconds, or
a time span value such as "5min a time span value such as "5min

2
man/systemd.special.xml
View File

@ -1007,7 +1007,7 @@
terminate the user service terminate the user service
manager should start this manager should start this
unit. If systemd receives unit. If systemd receives
SIGTERM or SIGINT when running <constant>SIGTERM</constant> or <constant>SIGINT</constant> when running
as user service daemon it will as user service daemon it will
start this unit.</para> start this unit.</para>

4
man/systemd.swap.xml
View File

@ -176,8 +176,8 @@
will be considered failed and be shut will be considered failed and be shut
down again. All commands still running down again. All commands still running
will be terminated forcibly via will be terminated forcibly via
SIGTERM, and after another delay of <constant>SIGTERM</constant>, and after another delay of
this time with SIGKILL. (See this time with <constant>SIGKILL</constant>. (See
<option>KillMode=</option> in <option>KillMode=</option> in
<citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>.) <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>.)
Takes a unit-less value in seconds, or Takes a unit-less value in seconds, or

23
man/systemd.time.xml
View File

@ -214,23 +214,24 @@
specified, it should consist of one or more English specified, it should consist of one or more English
language weekday names, either in the abbreviated language weekday names, either in the abbreviated
(Wed) or non-abbreviated (Wednesday) form (case does (Wed) or non-abbreviated (Wednesday) form (case does
not matter), separated by commas. Specifying two weekdays not matter), separated by commas. Specifying two
separated by "-" refers to a range of continuous weekdays separated by <literal>-</literal> refers to a
weekdays. "," and "-" may be combined freely.</para> range of continuous weekdays. <literal>,</literal> and
<literal>-</literal> may be combined freely.</para>
<para>In the date and time specifications, any <para>In the date and time specifications, any
component may be specified as "*" in which case any component may be specified as <literal>*</literal> in
value will match. Alternatively, each component can be which case any value will match. Alternatively, each
specified as list of values separated by component can be specified as list of values separated
commas. Values may also be suffixed with "/" and a by commas. Values may also be suffixed with
repetition value, which indicates that the value and <literal>/</literal> and a repetition value, which
all values plus multiples of the repetition value are indicates that the value and all values plus multiples
matched.</para> of the repetition value are matched.</para>
<para>Either time or date specification may be <para>Either time or date specification may be
omitted, in which case the current day and 00:00:00 is omitted, in which case the current day and 00:00:00 is
implied, respectively. If the second component is not implied, respectively. If the second component is not
specified ":00" is assumed.</para> specified <literal>:00</literal> is assumed.</para>
<para>Timezone names may not be specified.</para> <para>Timezone names may not be specified.</para>

6
man/systemd.unit.xml
View File

@ -214,9 +214,9 @@
systemd looks for a unit configuration file it will systemd looks for a unit configuration file it will
first search for the literal unit name in the first search for the literal unit name in the
filesystem. If that yields no success and the unit filesystem. If that yields no success and the unit
name contains an @ character, systemd will look for a name contains an <literal>@</literal> character, systemd will look for a
unit template that shares the same name but with the unit template that shares the same name but with the
instance string (i.e. the part between the @ character instance string (i.e. the part between the <literal>@</literal> character
and the suffix) removed. Example: if a service and the suffix) removed. Example: if a service
<filename>getty@tty3.service</filename> is requested <filename>getty@tty3.service</filename> is requested
and no file by that name is found, systemd will look and no file by that name is found, systemd will look
@ -1198,7 +1198,7 @@
<row> <row>
<entry><literal>%i</literal></entry> <entry><literal>%i</literal></entry>
<entry>Instance name</entry> <entry>Instance name</entry>
<entry>For instantiated units: this is the string between the @ character and the suffix.</entry> <entry>For instantiated units: this is the string between the <literal>@</literal> character and the suffix.</entry>
</row> </row>
<row> <row>
<entry><literal>%I</literal></entry> <entry><literal>%I</literal></entry>

2
man/systemd.xml
View File

@ -643,7 +643,7 @@
<para>systemd user managers <para>systemd user managers
treat this signal the same way as treat this signal the same way as
SIGTERM.</para></listitem> <constant>SIGTERM</constant>.</para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>

2
man/timedatectl.xml
View File

@ -111,7 +111,7 @@
<listitem><para>Execute the operation <listitem><para>Execute the operation
remotely. Specify a hostname, or remotely. Specify a hostname, or
username and hostname separated by @, username and hostname separated by <literal>@</literal>,
to connect to. This will use SSH to to connect to. This will use SSH to
talk to a remote talk to a remote
system.</para></listitem> system.</para></listitem>