Bug#1071706: networkctl.1: some remarks and editorial changes for this man page
Bjarni Ingi Gislason
bjarniig at simnet.is
Fri May 24 02:17:56 BST 2024
Package: systemd
Version: 255.5-1
Severity: minor
Tags: patch
Dear Maintainer,
here are some notes and editorial fixes for the manual.
The patch is in the attachment.
-.-
The difference between the formatted outputs can be seen with:
nroff -man <file1> > <out1>
nroff -man <file2> > <out2>
diff -u <out1> <out2>
and for groff, using
"printf '%s\n%s\n' '.kern 0' '.ss 12 0' | groff -man -Z - "
instead of "nroff -man"
Add the option "-t", if the file contains a table.
Read the output of "diff -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 -z"
export MAN_KEEP_STDERR=yes (or any non-empty value)
-.-.
Output from "mandoc -T lint networkctl.1": (possibly shortened list)
mandoc: networkctl.1:2:22: WARNING: missing date, using "": TH
mandoc: networkctl.1:28:2: WARNING: skipping paragraph macro: PP after SH
mandoc: networkctl.1:33:85: STYLE: input text line longer than 80 bytes: for an introduction ...
mandoc: networkctl.1:35:2: WARNING: skipping paragraph macro: PP after SH
mandoc: networkctl.1:91:138: STYLE: input text line longer than 80 bytes: One of the bonding o...
mandoc: networkctl.1:98:128: STYLE: input text line longer than 80 bytes: The link has carrier...
mandoc: networkctl.1:105:185: STYLE: input text line longer than 80 bytes: The link has carrier...
mandoc: networkctl.1:112:82: STYLE: input text line longer than 80 bytes: The link has carrier...
mandoc: networkctl.1:119:176: STYLE: input text line longer than 80 bytes: The link has carrier...
mandoc: networkctl.1:185:149: STYLE: input text line longer than 80 bytes: Show information abo...
mandoc: networkctl.1:188:86: STYLE: input text line longer than 80 bytes: When no links are sp...
mandoc: networkctl.1:211:219: STYLE: input text line longer than 80 bytes: In the overall netwo...
mandoc: networkctl.1:278:105: STYLE: input text line longer than 80 bytes: Show numerical addre...
mandoc: networkctl.1:332:116: STYLE: input text line longer than 80 bytes: Renew dynamic config...
mandoc: networkctl.1:339:126: STYLE: input text line longer than 80 bytes: Send a FORCERENEW me...
mandoc: networkctl.1:346:104: STYLE: input text line longer than 80 bytes: Reconfigure network ...
mandoc: networkctl.1:350:97: STYLE: input text line longer than 80 bytes: corresponding to the...
mandoc: networkctl.1:365:88: STYLE: input text line longer than 80 bytes: file is found, then ...
mandoc: networkctl.1:382:100: STYLE: input text line longer than 80 bytes: files\&. If no netwo...
mandoc: networkctl.1:384:181: STYLE: input text line longer than 80 bytes: "@", it will be trea...
mandoc: networkctl.1:391:85: STYLE: input text line longer than 80 bytes: is specified, edit t...
mandoc: networkctl.1:419:2: WARNING: skipping paragraph macro: PP after SH
mandoc: networkctl.1:479:83: STYLE: input text line longer than 80 bytes: (for the shortest po...
mandoc: networkctl.1:506:2: WARNING: skipping paragraph macro: PP after SH
mandoc: networkctl.1:509:2: WARNING: skipping paragraph macro: PP after SH
-.-.
Mark a full stop (.) and the exclamation mark (!) with "\&",
if it does not mean an end of a sentence.
This is a preventive action,
the paragraph could be reshaped, e.g., after changes.
When typing, one does not always notice when the line wraps after the
period.
There are too many examples of input lines in manual pages,
that end with an abbreviation point.
This marking is robust, and independent of the position on the line.
It corresponds to "\ " in TeX, and to "@:" in Texinfo.
203: Gateway: 10\&.193\&.11\&.1 (CISCO SYSTEMS, INC\&.) on eth0
215:All links have unknown online status (i\&.e\&. there are no required links)\&.
260:enp0s25 00:e0:4c:00:00:00 GS1900 \&.\&.b\&.\&.\&.\&.\&.\&.\&.\&. 2 Port #2
332:Renew dynamic configurations e\&.g\&. addresses received from DHCP server\&. Takes interface name or index number\&.
498:Do not print the legend, i\&.e\&. column headers and the footer with hints\&.
-.-.
Wrong distance between sentences.
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.
N.B
The number of lines affected is too large to be in the patch.
31:\fBsystemd\-networkd\fR\&. Please refer to
40:Show a list of existing links and their status\&. If one or more
41:\fIPATTERN\fRs are specified, only links matching one of them are shown\&. If no further arguments are specified shows all links, otherwise just the specified links\&. Produces output similar to:
105:The link has carrier and addresses valid on the local link configured\&. For bond or bridge master this means that not all slave network interfaces have carrier but at least one does\&.
119:The link has carrier and routable address configured\&. For bond or bridge master it is not necessary for all slave network interfaces to have carrier, but at least one must\&.
185:Show information about the specified links: type, state, kernel module driver, hardware and IP address, configured DNS servers, etc\&. If one or more
188:When no links are specified, an overall network status is shown\&. Also see the option
203: Gateway: 10\&.193\&.11\&.1 (CISCO SYSTEMS, INC\&.) on eth0
211:In the overall network status, the online state depends on the individual online state of all required links\&. Managed links are required for online by default\&. In this case, the online state is one of the following:
215:All links have unknown online status (i\&.e\&. there are no required links)\&.
246:Show discovered LLDP (Link Layer Discovery Protocol) neighbors\&. If one or more
247:\fIPATTERN\fRs are specified only neighbors on those interfaces are shown\&. Otherwise shows discovered neighbors on all interfaces\&. Note that for this feature to work,
260:enp0s25 00:e0:4c:00:00:00 GS1900 \&.\&.b\&.\&.\&.\&.\&.\&.\&.\&. 2 Port #2
278:Show numerical address labels that can be used for address selection\&. This is the same information that
280:shows\&. See
311:Deletes virtual netdevs\&. Takes interface name or index number\&.
318:Bring devices up\&. Takes interface name or index number\&.
325:Bring devices down\&. Takes interface name or index number\&.
332:Renew dynamic configurations e\&.g\&. addresses received from DHCP server\&. Takes interface name or index number\&.
339:Send a FORCERENEW message to all connected clients, triggering DHCP reconfiguration\&. Takes interface name or index number\&.
346:Reconfigure network interfaces\&. Takes interface name or index number\&. Note that this does not reload
350:corresponding to the specified interface\&. So, if you edit config files, it is necessary to call
363:files\&. If a new
365:file is found, then the corresponding netdev is created\&. Note that even if an existing
369:does not update or remove the netdev\&. If a new, modified or removed
382:files\&. If no network config file matching the given name is found, a new one will be created under
383:/etc/\&. Specially, if the name is prefixed by
384:"@", it will be treated as a network interface, and editing will be performed on the network config files associated with it\&. Additionally, the interface name can be suffixed with
391:is specified, edit the drop\-in file instead of the main configuration file\&. Unless
399:files finishes\&. The same applies for
402:\fBsystemd-udevd\fR(8)\&. Note that the changed link settings are not automatically applied after reloading\&. To achieve that, trigger uevents for the corresponding interface\&. Refer to
411:Show network configuration files\&. This command honors the
448:\fBstatus\fR, controls the number of journal lines to show, counting from the most recent ones\&. Takes a positive integer argument\&. Defaults to 10\&.
477:Shows output formatted as JSON\&. Expects one of
498:Do not print the legend, i\&.e\&. column headers and the footer with hints\&.
-.-.
Split lines longer than 80 characters into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.
To many lines to include in the patch.
networkctl.1: line 33 length 85
for an introduction to the basic concepts, functionality, and configuration syntax\&.
networkctl.1: line 41 length 195
\fIPATTERN\fRs are specified, only links matching one of them are shown\&. If no further arguments are specified shows all links, otherwise just the specified links\&. Produces output similar to:
networkctl.1: line 91 length 138
One of the bonding or bridge slave network interfaces is in off, no\-carrier, or dormant state, and the master interface has no address\&.
networkctl.1: line 98 length 128
The link has carrier, or for bond or bridge master, all bonding or bridge slave network interfaces are enslaved to the master\&.
networkctl.1: line 105 length 185
The link has carrier and addresses valid on the local link configured\&. For bond or bridge master this means that not all slave network interfaces have carrier but at least one does\&.
networkctl.1: line 112 length 82
The link has carrier and is enslaved to bond or bridge master network interface\&.
networkctl.1: line 119 length 176
The link has carrier and routable address configured\&. For bond or bridge master it is not necessary for all slave network interfaces to have carrier, but at least one must\&.
networkctl.1: line 185 length 149
Show information about the specified links: type, state, kernel module driver, hardware and IP address, configured DNS servers, etc\&. If one or more
networkctl.1: line 188 length 86
When no links are specified, an overall network status is shown\&. Also see the option
networkctl.1: line 211 length 219
In the overall network status, the online state depends on the individual online state of all required links\&. Managed links are required for online by default\&. In this case, the online state is one of the following:
networkctl.1: line 247 length 170
\fIPATTERN\fRs are specified only neighbors on those interfaces are shown\&. Otherwise shows discovered neighbors on all interfaces\&. Note that for this feature to work,
networkctl.1: line 259 length 98
LINK CHASSIS ID SYSTEM NAME CAPS PORT ID PORT DESCRIPTION
networkctl.1: line 260 length 109
enp0s25 00:e0:4c:00:00:00 GS1900 \&.\&.b\&.\&.\&.\&.\&.\&.\&.\&. 2 Port #2
networkctl.1: line 278 length 105
Show numerical address labels that can be used for address selection\&. This is the same information that
networkctl.1: line 332 length 116
Renew dynamic configurations e\&.g\&. addresses received from DHCP server\&. Takes interface name or index number\&.
networkctl.1: line 339 length 126
Send a FORCERENEW message to all connected clients, triggering DHCP reconfiguration\&. Takes interface name or index number\&.
networkctl.1: line 346 length 104
Reconfigure network interfaces\&. Takes interface name or index number\&. Note that this does not reload
networkctl.1: line 350 length 97
corresponding to the specified interface\&. So, if you edit config files, it is necessary to call
networkctl.1: line 365 length 88
file is found, then the corresponding netdev is created\&. Note that even if an existing
networkctl.1: line 382 length 100
files\&. If no network config file matching the given name is found, a new one will be created under
networkctl.1: line 384 length 181
"@", it will be treated as a network interface, and editing will be performed on the network config files associated with it\&. Additionally, the interface name can be suffixed with
networkctl.1: line 391 length 85
is specified, edit the drop\-in file instead of the main configuration file\&. Unless
networkctl.1: line 402 length 187
\fBsystemd-udevd\fR(8)\&. Note that the changed link settings are not automatically applied after reloading\&. To achieve that, trigger uevents for the corresponding interface\&. Refer to
networkctl.1: line 448 length 152
\fBstatus\fR, controls the number of journal lines to show, counting from the most recent ones\&. Takes a positive integer argument\&. Defaults to 10\&.
networkctl.1: line 479 length 83
(for the shortest possible output without any redundant whitespace or line breaks),
-.-.
Remove unnecessary second font change in a row or (better) use a
two-fonts macro.
453:\fB\-\-drop\-in=\fR\fINAME\fR
475:\fB\-\-json=\fR\fIMODE\fR
-.-.
Output from "test-groff -b -mandoc -dAD=l -rF0 -rHY=0 -t -w w -z -K utf8":
troff: backtrace: file '<stdin>':197
troff:<stdin>:197: warning: special character 'u25CF' not defined
Character u25CF 'BLACK CIRCLE' changed to '\s+6\(bu\s-6' (bullet) in output
from 'groff'; for nroff 'O' is used (as character '\(ci' uses).
Preprocessor 'tbl' is used to get better organized tables.
-- System Information:
Debian Release: trixie/sid
APT prefers testing-proposed-updates
APT policy: (500, 'testing-proposed-updates'), (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.7.12-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 systemd depends on:
ii libacl1 2.3.2-2
ii libapparmor1 3.0.13-2
ii libaudit1 1:3.1.2-2
ii libblkid1 2.40.1-1
ii libc6 2.38-11
ii libcap2 1:2.66-5
ii libcryptsetup12 2:2.7.2-2
ii libfdisk1 2.40.1-1
ii libgcrypt20 1.10.3-3
ii libkmod2 31+20240202-2
ii liblz4-1 1.9.4-2
ii liblzma5 5.6.1+really5.4.5-1
ii libmount1 2.40.1-1
ii libpam0g 1.5.3-7
ii libseccomp2 2.5.5-1
ii libselinux1 3.5-2+b2
ii libssl3t64 3.2.1-3
ii libsystemd-shared 255.5-1
ii libsystemd0 255.5-1
ii libzstd1 1.5.5+dfsg2-2
ii mount 2.40.1-1
ii systemd-dev 255.5-1
Versions of packages systemd recommends:
ii dbus [default-dbus-system-bus] 1.14.10-4+b1
pn systemd-timesyncd | time-daemon <none>
Versions of packages systemd suggests:
ii libbpf1 1:1.4.1-1
ii libfido2-1 1.14.0-1+b2
ii libip4tc2 1.8.10-3
ii libp11-kit0 0.25.3-5
pn libpwquality1 <none>
pn libqrencode4 <none>
pn libtss2-esys-3.0.2-0 <none>
pn libtss2-mu-4.0.1-0 <none>
pn libtss2-rc0 <none>
pn libtss2-tcti-device0 <none>
pn polkitd <none>
pn systemd-boot <none>
pn systemd-container <none>
pn systemd-homed <none>
pn systemd-resolved <none>
pn systemd-userdbd <none>
Versions of packages systemd is related to:
pn dbus-user-session <none>
pn dracut <none>
ii initramfs-tools 0.142
pn libnss-systemd <none>
pn libpam-systemd <none>
ii udev 255.5-1
-- no debconf information
-------------- next part --------------
--- networkctl.1 2024-05-23 22:22:40.728486802 +0000
+++ networkctl.1.new 2024-05-24 01:04:30.571615161 +0000
@@ -23,34 +23,35 @@
networkctl \- Query or modify the status of network links
.SH "SYNOPSIS"
.HP \w'\fBnetworkctl\fR\ 'u
-\fBnetworkctl\fR [OPTIONS...] COMMAND [LINK...]
+.BR networkctl " [" \fIOPTIONS...\fP "] " \fICOMMAND\fP " [" \fILINK...\fP ]
.SH "DESCRIPTION"
-.PP
\fBnetworkctl\fR
may be used to query or modify the state of the network links as seen by
-\fBsystemd\-networkd\fR\&. Please refer to
+\fBsystemd\-networkd\fR. Please refer to
\fBsystemd-networkd.service\fR(8)
-for an introduction to the basic concepts, functionality, and configuration syntax\&.
+for an introduction to the basic concepts, functionality, and configuration syntax.
.SH "COMMANDS"
-.PP
The following commands are understood:
.PP
-\fBlist\fR [\fIPATTERN\&...\fR]
+\fBlist\fR [\fIPATTERN...\fR]
.RS 4
-Show a list of existing links and their status\&. If one or more
-\fIPATTERN\fRs are specified, only links matching one of them are shown\&. If no further arguments are specified shows all links, otherwise just the specified links\&. Produces output similar to:
+Show a list of existing links and their status. If one or more
+\fIPATTERN\fRs are specified, only links matching one of them are shown. If no further arguments are specified shows all links, otherwise just the specified links. Produces output similar to:
.sp
.if n \{\
.RS 4
.\}
.nf
-IDX LINK TYPE OPERATIONAL SETUP
- 1 lo loopback carrier unmanaged
- 2 eth0 ether routable configured
- 3 virbr0 ether no\-carrier unmanaged
- 4 virbr0\-nic ether off unmanaged
-
-4 links listed\&.
+.TS
+l l l l l.
+IDX LINK TYPE OPERATIONAL SETUP
+1 lo loopback carrier unmanaged
+2 eth0 ether routable configured
+3 virbr0 ether no\-carrier unmanaged
+4 virbr0\-nic ether off unmanaged
+.TE
+.sp
+4 links listed.
.fi
.if n \{\
.RE
@@ -60,65 +61,65 @@ The operational status is one of the fol
.PP
missing
.RS 4
-The device is missing\&.
+The device is missing.
.sp
-Added in version 245\&.
+Added in version 245.
.RE
.PP
off
.RS 4
-The device is powered down\&.
+The device is powered down.
.sp
-Added in version 240\&.
+Added in version 240.
.RE
.PP
no\-carrier
.RS 4
-The device is powered up, but does not yet have a carrier\&.
+The device is powered up, but does not yet have a carrier.
.sp
-Added in version 240\&.
+Added in version 240.
.RE
.PP
dormant
.RS 4
-The device has a carrier, but is not yet ready for normal traffic\&.
+The device has a carrier, but is not yet ready for normal traffic.
.sp
-Added in version 240\&.
+Added in version 240.
.RE
.PP
degraded\-carrier
.RS 4
-One of the bonding or bridge slave network interfaces is in off, no\-carrier, or dormant state, and the master interface has no address\&.
+One of the bonding or bridge slave network interfaces is in off, no\-carrier, or dormant state, and the master interface has no address.
.sp
-Added in version 242\&.
+Added in version 242.
.RE
.PP
carrier
.RS 4
-The link has carrier, or for bond or bridge master, all bonding or bridge slave network interfaces are enslaved to the master\&.
+The link has carrier, or for bond or bridge master, all bonding or bridge slave network interfaces are enslaved to the master.
.sp
-Added in version 240\&.
+Added in version 240.
.RE
.PP
degraded
.RS 4
-The link has carrier and addresses valid on the local link configured\&. For bond or bridge master this means that not all slave network interfaces have carrier but at least one does\&.
+The link has carrier and addresses valid on the local link configured. For bond or bridge master this means that not all slave network interfaces have carrier but at least one does.
.sp
-Added in version 240\&.
+Added in version 240.
.RE
.PP
enslaved
.RS 4
-The link has carrier and is enslaved to bond or bridge master network interface\&.
+The link has carrier and is enslaved to bond or bridge master network interface.
.sp
-Added in version 242\&.
+Added in version 242.
.RE
.PP
routable
.RS 4
-The link has carrier and routable address configured\&. For bond or bridge master it is not necessary for all slave network interfaces to have carrier, but at least one must\&.
+The link has carrier and routable address configured. For bond or bridge master it is not necessary for all slave network interfaces to have carrier, but at least one must.
.sp
-Added in version 240\&.
+Added in version 240.
.RE
.sp
The setup status is one of the following:
@@ -126,232 +127,247 @@ The setup status is one of the following
pending
.RS 4
\fBsystemd-udevd\fR(8)
-is still processing the link, we don\*(Aqt yet know if we will manage it\&.
+is still processing the link, we don\*(Aqt yet know if we will manage it.
.sp
-Added in version 240\&.
+Added in version 240.
.RE
.PP
initialized
.RS 4
\fBsystemd-udevd\fR(8)
-has processed the link, but we don\*(Aqt yet know if we will manage it\&.
+has processed the link, but we don\*(Aqt yet know if we will manage it.
.sp
-Added in version 251\&.
+Added in version 251.
.RE
.PP
configuring
.RS 4
-Configuration for the link is being retrieved or the link is being configured\&.
+Configuration for the link is being retrieved or the link is being configured.
.sp
-Added in version 240\&.
+Added in version 240.
.RE
.PP
configured
.RS 4
-Link has been configured successfully\&.
+Link has been configured successfully.
.sp
-Added in version 240\&.
+Added in version 240.
.RE
.PP
unmanaged
.RS 4
\fBsystemd\-networkd\fR
-is not handling the link\&.
+is not handling the link.
.sp
-Added in version 240\&.
+Added in version 240.
.RE
.PP
failed
.RS 4
\fBsystemd\-networkd\fR
-failed to configure the link\&.
+failed to configure the link.
.sp
-Added in version 240\&.
+Added in version 240.
.RE
.PP
linger
.RS 4
The link is gone, but has not yet been dropped by
-\fBsystemd\-networkd\fR\&.
+\fBsystemd\-networkd\fR.
.sp
-Added in version 240\&.
+Added in version 240.
.RE
.sp
-Added in version 219\&.
+Added in version 219.
.RE
.PP
-\fBstatus\fR [\fIPATTERN\&...\fR]
+\fBstatus\fR [\fIPATTERN...\fR]
.RS 4
-Show information about the specified links: type, state, kernel module driver, hardware and IP address, configured DNS servers, etc\&. If one or more
-\fIPATTERN\fRs are specified, only links matching one of them are shown\&.
+Show information about the specified links: type, state, kernel module driver, hardware and IP address, configured DNS servers, etc. If one or more
+\fIPATTERN\fRs are specified, only links matching one of them are shown.
.sp
-When no links are specified, an overall network status is shown\&. Also see the option
-\fB\-\-all\fR\&.
+When no links are specified, an overall network status is shown. Also see the option
+\fB\-\-all\fR.
.sp
Produces output similar to:
.sp
.if n \{\
.RS 4
.\}
-.nf
-??? State: routable
- Online state: online
- Address: 10\&.193\&.76\&.5 on eth0
- 192\&.168\&.122\&.1 on virbr0
- 169\&.254\&.190\&.105 on eth0
- fe80::5054:aa:bbbb:cccc on eth0
- Gateway: 10\&.193\&.11\&.1 (CISCO SYSTEMS, INC\&.) on eth0
- DNS: 8\&.8\&.8\&.8
- 8\&.8\&.4\&.4
-.fi
+.\"??? is Unicode 25CF or BLACK CIRCLE (GEOMETRIC SHAPES) (groff's text
+.\" marker for 'nroff' is O, LATIN CAPITAL LETTER O)
+.ie t \{\
+.ds ci \s+6\(bu\s-6 State:
+.\}
+.el \{\
+.ds ci O State:
+.\}
+.ne 10v
+.TS
+r l.
+\*(ci routable
+Online state: online
+Address: 10.193.76.5 on eth0
+ 192.168.122.1 on virbr0
+ 169.254.190.105 on eth0
+ fe80::5054:aa:bbbb:cccc on eth0
+Gateway: 10.193.11.1 (CISCO SYSTEMS, INC.\&) on eth0
+DNS: 8.8.8.8
+ 8.8.4.4
+.TE
.if n \{\
.RE
.\}
.sp
-In the overall network status, the online state depends on the individual online state of all required links\&. Managed links are required for online by default\&. In this case, the online state is one of the following:
+In the overall network status, the online state depends on the individual online state of all required links. Managed links are required for online by default. In this case, the online state is one of the following:
.PP
unknown
.RS 4
-All links have unknown online status (i\&.e\&. there are no required links)\&.
+All links have unknown online status (i.e.\& there are no required links).
.sp
-Added in version 249\&.
+Added in version 249.
.RE
.PP
offline
.RS 4
-All required links are offline\&.
+All required links are offline.
.sp
-Added in version 249\&.
+Added in version 249.
.RE
.PP
partial
.RS 4
-Some, but not all, required links are online\&.
+Some, but not all, required links are online.
.sp
-Added in version 249\&.
+Added in version 249.
.RE
.PP
online
.RS 4
-All required links are online\&.
+All required links are online.
.sp
-Added in version 249\&.
+Added in version 249.
.RE
.sp
-Added in version 219\&.
+Added in version 219.
.RE
.PP
-\fBlldp\fR [\fIPATTERN\&...\fR]
+\fBlldp\fR [\fIPATTERN...\fR]
.RS 4
-Show discovered LLDP (Link Layer Discovery Protocol) neighbors\&. If one or more
-\fIPATTERN\fRs are specified only neighbors on those interfaces are shown\&. Otherwise shows discovered neighbors on all interfaces\&. Note that for this feature to work,
+Show discovered LLDP (Link Layer Discovery Protocol) neighbors. If one or more
+\fIPATTERN\fRs are specified only neighbors on those interfaces are shown. Otherwise shows discovered neighbors on all interfaces. Note that for this feature to work,
\fILLDP=\fR
must be turned on for the specific interface, see
\fBsystemd.network\fR(5)
-for details\&.
+for details.
.sp
Produces output similar to:
.sp
.if n \{\
.RS 4
.\}
+.TS
+l2 l2 l l l l.
+LINK CHASSIS ID SYSTEM NAME CAPS PORT ID PORT DESCRIPTION
+enp0s25 00:e0:4c:00:00:00 GS1900 ..b....... 2 Port #2
+.TE
+.sp
.nf
-LINK CHASSIS ID SYSTEM NAME CAPS PORT ID PORT DESCRIPTION
-enp0s25 00:e0:4c:00:00:00 GS1900 \&.\&.b\&.\&.\&.\&.\&.\&.\&.\&. 2 Port #2
-
Capability Flags:
o \- Other; p \- Repeater; b \- Bridge; w \- WLAN Access Point; r \- Router;
t \- Telephone; d \- DOCSIS cable device; a \- Station; c \- Customer VLAN;
s \- Service VLAN, m \- Two\-port MAC Relay (TPMR)
-1 neighbors listed\&.
+1 neighbors listed.
.fi
.if n \{\
.RE
.\}
.sp
-Added in version 219\&.
+Added in version 219.
.RE
.PP
\fBlabel\fR
.RS 4
-Show numerical address labels that can be used for address selection\&. This is the same information that
+Show numerical address labels that can be used for address selection. This is the same information that
\fBip-addrlabel\fR(8)
-shows\&. See
+shows. See
\m[blue]\fBRFC 3484\fR\m[]\&\s-2\u[1]\d\s+2
-for a discussion of address labels\&.
+for a discussion of address labels.
.sp
Produces output similar to:
.sp
.if n \{\
.RS 4
.\}
-.nf
-Prefix/Prefixlen Label
- ::/0 1
- fc00::/7 5
- fec0::/10 11
- 2002::/16 2
- 3ffe::/16 12
- 2001:10::/28 7
- 2001::/32 6
-::ffff:0\&.0\&.0\&.0/96 4
- ::/96 3
- ::1/128 0
-.fi
+.TS
+l l
+l n.
+Prefix/Prefixlen Label
+::/0 1
+fc00::/7 5
+fec0::/10 11
+2002::/16 2
+3ffe::/16 12
+2001:10::/28 7
+2001::/32 6
+::ffff:0.0.0.0/96 4
+::/96 3
+::1/128 0
+.TE
.if n \{\
.RE
.\}
.sp
-Added in version 234\&.
+Added in version 234.
.RE
.PP
-\fBdelete\fR \fIDEVICE\&...\fR
+\fBdelete\fR \fIDEVICE...\fR
.RS 4
-Deletes virtual netdevs\&. Takes interface name or index number\&.
+Deletes virtual netdevs. Takes interface name or index number.
.sp
-Added in version 243\&.
+Added in version 243.
.RE
.PP
-\fBup\fR \fIDEVICE\&...\fR
+\fBup\fR \fIDEVICE...\fR
.RS 4
-Bring devices up\&. Takes interface name or index number\&.
+Bring devices up. Takes interface name or index number.
.sp
-Added in version 246\&.
+Added in version 246.
.RE
.PP
-\fBdown\fR \fIDEVICE\&...\fR
+\fBdown\fR \fIDEVICE...\fR
.RS 4
-Bring devices down\&. Takes interface name or index number\&.
+Bring devices down. Takes interface name or index number.
.sp
-Added in version 246\&.
+Added in version 246.
.RE
.PP
-\fBrenew\fR \fIDEVICE\&...\fR
+\fBrenew\fR \fIDEVICE...\fR
.RS 4
-Renew dynamic configurations e\&.g\&. addresses received from DHCP server\&. Takes interface name or index number\&.
+Renew dynamic configurations e.g.\& addresses received from DHCP server. Takes interface name or index number.
.sp
-Added in version 244\&.
+Added in version 244.
.RE
.PP
-\fBforcerenew\fR \fIDEVICE\&...\fR
+\fBforcerenew\fR \fIDEVICE...\fR
.RS 4
-Send a FORCERENEW message to all connected clients, triggering DHCP reconfiguration\&. Takes interface name or index number\&.
+Send a FORCERENEW message to all connected clients, triggering DHCP reconfiguration. Takes interface name or index number.
.sp
-Added in version 246\&.
+Added in version 246.
.RE
.PP
-\fBreconfigure\fR \fIDEVICE\&...\fR
+\fBreconfigure\fR \fIDEVICE...\fR
.RS 4
-Reconfigure network interfaces\&. Takes interface name or index number\&. Note that this does not reload
+Reconfigure network interfaces. Takes interface name or index number. Note that this does not reload
\&.netdev
or
\&.network
-corresponding to the specified interface\&. So, if you edit config files, it is necessary to call
+corresponding to the specified interface. So, if you edit config files, it is necessary to call
\fBnetworkctl reload\fR
-first to apply new settings\&.
+first to apply new settings.
.sp
-Added in version 244\&.
+Added in version 244.
.RE
.PP
\fBreload\fR
@@ -360,35 +376,35 @@ Reload
\&.netdev
and
\&.network
-files\&. If a new
+files. If a new
\&.netdev
-file is found, then the corresponding netdev is created\&. Note that even if an existing
+file is found, then the corresponding netdev is created. Note that even if an existing
\&.netdev
is modified or removed,
\fBsystemd\-networkd\fR
-does not update or remove the netdev\&. If a new, modified or removed
+does not update or remove the netdev. If a new, modified or removed
\&.network
-file is found, then all interfaces which match the file are reconfigured\&.
+file is found, then all interfaces which match the file are reconfigured.
.sp
-Added in version 244\&.
+Added in version 244.
.RE
.PP
-\fBedit\fR \fIFILE\fR|\fI at DEVICE\fR\&...
+\fBedit\fR \fIFILE\fR|\fI at DEVICE\fR...
.RS 4
Edit network configuration files, which include
\&.network,
\&.netdev, and
\&.link
-files\&. If no network config file matching the given name is found, a new one will be created under
-/etc/\&. Specially, if the name is prefixed by
-"@", it will be treated as a network interface, and editing will be performed on the network config files associated with it\&. Additionally, the interface name can be suffixed with
+files. If no network config file matching the given name is found, a new one will be created under
+/etc/. Specially, if the name is prefixed by
+"@", it will be treated as a network interface, and editing will be performed on the network config files associated with it. Additionally, the interface name can be suffixed with
":network"
(default) or
-":link", in order to choose the type of network config to operate on\&.
+":link", in order to choose the type of network config to operate on.
.sp
If
\fB\-\-drop\-in=\fR
-is specified, edit the drop\-in file instead of the main configuration file\&. Unless
+is specified, edit the drop\-in file instead of the main configuration file. Unless
\fB\-\-no\-reload\fR
is specified,
\fBsystemd\-networkd\fR
@@ -396,68 +412,67 @@ will be reloaded after the edit of the
\&.network
or
\&.netdev
-files finishes\&. The same applies for
+files finishes. The same applies for
\&.link
files and
-\fBsystemd-udevd\fR(8)\&. Note that the changed link settings are not automatically applied after reloading\&. To achieve that, trigger uevents for the corresponding interface\&. Refer to
+\fBsystemd-udevd\fR(8). Note that the changed link settings are not automatically applied after reloading. To achieve that, trigger uevents for the corresponding interface. Refer to
\fBsystemd.link\fR(5)
-for more information\&.
+for more information.
.sp
-Added in version 254\&.
+Added in version 254.
.RE
.PP
-\fBcat\fR \fIFILE\fR|\fI at DEVICE\fR\&...
+\fBcat\fR \fIFILE\fR|\fI at DEVICE\fR...
.RS 4
-Show network configuration files\&. This command honors the
+Show network configuration files. This command honors the
"@"
prefix in the same way as
-\fBedit\fR\&.
+\fBedit\fR.
.sp
-Added in version 254\&.
+Added in version 254.
.RE
.SH "OPTIONS"
-.PP
The following options are understood:
.PP
-\fB\-a\fR \fB\-\-all\fR
+\fB\-a\fR, \fB\-\-all\fR
.RS 4
Show all links with
-\fBstatus\fR\&.
+\fBstatus\fR.
.sp
-Added in version 219\&.
+Added in version 219.
.RE
.PP
-\fB\-s\fR \fB\-\-stats\fR
+\fB\-s\fR, \fB\-\-stats\fR
.RS 4
Show link statistics with
-\fBstatus\fR\&.
+\fBstatus\fR.
.sp
-Added in version 243\&.
+Added in version 243.
.RE
.PP
\fB\-l\fR, \fB\-\-full\fR
.RS 4
-Do not ellipsize the output\&.
+Do not ellipsize the output.
.sp
-Added in version 245\&.
+Added in version 245.
.RE
.PP
\fB\-n\fR, \fB\-\-lines=\fR
.RS 4
When used with
-\fBstatus\fR, controls the number of journal lines to show, counting from the most recent ones\&. Takes a positive integer argument\&. Defaults to 10\&.
+\fBstatus\fR, controls the number of journal lines to show, counting from the most recent ones. Takes a positive integer argument. Defaults to 10.
.sp
-Added in version 245\&.
+Added in version 245.
.RE
.PP
-\fB\-\-drop\-in=\fR\fINAME\fR
+.BI \-\-drop\-in= NAME
.RS 4
When used with
\fBedit\fR, edit the drop\-in file
\fINAME\fR
-instead of the main configuration file\&.
+instead of the main configuration file.
.sp
-Added in version 254\&.
+Added in version 254.
.RE
.PP
\fB\-\-no\-reload\fR
@@ -467,46 +482,44 @@ When used with
\fBsystemd-networkd.service\fR(8)
or
\fBsystemd-udevd.service\fR(8)
-will not be reloaded after the editing finishes\&.
+will not be reloaded after the editing finishes.
.sp
-Added in version 254\&.
+Added in version 254.
.RE
.PP
-\fB\-\-json=\fR\fIMODE\fR
+.BI \-\-json= MODE
.RS 4
-Shows output formatted as JSON\&. Expects one of
+Shows output formatted as JSON. Expects one of
"short"
(for the shortest possible output without any redundant whitespace or line breaks),
"pretty"
(for a pretty version of the same, with indentation and line breaks) or
"off"
-(to turn off JSON output, the default)\&.
+(to turn off JSON output, the default).
.RE
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
-Print a short help text and exit\&.
+Print a short help text and exit.
.RE
.PP
\fB\-\-version\fR
.RS 4
-Print a short version string and exit\&.
+Print a short version string and exit.
.RE
.PP
\fB\-\-no\-legend\fR
.RS 4
-Do not print the legend, i\&.e\&. column headers and the footer with hints\&.
+Do not print the legend, i.e.\& column headers and the footer with hints.
.RE
.PP
\fB\-\-no\-pager\fR
.RS 4
-Do not pipe output into a pager\&.
+Do not pipe output into a pager.
.RE
.SH "EXIT STATUS"
-.PP
-On success, 0 is returned, a non\-zero failure code otherwise\&.
+On success, 0 is returned, a non-zero failure code otherwise.
.SH "SEE ALSO"
-.PP
\fBsystemd-networkd.service\fR(8),
\fBsystemd.network\fR(5),
\fBsystemd.netdev\fR(5),
More information about the Pkg-systemd-maintainers
mailing list