Skip to content

Commit 885a4e6

Browse files
committed
man: assorted small fixes
This is almost all of systemd#17177.
1 parent 0558f30 commit 885a4e6

12 files changed

+86
-93
lines changed

man/homectl.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@
120120

121121
<listitem><para>Read the user's JSON record from the specified file. If passed as
122122
<literal>-</literal> read the user record from standard input. The supplied JSON object must follow
123-
the structure documented on <ulink url="https://systemd.io/USER_RECORD">JSON User Records</ulink>.
123+
the structure documented in <ulink url="https://systemd.io/USER_RECORD">JSON User Records</ulink>.
124124
This option may be used in conjunction with the <command>create</command> and
125125
<command>update</command> commands (see below), where it allows configuring the user record in JSON
126126
as-is, instead of setting the individual user record properties (see below).</para></listitem>
@@ -421,7 +421,7 @@
421421

422422
<listitem><para>Takes a password hint to store alongside the user record. This string is stored
423423
accessible only to privileged users and the user itself and may not be queried by other users.
424-
Example: <option>--password-hint="My first pet's name"</option></para></listitem>
424+
Example: <option>--password-hint="My first pet's name"</option>.</para></listitem>
425425
</varlistentry>
426426

427427
<varlistentry>

man/systemd-firstboot.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -211,8 +211,8 @@
211211
<varlistentry>
212212
<term><option>--prompt</option></term>
213213

214-
<listitem><para>Query the user for locale, keymap, timezone, hostname
215-
and root password. This is equivalent to specifying
214+
<listitem><para>Query the user for locale, keymap, timezone, hostname,
215+
root's password, and root's shell. This is equivalent to specifying
216216
<option>--prompt-locale</option>,
217217
<option>--prompt-keymap</option>,
218218
<option>--prompt-timezone</option>,

man/systemd-machined.service.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,9 +107,9 @@
107107
For more information please consult
108108
<citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>3</manvolnum></citerefentry>
109109
and
110-
<citerefentry><refentrytitle>org.freedesktop.machine1</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
110+
<citerefentry><refentrytitle>org.freedesktop.machine1</refentrytitle><manvolnum>5</manvolnum></citerefentry>
111111
and
112-
<citerefentry><refentrytitle>org.freedesktop.LogControl1</refentrytitle><manvolnum>5</manvolnum></citerefentry>
112+
<citerefentry><refentrytitle>org.freedesktop.LogControl1</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
113113
</para>
114114

115115
<para>A small companion daemon

man/systemd-mount.xml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,8 +131,9 @@
131131
<term><option>--type=</option></term>
132132
<term><option>-t</option></term>
133133

134-
<listitem><para>Specifies the file system type to mount (e.g. <literal>vfat</literal>, <literal>ext4</literal>,
135-
…). If omitted (or set to <literal>auto</literal>) the file system is determined automatically.</para></listitem>
134+
<listitem><para>Specifies the file system type to mount (e.g. <literal>vfat</literal> or
135+
<literal>ext4</literal>). If omitted or set to <literal>auto</literal>, the file system type is
136+
determined automatically.</para></listitem>
136137
</varlistentry>
137138

138139
<varlistentry>

man/systemd-notify.xml

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -136,11 +136,10 @@
136136
<varlistentry>
137137
<term><option>--no-block</option></term>
138138

139-
<listitem><para>Do not synchronously wait for the requested operation to finish.
140-
Use of this option is only recommended when <command>systemd-notify</command>
141-
is spawned by the service manager, or when the invoking process is directly spawned
142-
by the service manager and has enough privileges to allow <command>systemd-notify
143-
</command> to send the notification on its behalf. Sending notifications with
139+
<listitem><para>Do not synchronously wait for the requested operation to finish. Use of this option
140+
is only recommended when <command>systemd-notify</command> is spawned by the service manager, or when
141+
the invoking process is directly spawned by the service manager and has enough privileges to allow
142+
<command>systemd-notify</command> to send the notification on its behalf. Sending notifications with
144143
this option set is prone to race conditions in all other cases.</para></listitem>
145144
</varlistentry>
146145

man/systemd.exec.xml

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -231,13 +231,14 @@
231231
<varlistentry>
232232
<term><varname>RootHashSignature=</varname></term>
233233

