diff options
| author | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2020-07-06 11:00:06 +0200 |
|---|---|---|
| committer | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2020-07-06 11:29:05 +0200 |
| commit | bdac560801ac01af616c127ba603a4b2d7d54c47 (patch) | |
| tree | caabc7c348e60e50b5fe687db39d25686fda17df | |
| parent | tree-wide: fixes for assorted grammar and spelling issues (diff) | |
| download | systemd-bdac560801ac01af616c127ba603a4b2d7d54c47.tar.xz systemd-bdac560801ac01af616c127ba603a4b2d7d54c47.zip | |
tree-wide: drop quotes from around [section]
For users, the square brackets already serve as markup and clearly delineate
the section name from surrounding text. Putting additional markup around that
only adds clutter. Also, we were very inconsistent in using the quotes. Let's
just drop them altogether.
33 files changed, 250 insertions, 285 deletions
diff --git a/man/coredump.conf.xml b/man/coredump.conf.xml index 81cdc33898..46da7741c9 100644 --- a/man/coredump.conf.xml +++ b/man/coredump.conf.xml @@ -49,7 +49,7 @@ <title>Options</title> <para>All options are configured in the - <literal>[Coredump]</literal> section:</para> + [Coredump] section:</para> <variablelist class='config-directives'> diff --git a/man/daemon.xml b/man/daemon.xml index 52b3883607..072529eeec 100644 --- a/man/daemon.xml +++ b/man/daemon.xml @@ -357,7 +357,7 @@ special target unit <filename>sockets.target</filename>. It is recommended to place a <varname>WantedBy=sockets.target</varname> directive in the - <literal>[Install]</literal> section to automatically add such a + [Install] section to automatically add such a dependency on installation of a socket unit. Unless <varname>DefaultDependencies=no</varname> is set, the necessary ordering dependencies are implicitly created for all socket @@ -520,7 +520,7 @@ operating system-independent.</para></listitem> <listitem><para>Make sure to include an - <literal>[Install]</literal> section including installation + [Install] section including installation information for the unit file. See <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details. To activate your service on boot, make sure to diff --git a/man/homed.conf.xml b/man/homed.conf.xml index 9e321940b7..2c5f3355d3 100644 --- a/man/homed.conf.xml +++ b/man/homed.conf.xml @@ -42,7 +42,7 @@ <refsect1> <title>Options</title> - <para>The following options are available in the <literal>[Home]</literal> section:</para> + <para>The following options are available in the [Home] section:</para> <variablelist class='home-directives'> diff --git a/man/journal-remote.conf.xml b/man/journal-remote.conf.xml index ab3dfd0111..3db12dd0ce 100644 --- a/man/journal-remote.conf.xml +++ b/man/journal-remote.conf.xml @@ -49,7 +49,7 @@ <title>Options</title> <para>All options are configured in the - <literal>[Remote]</literal> section:</para> + [Remote] section:</para> <variablelist class='config-directives'> <varlistentry> diff --git a/man/journal-upload.conf.xml b/man/journal-upload.conf.xml index f2721a75e7..6cb1aa474d 100644 --- a/man/journal-upload.conf.xml +++ b/man/journal-upload.conf.xml @@ -43,7 +43,7 @@ <refsect1> <title>Options</title> - <para>All options are configured in the <literal>[Upload]</literal> section:</para> + <para>All options are configured in the [Upload] section:</para> <variablelist class='config-directives'> <varlistentry> diff --git a/man/journald.conf.xml b/man/journald.conf.xml index 957ec36a68..5c9419b012 100644 --- a/man/journald.conf.xml +++ b/man/journald.conf.xml @@ -53,7 +53,7 @@ <title>Options</title> <para>All options are configured in the - <literal>[Journal]</literal> section:</para> + [Journal] section:</para> <variablelist class='config-directives'> diff --git a/man/logind.conf.xml b/man/logind.conf.xml index b23794c2f3..22f21355b6 100644 --- a/man/logind.conf.xml +++ b/man/logind.conf.xml @@ -46,7 +46,7 @@ <title>Options</title> <para>All options are configured in the - <literal>[Login]</literal> section:</para> + [Login] section:</para> <variablelist class='config-directives'> diff --git a/man/networkd.conf.xml b/man/networkd.conf.xml index 6c60f6cf6b..e8e41ebe92 100644 --- a/man/networkd.conf.xml +++ b/man/networkd.conf.xml @@ -45,7 +45,7 @@ <refsect1> <title>[Network] Section Options</title> - <para>The following options are available in the <literal>[Network]</literal> section:</para> + <para>The following options are available in the [Network] section:</para> <variablelist class='network-directives'> <varlistentry> diff --git a/man/pstore.conf.xml b/man/pstore.conf.xml index 15af353de1..501171e78a 100644 --- a/man/pstore.conf.xml +++ b/man/pstore.conf.xml @@ -44,7 +44,7 @@ <title>Options</title> <para>All options are configured in the - <literal>[PStore]</literal> section:</para> + [PStore] section:</para> <variablelist class='config-directives'> diff --git a/man/resolved.conf.xml b/man/resolved.conf.xml index a39da086bf..0e7a9f4bc6 100644 --- a/man/resolved.conf.xml +++ b/man/resolved.conf.xml @@ -41,7 +41,7 @@ <refsect1> <title>Options</title> - <para>The following options are available in the <literal>[Resolve]</literal> section:</para> + <para>The following options are available in the [Resolve] section:</para> <variablelist class='network-directives'> diff --git a/man/systemctl.xml b/man/systemctl.xml index f05beaf6ee..28c2194285 100644 --- a/man/systemctl.xml +++ b/man/systemctl.xml @@ -582,7 +582,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err <listitem> <para>Enable one or more units or unit instances. This will create a set of symlinks, as encoded in the - <literal>[Install]</literal> sections of the indicated unit files. After the symlinks have been created, + [Install] sections of the indicated unit files. After the symlinks have been created, the system manager configuration is reloaded (in a way equivalent to <command>daemon-reload</command>), in order to ensure the changes are taken into account immediately. Note that this does <emphasis>not</emphasis> have the effect of also starting any of the units being enabled. If this is @@ -605,7 +605,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err <option>--quiet</option>. </para> - <para>Note that this operation creates only the symlinks suggested in the <literal>[Install]</literal> + <para>Note that this operation creates only the symlinks suggested in the [Install] section of the unit files. While this command is the recommended way to manipulate the unit configuration directory, the administrator is free to make additional changes manually by placing or removing symlinks below this directory. This is particularly useful to create configurations that deviate from the suggested @@ -645,7 +645,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err <para>This command expects valid unit names only, it does not accept paths to unit files.</para> <para>In addition to the units specified as arguments, all units are disabled that are listed in the - <varname>Also=</varname> setting contained in the <literal>[Install]</literal> section of any of the unit + <varname>Also=</varname> setting contained in the [Install] section of any of the unit files being operated on.</para> <para>This command implicitly reloads the system manager configuration after completing the operation. Note @@ -668,7 +668,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err <listitem> <para>Reenable one or more units, as specified on the command line. This is a combination of <command>disable</command> and <command>enable</command> and is useful to reset the symlinks a unit file is - enabled with to the defaults configured in its <literal>[Install]</literal> section. This command expects + enabled with to the defaults configured in its [Install] section. This command expects a unit name only, it does not accept paths to unit files.</para> </listitem> </varlistentry> @@ -768,17 +768,17 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err </row> <row> <entry><literal>static</literal></entry> - <entry>The unit file is not enabled, and has no provisions for enabling in the <literal>[Install]</literal> unit file section.</entry> + <entry>The unit file is not enabled, and has no provisions for enabling in the [Install] unit file section.</entry> <entry>0</entry> </row> <row> <entry><literal>indirect</literal></entry> - <entry>The unit file itself is not enabled, but it has a non-empty <varname>Also=</varname> setting in the <literal>[Install]</literal> unit file section, listing other unit files that might be enabled, or it has an alias under a different name through a symlink that is not specified in <varname>Also=</varname>. For template unit files, an instance different than the one specified in <varname>DefaultInstance=</varname> is enabled.</entry> + <entry>The unit file itself is not enabled, but it has a non-empty <varname>Also=</varname> setting in the [Install] unit file section, listing other unit files that might be enabled, or it has an alias under a different name through a symlink that is not specified in <varname>Also=</varname>. For template unit files, an instance different than the one specified in <varname>DefaultInstance=</varname> is enabled.</entry> <entry>0</entry> </row> <row> <entry><literal>disabled</literal></entry> - <entry>The unit file is not enabled, but contains an <literal>[Install]</literal> section with installation instructions.</entry> + <entry>The unit file is not enabled, but contains an [Install] section with installation instructions.</entry> <entry>> 0</entry> </row> <row> diff --git a/man/systemd-sleep.conf.xml b/man/systemd-sleep.conf.xml index a6949b0c3b..1acf0e8905 100644 --- a/man/systemd-sleep.conf.xml +++ b/man/systemd-sleep.conf.xml @@ -105,7 +105,7 @@ <title>Options</title> <para>The following options can be configured in the - <literal>[Sleep]</literal> section of + [Sleep] section of <filename>/etc/systemd/sleep.conf</filename> or a <filename>sleep.conf.d</filename> file:</para> diff --git a/man/systemd-suspend.service.xml b/man/systemd-suspend.service.xml index 4f445123a7..e57000e09a 100644 --- a/man/systemd-suspend.service.xml +++ b/man/systemd-suspend.service.xml @@ -80,7 +80,7 @@ <para>Internally, this service will echo a string like <literal>mem</literal> into <filename>/sys/power/state</filename>, to trigger the actual system suspend. What exactly is written - where can be configured in the <literal>[Sleep]</literal> section + where can be configured in the [Sleep] section of <filename>/etc/systemd/sleep.conf</filename> or a <filename>sleep.conf.d</filename> file. See <citerefentry><refentrytitle>systemd-sleep.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>. diff --git a/man/systemd-system.conf.xml b/man/systemd-system.conf.xml index dd505c05f0..8cf5666f4b 100644 --- a/man/systemd-system.conf.xml +++ b/man/systemd-system.conf.xml @@ -58,7 +58,7 @@ <title>Options</title> <para>All options are configured in the - <literal>[Manager]</literal> section:</para> + [Manager] section:</para> <variablelist class='config-directives'> @@ -149,7 +149,7 @@ for details. During the first phase of the shutdown operation the system and service manager remains running and hence <varname>RuntimeWatchdogSec=</varname> is still honoured. In order to define a timeout on this first phase of system shutdown, configure <varname>JobTimeoutSec=</varname> and <varname>JobTimeoutAction=</varname> - in the <literal>[Unit]</literal> section of the <filename>shutdown.target</filename> unit. By default + in the [Unit] section of the <filename>shutdown.target</filename> unit. By default <varname>RuntimeWatchdogSec=</varname> defaults to 0 (off), and <varname>RebootWatchdogSec=</varname> to 10min. <varname>KExecWatchdogSec=</varname> may be used to additionally enable the watchdog when kexec is being executed rather than when rebooting. Note that if the kernel does not reset the watchdog on kexec (depending diff --git a/man/systemd.automount.xml b/man/systemd.automount.xml index fd65f5da79..29b9bb14e1 100644 --- a/man/systemd.automount.xml +++ b/man/systemd.automount.xml @@ -35,9 +35,9 @@ this unit type. See <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for the common options of all unit configuration files. The common - configuration items are configured in the generic <literal>[Unit]</literal> and - <literal>[Install]</literal> sections. The automount specific configuration options - are configured in the <literal>[Automount]</literal> section.</para> + configuration items are configured in the generic [Unit] and + [Install] sections. The automount specific configuration options + are configured in the [Automount] section.</para> <para>Automount units must be named after the automount directories they control. Example: the automount point <filename index="false">/home/lennart</filename> must be configured in a unit file diff --git a/man/systemd.device.xml b/man/systemd.device.xml index 84acf9001a..085fd62bce 100644 --- a/man/systemd.device.xml +++ b/man/systemd.device.xml @@ -36,8 +36,8 @@ <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for the common options of all unit configuration files. The common configuration items are configured in the generic - <literal>[Unit]</literal> and <literal>[Install]</literal> - sections. A separate <literal>[Device]</literal> section does not + [Unit] and [Install] + sections. A separate [Device] section does not exist, since no device-specific options may be configured.</para> <para>systemd will dynamically create device units for all kernel diff --git a/man/systemd.dnssd.xml b/man/systemd.dnssd.xml index 2fb0a8ee70..d7e6caddf1 100644 --- a/man/systemd.dnssd.xml +++ b/man/systemd.dnssd.xml @@ -64,7 +64,7 @@ <refsect1> <title>[Service] Section Options</title> - <para>The network service file contains a <literal>[Service]</literal> + <para>The network service file contains a [Service] section, which specifies a discoverable network service announced in a local network with Multicast DNS broadcasts.</para> diff --git a/man/systemd.link.xml b/man/systemd.link.xml index d7724a0a59..dc59ee4e9a 100644 --- a/man/systemd.link.xml +++ b/man/systemd.link.xml @@ -64,8 +64,8 @@ <title>[Match] Section Options</title> <para>A link file is said to match a device if all matches specified by the - <literal>[Match]</literal> section are satisfied. When a link file does not contain valid settings - in <literal>[Match]</literal> section, then the file will match all devices and + [Match] section are satisfied. When a link file does not contain valid settings + in [Match] section, then the file will match all devices and <command>systemd-udevd</command> warns about that. Hint: to avoid the warning and to make it clear that all interfaces shall be matched, add the following: <programlisting>OriginalName=*</programlisting> diff --git a/man/systemd.mount.xml b/man/systemd.mount.xml index 07feccb54a..f5a9d446e9 100644 --- a/man/systemd.mount.xml +++ b/man/systemd.mount.xml @@ -34,9 +34,9 @@ this unit type. See <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for the common options of all unit configuration files. The common - configuration items are configured in the generic <literal>[Unit]</literal> and - <literal>[Install]</literal> sections. The mount specific configuration options are - configured in the <literal>[Mount]</literal> section.</para> + configuration items are configured in the generic [Unit] and + [Install] sections. The mount specific configuration options are + configured in the [Mount] section.</para> <para>Additional options are listed in <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>, diff --git a/man/systemd.netdev.xml b/man/systemd.netdev.xml index e8c1c140cf..37659326e3 100644 --- a/man/systemd.netdev.xml +++ b/man/systemd.netdev.xml @@ -193,7 +193,7 @@ <title>[Match] Section Options</title> <para>A virtual network device is only created if the - <literal>[Match]</literal> section matches the current + [Match] section matches the current environment, or if the section is empty. The following keys are accepted:</para> @@ -259,7 +259,7 @@ <refsect1> <title>[NetDev] Section Options</title> - <para>The <literal>[NetDev]</literal> section accepts the + <para>The [NetDev] section accepts the following keys:</para> <variablelist class='network-directives'> @@ -290,7 +290,7 @@ <para>The maximum transmission unit in bytes to set for the device. The usual suffixes K, M, G are supported and are understood to the base of 1024. For <literal>tun</literal> or <literal>tap</literal> devices, <varname>MTUBytes=</varname> setting is not currently supported in - <literal>[NetDev]</literal> section. Please specify it in <literal>[Link]</literal> section of + [NetDev] section. Please specify it in [Link] section of corresponding <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry> files.</para> @@ -300,8 +300,8 @@ <term><varname>MACAddress=</varname></term> <listitem> <para>The MAC address to use for the device. For <literal>tun</literal> or <literal>tap</literal> - devices, setting <varname>MACAddress=</varname> in the <literal>[NetDev]</literal> section is not - supported. Please specify it in <literal>[Link]</literal> section of the corresponding + devices, setting <varname>MACAddress=</varname> in the [NetDev] section is not + supported. Please specify it in [Link] section of the corresponding <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry> file. If this option is not set, <literal>vlan</literal> devices inherit the MAC address of the physical interface. For other kind of netdevs, if this option is not set, then MAC address is @@ -316,7 +316,7 @@ <refsect1> <title>[Bridge] Section Options</title> - <para>The <literal>[Bridge]</literal> section only applies for + <para>The [Bridge] section only applies for netdevs of kind <literal>bridge</literal>, and accepts the following keys:</para> @@ -436,7 +436,7 @@ <refsect1> <title>[VLAN] Section Options</title> - <para>The <literal>[VLAN]</literal> section only applies for + <para>The [VLAN] section only applies for netdevs of kind <literal>vlan</literal>, and accepts the following key:</para> @@ -488,7 +488,7 @@ <refsect1> <title>[MACVLAN] Section Options</title> - <para>The <literal>[MACVLAN]</literal> section only applies for + <para>The [MACVLAN] section only applies for netdevs of kind <literal>macvlan</literal>, and accepts the following key:</para> @@ -510,15 +510,15 @@ <refsect1> <title>[MACVTAP] Section Options</title> - <para>The <literal>[MACVTAP]</literal> section applies for + <para>The [MACVTAP] section applies for netdevs of kind <literal>macvtap</literal> and accepts the - same key as <literal>[MACVLAN]</literal>.</para> + same key as [MACVLAN].</para> </refsect1> <refsect1> <title>[IPVLAN] Section Options</title> - <para>The <literal>[IPVLAN]</literal> section only applies for + <para>The [IPVLAN] section only applies for netdevs of kind <literal>ipvlan</literal>, and accepts the following key:</para> @@ -545,15 +545,15 @@ <refsect1> <title>[IPVTAP] Section Options</title> - <para>The <literal>[IPVTAP]</literal> section only applies for + <para>The [IPVTAP] section only applies for netdevs of kind <literal>ipvtap</literal> and accepts the - same key as <literal>[IPVLAN]</literal>.</para> + same key as [IPVLAN].</para> </refsect1> <refsect1> <title>[VXLAN] Section Options</title> - <para>The <literal>[VXLAN]</literal> section only applies for + <para>The [VXLAN] section only applies for netdevs of kind <literal>vxlan</literal>, and accepts the following keys:</para> @@ -739,7 +739,7 @@ <refsect1> <title>[GENEVE] Section Options</title> - <para>The <literal>[GENEVE]</literal> section only applies for + <para>The [GENEVE] section only applies for netdevs of kind <literal>geneve</literal>, and accepts the following keys:</para> @@ -765,7 +765,7 @@ <varlistentry> <term><varname>TTL=</varname></term> <listitem> - <para>Accepts the same values as in the <literal>[VXLAN]</literal> section, except that when unset + <para>Accepts the same values as in the [VXLAN] section, except that when unset or set to 0, the kernel's default will be used, meaning that packet TTL will be set from <filename>/proc/sys/net/ipv4/ip_default_ttl</filename>.</para> </listitem> @@ -805,7 +805,7 @@ <varlistentry> <term><varname>IPDoNotFragment=</varname></term> <listitem> - <para>Accepts the same key in <literal>[VXLAN]</literal> section.</para> + <para>Accepts the same key in [VXLAN] section.</para> </listitem> </varlistentry> </variablelist> @@ -814,7 +814,7 @@ <refsect1> <title>[L2TP] Section Options</title> - <para>The <literal>[L2TP]</literal> section only applies for + <para>The [L2TP] section only applies for netdevs of kind <literal>l2tp</literal>, and accepts the following keys:</para> @@ -898,7 +898,7 @@ <refsect1> <title>[L2TPSession] Section Options</title> - <para>The <literal>[L2TPSession]</literal> section only applies for + <para>The [L2TPSession] section only applies for netdevs of kind <literal>l2tp</literal>, and accepts the following keys:</para> <variablelist class='network-directives'> @@ -936,7 +936,7 @@ <refsect1> <title>[MACsec] Section Options</title> - <para>The <literal>[MACsec]</literal> section only applies for network devices of kind + <para>The [MACsec] section only applies for network devices of kind <literal>macsec</literal>, and accepts the following keys:</para> <variablelist class='network-directives'> @@ -959,7 +959,7 @@ <refsect1> <title>[MACsecReceiveChannel] Section Options</title> - <para>The <literal>[MACsecReceiveChannel]</literal> section only applies for network devices of + <para>The [MACsecReceiveChannel] section only applies for network devices of kind <literal>macsec</literal>, and accepts the following keys:</para> <variablelist class='network-directives'> @@ -985,7 +985,7 @@ <refsect1> <title>[MACsecTransmitAssociation] Section Options</title> - <para>The <literal>[MACsecTransmitAssociation]</literal> section only applies for network devices + <para>The [MACsecTransmitAssociation] section only applies for network devices of kind <literal>macsec</literal>, and accepts the following keys:</para> <variablelist class='network-directives'> @@ -1035,7 +1035,7 @@ <term><varname>UseForEncoding=</varname></term> <listitem> <para>Takes a boolean. If enabled, then the security association is used for encoding. Only - one <literal>[MACsecTransmitAssociation]</literal> section can enable this option. When enabled, + one [MACsecTransmitAssociation] section can enable this option. When enabled, <varname>Activate=yes</varname> is implied. Defaults to unset.</para> </listitem> </varlistentry> @@ -1045,7 +1045,7 @@ <refsect1> <title>[MACsecReceiveAssociation] Section Options</title> - <para>The <literal>[MACsecReceiveAssociation]</literal> section only applies for + <para>The [MACsecReceiveAssociation] section only applies for network devices of kind <literal>macsec</literal>, and accepts the following keys:</para> @@ -1053,43 +1053,43 @@ <varlistentry> <term><varname>Port=</varname></term> <listitem> - <para>Accepts the same key in <literal>[MACsecReceiveChannel]</literal> section.</para> + <para>Accepts the same key in [MACsecReceiveChannel] section.</para> </listitem> </varlistentry> <varlistentry> <term><varname>MACAddress=</varname></term> <listitem> - <para>Accepts the same key in <literal>[MACsecReceiveChannel]</literal> section.</para> + <para>Accepts the same key in [MACsecReceiveChannel] section.</para> </listitem> </varlistentry> <varlistentry> <term><varname>PacketNumber=</varname></term> <listitem> - <para>Accepts the same key in <literal>[MACsecTransmitAssociation]</literal> section.</para> + <para>Accepts the same key in [MACsecTransmitAssociation] section.</para> </listitem> </varlistentry> <varlistentry> <term><varname>KeyId=</varname></term> <listitem> - <para>Accepts the same key in <literal>[MACsecTransmitAssociation]</literal> section.</para> + <para>Accepts the same key in [MACsecTransmitAssociation] section.</para> </listitem> </varlistentry> <varlistentry> <term><varname>Key=</varname></term> <listitem> - <para>Accepts the same key in <literal>[MACsecTransmitAssociation]</literal> section.</para> + <para>Accepts the same key in [MACsecTransmitAssociation] section.</para> </listitem> </varlistentry> <varlistentry> <term><varname>KeyFile=</varname></term> <listitem> - <para>Accepts the same key in <literal>[MACsecTransmitAssociation]</literal> section.</para> + <para>Accepts the same key in [MACsecTransmitAssociation] section.</para> </listitem> </varlistentry> <varlistentry> <term><varname>Activate=</varname></term> <listitem> - <para>Accepts the same key in <literal>[MACsecTransmitAssociation]</literal> section.</para> + <para>Accepts the same key in [MACsecTransmitAssociation] section.</para> </listitem> </varlistentry> </variablelist> @@ -1098,7 +1098,7 @@ <refsect1> <title>[Tunnel] Section Options</title> - <para>The <literal>[Tunnel]</literal> section only applies for + <para>The [Tunnel] section only applies for netdevs of kind <literal>ipip</literal>, <literal>sit</literal>, @@ -1281,7 +1281,7 @@ <varlistentry> <term><varname>Encapsulation=</varname></term> <listitem> - <para>Accepts the same key as in the <literal>[FooOverUDP]</literal> section.</para> + <para>Accepts the same key as in the [FooOverUDP] section.</para> </listitem> </varlistentry> <varlistentry> @@ -1321,7 +1321,7 @@ <refsect1> <title>[FooOverUDP] Section Options</title> - <para>The <literal>[FooOverUDP]</literal> section only applies for + <para>The [FooOverUDP] section only applies for netdevs of kind <literal>fou</literal> and accepts the following keys:</para> @@ -1386,7 +1386,7 @@ <refsect1> <title>[Peer] Section Options</title> - <para>The <literal>[Peer]</literal> section only applies for + <para>The [Peer] section only applies for netdevs of kind <literal>veth</literal> and accepts the following keys:</para> @@ -1412,7 +1412,7 @@ <refsect1> <title>[VXCAN] Section Options</title> - <para>The <literal>[VXCAN]</literal> section only applies for + <para>The [VXCAN] section only applies for netdevs of kind <literal>vxcan</literal> and accepts the following key:</para> @@ -1430,7 +1430,7 @@ <refsect1> <title>[Tun] Section Options</title> - <para>The <literal>[Tun]</literal> section only applies for + <para>The [Tun] section only applies for netdevs of kind <literal>tun</literal>, and accepts the following keys:</para> @@ -1480,15 +1480,15 @@ <refsect1> <title>[Tap] Section Options</title> - <para>The <literal>[Tap]</literal> section only applies for + <para>The [Tap] section only applies for netdevs of kind <literal>tap</literal>, and accepts the same keys - as the <literal>[Tun]</literal> section.</para> + as the [Tun] section.</para> </refsect1> <refsect1> <title>[WireGuard] Section Options</title> - <para>The <literal>[WireGuard]</literal> section accepts the following + <para>The [WireGuard] section accepts the following keys:</para> <variablelist class='network-directives'> @@ -1535,7 +1535,7 @@ <refsect1> <title>[WireGuardPeer] Section Options</title> - <para>The <literal>[WireGuardPeer]</literal> section accepts the following + <para>The [WireGuardPeer] section accepts the following keys:</para> <variablelist class='network-directives'> @@ -1611,7 +1611,7 @@ <refsect1> <title>[Bond] Section Options</title> - <para>The <literal>[Bond]</literal> section accepts the following + <para>The [Bond] section accepts the following key:</para> <variablelist class='network-directives'> @@ -1891,7 +1891,7 @@ <refsect1> <title>[Xfrm] Section Options</title> - <para>The <literal>[Xfrm]</literal> section accepts the following + <para>The [Xfrm] section accepts the following keys:</para> <variablelist class='network-directives'> @@ -1919,7 +1919,7 @@ <refsect1> <title>[VRF] Section Options</title> - <para>The <literal>[VRF]</literal> section only applies for + <para>The [VRF] section only applies for netdevs of kind <literal>vrf</literal> and accepts the following key:</para> diff --git a/man/systemd.network.xml b/man/systemd.network.xml index 7e3b2953c0..88f00bdca6 100644 --- a/man/systemd.network.xml +++ b/man/systemd.network.xml @@ -72,21 +72,16 @@ <refsect1> <title>[Match] Section Options</title> - <para>The network file contains a <literal>[Match]</literal> - section, which determines if a given network file may be applied - to a given device; and a <literal>[Network]</literal> section - specifying how the device should be configured. The first (in - lexical order) of the network files that matches a given device - is applied, all later files are ignored, even if they match as - well.</para> - - <para>A network file is said to match a network interface if all matches specified by the - <literal>[Match]</literal> section are satisfied. When a network file does not contain valid - settings in <literal>[Match]</literal> section, then the file will match all interfaces and - <command>systemd-networkd</command> warns about that. Hint: to avoid the warning and to make it - clear that all interfaces shall be matched, add the following: - <programlisting>Name=*</programlisting> - The following keys are accepted:</para> + <para>The network file contains a [Match] section, which determines if a given network file may be + applied to a given device; and a [Network] section specifying how the device should be configured. The + first (in lexical order) of the network files that matches a given device is applied, all later files + are ignored, even if they match as well.</para> + + <para>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 the + file will match all interfaces and <command>systemd-networkd</command> warns about that. Hint: to avoid + the warning and to make it clear that all interfaces shall be matched, add the following: + <programlisting>Name=*</programlisting> The following keys are accepted:</para> <variablelist class='network-directives'> <xi:include href="systemd.link.xml" xpointer="mac-address" /> @@ -149,7 +144,7 @@ <refsect1> <title>[Link] Section Options</title> - <para> The <literal>[Link]</literal> section accepts the following keys:</para> + <para> The [Link] section accepts the following keys:</para> <variablelist class='network-directives'> <varlistentry> @@ -238,12 +233,11 @@ <refsect1> <title>[SR-IOV] Section Options</title> - <para>The <literal>[SR-IOV]</literal> section accepts the - following keys. Specify several <literal>[SR-IOV]</literal> - sections to configure several SR-IOVs. SR-IOV provides the ability to partition a single physical PCI resource - into virtual PCI functions which can then be injected into a VM. In the case of network VFs, SR-IOV improves - north-south network performance (that is, traffic with endpoints outside the host machine) by allowing traffic to - bypass the host machine’s network stack.</para> + <para>The [SR-IOV] section accepts the following keys. Specify several [SR-IOV] sections to configure + several SR-IOVs. SR-IOV provides the ability to partition a single physical PCI resource into virtual + PCI functions which can then be injected into a VM. In the case of network VFs, SR-IOV improves + north-south network performance (that is, traffic with endpoints outside the host machine) by allowing + traffic to bypass the host machine’s network stack.</para> <variablelist class='network-directives'> <varlistentry> @@ -326,7 +320,7 @@ <refsect1> <title>[Network] Section Options</title> - <para>The <literal>[Network]</literal> section accepts the following keys:</para> + <para>The [Network] section accepts the following keys:</para> <variablelist class='network-directives'> <varlistentry> @@ -355,16 +349,15 @@ specified through DHCP is not used for name resolution. See option <option>UseDomains=</option> below.</para> - <para>See the <literal>[DHCPv4]</literal> or <literal>[DHCPv6]</literal> section below for - further configuration options for the DHCP client support.</para> + <para>See the [DHCPv4] or [DHCPv6] sections below for further configuration options for the DHCP + client support.</para> </listitem> </varlistentry> <varlistentry> <term><varname>DHCPServer=</varname></term> <listitem> <para>Takes a boolean. If set to <literal>yes</literal>, DHCPv4 server will be started. Defaults - to <literal>no</literal>. Further settings for the DHCP - server may be set in the <literal>[DHCPServer]</literal> + to <literal>no</literal>. Further settings for the DHCP server may be set in the [DHCPServer] section described below.</para> </listitem> </varlistentry> @@ -727,8 +720,8 @@ forwarding is enabled, and to enable it otherwise. Cannot be enabled on bond devices and when link local addressing is disabled.</para> - <para>Further settings for the IPv6 RA support may be configured in the - <literal>[IPv6AcceptRA]</literal> section, see below.</para> + <para>Further settings for the IPv6 RA support may be configured in the [IPv6AcceptRA] section, see + below.</para> <para>Also see <ulink url="https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt">ip-sysctl.txt</ulink> in the kernel @@ -798,18 +791,15 @@ </varlistentry> <varlistentry> <term><varname>IPv6PrefixDelegation=</varname></term> - <listitem><para>Whether to enable or disable Router Advertisement sending on a link. - Allowed values are <literal>static</literal> which distributes prefixes as defined in - the <literal>[IPv6PrefixDelegation]</literal> and any <literal>[IPv6Prefix]</literal> - sections, <literal>dhcpv6</literal> which requests prefixes using a DHCPv6 client - configured for another link and any values configured in the - <literal>[IPv6PrefixDelegation]</literal> section while ignoring all static prefix - configuration sections, <literal>yes</literal> which uses both static configuration - and DHCPv6, and <literal>false</literal> which turns off IPv6 prefix delegation - altogether. Defaults to <literal>false</literal>. See the - <literal>[IPv6PrefixDelegation]</literal> and the <literal>[IPv6Prefix]</literal> - sections for more configuration options. - </para></listitem> + <listitem><para>Whether to enable or disable Router Advertisement sending on a link. Allowed + values are <literal>static</literal> which distributes prefixes as defined in the + [IPv6PrefixDelegation] and any [IPv6Prefix] sections, <literal>dhcpv6</literal> which requests + prefixes using a DHCPv6 client configured for another link and any values configured in the + [IPv6PrefixDelegation] section while ignoring all static prefix configuration sections, + <literal>yes</literal> which uses both static configuration and DHCPv6, and + <literal>false</literal> which turns off IPv6 prefix delegation altogether. Defaults to + <literal>false</literal>. See the [IPv6PrefixDelegation] and the [IPv6Prefix] sections for more + configuration options.</para></listitem> </varlistentry> <varlistentry> <term><varname>IPv6PDSubnetId=</varname></term> @@ -975,16 +965,15 @@ <refsect1> <title>[Address] Section Options</title> - <para>An <literal>[Address]</literal> section accepts the - following keys. Specify several <literal>[Address]</literal> + <para>An [Address] section accepts the following keys. Specify several [Address] sections to configure several addresses.</para> <variablelist class='network-directives'> <varlistentry> <term><varname>Address=</varname></term> <listitem> - <para>As in the <literal>[Network]</literal> section. This key is mandatory. Each - <literal>[Address]</literal> section can contain one <varname>Address=</varname> setting.</para> + <para>As in the [Network] section. This key is mandatory. Each [Address] section can contain one + <varname>Address=</varname> setting.</para> </listitem> </varlistentry> <varlistentry> @@ -1090,12 +1079,10 @@ <refsect1> <title>[Neighbor] Section Options</title> - <para>A <literal>[Neighbor]</literal> section accepts the - following keys. The neighbor section adds a permanent, static - entry to the neighbor table (IPv6) or ARP table (IPv4) for - the given hardware address on the links matched for the network. - Specify several <literal>[Neighbor]</literal> sections to configure - several static neighbors.</para> + <para>A [Neighbor] section accepts the following keys. The neighbor section adds a permanent, static + entry to the neighbor table (IPv6) or ARP table (IPv4) for the given hardware address on the links + matched for the network. Specify several [Neighbor] sections to configure several static neighbors. + </para> <variablelist class='network-directives'> <varlistentry> @@ -1116,11 +1103,10 @@ <refsect1> <title>[IPv6AddressLabel] Section Options</title> - <para>An <literal>[IPv6AddressLabel]</literal> section accepts the - following keys. Specify several <literal>[IPv6AddressLabel]</literal> - sections to configure several address labels. IPv6 address labels are - used for address selection. See <ulink url="https://tools.ietf.org/html/rfc3484">RFC 3484</ulink>. - Precedence is managed by userspace, and only the label itself is stored in the kernel</para> + <para>An [IPv6AddressLabel] section accepts the following keys. Specify several [IPv6AddressLabel] + sections to configure several address labels. IPv6 address labels are used for address selection. See + <ulink url="https://tools.ietf.org/html/rfc3484">RFC 3484</ulink>. Precedence is managed by userspace, + and only the label itself is stored in the kernel</para> <variablelist class='network-directives'> <varlistentry> @@ -1143,8 +1129,7 @@ <refsect1> <title>[RoutingPolicyRule] Section Options</title> - <para>An <literal>[RoutingPolicyRule]</literal> section accepts the - following keys. Specify several <literal>[RoutingPolicyRule]</literal> + <para>An [RoutingPolicyRule] section accepts the following keys. Specify several [RoutingPolicyRule] sections to configure several rules.</para> <variablelist class='network-directives'> @@ -1266,7 +1251,7 @@ <varlistentry> <term><varname>Gateway=</varname></term> <listitem> - <para>As in the <literal>[Network]</literal> section. This is mandatory.</para> + <para>As in the [Network] section. This is mandatory.</para> </listitem> </varlistentry> <varlistentry> @@ -1280,9 +1265,8 @@ <refsect1> <title>[Route] Section Options</title> - <para>The <literal>[Route]</literal> section accepts the - following keys. Specify several <literal>[Route]</literal> - sections to configure several routes.</para> + <para>The [Route] section accepts the following keys. Specify several [Route] sections to configure + several routes.</para> <variablelist class='network-directives'> <varlistentry> @@ -1467,8 +1451,7 @@ <refsect1> <title>[DHCPv4] Section Options</title> - <para>The <literal>[DHCPv4]</literal> section configures the - DHCPv4 client, if it is enabled with the + <para>The [DHCPv4] section configures the DHCPv4 client, if it is enabled with the <varname>DHCP=</varname> setting described above:</para> <variablelist class='network-directives'> @@ -1811,7 +1794,7 @@ <refsect1> <title>[DHCPv6] Section Options</title> - <para>The <literal>[DHCPv6]</literal> section configures the DHCPv6 client, if it is enabled with the + <para>The [DHCPv6] section configures the DHCPv6 client, if it is enabled with the <varname>DHCP=</varname> setting described above, or invoked by the IPv6 Router Advertisement:</para> <variablelist class='network-directives'> @@ -1819,7 +1802,7 @@ <term><varname>UseDNS=</varname></term> <term><varname>UseNTP=</varname></term> <listitem> - <para>As in the <literal>[DHCPv4]</literal> section.</para> + <para>As in the [DHCPv4] section.</para> </listitem> </varlistentry> @@ -1935,7 +1918,7 @@ <varlistentry> <term><varname>SendOption=</varname></term> <listitem> - <para>As in the <literal>[DHCPv4]</literal> section, however because DHCPv6 uses 16-bit fields to store + <para>As in the [DHCPv4] section, however because DHCPv6 uses 16-bit fields to store option numbers, the option number is an integer in the range 1..65536.</para> </listitem> </varlistentry> @@ -1969,9 +1952,8 @@ <refsect1> <title>[IPv6AcceptRA] Section Options</title> - <para>The <literal>[IPv6AcceptRA]</literal> section configures the IPv6 Router Advertisement - (RA) client, if it is enabled with the <varname>IPv6AcceptRA=</varname> setting described - above:</para> + <para>The [IPv6AcceptRA] section configures the IPv6 Router Advertisement (RA) client, if it is enabled + with the <varname>IPv6AcceptRA=</varname> setting described above:</para> <variablelist class='network-directives'> <varlistentry> @@ -2051,8 +2033,7 @@ <refsect1> <title>[DHCPServer] Section Options</title> - <para>The <literal>[DHCPServer]</literal> section contains - settings for the DHCP server, if enabled via the + <para>The [DHCPServer] section contains settings for the DHCP server, if enabled via the <varname>DHCPServer=</varname> option described above:</para> <variablelist class='network-directives'> @@ -2186,11 +2167,9 @@ <refsect1> <title>[IPv6PrefixDelegation] Section Options</title> - <para>The <literal>[IPv6PrefixDelegation]</literal> section contains - settings for sending IPv6 Router Advertisements and whether to act as - a router, if enabled via the <varname>IPv6PrefixDelegation=</varname> - option described above. IPv6 network prefixes are defined with one or - more <literal>[IPv6Prefix]</literal> sections.</para> + <para>The [IPv6PrefixDelegation] section contains settings for sending IPv6 Router Advertisements and + whether to act as a router, if enabled via the <varname>IPv6PrefixDelegation=</varname> option described + above. IPv6 network prefixes are defined with one or more [IPv6Prefix] sections.</para> <variablelist class='network-directives'> @@ -2234,32 +2213,26 @@ <term><varname>EmitDNS=</varname></term> <term><varname>DNS=</varname></term> - <listitem><para><varname>DNS=</varname> specifies a list of recursive DNS server IPv6 addresses - that are distributed via Router Advertisement messages when <varname>EmitDNS=</varname> is - true. <varname>DNS=</varname> also takes special value <literal>_link_local</literal>; in that - case the IPv6 link local address is distributed. If <varname>DNS=</varname> is empty, DNS - servers are read from the <literal>[Network]</literal> section. If the - <literal>[Network]</literal> section does not contain any DNS servers either, DNS servers from - the uplink with the highest priority default route are used. When <varname>EmitDNS=</varname> - is false, no DNS server information is sent in Router Advertisement messages. - <varname>EmitDNS=</varname> defaults to true. - </para></listitem> + <listitem><para><varname>DNS=</varname> specifies a list of recursive DNS server IPv6 addresses that + are distributed via Router Advertisement messages when <varname>EmitDNS=</varname> is + true. <varname>DNS=</varname> also takes special value <literal>_link_local</literal>; in that case + the IPv6 link local address is distributed. If <varname>DNS=</varname> is empty, DNS servers are read + from the [Network] section. If the [Network] section does not contain any DNS servers either, DNS + servers from the uplink with the highest priority default route are used. When + <varname>EmitDNS=</varname> is false, no DNS server information is sent in Router Advertisement + messages. <varname>EmitDNS=</varname> defaults to true.</para></listitem> </varlistentry> <varlistentry> <term><varname>EmitDomains=</varname></term> <term><varname>Domains=</varname></term> - <listitem><para>A list of DNS search domains distributed via Router - Advertisement messages when <varname>EmitDomains=</varname> is true. If - <varname>Domains=</varname> is empty, DNS search domains are read from the - <literal>[Network]</literal> section. If the <literal>[Network]</literal> - section does not contain any DNS search domains either, DNS search - domains from the uplink with the highest priority default route are - used. When <varname>EmitDomains=</varname> is false, no DNS search domain - information is sent in Router Advertisement messages. - <varname>EmitDomains=</varname> defaults to true. - </para></listitem> + <listitem><para>A list of DNS search domains distributed via Router Advertisement messages when + <varname>EmitDomains=</varname> is true. If <varname>Domains=</varname> is empty, DNS search domains + are read from the [Network] section. If the [Network] section does not contain any DNS search domains + either, DNS search domains from the uplink with the highest priority default route are used. When + <varname>EmitDomains=</varname> is false, no DNS search domain information is sent in Router + Advertisement messages. <varname>EmitDomains=</varname> defaults to true.</para></listitem> </varlistentry> <varlistentry> @@ -2295,13 +2268,11 @@ <varlistentry> <term><varname>Prefix=</varname></term> - <listitem><para>The IPv6 prefix that is to be distributed to hosts. - Similarly to configuring static IPv6 addresses, the setting is - configured as an IPv6 prefix and its prefix length, separated by a - <literal>/</literal> character. Use multiple - <literal>[IPv6Prefix]</literal> sections to configure multiple IPv6 - prefixes since prefix lifetimes, address autoconfiguration and onlink - status may differ from one prefix to another.</para></listitem> + <listitem><para>The IPv6 prefix that is to be distributed to hosts. Similarly to configuring static + IPv6 addresses, the setting is configured as an IPv6 prefix and its prefix length, separated by a + <literal>/</literal> character. Use multiple [IPv6Prefix] sections to configure multiple IPv6 + prefixes since prefix lifetimes, address autoconfiguration and onlink status may differ from one + prefix to another.</para></listitem> </varlistentry> <varlistentry> @@ -2324,7 +2295,7 @@ <refsect1> <title>[IPv6RoutePrefix] Section Options</title> - <para>One or more <literal>[IPv6RoutePrefix]</literal> sections contain the IPv6 + <para>One or more [IPv6RoutePrefix] sections contain the IPv6 prefix routes that are announced via Router Advertisements. See <ulink url="https://tools.ietf.org/html/rfc4191">RFC 4191</ulink> for further details.</para> @@ -2334,12 +2305,10 @@ <varlistentry> <term><varname>Route=</varname></term> - <listitem><para>The IPv6 route that is to be distributed to hosts. - Similarly to configuring static IPv6 routes, the setting is - configured as an IPv6 prefix routes and its prefix route length, - separated by a<literal>/</literal> character. Use multiple - <literal>[IPv6PrefixRoutes]</literal> sections to configure multiple IPv6 - prefix routes.</para></listitem> + <listitem><para>The IPv6 route that is to be distributed to hosts. Similarly to configuring static + IPv6 routes, the setting is configured as an IPv6 prefix routes and its prefix route length, + separated by a <literal>/</literal> character. Use multiple [IPv6PrefixRoutes] sections to configure + multiple IPv6 prefix routes.</para></listitem> </varlistentry> <varlistentry> @@ -2355,8 +2324,7 @@ <refsect1> <title>[Bridge] Section Options</title> - <para>The <literal>[Bridge]</literal> section accepts the - following keys.</para> + <para>The [Bridge] section accepts the following keys:</para> <variablelist class='network-directives'> <varlistentry> <term><varname>UnicastFlood=</varname></term> @@ -2482,17 +2450,14 @@ </refsect1> <refsect1> <title>[BridgeFDB] Section Options</title> - <para>The <literal>[BridgeFDB]</literal> section manages the - forwarding database table of a port and accepts the following - keys. Specify several <literal>[BridgeFDB]</literal> sections to - configure several static MAC table entries.</para> + <para>The [BridgeFDB] section manages the forwarding database table of a port and accepts the following + keys. Specify several [BridgeFDB] sections to configure several static MAC table entries.</para> <variablelist class='network-directives'> <varlistentry> <term><varname>MACAddress=</varname></term> <listitem> - <para>As in the <literal>[Network]</literal> section. This - key is mandatory.</para> + <para>As in the [Network] section. This key is mandatory.</para> </listitem> </varlistentry> <varlistentry> @@ -2535,8 +2500,8 @@ <refsect1> <title>[LLDP] Section Options</title> - <para>The <literal>[LLDP]</literal> section manages the Link Layer Discovery Protocol (LLDP) and accepts the - following keys.</para> + <para>The [LLDP] section manages the Link Layer Discovery Protocol (LLDP) and accepts the following + keys.</para> <variablelist class='network-directives'> <varlistentry> <term><varname>MUDURL=</varname></term> @@ -2557,8 +2522,8 @@ <refsect1> <title>[CAN] Section Options</title> - <para>The <literal>[CAN]</literal> section manages the Controller Area Network (CAN bus) and accepts the - following keys.</para> + <para>The [CAN] section manages the Controller Area Network (CAN bus) and accepts the + following keys:</para> <variablelist class='network-directives'> <varlistentry> <term><varname>BitRate=</varname></term> @@ -2636,7 +2601,7 @@ <refsect1> <title>[QDisc] Section Options</title> - <para>The <literal>[QDisc]</literal> section manages the traffic control queueing discipline (qdisc).</para> + <para>The [QDisc] section manages the traffic control queueing discipline (qdisc).</para> <variablelist class='network-directives'> <varlistentry> @@ -2653,10 +2618,10 @@ <refsect1> <title>[NetworkEmulator] Section Options</title> - <para>The <literal>[NetworkEmulator]</literal> section manages the queueing discipline (qdisc) of - the network emulator. It can be used to configure the kernel packet scheduler and simulate packet - delay and loss for UDP or TCP applications, or limit the bandwidth usage of a particular service to - simulate internet connections.</para> + <para>The [NetworkEmulator] section manages the queueing discipline (qdisc) of the network emulator. It + can be used to configure the kernel packet scheduler and simulate packet delay and loss for UDP or TCP + applications, or limit the bandwidth usage of a particular service to simulate internet connections. + </para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="qdisc-parent" /> @@ -2780,8 +2745,8 @@ <refsect1> <title>[PIE] Section Options</title> - <para>The <literal>[PIE]</literal> section manages the queueing discipline - (qdisc) of Proportional Integral controller-Enhanced (PIE).</para> + <para>The [PIE] section manages the queueing discipline (qdisc) of Proportional Integral + controller-Enhanced (PIE).</para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="qdisc-parent" /> @@ -2799,8 +2764,8 @@ <refsect1> <title>[StochasticFairBlue] Section Options</title> - <para>The <literal>[StochasticFairBlue]</literal> section manages the queueing discipline - (qdisc) of stochastic fair blue (sfb).</para> + <para>The [StochasticFairBlue] section manages the queueing discipline (qdisc) of stochastic fair blue + (sfb).</para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="qdisc-parent" /> @@ -2819,8 +2784,8 @@ <refsect1> <title>[StochasticFairnessQueueing] Section Options</title> - <para>The <literal>[StochasticFairnessQueueing]</literal> section manages the queueing discipline - (qdisc) of stochastic fairness queueing (sfq).</para> + <para>The [StochasticFairnessQueueing] section manages the queueing discipline (qdisc) of stochastic + fairness queueing (sfq).</para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="qdisc-parent" /> @@ -2837,8 +2802,8 @@ <refsect1> <title>[BFIFO] Section Options</title> - <para>The <literal>[BFIFO]</literal> section manages the queueing discipline (qdisc) of - Byte limited Packet First In First Out (bfifo).</para> + <para>The [BFIFO] section manages the queueing discipline (qdisc) of Byte limited Packet First In First + Out (bfifo).</para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="qdisc-parent" /> @@ -2859,8 +2824,8 @@ <refsect1> <title>[PFIFO] Section Options</title> - <para>The <literal>[PFIFO]</literal> section manages the queueing discipline (qdisc) of - Packet First In First Out (pfifo).</para> + <para>The [PFIFO] section manages the queueing discipline (qdisc) of Packet First In First Out + (pfifo).</para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="qdisc-parent" /> @@ -2880,8 +2845,8 @@ <refsect1> <title>[PFIFOHeadDrop] Section Options</title> - <para>The <literal>[PFIFOHeadDrop]</literal> section manages the queueing discipline (qdisc) of - Packet First In First Out Head Drop (pfifo_head_drop).</para> + <para>The [PFIFOHeadDrop] section manages the queueing discipline (qdisc) of Packet First In First Out + Head Drop (pfifo_head_drop).</para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="qdisc-parent" /> @@ -2890,15 +2855,15 @@ <varlistentry> <term><varname>PacketLimit=</varname></term> <listitem> - <para>As in <literal>[PFIFO]</literal> section.</para></listitem> + <para>As in [PFIFO] section.</para></listitem> </varlistentry> </variablelist> </refsect1> <refsect1> <title>[PFIFOFast] Section Options</title> - <para>The <literal>[PFIFOFast]</literal> section manages the queueing discipline (qdisc) of - Packet First In First Out Fast (pfifo_fast).</para> + <para>The [PFIFOFast] section manages the queueing discipline (qdisc) of Packet First In First Out Fast + (pfifo_fast).</para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="qdisc-parent" /> @@ -2908,8 +2873,8 @@ <refsect1> <title>[CAKE] Section Options</title> - <para>The <literal>[CAKE]</literal> section manages the queueing discipline (qdisc) of - Common Applications Kept Enhanced (CAKE).</para> + <para>The [CAKE] section manages the queueing discipline (qdisc) of Common Applications Kept Enhanced + (CAKE).</para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="qdisc-parent" /> @@ -2936,7 +2901,7 @@ <refsect1> <title>[ControlledDelay] Section Options</title> - <para>The <literal>[ControlledDelay]</literal> section manages the queueing discipline (qdisc) of + <para>The [ControlledDelay] section manages the queueing discipline (qdisc) of controlled delay (CoDel).</para> <variablelist class='network-directives'> @@ -2988,8 +2953,8 @@ <refsect1> <title>[DeficitRoundRobinScheduler] Section Options</title> - <para>The <literal>[DeficitRoundRobinScheduler]</literal> section manages the queueing discipline (qdisc) of - Deficit Round Robin Scheduler (DRR).</para> + <para>The [DeficitRoundRobinScheduler] section manages the queueing discipline (qdisc) of Deficit Round + Robin Scheduler (DRR).</para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="qdisc-parent" /> @@ -2999,8 +2964,8 @@ <refsect1> <title>[DeficitRoundRobinSchedulerClass] Section Options</title> - <para>The <literal>[DeficitRoundRobinSchedulerClass]</literal> section manages the traffic control class of - Deficit Round Robin Scheduler (DRR).</para> + <para>The [DeficitRoundRobinSchedulerClass] section manages the traffic control class of Deficit Round + Robin Scheduler (DRR).</para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="tclass-parent" /> @@ -3021,8 +2986,8 @@ <refsect1> <title>[EnhancedTransmissionSelection] Section Options</title> - <para>The <literal>[EnhancedTransmissionSelection]</literal> section manages the queueing discipline (qdisc) of - Enhanced Transmission Selection (ETS).</para> + <para>The [EnhancedTransmissionSelection] section manages the queueing discipline (qdisc) of Enhanced + Transmission Selection (ETS).</para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="qdisc-parent" /> @@ -3072,8 +3037,8 @@ <refsect1> <title>[GenericRandomEarlyDetection] Section Options</title> - <para>The <literal>[GenericRandomEarlyDetection]</literal> section manages the queueing discipline - (qdisc) of Generic Random Early Detection (GRED).</para> + <para>The [GenericRandomEarlyDetection] section manages the queueing discipline (qdisc) of Generic Random + Early Detection (GRED).</para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="qdisc-parent" /> @@ -3106,8 +3071,8 @@ <refsect1> <title>[FairQueueingControlledDelay] Section Options</title> - <para>The <literal>[FairQueueingControlledDelay]</literal> section manages the queueing discipline - (qdisc) of fair queuing controlled delay (FQ-CoDel).</para> + <para>The [FairQueueingControlledDelay] section manages the queueing discipline (qdisc) of fair queuing + controlled delay (FQ-CoDel).</para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="qdisc-parent" /> @@ -3183,8 +3148,8 @@ <refsect1> <title>[FairQueueing] Section Options</title> - <para>The <literal>[FairQueueing]</literal> section manages the queueing discipline - (qdisc) of fair queue traffic policing (FQ).</para> + <para>The [FairQueueing] section manages the queueing discipline (qdisc) of fair queue traffic policing + (FQ).</para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="qdisc-parent" /> @@ -3272,8 +3237,8 @@ <refsect1> <title>[TrivialLinkEqualizer] Section Options</title> - <para>The <literal>[TrivialLinkEqualizer]</literal> section manages the queueing discipline (qdisc) of - trivial link equalizer (teql).</para> + <para>The [TrivialLinkEqualizer] section manages the queueing discipline (qdisc) of trivial link + equalizer (teql).</para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="qdisc-parent" /> @@ -3293,8 +3258,8 @@ <refsect1> <title>[HierarchyTokenBucket] Section Options</title> - <para>The <literal>[HierarchyTokenBucket]</literal> section manages the queueing discipline (qdisc) of - hierarchy token bucket (htb).</para> + <para>The [HierarchyTokenBucket] section manages the queueing discipline (qdisc) of hierarchy token + bucket (htb).</para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="qdisc-parent" /> @@ -3320,8 +3285,8 @@ <refsect1> <title>[HierarchyTokenBucketClass] Section Options</title> - <para>The <literal>[HierarchyTokenBucketClass]</literal> section manages the traffic control class of - hierarchy token bucket (htb).</para> + <para>The [HierarchyTokenBucketClass] section manages the traffic control class of hierarchy token bucket + (htb).</para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="tclass-parent" /> @@ -3402,8 +3367,8 @@ <refsect1> <title>[HeavyHitterFilter] Section Options</title> - <para>The <literal>[HeavyHitterFilter]</literal> section manages the queueing discipline - (qdisc) of Heavy Hitter Filter (hhf).</para> + <para>The [HeavyHitterFilter] section manages the queueing discipline (qdisc) of Heavy Hitter Filter + (hhf).</para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="qdisc-parent" /> @@ -3422,8 +3387,8 @@ <refsect1> <title>[QuickFairQueueing] Section Options</title> - <para>The <literal>[QuickFairQueueing]</literal> section manages the queueing discipline - (qdisc) of Quick Fair Queueing (QFQ).</para> + <para>The [QuickFairQueueing] section manages the queueing discipline (qdisc) of Quick Fair Queueing + (QFQ).</para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="qdisc-parent" /> @@ -3433,8 +3398,8 @@ <refsect1> <title>[QuickFairQueueingClass] Section Options</title> - <para>The <literal>[QuickFairQueueingClass]</literal> section manages the traffic control class of - Quick Fair Queueing (qfq).</para> + <para>The [QuickFairQueueingClass] section manages the traffic control class of Quick Fair Queueing + (qfq).</para> <variablelist class='network-directives'> <xi:include href="tc.xml" xpointer="tclass-parent" /> @@ -3461,9 +3426,9 @@ <refsect1> <title>[BridgeVLAN] Section Options</title> - <para>The <literal>[BridgeVLAN]</literal> section manages the VLAN ID configuration of a bridge port and accepts - the following keys. Specify several <literal>[BridgeVLAN]</literal> sections to configure several VLAN entries. - The <varname>VLANFiltering=</varname> option has to be enabled, see <literal>[Bridge]</literal> section in + <para>The [BridgeVLAN] section manages the VLAN ID configuration of a bridge port and accepts the + following keys. Specify several [BridgeVLAN] sections to configure several VLAN entries. The + <varname>VLANFiltering=</varname> option has to be enabled, see the [Bridge] section in <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> <variablelist class='network-directives'> diff --git a/man/systemd.nspawn.xml b/man/systemd.nspawn.xml index 44d3bbc75b..4b37c5dc44 100644 --- a/man/systemd.nspawn.xml +++ b/man/systemd.nspawn.xml @@ -80,7 +80,7 @@ <refsect1> <title>[Exec] Section Options</title> - <para>Settings files may include an <literal>[Exec]</literal> + <para>Settings files may include an [Exec] section, which carries various execution parameters:</para> <variablelist class='nspawn-directives'> @@ -344,7 +344,7 @@ <refsect1> <title>[Files] Section Options</title> - <para>Settings files may include a <literal>[Files]</literal> + <para>Settings files may include a [Files] section, which carries various parameters configuring the file system of the container:</para> @@ -439,7 +439,7 @@ <refsect1> <title>[Network] Section Options</title> - <para>Settings files may include a <literal>[Network]</literal> + <para>Settings files may include a [Network] section, which carries various parameters configuring the network connectivity of the container:</para> diff --git a/man/systemd.path.xml b/man/systemd.path.xml index f6fe3d8388..604bf494ba 100644 --- a/man/systemd.path.xml +++ b/man/systemd.path.xml @@ -34,9 +34,9 @@ this unit type. See <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for the common options of all unit configuration files. The common - configuration items are configured in the generic <literal>[Unit]</literal> and - <literal>[Install]</literal> sections. The path specific configuration options are - configured in the <literal>[Path]</literal> section.</para> + configuration items are configured in the generic [Unit] and + [Install] sections. The path specific configuration options are + configured in the [Path] section.</para> <para>For each path file, a matching unit file must exist, describing the unit to activate when the path changes. By default, diff --git a/man/systemd.scope.xml b/man/systemd.scope.xml index b624ac5f93..449b90b484 100644 --- a/man/systemd.scope.xml +++ b/man/systemd.scope.xml @@ -89,7 +89,7 @@ <refsect1> <title>Options</title> - <para>Scope files may include a <literal>[Scope]</literal> + <para>Scope files may include a [Scope] section, which carries information about the scope and the units it contains. A number of options that may be used in this section are shared with other unit types. These options are @@ -97,7 +97,7 @@ <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry> and <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>. - The options specific to the <literal>[Scope]</literal> section + The options specific to the [Scope] section of scope units are the following:</para> <variablelist class='unit-directives'> diff --git a/man/systemd.service.xml b/man/systemd.service.xml index 8ddfec2b94..4e281ec6d4 100644 --- a/man/systemd.service.xml +++ b/man/systemd.service.xml @@ -35,9 +35,9 @@ <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for the common options of all unit configuration files. The common configuration items are configured in the generic - <literal>[Unit]</literal> and <literal>[Install]</literal> + [Unit] and [Install] sections. The service specific configuration options are - configured in the <literal>[Service]</literal> section.</para> + configured in the [Service] section.</para> <para>Additional options are listed in <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>, @@ -138,7 +138,7 @@ <refsect1> <title>Options</title> - <para>Service files must include a <literal>[Service]</literal> + <para>Service files must include a [Service] section, which carries information about the service and the process it supervises. A number of options that may be used in this section are shared with other unit types. These options are @@ -147,7 +147,7 @@ <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry> and <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>. - The options specific to the <literal>[Service]</literal> section + The options specific to the [Service] section of service units are the following:</para> <variablelist class='unit-directives'> @@ -1495,7 +1495,7 @@ ExecStart=/usr/sbin/simple-dbus-service WantedBy=multi-user.target</programlisting> <para>For <emphasis>bus-activatable</emphasis> services, do not - include a <literal>[Install]</literal> section in the systemd + include a [Install] section in the systemd service file, but use the <varname>SystemdService=</varname> option in the corresponding DBus service file, for example (<filename>/usr/share/dbus-1/system-services/org.example.simple-dbus-service.service</filename>):</para> diff --git a/man/systemd.slice.xml b/man/systemd.slice.xml index 7157dfa32d..5019bf9976 100644 --- a/man/systemd.slice.xml +++ b/man/systemd.slice.xml @@ -55,9 +55,9 @@ <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for the common options of all unit configuration files. The common configuration items are configured - in the generic <literal>[Unit]</literal> and <literal>[Install]</literal> sections. The + in the generic [Unit] and [Install] sections. The slice specific configuration options are configured in - the <literal>[Slice]</literal> section. Currently, only generic resource control settings + the [Slice] section. Currently, only generic resource control settings as described in <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry> are allowed. </para> diff --git a/man/systemd.socket.xml b/man/systemd.socket.xml index 0a9dfd2564..f989b99f95 100644 --- a/man/systemd.socket.xml +++ b/man/systemd.socket.xml @@ -35,9 +35,9 @@ this unit type. See <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for the common options of all unit configuration files. The common - configuration items are configured in the generic <literal>[Unit]</literal> and - <literal>[Install]</literal> sections. The socket specific configuration options are - configured in the <literal>[Socket]</literal> section.</para> + configuration items are configured in the generic [Unit] and + [Install] sections. The socket specific configuration options are + configured in the [Socket] section.</para> <para>Additional options are listed in <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>, diff --git a/man/systemd.special.xml b/man/systemd.special.xml index 5a825a3913..a948969a8f 100644 --- a/man/systemd.special.xml +++ b/man/systemd.special.xml @@ -297,7 +297,7 @@ this unit (or <filename>multi-user.target</filename>) during installation. This is best configured via <varname>WantedBy=graphical.target</varname> in the unit's - <literal>[Install]</literal> section.</para> + [Install] section.</para> </listitem> </varlistentry> <varlistentry> @@ -447,7 +447,7 @@ add <varname>Wants=</varname> dependencies for their unit to this unit during installation. This is best configured via <varname>WantedBy=multi-user.target</varname> in the unit's - <literal>[Install]</literal> section.</para> + [Install] section.</para> </listitem> </varlistentry> <varlistentry> @@ -505,7 +505,7 @@ applications get pulled in via <varname>Wants=</varname> dependencies from this unit. This is best configured via a <varname>WantedBy=paths.target</varname> in the path unit's - <literal>[Install]</literal> section.</para> + [Install] section.</para> </listitem> </varlistentry> <varlistentry> @@ -641,7 +641,7 @@ <para>Adding slice units to <filename>slices.target</filename> is generally not necessary. Instead, when some unit that uses <varname>Slice=</varname> is started, the specified slice will be started automatically. Adding - <varname>WantedBy=slices.target</varname> lines to the <literal>[Install]</literal> + <varname>WantedBy=slices.target</varname> lines to the [Install] section should only be done for units that need to be always active. In that case care needs to be taken to avoid creating a loop through the automatic dependencies on "parent" slices.</para> @@ -659,7 +659,7 @@ <varname>Wants=</varname> dependencies to this unit for their socket unit during installation. This is best configured via a <varname>WantedBy=sockets.target</varname> - in the socket unit's <literal>[Install]</literal> + in the socket unit's [Install] section.</para> </listitem> </varlistentry> @@ -742,7 +742,7 @@ applications get pulled in via <varname>Wants=</varname> dependencies from this unit. This is best configured via <varname>WantedBy=timers.target</varname> in the timer - unit's <literal>[Install]</literal> section.</para> + unit's [Install] section.</para> </listitem> </varlistentry> <varlistentry> @@ -1104,7 +1104,7 @@ <para>This target is active whenever any graphical session is running. It is used to stop user services which only apply to a graphical (X, Wayland, etc.) session when the session is terminated. Such services should have - <literal>PartOf=graphical-session.target</literal> in their <literal>[Unit]</literal> + <literal>PartOf=graphical-session.target</literal> in their [Unit] section. A target for a particular session (e. g. <filename>gnome-session.target</filename>) starts and stops <literal>graphical-session.target</literal> with diff --git a/man/systemd.swap.xml b/man/systemd.swap.xml index 6410b2fe5c..4b1f850af4 100644 --- a/man/systemd.swap.xml +++ b/man/systemd.swap.xml @@ -37,9 +37,9 @@ this unit type. See <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for the common options of all unit configuration files. The common - configuration items are configured in the generic <literal>[Unit]</literal> and - <literal>[Install]</literal> sections. The swap specific configuration options are - configured in the <literal>[Swap]</literal> section.</para> + configuration items are configured in the generic [Unit] and + [Install] sections. The swap specific configuration options are + configured in the [Swap] section.</para> <para>Additional options are listed in <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>, diff --git a/man/systemd.target.xml b/man/systemd.target.xml index 3052b17786..a706a4588a 100644 --- a/man/systemd.target.xml +++ b/man/systemd.target.xml @@ -34,8 +34,8 @@ <para>This unit type has no specific options. See <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for the common options of all unit configuration files. The common - configuration items are configured in the generic <literal>[Unit]</literal> and - <literal>[Install]</literal> sections. A separate <literal>[Target]</literal> section does not exist, + configuration items are configured in the generic [Unit] and + [Install] sections. A separate [Target] section does not exist, since no target-specific options may be configured.</para> <para>Target units do not offer any additional functionality on diff --git a/man/systemd.timer.xml b/man/systemd.timer.xml index 040b8e2893..5822402712 100644 --- a/man/systemd.timer.xml +++ b/man/systemd.timer.xml @@ -35,9 +35,9 @@ this unit type. See <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for the common options of all unit configuration files. The common - configuration items are configured in the generic <literal>[Unit]</literal> and - <literal>[Install]</literal> sections. The timer specific configuration options are - configured in the <literal>[Timer]</literal> section.</para> + configuration items are configured in the generic [Unit] and + [Install] sections. The timer specific configuration options are + configured in the [Timer] section.</para> <para>For each timer file, a matching unit file must exist, describing the unit to activate when the timer elapses. By diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml index a9399cc88a..af45900cd0 100644 --- a/man/systemd.unit.xml +++ b/man/systemd.unit.xml @@ -1639,7 +1639,7 @@ <refsect1> <title>[Install] Section Options</title> - <para>Unit files may include an <literal>[Install]</literal> section, which carries installation information for + <para>Unit files may include an [Install] section, which carries installation information for the unit. This section is not interpreted by <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> during runtime; it is used by the <command>enable</command> and <command>disable</command> commands of the diff --git a/man/timesyncd.conf.xml b/man/timesyncd.conf.xml index c64d015400..44694e8033 100644 --- a/man/timesyncd.conf.xml +++ b/man/timesyncd.conf.xml @@ -41,7 +41,7 @@ <refsect1> <title>Options</title> - <para>The following settings are configured in the <literal>[Time]</literal> section:</para> + <para>The following settings are configured in the [Time] section:</para> <variablelist class='network-directives'> |