From: cunshunxia Date: Thu, 29 Feb 2024 02:46:25 +0000 (+0800) Subject: man: fix a few issues in manpage X-Git-Tag: v256-rc1~467 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=cc59d1014f4851ad188640d0b6b370083ec7213f;p=thirdparty%2Fsystemd.git man: fix a few issues in manpage fix: #31482 Signed-off-by: cunshunxia --- diff --git a/man/daemon.xml b/man/daemon.xml index dc51041138b..42630d27825 100644 --- a/man/daemon.xml +++ b/man/daemon.xml @@ -228,7 +228,7 @@ If the service opens sockets or other files on it own, and those file descriptors shall survive a restart, the daemon should store them in the service manager via sd_notify3 with - FDSTORE=1.. + FDSTORE=1. Instead of using the syslog() call to log directly to the system syslog service, a new-style daemon may choose to simply log to standard error via diff --git a/man/journalctl.xml b/man/journalctl.xml index ea517f4ac4e..7d6820064ec 100644 --- a/man/journalctl.xml +++ b/man/journalctl.xml @@ -826,7 +826,7 @@ Commands - The following commands are understood. If none is specified the default is to display journal records. + The following commands are understood. If none is specified the default is to display journal records: diff --git a/man/portablectl.xml b/man/portablectl.xml index 5223131368f..9651112f978 100644 --- a/man/portablectl.xml +++ b/man/portablectl.xml @@ -399,7 +399,7 @@ multiple times, in which case the order in which images are laid down follows the rules specified in systemd.exec5 for the ExtensionImages= directive and for the - systemd-sysext8 and. + systemd-sysext8 and systemd-confext8 tools. The images must contain an extension-release file with metadata that matches what is defined in the os-release of IMAGE. See: diff --git a/man/systemd-bsod.service.xml b/man/systemd-bsod.service.xml index 12667844853..e58d64c52ba 100644 --- a/man/systemd-bsod.service.xml +++ b/man/systemd-bsod.service.xml @@ -19,7 +19,7 @@ systemd-bsod.service systemd-bsod - Displays boot-time emergency log message in full screen. + Displays boot-time emergency log message in full screen diff --git a/man/systemd-cryptsetup.xml b/man/systemd-cryptsetup.xml index 72dc56390ff..4c139c5b45b 100644 --- a/man/systemd-cryptsetup.xml +++ b/man/systemd-cryptsetup.xml @@ -52,7 +52,7 @@ 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 be called manually. - The positional arguments VOLUME, SOURCEDEVICE, + The positional arguments VOLUME, SOURCE-DEVICE, KEY-FILE, and CRYPTTAB-OPTIONS have the same meaning as the fields in crypttab5. diff --git a/man/systemd-nspawn.xml b/man/systemd-nspawn.xml index 8f7e6d103d2..4b9c252784f 100644 --- a/man/systemd-nspawn.xml +++ b/man/systemd-nspawn.xml @@ -1754,7 +1754,7 @@ After=sys-subsystem-net-devices-ens1.device In order to embed binary data into the credential data for , use C-style escaping (i.e. \n to embed a newline, or \x00 to embed a NUL byte). Note that the invoking shell might already apply unescaping - once, hence this might require double escaping!. + once, hence this might require double escaping! The systemd-sysusers.service8 diff --git a/man/systemd-pcrlock.xml b/man/systemd-pcrlock.xml index 58907f728c5..2c674a34b4c 100644 --- a/man/systemd-pcrlock.xml +++ b/man/systemd-pcrlock.xml @@ -403,7 +403,7 @@ Generates/removes a .pcrlock file based on raw binary data. The data is either read from the specified file or from STDIN (if none is specified). This requires that - is specified. The generated pcrlock file is written to the file specified + is specified. The generated .pcrlock file is written to the file specified via or to STDOUT (if none is specified). @@ -450,7 +450,7 @@ - Specifies to NV index to store the policy in. Honoured by + Specifies the NV index to store the policy in. Honoured by make-policy. If not specified the command will automatically pick a free NV index. diff --git a/man/systemd-poweroff.service.xml b/man/systemd-poweroff.service.xml index 786bb6bf132..ec7ffdeb0d3 100644 --- a/man/systemd-poweroff.service.xml +++ b/man/systemd-poweroff.service.xml @@ -60,7 +60,7 @@ 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. Note that these executables are run after all services have been shut down, and after most - mounts have been detached (the root file system as well as /run/ and various API + mounts have been unmounted (the root file system as well as /run/ and various API file systems are still around though). This means any programs dropped into this directory must be prepared to run in such a limited execution environment and not rely on external services or hierarchies such as /var/ to be around (or writable). diff --git a/man/systemd-repart.xml b/man/systemd-repart.xml index 7e2730a33a2..e719bd9687f 100644 --- a/man/systemd-repart.xml +++ b/man/systemd-repart.xml @@ -633,7 +633,7 @@ Generate a configuration extension image The following creates a configuration extension DDI (confext) for an - /etc/motd update. + /etc/motd update: mkdir tree tree/etc tree/etc/extension-release.d echo "Hello World" > tree/etc/motd diff --git a/man/systemd-soft-reboot.service.xml b/man/systemd-soft-reboot.service.xml index 354a24679a2..26717e42592 100644 --- a/man/systemd-soft-reboot.service.xml +++ b/man/systemd-soft-reboot.service.xml @@ -104,7 +104,7 @@ via SurviveFinalKillSignal=yes, and also be configured to avoid being stopped on isolate via IgnoreOnIsolate=yes. They also have to be configured to be stopped on normal shutdown, reboot and maintenance mode. Finally, they have to be ordered after - basic.target to ensure correct ordeering on boot. Note that in case any new or + basic.target to ensure correct ordering on boot. Note that in case any new or custom units are used to isolate to, or that implement an equivalent shutdown functionality, they will also have to be configured manually for correct ordering and conflicting. For example: diff --git a/man/systemd-storagetm.service.xml b/man/systemd-storagetm.service.xml index 84e91dd47a0..6fdbc3dc056 100644 --- a/man/systemd-storagetm.service.xml +++ b/man/systemd-storagetm.service.xml @@ -69,7 +69,7 @@ exposed NVMe-TCP mass storage devices. The NQN should follow the syntax described in NVM Express Base Specification 2.0c, section 4.5 "NVMe Qualified Names". Note that the NQN - specified here will be suffixed with a dot and the the block device name before it is exposed on the + specified here will be suffixed with a dot and the block device name before it is exposed on the NVMe target. If not specified defaults to nqn.2023-10.io.systemd:storagetm.ID, where ID is replaced by a 128bit ID derived from diff --git a/man/systemd-sysext.xml b/man/systemd-sysext.xml index 8e5a6a6aa1b..df1f10aeefb 100644 --- a/man/systemd-sysext.xml +++ b/man/systemd-sysext.xml @@ -141,7 +141,7 @@ but the used architecture identifiers are the same as for ConditionArchitecture= described in systemd.unit5. EXTENSION_RELOAD_MANAGER= can be set to 1 if the extension requires a service manager reload after application - of the extension. Note that the for the reasons mentioned earlier: + of the extension. Note that for the reasons mentioned earlier: Portable Services remain the recommended way to ship system services. diff --git a/man/systemd-tpm2-setup.service.xml b/man/systemd-tpm2-setup.service.xml index 245d3444b1a..3fa34909954 100644 --- a/man/systemd-tpm2-setup.service.xml +++ b/man/systemd-tpm2-setup.service.xml @@ -37,7 +37,7 @@ The services will store the public key of the SRK key pair in a PEM file in /run/systemd/tpm2-srk-public-key.pem and - /var/lib/systemd/tpm2-srk-public-key.pem. It will also store it in TPM2B_PUBLIC + /var/lib/systemd/tpm2-srk-public-key.pem. They will also store it in TPM2B_PUBLIC format in /run/systemd/tpm2-srk-public-key.tpm2_public and /var/lib/systemd/tpm2-srk-public-key.tpm2b_public. diff --git a/man/systemd-vmspawn.xml b/man/systemd-vmspawn.xml index ef4d3ca2b62..b75158811f8 100644 --- a/man/systemd-vmspawn.xml +++ b/man/systemd-vmspawn.xml @@ -18,7 +18,7 @@ systemd-vmspawn - Spawn an OS in a virtual machine. + Spawn an OS in a virtual machine @@ -440,7 +440,7 @@ In order to embed binary data into the credential data for , use C-style escaping (i.e. \n to embed a newline, or \x00 to embed a NUL byte). Note that the invoking shell might already apply unescaping - once, hence this might require double escaping!. + once, hence this might require double escaping! diff --git a/man/systemd.network.xml b/man/systemd.network.xml index 472add2f984..e143aebb1bd 100644 --- a/man/systemd.network.xml +++ b/man/systemd.network.xml @@ -857,7 +857,7 @@ Table=1234 ipv4, ipv6, both, or no. Defaults to no. Note. Any positive boolean values such as yes or - true are now deprecated. Please use one of the values in the above. + true are now deprecated. Please use one of the values above. @@ -3611,7 +3611,7 @@ Address=192.168.0.1/24 Address=192.168.0.2/24 [DHCPServer] ServerAddress=192.168.0.1/24 - are equivalent to the following. + are equivalent to the following: [Network] DHCPServer=yes Address=192.168.0.2/24 @@ -3973,7 +3973,7 @@ ServerAddress=192.168.0.1/24 Takes a timespan. Configures the retransmit time, used by clients to retransmit Neighbor Solicitation messages on address resolution and the Neighbor Unreachability Detection algorithm. - An integer the default unit of seconds, in the range 0…4294967295 msec. Defaults to 0. + An integer, the default unit is seconds, in the range 0…4294967295 msec. Defaults to 0. @@ -4062,8 +4062,8 @@ ServerAddress=192.168.0.1/24 HomeAgent= - Takes a boolean. Specifies that IPv6 router advertisements which indicates to hosts that - the router acts as a Home Agent and includes a Home Agent Option. Defaults to false. See + Takes a boolean. Specifies that IPv6 router advertisements which indicate to hosts that + the router acts as a Home Agent and includes a Home Agent option. Defaults to false. See RFC 6275 for further details. @@ -4073,7 +4073,7 @@ ServerAddress=192.168.0.1/24 HomeAgentLifetimeSec= - Takes a timespan. Specifies the lifetime of the Home Agent. An integer the default unit of seconds, + Takes a timespan. Specifies the lifetime of the Home Agent. An integer, the default unit is seconds, in the range 1…65535. Defaults to the value set to RouterLifetimeSec=. diff --git a/man/systemd.pcrlock.xml b/man/systemd.pcrlock.xml index 7655f2edfe1..27ceb48652f 100644 --- a/man/systemd.pcrlock.xml +++ b/man/systemd.pcrlock.xml @@ -95,7 +95,7 @@ 250-firmware-code-early.pcrlock Firmware code measurements, as recorded to PCR 0 and 2, up to the separator - measurement (see 400-secureboot-separator.pcrlock. below). May be generated via + measurement (see 400-secureboot-separator.pcrlock below). May be generated via systemd-pcrlock lock-firmware-code. @@ -105,7 +105,7 @@ 250-firmware-config-early.pcrlock Firmware configuration measurements, as recorded to PCR 1 and 3, up to the separator - measurement (see 400-secureboot-separator.pcrlock. below). May be generated via + measurement (see 400-secureboot-separator.pcrlock below). May be generated via systemd-pcrlock lock-firmware-config. @@ -141,7 +141,7 @@ 550-firmware-code-late.pcrlock Firmware code measurements, as recorded to PCR 0 and 2, after the separator - measurement (see 400-secureboot-separator.pcrlock. above). May be generated via + measurement (see 400-secureboot-separator.pcrlock above). May be generated via systemd-pcrlock lock-firmware-code. @@ -151,7 +151,7 @@ 550-firmware-config-late.pcrlock Firmware configuration measurements, as recorded to PCR 1 and 3, after the separator - measurement (see 400-secureboot-separator.pcrlock. above). May be generated via + measurement (see 400-secureboot-separator.pcrlock above). May be generated via systemd-pcrlock lock-firmware-config. @@ -179,7 +179,7 @@ 700-action-efi-exit-boot-services.pcrlock The EFI action generated when ExitBootServices() is generated, - i.e. the UEFI environment is left and the OS takes over. Covers the PCR 5 measurement. Statically + i.e. when the UEFI environment is left and the OS takes over. Covers the PCR 5 measurement. Statically defined. diff --git a/man/varlinkctl.xml b/man/varlinkctl.xml index 646fea0d247..22add03a9d5 100644 --- a/man/varlinkctl.xml +++ b/man/varlinkctl.xml @@ -50,7 +50,7 @@ call ADDRESS METHOD - PARAMETERS + ARGUMENTS @@ -105,7 +105,7 @@ info ADDRESS Show brief information about the specified service, including vendor name and list of - implemented interfaces. Expects a service address in the formats described above. + implemented interfaces. Expects a service address in one of the formats described above. @@ -114,7 +114,7 @@ list-interfaces ADDRESS Show list of interfaces implemented by the specified service. Expects a service - address in the formats described above. + address in one of the formats described above. @@ -123,7 +123,7 @@ introspect ADDRESS INTERFACE Show interface definition of the specified interface provided by the specified - service. Expects a service address in the formats described above and a Varlink interface + service. Expects a service address in one of the formats described above and a Varlink interface name. diff --git a/man/veritytab.xml b/man/veritytab.xml index 16f7491e0cb..6bd09604b67 100644 --- a/man/veritytab.xml +++ b/man/veritytab.xml @@ -125,7 +125,7 @@ This is based on crypttab(5). - Use the provided UUID for format command instead of generating new one. The UUID must be + Use the provided UUID instead of generating new one. The UUID must be provided in standard UUID format, e.g. 12345678-1234-1234-1234-123456789abc. @@ -186,8 +186,8 @@ This is based on crypttab(5). Use forward error correction (FEC) to recover from corruption if hash verification fails. Use - encoding data from the specified device. The fec device argument can be block device or file image. For format, - if fec device path doesn't exist, it will be created as file. Note: block sizes for data and hash devices must + encoding data from the specified device. The fec device argument can be block device or file image. + If fec device path doesn't exist, it will be created as file. Note: block sizes for data and hash devices must match. Also, if the verity data_device is encrypted the fec_device should be too.