1
1
mirror of https://github.com/systemd/systemd-stable.git synced 2024-12-22 13:33:56 +03:00

man: always supply quotes around literals

When manpages are displayed on a terminal, <literal>s are indistinguishable
from surrounding text. Add quotes everywhere, remove duplicate quotes,
and tweak a few lists for consistent formatting.

https://bugzilla.redhat.com/show_bug.cgi?id=874631
This commit is contained in:
Zbigniew Jędrzejewski-Szmek 2013-06-26 08:03:53 -04:00
parent 3b05b8b3b5
commit 909f413d3c
13 changed files with 123 additions and 106 deletions

View File

@ -68,7 +68,7 @@
describes encrypted block devices that are set up
during system boot.</para>
<para>Empty lines and lines starting with the #
<para>Empty lines and lines starting with the <literal>#</literal>
character are ignored. Each of the remaining lines
describes one encrypted block device, fields on the
line are delimited by white space. The first two

View File

@ -172,6 +172,12 @@
<hr/>
</xsl:template>
<xsl:template match="literal">
<xsl:text>"</xsl:text>
<xsl:call-template name="inline.monoseq"/>
<xsl:text>"</xsl:text>
</xsl:template>
<!-- Switch things to UTF-8, ISO-8859-1 is soo yesteryear -->
<xsl:output method="html" encoding="UTF-8" indent="no"/>

View File

@ -52,4 +52,13 @@
<xsl:call-template name="mark.subheading"/>
</xsl:template>
<xsl:template match="literal">
<xsl:if test="$man.hyphenate.computer.inlines = 0">
<xsl:call-template name="suppress.hyphenation"/>
</xsl:if>
<xsl:text>"</xsl:text>
<xsl:call-template name="inline.monoseq"/>
<xsl:text>"</xsl:text>
</xsl:template>
</xsl:stylesheet>

View File

@ -547,7 +547,7 @@
systemd, kernel devices appearing in the
sysfs/udev device tree can be exposed as units
if they are tagged with the string
"<literal>systemd</literal>". Like any other
<literal>systemd</literal>. Like any other
kind of unit they may then pull in other units
when activated (i.e. Plugged in) and thus
implement device-based activation. Systemd

View File

@ -84,7 +84,7 @@
alternatives, i.e. the resulting output will show
entries matching any of the specified matches for the
same field. Finally, if the character
"<literal>+</literal>" appears as separate word on the
<literal>+</literal> appears as separate word on the
command line all matches before and after are combined
in a disjunction (i.e. logical OR).</para>
@ -415,14 +415,15 @@
<listitem><para>Start showing entries
on or newer than the specified date,
or on or older than the specified
date, respectively. Date specifications should be of
the format "2012-10-30 18:17:16". If
the time part is omitted, 00:00:00 is
assumed. If only the seconds component
is omitted, :00 is assumed. If the
date component is omitted, the
current day is assumed. Alternatively
the strings
date, respectively. Date specifications
should be of the format
<literal>2012-10-30 18:17:16</literal>.
If the time part is omitted,
<literal>00:00:00</literal> is assumed.
If only the seconds component is omitted,
<literal>:00</literal> is assumed. If the
date component is omitted, the current
day is assumed. Alternatively the strings
<literal>yesterday</literal>,
<literal>today</literal>,
<literal>tomorrow</literal> are
@ -681,7 +682,7 @@
<programlisting>journalctl _SYSTEMD_UNIT=avahi-daemon.service _SYSTEMD_UNIT=dbus.service</programlisting>
<para>If the separator "<literal>+</literal>" is used
<para>If the separator <literal>+</literal> is used
two expressions may be combined in a logical OR. The
following will show all messages from the Avahi
service process with the PID 28097 plus all messages

View File

