From b082968d199976a868fd686340691af112d44c51 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Wed, 28 May 2025 15:20:50 +0200 Subject: [PATCH] man: better tags, more links, minor grammar and formatting improvements Closes https://github.com/systemd/systemd/issues/35751. --- man/busctl.xml | 2 +- man/coredump.conf.xml | 3 +- man/networkctl.xml | 14 ++++---- man/os-release.xml | 2 +- man/repart.d.xml | 39 ++++++++++++----------- man/systemctl.xml | 12 ++++--- man/systemd-boot.xml | 7 ++-- man/systemd-cryptsetup.xml | 2 +- man/systemd-fsck@.service.xml | 7 ++-- man/systemd-gpt-auto-generator.xml | 7 +--- man/systemd-import-generator.xml | 10 +++--- man/systemd-network-generator.service.xml | 10 +++--- man/systemd-pcrphase.service.xml | 7 ++-- man/systemd-poweroff.service.xml | 6 ++-- man/systemd-repart.xml | 2 +- man/systemd-sbsign.xml | 8 ++--- man/systemd-soft-reboot.service.xml | 4 +-- man/systemd-stub.xml | 38 +++++++++++----------- man/systemd-timesyncd.service.xml | 30 ++++++++--------- man/systemd.exec.xml | 2 +- man/systemd.link.xml | 3 +- man/systemd.net-naming-scheme.xml | 12 ++++--- man/systemd.netdev.xml | 2 +- man/systemd.network.xml | 15 +++++---- man/sysupdate.d.xml | 10 ++++-- man/sysupdate.features.xml | 8 +++-- man/tmpfiles.d.xml | 12 ++++--- 27 files changed, 150 insertions(+), 124 deletions(-) diff --git a/man/busctl.xml b/man/busctl.xml index 9e5e19063c3..47a20e8c4c8 100644 --- a/man/busctl.xml +++ b/man/busctl.xml @@ -149,7 +149,7 @@ Wait for a signal. Takes an object path, interface name, and signal name. To suppress output of the returned data, use the option. The service name may be - omitted, in which case busctl will match signals from any sender. + omitted, in which case busctl will match signals from any sender. diff --git a/man/coredump.conf.xml b/man/coredump.conf.xml index c20879eda03..0398ef78db5 100644 --- a/man/coredump.conf.xml +++ b/man/coredump.conf.xml @@ -113,7 +113,8 @@ EnterNamespace= For processes belonging to a PID namespace, controls whether - systemd-coredump shall attempt to process core dumps on the host, using debug + systemd-coredump8 + shall attempt to process core dumps on the host, using debug information from the file system hierarchy (i.e. the mount namespace) of the process that crashed. Access to the process' file system hierarchy might be necessary to generate a fully symbolized backtrace. If set to yes, systemd-coredump will diff --git a/man/networkctl.xml b/man/networkctl.xml index c8ebaa227dd..561eb932386 100644 --- a/man/networkctl.xml +++ b/man/networkctl.xml @@ -422,7 +422,8 @@ s - Service VLAN, m - Two-port MAC Relay (TPMR) was created, so changing [VLAN] Id= will not take effect if the matching VLAN interface already exists. To apply such settings, the interfaces need to be removed manually before reload. Also note that even if a .netdev file is removed, - systemd-networkd does not remove the existing netdev corresponding to the file. + systemd-networkd8 + does not remove the existing netdev corresponding to the file. If a new, modified, or removed .network file is found, then all @@ -449,9 +450,9 @@ s - Service VLAN, m - Two-port MAC Relay (TPMR) If is specified, edit the drop-in file instead of the main configuration file. Unless is specified, - systemd-networkd will be reloaded after the edit of the - .network or .netdev files finishes. - The same applies for .link files and + systemd-networkd8 + will be reloaded after the edit of the .network or .netdev + files finishes. The same applies for .link files and systemd-udevd8. Note that the changed link settings are not automatically applied after reloading. To achieve that, trigger uevents for the corresponding interface. Refer to @@ -520,8 +521,9 @@ s - Service VLAN, m - Two-port MAC Relay (TPMR) BOOL - Notify systemd-networkd.service that the persistent storage for the - service is ready. This is called by + Notify + systemd-networkd.service8 + that the persistent storage for the service is ready. This is called by systemd-networkd-persistent-storage.service. Usually, this command should not be called manually by users or administrators. diff --git a/man/os-release.xml b/man/os-release.xml index 54978edd43c..17165071ece 100644 --- a/man/os-release.xml +++ b/man/os-release.xml @@ -343,7 +343,7 @@ lts is for long term support releases of the system, suitable for production use and supported for an extended period of time. Generally, LTS releases continue to receive support even if newer major releases of the distribution are available. - Examples include Ubuntu 24.04, Debian 12 Bookworm and RHEL 9.4. + Examples include Ubuntu 24.04, Debian 12 Bookworm, and RHEL 9.4. development is for unstable versions of the system, unsuitable for production use, such as alpha, beta, or rolling unstable releases. Examples diff --git a/man/repart.d.xml b/man/repart.d.xml index 71c520d643f..a53057ffa1a 100644 --- a/man/repart.d.xml +++ b/man/repart.d.xml @@ -516,7 +516,7 @@ /, both the directory and its contents are excluded. ExcludeFilesTarget= is like ExcludeFiles= except that - instead of excluding the path on the host from being copied into the partition, it exclude any files + instead of excluding the path on the host from being copied into the partition, it excludes any files and directories from being copied into the given path in the partition. When @@ -612,10 +612,10 @@ MakeDirectories= and CopyFiles=. Note that this option only takes effect if the target filesystem supports subvolumes, such as - btrfs. + btrfs8. Note that this option is only supported in combination with - since btrfs-progs 6.11 or newer. + since btrfs-progs 6.11 or newer. @@ -632,7 +632,7 @@ Note that this option is only supported in combination with - since btrfs-progs 6.11 or newer. + since btrfs-progs 6.11 or newer. @@ -868,7 +868,9 @@ Note that this setting is only taken into account when the filesystem configured with Format= supports compression ( btrfs8, - squashfs, erofs). Here's an incomplete list of compression algorithms supported by the filesystems + squashfs, + erofs5). + Here's an incomplete list of compression algorithms supported by the filesystems known to systemd-repart: @@ -954,29 +956,30 @@ target for some other supplement definition. A target cannot have more than one supplement partition associated with it. - For example, distributions can use this to implement $BOOT as defined in - the Boot Loader + For example, distributions can use this to implement $BOOT as defined in the + Boot Loader Specification. Distributions may prefer to use the ESP as $BOOT whenever possible, but to adhere to the spec XBOOTLDR must sometimes be used instead. So, they should create two definitions: the first defining an ESP big enough to hold just the bootloader, and a second for the XBOOTLDR that's sufficiently large to hold kernels and configured as a supplement for the ESP. - Whenever possible, systemd-repart will try to merge the two definitions to create - one large ESP, but if that's not allowable due to the existing conditions on disk a small ESP and a - large XBOOTLDR will be created instead. + Whenever possible, + systemd-repart8 + will try to merge the two definitions to create one large ESP, but if that's not allowable due to the + existing conditions on disk a small ESP and a large XBOOTLDR will be created instead.As another example, distributions can also use this to seamlessly share a single /home partition in a multi-boot scenario, while preferring to keep /home on the root partition by default. Having a /home partition separated from the root partition entails some extra complexity: someone has to decide how to split the space between the two partitions. On the other hand, it allows a user to share their - home area between multiple installed OSs (i.e. via systemd-homed.service - 8). Distributions should create two definitions: - the first for a root partition that takes up some relatively small percentage of the disk, and the - second as a supplement for the first to create a /home partition that takes up - all the remaining free space. On first boot, if systemd-repart finds an existing - /home partition on disk, it'll un-merge the definitions and create just a small - root partition. Otherwise, the definitions will be merged and a single large root partition will be - created. + home area between multiple installed OSs (i.e. via + systemd-homed.service8). + Distributions should create two definitions: the first for a root partition that takes up some + relatively small percentage of the disk, and the second as a supplement for the first to create a + /home partition that takes up all the remaining free space. On first boot, if + systemd-repart finds an existing /home partition on disk, + it'll un-merge the definitions and create just a small root partition. Otherwise, the definitions + will be merged and a single large root partition will be created. diff --git a/man/systemctl.xml b/man/systemctl.xml index 7bbcf34bc47..037410cd219 100644 --- a/man/systemctl.xml +++ b/man/systemctl.xml @@ -2298,11 +2298,13 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err When system shutdown or sleep state is requested, this option controls checking of inhibitor - locks. It takes one of auto, yes or - no. Defaults to auto, which means logind will perform the - check and respect active inhibitor locks, but systemctl will only do a client-side check for - interactive invocations (i.e. from a TTY), so that a more friendly and informative error can be - returned to users. no disables both the systemctl and logind checks. + locks. It takes one of auto, yes, and no. + Defaults to auto, which means logind will perform the check and respect active + inhibitor locks, but systemctl will only do a client-side check for interactive + invocations (i.e. from a TTY), so that a more friendly and informative error can be returned to + users. no disables the checks both in systemctl and + systemd-logind8. + Applications can establish inhibitor locks to prevent certain important operations (such as CD burning) from being interrupted by system shutdown or sleep. Any user may take these locks and diff --git a/man/systemd-boot.xml b/man/systemd-boot.xml index d0912739d18..b6898ea8f01 100644 --- a/man/systemd-boot.xml +++ b/man/systemd-boot.xml @@ -430,9 +430,10 @@ LoaderDevicePartUUID Contains the partition UUID of the partition the boot loader has been started from on - the current boot (usually a EFI System Partition). Set by the boot loader. (Note that - systemd-stub will set this too, if not set yet, to support systems that directly - boot into a unified kernel image, bypassing any boot loader.) + the current boot (usually an EFI System Partition). Set by the boot loader. (Note that + systemd-stub7 will + set this too, if not set yet, to support systems that boot directly into a unified kernel image, + bypassing any boot loader.) systemd-gpt-auto-generator8 uses this information to automatically find the disk booted from, in order to discover various other partitions on the same disk automatically. diff --git a/man/systemd-cryptsetup.xml b/man/systemd-cryptsetup.xml index 6c13bd94187..8e90ed866d8 100644 --- a/man/systemd-cryptsetup.xml +++ b/man/systemd-cryptsetup.xml @@ -49,7 +49,7 @@ Description - systemd-cryptsetup is used to set up (with attach) and tear + systemd-cryptsetup is used to set up (with attach) and tear down (with detach) access to an encrypted block device. It is primarily used via systemd-cryptsetup@.service during early boot, but may also be called manually. The positional arguments VOLUME, SOURCE-DEVICE, diff --git a/man/systemd-fsck@.service.xml b/man/systemd-fsck@.service.xml index f68c79bff5b..b0e2ebafbd2 100644 --- a/man/systemd-fsck@.service.xml +++ b/man/systemd-fsck@.service.xml @@ -64,10 +64,11 @@ returns the "Filesystem errors left uncorrected" condition. systemd-fsck@.service will fail if - fsck returns with either "System should reboot" - or "Filesystem errors left uncorrected" conditions. For filesystems + fsck8 + returns either the "System should reboot" + or the "Filesystem errors left uncorrected" condition. For filesystems listed in /etc/fstab without nofail - or noauto options, local-fs.target + or noauto options, local-fs.target will then activate emergency.target. diff --git a/man/systemd-gpt-auto-generator.xml b/man/systemd-gpt-auto-generator.xml index 2fd9694038f..00a6b11234d 100644 --- a/man/systemd-gpt-auto-generator.xml +++ b/man/systemd-gpt-auto-generator.xml @@ -159,12 +159,7 @@ 4d21b016-b534-45c2-a9fb-5c16e091fd2d Variable Data Partition /var/ - The first partition with this type UUID on the same disk as the root partition is mounted - to /var/ — under the condition its partition UUID matches the first 128 bit - of the HMAC-SHA256 of the GPT type uuid of this partition keyed by the machine ID of the - installation stored in - machine-id5. - This can be generated using systemd-id1281. + The first partition with this type UUID on the same disk as the root partition is mounted to /var/ — under the condition its partition UUID matches the first 128 bit of the HMAC-SHA256 of the GPT type uuid of this partition keyed by the machine ID of the installation stored in machine-id5. This can be generated using systemd-id1281. SD_GPT_TMP diff --git a/man/systemd-import-generator.xml b/man/systemd-import-generator.xml index ed04f0830c1..91ba81233cc 100644 --- a/man/systemd-import-generator.xml +++ b/man/systemd-import-generator.xml @@ -81,10 +81,11 @@ verify= Controls whether to cryptographically validate the download before installing it - in place. Takes one of no, checksum or - signature (the latter being the default if not specified). For details see the + in place. Takes one of no, checksum, or + signature (the default if not specified). For details see the of - importctl1 + importctl1. + @@ -111,7 +112,8 @@ raw Controls the type of resource to download, i.e. a (possibly compressed) tarball - that needs to be unpacked into a file system tree, or (possibly compressed) raw disk image (DDI). + that needs to be unpacked into a file system tree, or (possibly compressed) raw disk image (DDI). + Specification of exactly one of these options is mandatory. diff --git a/man/systemd-network-generator.service.xml b/man/systemd-network-generator.service.xml index f18508e5f0c..ccdb57b62b2 100644 --- a/man/systemd-network-generator.service.xml +++ b/man/systemd-network-generator.service.xml @@ -143,15 +143,17 @@ 50-foobar.link. Note that the resulting files are created world-readable, it is hence recommended to not include - secrets in these credentials, but supply them via separate credentials directly to - systemd-networkd.service. + secrets in these credentials, but to supply them via separate credentials directly to + systemd-networkd.service8. + - Note that by default the systemd-network-generator.service unit file is set up - to inherit the these credentials from the service manager. + Note that by default the + systemd-networkd.service8 + service is set up to inherit the these credentials from the service manager. diff --git a/man/systemd-pcrphase.service.xml b/man/systemd-pcrphase.service.xml index 675683d8769..e301435f8ea 100644 --- a/man/systemd-pcrphase.service.xml +++ b/man/systemd-pcrphase.service.xml @@ -73,7 +73,8 @@ 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 the - systemd-pcrphase-initrd.service service is stopped.) + systemd-pcrphase-sysinit.service8 + 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 @@ -85,7 +86,9 @@ 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 the systemd-pcrphase.service service is started.) + (This extension happens when the + systemd-pcrphase-sysinit.service8 + service is started.) shutdown — when the system shutdown begins. It acts as barrier diff --git a/man/systemd-poweroff.service.xml b/man/systemd-poweroff.service.xml index ad378670e4d..f2872cf25a6 100644 --- a/man/systemd-poweroff.service.xml +++ b/man/systemd-poweroff.service.xml @@ -54,9 +54,9 @@ thus keeping the file system busy, which then cannot be re-mounted read-only. Shortly before executing the actual system power-off/halt/reboot/kexec, - systemd-shutdown will run all executables in - /usr/lib/systemd/system-shutdown/ and pass one arguments to them: either - poweroff, halt, reboot, or + systemd-shutdown will run all executables in + /usr/lib/systemd/system-shutdown/. Those executables are called with one argument: + either poweroff, halt, reboot, or kexec, depending on the chosen action. All executables in this directory are executed in parallel, and execution of the action is not continued before all executables finished. (A safety timeout of 90s is applied however.) Note that these executables are run after all diff --git a/man/systemd-repart.xml b/man/systemd-repart.xml index 2f20a6fe43a..7a739752eb4 100644 --- a/man/systemd-repart.xml +++ b/man/systemd-repart.xml @@ -19,7 +19,7 @@ systemd-repart systemd-repart.service - Automatically grow and add partitions, and generate disk images (DDIs). + Automatically grow and add partitions, and generate disk images (DDIs) diff --git a/man/systemd-sbsign.xml b/man/systemd-sbsign.xml index 72b286256a3..20cdf7f2160 100644 --- a/man/systemd-sbsign.xml +++ b/man/systemd-sbsign.xml @@ -73,12 +73,12 @@ Set the Secure Boot private key and certificate for use with the - sign. The option takes a path to a PEM encoded - X.509 certificate or a URI that's passed to the OpenSSL provider configured with - . The takes one of + sign verb. The option takes a path to a + PEM-encoded X.509 certificate or a URI that's passed to the OpenSSL provider configured with + . The option takes one of file or provider, with the latter being followed by a specific provider identifier, separated with a colon, e.g. provider:pkcs11. The - option can take a path or a URI that will be passed to the OpenSSL + option takes a path or a URI that will be passed to the OpenSSL engine or provider, as specified by as a type:name tuple, such as engine:pkcs11. The specified OpenSSL signing engine or provider will be used to sign the PE binary. diff --git a/man/systemd-soft-reboot.service.xml b/man/systemd-soft-reboot.service.xml index a72aecb05f1..1205d4d0534 100644 --- a/man/systemd-soft-reboot.service.xml +++ b/man/systemd-soft-reboot.service.xml @@ -170,8 +170,8 @@ DefaultDependencies=no either. Note that systemd-soft-reboot.service (and related units) should never be - executed directly. Instead, trigger system shutdown with a command such as systemctl - soft-reboot. + executed directly. Instead, trigger system shutdown with a command such as systemctl + soft-reboot. Note that if a new root file system has been set up on /run/nextroot/, a soft-reboot will be performed when the reboot command is diff --git a/man/systemd-stub.xml b/man/systemd-stub.xml index 273513c14bd..76ca69837d8 100644 --- a/man/systemd-stub.xml +++ b/man/systemd-stub.xml @@ -140,11 +140,12 @@ command line PE section in the kernel image file. If a command line is accepted via EFI invocation parameters to the EFI binary it is measured into TPM PCR 12 (if a TPM is present). If a DeviceTree is embedded in the .dtb section, it replaces an existing DeviceTree in the - corresponding EFI configuration table. systemd-stub will ask the firmware via the - EFI_DT_FIXUP_PROTOCOL for hardware specific fixups to the DeviceTree. The - contents of 11 of these 12 sections are measured into TPM PCR 11. It is otherwise not used and thus the - result can be pre-calculated without too much effort. The .pcrsig section is not - included in this PCR measurement, since it is supposed to contain signatures for the output of the + corresponding EFI configuration table. systemd-stub will ask the firmware via the + EFI_DT_FIXUP_PROTOCOL for hardware specific fixups to the DeviceTree. + + The contents of 11 of these 12 sections are measured into TPM PCR 11. It is otherwise not used and + thus the result can be pre-calculated without too much effort. The .pcrsig section is + not included in this PCR measurement, since it is supposed to contain signatures for the output of the measurement operation, and thus cannot also be input to it. If an UKI contains multiple profiles, only the PE sections of the selected profile (and those of the base profile, except if overridden) are measured. @@ -287,19 +288,20 @@ rd.systemd.unit=storagetm.target. A single UKI may support multiple profiles by means of the special .profile PE - section. This section acts as separator between the PE sections of the individual - profiles. .profile PE sections hence may appear multiple times in a single UKI, and - the other PE sections listed above may appear multiple times too, if .profile are - used, but only once before the first .profile section, once between each subsequent - pair, and once after the last appearance of .profile. The sections listed before the - first .profile are considered the "base" profile of the UKI. Each - .profile section then introduces a new profile, which are numbered starting from - zero. The PE sections following each .profile are specific to that profile. When - booting into a specific profile the base section's profiles are used in combination with the specific - profile's sections: if the same section is defined in both, the per-profile section overrides the base - profile's version, otherwise the per-profile sections is used together with the base profile - sections. A UKI that contains no .profile is consider equivalent to one - that just contains a single .profile, as having only a single profile @0. + section. This section acts as separator between the PE sections of the individual profiles. + .profile PE sections hence may appear multiple times in a single UKI, and the other PE + sections listed above may appear multiple times too, if .profile are used, but only + once before the first .profile section, once between each subsequent pair, and once + after the last appearance of .profile. The sections listed before the first + .profile are considered the "base" profile of the UKI. Each + .profile section then introduces a new profile, which are numbered starting from zero. + The PE sections following each .profile are specific to that profile. When booting + into a specific profile, the base section's profiles are used in combination with the specific profile's + sections: if the same section is defined in both, the per-profile section overrides the base profile's + version, otherwise the base profile sections are used. + + A UKI that contains no .profile is consider equivalent to one that just contains + a single .profile, as having only a single profile @0. Here's a simple example for a multi-profile UKI's sections, inspired by the setup suggested above: diff --git a/man/systemd-timesyncd.service.xml b/man/systemd-timesyncd.service.xml index 1f504deac14..f13a991a9c5 100644 --- a/man/systemd-timesyncd.service.xml +++ b/man/systemd-timesyncd.service.xml @@ -30,16 +30,16 @@ Description - systemd-timesyncd is a system service that may be used to synchronize the - local system clock with a remote Network Time Protocol (NTP) server. It also saves the local time to disk - every time the clock has been synchronized and uses this to possibly advance the system realtime clock on - subsequent reboots to ensure it (roughly) monotonically advances even if the system lacks a + systemd-timesyncd.service is a system service that may be used to synchronize + the local system clock with a remote Network Time Protocol (NTP) server. It also saves the local time to + disk every time the clock has been synchronized and uses this to possibly advance the system realtime + clock on subsequent reboots to ensure it (roughly) monotonically advances even if the system lacks a battery-buffered RTC chip. - The systemd-timesyncd service implements SNTP only. This minimalistic service - will step the system clock for large offsets or slowly adjust it for smaller deltas. Complex use cases - that require full NTP support (and where SNTP is not sufficient) are not covered by - systemd-timesyncd. + The systemd-timesyncd.service service implements SNTP only. This minimalistic + service will step the system clock for large offsets or slowly adjust it for smaller deltas. Complex use + cases that require full NTP support (and where SNTP is not sufficient) are not covered by + systemd-timesyncd.service. The NTP servers contacted are determined from the global settings in timesyncd.conf5, the @@ -56,8 +56,8 @@ timesync-status or show-timesync command can be used to show the current status of this service. - systemd-timesyncd initialization delays the start of units that are ordered - after time-set.target (see + Initialization of systemd-timesyncd.service delays the start of units that are + ordered after time-set.target (see systemd.special7 for details) until the local time has been updated from /var/lib/systemd/timesync/clock (see below) in order to make it roughly monotonic. It does not delay other units until synchronization @@ -67,13 +67,13 @@ time-sync.target until synchronization to an accurate reference clock is reached. - systemd and systemd-timesyncd advance the system clock to + systemd and systemd-timesyncd advance the system clock to the "epoch" (the lowest date above which the system clock time is assumed to be set correctly). See "System clock epoch" section in systemd1 for details. - systemd will set the clock when initializing, but + systemd will set the clock when initializing, but /var/lib/systemd/timesync/clock might not yet be available at that point. - systemd-timesyncd will advance the clock when it is started and notices that the + systemd-timesyncd will advance the clock when it is started and notices that the system clock is before the modification time of /var/lib/systemd/timesync/clock. @@ -104,8 +104,8 @@ A file that is touched on each successful synchronization to assist - systemd-time-wait-sync and other applications in detecting synchronization to - an accurate reference clock. + systemd-time-wait-sync.service8 + service and other applications in detecting synchronization to an accurate reference clock. diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml index 9fca7142f2d..7deda0f2979 100644 --- a/man/systemd.exec.xml +++ b/man/systemd.exec.xml @@ -3793,7 +3793,7 @@ StandardInputData=V2XigLJyZSBubyBzdHJhbmdlcnMgdG8gbG92ZQpZb3Uga25vdyB0aGUgcnVsZX my.renamed.xxx to the service. If ImportCredential= is specified multiple times and multiple credentials - end up with the same name after renaming, the first one is kept and later ones are dropped.. + end up with the same name after renaming, the first one is kept and later ones are dropped. When multiple credentials of the same name are found, credentials found by LoadCredential= and LoadCredentialEncrypted= take priority over diff --git a/man/systemd.link.xml b/man/systemd.link.xml index 7643430549b..aeceb5d925d 100644 --- a/man/systemd.link.xml +++ b/man/systemd.link.xml @@ -396,7 +396,8 @@ This setting is useful to configure the ID_NET_MANAGED_BY= property which declares which network management service shall manage the interface, which is respected by - systemd-networkd and others. Use + systemd-networkd8 + and others. Use Property=ID_NET_MANAGED_BY=io.systemd.Network to declare explicitly that systemd-networkd shall manage the interface, or set the property to something else to declare explicitly it shall not do so. See diff --git a/man/systemd.net-naming-scheme.xml b/man/systemd.net-naming-scheme.xml index 24f2592b841..d21b858a5d4 100644 --- a/man/systemd.net-naming-scheme.xml +++ b/man/systemd.net-naming-scheme.xml @@ -94,7 +94,8 @@
- The udev net_id builtin exports the following udev device properties: + The udev7 + net_id builtin exports the following device properties: @@ -560,10 +561,11 @@ Limiting the use of specific sysfs attributes - When creating names for network cards, some naming schemes use data from sysfs populated - by the kernel. This means that although a specific naming scheme in udev is picked, - the network card's name can still change when a new kernel version adds a new sysfs attribute. - For example if kernel starts setting the phys_port_name, udev will append the + When creating names for network cards, some naming schemes use data from sysfs populated by the + kernel. This means that although a specific naming scheme in + udev7 is picked, the + network card's name can still change when a new kernel version adds a new sysfs attribute. For example, + if kernel starts setting the phys_port_name, udev will append the "nphys_port_name" suffix to the device name. diff --git a/man/systemd.netdev.xml b/man/systemd.netdev.xml index 3bfaf7c2157..97436f016a5 100644 --- a/man/systemd.netdev.xml +++ b/man/systemd.netdev.xml @@ -1112,7 +1112,7 @@ Ports=eth2 MinSourcePort= - Specifies the lowest value of the UDP tunnel source UDP port (in range 1…65535). + Specifies the lowest value of the UDP tunnel source port (in range 1…65535). Defaults to unset. diff --git a/man/systemd.network.xml b/man/systemd.network.xml index 196cc0c07e1..53221cbd5ea 100644 --- a/man/systemd.network.xml +++ b/man/systemd.network.xml @@ -89,10 +89,11 @@ Note that any network interfaces that have the ID_NET_MANAGED_BY= udev property set will never be matched by any .network files – unless the property's value is the string io.systemd.Network – even if the [Match] section would otherwise match. This may be - used to exclude specific network interfaces from systemd-networkd's management, while - keeping the [Match] section generic. The ID_NET_MANAGED_BY= property thus declares - intended ownership of the device, and permits ensuring that concurrent network - management implementations do not compete for management of specific devices. + used to exclude specific network interfaces from + systemd-networkd8's + management, while keeping the [Match] section generic. The ID_NET_MANAGED_BY= property + thus declares intended ownership of the device, and permits ensuring that concurrent + network management implementations do not compete for management of specific devices. A network file is said to match a network interface if all matches specified by the [Match] section are satisfied. When a network file does not contain valid settings in [Match] section, then @@ -1802,8 +1803,8 @@ NFTSet=prefix:netdev:filter:eth_ipv4_prefix GoTo= - Specifies the target priority used by goto type of rule. Takes an integer - in the range 1…4294967295. This must be larger than the priority of this rule specified in + Specifies the target priority used by the goto type of rule. Takes an + integer in the range 1…4294967295. This must be larger than the priority of the rule specified in Priority=. When specified, Type=goto is implied. This is mandatory when Type=goto. @@ -2973,7 +2974,7 @@ NFTSet=prefix:netdev:filter:eth_ipv4_prefix prefix length after /. DHCP offers from servers in the list are accepted. Note that this filters only DHCP offers, so the filtering might not work when - RapidCommit= is enabled. See also RapidCommit= in the above. + RapidCommit= is enabled. See also RapidCommit= above. diff --git a/man/sysupdate.d.xml b/man/sysupdate.d.xml index df3aaf7f387..9a32c8c734a 100644 --- a/man/sysupdate.d.xml +++ b/man/sysupdate.d.xml @@ -58,7 +58,8 @@ combined, synchronized operation, so that only a combined update of all three together constitutes a complete update. We'll call such a collection of transfers a target. - systemd-sysupdate always operates on a single target. + systemd-sysupdate8 + always operates on a single target. Transfers may be grouped together into sets that can be individually enabled or disabled by the system administrator, called "Optional Features": @@ -522,7 +523,9 @@ XML file. This may be used by software centers (such as GNOME Software or KDE Discover) to present rich metadata about the resources being updated. This includes display names, changelogs, icons, and more. The specified catalog must include special metadata - to be correctly associated with systemd-sysupdate by the software centers. + to be correctly associated with + systemd-sysupdate8 + by the software centers. This setting supports specifier expansion. See below for details on supported specifiers. @@ -688,7 +691,8 @@ If set to explicit, the specified Path= will be resolved relative to the directory specified with when invoking - systemd-sysupdate. + systemd-sysupdate8. + The values esp, xbootldr, and boot are only supported when Type= is set to diff --git a/man/sysupdate.features.xml b/man/sysupdate.features.xml index e3a02d6f9d2..9a1cfcc6ee1 100644 --- a/man/sysupdate.features.xml +++ b/man/sysupdate.features.xml @@ -43,7 +43,9 @@ downloading updates, when vacuuming, and in all other situations. In effect, transfers belonging to a feature will always be updated in lock-step with the rest of their target. - This is the primary difference an Optional Feature and a systemd-sysupdate component. + This is the primary difference an Optional Feature and a + systemd-sysupdate8 + component. When a feature is disabled, its transfers will not be considered when checking for and downloading updates, but systemd-sysupdate will still consider them while vacuuming and in other situations where it needs to determine ownership over previously downloaded system resources. @@ -54,8 +56,8 @@ defined below. Transfers can declare that they belong to a feature via the Features= setting. Feature definitions support drop-in files, which are most commonly used to override the - Enabled= setting). - They can also be masked out to hide the availability of the feature entirely. + Enabled= setting. + They can also be masked to hide the availability of the feature entirely. Each *.feature file contains one section: [Feature]. diff --git a/man/tmpfiles.d.xml b/man/tmpfiles.d.xml index 18edc8f241c..39fcad850d7 100644 --- a/man/tmpfiles.d.xml +++ b/man/tmpfiles.d.xml @@ -508,8 +508,9 @@ r! /tmp/.X[0-9]*-lock . If the minus sign (-) is used, this line failing to run successfully during - create (and only create) will not cause the execution of systemd-tmpfiles to return - an error. + create (and only create) will not cause the execution of + systemd-tmpfiles8 + to return an error. For example: # Modify sysfs but do not fail if we are in a container with a read-only /proc @@ -877,9 +878,10 @@ e! /var/cache/krb5rcache - - - 0 By passing this line to QEMU, the public key of the current user will be encoded in base64, added - to a tmpfiles.d line that tells systemd-tmpfiles to decode it into - /root/.ssh/authorized_keys, encode that line itself in base64 and pass it as a - Credential that will be picked up by systemd from SMBIOS on boot. + to a tmpfiles.d line that tells + systemd-tmpfiles8 to + decode it into /root/.ssh/authorized_keys, encode that line itself in base64 and + pass it as a Credential that will be picked up by systemd from SMBIOS on boot. -- 2.47.3