diff --git a/man/coredumpctl.xml b/man/coredumpctl.xml index 2b0f62a28d..4e99bc0d69 100644 --- a/man/coredumpctl.xml +++ b/man/coredumpctl.xml @@ -321,7 +321,7 @@ Extract the last core dump of /usr/bin/bar to a file named - <filename noindex="true">bar.coredump</filename> + bar.coredump # coredumpctl -o bar.coredump dump /usr/bin/bar diff --git a/man/daemon.xml b/man/daemon.xml index 79ea55ba26..52b3883607 100644 --- a/man/daemon.xml +++ b/man/daemon.xml @@ -102,7 +102,7 @@ In the daemon process, write the daemon PID (as returned by getpid()) to a PID file, - for example /run/foobar.pid (for a + for example /run/foobar.pid (for a hypothetical daemon "foobar") to ensure that the daemon cannot be started more than once. This must be implemented in race-free fashion so that the PID file is only updated when it diff --git a/man/environment.d.xml b/man/environment.d.xml index 702154837b..69c156aacb 100644 --- a/man/environment.d.xml +++ b/man/environment.d.xml @@ -75,7 +75,7 @@ Example Setup environment to allow access to a program installed in - <filename noindex='true'>/opt/foo</filename> + /opt/foo /etc/environment.d/60-foo.conf: diff --git a/man/journal-upload.conf.xml b/man/journal-upload.conf.xml index 6b946bf649..f2721a75e7 100644 --- a/man/journal-upload.conf.xml +++ b/man/journal-upload.conf.xml @@ -50,7 +50,7 @@ URL= The URL to upload the journal entries to. See the description - of --url= option in + of option in systemd-journal-upload8 for the description of possible values. There is no default value, so either this option or the command-line option must be always present to make an upload. diff --git a/man/less-variables.xml b/man/less-variables.xml index 8a701277b6..03e4b35388 100644 --- a/man/less-variables.xml +++ b/man/less-variables.xml @@ -27,7 +27,7 @@ Users might want to change two options in particular: - + diff --git a/man/resolvectl.xml b/man/resolvectl.xml index 8c1d6e5de4..594e22c03f 100644 --- a/man/resolvectl.xml +++ b/man/resolvectl.xml @@ -53,13 +53,15 @@ - + query HOSTNAME|ADDRESS… Resolve domain names, IPv4 and IPv6 addresses. - + service + [[NAME] TYPE] + DOMAIN Resolve DNS-SD and SRV services, depending on the specified list of parameters. @@ -71,7 +73,7 @@ - + openpgp EMAIL@DOMAIN… Query PGP keys stored as OPENPGPKEY resource records. Specified e-mail addresses are converted to the corresponding DNS domain name, and any @@ -79,7 +81,9 @@ - + tlsa + [FAMILY] + DOMAIN[:PORT]… Query TLS public keys stored as TLSA resource records. A query will be performed for each of the specified names prefixed with the port and family @@ -89,28 +93,28 @@ - + status [LINK…] Shows the global and per-link DNS settings currently in effect. If no command is specified, this is the implied default. - + statistics Shows general resolver statistics, including information whether DNSSEC is enabled and available, as well as resolution and validation statistics. - + reset-statistics - Resets the statistics counters shown in to zero. + Resets the statistics counters shown in statistics to zero. This operation requires root privileges. - + flush-caches Flushes all DNS resource record caches the service maintains locally. This is mostly equivalent to sending the SIGUSR2 to the systemd-resolved @@ -118,7 +122,7 @@ - + reset-server-features Flushes all feature level information the resolver learnt about specific servers, and ensures that the server feature probing logic is started from the beginning with the next look-up request. This is @@ -127,46 +131,48 @@ - - - - - - - - + dns [LINK [SERVER…]] + domain [LINK [DOMAIN…]] + default-route [LINK [BOOL…]] + llmnr [LINK [MODE]] + mdns [LINK [MODE]] + dnssec [LINK [MODE]] + dnsovertls [LINK [MODE]] + nta [LINK [DOMAIN…]] - Get/set per-interface DNS configuration. These commands may be used to configure various DNS settings - for network interfaces. These commands may be used to inform systemd-resolved or - systemd-networkd about per-interface DNS configuration determined - through external means. The command expects IPv4 or IPv6 address specifications of DNS - servers to use. The command expects valid DNS domains, possibly prefixed with - ~, and configures a per-interface search or route-only domain. The - command expects a boolean parameter, and configures whether the link may be - used as default route for DNS lookups, i.e. if it is suitable for lookups on domains no other link explicitly - is configured for. The , , and - commands may be used to configure the per-interface LLMNR, MulticastDNS, DNSSEC - and DNSOverTLS settings. Finally, command may be used to configure additional - per-interface DNSSEC NTA domains. + Get/set per-interface DNS configuration. These commands may be used to configure various DNS + settings for network interfaces. These commands may be used to inform + systemd-resolved or systemd-networkd about per-interface DNS + configuration determined through external means. The dns command expects IPv4 or + IPv6 address specifications of DNS servers to use. The domain command expects + valid DNS domains, possibly prefixed with ~, and configures a per-interface + search or route-only domain. The default-route command expects a boolean + parameter, and configures whether the link may be used as default route for DNS lookups, i.e. if it + is suitable for lookups on domains no other link explicitly is configured for. The + llmnr, mdns, dnssec and + dnsovertls commands may be used to configure the per-interface LLMNR, + MulticastDNS, DNSSEC and DNSOverTLS settings. Finally, nta command may be used + to configure additional per-interface DNSSEC NTA domains. - Options , and can take + Commands dns, domain and nta can take a single empty string argument to clear their respective value lists. - For details about these settings, their possible values and their effect, see the corresponding options in + For details about these settings, their possible values and their effect, see the + corresponding settings in systemd.network5. - + revert LINK Revert the per-interface DNS configuration. If the DNS configuration is reverted all - per-interface DNS setting are reset to their defaults, undoing all effects of , - , , , , - , , . Note that when a network interface - disappears all configuration is lost automatically, an explicit reverting is not necessary in that - case. + per-interface DNS setting are reset to their defaults, undoing all effects of dns, + domain, default-route, llmnr, + mdns, dnssec, dnsovertls, + nta. Note that when a network interface disappears all configuration is lost + automatically, an explicit reverting is not necessary in that case. diff --git a/man/systemd-analyze.xml b/man/systemd-analyze.xml index dcb7cf29c1..911a00bc02 100644 --- a/man/systemd-analyze.xml +++ b/man/systemd-analyze.xml @@ -348,8 +348,8 @@ DATAERR 65 BSD <command>systemd-analyze condition <replaceable>CONDITION</replaceable>...</command> - This command will evaluate Condition*=... and - Assert*=... assignments, and print their values, and + This command will evaluate Condition*=... and + Assert*=... assignments, and print their values, and the resulting value of the combined condition set. See systemd.unit5 for a list of available conditions and asserts. @@ -602,7 +602,7 @@ Service b@0.service not loaded, b.socket cannot be started. policy is not validated too. - Analyze <filename noindex="true">systemd-logind.service</filename> + Analyze <filename index="false">systemd-logind.service</filename> $ systemd-analyze security --no-pager systemd-logind.service NAME DESCRIPTION EXPOSURE diff --git a/man/systemd-cat.xml b/man/systemd-cat.xml index f3d6f3785f..96d3072a1f 100644 --- a/man/systemd-cat.xml +++ b/man/systemd-cat.xml @@ -140,7 +140,7 @@ Invoke a program - This calls /bin/ls + This calls /bin/ls with standard output and error connected to the journal: # systemd-cat ls diff --git a/man/systemd-cgtop.xml b/man/systemd-cgtop.xml index a850a57c97..5beeb586d7 100644 --- a/man/systemd-cgtop.xml +++ b/man/systemd-cgtop.xml @@ -42,7 +42,7 @@ If systemd-cgtop is not connected to a tty, no column headers are printed and the default is to only run - one iteration. The --iterations= argument, if + one iteration. The argument, if given, is honored. This mode is suitable for scripting. Resource usage is only accounted for control groups in the diff --git a/man/systemd-fsck@.service.xml b/man/systemd-fsck@.service.xml index 121b0cdf76..16fad1ae04 100644 --- a/man/systemd-fsck@.service.xml +++ b/man/systemd-fsck@.service.xml @@ -51,7 +51,7 @@ systemd-fsck does not know any details about specific filesystems, and simply executes file system checkers specific to each filesystem type - (/sbin/fsck.*). These checkers will decide if + (/sbin/fsck.type). These checkers will decide if the filesystem should actually be checked based on the time since last check, number of mounts, unclean unmount, etc. diff --git a/man/systemd-makefs@.service.xml b/man/systemd-makefs@.service.xml index 89662b8ae5..f58c1c1f34 100644 --- a/man/systemd-makefs@.service.xml +++ b/man/systemd-makefs@.service.xml @@ -51,7 +51,7 @@ systemd-makefs knows very little about specific file systems and swap devices, and after checking that the block device does not already contain a file system or other content, it will execute binaries specific to - each filesystem type (/sbin/mkfs.*). + each filesystem type (/sbin/mkfs.type). systemd-growfs knows very little about specific file systems and swap devices, and will instruct the kernel to grow the mounted diff --git a/man/systemd-nspawn.xml b/man/systemd-nspawn.xml index 92987ff32f..f5d42350dd 100644 --- a/man/systemd-nspawn.xml +++ b/man/systemd-nspawn.xml @@ -1366,7 +1366,7 @@ # systemd-nspawn -bD /var/lib/machines/f&fedora_latest_version; This installs a minimal Fedora distribution into the - directory /var/lib/machines/f&fedora_latest_version; + directory /var/lib/machines/f&fedora_latest_version; and then boots an OS in a namespace container in it. Because the installation is located underneath the standard /var/lib/machines/ directory, it is also possible to start the machine using diff --git a/man/systemd.automount.xml b/man/systemd.automount.xml index 75302e07e9..f2ed761021 100644 --- a/man/systemd.automount.xml +++ b/man/systemd.automount.xml @@ -40,7 +40,7 @@ are configured in the [Automount] section. Automount units must be named after the automount directories they control. Example: the automount point - /home/lennart must be configured in a unit file + /home/lennart must be configured in a unit file home-lennart.automount. For details about the escaping logic used to convert a file system path to a unit name see systemd.unit5. Note that diff --git a/man/systemd.device.xml b/man/systemd.device.xml index ff7ab9ccce..ae786a3298 100644 --- a/man/systemd.device.xml +++ b/man/systemd.device.xml @@ -51,7 +51,7 @@ Device units are named after the /sys and /dev paths they control. Example: the - device /dev/sda5 is exposed in + device /dev/sda5 is exposed in systemd as dev-sda5.device. For details about the escaping logic used to convert a file system path to a unit name see diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml index 3a11cecb95..7b0b4f18e5 100644 --- a/man/systemd.exec.xml +++ b/man/systemd.exec.xml @@ -356,11 +356,12 @@ Example: if a unit has the following, CapabilityBoundingSet=CAP_A CAP_B CapabilityBoundingSet=CAP_B CAP_C - then CAP_A, CAP_B, and CAP_C are set. - If the second line is prefixed with ~, e.g., + then CAP_A, CAP_B, and + CAP_C are set. If the second line is prefixed with + ~, e.g., CapabilityBoundingSet=CAP_A CAP_B CapabilityBoundingSet=~CAP_B CAP_C - then, only CAP_A is set. + then, only CAP_A is set. @@ -994,8 +995,10 @@ CapabilityBoundingSet=~CAP_B CAP_C Example: if a system service unit has the following, RuntimeDirectory=foo/bar baz the service manager creates /run/foo (if it does not exist), - /run/foo/bar, and /run/baz. The directories - /run/foo/bar and /run/baz except /run/foo are + + /run/foo/bar, and /run/baz. The + directories /run/foo/bar and + /run/baz except /run/foo are owned by the user and group specified in User= and Group=, and removed when the service is stopped. diff --git a/man/systemd.generator.xml b/man/systemd.generator.xml index c77afda0f2..dd0b591996 100644 --- a/man/systemd.generator.xml +++ b/man/systemd.generator.xml @@ -24,7 +24,7 @@ - /path/to/generator + /path/to/generator normal-dir early-dir late-dir diff --git a/man/systemd.link.xml b/man/systemd.link.xml index 5013e7e9b5..59d1434694 100644 --- a/man/systemd.link.xml +++ b/man/systemd.link.xml @@ -709,7 +709,7 @@ ID_NET_LINK_FILE=/usr/lib/systemd/network/99-default.link In this case, the interface was already renamed, so the policy specified as - the first option in 99-default.link means that the existing name is + the first option in 99-default.link means that the existing name is preserved. If was removed, or if were in boot before the renaming has happened, we might get the following instead: diff --git a/man/systemd.mount.xml b/man/systemd.mount.xml index a72a33240d..b2c9d60681 100644 --- a/man/systemd.mount.xml +++ b/man/systemd.mount.xml @@ -60,7 +60,7 @@ must be run as UID 0. Mount units must be named after the mount point directories they control. Example: the mount point /home/lennart must be configured in a unit file home-lennart.mount. + index="false">/home/lennart must be configured in a unit file home-lennart.mount. For details about the escaping logic used to convert a file system path to a unit name, see systemd.unit5. Note that mount units cannot be templated, nor is possible to add multiple names to a mount unit by creating additional symlinks to diff --git a/man/systemd.net-naming-scheme.xml b/man/systemd.net-naming-scheme.xml index 419fed62ea..ec3b8671f2 100644 --- a/man/systemd.net-naming-scheme.xml +++ b/man/systemd.net-naming-scheme.xml @@ -300,7 +300,7 @@ again. Previously, this naming policy applied implicitly, and now it must be explicitly requested. Effectively, this means that network devices will be renamed according to the configuration, even if they have been renamed already, if keep is not - specified as the naming policy in the .link file. See + specified as the naming policy in the .link file. See systemd.link5 for a description of NamePolicy=. @@ -310,7 +310,7 @@ was extended to set MAC addresses based on the device name. Previously addresses were only based on the - ID_NET_NAME_* attributes, which meant that interface names would + ID_NET_NAME_* attributes, which meant that interface names would never be generated for virtual devices. Now a persistent address will be generated for most devices, including in particular bridges. diff --git a/man/systemd.offline-updates.xml b/man/systemd.offline-updates.xml index 06390669de..89c12b598b 100644 --- a/man/systemd.offline-updates.xml +++ b/man/systemd.offline-updates.xml @@ -35,13 +35,13 @@ The package manager prepares system updates by downloading all (RPM or DEB or whatever) packages to update off-line in a special directory - /var/lib/system-update (or + /var/lib/system-update (or another directory of the package/upgrade manager's choice). When the user OK'ed the update, the symlink /system-update is - created that points to /var/lib/system-update (or + created that points to /var/lib/system-update (or wherever the directory with the upgrade files is located) and the system is rebooted. This symlink is in the root directory, since we need to check for it very early at boot, at a time where /var is not available yet. @@ -106,12 +106,12 @@ To make things a bit more robust we recommend hooking the update script into - system-update.target via a .wants/ + system-update.target via a .wants/ symlink in the distribution package, rather than depending on systemctl enable in the postinst scriptlets of your package. More specifically, for your update script create a .service file, without [Install] section, and then add a symlink like - /usr/lib/systemd/system-update.target.wants/foobar.service - → ../foobar.service to your package. + /usr/lib/systemd/system-update.target.wants/foobar.service + → ../foobar.service to your package. @@ -144,7 +144,7 @@ Wants=system-update-pre.target and Before=system-update-pre.target and add a symlink to that file under - /usr/lib/systemd/system-update.target.wants + /usr/lib/systemd/system-update.target.wants . diff --git a/man/systemd.resource-control.xml b/man/systemd.resource-control.xml index 7daaba5074..a9600917ea 100644 --- a/man/systemd.resource-control.xml +++ b/man/systemd.resource-control.xml @@ -91,7 +91,7 @@ - + CPU CPUWeight= and StartupCPUWeight= replace CPUShares= and StartupCPUShares=, respectively. @@ -101,7 +101,7 @@ - + Memory MemoryMax= replaces MemoryLimit=. MemoryLow= and MemoryHigh= are effective only on unified hierarchy. @@ -109,10 +109,11 @@ - + IO - IO prefixed settings are a superset of and replace BlockIO - prefixed ones. On unified hierarchy, IO resource control also applies to buffered writes. + IO-prefixed settings are a superset of and replace + BlockIO-prefixed ones. On unified hierarchy, IO resource control also applies + to buffered writes. diff --git a/man/systemd.service.xml b/man/systemd.service.xml index f57e37ca5b..db28e3e272 100644 --- a/man/systemd.service.xml +++ b/man/systemd.service.xml @@ -574,8 +574,8 @@ TimeoutStopSec= This option serves two purposes. First, it configures the time to wait for each - ExecStop= command. If any of them times out, subsequent ExecStop= commands - are skipped and the service will be terminated by SIGTERM. If no ExecStop= + ExecStop= command. If any of them times out, subsequent ExecStop= commands + are skipped and the service will be terminated by SIGTERM. If no ExecStop= commands are specified, the service gets the SIGTERM immediately. Second, it configures the time to wait for the service itself to stop. If it doesn't terminate in the specified time, it will be forcibly terminated by SIGKILL (see KillMode= in @@ -1329,8 +1329,8 @@ WantedBy=multi-user.target Type= are the only service units that may have more than one ExecStart= specified. For units with multiple - commands (Type=oneshot), all commands will be run again. - For Type=oneshot, Restart= + commands (Type=oneshot), all commands will be run again. + For Type=oneshot, Restart= and Restart= are not allowed. diff --git a/man/systemd.swap.xml b/man/systemd.swap.xml index 23547bb273..190fc388c0 100644 --- a/man/systemd.swap.xml +++ b/man/systemd.swap.xml @@ -54,7 +54,7 @@ unit. Swap units must be named after the devices or files they control. Example: the swap device /dev/sda5 must be configured in a unit file dev-sda5.swap. For + index="false">/dev/sda5 must be configured in a unit file dev-sda5.swap. For details about the escaping logic used to convert a file system path to a unit name, see systemd.unit5. Note that swap units cannot be templated, nor is possible to add multiple names to a swap unit by creating additional symlinks to diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml index d6ff6cf9cb..763e3229a7 100644 --- a/man/systemd.unit.xml +++ b/man/systemd.unit.xml @@ -48,7 +48,7 @@ /run/systemd/system/* /run/systemd/systemd.attached/* /run/systemd/generator/* -… +… /usr/lib/systemd/system/* /run/systemd/generator.late/* @@ -65,7 +65,7 @@ /run/systemd/user/* $XDG_RUNTIME_DIR/systemd/generator/* ~/.local/share/systemd/user/* -… +… /usr/lib/systemd/user/* $XDG_RUNTIME_DIR/systemd/generator.late/* @@ -246,7 +246,7 @@ escaping is used, in order to map strings containing arbitrary byte values (except NUL) into valid unit names and their restricted character set. A common special case are unit names that reflect paths to objects in the file system hierarchy. Example: a device unit dev-sda.device refers to a device with the device - node /dev/sda in the file system. + node /dev/sda in the file system. The escaping algorithm operates as follows: given a string, any / character is replaced by -, and all other characters which are not ASCII alphanumerics or _ are @@ -435,7 +435,7 @@ Units of packages that have been installed in the home directory ($XDG_DATA_HOME is used if set, ~/.local/share otherwise) - $dir/systemd/user for each $dir in $XDG_DATA_DIRS + $dir/systemd/user for each $dir in $XDG_DATA_DIRS Additional locations for installed user units, one for each entry in $XDG_DATA_DIRS @@ -1026,8 +1026,8 @@ Conditions and Asserts - Unit files may also include a number of Condition…= and - Assert…= settings. Before the unit is started, systemd will verify + Unit files may also include a number of Condition…= and + Assert…= settings. Before the unit is started, systemd will verify that the specified conditions are true. If not, the starting of the unit will be (mostly silently) skipped. Failing conditions will not result in the unit being moved into the failed state. The conditions are checked at the time the queued start job is to be executed. The ordering @@ -1731,7 +1731,7 @@ Note that this setting is not influenced by the Us %L Log directory root - This is either /var/log (for the system manager) or the path $XDG_CONFIG_HOME resolves to with /log appended (for user managers). + This is either /var/log (for the system manager) or the path $XDG_CONFIG_HOME resolves to with /log appended (for user managers). %m diff --git a/man/tmpfiles.d.xml b/man/tmpfiles.d.xml index aae63b7591..a497b9b489 100644 --- a/man/tmpfiles.d.xml +++ b/man/tmpfiles.d.xml @@ -33,7 +33,7 @@ ~/.config/user-tmpfiles.d/*.conf $XDG_RUNTIME_DIR/user-tmpfiles.d/*.conf ~/.local/share/user-tmpfiles.d/*.conf -… +… /usr/share/user-tmpfiles.d/*.conf @@ -654,7 +654,7 @@ w- /proc/sys/vm/swappiness - - - - 10 %L System or user log directory - In mode, this is the same as $XDG_CONFIG_HOME with /log appended, and /var/log otherwise. + In mode, this is the same as $XDG_CONFIG_HOME with /log appended, and /var/log otherwise. %m diff --git a/man/user@.service.xml b/man/user@.service.xml index e748c03b88..81a6fef4ba 100644 --- a/man/user@.service.xml +++ b/man/user@.service.xml @@ -68,16 +68,16 @@ different levels. As described in the previous section, user.slice contains processes of all users, so any resource limits on that slice apply to all users together. The usual way to configure them would be through drop-ins, e.g. /etc/systemd/system/user.slice.d/resources.conf. + index="false">/etc/systemd/system/user.slice.d/resources.conf. The processes of a single user are collected under user-UID.slice. Resource limits for that user can be configured through drop-ins for that unit, e.g. /etc/systemd/system/user-1000.slice.d/resources.conf. If the limits + index="false">/etc/systemd/system/user-1000.slice.d/resources.conf. If the limits should apply to all users instead, they may be configured through drop-ins for the truncated unit name, user-.slice. For example, configuration in /etc/systemd/system/user-.slice.d/resources.conf is included in all + index="false">/etc/systemd/system/user-.slice.d/resources.conf is included in all user-UID.slice units, see systemd.unit5 for a discussion of the drop-in mechanism. @@ -141,20 +141,20 @@ Control group /: │ └─6706 /usr/bin/sleep 30 … User with UID 1000 is logged in using gdm (session-4.scope) and + index="false">session-4.scope) and ssh1 - (session-19.scope), and also has a user manager instance - running (user@1000.service). User with UID 1001 is logged - in using ssh (session-20.scope) and + (session-19.scope), and also has a user manager instance + running (user@1000.service). User with UID 1001 is logged + in using ssh (session-20.scope) and also has a user manager instance running (user@1001.service). Those are all (leaf) system units, and form - part of the slice hierarchy, with user-1000.slice and - user-1001.slice below user.slice. User units are visible below the + index="false">user@1001.service). Those are all (leaf) system units, and form + part of the slice hierarchy, with user-1000.slice and + user-1001.slice below user.slice. User units are visible below the user@.service instances (pulseaudio.service, gnome-terminal-server.service, init.scope, sleep.service). + index="false">pulseaudio.service, gnome-terminal-server.service, init.scope, sleep.service). diff --git a/tools/make-directive-index.py b/tools/make-directive-index.py index 9d9448703f..da10575f32 100755 --- a/tools/make-directive-index.py +++ b/tools/make-directive-index.py @@ -187,10 +187,13 @@ def _extract_directives(directive_groups, formatting, page): storvar if klass else storopt)): for name in variablelist.iterfind(xpath): text = re.sub(r'([= ]).*', r'\1', name.text).rstrip() + if text.startswith('-'): + # for options, merge options with and without mandatory arg + text = text.partition('=')[0] stor[text].append((pagename, section)) if text not in formatting: # use element as formatted display - if name.text[-1] in '= ': + if name.text[-1] in "= '": name.clear() else: name.tail = '' @@ -204,7 +207,7 @@ def _extract_directives(directive_groups, formatting, page): for name in t.iterfind(xpath): if absolute_only and not (name.text and name.text.startswith('/')): continue - if name.attrib.get('noindex'): + if name.attrib.get('index') == 'false': continue name.tail = '' if name.text: @@ -228,7 +231,7 @@ def _extract_directives(directive_groups, formatting, page): storfile = directive_groups['constants'] for name in t.iterfind('.//constant'): - if name.attrib.get('noindex'): + if name.attrib.get('index') == 'false': continue name.tail = '' if name.text.startswith('('): # a cast, strip it