diff options
author | Lennart Poettering <lennart@poettering.net> | 2020-04-30 12:26:11 +0200 |
---|---|---|
committer | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2020-05-05 11:33:13 +0200 |
commit | c83347b49de7a8d0cb7d51129b2534aa7e4a2a2e (patch) | |
tree | a3b13ba28ebd424ddaf7115bfeb2b82d768f9470 /man | |
parent | 90f1f8188b842c0d21cc3e24253ff900cac1f953 (diff) | |
download | systemd-c83347b49de7a8d0cb7d51129b2534aa7e4a2a2e.tar.gz |
man: migrate more specifier explanations to standard-specifiers.xml
We probably can migrate even more, but for now let's just migrate those
which have the 1:1 identical text everywhere.
(Also, let's add the % entry to all specifier tables)
Diffstat (limited to 'man')
-rw-r--r-- | man/standard-specifiers.xml | 25 | ||||
-rw-r--r-- | man/systemd.dnssd.xml | 25 | ||||
-rw-r--r-- | man/systemd.unit.xml | 25 | ||||
-rw-r--r-- | man/sysusers.d.xml | 30 | ||||
-rw-r--r-- | man/tmpfiles.d.xml | 30 |
5 files changed, 45 insertions, 90 deletions
diff --git a/man/standard-specifiers.xml b/man/standard-specifiers.xml index c5cd6a8862..0c258241df 100644 --- a/man/standard-specifiers.xml +++ b/man/standard-specifiers.xml @@ -4,6 +4,11 @@ <!-- SPDX-License-Identifier: LGPL-2.1+ --> <tbody> + <row id='b'> + <entry><literal>%b</literal></entry> + <entry>Boot ID</entry> + <entry>The boot ID of the running system, formatted as string. See <citerefentry><refentrytitle>random</refentrytitle><manvolnum>4</manvolnum></citerefentry> for more information.</entry> + </row> <row id='a'> <entry><literal>%a</literal></entry> <entry>Architecture</entry> @@ -14,11 +19,26 @@ <entry>Operating system build ID</entry> <entry>The operating system build identifier of the running system, as read from the <varname>BUILD_ID=</varname> field of <filename>/etc/os-release</filename>. If not set, resolves to an empty string. See <citerefentry><refentrytitle>os-release</refentrytitle><manvolnum>5</manvolnum></citerefentry> for more information.</entry> </row> + <row id='H'> + <entry><literal>%H</literal></entry> + <entry>Host name</entry> + <entry>The hostname of the running system.</entry> + </row> + <row id='m'> + <entry><literal>%m</literal></entry> + <entry>Machine ID</entry> + <entry>The machine ID of the running system, formatted as string. See <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry> for more information.</entry> + </row> <row id='o'> <entry><literal>%o</literal></entry> <entry>Operating system ID</entry> <entry>The operating system identifier of the running system, as read from the <varname>ID=</varname> field of <filename>/etc/os-release</filename>. See <citerefentry><refentrytitle>os-release</refentrytitle><manvolnum>5</manvolnum></citerefentry> for more information.</entry> </row> + <row id='v'> + <entry><literal>%v</literal></entry> + <entry>Kernel release</entry> + <entry>Identical to <command>uname -r</command> output.</entry> + </row> <row id='w'> <entry><literal>%w</literal></entry> <entry>Operating system version ID</entry> @@ -29,4 +49,9 @@ <entry>Operating system variant ID</entry> <entry>The operating system variant identifier of the running system, as read from the <varname>VARIANT_ID=</varname> field of <filename>/etc/os-release</filename>. If not set, resolves to an empty string. See <citerefentry><refentrytitle>os-release</refentrytitle><manvolnum>5</manvolnum></citerefentry> for more information.</entry> </row> + <row id='percent'> + <entry><literal>%%</literal></entry> + <entry>Single percent sign</entry> + <entry>Use <literal>%%</literal> in place of <literal>%</literal> to specify a single percent sign.</entry> + </row> </tbody> diff --git a/man/systemd.dnssd.xml b/man/systemd.dnssd.xml index d70cc43944..9e11677bde 100644 --- a/man/systemd.dnssd.xml +++ b/man/systemd.dnssd.xml @@ -90,30 +90,15 @@ </thead> <tbody> <xi:include href="standard-specifiers.xml" xpointer="a"/> - <row> - <entry><literal>%b</literal></entry> - <entry>Boot ID</entry> - <entry>The boot ID of the running system, formatted as string. See <citerefentry><refentrytitle>random</refentrytitle><manvolnum>4</manvolnum></citerefentry> for more information.</entry> - </row> + <xi:include href="standard-specifiers.xml" xpointer="b"/> <xi:include href="standard-specifiers.xml" xpointer="B"/> - <row> - <entry><literal>%H</literal></entry> - <entry>Host name</entry> - <entry>The hostname of the running system.</entry> - </row> - <row> - <entry><literal>%m</literal></entry> - <entry>Machine ID</entry> - <entry>The machine ID of the running system, formatted as string. See <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry> for more information.</entry> - </row> + <xi:include href="standard-specifiers.xml" xpointer="H"/> + <xi:include href="standard-specifiers.xml" xpointer="m"/> <xi:include href="standard-specifiers.xml" xpointer="o"/> - <row> - <entry><literal>%v</literal></entry> - <entry>Kernel release</entry> - <entry>Identical to <command>uname -r</command> output.</entry> - </row> + <xi:include href="standard-specifiers.xml" xpointer="v"/> <xi:include href="standard-specifiers.xml" xpointer="w"/> <xi:include href="standard-specifiers.xml" xpointer="W"/> + <xi:include href="standard-specifiers.xml" xpointer="percent"/> </tbody> </tgroup> </table> diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml index d570016b2f..999a13c560 100644 --- a/man/systemd.unit.xml +++ b/man/systemd.unit.xml @@ -1715,11 +1715,7 @@ <entry>Architecture</entry> <entry>A short string identifying the architecture of the local system. A string such as <constant>x86</constant>, <constant>x86-64</constant> or <constant>arm64</constant>. See the architectures defined for <varname>ConditionArchitecture=</varname> above for a full list.</entry> </row> - <row> - <entry><literal>%b</literal></entry> - <entry>Boot ID</entry> - <entry>The boot ID of the running system, formatted as string. See <citerefentry><refentrytitle>random</refentrytitle><manvolnum>4</manvolnum></citerefentry> for more information.</entry> - </row> + <xi:include href="standard-specifiers.xml" xpointer="b"/> <xi:include href="standard-specifiers.xml" xpointer="B"/> <row> <entry><literal>%C</literal></entry> @@ -1744,6 +1740,7 @@ Note that this setting is <emphasis>not</emphasis> influenced by the <varname>User=</varname> setting configurable in the [Service] section of the service unit.</entry> </row> <row> + <!-- We do not use the common definition from standard-specifiers.xml here since we want a slightly more verbose explanation here, referring to the reload cycle. --> <entry><literal>%H</literal></entry> <entry>Host name</entry> <entry>The hostname of the running system at the point in time the unit configuration is loaded.</entry> @@ -1773,11 +1770,7 @@ Note that this setting is <emphasis>not</emphasis> influenced by the <varname>Us <entry>Log directory root</entry> <entry>This is either <filename>/var/log</filename> (for the system manager) or the path <literal>$XDG_CONFIG_HOME</literal> resolves to with <filename index="false">/log</filename> appended (for user managers).</entry> </row> - <row> - <entry><literal>%m</literal></entry> - <entry>Machine ID</entry> - <entry>The machine ID of the running system, formatted as string. See <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry> for more information.</entry> - </row> + <xi:include href="standard-specifiers.xml" xpointer="m"/> <xi:include href="standard-specifiers.xml" xpointer="o"/> <row> <entry><literal>%n</literal></entry> @@ -1843,11 +1836,7 @@ Note that this setting is <emphasis>not</emphasis> influenced by the <varname>Us Note that this setting is <emphasis>not</emphasis> influenced by the <varname>User=</varname> setting configurable in the [Service] section of the service unit.</entry> </row> - <row> - <entry><literal>%v</literal></entry> - <entry>Kernel release</entry> - <entry>Identical to <command>uname -r</command> output</entry> - </row> + <xi:include href="standard-specifiers.xml" xpointer="v"/> <row> <entry><literal>%V</literal></entry> <entry>Directory for larger and persistent temporary files</entry> @@ -1855,11 +1844,7 @@ Note that this setting is <emphasis>not</emphasis> influenced by the <varname>Us </row> <xi:include href="standard-specifiers.xml" xpointer="w"/> <xi:include href="standard-specifiers.xml" xpointer="W"/> - <row> - <entry><literal>%%</literal></entry> - <entry>Single percent sign</entry> - <entry>Use <literal>%%</literal> in place of <literal>%</literal> to specify a single percent sign.</entry> - </row> + <xi:include href="standard-specifiers.xml" xpointer="percent"/> </tbody> </tgroup> </table> diff --git a/man/sysusers.d.xml b/man/sysusers.d.xml index 2be41c1030..46e860ee50 100644 --- a/man/sysusers.d.xml +++ b/man/sysusers.d.xml @@ -252,33 +252,17 @@ r - 500-900 </thead> <tbody> <xi:include href="standard-specifiers.xml" xpointer="a"/> - <row> - <entry><literal>%b</literal></entry> - <entry>Boot ID</entry> - <entry>The boot ID of the running system, formatted as string. See <citerefentry><refentrytitle>random</refentrytitle><manvolnum>4</manvolnum></citerefentry> for more information.</entry> - </row> + <xi:include href="standard-specifiers.xml" xpointer="b"/> <xi:include href="standard-specifiers.xml" xpointer="B"/> - <row> - <entry><literal>%H</literal></entry> - <entry>Host name</entry> - <entry>The hostname of the running system.</entry> - </row> - <row> - <entry><literal>%m</literal></entry> - <entry>Machine ID</entry> - <entry>The machine ID of the running system, formatted as string. See <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry> for more information.</entry> - </row> + <xi:include href="standard-specifiers.xml" xpointer="H"/> + <xi:include href="standard-specifiers.xml" xpointer="m"/> <xi:include href="standard-specifiers.xml" xpointer="o"/> <row> <entry><literal>%T</literal></entry> <entry>Directory for temporary files</entry> <entry>This is either <filename>/tmp</filename> or the path <literal>$TMPDIR</literal>, <literal>$TEMP</literal> or <literal>$TMP</literal> are set to.</entry> </row> - <row> - <entry><literal>%v</literal></entry> - <entry>Kernel release</entry> - <entry>Identical to <command>uname -r</command> output.</entry> - </row> + <xi:include href="standard-specifiers.xml" xpointer="v"/> <row> <entry><literal>%V</literal></entry> <entry>Directory for larger and persistent temporary files</entry> @@ -286,11 +270,7 @@ r - 500-900 </row> <xi:include href="standard-specifiers.xml" xpointer="w"/> <xi:include href="standard-specifiers.xml" xpointer="W"/> - <row> - <entry><literal>%%</literal></entry> - <entry>Escaped <literal>%</literal></entry> - <entry>Single percent sign.</entry> - </row> + <xi:include href="standard-specifiers.xml" xpointer="percent"/> </tbody> </tgroup> </table> diff --git a/man/tmpfiles.d.xml b/man/tmpfiles.d.xml index 79fd6a9921..f45dfe0a53 100644 --- a/man/tmpfiles.d.xml +++ b/man/tmpfiles.d.xml @@ -633,11 +633,7 @@ w- /proc/sys/vm/swappiness - - - - 10</programlisting></para> </thead> <tbody> <xi:include href="standard-specifiers.xml" xpointer="a"/> - <row> - <entry><literal>%b</literal></entry> - <entry>Boot ID</entry> - <entry>The boot ID of the running system, formatted as string. See <citerefentry><refentrytitle>random</refentrytitle><manvolnum>4</manvolnum></citerefentry> for more information.</entry> - </row> + <xi:include href="standard-specifiers.xml" xpointer="b"/> <xi:include href="standard-specifiers.xml" xpointer="B"/> <row> <entry><literal>%C</literal></entry> @@ -649,21 +645,13 @@ w- /proc/sys/vm/swappiness - - - - 10</programlisting></para> <entry>User home directory</entry> <entry>This is the home directory of the user running the command. In case of the system instance this resolves to <literal>/root</literal>.</entry> </row> - <row> - <entry><literal>%H</literal></entry> - <entry>Host name</entry> - <entry>The hostname of the running system.</entry> - </row> + <xi:include href="standard-specifiers.xml" xpointer="H"/> <row> <entry><literal>%L</literal></entry> <entry>System or user log directory</entry> <entry>In <option>--user</option> mode, this is the same as <varname>$XDG_CONFIG_HOME</varname> with <filename index="false">/log</filename> appended, and <filename>/var/log</filename> otherwise.</entry> </row> - <row> - <entry><literal>%m</literal></entry> - <entry>Machine ID</entry> - <entry>The machine ID of the running system, formatted as string. See <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry> for more information.</entry> - </row> + <xi:include href="standard-specifiers.xml" xpointer="m"/> <xi:include href="standard-specifiers.xml" xpointer="o"/> <row> <entry><literal>%S</literal></entry> @@ -700,11 +688,7 @@ w- /proc/sys/vm/swappiness - - - - 10</programlisting></para> <entry>User UID</entry> <entry>This is the numeric UID of the user running the command. In case of the system instance this resolves to <constant>0</constant>.</entry> </row> - <row> - <entry><literal>%v</literal></entry> - <entry>Kernel release</entry> - <entry>Identical to <command>uname -r</command> output.</entry> - </row> + <xi:include href="standard-specifiers.xml" xpointer="v"/> <row> <entry><literal>%V</literal></entry> <entry>Directory for larger and persistent temporary files</entry> @@ -712,11 +696,7 @@ w- /proc/sys/vm/swappiness - - - - 10</programlisting></para> </row> <xi:include href="standard-specifiers.xml" xpointer="w"/> <xi:include href="standard-specifiers.xml" xpointer="W"/> - <row> - <entry><literal>%%</literal></entry> - <entry>Escaped <literal>%</literal></entry> - <entry>Single percent sign.</entry> - </row> + <xi:include href="standard-specifiers.xml" xpointer="percent"/> </tbody> </tgroup> </table> |