@ -243,7 +243,7 @@
<title>Examples</title>
<para>This plots all dependencies of any unit whose
name starts with "<literal>avahi-daemon.</literal>":</para>
name starts with <literal>avahi-daemon.</literal>:</para>
<programlisting>$ systemd-analyze dot 'avahi-daemon.*' | dot -Tsvg > avahi.svg
$ eog avahi.svg</programlisting>

View File

@ -89,10 +89,10 @@
executables in
<filename>/usr/lib/systemd/system-shutdown/</filename>
and pass one arguments to them: either
"<literal>halt</literal>",
"<literal>poweroff</literal>",
"<literal>reboot</literal>" or
"<literal>kexec</literal>", depending on the chosen
<literal>halt</literal>,
<literal>poweroff</literal>,
<literal>reboot</literal> or
<literal>kexec</literal>, depending on the chosen
action. All executables in this directory are executed
in parallel, and execution of the action is not
continued before all executables finished.</para>
@ -101,7 +101,7 @@
<filename>systemd-halt.service</filename> (and the
related units) should never be executed
directly. Instead, trigger system shutdown with a
command such as "<literal>systemctl halt</literal>" or
command such as <literal>systemctl halt</literal> or
suchlike.</para>
</refsect1>

View File

@ -80,14 +80,14 @@
executables in
<filename>/usr/lib/systemd/system-sleep/</filename>
and pass two arguments to them. The first argument
will be "<literal>pre</literal>", the second either
"<literal>suspend</literal>",
"<literal>hibernate</literal>", or
"<literal>hybrid-sleep</literal>" depending on the
will be <literal>pre</literal>, the second either
<literal>suspend</literal>,
<literal>hibernate</literal>, or
<literal>hybrid-sleep</literal> depending on the
chosen action. Immediately after leaving system
suspend and/or hibernation the same executables are run,
but the first argument is now
"<literal>post</literal>". All executables in this
<literal>post</literal>. All executables in this
directory are executed in parallel, and execution of
the action is not continued until all executables
have finished.</para>
@ -105,11 +105,11 @@
<filename>systemd-hybrid-sleep.service</filename>
should never be executed directly. Instead, trigger
system sleep states with a command such as
"<literal>systemctl suspend</literal>" or
<literal>systemctl suspend</literal> or
similar.</para>
<para>Internally, this service will echo a string like
"<literal>mem</literal>" into
<literal>mem</literal> into
<filename>/sys/power/state</filename>, to trigger the
actual system suspend. What exactly is written
where can be configured in the <literal>[Sleep]</literal>

View File

@ -107,7 +107,7 @@
available. Note that this and the
other tags are not taken into account
unless the device is tagged with the
"<literal>systemd</literal>" string in
<literal>systemd</literal> string in
the udev database, because otherwise
the device is not exposed as systemd
unit.</para></listitem>

View File

@ -375,15 +375,15 @@
name. If the entry is
associated to a block device,
the major and minor of the
device node, separated by ':'
and prefixed by 'b'. Similar
device node, separated by <literal>:</literal>
and prefixed by <literal>b</literal>. Similar
for character devices, but
prefixed by 'c'. For network
prefixed by <literal>c</literal>. For network
devices the interface index,
prefixed by 'n'. For all other
devices '+' followed by the
prefixed by <literal>n</literal>. For all other
devices <literal>+</literal> followed by the
subsystem name, followed by
':', followed by the kernel
<literal>:</literal>, followed by the kernel
device name.</para>
</listitem>
</varlistentry>

View File

