From 21006e0e3e73b9157b5a7f50c69c3641152778e1 Mon Sep 17 00:00:00 2001 From: Zbigniew Jędrzejewski-Szmek Date: Tue, 29 Sep 2020 08:03:10 +0200 Subject: man,units: link to the new dbus-api man pages --- man/systemd-resolved.service.xml | 6 +++--- man/systemd.offline-updates.xml | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) (limited to 'man') diff --git a/man/systemd-resolved.service.xml b/man/systemd-resolved.service.xml index 914607e3f8..6137a6d836 100644 --- a/man/systemd-resolved.service.xml +++ b/man/systemd-resolved.service.xml @@ -212,9 +212,9 @@ receives any DNS traffic not matching any of its configured search/route-only domains, set the "DNS default route" option for it to false. - See the resolved D-Bus API - Documentation for information about the APIs systemd-resolved provides. - + See + org.freedesktop.resolve15 + for information about the D-Bus APIs systemd-resolved provides. diff --git a/man/systemd.offline-updates.xml b/man/systemd.offline-updates.xml index 81a37f6789..49d98d496a 100644 --- a/man/systemd.offline-updates.xml +++ b/man/systemd.offline-updates.xml @@ -126,8 +126,8 @@ script exits uncleanly (by non-zero error code, or signal/coredump). If your script succeeds you should trigger the reboot in your own code, for example by invoking logind's Reboot() call or calling systemctl reboot. See - logind dbus API - for details. + org.freedesktop.login15 + for details about the logind D-Bus API. -- cgit v1.2.3 From fa26ff47f70c1baff92b65ceb003e25b70208907 Mon Sep 17 00:00:00 2001 From: Zbigniew Jędrzejewski-Szmek Date: Tue, 29 Sep 2020 09:21:15 +0200 Subject: man: adjustments in file-hierarchy(7) In table titles, capitalize only the first word (they are rather long and it is easier to read when it looks like a normal sentence). Adjust some phrases to make them clearer when reported as unclear in #17177. --- man/file-hierarchy.xml | 42 +++++++++++++++++++----------------------- 1 file changed, 19 insertions(+), 23 deletions(-) (limited to 'man') diff --git a/man/file-hierarchy.xml b/man/file-hierarchy.xml index d5899dc362..48114394c4 100644 --- a/man/file-hierarchy.xml +++ b/man/file-hierarchy.xml @@ -603,13 +603,12 @@ System Packages - Developers of system packages should follow strict rules - when placing their own files in the file system. The following - table lists recommended locations for specific types of files - supplied by the vendor. + Developers of system packages should follow strict rules when placing their files in the file + system. The following table lists recommended locations for specific types of files supplied by the + vendor. - System Package Vendor Files Locations + System package vendor files locations @@ -648,11 +647,11 @@ /usr/share/ hierarchy to the locations defined by the various relevant specifications. - During runtime, and for local configuration and runtime state, - additional directories are defined: + The following directories shall be used by the package for local configuration and files created + during runtime:
- System Package Variable Files Locations + System package variable files locations @@ -699,16 +698,13 @@ User Packages - Programs running in user context should follow strict rules - when placing their own files in the user's home directory. The - following table lists recommended locations in the home directory - for specific types of files supplied by the vendor if the - application is installed in the home directory. (Note, however, - that user applications installed system-wide should follow the - rules outlined above regarding placing vendor files.) + Programs running in user context should follow strict rules when placing their own files in the + user's home directory. The following table lists recommended locations in the home directory for specific + types of files supplied by the vendor if the application is installed in the home directory. (User + applications installed system-wide are covered by the rules outlined above for vendor files.)
- User Package Vendor File Locations + Vendor package file locations under the home directory of the user @@ -725,7 +721,7 @@ ~/.local/lib/arch-id/ - Public shared libraries of the package. As above, be careful with using too generic names, and pick unique names for your libraries to place here to avoid name clashes. + Public shared libraries of the package. As above, be careful with using overly generic names, and pick unique names for your libraries to place here to avoid name clashes. ~/.local/lib/package/ @@ -739,15 +735,15 @@
- Additional static vendor files may be installed in the - ~/.local/share/ hierarchy to the locations - defined by the various relevant specifications. + Additional static vendor files may be installed in the ~/.local/share/ + hierarchy, mirroring the subdirectories specified in the section "Vendor-supplied operating system + resources" above. - During runtime, and for local configuration and state, - additional directories are defined: + The following directories shall be used by the package for per-user local configuration and files + created during runtime: - User Package Variable File Locations + User package variable file locations -- cgit v1.2.3 From 7fd897c51ceaa3ff5760025598387ad1208498cf Mon Sep 17 00:00:00 2001 From: Zbigniew Jędrzejewski-Szmek Date: Tue, 29 Sep 2020 09:30:42 +0200 Subject: man: explain why TZ=: is used Also, reword the description a bit. "As a string" is meaningless in the context of commandline arguments, where evyrything is a string. This is not a strongly-typed programming language where 5 is a number but "5" is something completely different. Here both 5 and "5" are indistinguishable. The original text was trying to say that a location name should be given and not a number, so say "time zone location name". For #17177. --- man/homectl.xml | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) (limited to 'man') diff --git a/man/homectl.xml b/man/homectl.xml index dd16e47beb..732b7511ad 100644 --- a/man/homectl.xml +++ b/man/homectl.xml @@ -299,11 +299,13 @@ TIMEZONE - Takes a timezone specification as string that sets the timezone for the specified - user. Expects a `tzdata` location string. When the user logs in the $TZ - environment variable is initialized from this setting. Example: - will result in the environment variable - TZ=:Europe/Amsterdam. + Takes a time zone location name that sets the timezone for the specified user. When + the user logs in the $TZ environment variable is initialized from this + setting. Example: will result in the environment + variable TZ=:Europe/Amsterdam. (: is used intentionally as part + of the timezone specification, see + tzset3.) + -- cgit v1.2.3 From 32520ff3de75f17515262e23dcb183595d6f2540 Mon Sep 17 00:00:00 2001 From: Zbigniew Jędrzejewski-Szmek Date: Tue, 29 Sep 2020 09:43:18 +0200 Subject: man: reword description of "-" in sysctl.d(5) For #17177. --- man/sysctl.d.xml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'man') diff --git a/man/sysctl.d.xml b/man/sysctl.d.xml index 70504510f9..d348795063 100644 --- a/man/sysctl.d.xml +++ b/man/sysctl.d.xml @@ -70,11 +70,11 @@ key.pattern.overridden.with.glob = custom followed by =, see SYNOPSIS. Any access permission errors and attempts to write variables not present on the local system are - logged at debug level and do not cause the service to fail. Moreover, if a variable assignment is - prefixed with a single - character, failure to set the variable for other reasons will - be logged at debug level and will not cause the service to fail. In other cases, errors when setting - variables are logged with higher priority and cause the service to return failure at the end (after - processing other variables). + logged at debug level and do not cause the service to fail. Other types of errors when setting variables + are logged with higher priority and cause the service to return failure at the end (after processing + other variables). As an exception, if a variable assignment is prefixed with a single + - character, failure to set the variable for any reason will be logged at debug level + and will not cause the service to fail. The settings configured with sysctl.d files will be applied early on boot. The network interface-specific options will also be applied individually for each network interface as it -- cgit v1.2.3 From ab1a8ff57d66e62ae3eb5a75f0526f8dcfe73b93 Mon Sep 17 00:00:00 2001 From: Zbigniew Jędrzejewski-Szmek Date: Tue, 29 Sep 2020 09:55:00 +0200 Subject: man: refer to the right man page for Environment= For #17177. --- man/systemd.xml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'man') diff --git a/man/systemd.xml b/man/systemd.xml index d53b52b6b7..8eb5bd37ad 100644 --- a/man/systemd.xml +++ b/man/systemd.xml @@ -1087,15 +1087,15 @@ command line, and as a normal command line argument, the latter has higher precedence. When systemd is used as a user manager, the kernel command line is ignored and - the options described are understood. Nevertheless, systemd is usually started in - this mode through the + only the options described below are understood. Nevertheless, systemd is usually + started in this mode through the user@.service5 service, which is shared between all users, and it may be more convenient to use configuration files to - modify settings, see - systemd-user.conf5, - or a drop-in that specifies one of the environment variables listed above in the Environment section, - see - systemd.unit5. + modify settings (see + systemd-user.conf5), + or a drop-in that specifies one of the environment variables listed above in the Environment section + (see the discussion of Environment= and EnvironmentFile= in + systemd.exec5). -- cgit v1.2.3 From 211c99c7610395d151150a15b36ef0f57d1fd9e0 Mon Sep 17 00:00:00 2001 From: Zbigniew Jędrzejewski-Szmek Date: Tue, 29 Sep 2020 10:04:12 +0200 Subject: man: do not index various /foobar/ paths For #17177. --- man/environment.d.xml | 2 +- man/systemd-hibernate-resume-generator.xml | 2 +- man/systemd-homed.service.xml | 6 +++--- man/systemd-nspawn.xml | 21 +++++++++++---------- man/systemd.exec.xml | 2 +- man/systemd.service.xml | 2 +- man/systemd.special.xml | 4 ++-- man/systemd.unit.xml | 4 ++-- 8 files changed, 22 insertions(+), 21 deletions(-) (limited to 'man') diff --git a/man/environment.d.xml b/man/environment.d.xml index 0f53b0fef1..4db44616a7 100644 --- a/man/environment.d.xml +++ b/man/environment.d.xml @@ -76,7 +76,7 @@ Setup environment to allow access to a program installed in <filename index="false">/opt/foo</filename> - /etc/environment.d/60-foo.conf: + /etc/environment.d/60-foo.conf: FOO_DEBUG=force-software-gl,log-verbose diff --git a/man/systemd-hibernate-resume-generator.xml b/man/systemd-hibernate-resume-generator.xml index f532a19a48..60d66b201d 100644 --- a/man/systemd-hibernate-resume-generator.xml +++ b/man/systemd-hibernate-resume-generator.xml @@ -49,7 +49,7 @@ Takes a path to the resume device. Both persistent block device paths like - /dev/disk/by-foo/bar and + /dev/disk/by-foo/bar and fstab5-style specifiers like FOO=bar are supported. diff --git a/man/systemd-homed.service.xml b/man/systemd-homed.service.xml index ab8bcab8cb..d6a239bc96 100644 --- a/man/systemd-homed.service.xml +++ b/man/systemd-homed.service.xml @@ -86,9 +86,9 @@ In order to migrate a home directory from a host foobar to another host quux it is hence sufficient to copy /var/lib/systemd/home/local.public from the host foobar to - quux, maybe calling the file on the destination - /var/lib/systemd/home/foobar.public, reflecting the origin of the key. If the user - record should be modifiable on quux the pair + quux, maybe calling the file on the destination /var/lib/systemd/home/foobar.public, reflecting the origin of the key. If the + user record should be modifiable on quux the pair /var/lib/systemd/home/local.public and /var/lib/systemd/home/local.private need to be copied from foobar to quux, and placed under the identical paths there, as currently only a single diff --git a/man/systemd-nspawn.xml b/man/systemd-nspawn.xml index 7c89bc4423..cfdd27d8c4 100644 --- a/man/systemd-nspawn.xml +++ b/man/systemd-nspawn.xml @@ -348,16 +348,17 @@ terminated. When the mode parameter is specified as (the default), the whole OS tree is made available writable (unless is specified, see above). - Note that if one of the volatile modes is chosen, its effect is limited to the root file system (or - /var/ in case of ), and any other mounts placed in the hierarchy are - unaffected — regardless if they are established automatically (e.g. the EFI system partition that might be - mounted to /efi/ or /boot/) or explicitly (e.g. through an additional - command line option such as , see below). This means, even if - is used changes to /efi/ or - /boot/ are prohibited in case such a partition exists in the container image operated on, - and even if is used the hypothetical file /etc/foobar is - potentially writable if if used to mount it from outside the read-only - container /etc directory. + Note that if one of the volatile modes is chosen, its effect is limited to the root file system + (or /var/ in case of ), and any other mounts placed in the + hierarchy are unaffected — regardless if they are established automatically (e.g. the EFI system + partition that might be mounted to /efi/ or /boot/) or + explicitly (e.g. through an additional command line option such as , see + below). This means, even if is used changes to + /efi/ or /boot/ are prohibited in case such a partition + exists in the container image operated on, and even if is used the + hypothetical file /etc/foobar is potentially writable if + if used to mount it from outside the read-only container + /etc directory. The option is closely related to this setting, and provides similar behaviour by making a temporary, ephemeral copy of the whole OS image and executing that. For further details, diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml index ed657831f6..108e3c9bc6 100644 --- a/man/systemd.exec.xml +++ b/man/systemd.exec.xml @@ -1275,7 +1275,7 @@ CapabilityBoundingSet=~CAP_B CAP_C Example: if a system service unit has the following, RuntimeDirectory=foo/bar baz - the service manager creates /run/foo (if it does not exist), + the service manager creates /run/foo (if it does not exist), /run/foo/bar, and /run/baz. The directories /run/foo/bar and diff --git a/man/systemd.service.xml b/man/systemd.service.xml index d11e37da84..aec3a764a8 100644 --- a/man/systemd.service.xml +++ b/man/systemd.service.xml @@ -1307,7 +1307,7 @@ ls Simple service The following unit file creates a service that will - execute /usr/sbin/foo-daemon. Since no + execute /usr/sbin/foo-daemon. Since no Type= is specified, the default Type= will be assumed. systemd will assume the unit to be started immediately after the diff --git a/man/systemd.special.xml b/man/systemd.special.xml index a948969a8f..7011537d1f 100644 --- a/man/systemd.special.xml +++ b/man/systemd.special.xml @@ -862,8 +862,8 @@ pulled in via a dependency of the storage daemon and thus generally not be part of any transaction unless a storage daemon is used. The instance name for instances of this template unit must be a properly escaped block device node path, e.g. - blockdev@dev-mapper-foobar.target for the storage device - /dev/mapper/foobar. + blockdev@dev-mapper-foobar.target for the storage device + /dev/mapper/foobar. cryptsetup-pre.target diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml index cc6606022b..1ab6e2b0b9 100644 --- a/man/systemd.unit.xml +++ b/man/systemd.unit.xml @@ -279,7 +279,7 @@ When the input qualifies as absolute file system path, this algorithm is extended slightly: the path to the root directory / is encoded as single dash -. In addition, any leading, trailing or duplicate / characters are removed from the string before transformation. Example: - /foo//bar/baz/ becomes foo-bar-baz. + /foo//bar/baz/ becomes foo-bar-baz. This escaping is fully reversible, as long as it is known whether the escaped string was a path (the unescaping results are different for paths and non-path strings). The @@ -1922,7 +1922,7 @@ ExecStart=/usr/sbin/foo-daemon After running systemctl enable, a symlink - /etc/systemd/system/multi-user.target.wants/foo.service + /etc/systemd/system/multi-user.target.wants/foo.service linking to the actual unit will be created. It tells systemd to pull in the unit when starting multi-user.target. The inverse -- cgit v1.2.3 From 0b4d17c9a56e9fca049f8049e4317ce5c2604e63 Mon Sep 17 00:00:00 2001 From: Zbigniew Jędrzejewski-Szmek Date: Tue, 29 Sep 2020 10:10:35 +0200 Subject: man: link to fork(2) more prominently For #17177. --- man/systemd.exec.xml | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) (limited to 'man') diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml index 108e3c9bc6..4058540a63 100644 --- a/man/systemd.exec.xml +++ b/man/systemd.exec.xml @@ -1025,10 +1025,12 @@ CapabilityBoundingSet=~CAP_B CAP_C CPUSchedulingResetOnFork= - Takes a boolean argument. If true, elevated CPU scheduling priorities and policies will be - reset when the executed processes fork, and can hence not leak into child processes. See - sched_setscheduler2 for - details. Defaults to false. + Takes a boolean argument. If true, elevated CPU scheduling priorities and policies + will be reset when the executed processes call + fork2, + and can hence not leak into child processes. See + sched_setscheduler2 + for details. Defaults to false. @@ -3623,7 +3625,8 @@ StandardInputData=SWNrIHNpdHplIGRhIHVuJyBlc3NlIEtsb3BzLAp1ZmYgZWVtYWwga2xvcHAncy systemd.time7, systemd.directives7, tmpfiles.d5, - exec3 + exec3, + fork2 -- cgit v1.2.3 From 9e7600cfd73e428d2cf71cad105d0fc79bd33e0b Mon Sep 17 00:00:00 2001 From: Zbigniew Jędrzejewski-Szmek Date: Tue, 29 Sep 2020 12:16:12 +0200 Subject: man: in systemd-nspawn(1), refer to systemd.exec(5) for the shared stuff We should avoid duplicating lengthy description of very similar concepts. --root-hash-sig follows the same semantics as RootHashSig=, so just refer the reader to the other man page. --root-hash doesn't implement the same features as RootHash=, so we can't fully replace the description, but let's give the user a hint to look at the other man page too. For #17177. --- man/systemd-nspawn.xml | 22 +++++++++------------- 1 file changed, 9 insertions(+), 13 deletions(-) (limited to 'man') diff --git a/man/systemd-nspawn.xml b/man/systemd-nspawn.xml index cfdd27d8c4..854559cb61 100644 --- a/man/systemd-nspawn.xml +++ b/man/systemd-nspawn.xml @@ -405,24 +405,20 @@ user.verity.usrhash extended file attribute or via a .usrhash file adjacent to the disk image, following the same format and logic as for the root hash for the root file system described here. Note that there's currently no switch to configure the root hash for - the /usr/ from the command line. + the /usr/ from the command line. + + Also see the RootHash= option in + systemd.exec5. + - Takes a PKCS7 formatted binary signature of the option as a path - to a DER encoded signature file or as an ASCII base64 string encoding of the DER encoded signature, prefixed - by base64:. The dm-verity volume will only be opened if the signature of the root hash hex - string is valid and done by a public key present in the kernel keyring. If this option is not specified, but a - file with the .roothash.p7s suffix is found next to the image file, bearing otherwise the - same name (except if the image has the .raw suffix, in which case the signature file must - not have it in its name), the signature is read from it and automatically used. - - The root hash for the /usr/ file system included in a disk image may be - configured via a .usrhash.p7s file adjacent to the disk image. There's currently - no switch to configure the signature of the root hash of the /usr/ file system - from the command line. + Takes a PKCS7 signature of the option. + The semantics are the same as for the RootHashSignature= option, see + systemd.exec5. + -- cgit v1.2.3 From 0558f3035fac84f008cb7ddf215887c3087decb1 Mon Sep 17 00:00:00 2001 From: Zbigniew Jędrzejewski-Szmek Date: Tue, 29 Sep 2020 12:27:19 +0200 Subject: man/systemd.network(5): unify descriptions of MUDURL= Let's write one good description and refer to it from the other two spots. --- man/systemd.network.xml | 35 ++++++++++++++++++----------------- 1 file changed, 18 insertions(+), 17 deletions(-) (limited to 'man') diff --git a/man/systemd.network.xml b/man/systemd.network.xml index 02d56480b5..dc295198c3 100644 --- a/man/systemd.network.xml +++ b/man/systemd.network.xml @@ -1548,11 +1548,16 @@ IPv6Token=prefixstable:2002:da8:1:: MUDURL= - When configured, the Manufacturer Usage Descriptions (MUD) URL will be sent to the - DHCPv4 server. Takes an URL of length up to 255 characters. A superficial verification that - the string is a valid URL will be performed. DHCPv4 clients are intended to have at most one - MUD URL associated with them. See - RFC 8520. + When configured, the specified Manufacturer Usage Description (MUD) URL will be sent to the + DHCPv4 server. Takes a URL of length up to 255 characters. A superficial verification that the + string is a valid URL will be performed. DHCPv4 clients are intended to have at most one MUD URL + associated with them. See RFC 8520. + + + MUD is an embedded software standard defined by the IETF that allows IoT device makers to + advertise device specifications, including the intended communication patterns for their device + when it connects to the network. The network can then use this to author a context-specific + access policy, so the device functions only within those parameters. @@ -1847,10 +1852,9 @@ IPv6Token=prefixstable:2002:da8:1:: MUDURL= - When configured, the Manufacturer Usage Descriptions (MUD) URL will be sent to the DHCPV6 server. - Takes an URL of length up to 255 characters. A superficial verification that the string is a valid URL - will be performed. DHCPv6 clients are intended to have at most one MUD URL associated with them. See - RFC 8520. + When configured, the specified Manufacturer Usage Description (MUD) URL will be sent to + the DHCPV6 server. The syntax and semantics are the same as for MUDURL= in the + [DHCPv4] section described above. @@ -2567,14 +2571,11 @@ IPv6Token=prefixstable:2002:da8:1:: MUDURL= - Controls support for Ethernet LLDP packet's Manufacturer Usage Description (MUD). MUD is an embedded software - standard defined by the IETF that allows IoT Device makers to advertise device specifications, including the intended - communication patterns for their device when it connects to the network. The network can then use this intent to author - a context-specific access policy, so the device functions only within those parameters. Takes an URL of length up to 255 - characters. A superficial verification that the string is a valid URL - will be performed. See - RFC 8520 for details. The MUD URL received - from the LLDP packets will be saved at the state files and can be read via + When configured, the specified Manufacturer Usage Descriptions (MUD) URL will be sent in + LLDP packets. The syntax and semantics are the same as for MUDURL= in the + [DHCPv4] section described above. + + The MUD URLs received via LLDP packets are saved and can be read using the sd_lldp_neighbor_get_mud_url() function. -- cgit v1.2.3 From 885a4e6ca772dc04452bd34541599d295ff8cd5a Mon Sep 17 00:00:00 2001 From: Zbigniew Jędrzejewski-Szmek Date: Tue, 29 Sep 2020 12:31:27 +0200 Subject: man: assorted small fixes This is almost all of #17177. --- man/homectl.xml | 4 ++-- man/systemd-firstboot.xml | 4 ++-- man/systemd-machined.service.xml | 4 ++-- man/systemd-mount.xml | 5 +++-- man/systemd-notify.xml | 9 ++++----- man/systemd.exec.xml | 41 ++++++++++++++++++++-------------------- man/systemd.journal-fields.xml | 25 ++++++++++-------------- man/systemd.netdev.xml | 39 ++++++++++++++++++-------------------- man/systemd.network.xml | 34 ++++++++++++++++----------------- man/systemd.socket.xml | 2 +- man/systemd.special.xml | 2 +- man/systemd.xml | 10 +++++----- 12 files changed, 86 insertions(+), 93 deletions(-) (limited to 'man') diff --git a/man/homectl.xml b/man/homectl.xml index 732b7511ad..2ceb56e3f0 100644 --- a/man/homectl.xml +++ b/man/homectl.xml @@ -120,7 +120,7 @@ Read the user's JSON record from the specified file. If passed as - read the user record from standard input. The supplied JSON object must follow - the structure documented on JSON User Records. + the structure documented in JSON User Records. This option may be used in conjunction with the create and update commands (see below), where it allows configuring the user record in JSON as-is, instead of setting the individual user record properties (see below). @@ -421,7 +421,7 @@ Takes a password hint to store alongside the user record. This string is stored accessible only to privileged users and the user itself and may not be queried by other users. - Example: + Example: . diff --git a/man/systemd-firstboot.xml b/man/systemd-firstboot.xml index 0976394b66..48d1c89a47 100644 --- a/man/systemd-firstboot.xml +++ b/man/systemd-firstboot.xml @@ -211,8 +211,8 @@ - Query the user for locale, keymap, timezone, hostname - and root password. This is equivalent to specifying + Query the user for locale, keymap, timezone, hostname, + root's password, and root's shell. This is equivalent to specifying , , , diff --git a/man/systemd-machined.service.xml b/man/systemd-machined.service.xml index a976c606bd..a6b1aa0f13 100644 --- a/man/systemd-machined.service.xml +++ b/man/systemd-machined.service.xml @@ -107,9 +107,9 @@ For more information please consult sd-login3 and - org.freedesktop.machine15. + org.freedesktop.machine15 and - org.freedesktop.LogControl15 + org.freedesktop.LogControl15. A small companion daemon diff --git a/man/systemd-mount.xml b/man/systemd-mount.xml index f1089eed3b..3641c90248 100644 --- a/man/systemd-mount.xml +++ b/man/systemd-mount.xml @@ -131,8 +131,9 @@ - Specifies the file system type to mount (e.g. vfat, ext4, - …). If omitted (or set to auto) the file system is determined automatically. + Specifies the file system type to mount (e.g. vfat or + ext4). If omitted or set to auto, the file system type is + determined automatically. diff --git a/man/systemd-notify.xml b/man/systemd-notify.xml index 6d583003ba..f61bfd9980 100644 --- a/man/systemd-notify.xml +++ b/man/systemd-notify.xml @@ -136,11 +136,10 @@ - Do not synchronously wait for the requested operation to finish. - Use of this option is only recommended when systemd-notify - is spawned by the service manager, or when the invoking process is directly spawned - by the service manager and has enough privileges to allow systemd-notify - to send the notification on its behalf. Sending notifications with + Do not synchronously wait for the requested operation to finish. Use of this option + is only recommended when systemd-notify is spawned by the service manager, or when + the invoking process is directly spawned by the service manager and has enough privileges to allow + systemd-notify to send the notification on its behalf. Sending notifications with this option set is prone to race conditions in all other cases. diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml index 4058540a63..e5e97bf8fe 100644 --- a/man/systemd.exec.xml +++ b/man/systemd.exec.xml @@ -231,13 +231,14 @@ RootHashSignature= - Takes a PKCS7 formatted binary signature of the RootHash= option as a path - to a DER encoded signature file or as an ASCII base64 string encoding of the DER encoded signature, prefixed - by base64:. The dm-verity volume will only be opened if the signature of the root hash - signature is valid and created by a public key present in the kernel keyring. If this option is not specified, - but a file with the .roothash.p7s suffix is found next to the image file, bearing otherwise - the same name (except if the image has the .raw suffix, in which case the signature file - must not have it in its name), the signature is read from it and automatically used. + Takes a PKCS7 signature of the RootHash= option as a path to a + DER-encoded signature file, or as an ASCII base64 string encoding of a DER-encoded signature prefixed + by base64:. The dm-verity volume will only be opened if the signature of the root + hash is valid and signed by a public key present in the kernel keyring. If this option is not + specified, but a file with the .roothash.p7s suffix is found next to the image + file, bearing otherwise the same name (except if the image has the .raw suffix, + in which case the signature file must not have it in its name), the signature is read from it and + automatically used. If the disk image contains a separate /usr/ partition it may also be Verity protected, in which case the signature for the root hash may configured via a @@ -681,7 +682,7 @@ CapabilityBoundingSet=~CAP_B CAP_C Takes a profile name as argument. The process executed by the unit will switch to this profile when started. Profiles must already be loaded in the kernel, or the unit will fail. If prefixed by -, all errors will be ignored. This setting has no effect if AppArmor - is not enabled. This setting not affect commands prefixed with +. + is not enabled. This setting does not affect commands prefixed with +. @@ -1169,12 +1170,12 @@ CapabilityBoundingSet=~CAP_B CAP_C LogsDirectory= ConfigurationDirectory= - These options take a whitespace-separated list of directory names. The specified directory - names must be relative, and may not include ... If set, one or more - directories by the specified names will be created (including their parents) below the locations - defined in the following table, when the unit is started. Also, the corresponding environment variable - is defined with the full path of directories. If multiple directories are set, then in the environment variable - the paths are concatenated with colon (:). + These options take a whitespace-separated list of directory names. The specified + directory names must be relative, and may not include ... If set, when the unit is + started, one or more directories by the specified names will be created (including their parents) + below the locations defined in the following table. Also, the corresponding environment variable will + be defined with the full paths of the directories. If multiple directories are set, then in the + environment variable the paths are concatenated with colon (:).
Automatic directory creation and environment variables @@ -1336,10 +1337,10 @@ StateDirectory=aaa/bbb ccc ReadOnlyPaths= InaccessiblePaths= - Sets up a new file system namespace for executed processes. These options may be used to limit - access a process might have to the file system hierarchy. Each setting takes a space-separated list of paths - relative to the host's root directory (i.e. the system running the service manager). Note that if paths - contain symlinks, they are resolved relative to the root directory set with + Sets up a new file system namespace for executed processes. These options may be used + to limit access a process has to the file system. Each setting takes a space-separated list of paths + relative to the host's root directory (i.e. the system running the service manager). Note that if + paths contain symlinks, they are resolved relative to the root directory set with RootDirectory=/RootImage=. Paths listed in ReadWritePaths= are accessible from within the namespace @@ -2962,8 +2963,8 @@ StandardInputData=SWNrIHNpdHplIGRhIHVuJyBlc3NlIEtsb3BzLAp1ZmYgZWVtYWwga2xvcHAncy $LOG_NAMESPACE - If the LogNamespace= service setting is used, contains name of the - selected logging namespace. + Contains the name of the selected logging namespace when the + LogNamespace= service setting is used. diff --git a/man/systemd.journal-fields.xml b/man/systemd.journal-fields.xml index 31e3d8b210..a343e5697b 100644 --- a/man/systemd.journal-fields.xml +++ b/man/systemd.journal-fields.xml @@ -219,12 +219,10 @@ _SYSTEMD_OWNER_UID= - The control group path in the systemd hierarchy, the - the systemd slice unit name, the systemd unit name, the - unit name in the systemd user manager (if any), the systemd - session ID (if any), and the owner UID of the systemd user - unit or systemd session (if any) of the process the journal - entry originates from. + The control group path in the systemd hierarchy, the systemd slice unit name, the systemd + unit name, the unit name in the systemd user manager (if any), the systemd session ID (if any), and + the owner UID of the systemd user unit or systemd session (if any) of the process the journal entry + originates from. @@ -398,15 +396,12 @@ _KERNEL_DEVICE= - The kernel device name. If the entry is associated to - a block device, the major and minor of the device node, - separated by : and prefixed by - b. Similar for character devices but - prefixed by c. For network devices, this - is the interface index prefixed by n. For - all other devices, this is the subsystem name prefixed by - +, followed by :, - followed by the kernel device name. + The kernel device name. If the entry is associated to a block device, contains the major and + minor numbers of the device node, separated by : and prefixed by + b. Similarly for character devices, but prefixed by c. For + network devices, this is the interface index prefixed by n. For all other + devices, this is the subsystem name prefixed by +, followed by + :, followed by the kernel device name. diff --git a/man/systemd.netdev.xml b/man/systemd.netdev.xml index 2e716cca9c..863fa9108f 100644 --- a/man/systemd.netdev.xml +++ b/man/systemd.netdev.xml @@ -523,9 +523,8 @@ [MACVTAP] Section Options - The [MACVTAP] section applies for - netdevs of kind macvtap and accepts the - same key as [MACVLAN]. + The [MACVTAP] section applies for netdevs of kind macvtap and accepts the same + keys as [MACVLAN]. @@ -558,9 +557,8 @@ [IPVTAP] Section Options - The [IPVTAP] section only applies for - netdevs of kind ipvtap and accepts the - same key as [IPVLAN]. + The [IPVTAP] section only applies for netdevs of kind ipvtap and accepts the + same keys as [IPVLAN]. @@ -818,7 +816,7 @@ IPDoNotFragment= - Accepts the same key in [VXLAN] section. + Accepts the same key as in [VXLAN] section. @@ -876,8 +874,8 @@ PeerTunnelId= Specifies the peer tunnel id. Takes a number in the range 1—4294967295. The value used must - match the PeerTunnelId= value being used at the peer. This setting is - compulsory. + match the TunnelId= value being used at the peer. This setting is compulsory. + @@ -1100,43 +1098,43 @@ Port= - Accepts the same key in [MACsecReceiveChannel] section. + Accepts the same key as in [MACsecReceiveChannel] section. MACAddress= - Accepts the same key in [MACsecReceiveChannel] section. + Accepts the same key as in [MACsecReceiveChannel] section. PacketNumber= - Accepts the same key in [MACsecTransmitAssociation] section. + Accepts the same key as in [MACsecTransmitAssociation] section. KeyId= - Accepts the same key in [MACsecTransmitAssociation] section. + Accepts the same key as in [MACsecTransmitAssociation] section. Key= - Accepts the same key in [MACsecTransmitAssociation] section. + Accepts the same key as in [MACsecTransmitAssociation] section. KeyFile= - Accepts the same key in [MACsecTransmitAssociation] section. + Accepts the same key as in [MACsecTransmitAssociation] section. Activate= - Accepts the same key in [MACsecTransmitAssociation] section. + Accepts the same key as in [MACsecTransmitAssociation] section. @@ -1379,7 +1377,7 @@ Specifies the encapsulation mechanism used to store networking packets of various protocols inside the UDP packets. Supports the following values: - FooOverUDP provides the simplest no frills model of UDP encapsulation, it simply + FooOverUDP provides the simplest no-frills model of UDP encapsulation, it simply encapsulates packets directly in the UDP payload. GenericUDPEncapsulation is a generic and extensible encapsulation, it allows encapsulation of packets for any IP protocol and optional data as part of the encapsulation. For more detailed information see Port= - Specifies the port number, where the IP encapsulation packets will arrive. Please take note - that the packets will arrive with the encapsulation will be removed. Then they will be manually fed - back into the network stack, and sent ahead for delivery to the real destination. This option is - mandatory. + Specifies the port number where the encapsulated packets will arrive. Those packets will be + removed and manually fed back into the network stack with the encapsulation removed to be sent to + the real destination. This option is mandatory. diff --git a/man/systemd.network.xml b/man/systemd.network.xml index dc295198c3..7f959bbb6d 100644 --- a/man/systemd.network.xml +++ b/man/systemd.network.xml @@ -1861,8 +1861,9 @@ IPv6Token=prefixstable:2002:da8:1:: RequestOptions= - When configured, allows to set arbitrary request options in the DHCPv6 request options list and will - sent to the DHCPV6 server. A whitespace-separated list of integers in the range 1..254. Defaults to unset. + When configured, allows to set arbitrary request options in the DHCPv6 request options list + that will be sent to the DHCPV6 server. A whitespace-separated list of integers in the range + 1..254. Defaults to unset. @@ -2053,8 +2054,8 @@ IPv6Token=prefixstable:2002:da8:1:: UseOnLinkPrefix= - When true (the default), the onlink prefix received in the Router Advertisement will be used and take - precedence over any statically configured ones. + When true (the default), the onlink prefix received in the Router Advertisement will be + used and takes precedence over any statically configured ones. @@ -2566,7 +2567,7 @@ IPv6Token=prefixstable:2002:da8:1:: [LLDP] Section Options The [LLDP] section manages the Link Layer Discovery Protocol (LLDP) and accepts the following - keys. + keys: MUDURL= @@ -2893,11 +2894,11 @@ IPv6Token=prefixstable:2002:da8:1:: LimitBytes= - Specifies the hard limit on the FIFO size in bytes. The size limit (a buffer size) to prevent - it from overflowing in case it is unable to dequeue packets as quickly as it receives them. When - this limit is reached, incoming packets are dropped. When suffixed with K, M, or G, the specified - size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults - to unset and kernel's default is used. + Specifies the hard limit in bytes on the FIFO buffer size. The size limit prevents overflow + in case the kernel is unable to dequeue packets as quickly as it receives them. When this limit is + reached, incoming packets are dropped. When suffixed with K, M, or G, the specified size is parsed + as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to unset and + kernel default is used. @@ -3104,13 +3105,12 @@ IPv6Token=prefixstable:2002:da8:1:: PriorityMap= - The priority map maps the priority of a packet to a band. The argument is a white-space - separated list of numbers. The first number indicates which band the packets with priority - 0 should be put to, the second is for priority 1, and so on. There can be up to 16 numbers in - the list. If there are fewer, the default band that traffic with one of the unmentioned - priorities goes to is the last one. Each band number must be 0..255. This setting can be - specified multiple times. If an empty string is assigned, then the all previous assignments - are cleared. + The priority map maps the priority of a packet to a band. The argument is a whitespace + separated list of numbers. The first number indicates which band the packets with priority 0 should + be put to, the second is for priority 1, and so on. There can be up to 16 numbers in the list. If + there are fewer, the default band that traffic with one of the unmentioned priorities goes to is + the last one. Each band number must be in the range 0..255. This setting can be specified multiple + times. If an empty string is assigned, then the all previous assignments are cleared. diff --git a/man/systemd.socket.xml b/man/systemd.socket.xml index ba0ad1d36e..74e0007c88 100644 --- a/man/systemd.socket.xml +++ b/man/systemd.socket.xml @@ -299,7 +299,7 @@ url="https://www.kernel.org/doc/Documentation/usb/functionfs.txt">USB FunctionFS endpoints location to listen on, for implementation of USB gadget functions. This expects an - absolute file system path of FunctionFS mount point as the argument. + absolute file system path of a FunctionFS mount point as the argument. Behavior otherwise is very similar to the ListenFIFO= directive above. Use this to open the FunctionFS endpoint ep0. When using this option, the diff --git a/man/systemd.special.xml b/man/systemd.special.xml index 7011537d1f..d99a2183a2 100644 --- a/man/systemd.special.xml +++ b/man/systemd.special.xml @@ -1162,7 +1162,7 @@ systemd-xdg-autostart-generator8 for the XDG desktop files in autostart directories. Desktop Environments can opt-in to use this service by adding a Wants= - dependency on xdg-desktop-autostart.target. + dependency on xdg-desktop-autostart.target. diff --git a/man/systemd.xml b/man/systemd.xml index 8eb5bd37ad..0d6f853426 100644 --- a/man/systemd.xml +++ b/man/systemd.xml @@ -670,7 +670,7 @@ These variables may contain a list of paths, separated by colons (:). When set, if the list ends with an empty component (...:), this list is prepended to the - usual set of of paths. Otherwise, the specified list replaces the usual + usual set of paths. Otherwise, the specified list replaces the usual set of paths. @@ -850,9 +850,9 @@ Controls log output, with the same effect as the $SYSTEMD_LOG_COLOR, $SYSTEMD_LOG_LEVEL, $SYSTEMD_LOG_LOCATION, $SYSTEMD_LOG_TARGET, - $SYSTEMD_LOG_TIME, $SYSTEMD_LOG_TID environment variables - described above. systemd.log_color, systemd.log_location, - systemd.log_time and systemd.log_tid= can be specified without + $SYSTEMD_LOG_TIME, and $SYSTEMD_LOG_TID environment variables + described above. systemd.log_color, systemd.log_location, + systemd.log_time, and systemd.log_tid= can be specified without an argument, with the same effect as a positive boolean. @@ -1084,7 +1084,7 @@ Those options correspond directly to options listed above in "Kernel Command Line". Both forms may be used equivalently for the system manager, but it is recommended to use the forms listed above in this context, because they are properly namespaced. When an option is specified both on the kernel - command line, and as a normal command line argument, the latter has higher precedence. + command line and as a normal command line argument, the latter has higher precedence. When systemd is used as a user manager, the kernel command line is ignored and only the options described below are understood. Nevertheless, systemd is usually -- cgit v1.2.3