234-
<listitem><para>Takes a PKCS7 formatted binary signature of the <varname>RootHash=</varname> option as a path
235-
to a DER encoded signature file or as an ASCII base64 string encoding of the DER encoded signature, prefixed
236-
by <literal>base64:</literal>. The dm-verity volume will only be opened if the signature of the root hash
237-
signature is valid and created by a public key present in the kernel keyring. If this option is not specified,
238-
but a file with the <filename>.roothash.p7s</filename> suffix is found next to the image file, bearing otherwise
239-
the same name (except if the image has the <filename>.raw</filename> suffix, in which case the signature file
240-
must not have it in its name), the signature is read from it and automatically used.</para>
234+
<listitem><para>Takes a PKCS7 signature of the <varname>RootHash=</varname> option as a path to a
235+
DER-encoded signature file, or as an ASCII base64 string encoding of a DER-encoded signature prefixed
236+
by <literal>base64:</literal>. The dm-verity volume will only be opened if the signature of the root
237+
hash is valid and signed by a public key present in the kernel keyring. If this option is not
238+
specified, but a file with the <filename>.roothash.p7s</filename> suffix is found next to the image
239+
file, bearing otherwise the same name (except if the image has the <filename>.raw</filename> suffix,
240+
in which case the signature file must not have it in its name), the signature is read from it and
241+
automatically used.</para>
241242

242243
<para>If the disk image contains a separate <filename>/usr/</filename> partition it may also be
243244
Verity protected, in which case the signature for the root hash may configured via a
@@ -681,7 +682,7 @@ CapabilityBoundingSet=~CAP_B CAP_C</programlisting>
681682
<listitem><para>Takes a profile name as argument. The process executed by the unit will switch to
682683
this profile when started. Profiles must already be loaded in the kernel, or the unit will fail. If
683684
prefixed by <literal>-</literal>, all errors will be ignored. This setting has no effect if AppArmor
684-
is not enabled. This setting not affect commands prefixed with <literal>+</literal>.</para>
685+
is not enabled. This setting does not affect commands prefixed with <literal>+</literal>.</para>
685686
</listitem>
686687
</varlistentry>
687688

@@ -1169,12 +1170,12 @@ CapabilityBoundingSet=~CAP_B CAP_C</programlisting>
11691170
<term><varname>LogsDirectory=</varname></term>
11701171
<term><varname>ConfigurationDirectory=</varname></term>
11711172

1172-
<listitem><para>These options take a whitespace-separated list of directory names. The specified directory
1173-
names must be relative, and may not include <literal>..</literal>. If set, one or more
1174-
directories by the specified names will be created (including their parents) below the locations
1175-
defined in the following table, when the unit is started. Also, the corresponding environment variable
1176-
is defined with the full path of directories. If multiple directories are set, then in the environment variable
1177-
the paths are concatenated with colon (<literal>:</literal>).</para>
1173+
<listitem><para>These options take a whitespace-separated list of directory names. The specified
1174+
directory names must be relative, and may not include <literal>..</literal>. If set, when the unit is
1175+
started, one or more directories by the specified names will be created (including their parents)
1176+
below the locations defined in the following table. Also, the corresponding environment variable will
1177+
be defined with the full paths of the directories. If multiple directories are set, then in the
1178+
environment variable the paths are concatenated with colon (<literal>:</literal>).</para>
11781179
<table>
11791180
<title>Automatic directory creation and environment variables</title>
11801181
<tgroup cols='4'>
@@ -1336,10 +1337,10 @@ StateDirectory=aaa/bbb ccc</programlisting>
13361337
<term><varname>ReadOnlyPaths=</varname></term>
13371338
<term><varname>InaccessiblePaths=</varname></term>
13381339

1339-
<listitem><para>Sets up a new file system namespace for executed processes. These options may be used to limit
1340-
access a process might have to the file system hierarchy. Each setting takes a space-separated list of paths
1341-
relative to the host's root directory (i.e. the system running the service manager). Note that if paths
1342-
contain symlinks, they are resolved relative to the root directory set with
1340+
<listitem><para>Sets up a new file system namespace for executed processes. These options may be used
1341+
to limit access a process has to the file system. Each setting takes a space-separated list of paths
1342+
relative to the host's root directory (i.e. the system running the service manager). Note that if
1343+
paths contain symlinks, they are resolved relative to the root directory set with
13431344
<varname>RootDirectory=</varname>/<varname>RootImage=</varname>.</para>
13441345