@ -319,7 +319,7 @@
suitable for XDG
<filename>.desktop</filename> files.
Lone semicolons may be escaped as
'<literal>\;</literal>'. If the empty
<literal>\;</literal>. If the empty
string is assigned to this option the
list of commands to start is reset,
prior assignments of this option will
@ -330,7 +330,7 @@
one by one sequentially in the order
they appear in the unit file. If one
of the commands fails (and is not
prefixed with '<literal>-</literal>'),
prefixed with <literal>-</literal>),
other lines are not executed and the
unit is considered failed.</para>
@ -341,7 +341,7 @@
main process of the daemon.</para>
<para>The command line accepts
'<literal>%</literal>' specifiers as
<literal>%</literal> specifiers as
described in
<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>. Note
that the first argument of the command
@ -370,19 +370,19 @@
<para>Optionally, if the absolute file
name is prefixed with
'<literal>@</literal>', the second token
<literal>@</literal>, the second token
will be passed as
<literal>argv[0]</literal> to the
executed process, followed by the
further arguments specified. If the
absolute file name is prefixed with
'<literal>-</literal>' an exit code of
<literal>-</literal> an exit code of
the command normally considered a
failure (i.e. non-zero exit status or
abnormal exit due to signal) is ignored
and considered success. If both
'<literal>-</literal>' and
'<literal>@</literal>' are used they
<literal>-</literal> and
<literal>@</literal> are used they
can appear in either order.</para>
<para>Note that this setting does not
@ -417,7 +417,7 @@
after the other, serially.</para>
<para>If any of those commands (not
prefixed with '<literal>-</literal>')
prefixed with <literal>-</literal>)
fail, the rest are not executed and
the unit is considered failed.</para>
</listitem>
@ -662,8 +662,8 @@
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
<literal>SuccessExitStatus=1 2 8
SIGKILL</literal>, ensures that exit
codes 1, 2, 8 and the termination
signal SIGKILL are considered clean
service terminations. This option may
@ -692,8 +692,8 @@
that by default no exit status is
excluded from the configured restart
logic. Example:
"<literal>RestartPreventExitStatus=1 6
SIGABRT</literal>", ensures that exit
<literal>RestartPreventExitStatus=1 6
SIGABRT</literal>, ensures that exit
codes 1 and 6 and the termination
signal SIGABRT will not result in
automatic service restarting. This

View File

@ -646,7 +646,7 @@
<listitem><para>Lists one or more
units that are activated when this
unit enters the
'<literal>failed</literal>'
<literal>failed</literal>
state.</para></listitem>
</varlistentry>
@ -812,7 +812,7 @@
time. If this time limit is reached
the job will be cancelled, the unit
however will not change state or even
enter the '<literal>failed</literal>'
enter the <literal>failed</literal>
mode. This value defaults to 0 (job
timeouts disabled), except for device
units. NB: this timeout is independent
@ -871,7 +871,7 @@
to
<varname>ConditionPathExists=</varname>
is prefixed with an exclamation mark
('!'), the test is negated, and the unit
(<literal>!</literal>), the test is negated, and the unit
is only started if the path does not
exist.</para>
@ -940,7 +940,7 @@
exclamation mark unset). The argument
must either be a single word, or an
assignment (i.e. two words, separated
'='). In the former
<literal>=</literal>). In the former
case the kernel command line is
searched for the word appearing as is,
or as left hand side of an

View File

