summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2013-06-29 12:09:14 -0400
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2013-07-02 23:06:22 -0400
commit05cc726731c5cec952722f1c14acb08e3d4d5e98 (patch)
treeff2fa1545aa2b02e2102f1f4e769e8063d5a50dd /man
parente9dd9f9547350c7dc0473583b5c2228dc8f0ab76 (diff)
man: add more formatting markup
Diffstat (limited to 'man')
-rw-r--r--man/daemon.xml6
-rw-r--r--man/hostnamectl.xml19
-rw-r--r--man/localectl.xml2
-rw-r--r--man/loginctl.xml24
-rw-r--r--man/sd_id128_to_string.xml11
-rw-r--r--man/sd_is_fifo.xml11
-rw-r--r--man/sd_notify.xml2
-rw-r--r--man/sd_seat_get_active.xml7
-rw-r--r--man/systemctl.xml6
-rw-r--r--man/systemd.exec.xml23
-rw-r--r--man/systemd.kill.xml8
-rw-r--r--man/systemd.mount.xml4
-rw-r--r--man/systemd.service.xml14
-rw-r--r--man/systemd.socket.xml20
-rw-r--r--man/systemd.special.xml2
-rw-r--r--man/systemd.swap.xml4
-rw-r--r--man/systemd.time.xml23
-rw-r--r--man/systemd.unit.xml6
-rw-r--r--man/systemd.xml2
-rw-r--r--man/timedatectl.xml2
20 files changed, 104 insertions, 92 deletions
diff --git a/man/daemon.xml b/man/daemon.xml
index 258694080e..76ae832a42 100644
--- a/man/daemon.xml
+++ b/man/daemon.xml
@@ -92,7 +92,7 @@
best done by iterating through the
available signals up to the limit of
_NSIG and resetting them to
- SIG_DFL.</para></listitem>
+ <constant>SIG_DFL</constant>.</para></listitem>
<listitem><para>Reset the signal mask
using
@@ -237,11 +237,11 @@
to implement the following:</para>
<orderedlist>
- <listitem><para>If SIGTERM is
+ <listitem><para>If <constant>SIGTERM</constant> is
received, shut down the daemon and
exit cleanly.</para></listitem>
- <listitem><para>If SIGHUP is received,
+ <listitem><para>If <constant>SIGHUP</constant> is received,
reload the configuration files, if
this applies.</para></listitem>
diff --git a/man/hostnamectl.xml b/man/hostnamectl.xml
index d7a9e92879..28e875dafd 100644
--- a/man/hostnamectl.xml
+++ b/man/hostnamectl.xml
@@ -129,7 +129,7 @@
<listitem><para>Execute the operation
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
talk to a remote
system.</para></listitem>
@@ -178,20 +178,21 @@
hostname will be simplified in regards
to the character set used before the
latter are updated. This is done by
- replacing spaces with "-" and removing
+ replacing spaces with
+ <literal>-</literal> and removing
special characters. This ensures that
the pretty and the static hostname are
always closely related while still
following the validity rules of the
specific name. This simplification of
the hostname string is not done if
- only the transient and/or static
- hostnames are set, and the pretty
- hostname is left untouched. Pass the
- empty string "" as the hostname to
- reset the selected hostnames to their
- default (usually "localhost").
- </para></listitem>
+ only the transient and/or static host
+ names are set, and the pretty host
+ name is left untouched. Pass the empty
+ string <literal></literal> as the
+ hostname to reset the selected
+ hostnames to their default (usually
+ <literal>localhost</literal>).</para></listitem>
</varlistentry>
<varlistentry>
diff --git a/man/localectl.xml b/man/localectl.xml
index 4a0457018f..f14393071a 100644
--- a/man/localectl.xml
+++ b/man/localectl.xml
@@ -124,7 +124,7 @@
<listitem><para>Execute the operation
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
talk to a remote
system.</para></listitem>
diff --git a/man/loginctl.xml b/man/loginctl.xml
index f10ca030c9..790a3e4bf8 100644
--- a/man/loginctl.xml
+++ b/man/loginctl.xml
@@ -158,9 +158,11 @@
which signal to send to selected
processes. Must be one of the well
known signal specifiers, such as
- SIGTERM, SIGINT or SIGSTOP. If omitted,
- defaults to
- <option>SIGTERM</option>.</para></listitem>
+ <constant>SIGTERM</constant>,
+ <constant>SIGINT</constant> or
+ <constant>SIGSTOP</constant>. If
+ omitted defaults to
+ <constant>SIGTERM</constant>.</para></listitem>
</varlistentry>
<varlistentry>
@@ -169,7 +171,7 @@
<listitem><para>Execute operation
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
talk to the remote login manager
instance.</para></listitem>
@@ -415,12 +417,14 @@
attach at least one graphics card to a
previously unused seat name. Seat
names may consist only of a-z, A-Z,
- 0-9, "-" and "_" and must be prefixed
- with "seat". To drop assignment of a
- device to a specific seat, just
- reassign it to a different seat, or
- use
- <command>flush-devices</command>.</para></listitem>
+ 0-9, <literal>-</literal> and
+ <literal>_</literal> and must be
+ prefixed with <literal>seat</literal>.
+ To drop assignment of a device to a
+ specific seat, just reassign it to a
+ different seat, or use
+ <command>flush-devices</command>.
+ </para></listitem>
</varlistentry>
<varlistentry>
diff --git a/man/sd_id128_to_string.xml b/man/sd_id128_to_string.xml
index 3da5b70f80..71cf82a6cd 100644
--- a/man/sd_id128_to_string.xml
+++ b/man/sd_id128_to_string.xml
@@ -72,14 +72,15 @@
formats a 128-bit ID as a character string. It expects
the ID and a string array capable of storing 33
characters. The ID will be formatted as 32 lowercase
- hexadecimal digits and be terminated by a NUL
- byte.</para>
+ hexadecimal digits and be terminated by a
+ <constant>NUL</constant> byte.</para>
<para><function>sd_id128_from_string()</function>
implements the reverse operation: it takes a 33
- character string with 32 hexadecimal digits
- (either lowercase or uppercase, terminated by NUL) and
- parses them back into a 128-bit ID returned in
+ character string with 32 hexadecimal digits (either
+ lowercase or uppercase, terminated by
+ <constant>NUL</constant>) and parses them back into a
+ 128-bit ID returned in
<parameter>ret</parameter>. Alternatively, this call
can also parse a 37-character string with a 128-bit ID
formatted as RFC UUID.</para>
diff --git a/man/sd_is_fifo.xml b/man/sd_is_fifo.xml
index c136b37d8f..a790c370e1 100644
--- a/man/sd_is_fifo.xml
+++ b/man/sd_is_fifo.xml
@@ -102,8 +102,9 @@
<para><function>sd_is_fifo()</function> may be called
to check whether the specified file descriptor refers
to a FIFO or pipe. If the <parameter>path</parameter>
- parameter is not NULL, it is checked whether the FIFO
- is bound to the specified file system path.</para>
+ parameter is not <constant>NULL</constant>, it is
+ checked whether the FIFO is bound to the specified
+ file system path.</para>
<para><function>sd_is_socket()</function> may be
called to check whether the specified file descriptor
@@ -149,9 +150,9 @@
<para><function>sd_is_mq()</function> may be called to
check whether the specified file descriptor refers to
a POSIX message queue. If the
- <parameter>path</parameter> parameter is not NULL, it
- is checked whether the message queue is bound to the
- specified name.</para>
+ <parameter>path</parameter> parameter is not
+ <constant>NULL</constant>, it is checked whether the
+ message queue is bound to the specified name.</para>
</refsect1>
<refsect1>
diff --git a/man/sd_notify.xml b/man/sd_notify.xml
index a7bf17f9c6..7d96890397 100644
--- a/man/sd_notify.xml
+++ b/man/sd_notify.xml
@@ -220,7 +220,7 @@
<constant>AF_UNIX</constant> socket referenced in the
<varname>$NOTIFY_SOCKET</varname> environment
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
datagram is accompanied by the process credentials of
the sending daemon, using SCM_CREDENTIALS.</para>
diff --git a/man/sd_seat_get_active.xml b/man/sd_seat_get_active.xml
index 8b32bdc669..3c26fb1e29 100644
--- a/man/sd_seat_get_active.xml
+++ b/man/sd_seat_get_active.xml
@@ -93,9 +93,10 @@
a seat, if there is any. Returns the session
identifier and the user identifier of the Unix user
the session is belonging to. Either the session or the
- user identifier parameter can be passed NULL, in
- case only one of the parameters shall be queried. The
- returned string needs to be freed with the libc
+ user identifier parameter can be passed
+ <constant>NULL</constant>, in case only one of the
+ parameters shall be queried. The returned string needs
+ to be freed with the libc
<citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
call after use.</para>
diff --git a/man/systemctl.xml b/man/systemctl.xml
index 84a149c3d0..632a26dedb 100644
--- a/man/systemctl.xml
+++ b/man/systemctl.xml
@@ -382,8 +382,8 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
<listitem>
<para>When used with <command>kill</command>, choose which
signal to send to selected processes. Must be one of the
- well known signal specifiers such as SIGTERM, SIGINT or
- SIGSTOP. If omitted defaults to
+ well known signal specifiers such as <constant>SIGTERM</constant>, <constant>SIGINT</constant> or
+ <constant>SIGSTOP</constant>. If omitted defaults to
<option>SIGTERM</option>.</para>
</listitem>
</varlistentry>
@@ -453,7 +453,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
<listitem>
<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
instance.</para>
</listitem>
diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml
index d6fc324b5d..4294e54a55 100644
--- a/man/systemd.exec.xml
+++ b/man/systemd.exec.xml
@@ -326,15 +326,16 @@
<para>The argument passed should be an
absolute filename or wildcard
expression, optionally prefixed with
- "-", which indicates that if the file
- does not exist it won't be read and no
- error or warning message is logged.
- This option may be specified more than
- once in which case all specified files
- are read. If the empty string is
- assigned to this option the list of
- file to read is reset, all prior
- assignments have no effect.</para>
+ <literal>-</literal>, which indicates
+ that if the file does not exist it
+ won't be read and no error or warning
+ message is logged. This option may be
+ specified more than once in which case
+ all specified files are read. If the
+ empty string is assigned to this
+ option the list of file to read is
+ reset, all prior assignments have no
+ effect.</para>
<para>The files listed with this
directive will be read shortly before
@@ -1184,10 +1185,10 @@
<term><varname>IgnoreSIGPIPE=</varname></term>
<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
process. Defaults to true because
- SIGPIPE generally is useful only in
+ <constant>SIGPIPE</constant> generally is useful only in
shell pipelines.</para></listitem>
</varlistentry>
diff --git a/man/systemd.kill.xml b/man/systemd.kill.xml
index b41ce460b5..2a810e257f 100644
--- a/man/systemd.kill.xml
+++ b/man/systemd.kill.xml
@@ -115,14 +115,14 @@
<option>control-group</option>.</para>
<para>Processes will first be
- terminated via SIGTERM (unless the
+ terminated via <constant>SIGTERM</constant> (unless the
signal to send is changed via
<varname>KillSignal=</varname>). If
then after a delay (configured via the
<varname>TimeoutSec=</varname> option)
processes still remain, the
termination request is repeated with
- the SIGKILL signal (unless this is
+ the <constant>SIGKILL</constant> signal (unless this is
disabled via the
<varname>SendSIGKILL=</varname>
option). See
@@ -135,14 +135,14 @@
<term><varname>KillSignal=</varname></term>
<listitem><para>Specifies which signal
to use when killing a
- service. Defaults to SIGTERM.
+ service. Defaults to <constant>SIGTERM</constant>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>SendSIGKILL=</varname></term>
<listitem><para>Specifies whether to
- send SIGKILL to remaining processes
+ send <constant>SIGKILL</constant> to remaining processes
after a timeout, if the normal
shutdown procedure left processes of
the service around. Takes a boolean
diff --git a/man/systemd.mount.xml b/man/systemd.mount.xml
index d47fb93669..07f21025b8 100644
--- a/man/systemd.mount.xml
+++ b/man/systemd.mount.xml
@@ -249,8 +249,8 @@
will be considered failed and be shut
down again. All commands still running
will be terminated forcibly via
- SIGTERM, and after another delay of
- this time with SIGKILL. (See
+ <constant>SIGTERM</constant>, and after another delay of
+ this time with <constant>SIGKILL</constant>. (See
<option>KillMode=</option> in
<citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>.)
Takes a unit-less value in seconds, or
diff --git a/man/systemd.service.xml b/man/systemd.service.xml
index fab0c4de27..abe3a8d673 100644
--- a/man/systemd.service.xml
+++ b/man/systemd.service.xml
@@ -529,9 +529,9 @@
wait for stop. If a service is asked
to stop but does not terminate in the
specified time, it will be terminated
- forcibly via SIGTERM, and after
+ forcibly via <constant>SIGTERM</constant>, and after
another delay of this time with
- SIGKILL (See
+ <constant>SIGKILL</constant> (See
<varname>KillMode=</varname>
in <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
Takes a unit-less value in seconds, or a
@@ -620,7 +620,7 @@
exits cleanly.
In this context, a clean exit means
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
specified in <varname>SuccessExitStatus=</varname>.
If set to <option>on-failure</option>
@@ -657,15 +657,15 @@
by the main service process will be
considered successful termination, in
addition to the normal successful exit
- code 0 and the signals SIGHUP, SIGINT,
- SIGTERM and SIGPIPE. Exit status
+ code 0 and the signals <constant>SIGHUP</constant>, <constant>SIGINT</constant>,
+ <constant>SIGTERM</constant> and <constant>SIGPIPE</constant>. Exit status
definitions can either be numeric exit
codes or termination signal names,
separated by spaces. Example:
<literal>SuccessExitStatus=1 2 8
- SIGKILL</literal>, ensures that exit
+ <constant>SIGKILL</constant></literal>, ensures that exit
codes 1, 2, 8 and the termination
- signal SIGKILL are considered clean
+ signal <constant>SIGKILL</constant> are considered clean
service terminations. This option may
appear more than once in which case
the list of successful exit statuses
diff --git a/man/systemd.socket.xml b/man/systemd.socket.xml
index 0ff3ca22ac..0a2d86996b 100644
--- a/man/systemd.socket.xml
+++ b/man/systemd.socket.xml
@@ -156,16 +156,18 @@
can be written in various formats:</para>
<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
family.</para>
- <para>If the address starts with an
- at symbol (@) it is read as abstract
- namespace socket in the <constant>AF_UNIX</constant>
- family. The @ is replaced with a NUL
- character before binding. For details
- see
+ <para>If the address starts with an at
+ symbol (<literal>@</literal>) it is read as abstract
+ namespace socket in the
+ <constant>AF_UNIX</constant>
+ family. The <literal>@</literal> is
+ replaced with a
+ <constant>NUL</constant> character
+ before binding. For details see
<citerefentry><refentrytitle>unix</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para>
<para>If the address string is a
@@ -657,8 +659,8 @@
will be considered failed and be shut
down again. All commands still running,
will be terminated forcibly via
- SIGTERM, and after another delay of
- this time with SIGKILL. (See
+ <constant>SIGTERM</constant>, and after another delay of
+ this time with <constant>SIGKILL</constant>. (See
<option>KillMode=</option> in <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>.)
Takes a unit-less value in seconds, or
a time span value such as "5min
diff --git a/man/systemd.special.xml b/man/systemd.special.xml
index 4588f58999..d1cd81f1d1 100644
--- a/man/systemd.special.xml
+++ b/man/systemd.special.xml
@@ -1007,7 +1007,7 @@
terminate the user service
manager should start this
unit. If systemd receives
- SIGTERM or SIGINT when running
+ <constant>SIGTERM</constant> or <constant>SIGINT</constant> when running
as user service daemon it will
start this unit.</para>
diff --git a/man/systemd.swap.xml b/man/systemd.swap.xml
index 8268e6164d..9a3905a927 100644
--- a/man/systemd.swap.xml
+++ b/man/systemd.swap.xml
@@ -176,8 +176,8 @@
will be considered failed and be shut
down again. All commands still running
will be terminated forcibly via
- SIGTERM, and after another delay of
- this time with SIGKILL. (See
+ <constant>SIGTERM</constant>, and after another delay of
+ this time with <constant>SIGKILL</constant>. (See
<option>KillMode=</option> in
<citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>.)
Takes a unit-less value in seconds, or
diff --git a/man/systemd.time.xml b/man/systemd.time.xml
index 79ebdc5dfc..4f6dd0f086 100644
--- a/man/systemd.time.xml
+++ b/man/systemd.time.xml
@@ -214,23 +214,24 @@
specified, it should consist of one or more English
language weekday names, either in the abbreviated
(Wed) or non-abbreviated (Wednesday) form (case does
- not matter), separated by commas. Specifying two weekdays
- separated by "-" refers to a range of continuous
- weekdays. "," and "-" may be combined freely.</para>
+ not matter), separated by commas. Specifying two
+ weekdays separated by <literal>-</literal> refers to a
+ range of continuous weekdays. <literal>,</literal> and
+ <literal>-</literal> may be combined freely.</para>
<para>In the date and time specifications, any
- component may be specified as "*" in which case any
- value will match. Alternatively, each component can be
- specified as list of values separated by
- commas. Values may also be suffixed with "/" and a
- repetition value, which indicates that the value and
- all values plus multiples of the repetition value are
- matched.</para>
+ component may be specified as <literal>*</literal> in
+ which case any value will match. Alternatively, each
+ component can be specified as list of values separated
+ by commas. Values may also be suffixed with
+ <literal>/</literal> and a repetition value, which
+ indicates that the value and all values plus multiples
+ of the repetition value are matched.</para>
<para>Either time or date specification may be
omitted, in which case the current day and 00:00:00 is
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>
diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml
index 552c747695..1fd609dc85 100644
--- a/man/systemd.unit.xml
+++ b/man/systemd.unit.xml
@@ -214,9 +214,9 @@
systemd looks for a unit configuration file it will
first search for the literal unit name in the
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
- 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
<filename>getty@tty3.service</filename> is requested
and no file by that name is found, systemd will look
@@ -1198,7 +1198,7 @@
<row>
<entry><literal>%i</literal></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>
<entry><literal>%I</literal></entry>
diff --git a/man/systemd.xml b/man/systemd.xml
index 5f941e5f94..b4b4845305 100644
--- a/man/systemd.xml
+++ b/man/systemd.xml
@@ -643,7 +643,7 @@
<para>systemd user managers
treat this signal the same way as
- SIGTERM.</para></listitem>
+ <constant>SIGTERM</constant>.</para></listitem>
</varlistentry>
<varlistentry>
diff --git a/man/timedatectl.xml b/man/timedatectl.xml
index 77af2ad460..16ee3df4be 100644
--- a/man/timedatectl.xml
+++ b/man/timedatectl.xml
@@ -111,7 +111,7 @@
<listitem><para>Execute the operation
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
talk to a remote
system.</para></listitem>