13451346
<para>Paths listed in <varname>ReadWritePaths=</varname> are accessible from within the namespace
@@ -2962,8 +2963,8 @@ StandardInputData=SWNrIHNpdHplIGRhIHVuJyBlc3NlIEtsb3BzLAp1ZmYgZWVtYWwga2xvcHAncy
29622963
<varlistentry>
29632964
<term><varname>$LOG_NAMESPACE</varname></term>
29642965

2965-
<listitem><para>If the <varname>LogNamespace=</varname> service setting is used, contains name of the
2966-
selected logging namespace.</para></listitem>
2966+
<listitem><para>Contains the name of the selected logging namespace when the
2967+
<varname>LogNamespace=</varname> service setting is used.</para></listitem>
29672968
</varlistentry>
29682969

29692970
<varlistentry>

man/systemd.journal-fields.xml

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -219,12 +219,10 @@
219219
<term><varname>_SYSTEMD_OWNER_UID=</varname></term>
220220

221221
<listitem>
222-
<para>The control group path in the systemd hierarchy, the
223-
the systemd slice unit name, the systemd unit name, the
224-
unit name in the systemd user manager (if any), the systemd
225-
session ID (if any), and the owner UID of the systemd user
226-
unit or systemd session (if any) of the process the journal
227-
entry originates from.</para>
222+
<para>The control group path in the systemd hierarchy, the systemd slice unit name, the systemd
223+
unit name, the unit name in the systemd user manager (if any), the systemd session ID (if any), and
224+
the owner UID of the systemd user unit or systemd session (if any) of the process the journal entry
225+
originates from.</para>
228226
</listitem>
229227
</varlistentry>
230228

@@ -398,15 +396,12 @@
398396
<varlistentry>
399397
<term><varname>_KERNEL_DEVICE=</varname></term>
400398
<listitem>
401-
<para>The kernel device name. If the entry is associated to
402-
a block device, the major and minor of the device node,
403-
separated by <literal>:</literal> and prefixed by
404-
<literal>b</literal>. Similar for character devices but
405-
prefixed by <literal>c</literal>. For network devices, this
406-
is the interface index prefixed by <literal>n</literal>. For
407-
all other devices, this is the subsystem name prefixed by
408-
<literal>+</literal>, followed by <literal>:</literal>,
409-
followed by the kernel device name.</para>
399+
<para>The kernel device name. If the entry is associated to a block device, contains the major and
400+
minor numbers of the device node, separated by <literal>:</literal> and prefixed by
401+
<literal>b</literal>. Similarly for character devices, but prefixed by <literal>c</literal>. For
402+
network devices, this is the interface index prefixed by <literal>n</literal>. For all other
403+
devices, this is the subsystem name prefixed by <literal>+</literal>, followed by
404+
<literal>:</literal>, followed by the kernel device name.</para>
410405
</listitem>
411406
</varlistentry>
412407
<varlistentry>

man/systemd.netdev.xml

Lines changed: 18 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -523,9 +523,8 @@
523523
<refsect1>
524524
<title>[MACVTAP] Section Options</title>
525525

526-
<para>The [MACVTAP] section applies for
527-
netdevs of kind <literal>macvtap</literal> and accepts the
528-
same key as [MACVLAN].</para>
526+
<para>The [MACVTAP] section applies for netdevs of kind <literal>macvtap</literal> and accepts the same
527+
keys as [MACVLAN].</para>
529528
</refsect1>
530529

531530
<refsect1>
@@ -558,9 +557,8 @@
558557
<refsect1>
559558
<title>[IPVTAP] Section Options</title>
560559

561-
<para>The [IPVTAP] section only applies for
562-
netdevs of kind <literal>ipvtap</literal> and accepts the
563-
same key as [IPVLAN].</para>
560+
<para>The [IPVTAP] section only applies for netdevs of kind <literal>ipvtap</literal> and accepts the
561+
same keys as [IPVLAN].</para>
564562
</refsect1>
565563

