Skip to content

Commit fa7a453

Browse files
cromerccromerc
authored
Merge pull request #3 from Tachi107/standard-specifiers.xml
build(man): add missing standard-specifiers.xml
2 parents 4491e4e + 90bf632 commit fa7a453

3 files changed

Lines changed: 104 additions & 14 deletions

File tree

‎man/Makefile‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ download-docs:
4545
'https://github.com/systemd/systemd/raw/main/man/custom-html.xsl' \
4646
'https://github.com/systemd/systemd/raw/main/man/custom-man.xsl' \
4747
'https://github.com/systemd/systemd/raw/main/man/standard-options.xml' \
48+
'https://github.com/systemd/systemd/raw/main/man/standard-specifiers.xml' \
4849
'https://github.com/systemd/systemd/raw/main/man/systemd-sysusers.xml' \
4950
'https://github.com/systemd/systemd/raw/main/man/sysusers.d.xml' \
5051
'https://github.com/systemd/systemd/raw/main/docs/UIDS-GIDS.md' \

‎man/standard-specifiers.xml‎

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
<?xml version="1.0"?>
2+
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3+
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
4+
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
5+
6+
<tbody>
7+
<!-- note: units also use the following deprecated specifiers that are not documented:
8+
%c, %r, %R. Do not reuse. -->
9+
10+
<row id='a'>
11+
<entry><literal>%a</literal></entry>
12+
<entry>Architecture</entry>
13+
<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> in <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for a full list.</entry>
14+
</row>
15+
<row id='A'>
16+
<entry><literal>%A</literal></entry>
17+
<entry>Operating system image version</entry>
18+
<entry>The operating system image version identifier of the running system, as read from the <varname>IMAGE_VERSION=</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>
19+
</row>
20+
<row id='b'>
21+
<entry><literal>%b</literal></entry>
22+
<entry>Boot ID</entry>
23+
<entry>The boot ID of the running system, formatted as string. See <citerefentry><refentrytitle>random</refentrytitle><manvolnum>4</manvolnum></citerefentry> for more information.</entry>
24+
</row>
25+
<row id='B'>
26+
<entry><literal>%B</literal></entry>
27+
<entry>Operating system build ID</entry>
28+
<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>
29+
</row>
30+
<row id='H'>
31+
<entry><literal>%H</literal></entry>
32+
<entry>Host name</entry>
33+
<entry>The hostname of the running system.</entry>
34+
</row>
35+
<row id='l'>
36+
<entry><literal>%l</literal></entry>
37+
<entry>Short host name</entry>
38+
<entry>The hostname of the running system, truncated at the first dot to remove any domain component.</entry>
39+
</row>
40+
<row id='m'>
41+
<entry><literal>%m</literal></entry>
42+
<entry>Machine ID</entry>
43+
<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>
44+
</row>
45+
<row id='M'>
46+
<entry><literal>%M</literal></entry>
47+
<entry>Operating system image identifier</entry>
48+
<entry>The operating system image identifier of the running system, as read from the <varname>IMAGE_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>
49+
</row>
50+
<row id='o'>
51+
<entry><literal>%o</literal></entry>
52+
<entry>Operating system ID</entry>
53+
<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>
54+
</row>
55+
<row id='q'>
56+
<entry><literal>%q</literal></entry>
57+
<entry>Pretty host name</entry>
58+
<entry>The pretty hostname of the running system, as read from the <varname>PRETTY_HOSTNAME=</varname> field of <filename>/etc/machine-info</filename>. If not set, resolves to the short hostname. See <citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>5</manvolnum></citerefentry> for more information.</entry>
59+
</row>
60+
<row id='T'>
61+
<entry><literal>%T</literal></entry>
62+
<entry>Directory for temporary files</entry>
63+
<entry>This is either <filename>/tmp<!-- no / --></filename> or the path <literal>$TMPDIR</literal>, <literal>$TEMP</literal> or <literal>$TMP</literal> are set to. (Note that the directory may be specified without a trailing slash.)</entry>
64+
</row>
65+
<row id='v'>
66+
<entry><literal>%v</literal></entry>
67+
<entry>Kernel release</entry>
68+
<entry>Identical to <command>uname -r</command> output.</entry>
69+
</row>
70+
<row id='V'>
71+
<entry><literal>%V</literal></entry>
72+
<entry>Directory for larger and persistent temporary files</entry>
73+
<entry>This is either <filename>/var/tmp<!-- no / --></filename> or the path <literal>$TMPDIR</literal>, <literal>$TEMP</literal> or <literal>$TMP</literal> are set to. (Note that the directory may be specified without a trailing slash.)</entry>
74+
</row>
75+
<row id='w'>
76+
<entry><literal>%w</literal></entry>
77+
<entry>Operating system version ID</entry>
78+
<entry>The operating system version identifier of the running system, as read from the <varname>VERSION_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>
79+
</row>
80+
<row id='W'>
81+
<entry><literal>%W</literal></entry>
82+
<entry>Operating system variant ID</entry>
83+
<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>
84+
</row>
85+
<row id='percent'>
86+
<entry><literal>%%</literal></entry>
87+
<entry>Single percent sign</entry>
88+
<entry>Use <literal>%%</literal> in place of <literal>%</literal> to specify a single percent sign.</entry>
89+
</row>
90+
</tbody>

‎man/systemd-sysusers.xml‎

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -35,23 +35,22 @@
3535
<refsect1>
3636
<title>Description</title>
3737

38-
<para><command>systemd-sysusers</command> creates system users and
39-
groups, based on the file format and location specified in
38+
<para><command>systemd-sysusers</command> creates system users and groups, based on files in the format
39+
described in
4040
<citerefentry><refentrytitle>sysusers.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
4141
</para>
4242

43-
<para>If invoked with no arguments, it applies all directives from all files
44-
found in the directories specified by
45-
<citerefentry><refentrytitle>sysusers.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
46-
When invoked with positional arguments, if option
47-
<option>--replace=<replaceable>PATH</replaceable></option> is specified, arguments
48-
specified on the command line are used instead of the configuration file
49-
<replaceable>PATH</replaceable>. Otherwise, just the configuration specified by
50-
the command line arguments is executed. The string <literal>-</literal> may be
51-
specified instead of a filename to instruct <command>systemd-sysusers</command>
52-
to read the configuration from standard input. If only the basename of a file is
53-
specified, all configuration directories are searched for a matching file and
54-
the file found that has the highest priority is executed.</para>
43+
<para>If invoked with no arguments, it applies all directives from all files found in the directories
44+
specified by
45+
<citerefentry><refentrytitle>sysusers.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>. When
46+
invoked with positional arguments, if option <option>--replace=<replaceable>PATH</replaceable></option>
47+
is specified, arguments specified on the command line are used instead of the configuration file
48+
<replaceable>PATH</replaceable>. Otherwise, just the configuration specified by the command line
49+
arguments is executed. The string <literal>-</literal> may be specified instead of a filename to instruct
50+
<command>systemd-sysusers</command> to read the configuration from standard input. If the argument is a
51+
relative path, all configuration directories are searched for a matching file and the file found that has
52+
the highest priority is executed. If the argument is an absolute path, that file is used directly without
53+
searching of the configuration directories.</para>
5554
</refsect1>
5655

5756
<refsect1>

0 commit comments

Comments
 (0)