From 8fb350049bb7a7305589f201df9d37482e544f24 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Wed, 17 May 2023 12:24:04 +0200 Subject: [PATCH] man: fixes for assorted issues reported by the manpage-l10n project Fixes #26761. --- man/loader.conf.xml | 6 +++--- man/nss-resolve.xml | 7 +++++-- man/org.freedesktop.systemd1.xml | 7 ++++--- man/repart.d.xml | 15 ++++++++++----- man/systemd-boot-random-seed.service.xml | 10 ++++++---- man/systemd-boot.xml | 4 ++-- man/systemd-dissect.xml | 18 ++++++++++-------- man/systemd-notify.xml | 2 +- man/systemd-nspawn.xml | 10 ++++++---- man/systemd-pcrphase.service.xml | 23 +++++++++++++---------- man/systemd-repart.xml | 6 +++--- man/systemd.exec.xml | 24 +++++++++++++----------- man/systemd.net-naming-scheme.xml | 15 ++++++++------- man/systemd.path.xml | 2 +- man/systemd.service.xml | 9 +++++---- man/systemd.system-credentials.xml | 20 ++++++++++---------- man/systemd.timer.xml | 2 +- man/sysupdate.d.xml | 2 +- man/ukify.xml | 7 ++++--- 19 files changed, 106 insertions(+), 83 deletions(-) diff --git a/man/loader.conf.xml b/man/loader.conf.xml index a0fc278c2ac..dbbc4b4f5d5 100644 --- a/man/loader.conf.xml +++ b/man/loader.conf.xml @@ -261,9 +261,9 @@ allows one to ship multiple sets of Secure Boot variables and choose which one to enroll at runtime. - Supported Secure Boot variables are one database for authorized images, one key exchange key - (KEK) and one platform key (PK). For more information, refer to the UEFI specification, under Secure Boot and Driver + Supported Secure Boot variables are one database for authorized images, one for the key + exchange key (KEK) and one for the platform key (PK). For more information, refer to the + UEFI specification, under Secure Boot and Driver Signing. Another resource that describe the interplay of the different variables is the EDK2 documentation. diff --git a/man/nss-resolve.xml b/man/nss-resolve.xml index b72b1ba64d0..9954d4082f7 100644 --- a/man/nss-resolve.xml +++ b/man/nss-resolve.xml @@ -94,7 +94,9 @@ $SYSTEMD_NSS_RESOLVE_CACHE Takes a boolean argument. When false, the cache of previously queried records will - not be used by systemd-resolved. + not be used by + systemd-resolved8. + @@ -121,7 +123,8 @@ $SYSTEMD_NSS_RESOLVE_NETWORK Takes a boolean argument. When false, answers will be returned without using the - network, i.e. either from local sources or the cache in systemd-resolved. + network, i.e. either from local sources or the cache in + systemd-resolved8. diff --git a/man/org.freedesktop.systemd1.xml b/man/org.freedesktop.systemd1.xml index 09bde73af1f..476971b4535 100644 --- a/man/org.freedesktop.systemd1.xml +++ b/man/org.freedesktop.systemd1.xml @@ -2516,9 +2516,10 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice { only provided in a best effort fashion: it is not guaranteed to be set, and it is not guaranteed to be the only trigger. It is only guaranteed to be a valid trigger that caused the activation job to be enqueued and complete successfully. The key value pairs correspond (in lowercase) to the environment - variables described in the Environment Variables Set on Triggered Units section in - systemd.exec1. - Note that new key value pair may be added at any time in future versions. Existing entries will not be + variables described in the Environment Variables Set or Propagated by the Service + Manager section in + systemd.exec1. Note + that new key value pair may be added at any time in future versions. Existing entries will not be removed. diff --git a/man/repart.d.xml b/man/repart.d.xml index 4c13ccfb580..464bbf076d9 100644 --- a/man/repart.d.xml +++ b/man/repart.d.xml @@ -423,7 +423,8 @@ Note that CopyFiles= will skip copying files that aren't supported by the target filesystem (e.g symlinks, fifos, sockets and devices on vfat). When an unsupported file type - is encountered, repart will skip copying this file and write a log message about it. + is encountered, systemd-repart will skip copying this file and write a log message + about it. Note that systemd-repart does not change the UIDs/GIDs of any copied files and directories. When running systemd-repart as an unprivileged user to build an @@ -433,7 +434,9 @@ Note that when populating XFS filesystems with systemd-repart and loop devices are not available, populating XFS filesystems with files containing spaces, tabs or newlines - will fail due to limitations of mkfs.xfs's protofile format. + will fail due to limitations of mkfs.xfs8 + protofile format. This option cannot be combined with CopyBlocks=. @@ -614,9 +617,11 @@ SplitName= Configures the suffix to append to split artifacts when the - option of systemd-repart is used. Simple specifier expansion is supported, see - below. Defaults to %t. To disable split artifact generation for a partition, set - SplitName= to -. + option of + systemd-repart8 is + used. Simple specifier expansion is supported, see below. Defaults to %t. To + disable split artifact generation for a partition, set SplitName= to + -. diff --git a/man/systemd-boot-random-seed.service.xml b/man/systemd-boot-random-seed.service.xml index ad3477a97ad..87e2e270d02 100644 --- a/man/systemd-boot-random-seed.service.xml +++ b/man/systemd-boot-random-seed.service.xml @@ -67,10 +67,12 @@ times. Specifically: - In UEFI mode, the systemd-boot or - systemd-stub components load the boot loader random seed off the ESP, hash it with - available entropy and the system token, and then update it on disk. A derived seed is passed to the - kernel which writes it to its entropy pool. + In UEFI mode, the + systemd-boot7 or + systemd-stub7 + components load the boot loader random seed from the ESP, hash it with available entropy and the system + token, and then update it on disk. A derived seed is passed to the kernel which writes it to its + entropy pool. In userspace the systemd-random-seed.service service loads the OS random seed, writes it to the kernel entropy pool, and then updates it on disk with a new value derived diff --git a/man/systemd-boot.xml b/man/systemd-boot.xml index a64281b9190..30908e398a3 100644 --- a/man/systemd-boot.xml +++ b/man/systemd-boot.xml @@ -504,11 +504,11 @@ - Using systemd-boot in virtual machines. + Using <command>systemd-boot</command> in virtual machines When using qemu with OVMF (UEFI Firmware for virtual machines) the switch works not only for linux kernels, but for any EFI binary, including sd-boot and unified linux - kernels. Example command line for loading sd-boot on x64: + kernels. Example command line for loading systemd-boot on x64: qemu-system-x86_64 [ ... ] diff --git a/man/systemd-dissect.xml b/man/systemd-dissect.xml index 06ee0717f82..0f7928a6c1e 100644 --- a/man/systemd-dissect.xml +++ b/man/systemd-dissect.xml @@ -210,17 +210,19 @@ - Generates a BSD mtree8 + Generates a BSD + mtree8 compatible file manifest of the specified disk image. This is useful for comparing disk image contents in detail, including inode information and other metadata. While the generated manifest will contain detailed inode information, it currently excludes extended attributes, file system - capabilities, MAC labels, chattr1 file - flags, btrfs subvolume information, and various other file metadata. File content information is - shown via a SHA256 digest. Additional fields might be added in future. Note that inode information - such as link counts, inode numbers and timestamps is excluded from the output on purpose, as it - typically complicates reproducibility. + capabilities, MAC labels, + chattr1 + file flags, + btrfs5 + subvolume information, and various other file metadata. File content information is shown via a + SHA256 digest. Additional fields might be added in future. Note that inode information such as link + counts, inode numbers and timestamps is excluded from the output on purpose, as it typically + complicates reproducibility. diff --git a/man/systemd-notify.xml b/man/systemd-notify.xml index 1b469fe85c4..8554f39e482 100644 --- a/man/systemd-notify.xml +++ b/man/systemd-notify.xml @@ -98,7 +98,7 @@ cycle. This is equivalent to systemd-notify RELOADING=1 (but implicitly also sets a MONOTONIC_USEC= field as required for Type=notify-reload services, see - systemd.service5, + systemd.service5 for details). For details about the semantics of this option see sd_notify3. diff --git a/man/systemd-nspawn.xml b/man/systemd-nspawn.xml index ded8e3cd715..847a11f0e0c 100644 --- a/man/systemd-nspawn.xml +++ b/man/systemd-nspawn.xml @@ -1396,13 +1396,15 @@ After=sys-subsystem-net-devices-ens1.device seen from inside of the container is mapped to in the range on the host. Other host users are mapped to inside the container. + If is used, any user in the UID range as seen from inside the container is mapped to the same - in the same range on the host. All host users outside of that range are - mapped to inside the container. + in the same range on the host. Other host users are mapped to + inside the container. + If is used, the user seen from inside - of the container is mapped to on the host. All host users outside of that range - are mapped to inside the container. + of the container is mapped to on the host. Other host users are mapped to + inside the container. Whichever ID mapping option is used, the same mapping will be used for users and groups IDs. If diff --git a/man/systemd-pcrphase.service.xml b/man/systemd-pcrphase.service.xml index 24c7560468f..fad9d8247ae 100644 --- a/man/systemd-pcrphase.service.xml +++ b/man/systemd-pcrphase.service.xml @@ -67,33 +67,36 @@ enter-initrd — early when the initrd initializes, before activating system extension images for the initrd. It acts as a barrier between the time where the kernel initializes and where the initrd starts operating and enables system extension images, i.e. code - shipped outside of the UKI. (This extension happens when - systemd-pcrphase-initrd.service is started.) + shipped outside of the UKI. (This extension happens when the + systemd-pcrphase-initrd.service8 + service is started.) leave-initrd — when the initrd is about to transition into the host - file system. It acts as barrier between initrd code and host OS code. (This extension happens when - systemd-pcrphase-initrd.service is stopped.) + file system. It acts as barrier between initrd code and host OS code. (This extension happens when the + systemd-pcrphase-initrd.service service is stopped.) sysinit — when basic system initialization is complete (which includes local file systems having been mounted), and the system begins starting regular system - services. (This extension happens when systemd-pcrphase-sysinit.service is - started.) + services. (This extension happens when the + systemd-pcrphase-sysinit.service8 + service is started.) ready — during later boot-up, after remote file systems have been activated (i.e. after remote-fs.target), but before users are permitted to log in (i.e. before systemd-user-sessions.service). It acts as barrier between the time where unprivileged regular users are still prohibited to log in and where they are allowed to log in. - (This extension happens when systemd-pcrphase.service is started.) + (This extension happens when the systemd-pcrphase.service service is started.) shutdown — when the system shutdown begins. It acts as barrier between the time the system is fully up and running and where it is about to shut down. (This extension - happens when systemd-pcrphase.service is stopped.) + happens when the systemd-pcrphase.service service is stopped.) final — at the end of system shutdown. It acts as barrier between the time the service manager still runs and when it transitions into the final shutdown phase where - service management is not available anymore. (This extension happens when - systemd-pcrphase-sysinit.service is stopped.) + service management is not available anymore. (This extension happens when the + systemd-pcrphase-sysinit.service8 + service is stopped.) During a regular system lifecycle, PCR 11 is extended with the strings diff --git a/man/systemd-repart.xml b/man/systemd-repart.xml index 98ca1c431a6..cd5d4631dbf 100644 --- a/man/systemd-repart.xml +++ b/man/systemd-repart.xml @@ -384,8 +384,8 @@ This option specifies for which partition types systemd-repart should defer. All partitions that are deferred using this option are still taken into account when calculating the sizes and offsets of other partitions, but aren't actually written to the disk image. - The net effect of this option is that if you run systemd-repart again without - these options, the missing partitions will be added as if they had not been deferred the first time + The net effect of this option is that if you run systemd-repart again without this + option, the missing partitions will be added as if they had not been deferred the first time systemd-repart was executed. @@ -395,7 +395,7 @@ This option allows configuring the sector size of the image produced by systemd-repart. It takes a value that is a power of 2 between 512 and 4096. This option is useful when building images for - disks that use a different sector size as the disk on which the image is produced.. + disks that use a different sector size as the disk on which the image is produced. diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml index 795e26e792a..45294154dbd 100644 --- a/man/systemd.exec.xml +++ b/man/systemd.exec.xml @@ -2957,21 +2957,23 @@ StandardInputData=V2XigLJyZSBubyBzdHJhbmdlcnMgdG8gbG92ZQpZb3Uga25vdyB0aGUgcnVsZX LogRateLimitIntervalSec= LogRateLimitBurst= - Configures the rate limiting that is applied to log messages generated by this - unit. If, in the time interval defined by LogRateLimitIntervalSec=, more messages - than specified in LogRateLimitBurst= are logged by a service, all further messages + Configures the rate limiting that is applied to log messages generated by this unit. + If, in the time interval defined by LogRateLimitIntervalSec=, more messages than + specified in LogRateLimitBurst= are logged by a service, all further messages within the interval are dropped until the interval is over. A message about the number of dropped messages is generated. The time specification for LogRateLimitIntervalSec= may be - specified in the following units: "s", "min", "h", "ms", "us" (see + specified in the following units: "s", "min", "h", "ms", "us". See systemd.time7 for - details). The default settings are set by RateLimitIntervalSec= and + details. The default settings are set by RateLimitIntervalSec= and RateLimitBurst= configured in - journald.conf5. Note - that this only applies to log messages that are processed by the logging subsystem, i.e. by - systemd-journald.service. This means, if you connect a service's stderr directly - to a file via StandardOutput=file:… or a similar setting the rate limiting will - not be applied to messages written that way (but they will be enforced for messages generated via - syslog() or similar). + journald.conf5. + Note that this only applies to log messages that are processed by the logging subsystem, i.e. by + systemd-journald.service8 + This means that if you connect a service's stderr directly to a file via + StandardOutput=file:… or a similar setting, the rate limiting will not be applied + to messages written that way (but it will be enforced for messages generated via + syslog3 + and similar functions). diff --git a/man/systemd.net-naming-scheme.xml b/man/systemd.net-naming-scheme.xml index 1e2295ba7a8..a2c82fb9161 100644 --- a/man/systemd.net-naming-scheme.xml +++ b/man/systemd.net-naming-scheme.xml @@ -101,10 +101,11 @@ ID_NET_NAME_ONBOARD=prefixdnumber This name is set based on the numeric ordering information given by the firmware - for on-board devices. Different schemes are used depending on the firmware type, as described in the table below. + for on-board devices. Different schemes are used depending on the firmware type, as described in + the table below. - Onboard naming schemes + On-board naming schemes @@ -117,7 +118,7 @@ prefixonumber - PCI onboard index + PCI on-board index @@ -411,10 +412,10 @@ numbers, which could either result in an incorrect value of the ID_NET_NAME_SLOT property or none at all. - Some firmware and hypervisor implementations report unreasonably high numbers for the onboard - index. To prevent the generation of bogus onbard interface names, index numbers greater than 16381 - (2¹⁴-1) were ignored. For s390 PCI devices index values up to 65535 (2¹⁶-1) are valid. To account - for that, the limit was increased to 65535. + Some firmware and hypervisor implementations report unreasonably high numbers for the + on-board index. To prevent the generation of bogus onbard interface names, index numbers greater + than 16381 (2¹⁴-1) were ignored. For s390 PCI devices index values up to 65535 (2¹⁶-1) are valid. + To account for that, the limit was increased to 65535. The udev rule NAME= replaces :, /, and % with an underscore (_), and diff --git a/man/systemd.path.xml b/man/systemd.path.xml index 834f480b5ce..7ea88d0b981 100644 --- a/man/systemd.path.xml +++ b/man/systemd.path.xml @@ -209,7 +209,7 @@ See Also Environment variables with details on the trigger will be set for triggered units. See the - Environment Variables Set on Triggered Units section in + section Environment Variables Set or Propagated by the Service Manager in systemd.exec5 for more details. diff --git a/man/systemd.service.xml b/man/systemd.service.xml index 7de1350a593..ba4f4275821 100644 --- a/man/systemd.service.xml +++ b/man/systemd.service.xml @@ -229,7 +229,7 @@ . However, it extends the logic in one way: the SIGHUP UNIX process signal is sent to the service's main process when the service is asked to reload. (The signal to send can be tweaked via - ReloadSignal=, see below.). When + ReloadSignal=, see below.) When initiating the reload process the service is then expected to reply with a notification message via sd_notify3 that contains the RELOADING=1 field in combination with @@ -1167,9 +1167,10 @@ systemd.exec5 for details. - This setting also applies to systemd-oomd. Similarly to the kernel OOM - kills, this setting determines the state of the unit after systemd-oomd kills a - cgroup associated with it. + This setting also applies to + systemd-oomd.service8. + Similarly to the kernel OOM kills performed by the kernel, this setting determines the state of the + unit after systemd-oomd kills a cgroup associated with it. diff --git a/man/systemd.system-credentials.xml b/man/systemd.system-credentials.xml index b473a580a67..5be4ddfe59d 100644 --- a/man/systemd.system-credentials.xml +++ b/man/systemd.system-credentials.xml @@ -201,16 +201,16 @@ vmm.notify_socket - This credential is parsed looking for an AF_VSOCK or - AF_UNIX address where to send a READY=1 - notification datagram when the system has finished booting. See: - sd_notify3 - This is useful for hypervisors/VMMs or other processes on the host - to receive a notification via VSOCK when a virtual machine has finished booting. - Note that in case the hypervisor does not support SOCK_DGRAM - over AF_VSOCK, SOCK_SEQPACKET will be - tried instead. The credential payload for AF_VSOCK should be - in the form: vsock:CID:PORT. + Contains a AF_VSOCK or AF_UNIX address where to + send a READY=1 notification datagram when the system has finished booting. See + sd_notify3 for + more information. Note that in case the hypervisor does not support SOCK_DGRAM + over AF_VSOCK, SOCK_SEQPACKET will be tried instead. The + credential payload for AF_VSOCK should be in the form + vsock:CID:PORT. + + This feature is useful for hypervisors/VMMs or other processes on the host to receive a + notification via VSOCK when a virtual machine has finished booting. diff --git a/man/systemd.timer.xml b/man/systemd.timer.xml index a8c8241c94e..80dbd641015 100644 --- a/man/systemd.timer.xml +++ b/man/systemd.timer.xml @@ -367,7 +367,7 @@ See Also Environment variables with details on the trigger will be set for triggered units. See the - Environment Variables Set on Triggered Units section in + Environment Variables Set or Propagated by the Service Manager section in systemd.exec5 for more details. diff --git a/man/sysupdate.d.xml b/man/sysupdate.d.xml index bdf4bcbf7a5..c4cdd7971b8 100644 --- a/man/sysupdate.d.xml +++ b/man/sysupdate.d.xml @@ -497,7 +497,7 @@ subvolume. For details about the resource types, see above. This option is mandatory. - Note that only some combinations of source and target resource types are supported, see + Note that only certain combinations of source and target resource types are supported, see above. diff --git a/man/ukify.xml b/man/ukify.xml index f5a2fcc3e85..2e22b1f42e4 100644 --- a/man/ukify.xml +++ b/man/ukify.xml @@ -121,8 +121,9 @@ - Enable or disable a call to systemd-measure to print - pre-calculated PCR values. Defaults to false. + Enable or disable a call to + systemd-measure1 + to print pre-calculated PCR values. Defaults to false. @@ -303,7 +304,7 @@ SigningEngine=ENGINE - An "engine" to for signing of the resulting binary. This option is currently passed + An "engine" for signing of the resulting binary. This option is currently passed verbatim to the option of sbsign1.