From: Zbigniew Jędrzejewski-Szmek Date: Thu, 28 Jan 2021 19:38:27 +0000 (+0100) Subject: man: various typos and other small issues X-Git-Tag: v248-rc1~236^2~1 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=75909cc7e48d6ebfa7c61bee1b089dd4e1ba0b5f;p=thirdparty%2Fsystemd.git man: various typos and other small issues Fixes #18397. --- diff --git a/man/networkctl.xml b/man/networkctl.xml index 466bba47ff3..ee204a60c55 100644 --- a/man/networkctl.xml +++ b/man/networkctl.xml @@ -104,7 +104,7 @@ carrier the link has a carrier, or for bond or bridge master, all bonding or bridge slave - network interfaces are enslaved to the master. + network interfaces are enslaved to the master diff --git a/man/systemd-dissect.xml b/man/systemd-dissect.xml index fd55fd0bfb3..caaf68dcae8 100644 --- a/man/systemd-dissect.xml +++ b/man/systemd-dissect.xml @@ -207,7 +207,7 @@ Takes one of disabled, loop, all, crypto. If disabled the image is - accessed with empty block discarding turned off. if loop discarding is enabled if + accessed with empty block discarding turned off. If loop discarding is enabled if operating on a regular file. If crypt discarding is enabled even on encrypted file systems. If all discarding is unconditionally enabled. @@ -217,15 +217,16 @@ - Configure various aspects of Verity data integrity for the OS - image. expects a hex-encoding top-level Verity hash to use for setting - up the Verity integrity protection. expects the path to a file - containing a PKCS#7 signature file for the hash. This signature is passed to the kernel during - activation, which will match it against signature keys available in the kernel - keyring. expects the path to a file with the Verity data to use for - the OS image, in case it is stored in a detached file. It is recommended to embed the Verity data - directly in the image, using the Verity mechanisms in the Discoverable Partitions Specification. + Configure various aspects of Verity data integrity for the OS image. Option + specifies a hex-encoded top-level Verity hash to use for setting up the + Verity integrity protection. Option specifies the path to a file + containing a PKCS#7 signature for the hash. This signature is passed to the kernel during activation, + which will match it against signature keys available in the kernel keyring. Option + specifies a path to a file with the Verity data to use for the OS + image, in case it is stored in a detached file. It is recommended to embed the Verity data directly + in the image, using the Verity mechanisms in the Discoverable Partitions Specification. + diff --git a/man/systemd-firstboot.xml b/man/systemd-firstboot.xml index a1607abb84a..10019249023 100644 --- a/man/systemd-firstboot.xml +++ b/man/systemd-firstboot.xml @@ -237,8 +237,8 @@ - Copy locale, keymap, time zone and root password from - the host. This is equivalent to specifying + Copy locale, keymap, time zone, root password and shell from the host. This is + equivalent to specifying , , , diff --git a/man/systemd-pstore.service.xml b/man/systemd-pstore.service.xml index 306f1099b04..66ad5572c82 100644 --- a/man/systemd-pstore.service.xml +++ b/man/systemd-pstore.service.xml @@ -34,10 +34,10 @@ thus preserving the existing information contained in the pstore, and clearing pstore storage for future error events. - Linux provides a persistent storage file system, pstore, that can store - error records when the kernel dies (or reboots or powers-off). These records in - turn can be referenced to debug kernel problems (currently the kernel stuffs - the tail of the dmesg, which also contains a stack backtrace, into pstore). + Linux provides a persistent storage file system, pstore, that can store error records when the + kernel dies (or reboots or powers-off). These records in turn can be referenced to debug kernel problems + (currently the kernel stores the tail of the kernel log, which also contains a stack backtrace, into + pstore). The pstore file system supports a variety of backends that map onto persistent storage, such as the ACPI ERST and UEFI variables. The pstore backends @@ -48,7 +48,7 @@ pstore. The pstore service is independent of the kdump service. In cloud environments - specifically, host and guest filesystems are on remote filesystems (eg. iSCSI + specifically, host and guest filesystems are on remote filesystems (e.g. iSCSI or NFS), thus kdump relies (implicitly and/or explicitly) upon proper operation of networking software *and* hardware *and* infrastructure. Thus it may not be possible to capture a kernel coredump to a file since writes over the network @@ -59,9 +59,9 @@ debugging. The systemd-pstore executable does the actual work. Upon starting, - the pstore.conf file is read and the /sys/fs/pstore + the pstore.conf file is read and the /sys/fs/pstore/ directory contents are processed according to the options. Pstore files are written to the - journal, and optionally saved into /var/lib/systemd/pstore. + journal, and optionally saved into /var/lib/systemd/pstore/. @@ -83,17 +83,14 @@ - Controlling kernel parameters + Kernel parameters The kernel has two parameters, /sys/module/kernel/parameters/crash_kexec_post_notifiers and - /sys/module/printk/parameters/always_kmsg_dump, - that control writes into pstore. - The crash_kexec_post_notifiers parameter enables the kernel to write - dmesg (including stack trace) into pstore upon a panic or crash, and - printk.always_kmsg_dump parameter enables the kernel to write dmesg - upon a normal shutdown (shutdown, reboot, halt). These kernel - parameters are managed via the + /sys/module/printk/parameters/always_kmsg_dump, that control writes into pstore. + The first enables storing of the kernel log (including stack trace) into pstore upon a panic or crash, + and the second enables storing of the kernel log upon a normal shutdown (shutdown, reboot, halt). These + parameters can be managed via the tmpfiles.d5 mechanism, specifically the file /usr/lib/tmpfiles/systemd-pstore.conf. diff --git a/man/systemd-resolved.service.xml b/man/systemd-resolved.service.xml index 93ffca6bfaa..09caf6b9a79 100644 --- a/man/systemd-resolved.service.xml +++ b/man/systemd-resolved.service.xml @@ -223,7 +223,7 @@ This section provides a short summary of differences in the stub resolver implemented by nss-resolve8 together - with systemd-resolved and the tranditional stub resolver implemented in + with systemd-resolved and the traditional stub resolver implemented in nss-dns8. diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml index 8f00ef555e0..d3336bedfc6 100644 --- a/man/systemd.exec.xml +++ b/man/systemd.exec.xml @@ -338,10 +338,10 @@ ProcSubset= Takes one of all (the default) and pid. If - the latter all files and directories not directly associated with process management and introspection - are made invisible in the /proc/ file system configured for the unit's - processes. This controls the subset= mount option of the procfs - instance for the unit. For further details see pid, all files and directories not directly associated with process management and + introspection are made invisible in the /proc/ file system configured for the + unit's processes. This controls the subset= mount option of the + procfs instance for the unit. For further details see The /proc Filesystem. Note that Linux exposes various kernel APIs via /proc/, which are made unavailable with this setting. Since these APIs are used frequently this option is @@ -1443,14 +1443,13 @@ BindReadOnlyPaths=/var/lib/systemd executed processes and mounts private /tmp/ and /var/tmp/ directories inside it that are not shared by processes outside of the namespace. This is useful to secure access to temporary files of the process, but makes sharing between processes via - /tmp/ or /var/tmp/ impossible. If this is enabled, all - temporary files created by a service in these directories will be removed after the service is - stopped. Defaults to false. It is possible to run two or more units within the same private - /tmp/ and /var/tmp/ namespace by using the - JoinsNamespaceOf= directive, see - systemd.unit5 for - details. This setting is implied if DynamicUser= is set. For this setting the same - restrictions regarding mount propagation and privileges apply as for + /tmp/ or /var/tmp/ impossible. If true, all temporary files + created by a service in these directories will be removed after the service is stopped. Defaults to + false. It is possible to run two or more units within the same private /tmp/ and + /var/tmp/ namespace by using the JoinsNamespaceOf= directive, + see systemd.unit5 + for details. This setting is implied if DynamicUser= is set. For this setting the + same restrictions regarding mount propagation and privileges apply as for ReadOnlyPaths= and related calls, see above. Enabling this setting has the side effect of adding Requires= and After= dependencies on all mount units necessary to access /tmp/ and /var/tmp/. Moreover an @@ -2762,8 +2761,7 @@ StandardInputData=SWNrIHNpdHplIGRhIHVuJyBlc3NlIEtsb3BzLAp1ZmYgZWVtYWwga2xvcHAncy ExecStart= command line use ${CREDENTIALS_DIRECTORY}/mycred, e.g. ExecStart=cat ${CREDENTIALS_DIRECTORY}/mycred. - Currently, an accumulated credential size limit of 1M bytes per unit is - enforced. + Currently, an accumulated credential size limit of 1 MB per unit is enforced. If referencing an AF_UNIX stream socket to connect to, the connection will originate from an abstract namespace socket, that includes information about the unit and the diff --git a/man/systemd.net-naming-scheme.xml b/man/systemd.net-naming-scheme.xml index 054de92c0b4..646dd3e5611 100644 --- a/man/systemd.net-naming-scheme.xml +++ b/man/systemd.net-naming-scheme.xml @@ -271,7 +271,7 @@ History The following "naming schemes" have been defined (which may be chosen at system boot-up time via - the net.naming-scheme= kernel command line switch, see above: + the net.naming-scheme= kernel command line switch, see above): @@ -362,11 +362,11 @@ v247 - If the PCI slot is associated with PCI bridge and that has multiple child network - controllers then all of them might derive the same value of ID_NET_NAME_SLOT - property. That could cause naming conflict if the property is selected as a device name. Now, we detect the - situation, slot - bridge relation, and we don't produce the ID_NET_NAME_SLOT property to - avoid possible naming conflict. + When a PCI slot is associated with a PCI bridge that has multiple child network + controllers, the same value of the ID_NET_NAME_SLOT property might be derived + for those controllers. This would cause a naming conflict if the property is selected as the device + name. Now, we detect this situation and don't produce the ID_NET_NAME_SLOT + property. diff --git a/man/systemd.network.xml b/man/systemd.network.xml index 6d7d7e94a50..cb445ec16bf 100644 --- a/man/systemd.network.xml +++ b/man/systemd.network.xml @@ -665,8 +665,7 @@ IPv6Token=prefixstable:2002:da8:1:: DNS= - A DNS server address, which must be in the format - described in + A DNS server address, which must be in the format described in inet_pton3. This option may be specified more than once. Each address can optionally take a port number separated with :, a network interface name or index separated with @@ -674,9 +673,8 @@ IPv6Token=prefixstable:2002:da8:1:: When IPv6 address is specified with a port number, then the address must be in the square brackets. That is, the acceptable full formats are 111.222.333.444:9953%ifname#example.com for IPv4 and - [1111:2222::3333]:9953%ifname#example.com for IPv6. This setting can be - specified multiple times. If an empty string is assigned, then the all previous assignments - are cleared. This setting is read by + [1111:2222::3333]:9953%ifname#example.com for IPv6. If an empty string is + assigned, then the all previous assignments are cleared. This setting is read by systemd-resolved.service8. @@ -1074,13 +1072,12 @@ IPv6Token=prefixstable:2002:da8:1:: PreferredLifetime= - Allows the default "preferred lifetime" of the address to be overridden. - Only three settings are accepted: forever or infinity - which is the default and means that the address never expires, and 0 which means - that the address is considered immediately "expired" and will not be used, - unless explicitly requested. A setting of PreferredLifetime=0 is useful for - addresses which are added to be used only by a specific application, - which is then configured to use them explicitly. + Allows the default "preferred lifetime" of the address to be overridden. Only three + settings are accepted: forever, infinity, which is the + default and means that the address never expires, and 0, which means that the + address is considered immediately "expired" and will not be used, unless explicitly requested. A + setting of is useful for addresses which are added to be + used only by a specific application, which is then configured to use them explicitly. @@ -1882,8 +1879,8 @@ IPv6Token=prefixstable:2002:da8:1:: RequestOptions= - When configured, allows to set arbitrary request options in the DHCPv4 request options list and will be - sent to the DHCPV4 server. A whitespace-separated list of integers in the range 1..254. Defaults to unset. + Sets request options to be sent to the server in the DHCPv4 request options list. A + whitespace-separated list of integers in the range 1..254. Defaults to unset. @@ -1965,7 +1962,7 @@ IPv6Token=prefixstable:2002:da8:1:: MUDURL= 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 + the DHCPv6 server. The syntax and semantics are the same as for MUDURL= in the [DHCPv4] section described above. @@ -1974,7 +1971,7 @@ IPv6Token=prefixstable:2002:da8:1:: RequestOptions= 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 + that will be sent to the DHCPv6 server. A whitespace-separated list of integers in the range 1..254. Defaults to unset. @@ -2306,7 +2303,7 @@ IPv6Token=prefixstable:2002:da8:1:: servers set. The "uplink" interface is determined by the default route of the system with the highest priority. Note that this information is acquired at the time the lease is handed out, and does not take uplink interfaces into account that acquire DNS server information at a later point. If no - suitable uplinkg interface is found the DNS server data from /etc/resolv.conf is + suitable uplink interface is found the DNS server data from /etc/resolv.conf is used. Also, note that the leases are not refreshed if the uplink network configuration changes. To ensure clients regularly acquire the most current uplink DNS server information, it is thus advisable to shorten the DHCP lease time via MaxLeaseTimeSec= described @@ -3022,8 +3019,9 @@ IPv6Token=prefixstable:2002:da8:1:: PacketLimit= - Specifies the hard limit on the queue size in number of packets. When this limit is reached, incoming packets are - dropped. An unsigned integer ranges 1 to 4294967294. Defaults to unset and kernel's default is used. + Specifies the hard limit on the queue size in number of packets. When this limit is reached, + incoming packets are dropped. An unsigned integer ranges 1 to 4294967294. Defaults to unset and + kernel's default is used. @@ -3101,10 +3099,10 @@ IPv6Token=prefixstable:2002:da8:1:: PacketLimit= - Specifies the hard limit on the FIFO size in number of packets. 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. An unsigned integer in the - range 0–4294967294. Defaults to unset and kernel's default is used. + Specifies the hard limit on the number of packets in the FIFO queue. 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. An unsigned integer in the range + 0–4294967294. Defaults to unset and kernel's default is used. @@ -3682,9 +3680,9 @@ IPv6Token=prefixstable:2002:da8:1:: MaxPacketBytes= - Specifies the maximum packet size in bytes for the class. When suffixed with K, M, or G, the specified - size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. When unset, - the kernel default is used. + Specifies the maximum packet size in bytes for the class. When suffixed with K, M, or G, the + specified size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of + 1024. When unset, the kernel default is used. diff --git a/man/systemd.resource-control.xml b/man/systemd.resource-control.xml index 6c513ed57ea..ea979ee2836 100644 --- a/man/systemd.resource-control.xml +++ b/man/systemd.resource-control.xml @@ -905,10 +905,11 @@ DeviceAllow=/dev/loop-control Overrides the default memory pressure limit set by - oomd.conf5 for this unit - (cgroup). Takes a percentage value between 0% and 100%, inclusive. This property is ignored unless - ManagedOOMMemoryPressure=. Defaults to 0%, which means use the - default set by oomd.conf5. + oomd.conf5 for + this unit (cgroup). Takes a percentage value between 0% and 100%, inclusive. This property is + ignored unless ManagedOOMMemoryPressure=. Defaults to 0%, + which means to use the default set by + oomd.conf5. diff --git a/man/systemd.service.xml b/man/systemd.service.xml index 5da6d132eec..25cca3d8d61 100644 --- a/man/systemd.service.xml +++ b/man/systemd.service.xml @@ -780,7 +780,7 @@ abnormally by a signal, or hit a timeout. - Exit causes and the effect of the <varname>Restart=</varname> settings on them + Exit causes and the effect of the <varname>Restart=</varname> settings diff --git a/man/systemd.special.xml b/man/systemd.special.xml index ce1e8655f56..948380b9b52 100644 --- a/man/systemd.special.xml +++ b/man/systemd.special.xml @@ -1281,9 +1281,9 @@ The XDG specification defines a way to autostart applications using XDG desktop files. systemd ships 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. + 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.