566564
<refsect1>
@@ -818,7 +816,7 @@
818816
<varlistentry>
819817
<term><varname>IPDoNotFragment=</varname></term>
820818
<listitem>
821-
<para>Accepts the same key in [VXLAN] section.</para>
819+
<para>Accepts the same key as in [VXLAN] section.</para>
822820
</listitem>
823821
</varlistentry>
824822
<varlistentry>
@@ -876,8 +874,8 @@
876874
<term><varname>PeerTunnelId=</varname></term>
877875
<listitem>
878876
<para>Specifies the peer tunnel id. Takes a number in the range 1—4294967295. The value used must
879-
match the <literal>PeerTunnelId=</literal> value being used at the peer. This setting is
880-
compulsory.</para>
877+
match the <literal>TunnelId=</literal> value being used at the peer. This setting is compulsory.
878+
</para>
881879
</listitem>
882880
</varlistentry>
883881
<varlistentry>
@@ -1100,43 +1098,43 @@
11001098
<varlistentry>
11011099
<term><varname>Port=</varname></term>
11021100
<listitem>
1103-
<para>Accepts the same key in [MACsecReceiveChannel] section.</para>
1101+
<para>Accepts the same key as in [MACsecReceiveChannel] section.</para>
11041102
</listitem>
11051103
</varlistentry>
11061104
<varlistentry>
11071105
<term><varname>MACAddress=</varname></term>
11081106
<listitem>
1109-
<para>Accepts the same key in [MACsecReceiveChannel] section.</para>
1107+
<para>Accepts the same key as in [MACsecReceiveChannel] section.</para>
11101108
</listitem>
11111109
</varlistentry>
11121110
<varlistentry>
11131111
<term><varname>PacketNumber=</varname></term>
11141112
<listitem>
1115-
<para>Accepts the same key in [MACsecTransmitAssociation] section.</para>
1113+
<para>Accepts the same key as in [MACsecTransmitAssociation] section.</para>
11161114
</listitem>
11171115
</varlistentry>
11181116
<varlistentry>
11191117
<term><varname>KeyId=</varname></term>
11201118
<listitem>
1121-
<para>Accepts the same key in [MACsecTransmitAssociation] section.</para>
1119+
<para>Accepts the same key as in [MACsecTransmitAssociation] section.</para>
11221120
</listitem>
11231121
</varlistentry>
11241122
<varlistentry>
11251123
<term><varname>Key=</varname></term>
11261124
<listitem>
1127-
<para>Accepts the same key in [MACsecTransmitAssociation] section.</para>
1125+
<para>Accepts the same key as in [MACsecTransmitAssociation] section.</para>
11281126
</listitem>
11291127
</varlistentry>
11301128
<varlistentry>
11311129
<term><varname>KeyFile=</varname></term>
11321130
<listitem>
1133-
<para>Accepts the same key in [MACsecTransmitAssociation] section.</para>
1131+
<para>Accepts the same key as in [MACsecTransmitAssociation] section.</para>
11341132
</listitem>
11351133
</varlistentry>
11361134
<varlistentry>
11371135
<term><varname>Activate=</varname></term>
11381136
<listitem>
1139-
<para>Accepts the same key in [MACsecTransmitAssociation] section.</para>
1137+
<para>Accepts the same key as in [MACsecTransmitAssociation] section.</para>
11401138
</listitem>
11411139
</varlistentry>
11421140
</variablelist>
@@ -1379,7 +1377,7 @@
13791377
<para>Specifies the encapsulation mechanism used to store networking packets of various protocols
13801378
inside the UDP packets. Supports the following values:
13811379

1382-
<literal>FooOverUDP</literal> provides the simplest no frills model of UDP encapsulation, it simply
1380+
<literal>FooOverUDP</literal> provides the simplest no-frills model of UDP encapsulation, it simply
13831381
encapsulates packets directly in the UDP payload. <literal>GenericUDPEncapsulation</literal> is a
13841382
generic and extensible encapsulation, it allows encapsulation of packets for any IP protocol and
13851383
optional data as part of the encapsulation. For more detailed information see <ulink
@@ -1391,10 +1389,9 @@
13911389
<varlistentry>
13921390
<term><varname>Port=</varname></term>
13931391
<listitem>
1394-
<para>Specifies the port number, where the IP encapsulation packets will arrive. Please take note
1395-
that the packets will arrive with the encapsulation will be removed. Then they will be manually fed
1396-
back into the network stack, and sent ahead for delivery to the real destination. This option is
1397-
mandatory.</para>
1392+
<para>Specifies the port number where the encapsulated packets will arrive. Those packets will be
1393+
removed and manually fed back into the network stack with the encapsulation removed to be sent to
1394+
the real destination. This option is mandatory.</para>
13981395
</listitem>
13991396
</varlistentry>
14001397
<varlistentry>

0 commit comments

Comments
 (0)