man: use <literal> not <filename> for suffixes

Especially sentences like "filename ends in .suffix" are easier to
parse if the suffix is surrounded by quotes. In sentences like
"requires a .service unit", where the suffix is used as a class
designation, there is no need to use quotes.
This commit is contained in:
Zbigniew Jędrzejewski-Szmek 2013-07-11 23:39:27 -04:00
parent b54022fb92
commit 479fe882ae
10 changed files with 12 additions and 12 deletions

View file

@ -55,7 +55,7 @@
<title>Description</title> <title>Description</title>
<para>A unit configuration file whose name ends in <para>A unit configuration file whose name ends in
<filename>.automount</filename> encodes information <literal>.automount</literal> encodes information
about a file system automount point controlled and about a file system automount point controlled and
supervised by systemd.</para> supervised by systemd.</para>

View file

@ -55,7 +55,7 @@
<title>Description</title> <title>Description</title>
<para>A unit configuration file whose name ends in <para>A unit configuration file whose name ends in
<filename>.device</filename> encodes information about <literal>.device</literal> encodes information about
a device unit as exposed in the a device unit as exposed in the
sysfs/<citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry> sysfs/<citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry>
device tree.</para> device tree.</para>

View file

@ -55,7 +55,7 @@
<title>Description</title> <title>Description</title>
<para>A unit configuration file whose name ends in <para>A unit configuration file whose name ends in
<filename>.mount</filename> encodes information about <literal>.mount</literal> encodes information about
a file system mount point controlled and supervised by a file system mount point controlled and supervised by
systemd.</para> systemd.</para>

View file

@ -55,7 +55,7 @@
<title>Description</title> <title>Description</title>
<para>A unit configuration file whose name ends in <para>A unit configuration file whose name ends in
<filename>.path</filename> encodes information about <literal>.path</literal> encodes information about
a path monitored by systemd, for a path monitored by systemd, for
path-based activation.</para> path-based activation.</para>
@ -185,7 +185,7 @@
when any of the configured paths when any of the configured paths
changes. The argument is a unit name, changes. The argument is a unit name,
whose suffix is not whose suffix is not
<filename>.path</filename>. If not <literal>.path</literal>. If not
specified, this value defaults to a specified, this value defaults to a
service that has the same name as the service that has the same name as the
path unit, except for the suffix. (See path unit, except for the suffix. (See

View file

@ -57,7 +57,7 @@
<para>Snapshot units are not configured via unit <para>Snapshot units are not configured via unit
configuration files. Nonetheless they are named configuration files. Nonetheless they are named
similar to filenames. A unit name whose name ends in similar to filenames. A unit name whose name ends in
<filename>.snapshot</filename> refers to a dynamic <literal>.snapshot</literal> refers to a dynamic
snapshot of the systemd runtime state.</para> snapshot of the systemd runtime state.</para>
<para>Snapshots are not configured on disk but created <para>Snapshots are not configured on disk but created

View file

@ -55,7 +55,7 @@
<title>Description</title> <title>Description</title>
<para>A unit configuration file whose name ends in <para>A unit configuration file whose name ends in
<filename>.socket</filename> encodes information about <literal>.socket</literal> encodes information about
an IPC or network socket or a file system FIFO an IPC or network socket or a file system FIFO
controlled and supervised by systemd, for socket-based controlled and supervised by systemd, for socket-based
activation.</para> activation.</para>

View file

@ -55,7 +55,7 @@
<title>Description</title> <title>Description</title>
<para>A unit configuration file whose name ends in <para>A unit configuration file whose name ends in
<filename>.swap</filename> encodes information about a <literal>.swap</literal> encodes information about a
swap device or file for memory paging controlled and swap device or file for memory paging controlled and
supervised by systemd.</para> supervised by systemd.</para>

View file

@ -55,7 +55,7 @@
<title>Description</title> <title>Description</title>
<para>A unit configuration file whose name ends in <para>A unit configuration file whose name ends in
<filename>.target</filename> encodes information about <literal>.target</literal> encodes information about
a target unit of systemd, which is used for grouping a target unit of systemd, which is used for grouping
units and as well-known synchronization points during units and as well-known synchronization points during
start-up.</para> start-up.</para>

View file

@ -55,7 +55,7 @@
<title>Description</title> <title>Description</title>
<para>A unit configuration file whose name ends in <para>A unit configuration file whose name ends in
<filename>.timer</filename> encodes information about <literal>.timer</literal> encodes information about
a timer controlled and supervised by systemd, for a timer controlled and supervised by systemd, for
timer-based activation.</para> timer-based activation.</para>
@ -187,7 +187,7 @@
<listitem><para>The unit to activate <listitem><para>The unit to activate
when this timer elapses. The argument is a when this timer elapses. The argument is a
unit name, whose suffix is not unit name, whose suffix is not
<filename>.timer</filename>. If not <literal>.timer</literal>. If not
specified, this value defaults to a specified, this value defaults to a
service that has the same name as the service that has the same name as the
timer unit, except for the timer unit, except for the

View file

@ -173,7 +173,7 @@
<para>Along with a unit file <para>Along with a unit file
<filename>foo.service</filename> a directory <filename>foo.service</filename> a directory
<filename>foo.service.d/</filename> may exist. All <filename>foo.service.d/</filename> may exist. All
files with the suffix <filename>.conf</filename> from files with the suffix <literal>.conf</literal> from
this directory will be parsed after the file itself is this directory will be parsed after the file itself is
parsed. This is useful to alter or add configuration parsed. This is useful to alter or add configuration
settings to a unit, without having to modify their settings to a unit, without having to modify their