diff --git a/man/busctl.xml b/man/busctl.xml index 8cb9a4bfa59..27327ee1928 100644 --- a/man/busctl.xml +++ b/man/busctl.xml @@ -315,7 +315,7 @@ - MODE + When used with the call or get-property command, shows output @@ -341,7 +341,7 @@ - BOOL + When used with the call command, @@ -361,7 +361,7 @@ - BOOL + When used with the call or emit command, specifies @@ -375,7 +375,7 @@ - BOOL + When used with the call command, @@ -389,7 +389,7 @@ - SECS + When used with the call command, @@ -407,7 +407,7 @@ - BOOL + Controls whether credential data reported by @@ -423,7 +423,7 @@ - BOOL + Controls whether to wait for the specified AF_UNIX bus socket to appear in the @@ -435,7 +435,7 @@ - SERVICE + Takes a service name. When used with the emit command, a signal is diff --git a/man/coredumpctl.xml b/man/coredumpctl.xml index 9e356a0da6b..6179d6b760d 100644 --- a/man/coredumpctl.xml +++ b/man/coredumpctl.xml @@ -226,7 +226,7 @@ FIELD - FIELD + Print all possible data values the specified field takes in matching core dump entries of the @@ -237,7 +237,7 @@ FILE - FILE + Write the core to . @@ -246,7 +246,7 @@ - DEBUGGER + Use the given debugger for the debug command. If not given and $SYSTEMD_DEBUGGER is unset, then @@ -258,7 +258,7 @@ ARGS - ARGS + Pass the given ARGS as extra command line arguments to the debugger. Quote as appropriate when ARGS contain whitespace. @@ -282,7 +282,7 @@ DIR - DIR + Use the journal files in the specified . diff --git a/man/homectl.xml b/man/homectl.xml index f1bade20534..effdb27f72a 100644 --- a/man/homectl.xml +++ b/man/homectl.xml @@ -117,7 +117,7 @@ - FILE + 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 @@ -130,7 +130,7 @@ - FORMAT + Controls whether to output the user record in JSON format, if the @@ -146,7 +146,7 @@ - FORMAT + @@ -201,7 +201,7 @@ - NAME + NAME The real name for the user. This corresponds with the GECOS field on classic UNIX NSS @@ -211,7 +211,7 @@ - REALM + The realm for the user. The realm associates a user with a specific organization or installation, and allows distinguishing users of the same name defined in different contexts. The @@ -227,7 +227,7 @@ - EMAIL + Takes an electronic mail address to associate with the user. On log-in the $EMAIL environment variable is initialized from this value. @@ -236,7 +236,7 @@ - TEXT + Takes location specification for this user. This is free-form text, which might or might not be usable by geo-location applications. Example: - ICON + Takes an icon name to associate with the user, following the scheme defined by the Icon Naming @@ -256,8 +256,8 @@ - PATH - PATH + + Takes a path to use as home directory for the user. Note that this is the directory the user's home directory is mounted to while the user is logged in. This is not where the user's @@ -268,7 +268,7 @@ - UID + Takes a preferred numeric UNIX UID to assign this user. If a user is to be created with the specified UID and it is already taken by a different user on the local system then creation @@ -293,7 +293,7 @@ - GROUP + GROUP Takes a comma-separated list of auxiliary UNIX groups this user shall belong @@ -310,8 +310,8 @@ - CAPABILITIES - CAPABILITIES + + These options take a space separated list of process capabilities (e.g. CAP_WAKE_ALARM, CAP_BLOCK_SUSPEND, …) that shall be @@ -325,7 +325,7 @@ - PATH + Takes a file system path to a directory. Specifies the skeleton directory to initialize the home directory with. All files and directories in the specified path are copied into @@ -336,7 +336,7 @@ - SHELL + Takes a file system path. Specifies the shell binary to execute on terminal logins. If not specified defaults to /bin/bash. @@ -345,7 +345,7 @@ - VARIABLE[=VALUE] + Takes an environment variable assignment to set for all user processes. May be used multiple times to set multiple environment variables. When = and @@ -360,7 +360,7 @@ - TIMEZONE + 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 @@ -374,7 +374,7 @@ - LANG + Takes a comma- or colon-separated list of languages preferred by the user, ordered by descending priority. The $LANG and $LANGUAGE environment @@ -386,7 +386,7 @@ - KEYS + Either takes a SSH authorized key line to associate with the user record or a @ character followed by a path to a file to read one or more such lines from. SSH keys configured this way are made available to SSH to permit access to this home directory and user @@ -396,7 +396,7 @@ - URI + Takes an RFC 7512 PKCS#11 URI referencing a security token (e.g. YubiKey or PIV smartcard) that shall be able to unlock the user account. The security token URI should reference a security token with exactly one pair of X.509 certificate and private key. A random secret key is @@ -425,7 +425,7 @@ - STRING + Specify COSE algorithm used in credential generation. The default value is es256. Supported values are es256, rs256 and eddsa. @@ -440,7 +440,7 @@ - PATH + Takes a path to a Linux hidraw device (e.g. /dev/hidraw1), referring to a FIDO2 security token implementing the @@ -471,7 +471,7 @@ - BOOL + When enrolling a FIDO2 security token, controls whether to require the user to enter a PIN when unlocking the account (the FIDO2 clientPin feature). Defaults to @@ -483,7 +483,7 @@ - BOOL + When enrolling a FIDO2 security token, controls whether to require the user to verify presence (tap the token, the FIDO2 up feature) when unlocking the account. @@ -495,7 +495,7 @@ - BOOL + When enrolling a FIDO2 security token, controls whether to require user verification when unlocking the account (the FIDO2 uv feature). Defaults to @@ -506,7 +506,7 @@ - BOOL + Accepts a boolean argument. If enabled a recovery key is configured for the account. A recovery key is a computer generated access key that may be used to regain access to an @@ -518,9 +518,9 @@ - PATH + PATH - FILENAME=PATH + FILENAME=PATH Accepts either a directory path, or a file name followed by a file path. If just a @@ -538,13 +538,13 @@ - PATH - PATH + + Accept a file path. If set, the specified file is used to overwrite the corresponding file in the user's blob directory. If blank, the corresponding file is deleted from the blob directory. Essentially, these options are shortcuts to - FILENAME=PATH + for the known filenames defined in User Record Blob Directories. @@ -552,7 +552,7 @@ - BOOLEAN + Takes a boolean argument. Specifies whether this user account shall be locked. If true logins into this account are prohibited, if false (the default) they are permitted (of course, @@ -562,8 +562,8 @@ - TIMESTAMP - TIMESTAMP + + These options take a timestamp string, in the format documented in systemd.time7 and @@ -574,8 +574,8 @@ - SECS - NUMBER + + Configures a rate limit on authentication attempts for this user. If the user attempts to authenticate more often than the specified number, on a specific system, within the @@ -586,7 +586,7 @@ - TEXT + 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. @@ -596,7 +596,7 @@ - BOOL + Takes a boolean argument. Configures whether to enforce the system's password policy @@ -608,7 +608,7 @@ - BOOL + Takes a boolean argument. If true the user is asked to change their password on next login. @@ -617,10 +617,10 @@ - TIME - TIME - TIME - TIME + + + + Each of these options takes a time span specification as argument (in the syntax documented in @@ -643,7 +643,7 @@ - BYTES + Either takes a size in bytes as argument (possibly using the usual K, M, G, … suffixes for 1024 base values), a percentage value, or the special strings min or max, and configures the disk space to assign to the user. If a percentage value is @@ -660,7 +660,7 @@ - MODE + Takes a UNIX file access mode written in octal. Configures the access mode of the home directory itself. Note that this is only used when the directory is first created, and the user @@ -671,7 +671,7 @@ - MASK + Takes the access mode mask (in octal syntax) to apply to newly created files and directories of the user ("umask"). If set this controls the initial umask set for all login sessions of @@ -681,7 +681,7 @@ - NICE + Takes the numeric scheduling priority ("nice level") to apply to the processes of the user at login time. Takes a numeric value in the range -20 (highest priority) to 19 (lowest priority). @@ -690,7 +690,7 @@ - LIMIT=VALUE:VALUE + Allows configuration of resource limits for processes of this user, see getrlimit2 @@ -703,7 +703,7 @@ - TASKS + Takes a non-zero unsigned integer as argument. Configures the maximum number of tasks (i.e. threads, where each process is at least one thread) the user may have at any given time. This @@ -720,8 +720,8 @@ - BYTES - BYTES + + Set a limit on the memory a user may take up on a system at any given time in bytes (the usual K, M, G, … suffixes are supported, to the base of 1024). This includes all memory used by @@ -735,8 +735,8 @@ - WEIGHT - WEIGHT + + Set CPU and IO scheduling weights of the processes of the user, including those of processes forked off by the user that changed user credentials. Takes a numeric value in the range @@ -749,7 +749,7 @@ - STORAGE + Selects the storage mechanism to use for this home directory. Takes one of luks, fscrypt, directory, @@ -762,7 +762,7 @@ - PATH + Takes a file system path. Configures where to place the user's home directory. When LUKS2 storage is used refers to the path to the loopback file, otherwise to the path to the home @@ -778,7 +778,7 @@ - BOOL + Automatically flush OS file system caches on logout. This is useful in combination with the fscrypt storage backend to ensure the OS does not keep decrypted versions of the files and @@ -791,7 +791,7 @@ - TYPE + When LUKS2 storage is used configures the file system type to use inside the home directory LUKS2 container. One of btrfs, ext4, @@ -804,7 +804,7 @@ - BOOL + When LUKS2 storage is used configures whether to enable the discard feature of the file system. If enabled the file system on top of the LUKS2 @@ -820,7 +820,7 @@ - BOOL + Similar to , controls the trimming of the file system. However, while controls what happens when the home directory @@ -832,7 +832,7 @@ - OPTIONS + Takes a string containing additional mount options to use when mounting the LUKS volume. If specified, this string will be appended to the default, built-in mount @@ -842,16 +842,16 @@ - CIPHER - MODE - BYTES - TYPE - ALGORITHM - ITERATIONS - SECONDS - BYTES - THREADS - BYTES + + + + + + + + + + Configures various cryptographic parameters for the LUKS2 storage mechanism. See - BOOL - BOOL - BOOL + + + Configures the nosuid, nodev and noexec mount options for the home directories. By default nodev @@ -923,10 +923,10 @@ - DOMAIN - USER - SERVICE - OPTIONS + + + + Configures the Windows File Sharing (CIFS) domain and user to associate with the home directory/user account, as well as the file share ("service") to mount as directory. The latter is @@ -942,7 +942,7 @@ - SECS + Configures the time the per-user service manager shall continue to run after the all sessions of the user ended. The default is configured in @@ -955,7 +955,7 @@ - BOOL + Configures whether to kill all processes of the user on logout. The default is configured in @@ -965,7 +965,7 @@ - BOOL + Takes a boolean argument. Configures whether the graphical UI of the system should automatically log this user in if possible. Defaults to off. If less or more than one user is marked @@ -975,7 +975,7 @@ - LAUNCHER + Takes a string argument. Configures the user's preferred session launcher .desktop entry file (i.e. gnome, plasma, or other names that @@ -986,7 +986,7 @@ - TYPE + Takes a string argument. Configures the user's preferred session type (i.e. x11, wayland, and other values accepted by @@ -1070,7 +1070,7 @@ create USER - create PATH USER + create USER Create a new home directory/user account of the specified name. Use the various user record property options (as documented above) to control various aspects of the home directory @@ -1094,7 +1094,7 @@ update USER - update PATH USER + update USER Update a home directory/user account. Use the various user record property options (as documented above) to make changes to the account, or alternatively provide a full, updated JSON diff --git a/man/networkctl.xml b/man/networkctl.xml index 8370e72cf9b..562ca3c6a7d 100644 --- a/man/networkctl.xml +++ b/man/networkctl.xml @@ -569,7 +569,7 @@ s - Service VLAN, m - Two-port MAC Relay (TPMR) - NAME + When used with edit, edit the drop-in file NAME diff --git a/man/portablectl.xml b/man/portablectl.xml index 9651112f978..bcfaf7ced15 100644 --- a/man/portablectl.xml +++ b/man/portablectl.xml @@ -310,7 +310,7 @@ PROFILE - PROFILE + When attaching an image, select the profile to use. By default the default profile is used. For details about profiles, see below. @@ -392,7 +392,7 @@ - PATH + Add an additional image PATH as an overlay on top of IMAGE when attaching/detaching. This argument can be specified diff --git a/man/resolvectl.xml b/man/resolvectl.xml index afa4ca77eba..ed656b48d72 100644 --- a/man/resolvectl.xml +++ b/man/resolvectl.xml @@ -278,7 +278,7 @@ INTERFACE - INTERFACE + Specifies the network interface to execute the query on. This may either be specified as numeric interface index or as network interface string (e.g. en0). Note that this option has no @@ -290,7 +290,7 @@ PROTOCOL - PROTOCOL + Specifies the network protocol for the query. May be one of dns (i.e. classic unicast DNS), llmnr ( TYPE - TYPE + CLASS - CLASS + When used in conjunction with the query command, specifies the DNS resource record type (e.g. A, AAAA, @@ -335,7 +335,7 @@ - BOOL + Takes a boolean parameter. If true (the default), when doing a service lookup with the hostnames contained in the SRV @@ -345,7 +345,7 @@ - BOOL + Takes a boolean parameter. If true (the default), when doing a DNS-SD service lookup with the TXT service metadata record is @@ -355,7 +355,7 @@ - BOOL + Takes a boolean parameter. If true (the default), DNS CNAME or DNAME redirections are @@ -366,7 +366,7 @@ - BOOL + Takes a boolean parameter; used in conjunction with query. If true (the default), DNSSEC validation is applied as usual — under the condition that it is enabled for the @@ -380,7 +380,7 @@ - BOOL + Takes a boolean parameter; used in conjunction with query. If true (the default), select domains are resolved on the local system, among them @@ -395,7 +395,7 @@ - BOOL + Takes a boolean parameter; used in conjunction with query. If true (the default), lookups use the local DNS resource record cache. If false, lookups are routed to the @@ -405,7 +405,7 @@ - BOOL + Takes a boolean parameter; used in conjunction with query. If true (the default), lookups are answered from locally registered LLMNR or mDNS resource records, if @@ -416,7 +416,7 @@ - BOOL + Takes a boolean parameter; used in conjunction with query. If true (the default), lookups for DS and DNSKEY are answered from the local DNSSEC trust anchors if @@ -426,7 +426,7 @@ - BOOL + Takes a boolean parameter; used in conjunction with query. If true (the default), lookups are answered via DNS, LLMNR or mDNS network requests if they cannot be @@ -438,7 +438,7 @@ - BOOL + Takes a boolean parameter. If true (the default), any specified single-label hostnames will be searched in the domains configured in the search domain list, if it is @@ -462,7 +462,7 @@ - BOOL + Takes a boolean parameter. If true (the default), column headers and meta information about the query response are shown. Otherwise, this output is suppressed. @@ -471,7 +471,7 @@ - BOOL + Takes a boolean parameter; used in conjunction with query. If true (the default), lookups are answered with stale data (expired resource records) if @@ -481,7 +481,7 @@ - BOOL + Takes a boolean parameter; used in conjunction with query. If true, rules regarding routing of single-label names are relaxed. Defaults to false. By default, diff --git a/man/standard-options.xml b/man/standard-options.xml index aaafa98bb78..d181f90b837 100644 --- a/man/standard-options.xml +++ b/man/standard-options.xml @@ -36,7 +36,7 @@ - BOOL + Enable or disable printing of the legend, i.e. column headers and the footer with hints. The @@ -73,7 +73,7 @@ - MODE + Shows output formatted as JSON. Expects one of short (for the shortest possible output without any redundant whitespace or line breaks), pretty diff --git a/man/systemctl.xml b/man/systemctl.xml index ce560bf2e5b..ca101d5b75c 100644 --- a/man/systemctl.xml +++ b/man/systemctl.xml @@ -2418,7 +2418,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err - INT + If used with the kill command, enqueues a signal along with the specified integer value parameter to the specified process(es). This operation is only available for @@ -2766,7 +2766,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err - NAME + When used with edit, use NAME as the drop-in file name instead of override.conf. diff --git a/man/systemd-analyze.xml b/man/systemd-analyze.xml index ca108c5cf9d..9a4b0cada41 100644 --- a/man/systemd-analyze.xml +++ b/man/systemd-analyze.xml @@ -1056,7 +1056,7 @@ x86-64 native - timespan + When used in conjunction with the critical-chain command (see above), also diff --git a/man/systemd-bsod.service.xml b/man/systemd-bsod.service.xml index e58d64c52ba..5ef10c2c072 100644 --- a/man/systemd-bsod.service.xml +++ b/man/systemd-bsod.service.xml @@ -58,7 +58,7 @@ - + Specify the TTY to output to. By default systemd-bsod will automatically find a free VT to display the message on. If this option is specified a TTY may be diff --git a/man/systemd-creds.xml b/man/systemd-creds.xml index 79ede4904d7..c8419d357a1 100644 --- a/man/systemd-creds.xml +++ b/man/systemd-creds.xml @@ -283,7 +283,7 @@ - name + When specified with the encrypt command controls the credential name to embed in the encrypted credential data. If not specified the name is chosen automatically @@ -306,7 +306,7 @@ - timestamp + When specified with the encrypt command controls the timestamp to embed into the encrypted credential. Defaults to the current time. Takes a timestamp specification in @@ -321,7 +321,7 @@ - timestamp + When specified with the encrypt command controls the time when the credential shall not be used anymore. This embeds the specified timestamp in the encrypted @@ -372,7 +372,7 @@ - PATH + Controls the TPM2 device to use. Expects a device node path referring to the TPM2 chip (e.g. /dev/tpmrm0). Alternatively the special value auto @@ -384,7 +384,7 @@ - PCR+PCR... + Configures the TPM2 PCRs (Platform Configuration Registers) to bind the encryption key to. Takes a + separated list of numeric PCR indexes in the range 0…23. If not @@ -396,8 +396,8 @@ - PATH - PCR+PCR... + + Configures a TPM2 signed PCR policy to bind encryption to, for use with the encrypt command. The option accepts a path to @@ -419,7 +419,7 @@ - PATH + Takes a path to a TPM2 PCR signature file as generated by the systemd-measure1 diff --git a/man/systemd-cryptenroll.xml b/man/systemd-cryptenroll.xml index c687ac31bb1..a3a2c610eeb 100644 --- a/man/systemd-cryptenroll.xml +++ b/man/systemd-cryptenroll.xml @@ -287,7 +287,7 @@ - PATH + Use a file instead of a password/passphrase read from stdin to unlock the volume. Expects the PATH to the file containing your key to unlock the volume. Currently there is nothing like @@ -298,7 +298,7 @@ - PATH + Use a FIDO2 device instead of a password/passphrase read from stdin to unlock the volume. Expects a hidraw device referring to the FIDO2 device (e.g. @@ -311,7 +311,7 @@ - PATH + Use a TPM2 device instead of a password/passhprase read from stdin to unlock the volume. Expects a device node path referring to the TPM2 chip (e.g. /dev/tpmrm0). @@ -323,7 +323,7 @@ - URI + Enroll a PKCS#11 security token or smartcard (e.g. a YubiKey). Expects a PKCS#11 URI that allows to find an X.509 certificate or a public key on the token. The URI must also be suitable @@ -356,7 +356,7 @@ - STRING + Specify COSE algorithm used in credential generation. The default value is es256. Supported values are es256, rs256 and eddsa. @@ -371,7 +371,7 @@ - PATH + Enroll a FIDO2 security token that implements the hmac-secret extension (e.g. a YubiKey). Expects a hidraw device referring to the FIDO2 @@ -397,7 +397,7 @@ - BOOL + When enrolling a FIDO2 security token, controls whether to require the user to enter a PIN when unlocking the volume (the FIDO2 clientPin feature). Defaults to @@ -409,7 +409,7 @@ - BOOL + When enrolling a FIDO2 security token, controls whether to require the user to verify presence (tap the token, the FIDO2 up feature) when unlocking the volume. @@ -421,7 +421,7 @@ - BOOL + When enrolling a FIDO2 security token, controls whether to require user verification when unlocking the volume (the FIDO2 uv feature). Defaults to @@ -432,7 +432,7 @@ - PATH + Enroll a TPM2 security chip. Expects a device node path referring to the TPM2 chip (e.g. /dev/tpmrm0). Alternatively the special value auto may @@ -457,7 +457,7 @@ - PATH + Enroll a TPM2 security chip using its public key. Expects a path referring to the TPM2 public key in TPM2B_PUBLIC format. This cannot be used with , as @@ -485,7 +485,7 @@ - HANDLE + Configures which parent key to use for sealing, using the TPM handle (index) of the key. This is used to "seal" (encrypt) a secret and must be used later to "unseal" (decrypt) the @@ -507,7 +507,7 @@ - PCR+PCR... + Configures the TPM2 PCRs (Platform Configuration Registers) to bind to when enrollment is requested via . Takes a list of PCR entries, where each @@ -532,7 +532,7 @@ - BOOL + When enrolling a TPM2 device, controls whether to require the user to enter a PIN when unlocking the volume in addition to PCR binding, based on TPM2 policy authentication. Defaults @@ -553,9 +553,9 @@ - PATH - PCR+PCR... - PATH + + + Configures a TPM2 signed PCR policy to bind encryption to. The option accepts a path to a PEM encoded RSA public key, to bind @@ -593,7 +593,7 @@ - PATH + Configures a TPM2 pcrlock policy to bind encryption to. Expects a path to a pcrlock policy file as generated by the @@ -607,7 +607,7 @@ - SLOT,SLOT... + Wipes one or more LUKS2 key slots. Takes a comma separated list of numeric slot indexes, or the special strings all (for wiping all key slots), diff --git a/man/systemd-measure.xml b/man/systemd-measure.xml index c979ce2f464..1707e0c7f3b 100644 --- a/man/systemd-measure.xml +++ b/man/systemd-measure.xml @@ -194,7 +194,7 @@ - PATH + Controls which TPM2 device to use. Expects a device node path referring to the TPM2 chip (e.g. /dev/tpmrm0). Alternatively the special value auto @@ -206,7 +206,7 @@ - PHASE + Controls which boot phases to calculate expected PCR 11 values for. This takes a series of colon-separated strings that encode boot "paths" for entering a specific phase of the boot @@ -232,7 +232,7 @@ - PATH + When generating a PCR JSON signature (via the sign command), combine it with a previously generated PCR JSON signature, and output it as one. The specified path diff --git a/man/systemd-networkd-wait-online.service.xml b/man/systemd-networkd-wait-online.service.xml index eac903f6842..e696a2ba9a1 100644 --- a/man/systemd-networkd-wait-online.service.xml +++ b/man/systemd-networkd-wait-online.service.xml @@ -61,7 +61,7 @@ INTERFACE:MIN_OPERSTATE:MAX_OPERSTATE - INTERFACE:MIN_OPERSTATE:MAX_OPERSTATE + Network interface to wait for before deciding if the system is online. This is useful when a system has several interfaces which will be configured, but a particular @@ -80,7 +80,7 @@ - INTERFACE + Network interfaces to be ignored when deciding if the system is online. By default, only the loopback @@ -92,7 +92,7 @@ MIN_OPERSTATE:MAX_OPERSTATE - MIN_OPERSTATE:MAX_OPERSTATE + Takes a minimum operational state and an optional maximum operational state. Please see networkctl1 @@ -158,7 +158,7 @@ - SECS + Fail the service if the network is not online by the time the timeout elapses. A timeout of 0 disables the diff --git a/man/systemd-notify.xml b/man/systemd-notify.xml index edbd0b9bf51..55bb8c59cf3 100644 --- a/man/systemd-notify.xml +++ b/man/systemd-notify.xml @@ -138,7 +138,7 @@ - USER + Set the user ID to send the notification from. Takes a UNIX user name or numeric UID. When specified the notification message will be sent with the specified UID as sender, in place of the user the diff --git a/man/systemd-nspawn.xml b/man/systemd-nspawn.xml index c7359f298a7..ec0492c26df 100644 --- a/man/systemd-nspawn.xml +++ b/man/systemd-nspawn.xml @@ -168,7 +168,7 @@ - MODE + Controls whether systemd-nspawn shall search for and use @@ -379,7 +379,7 @@ - MODE + Boots the container in volatile mode. When no mode parameter is passed or when mode is specified as , full volatile mode is enabled. This means the root directory is mounted as a @@ -1692,7 +1692,7 @@ After=sys-subsystem-net-devices-ens1.device - MODE + Configures how to set up standard input, output and error output for the container payload, as well as the /dev/console device for the container. Takes one of @@ -1758,8 +1758,8 @@ After=sys-subsystem-net-devices-ens1.device - ID:PATH - ID:VALUE + + Pass a credential to the container. These two options correspond to the LoadCredential= and SetCredential= settings in unit files. See diff --git a/man/systemd-pcrphase.service.xml b/man/systemd-pcrphase.service.xml index e4ee0941273..9c54663d3eb 100644 --- a/man/systemd-pcrphase.service.xml +++ b/man/systemd-pcrphase.service.xml @@ -158,7 +158,7 @@ - PATH + Controls which TPM2 device to use. Expects a device node path referring to the TPM2 chip (e.g. /dev/tpmrm0). Alternatively the special value auto diff --git a/man/systemd-repart.xml b/man/systemd-repart.xml index e719bd9687f..8f48081097b 100644 --- a/man/systemd-repart.xml +++ b/man/systemd-repart.xml @@ -390,8 +390,8 @@ - PATH - HANDLE + + Configures a TPM2 SRK key to bind encryption to. See systemd-cryptenroll1 @@ -401,8 +401,8 @@ - PATH - PCR+PCR... + + Configures a TPM2 signed PCR policy to bind encryption to. See systemd-cryptenroll1 @@ -412,7 +412,7 @@ - PATH + Configures a TPM2 pcrlock policy to bind encryption to. See systemd-cryptenroll1 @@ -422,7 +422,7 @@ - BOOL + Enables generation of split artifacts from partitions configured with SplitName=. If enabled, for each partition with SplitName= set, @@ -439,8 +439,8 @@ - PARTITIONS - PARTITIONS + + These options specify which partition types systemd-repart should operate on. If is used, all partitions that aren't specified @@ -454,7 +454,7 @@ - PARTITIONS + 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 @@ -467,7 +467,7 @@ - BYTES + 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 @@ -478,7 +478,7 @@ - ARCH + This option allows overriding the architecture used for architecture specific partition types. For example, if set to arm64 a partition type of @@ -508,7 +508,7 @@ - BOOL + Instructs systemd-repart to build the image offline. Takes a boolean or auto. Defaults to auto. If enabled, the image is @@ -522,7 +522,7 @@ - IMAGE + Instructs systemd-repart to synthesize partition definitions from the partition table in the given image. This option can be specified multiple times to synthesize @@ -537,7 +537,7 @@ - PATH + PATH Specifies a source directory all CopyFiles= source paths shall be @@ -550,7 +550,7 @@ - TYPE + Takes one of sysext, confext or portable. Generates a Discoverable Disk Image (DDI) for a system extension @@ -591,7 +591,7 @@ - PATH + Specifies a path where to write fstab entries for the mountpoints configured with in the root directory specified with or @@ -602,7 +602,7 @@ - PATH + Specifies a path where to write crypttab entries for the encrypted volumes configured with in the root directory specified with diff --git a/man/systemd-socket-activate.xml b/man/systemd-socket-activate.xml index 4d0a581c009..4c29fa2c665 100644 --- a/man/systemd-socket-activate.xml +++ b/man/systemd-socket-activate.xml @@ -122,7 +122,7 @@ - NAME:NAME… + Specify names for the file descriptors passed. This is equivalent to setting FileDescriptorName= in socket unit files, and enables use of diff --git a/man/systemd-sysext.xml b/man/systemd-sysext.xml index 5a6dffd2c58..de032f48cbe 100644 --- a/man/systemd-sysext.xml +++ b/man/systemd-sysext.xml @@ -380,7 +380,7 @@ - BOOL|auto|import + Set mutable mode. @@ -435,7 +435,7 @@ - BOOL + When merging configuration extensions into /etc/ the MS_NOEXEC mount flag is used by default. This option can be used to disable diff --git a/man/systemd-vmspawn.xml b/man/systemd-vmspawn.xml index 755040c1cb4..f9649b2f30a 100644 --- a/man/systemd-vmspawn.xml +++ b/man/systemd-vmspawn.xml @@ -104,7 +104,7 @@ - CPUS + Configures the number of CPUs to start the virtual machine with. Defaults to 1. @@ -114,7 +114,7 @@ - BYTES + Configures the amount of memory to start the virtual machine with. Defaults to 2G. @@ -124,7 +124,7 @@ - BOOL + Configures whether to use KVM. If the option is not specified KVM support will be detected automatically. If true, KVM is always used, and if false, KVM is never used. @@ -133,7 +133,7 @@ - BOOL + Configure whether to use VSOCK networking. @@ -145,7 +145,7 @@ - CID + Configure vmspawn to use a specific CID for the guest. @@ -160,7 +160,7 @@ - BOOL + Configure whether to use VM with a virtual TPM or not. @@ -178,7 +178,7 @@ - PATH + Set the linux kernel image to use for direct kernel boot. @@ -190,7 +190,7 @@ - PATH + Set the initrd to use for direct kernel boot. @@ -233,7 +233,7 @@ - PATH + Takes an absolute path, or a relative path beginning with ./. Specifies a JSON firmware definition file, which allows selecting the @@ -254,7 +254,7 @@ - BOOL + Configure whether to search for firmware which supports Secure Boot. @@ -327,7 +327,7 @@ - UID_SHIFT[:UID_RANGE] + Controls user namespacing under . If enabled, virtiofsd is instructed to map user and group ids (UIDs and GIDs). @@ -353,8 +353,8 @@ - PATH - PATH + + Mount a directory from the host into the virtual machine. Takes one of: a path argument — in which case the specified path will be mounted from the host to the same path in the virtual machine, or @@ -368,7 +368,7 @@ - PATH + Takes a disk image or block device on the host and supplies it to the virtual machine as another drive. @@ -383,7 +383,7 @@ - FILE|DIR + Forward the virtual machine's journal to the host. systemd-journal-remote8 @@ -397,7 +397,7 @@ - BOOL + By default an SSH key is generated to allow systemd-vmspawn to open a D-Bus connection to the VM's systemd bus. Setting this to "no" will disable SSH key generation. @@ -410,7 +410,7 @@ - TYPE + Configures the type of SSH key to generate, see ssh-keygen1 @@ -430,7 +430,7 @@ - MODE + Configures how to set up the console of the VM. Takes one of interactive, read-only, native, @@ -466,8 +466,8 @@ - ID:PATH - ID:VALUE + + Pass a credential to the virtual machine. These two options correspond to the LoadCredential= and SetCredential= settings in unit files. See diff --git a/man/systemd.xml b/man/systemd.xml index cb798af34c0..abfcc499f08 100644 --- a/man/systemd.xml +++ b/man/systemd.xml @@ -1360,7 +1360,7 @@ - VT + Switch to a specific virtual console (VT) on crash. This switch has no effect when running as user instance. Same as systemd.crash_chvt= above (but not the diff --git a/man/udevadm.xml b/man/udevadm.xml index 643321b0a23..41c8ae7a12d 100644 --- a/man/udevadm.xml +++ b/man/udevadm.xml @@ -704,7 +704,7 @@ - value + Set the maximum number of events, systemd-udevd will handle at the same time. When 0 is specified, then the maximum is determined based on the system resources. @@ -721,7 +721,7 @@ - seconds + The maximum number of seconds to wait for a reply from systemd-udevd. diff --git a/man/userdbctl.xml b/man/userdbctl.xml index 479893217ff..a7b438ad91b 100644 --- a/man/userdbctl.xml +++ b/man/userdbctl.xml @@ -53,7 +53,7 @@ - MODE + Choose the output mode, takes one of classic, friendly, table, json. If @@ -74,7 +74,7 @@ - FORMAT + Selects JSON output mode (like ) and selects the precise display mode. Takes one of pretty or short. If @@ -86,7 +86,7 @@ - SERVICE:SERVICE… + SERVICE:SERVICE… Controls which services to query for users/groups. Takes a list of one or more @@ -97,7 +97,7 @@ - BOOL + Controls whether to include classic glibc/NSS user/group lookups in the output. If is used any attempts to resolve or enumerate users/groups provided @@ -108,7 +108,7 @@ - BOOL + Controls whether to include Varlink user/group lookups in the output, i.e. those done via the User/Group Record Lookup API via @@ -120,7 +120,7 @@ - BOOL + Controls whether to include user/group lookups in the output that are defined using drop-in files in /etc/userdb/, /run/userdb/, @@ -133,7 +133,7 @@ - BOOL + Controls whether to synthesize records for the root and nobody users/groups if they aren't defined otherwise. By default (or yes) such records are implicitly @@ -155,7 +155,7 @@ - BOOL + Controls whether to do lookups via the multiplexer service (if specified as true, the default) or do lookups in the client (if specified as false). Using the multiplexer service is diff --git a/man/varlinkctl.xml b/man/varlinkctl.xml index 22add03a9d5..eefc3d1de0e 100644 --- a/man/varlinkctl.xml +++ b/man/varlinkctl.xml @@ -204,7 +204,7 @@ - MODE + Selects the JSON output formatting, one of pretty (for nicely indented,