Bug#1130177: systemd.link.5: Some remarks and a patch with editorial changes for this man page
Bjarni Ingi Gislason
bjarniig at simnet.is
Mon Mar 9 18:39:54 GMT 2026
Package: udev
Version: 260~rc2-1
Severity: minor
Tags: patch
Dear Maintainer,
>From "/usr/share/doc/debian/bug-reporting.txt.gz":
Don't file bugs upstream
If you file a bug in Debian, don't send a copy to the upstream software
maintainers yourself, as it is possible that the bug exists only in
Debian. If necessary, the maintainer of the package will forward the
bug upstream.
-.-
I do not send reports upstream if I have to get an account there.
The Debian maintainers have one already.
If I get a negative (or no) response from upstream, I send henceforth
bugs to Debian.
-.-
* What led up to the situation?
Checking for defects with a new version
test-[g|n]roff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z < "man page"
[Use
grep -n -e ' $' -e '\\~$' -e ' \\f.$' -e ' \\"' <file>
to find (most) trailing spaces.]
["test-groff" is a script in the repository for "groff"; is not shipped]
(local copy and "troff" slightly changed by me).
[The fate of "test-nroff" was decided in groff bug #55941.]
* What was the outcome of this action?
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ":
troff:<stdin>:1382: warning: [page 9, 7.4i (diversion '3tbd60,0', 0.0i)]: cannot adjust line in b adjust mode; overset by 1.2984n
troff:<stdin>:2372: warning: [page 16, 1.6i (diversion '3tbd10,2', 0.5i)]: cannot adjust line; underset by 2.8216n
troff:<stdin>:2618: warning: special character 'u1F4A3' not defined
troff:<stdin>:2618: warning: special character 'u1F4A5' not defined
troff:<stdin>:2618: warning: special character 'u1F9E8' not defined
Output from "test-nroff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ":
troff:<stdin>:1270: warning [page 1, line 624, diversion '3tbd44,0', line 1]: cannot break line in l adjust mode; overset by 2n
troff:<stdin>:1375: warning [page 1, line 624, diversion '3tbd59,0', line 1]: cannot break line in l adjust mode; overset by 1n
troff:<stdin>:1382: warning [page 1, line 624, diversion '3tbd60,0', line 1]: cannot break line in l adjust mode; overset by 3n
troff:<stdin>:2309: warning [page 1, line 1308, diversion '3tbd1,2', line 9]: cannot break line in l adjust mode; overset by 2n
troff:<stdin>:2618: warning: special character 'u1F4A3' not defined
troff:<stdin>:2618: warning: special character 'u1F4A5' not defined
troff:<stdin>:2618: warning: special character 'u1F9E8' not defined
troff:<stdin>:2629: warning [page 1, line 1580]: cannot break line in l adjust mode; overset by 27n
* What outcome did you expect instead?
No output (no warnings).
-.-
General remarks and further material, if a diff-file exist, are in the
attachments.
-- System Information:
Debian Release: forky/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.18.15+deb14-amd64 (SMP w/2 CPU threads; PREEMPT)
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1), LANGUAGE not set
Shell: /bin/sh linked to /usr/bin/dash
Init: sysvinit (via /sbin/init)
Versions of packages udev depends on:
ii libc6 2.42-13
ii libkmod2 34.2-2+b1
ii libsystemd-shared 260~rc2-1
ii libudev1 260~rc2-1
ii systemd [systemd-sysusers] 260~rc2-1
udev recommends no packages.
udev suggests no packages.
Versions of packages udev is related to:
ii systemd 260~rc2-1
-- no debconf information
-------------- next part --------------
Input file is systemd.link.5
Output from "mandoc -T lint systemd.link.5": (shortened list)
147 STYLE: input text line longer than 80 bytes:
1 WARNING: missing date, using "": TH
9 WARNING: skipping paragraph macro: PP after SH
2 WARNING: skipping paragraph macro: br after sp
1 WARNING: skipping paragraph macro: br before sp
-.-.
Output from
test-nroff -mandoc -t -Kutf8 -ww -z systemd.link.5: (shortened list)
1 cannot break line in l adjust mode; overset by 1n
1 cannot break line in l adjust mode; overset by 27n
2 cannot break line in l adjust mode; overset by 2n
1 cannot break line in l adjust mode; overset by 3n
1 special character 'u1F4A3' not defined
1 special character 'u1F4A5' not defined
1 special character 'u1F9E8' not defined
-.-.
Input file is systemd.link.5
Wrong distance (not two spaces) between sentences in the input file.
Separate the sentences and subordinate clauses; each begins on a new
line. See man-pages(7) ("Conventions for source file layout") and
"info groff" ("Input Conventions").
The best procedure is to always start a new sentence on a new line,
at least, if you are typing on a computer.
Remember coding: Only one command ("sentence") on each (logical) line.
E-mail: Easier to quote exactly the relevant lines.
Generally: Easier to edit the sentence.
Patches: Less unaffected text.
Search for two adjacent words is easier, when they belong to the same line,
and the same phrase.
The amount of space between sentences in the output can then be
controlled with the ".ss" request.
Mark a final abbreviation point as such by suffixing it with "\&".
Some sentences (etc.) do not begin on a new line.
Split (sometimes) lines after a punctuation mark; before a conjunction.
Lines with only one (or two) space(s) between sentences could be split,
so latter sentences begin on a new line.
Use
#!/usr/bin/sh
sed -e '/^\./n' \
-e 's/\([[:alpha:]]\)\. */\1.\n/g' $1
to split lines after a sentence period.
Check result with the difference between the formatted outputs.
See also the attachment "general.bugs"
[List of affected lines removed.]
-.-.
Split lines longer than 80 characters (fill completely
an A4 sized page line on a terminal)
into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.
Add "\:" to split the string for the output, "\<newline>" in the source.
[List of affected lines removed.]
Longest line is number 474 with 468 characters
If the hardware has a persistent MAC address, as most hardware should, and if it is used by the kernel, nothing is done\&. Otherwise, a new MAC address is generated which is guaranteed to be the same on every boot for the given machine and the given device, but which is otherwise random\&. This feature depends on ID_NET_NAME_* properties to exist for the link\&. On hardware where these properties are not set, the generation of a persistent MAC address will fail\&.
-.-.
Remove unnecessary double font change (e.g., \fR\fI) in a row or (better)
use a two-fonts macro.
224:\fBnetworkctl status \fR\fB\fIINTERFACE\fR\fR
226:\fBip \-d link show \fR\fB\fIINTERFACE\fR\fR\&. If the list is prefixed with a "!", the test is inverted\&. Some valid values are
1867:\fBethtool \-K \fR\fB\fIINTERFACE\fR\fR\fB tx\-scatter\-gather on|off\fR\&.
1875:\fBethtool \-K \fR\fB\fIINTERFACE\fR\fR\fB tx\-scatter\-gather\-fraglist on|off\fR\&.
1890:\fBethtool \-K \fR\fB\fIINTERFACE\fR\fR\fB tx\-tcp\-ecn\-segmentation on|off\fR\&.
1898:\fBethtool \-K \fR\fB\fIINTERFACE\fR\fR\fB tx\-tcp\-mangleid\-segmentation on|off\fR\&.
1943:\fBethtool \-K \fR\fB\fIINTERFACE\fR\fR\fB rx\-gro\-list on|off\fR\&.
1951:\fBethtool \-K \fR\fB\fIINTERFACE\fR\fR\fB rx\-udp\-gro\-forwarding on|off\fR\&.
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
[List of affected lines removed.]
-.-.
Use a hyphen between a number and the unit (name) "bit",
see "man-pages(7)", item "Terms to avoid".
600:Interface names must have a minimum length of 1 character and a maximum length of 15 characters, and may contain any 7bit ASCII character, with the exception of control characters,
-.-.
Use SI units, not abbreviations, bps -> bit/s
670:The speed to set for the device, the value is rounded down to the nearest Mbps. The usual suffixes K, M, G are supported and are understood to the base of 1000.
838:Speed (Mbps)
-.-.
No need for '\&' to be in front of a period (.),
if there is a character in front of it.
Remove with "sed -e 's/\(.\)\\&\./\1./g'".
[List of affected lines removed.]
-.-.
Only one space character is after a possible end of sentence
(after a punctuation, that can end a sentence).
[List of affected lines removed.]
-.-.
Remove quotes when there is a printable
but no space character between them
and the quotes are not for emphasis (markup),
for example as an argument to a macro.
systemd.link.5:2:.TH "SYSTEMD\&.LINK" "5" "" "systemd 260~rc2" "systemd.link"
systemd.link.5:22:.SH "NAME"
systemd.link.5:24:.SH "SYNOPSIS"
systemd.link.5:27:.SH "DESCRIPTION"
systemd.link.5:2269:.SH "SPECIFIERS"
systemd.link.5:2411:.SH "EXAMPLES"
systemd.link.5:2616:.SH "NOTES"
-.-.
Remove excessive "\&" when it has no functional purpose.
328:\m[blue]\fBSystem and Service Credentials\fR\m[]\&\s-2\u[2]\d\s+2
1920:\m[blue]\fBPartial Generic Segmentation Offload\fR\m[]\&\s-2\u[3]\d\s+2
-.-.
Use "\-" instead of "-" in web addresses.
2629:\%https://docs.kernel.org/networking/segmentation-offloads.html#partial-generic-segmentation-offload
-.-.
Put a (long) web address on a new output line to reduce the posibility of
splitting the address between two output lines.
Or inhibit hyphenation with "\%" in front of the name.
2624:\%https://systemd.io/CREDENTIALS
2629:\%https://docs.kernel.org/networking/segmentation-offloads.html#partial-generic-segmentation-offload
-.-.
Add "\&" after an ellipsis, when it does not end a sentence.
642:Specifies the device\*(Aqs number of transmit queues\&. An integer in the range 1\&...4096\&. When unset, the kernel\*(Aqs default will be used\&.
649:Specifies the device\*(Aqs number of receive queues\&. An integer in the range 1\&...4096\&. When unset, the kernel\*(Aqs default will be used\&.
656:Specifies the transmit queue length of the device in number of packets\&. An unsigned integer in the range 0\&...4294967294\&. When unset, the kernel\*(Aqs default will be used\&.
2024:Specifies the number of receive, transmit, other, or combined channels, respectively\&. Takes an unsigned integer in the range 1\&...4294967295 or
2033:Specifies the maximum number of pending packets in the NIC receive buffer, mini receive buffer, jumbo receive buffer, or transmit buffer, respectively\&. Takes an unsigned integer in the range 1\&...4294967295 or
2063:Specifies the maximum size of a Generic Segment Offload (GSO) packet the device should accept\&. The usual suffixes K, M, G are supported and are understood to the base of 1024\&. An unsigned integer in the range 1\&...65536\&. Defaults to unset\&.
2070:Specifies the maximum number of Generic Segment Offload (GSO) segments the device should accept\&. An unsigned integer in the range 1\&...65535\&. Defaults to unset\&.
2149:Specifies the number of SR\-IOV virtual functions\&. Takes an integer in the range 0\&...2147483647\&. Defaults to unset, and automatically determined from the values specified in the
2165:Specifies a Virtual Function (VF), lightweight PCIe function designed solely to move data in and out\&. Takes an integer in the range 0\&...2147483646\&. This option is compulsory\&.
2172:Specifies VLAN ID of the virtual function\&. Takes an integer in the range 1\&...4095\&.
2179:Specifies quality of service of the virtual function\&. Takes an integer in the range 1\&...4294967294\&.
2495:\&...
2506:\&...
2521:\&...
2534:\&...
2557:\&...
-.-.
Wrong distance (not two spaces) between sentences in the input file.
Separate the sentences and subordinate clauses; each begins on a new
line. See man-pages(7) ("Conventions for source file layout") and
"info groff" ("Input Conventions").
The best procedure is to always start a new sentence on a new line,
at least, if you are typing on a computer.
Remember coding: Only one command ("sentence") on each (logical) line.
E-mail: Easier to quote exactly the relevant lines.
Generally: Easier to edit the sentence.
Patches: Less unaffected text.
Search for two adjacent words is easier, when they belong to the same line,
and the same phrase.
The amount of space between sentences in the output can then be
controlled with the ".ss" request.
Mark a final abbreviation point as such by suffixing it with "\&".
Some sentences (etc.) do not begin on a new line.
Split (sometimes) lines after a punctuation mark; before a conjunction.
Lines with only one (or two) space(s) between sentences could be split,
so latter sentences begin on a new line.
Use
#!/usr/bin/sh
sed -e '/^\./n' \
-e 's/\([[:alpha:]]\)\. */\1.\n/g' $1
to split lines after a sentence period.
Check result with the difference between the formatted outputs.
See also the attachment "general.bugs"
[List of affected lines removed.]
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ":
troff:<stdin>:1382: warning: [page 9, 7.4i (diversion '3tbd60,0', 0.0i)]: cannot adjust line in b adjust mode; overset by 1.2984n
troff:<stdin>:2372: warning: [page 16, 1.6i (diversion '3tbd10,2', 0.5i)]: cannot adjust line; underset by 2.8216n
troff:<stdin>:2618: warning: special character 'u1F4A3' not defined
troff:<stdin>:2618: warning: special character 'u1F4A5' not defined
troff:<stdin>:2618: warning: special character 'u1F9E8' not defined
Output from "test-nroff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ":
troff:<stdin>:1270: warning [page 1, line 624, diversion '3tbd44,0', line 1]: cannot break line in l adjust mode; overset by 2n
troff:<stdin>:1375: warning [page 1, line 624, diversion '3tbd59,0', line 1]: cannot break line in l adjust mode; overset by 1n
troff:<stdin>:1382: warning [page 1, line 624, diversion '3tbd60,0', line 1]: cannot break line in l adjust mode; overset by 3n
troff:<stdin>:2309: warning [page 1, line 1308, diversion '3tbd1,2', line 9]: cannot break line in l adjust mode; overset by 2n
troff:<stdin>:2618: warning: special character 'u1F4A3' not defined
troff:<stdin>:2618: warning: special character 'u1F4A5' not defined
troff:<stdin>:2618: warning: special character 'u1F9E8' not defined
troff:<stdin>:2629: warning [page 1, line 1580]: cannot break line in l adjust mode; overset by 27n
-.-
Additionally:
Remove characters 'u1F4A3', 'u1F4A5', and 'u1F9E8'.
Remove multible format lines for a table.
-.-
Change "E\&.g\&." to "E.g." or "E.g.\&"
-.-
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
-.-
Tables:
Use the preprocessor 'tbl' to make tables.
Put data, that are wider than the header in the (centered) last column,
in a "T{...\nT}" block(, when the table gets wider than the output line).
Table headers, that are wider than any data in the corresponding column,
do not need to be centered, so left adjustment (l, L) is sufficient.
-------------- next part --------------
--- systemd.link.5 2026-03-09 03:40:47.327121406 +0000
+++ systemd.link.5.new 2026-03-09 18:18:52.207043029 +0000
@@ -1,5 +1,5 @@
'\" t
-.TH "SYSTEMD\&.LINK" "5" "" "systemd 260~rc2" "systemd.link"
+.TH SYSTEMD.LINK 5 "" "systemd 260~rc2" systemd.link
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -19,12 +19,12 @@
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
-.SH "NAME"
+.SH NAME
systemd.link \- Network device configuration
-.SH "SYNOPSIS"
+.SH SYNOPSIS
.PP
\fIlink\fR\&.link
-.SH "DESCRIPTION"
+.SH DESCRIPTION
.PP
A plain ini\-style text file that encodes configuration for matching network devices, used by
\fBsystemd-udevd\fR(8)
@@ -36,7 +36,7 @@ for a general description of the syntax\
.PP
Note that some distributions may incorporate
\&.link
-files in their early boot facilities (e\&.g\&. by including copies of the
+files in their early boot facilities (e.g. by including copies of the
\&.link
files in initramfs)\&. As such it may be necessary to take manual steps to ensure that any local changes are consistent with early\-boot storage facilities\&. The relevant distribution\-specific documentation should be consulted\&.
.PP
@@ -50,7 +50,7 @@ and
/run/systemd/network, and the local administration network directory
/etc/systemd/network\&. All configuration files are collectively sorted and processed in alphanumeric order, regardless of the directories in which they live\&. However, files with identical filenames replace each other\&. It is recommended that each filename is prefixed with a number smaller than
"70"
-(e\&.g\&.
+(e.g.\&
10\-eth0\&.link)\&. Otherwise, the default
\&.link
files or those generated by
@@ -97,7 +97,6 @@ for diagnosing problems with
\&.link
files\&.
.SH "[MATCH] SECTION OPTIONS"
-.PP
A link file is said to match an interface if all matches specified by the [Match] section are satisfied\&. When a link file does not contain valid settings in [Match] section, then the file will match all interfaces and
\fBsystemd\-udevd\fR
warns about that\&. Hint: to avoid the warning and to make it clear that all interfaces shall be matched, add the following:
@@ -120,7 +119,7 @@ A whitespace\-separated list of hardware
.PP
\fBcolon\-delimited hexadecimal\fR
.RS 4
-Each field must be one byte\&. E\&.g\&.
+Each field must be one byte\&. E.g.\&
"12:34:56:78:90:ab"
or
"AA:BB:CC:DD:EE:FF"\&.
@@ -130,7 +129,7 @@ Added in version 250\&.
.PP
\fBhyphen\-delimited hexadecimal\fR
.RS 4
-Each field must be one byte\&. E\&.g\&.
+Each field must be one byte\&. E.g.\&
"12\-34\-56\-78\-90\-ab"
or
"AA\-BB\-CC\-DD\-EE\-FF"\&.
@@ -140,7 +139,7 @@ Added in version 250\&.
.PP
\fBdot\-delimited hexadecimal\fR
.RS 4
-Each field must be two bytes\&. E\&.g\&.
+Each field must be two bytes\&. E.g.\&
"1234\&.5678\&.90ab"
or
"AABB\&.CCDD\&.EEFF"\&.
@@ -150,7 +149,7 @@ Added in version 250\&.
.PP
\fBIPv4 address format\fR
.RS 4
-E\&.g\&.
+E.g.\&
"127\&.0\&.0\&.1"
or
"192\&.168\&.0\&.1"\&.
@@ -160,7 +159,7 @@ Added in version 250\&.
.PP
\fBIPv6 address format\fR
.RS 4
-E\&.g\&.
+E.g.\&
"2001:0db8:85a3::8a2e:0370:7334"
or
"::1"\&.
@@ -325,7 +324,7 @@ Added in version 258\&.
Checks whether the specified credential was passed to the
systemd\-udevd\&.service
service\&. See
-\m[blue]\fBSystem and Service Credentials\fR\m[]\&\s-2\u[2]\d\s+2
+\m[blue]\fBSystem and Service Credentials\fR\m[]\s-2\u[2]\d\s+2
for details\&. When prefixed with an exclamation mark ("!"), the result is negated\&. If an empty string is assigned, the previously assigned value is cleared\&.
.sp
Added in version 252\&.
@@ -597,7 +596,7 @@ Note that specifying a name that the ker
or
"lan0"/"lan1"/"lan3"\&.
.sp
-Interface names must have a minimum length of 1 character and a maximum length of 15 characters, and may contain any 7bit ASCII character, with the exception of control characters,
+Interface names must have a minimum length of 1 character and a maximum length of 15 characters, and may contain any 7-bit ASCII character, with the exception of control characters,
":",
"/"
and
@@ -747,13 +746,13 @@ is specified\&. If specified without
\fIWakeOnLanPassword=\fR
option, then the password is read from the credential
"\fILINK\fR\&.link\&.wol\&.password"
-(e\&.g\&.,
+(e.g.,
"60\-foo\&.link\&.wol\&.password"), and if the credential not found, then read from
"wol\&.password"\&. See
\fIImportCredential=\fR/\fILoadCredential=\fR/\fISetCredential=\fR
in
\fBsystemd.exec\fR(5)
-for details\&. The password in the credential, must be 6 bytes in hex format with each byte separated by a colon (":") like an Ethernet MAC address, e\&.g\&.,
+for details\&. The password in the credential, must be 6 bytes in hex format with each byte separated by a colon (":") like an Ethernet MAC address, e.g.\&,
"aa:bb:cc:dd:ee:ff"\&.
.sp
Added in version 235\&.
@@ -770,7 +769,7 @@ Specifies the SecureOn password for Magi
\fBAF_UNIX\fR
stream socket, or the plain password\&. When a path to a regular file is specified, the password is read from it\&. When an
\fBAF_UNIX\fR
-stream socket is specified, a connection is made to it and the password is read from it\&. The password must be 6 bytes in hex format with each byte separated by a colon (":") like an Ethernet MAC address, e\&.g\&.,
+stream socket is specified, a connection is made to it and the password is read from it\&. The password must be 6 bytes in hex format with each byte separated by a colon (":") like an Ethernet MAC address, e.g.\&,
"aa:bb:cc:dd:ee:ff"\&. This implies
\fIWakeOnLan=secureon\fR\&. Defaults to unset, and the current value will not be changed\&.
.sp
@@ -840,130 +839,6 @@ T}:T{
Duplex Mode
T}
.T&
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
l l l.
T{
\fB10baset\-full\fR
@@ -1842,7 +1717,7 @@ T}:T{
T}
.TE
.sp 1
-By default, this is unset, i\&.e\&. all possible modes will be advertised\&. This option may be specified more than once, in which case all specified speeds and modes are advertised\&. If the empty string is assigned to this option, the list is reset, and all prior assignments have no effect\&.
+By default, this is unset, i.e.\& all possible modes will be advertised\&. This option may be specified more than once, in which case all specified speeds and modes are advertised\&. If the empty string is assigned to this option, the list is reset, and all prior assignments have no effect\&.
.sp
Added in version 240\&.
.RE
@@ -1917,7 +1792,7 @@ Added in version 232\&.
\fIPartialGenericSegmentationOffload=\fR
.RS 4
Takes a boolean\&. If set to true, Partial Generic Segmentation Offload (GSO_Partial) is enabled\&. See
-\m[blue]\fBPartial Generic Segmentation Offload\fR\m[]\&\s-2\u[3]\d\s+2
+\m[blue]\fBPartial Generic Segmentation Offload\fR\m[]\s-2\u[3]\d\s+2
for more details\&. When unset, the kernel\*(Aqs default will be used\&.
.sp
Added in version 258\&.
@@ -1963,7 +1838,7 @@ Added in version 232\&.
\fIReceivePacketSteeringCPUMask=\fR
.RS 4
Configures Receive Packet Steering (RPS) list of CPUs to which RPS may forward traffic\&. Takes a list of CPU indices or ranges separated by either whitespace or commas\&. Alternatively, takes the special value
-"all", which will include all available CPUs in the mask\&. CPU ranges are specified by the lower and upper CPU indices separated by a dash (e\&.g\&.
+"all", which will include all available CPUs in the mask\&. CPU ranges are specified by the lower and upper CPU indices separated by a dash (e.g.\&
"2\-6")\&. This option may be specified more than once, in which case the specified list of CPU ranges are merged\&. If an empty string is assigned, the list is reset, all assignments prior to this will have no effect\&. Defaults to unset and RPS CPU list is unchanged\&. To disable RPS when it was previously enabled, use the special value
"disable"\&.
.sp
@@ -2153,8 +2028,7 @@ settings in the [SR\-IOV] sections\&.
Added in version 251\&.
.RE
.SH "[SR\-IOV] SECTION OPTIONS"
-.PP
-SR\-IOV provides the ability to partition a single physical PCI resource into virtual PCI functions which can then be e\&.g\&. injected into a VM\&. In the case of network VFs, SR\-IOV reduces latency and CPU utilisation for north\-south network traffic (that is, traffic with endpoints outside the host machine), by allowing traffic to bypass the host machine\(cqs network stack\&.
+SR\-IOV provides the ability to partition a single physical PCI resource into virtual PCI functions which can then be e.g.\& injected into a VM\&. In the case of network VFs, SR\-IOV reduces latency and CPU utilisation for north\-south network traffic (that is, traffic with endpoints outside the host machine), by allowing traffic to bypass the host machine\(cqs network stack\&.
.PP
The presence of an [SR\-IOV] section in a \&.link file will cause the creation and configuration of the specified virtual function\&. Within a \&.network file, the specified virtual function will be configured, but must already exist\&. Specify several [SR\-IOV] sections to configure several SR\-IOVs\&.
.PP
@@ -2233,7 +2107,6 @@ Specifies the MAC address for the virtua
Added in version 251\&.
.RE
.SH "[ENERGYEFFICIENTETHERNET] SECTION OPTIONS"
-.PP
The [EnergyEfficientEthernet] section controls the Energy Efficient Ethernet (EEE) feature of the interface, and accepts the following keys\&.
.PP
\fIEnable=\fR
@@ -2259,21 +2132,19 @@ Added in version 258\&.
.PP
\fILinkMode=\fR
.RS 4
-Takes a list of link modes, e\&.g\&.
+Takes a list of link modes, e.g.\&
"1000baset\-full"\&. See the table for
\fIAdvertise=\fR
setting in [Link] section in the above for possible values\&. This configures the Energy Efficient Ethernet capable connection modes to be advertised\&. Defaults to unset, and the advertised modes will be unchanged\&.
.sp
Added in version 258\&.
.RE
-.SH "SPECIFIERS"
-.PP
+.SH SPECIFIERS
Some settings resolve specifiers which may be used to write generic unit files referring to runtime or unit parameters that are replaced when the unit files are loaded\&. Specifiers must be known and resolvable for the setting to be valid\&. The following specifiers are understood:
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
-.br
.B Table\ \&2.\ \&Specifiers available in unit files
.TS
allbox tab(:);
@@ -2286,20 +2157,6 @@ T}:T{
Details
T}
.T&
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
-l l l
l l l.
T{
"%a"
@@ -2408,8 +2265,7 @@ The operating system variant identifier
T}
.TE
.sp 1
-.SH "EXAMPLES"
-.PP
+.SH EXAMPLES
\fBExample\ \&1.\ \&/usr/lib/systemd/network/99\-default\&.link\fR
.PP
The link file
@@ -2476,7 +2332,7 @@ $ sudo udevadm trigger \-\-verbose \-\-s
.RE
.\}
.PP
-You may also need to stop the service that manages the network interface, e\&.g\&.
+You may also need to stop the service that manages the network interface, e.g.\&
\fBsystemd-networkd.service\fR(8)
or
NetworkManager\&.service
@@ -2611,11 +2467,10 @@ MACAddress=cb:a9:87:65:43:21
.RE
.\}
.SH "SEE ALSO"
-.PP
\fBsystemd-udevd.service\fR(8), \fBudevadm\fR(8), \fBsystemd.netdev\fR(5), \fBsystemd.network\fR(5), \fBsystemd-network-generator.service\fR(8)
-.SH "NOTES"
+.SH NOTES
.IP " 1." 4
-?????? Please note that those configuration files must be available at all times. If
+Please note that those configuration files must be available at all times. If
/usr/local/
is a separate partition, it may not be available during early boot, and must not be used for configuration.
.IP " 2." 4
@@ -2626,5 +2481,5 @@ System and Service Credentials
.IP " 3." 4
Partial Generic Segmentation Offload
.RS 4
-\%https://docs.kernel.org/networking/segmentation-offloads.html#partial-generic-segmentation-offload
+\%https://docs.kernel.org/networking/segmentation\-offloads.html#partial\-generic\-segmentation\-offload
.RE
-------------- next part --------------
Any program (person), that produces man pages, should check the output
for defects by using (both groff and nroff)
[gn]roff -mandoc -t -ww -b -z -K utf8 <man page>
To find trailing space use
grep -n -e ' $' -e ' \\f.$' -e ' \\"' <man page>
The same goes for man pages that are used as an input.
-.-
For a style guide use
mandoc -T lint
-.-
For general input conventions consult the man page "nroff(7)" (item
"Input conventions") or the Texinfo manual about the same item.
-.-
Any "autogenerator" should check its products with the above mentioned
'groff', 'mandoc', and additionally with 'nroff ...'.
It should also check its input files for too long (> 80) lines.
This is just a simple quality control measure.
The "autogenerator" may have to be corrected to get a better man page,
the source file may, and any additional file may.
-.-
Common defects:
Not removing trailing spaces (in in- and output).
The reason for these trailing spaces should be found and eliminated.
"git" has a "tool" to point out whitespace,
see for example "git-apply(1)" and git-config(1)")
-.-
Not beginning each input sentence on a new line.
Line length and patch size should thus be reduced when that has been fixed.
The script "reportbug" uses 'quoted-printable' encoding when a line is
longer than 1024 characters in an 'ascii' file.
See man-pages(7), item "semantic newline".
-.-
The difference between the formatted output of the original
and patched file can be seen with:
nroff -mandoc <file1> > <out1>
nroff -mandoc <file2> > <out2>
diff -d -u <out1> <out2>
and for groff, using
\"printf '%s\n%s\n' '.kern 0' '.ss 12 0' | groff -mandoc -Z - \"
instead of 'nroff -mandoc'
Add the option '-t', if the file contains a table.
Read the output from 'diff -d -u ...' with 'less -R' or similar.
-.-.
If 'man' (man-db) is used to check the manual for warnings,
the following must be set:
The option "-warnings=w"
The environmental variable:
export MAN_KEEP_STDERR=yes (or any non-empty value)
or
(produce only warnings):
export MANROFFOPT="-ww -b -z"
export MAN_KEEP_STDERR=yes (or any non-empty value)
-.-
More information about the Pkg-systemd-maintainers
mailing list