@ -73,7 +73,7 @@
extensions are ignored.</para>
<para>Every line in the rules file contains at least one key-value pair.
Except for empty lines or lines beginning with '#', which are ignored.
Except for empty lines or lines beginning with <literal>#</literal>, which are ignored.
There are two kinds of keys: match and assignment.
If all match keys match against their values, the rule gets applied and the
assignment keys get the specified values assigned.</para>
@ -130,28 +130,28 @@
one and the same parent device.</para>
<variablelist class='udev-directives'>
<varlistentry>
<term><option>ACTION</option></term>
<term><varname>ACTION</varname></term>
<listitem>
<para>Match the name of the event action.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>DEVPATH</option></term>
<term><varname>DEVPATH</varname></term>
<listitem>
<para>Match the devpath of the event device.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>KERNEL</option></term>
<term><varname>KERNEL</varname></term>
<listitem>
<para>Match the name of the event device.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>NAME</option></term>
<term><varname>NAME</varname></term>
<listitem>
<para>Match the name of a network interface. It can be used once the
NAME key has been set in one of the preceding rules.</para>
@ -159,7 +159,7 @@
</varlistentry>
<varlistentry>
<term><option>SYMLINK</option></term>
<term><varname>SYMLINK</varname></term>
<listitem>
<para>Match the name of a symlink targeting the node. It can
be used once a SYMLINK key has been set in one of the preceding
@ -169,20 +169,20 @@
</varlistentry>
<varlistentry>
<term><option>SUBSYSTEM</option></term>
<term><varname>SUBSYSTEM</varname></term>
<listitem>
<para>Match the subsystem of the event device.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>DRIVER</option></term>
<term><varname>DRIVER</varname></term>
<listitem>
<para>Match the driver name of the event device. Only set this key for devices
which are bound to a driver at the time the event is generated.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>ATTR{<replaceable>filename</replaceable>}</option></term>
<term><varname>ATTR{<replaceable>filename</replaceable>}</varname></term>
<listitem>
<para>Match sysfs attribute values of the event device. Trailing
whitespace in the attribute values is ignored unless the specified match
@ -192,59 +192,59 @@
</varlistentry>
<varlistentry>
<term><option>KERNELS</option></term>
<term><varname>KERNELS</varname></term>
<listitem>
<para>Search the devpath upwards for a matching device name.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>SUBSYSTEMS</option></term>
<term><varname>SUBSYSTEMS</varname></term>
<listitem>
<para>Search the devpath upwards for a matching device subsystem name.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>DRIVERS</option></term>
<term><varname>DRIVERS</varname></term>
<listitem>
<para>Search the devpath upwards for a matching device driver name.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>ATTRS{<replaceable>filename</replaceable>}</option></term>
<term><varname>ATTRS{<replaceable>filename</replaceable>}</varname></term>
<listitem>
<para>Search the devpath upwards for a device with matching sysfs attribute values.
If multiple <option>ATTRS</option> matches are specified, all of them
If multiple <varname>ATTRS</varname> matches are specified, all of them
must match on the same device. Trailing whitespace in the attribute values is ignored
unless the specified match value itself contains trailing whitespace.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>TAGS</option></term>
<term><varname>TAGS</varname></term>
<listitem>
<para>Search the devpath upwards for a device with matching tag.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>ENV{<replaceable>key</replaceable>}</option></term>
<term><varname>ENV{<replaceable>key</replaceable>}</varname></term>
<listitem>
<para>Match against a device property value.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>TAG</option></term>
<term><varname>TAG</varname></term>
<listitem>
<para>Match against a device tag.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>TEST{<replaceable>octal mode mask</replaceable>}</option></term>
<term><varname>TEST{<replaceable>octal mode mask</replaceable>}</varname></term>
<listitem>
<para>Test the existence of a file. An octal mode mask can be specified
if needed.</para>
@ -252,7 +252,7 @@
</varlistentry>
<varlistentry>
<term><option>PROGRAM</option></term>
<term><varname>PROGRAM</varname></term>
<listitem>
<para>Execute a program to determine whether there
is a match; the key is true if the program returns
@ -260,12 +260,12 @@
executed program in the environment. The program's stdout
is available in the RESULT key.</para>
<para>This can only be used for very short-running foreground tasks. For details
see <option>RUN</option>.</para>
see <varname>RUN</varname>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>RESULT</option></term>
<term><varname>RESULT</varname></term>
<listitem>
<para>Match the returned string of the last PROGRAM call. This key can
be used in the same or in any later rule after a PROGRAM call.</para>
@ -292,11 +292,12 @@
<term><literal>[]</literal></term>
<listitem>
<para>Matches any single character specified within the brackets. For
example, the pattern string 'tty[SR]' would match either 'ttyS' or 'ttyR'.
Ranges are also supported via the '-' character.
example, the pattern string <literal>tty[SR]</literal>
would match either <literal>ttyS</literal> or <literal>ttyR</literal>.
Ranges are also supported via the <literal>-</literal> character.
For example, to match on the range of all digits, the pattern [0-9] could
be used. If the first character following the '[' is a '!', any characters
not enclosed are matched.</para>
be used. If the first character following the <literal>[</literal> is a
<literal>!</literal>, any characters not enclosed are matched.</para>
</listitem>
</varlistentry>
</variablelist>
@ -304,7 +305,7 @@
<para>The following keys can get values assigned:</para>
<variablelist class='udev-directives'>
<varlistentry>
<term><option>NAME</option></term>
<term><varname>NAME</varname></term>
<listitem>
<para>The name to use for a network interface. The name of a device node
cannot be changed by udev, only additional symlinks can be created.</para>
@ -312,14 +313,14 @@
</varlistentry>
<varlistentry>
<term><option>SYMLINK</option></term>
<term><varname>SYMLINK</varname></term>
<listitem>
<para>The name of a symlink targeting the node. Every matching rule adds
this value to the list of symlinks to be created.</para>
<para>The set of characters to name a symlink is limited. Allowed
characters are [0-9A-Za-z#+-.:=@_/], valid UTF-8 character sequences,
and "\x00" hex encoding. All other characters are replaced by
a '_' character.</para>
characters are <literal>0-9A-Za-z#+-.:=@_/</literal>, valid UTF-8 character
sequences, and <literal>\x00</literal> hex encoding. All other
characters are replaced by a <literal>_</literal> character.</para>
<para>Multiple symlinks may be specified by separating the names by the
space character. In case multiple devices claim the same name, the link
always points to the device with the highest link_priority. If the current
@ -334,7 +335,7 @@
</varlistentry>
<varlistentry>
<term><option>OWNER</option>, <option>GROUP</option>, <option>MODE</option></term>
<term><varname>OWNER</varname>, <varname>GROUP</varname>, <varname>MODE</varname></term>
<listitem>
<para>The permissions for the device node. Every specified value overrides
the compiled-in default value.</para>
@ -342,7 +343,7 @@
</varlistentry>
<varlistentry>
<term><option>ATTR{<replaceable>key</replaceable>}</option></term>
<term><varname>ATTR{<replaceable>key</replaceable>}</varname></term>
<listitem>
<para>The value that should be written to a sysfs attribute of the
event device.</para>
@ -350,16 +351,16 @@
</varlistentry>
<varlistentry>
<term><option>ENV{<replaceable>key</replaceable>}</option></term>
<term><varname>ENV{<replaceable>key</replaceable>}</varname></term>
<listitem>
<para>Set a device property value. Property names with a leading '.'
<para>Set a device property value. Property names with a leading <literal>.</literal>
are neither stored in the database nor exported to events or
external tools (run by, say, the PROGRAM match key).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>TAG</option></term>
<term><varname>TAG</varname></term>
<listitem>
<para>Attach a tag to a device. This is used to filter events for users
of libudev's monitor functionality, or to enumerate a group of tagged
@ -372,7 +373,7 @@
</varlistentry>
<varlistentry>
<term><option>RUN{<replaceable>type</replaceable>}</option></term>
<term><varname>RUN{<replaceable>type</replaceable>}</varname></term>
<listitem>
<para>Add a program to the list of programs to be executed after processing all the
rules for a specific event, depending on <literal>type</literal>:</para>
@ -390,7 +391,7 @@
<varlistentry>
<term><literal>builtin</literal></term>
<listitem>
<para>As <option>program</option>, but use one of the built-in programs rather
<para>As <varname>program</varname>, but use one of the built-in programs rather
than an external one.</para>
</listitem>
</varlistentry>
@ -407,21 +408,21 @@
</varlistentry>
<varlistentry>
<term><option>LABEL</option></term>
<term><varname>LABEL</varname></term>
<listitem>
<para>A named label to which a GOTO may jump.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>GOTO</option></term>
<term><varname>GOTO</varname></term>
<listitem>
<para>Jumps to the next LABEL with a matching name.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>IMPORT{<replaceable>type</replaceable>}</option></term>
<term><varname>IMPORT{<replaceable>type</replaceable>}</varname></term>
<listitem>
<para>Import a set of variables as device properties,
depending on <literal>type</literal>:</para>
@ -432,14 +433,14 @@
<para>Execute an external program specified as the assigned value and
import its output, which must be in environment key
format. Path specification, command/argument separation,
and quoting work like in <option>RUN</option>.</para>
and quoting work like in <varname>RUN</varname>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>builtin</literal></term>
<listitem>
<para>As <option>program</option>, but use one of the built-in programs rather
than an external one.</para>
<para>Similar to <literal>program</literal>, but use one of the
built-in programs rather than an external one.</para>
</listitem>
</varlistentry>
<varlistentry>
@ -461,7 +462,7 @@
<term><literal>cmdline</literal></term>
<listitem>
<para>Import a single property from the kernel command line. For simple flags
the value of the property is set to '1'.</para>
the value of the property is set to <literal>1</literal>.</para>
</listitem>
</varlistentry>
<varlistentry>
@ -481,7 +482,7 @@
</varlistentry>
<varlistentry>
<term><option>WAIT_FOR</option></term>
<term><varname>WAIT_FOR</varname></term>
<listitem>
<para>Wait for a file to become available or until a timeout of
10 seconds expires. The path is relative to the sysfs device;
@ -490,7 +491,7 @@
</varlistentry>
<varlistentry>
<term><option>OPTIONS</option></term>
<term><varname>OPTIONS</varname></term>
<listitem>
<para>Rule and device options:</para>
<variablelist class='udev-directives'>
@ -543,9 +544,9 @@
</varlistentry>
</variablelist>
<para>The <option>NAME</option>, <option>SYMLINK</option>, <option>PROGRAM</option>,
<option>OWNER</option>, <option>GROUP</option>, <option>MODE</option> and <option>RUN</option>
fields support simple string substitutions. The <option>RUN</option>
<para>The <varname>NAME</varname>, <varname>SYMLINK</varname>, <varname>PROGRAM</varname>,
<varname>OWNER</varname>, <varname>GROUP</varname>, <varname>MODE</varname> and <varname>RUN</varname>
fields support simple string substitutions. The <varname>RUN</varname>
substitutions are performed after all rules have been processed, right before the program
is executed, allowing for the use of device properties set by earlier matching
rules. For all other fields, substitutions are performed while the individual rule is
@ -561,8 +562,8 @@
<varlistentry>
<term><option>$number</option>, <option>%n</option></term>
<listitem>
<para>The kernel number for this device. For example, 'sda3' has
kernel number of '3'</para>
<para>The kernel number for this device. For example,
<literal>sda3</literal> has kernel number <literal>3</literal>.</para>
</listitem>
</varlistentry>
@ -630,9 +631,9 @@
<listitem>
<para>The string returned by the external program requested with PROGRAM.
A single part of the string, separated by a space character, may be selected
by specifying the part number as an attribute: <option>%c{N}</option>.
If the number is followed by the '+' character, this part plus all remaining parts
of the result string are substituted: <option>%c{N+}</option></para>
by specifying the part number as an attribute: <literal>%c{N}</literal>.
If the number is followed by the <literal>+</literal> character, this part plus all remaining parts
of the result string are substituted: <literal>%c{N+}</literal>.</para>
</listitem>
</varlistentry>
@ -681,16 +682,16 @@
</varlistentry>
<varlistentry>
<term><literal>%%</literal></term>
<term><option>%%</option></term>
<listitem>
<para>The '%' character itself.</para>
<para>The <literal>%</literal> character itself.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>$$</literal></term>
<term><option>$$</option></term>
<listitem>
<para>The '$' character itself.</para>
<para>The <literal>$</literal> character itself.</para>
</listitem>
</varlistentry>
</variablelist>