chiark / gitweb /
man: use <literal> not <filename> for suffixes
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Fri, 12 Jul 2013 03:39:27 +0000 (23:39 -0400)
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Fri, 12 Jul 2013 05:09:25 +0000 (01:09 -0400)
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.

man/systemd.automount.xml
man/systemd.device.xml
man/systemd.mount.xml
man/systemd.path.xml
man/systemd.snapshot.xml
man/systemd.socket.xml
man/systemd.swap.xml
man/systemd.target.xml
man/systemd.timer.xml
man/systemd.unit.xml

index 2a310d3..adba75a 100644 (file)
@@ -55,7 +55,7 @@
                 <title>Description</title>
 
                 <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
                 supervised by systemd.</para>
 
index 1c29aa4..e3cf071 100644 (file)
@@ -55,7 +55,7 @@
                 <title>Description</title>
 
                 <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
                 sysfs/<citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry>
                 device tree.</para>
index 07f2102..c57f613 100644 (file)
@@ -55,7 +55,7 @@
                 <title>Description</title>
 
                 <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
                 systemd.</para>
 
index 1975142..8c782b8 100644 (file)
@@ -55,7 +55,7 @@
                 <title>Description</title>
 
                 <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
                 path-based activation.</para>
 
                                 when any of the configured paths
                                 changes. The argument is a unit name,
                                 whose suffix is not
-                                <filename>.path</filename>. If not
+                                <literal>.path</literal>. If not
                                 specified, this value defaults to a
                                 service that has the same name as the
                                 path unit, except for the suffix. (See
index 08d14c4..4e8d5a9 100644 (file)
@@ -57,7 +57,7 @@
                 <para>Snapshot units are not configured via unit
                 configuration files. Nonetheless they are named
                 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>
 
                 <para>Snapshots are not configured on disk but created
index 2e1fb7c..1b899c4 100644 (file)
@@ -55,7 +55,7 @@
                 <title>Description</title>
 
                 <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
                 controlled and supervised by systemd, for socket-based
                 activation.</para>
index 9a3905a..d931c46 100644 (file)
@@ -55,7 +55,7 @@
                 <title>Description</title>
 
                 <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
                 supervised by systemd.</para>
 
index fd51cfd..15662a5 100644 (file)
@@ -55,7 +55,7 @@
                 <title>Description</title>
 
                 <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
                 units and as well-known synchronization points during
                 start-up.</para>
index 1f0aac2..fa67d59 100644 (file)
@@ -55,7 +55,7 @@
                 <title>Description</title>
 
                 <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
                 timer-based activation.</para>
 
                                 <listitem><para>The unit to activate
                                 when this timer elapses. The argument is a
                                 unit name, whose suffix is not
-                                <filename>.timer</filename>. If not
+                                <literal>.timer</literal>. If not
                                 specified, this value defaults to a
                                 service that has the same name as the
                                 timer unit, except for the
index 4f0bd64..a870f6b 100644 (file)
                 <para>Along with a unit file
                 <filename>foo.service</filename> a directory
                 <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
                 parsed. This is useful to alter or add configuration
                 settings to a unit, without having to modify their