Package: ifupdown
Version: 0.8.44
Severity: minor
Tags: patch
* 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=10 -ww -z < "man
page"
[Use "groff -e ' $' -e '\\~$' <file>" to find obvious 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?
troff:<stdin>:504: warning: trailing space in the line
an.tmac:<stdin>:755: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:761: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
* 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: trixie/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.12.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 ifupdown depends on:
ii adduser 3.137
ii iproute2 6.13.0-1
ii libc6 2.40-6
Versions of packages ifupdown recommends:
ii dhcpcd-base [dhcp-client] 1:10.1.0-3
ii isc-dhcp-client [dhcp-client] 4.4.3-P1-5+b1
Versions of packages ifupdown suggests:
pn ppp <none>
pn rdnssd <none>
-- Configuration Files:
/etc/init.d/networking changed [not included]
-- no debconf information
Input file is interfaces.5
Output from "mandoc -T lint interfaces.5": (shortened list)
1 input text line longer than 80 bytes: "source" and "source...
1 input text line longer than 80 bytes: A list of packages p...
1 input text line longer than 80 bytes: After all the interf...
1 input text line longer than 80 bytes: Another way to ensur...
1 input text line longer than 80 bytes: As such, a VLAN inte...
1 input text line longer than 80 bytes: However, if the inte...
1 input text line longer than 80 bytes: However, it is possi...
1 input text line longer than 80 bytes: However, other packa...
1 input text line longer than 80 bytes: If no VARIABLE is gi...
1 input text line longer than 80 bytes: Ifupdown uses per-in...
1 input text line longer than 80 bytes: It is therefore impo...
1 input text line longer than 80 bytes: It takes one or more...
1 input text line longer than 80 bytes: Keep in mind that pa...
1 input text line longer than 80 bytes: Lines beginning with...
1 input text line longer than 80 bytes: On GNU/Hurd, interfa...
1 input text line longer than 80 bytes: Please consult the d...
1 input text line longer than 80 bytes: Please note that thi...
2 input text line longer than 80 bytes: Request a prefix thr...
1 input text line longer than 80 bytes: So if an interface i...
1 input text line longer than 80 bytes: The OPTIONS field cu...
1 input text line longer than 80 bytes: The file consists of...
1 input text line longer than 80 bytes: The following exampl...
1 input text line longer than 80 bytes: There are four direc...
1 input text line longer than 80 bytes: These patterns can c...
1 input text line longer than 80 bytes: This becomes very po...
1 input text line longer than 80 bytes: This can either be d...
1 input text line longer than 80 bytes: This is a copy of th...
1 input text line longer than 80 bytes: This is mainly usefu...
1 input text line longer than 80 bytes: This manual page doc...
2 input text line longer than 80 bytes: This method is used ...
11 input text line longer than 80 bytes: This method may be u...
1 input text line longer than 80 bytes: This method uses ava...
1 input text line longer than 80 bytes: This method uses pon...
1 input text line longer than 80 bytes: This method uses wvd...
1 input text line longer than 80 bytes: To ensure an interfa...
1 input text line longer than 80 bytes: Valid variable names...
1 input text line longer than 80 bytes: When ifupdown is bei...
1 input text line longer than 80 bytes: and may require that...
1 input text line longer than 80 bytes: any pattern that sta...
1 input text line longer than 80 bytes: arping, avahi-autoip...
1 input text line longer than 80 bytes: as long as these cal...
1 input text line longer than 80 bytes: he above will match ...
1 input text line longer than 80 bytes: in which case all VL...
1 input text line longer than 80 bytes: in which case the va...
1 input text line longer than 80 bytes: is run, patterns are...
1 input text line longer than 80 bytes: option. (This optio...
1 input text line longer than 80 bytes: parameter (or "auto"...
1 input text line longer than 80 bytes: since VLAN interface...
1 input text line longer than 80 bytes: so it is not possibl...
1 input text line longer than 80 bytes: the interface eth0 a...
1 input text line longer than 80 bytes: when "ifup --allow h...
1 skipping paragraph macro: PP empty
20 whitespace at end of input line
-.-.
Output from "test-groff -mandoc -t -ww -z interfaces.5": (shortened list)
25 Use macro '.B' for one argument or split argument.
12 Use macro '.I' for one argument or split argument.
22 .BI is for at least 2 arguments, got 1
3 .BR is for at least 2 arguments, got 1
12 .IR is for at least 2 arguments, got 1
95 trailing space in the line
-.-.
Remove space characters (whitespace) at the end of lines.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".
Number of lines affected is
20
-.-.
Change two HYPHEN-MINUSES (code 0x2D) to an em-dash (\(em),
if one is intended.
" \(em " creates a too big gap in the text (in "troff").
An en-dash is usually surrounded by a space,
while an em-dash is used without spaces.
"man" (1 byte characters in input) transforms an en-dash (\(en) to one
HYPHEN-MINUS,
and an em-dash to two HYPHEN-MINUSES without considering the space
around it.
If "--" are two single "-"
(begin of an option or end of options)
then use "\-\-".
interfaces.5:293:The exception is when ifup is called with the --allow option,
interfaces.5:312:when "ifup --allow hotplug eth0" is called (either manually or
because udev triggers this when a network device is hotplugged),
interfaces.5:436:The physical name of the interface being processed, or "--all"
(see below).
-.-.
Use the correct macro for the font change of a single argument or
split the argument into two.
136:.IR /etc/network/interfaces.d
144:.BR script
150:.IR /usr/share/doc/ifupdown/examples
241:.BR ifup
243:.BR ifdown
409:.BI down
411:.BI post-down
413:.IR /etc/network/interfaces
415:.BI post\-up
417:.BI pre\-down
420:.IR if-up.d
422:.IR if-down.d
430:.BI down
432:.BI post-down
484:.BI ifup
486:.BI ifdown
540:.BI scope
704:.BI ll-attempts
707:.BI ll-interval
754:.BI scope
760:.BI dad-attempts
763:.BI dad-interval
796:.BI ll-attempts
799:.BI ll-interval
-.-.
Change a HYPHEN-MINUS (code 0x2D) to a minus(-dash) (\-),
if it
is in front of a name for an option,
is a symbol for standard input,
is a single character used to indicate an option,
or is in the NAME section (man-pages(7)).
N.B. - (0x2D), processed as a UTF-8 file, is changed to a hyphen
(0x2010, groff \[u2010] or \[hy]) in the output.
76:not be brought down by the command "ifdown -a". Its main use is to prevent an
293:The exception is when ifup is called with the --allow option,
312:when "ifup --allow hotplug eth0" is called (either manually or because udev
triggers this when a network device is hotplugged),
436:The physical name of the interface being processed, or "--all" (see below).
451:This is a copy of the value given to the \fB-\-allow\fP option when running
ifup or ifdown,
452:otherwise it is set to "auto" when the \fB-\-all\fP option is used.
523:Broadcast address (dotted quad, + or -) \fBdeprecated\fP. Default value: "+"
-.-.
Find a repeated word
! 899 --> the
-.-.
Strings longer than 3/4 of a standard line length (80)
Use "\:" to split the string at the end of an output line, for example a
long URLs (web address)
962 \fIhttp://www.debian.org/doc/manuals/debian-reference/ch05.en.html\fR
-.-.
Add a comma (or \&) after "e.g." and "i.e.", or use English words
(man-pages(7)).
Abbreviation points should be protected against being interpreted as
an end of sentence, if they are not, and that independent of the
current place on the line.
669:\fItype\fP of Ethernet frames to use (e.g. \fB802.2\fP)
681:\fItype\fP of Ethernet frames to use (e.g. \fB802.2\fP)
-.-.
Wrong distance 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.
N.B.
The number of lines affected can be too large to be in a patch.
45:Lines starting with `#' are ignored. Note that end-of-line comments are
52:"source" and "source-directory" stanzas. These will be described in more
detail in the following sections.
66:be brought up automatically by various subsystems. This may be done using
68:up eth0 or eth1 if it is listed in an "allow-hotplug" line. Note that
76:not be brought down by the command "ifdown -a". Its main use is to prevent an
79:until the very end. Note that you can still bring down the interface by
112:so configuration can be split into many files. The word "source" is
113:followed by the path of file to be sourced. Shell wildcards can be
120:without specifying them individually or using shell globs. Additionally,
122:the following regular expression: \fI^[a\-zA\-Z0\-9_\-]+$\fR. In other
words,
124:ASCII digits, ASCII underscores, and ASCII minus-hyphens. In the directory
path,
129:keyword is placed. In the example above, if the file is located at
148:stanza provided to it on its standard input. The script must print a
149:string on its standard output before exiting. See
205:is an IPv6 route advertisement daemon on the network). It can also be used
to
236:VALUE can contain wildcard patterns such as ? and *,
270:The OPTIONS field currently only supports a number. If given, only the n-th
interface that has a matching value will actually be used, where n is the
number given, starting at 1. So /eth*/1 will match the first interface whose
name starts with eth.
285:virtual LAN interface. For example, interface
390:for any interface during certain phases of ifup and ifdown commands. These
are:
414:file itself have been processed. Please note that as
523:Broadcast address (dotted quad, + or -) \fBdeprecated\fP. Default value: "+"
532:Address of other end point (dotted quad). Note the spelling of "point-to".
541:Address validity scope. Possible values: global, link, host
544:This method may be used to define interfaces for which no configuration is
done by default. Such interfaces can be configured manually by means of
\fBup\fP and \fBdown\fP commands or /etc/network/if-*.d scripts.
556:This method may be used to obtain an address via DHCP with any of the
tools: dhclient, udhcpc, dhcpcd. (They have been listed in their order of
precedence.) If you have a complicated DHCP setup you should note that some of
these clients use their own configuration files and do not obtain their
configuration information via \fBifup\fP.
595:This method is used to create GRE or IPIP tunnels. You need to have the
\fBip\fP binary from the \fBiproute\fP package. For GRE tunnels, you will need
to load the ip_gre module and the ipip module for IPIP tunnels.
628:This method uses pon/poff to configure a PPP interface. See those commands
for details.
643:This method uses wvdial to configure a PPP interface. See that command for
more details.
652:This method uses avahi-autoipd to configure an interface with an IPv4
Link-Layer address (169.254.0.0/16 family). This method is also known as APIPA
or IPAC, and often colloquially referred to as "Zeroconf address".
663:This method may be used to setup an IPX interface. It requires the
\fIipx_interface\fP command.
669:\fItype\fP of Ethernet frames to use (e.g. \fB802.2\fP)
681:\fItype\fP of Ethernet frames to use (e.g. \fB802.2\fP)
687:This method may be used to define interfaces with automatically assigned
IPv6 addresses. Using this method on its own doesn't mean that RDNSS options
will be applied, too. To make this happen, \fBrdnssd\fP daemon must be
installed, properly configured and running. If stateless DHCPv6 support is
turned on, then additional network configuration parameters such as DNS and NTP
servers will be retrieved from a DHCP server. Please note that on ifdown, the
lease is not currently released (a known bug).
696:Accept router advertisements (0=off, 1=on, 2=on+forwarding). Default value:
"2"
702:Request a prefix through DHCPv6 Prefix Delegation (0=off, 1=on). Default
value: "0"
705:Number of attempts to wait for a link-local address. Default value: "60"
708:Link-local address polling interval in seconds. Default value: "0.1"
719:This method may be used to define interfaces with statically assigned IPv6
addresses. By default, stateless autoconfiguration is disabled for this
interface.
749:Perform stateless autoconfiguration (0=off, 1=on). Default value: "0"
755:Address validity scope. Possible values: global, site, link, host
761:Number of attempts to settle DAD (0 to disable DAD). Default value: "60"
764:DAD state polling interval in seconds. Default value: "0.1"
767:This method may be used to define interfaces for which no configuration is
done by default. Such interfaces can be configured manually by means of
\fBup\fP and \fBdown\fP commands or /etc/network/if-*.d scripts.
779:This method may be used to obtain network interface configuration via
stateful DHCPv6 with dhclient. In stateful DHCPv6, the DHCP server is
responsible for assigning addresses to clients.
788:Accept router advertisements (0=off, 1=on, 2=on+forwarding). Default value:
"1"
794:Request a prefix through DHCPv6 Prefix Delegation (0=off, 1=on). Default
value: "0"
797:Number of attempts to wait for a link-local address. Default value: "60"
800:Link-local address polling interval in seconds. Default value: "0.1"
803:This method is used to create IP6GRE, IP6IP6 or IPIP6 tunnels. You need to
have the \fBip\fP binary from the \fBiproute\fP package. For IP6GRE tunnels,
you will need to load the ip6_gre module and the ip6_tunnel module for IP6IP6
or IPIP6 tunnels.
842:This method may be used to setup an IPv6-over-IPv4 tunnel. It requires the
\fBip\fP command from the \fBiproute\fP package.
875:This method may be used to setup a 6to4 tunnel. It requires the \fBip\fP
command from the \fBiproute\fP package.
899:This method may be used to setup a Controller Area Network (CAN) interface.
It requires the the \fBip\fP command from the \fBiproute\fP package.
-.-.
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.
N.B.
The number of lines affected can be too large to be in a patch.
Line 26, length 252
The following example configures two network interfaces: eth0 is brought up at
boot, and uses DHCP for IPv4 and SLAAC for IPv6, whereas eth1 is brought up
whenever the network hardware is detected, and is configured with static IPv4
and IPv6 addresses.
Line 51, length 81
The file consists of zero or more "iface", "mapping", "auto", "allow-",
"rename",
Line 52, length 106
"source" and "source-directory" stanzas. These will be described in more detail
in the following sections.
Line 59, length 120
option. (This option is also used by the system boot scripts, so interfaces
marked "auto" are brought up at boot time.)
Line 71, length 87
This can either be during boot if the interface is already present, or at a
later time,
Line 73, length 100
Please note that this does not have anything to do with detecting a network
cable being plugged in.)
Line 82, length 86
Lines beginning with "no-scripts" are used to identify interfaces for which
scripts in
Line 85, length 98
he above will match eth0 and eth1, and will bring up both interfaces using the
"iface eth" stanza.
Line 88, length 129
It takes one or more arguments in the form of "CUR=NEW", where CUR is the name
of an existing interface, and NEW is the new name.
Line 89, length 85
This becomes very powerful when combined with pattern matching for the CUR
interface.
Line 93, length 113
So if an interface is started with the name "foo", and it has to be renamed to
"bar" and brought up at boot time,
Line 102, length 99
However, if the interface is not renamed yet, it is possible to use both "ifup
foo" and "ifup bar".
Line 104, length 92
This is mainly useful when ifup is called automatically whenever an interface
is hotplugged.
Line 108, length 85
and may require that the interface that is to be renamed has not been brought
up yet.
Line 195, length 112
A list of packages providing additional options is mentioned in the section
"OPTIONS PROVIDED BY OTHER PACKAGE".
Line 228, length 111
These patterns can currently appear in lines beginning with "auto", "allow-",
"rename" and on the command line.
Line 235, length 89
If no VARIABLE is given, this pattern will match interface names against the
given VALUE.
Line 244, length 143
is run, patterns are replaces by all real interfaces that are currently known
to the operating system kernel and whose names match the pattern.
Line 259, length 92
However, it is possible to combine a pattern with a mapping to a logical
interface, like so:
Line 266, length 99
Valid variable names are "mac", in which case value is matched against the
interface's MAC address.
Line 268, length 82
in which case the value is matched against the contents of the corresponding
file.
Line 270, length 248
The OPTIONS field currently only supports a number. If given, only the n-th
interface that has a matching value will actually be used, where n is the
number given, starting at 1. So /eth*/1 will match the first interface whose
name starts with eth.
Line 272, length 103
On GNU/Hurd, interface names start with /dev/, and this obviously clashes with
the format for patterns.
Line 273, length 81
To ensure an interface name like /dev/eth0 does not get interpreted as a
pattern,
Line 274, length 99
any pattern that starts with /dev/ is ignored, and instead interpreted as a
literal interface name.
Line 292, length 107
As such, a VLAN interface is normally not automatically brought up when its
parent interface is brought up.
Line 294, length 90
in which case all VLAN interfaces that are in the same allow class as the
parent interface
Line 312, length 127
when "ifup --allow hotplug eth0" is called (either manually or because udev
triggers this when a network device is hotplugged),
Line 313, length 83
the interface eth0 and the VLAN interface eth0.1 are brought up, but eth0.2 is
not.
Line 315, length 85
Keep in mind that pattern matching will only match interfaces the kernel knows
about,
Line 316, length 113
so it is not possible to specify "auto /eth0.*" and have all VLAN interfaces
for eth0 be brought up at boot time.
Line 317, length 112
Another way to ensure that a VLAN interface is brought up automatically when
the parent interface is brought up,
Line 329, length 103
since VLAN interfaces are automatically brought down whenever their parent
interfaces are brought down.
Line 389, length 82
There are four directories in which scripts can be placed which will always be
run
Line 451, length 91
This is a copy of the value given to the \fB-\-allow\fP option when running
ifup or ifdown,
Line 472, length 82
When ifupdown is being called with the \fB\-\-all\fR option, before doing
anything
Line 474, length 81
\fBIFACE\fR set to "\-\-all", \fBLOGICAL\fR set to the current value of
\-\-allow
Line 475, length 84
parameter (or "auto" if it's not set), \fBADDRFAM\fR="meta" and
\fBMETHOD\fR="none".
Line 476, length 84
After all the interfaces have been brought up or taken down, the appropriate
scripts
Line 479, length 124
Ifupdown uses per-interface locking to ensure that concurrent ifup and ifdown
calls to the same interface are run in serial.
Line 481, length 179
It is therefore important that any hook scripts and \fIpre-up\fR, \fIup\fR,
\fIdown\fR and \fIpost-down\fR commands are written with the possibility of
parallel execution in mind.
Line 488, length 104
as long as these calls refer to a different interface than the one that is
already being (de)configured.
Line 492, length 86
This manual page documents the configuration options provided by the ifupdown
package.
Line 493, length 92
However, other packages can make other options available for use in
/etc/network/interfaces.
Line 496, length 559
arping, avahi-autoipd, avahi-daemon, bind9, bridge-utils, clamav-freshclam,
controlaula, epoptes-client, ethtool, guidedog, hostap-utils, hostapd, htpdate,
ifenslave, ifmetric, ifupdown-extra, ifupdown-multi, ifupdown-scripts-zg2,
initscripts, isatapd, linux-wlan-ng, lprng, macchanger, miredo, nslcd, ntpdate,
openntpd, openresolv, openssh-server, openvpn, openvswitch-switch, postfix,
resolvconf, sendmail-base, shorewall-init, slrn, slrnpull, tinc, ucarp,
uml-utilities, uruk, vde2, vlan, vzctl, whereami, wide-dhcpv6-client,
wireless-tools, wpasupplicant.
Line 498, length 98
Please consult the documentation of those packages for information about how
they extend ifupdown.
Line 511, length 96
This method may be used to define Ethernet interfaces with statically allocated
IPv4 addresses.
Line 544, length 212
This method may be used to define interfaces for which no configuration is done
by default. Such interfaces can be configured manually by means of \fBup\fP and
\fBdown\fP commands or /etc/network/if-*.d scripts.
Line 556, length 337
This method may be used to obtain an address via DHCP with any of the tools:
dhclient, udhcpc, dhcpcd. (They have been listed in their order of precedence.)
If you have a complicated DHCP setup you should note that some of these clients
use their own configuration files and do not obtain their configuration
information via \fBifup\fP.
Line 595, length 215
This method is used to create GRE or IPIP tunnels. You need to have the
\fBip\fP binary from the \fBiproute\fP package. For GRE tunnels, you will need
to load the ip_gre module and the ipip module for IPIP tunnels.
Line 628, length 88
This method uses pon/poff to configure a PPP interface. See those commands for
details.
Line 643, length 89
This method uses wvdial to configure a PPP interface. See that command for more
details.
Line 652, length 216
This method uses avahi-autoipd to configure an interface with an IPv4
Link-Layer address (169.254.0.0/16 family). This method is also known as APIPA
or IPAC, and often colloquially referred to as "Zeroconf address".
Line 663, length 96
This method may be used to setup an IPX interface. It requires the
\fIipx_interface\fP command.
Line 687, length 501
This method may be used to define interfaces with automatically assigned IPv6
addresses. Using this method on its own doesn't mean that RDNSS options will be
applied, too. To make this happen, \fBrdnssd\fP daemon must be installed,
properly configured and running. If stateless DHCPv6 support is turned on, then
additional network configuration parameters such as DNS and NTP servers will be
retrieved from a DHCP server. Please note that on ifdown, the lease is not
currently released (a known bug).
Line 702, length 83
Request a prefix through DHCPv6 Prefix Delegation (0=off, 1=on). Default value:
"0"
Line 719, length 158
This method may be used to define interfaces with statically assigned IPv6
addresses. By default, stateless autoconfiguration is disabled for this
interface.
Line 767, length 212
This method may be used to define interfaces for which no configuration is done
by default. Such interfaces can be configured manually by means of \fBup\fP and
\fBdown\fP commands or /etc/network/if-*.d scripts.
Line 779, length 188
This method may be used to obtain network interface configuration via stateful
DHCPv6 with dhclient. In stateful DHCPv6, the DHCP server is responsible for
assigning addresses to clients.
Line 794, length 83
Request a prefix through DHCPv6 Prefix Delegation (0=off, 1=on). Default value:
"0"
Line 803, length 248
This method is used to create IP6GRE, IP6IP6 or IPIP6 tunnels. You need to have
the \fBip\fP binary from the \fBiproute\fP package. For IP6GRE tunnels, you
will need to load the ip6_gre module and the ip6_tunnel module for IP6IP6 or
IPIP6 tunnels.
Line 842, length 124
This method may be used to setup an IPv6-over-IPv4 tunnel. It requires the
\fBip\fP command from the \fBiproute\fP package.
Line 875, length 113
This method may be used to setup a 6to4 tunnel. It requires the \fBip\fP
command from the \fBiproute\fP package.
Line 899, length 145
This method may be used to setup a Controller Area Network (CAN) interface. It
requires the the \fBip\fP command from the \fBiproute\fP package.
-.-.
Split a punctuation mark from a single argument for a two-font macro
130:.IR /etc/network/interfaces\fR,
132:.IR /etc/network\fR.
407:.BI pre-up\fR,
408:.BI up\fR,
426:.BI pre-up\fR,
427:.BI up\fR,
428:.BI post-up\fR,
429:.BI pre-down\fR,
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
Not considered in a patch, too many lines.
interfaces.5:59:option. (This option is also used by the system boot scripts,
so interfaces marked "auto" are brought up at boot time.)
interfaces.5:197:Options are usually indented for clarity (as in the example
above)
interfaces.5:229:A pattern has the following format (see below for exceptions
for GNU/Hurd):
interfaces.5:312:when "ifup --allow hotplug eth0" is called (either manually or
because udev triggers this when a network device is hotplugged),
interfaces.5:404:The scripts in which are run (with no arguments) using
interfaces.5:436:The physical name of the interface being processed, or "--all"
(see below).
interfaces.5:439:The logical name of the interface being processed, or "auto"
(see below).
interfaces.5:442:The address family of the interface, or "meta" (see below).
interfaces.5:447:or "none" (see below).
interfaces.5:473:to interfaces, it calls all the hook scripts (\fIpre-up\fR or
\fIdown\fR) with
interfaces.5:475:parameter (or "auto" if it's not set), \fBADDRFAM\fR="meta"
and \fBMETHOD\fR="none".
interfaces.5:517:Address (dotted quad/netmask) \fBrequired\fP
interfaces.5:520:Netmask (dotted quad or number of bits) \fBdeprecated\fP
interfaces.5:523:Broadcast address (dotted quad, + or -) \fBdeprecated\fP.
Default value: "+"
interfaces.5:529:Default gateway (dotted quad)
interfaces.5:532:Address of other end point (dotted quad). Note the spelling of
"point-to".
interfaces.5:556:This method may be used to obtain an address via DHCP with any
of the tools: dhclient, udhcpc, dhcpcd. (They have been listed in their order
of precedence.) If you have a complicated DHCP setup you should note that some
of these clients use their own configuration files and do not obtain their
configuration information via \fBifup\fP.
interfaces.5:562:Hostname to be requested (dhcpcd, udhcpc)
interfaces.5:601:Local address (dotted quad) \fBrequired\fP
interfaces.5:604:Tunnel type (either GRE or IPIP) \fBrequired\fP
interfaces.5:610:Remote address (remote address inside tunnel)
interfaces.5:634:Use \fIname\fP as the provider (from /etc/ppp/peers).
interfaces.5:649:Use \fIname\fP as the provider (from /etc/wvdial.conf).
interfaces.5:652:This method uses avahi-autoipd to configure an interface with
an IPv4 Link-Layer address (169.254.0.0/16 family). This method is also known
as APIPA or IPAC, and often colloquially referred to as "Zeroconf address".
interfaces.5:669:\fItype\fP of Ethernet frames to use (e.g. \fB802.2\fP)
interfaces.5:681:\fItype\fP of Ethernet frames to use (e.g. \fB802.2\fP)
interfaces.5:687:This method may be used to define interfaces with
automatically assigned IPv6 addresses. Using this method on its own doesn't
mean that RDNSS options will be applied, too. To make this happen, \fBrdnssd\fP
daemon must be installed, properly configured and running. If stateless DHCPv6
support is turned on, then additional network configuration parameters such as
DNS and NTP servers will be retrieved from a DHCP server. Please note that on
ifdown, the lease is not currently released (a known bug).
interfaces.5:693:Privacy extensions (RFC4941) (0=off, 1=assign, 2=prefer)
interfaces.5:696:Accept router advertisements (0=off, 1=on, 2=on+forwarding).
Default value: "2"
interfaces.5:699:Use stateless DHCPv6 (0=off, 1=on)
interfaces.5:702:Request a prefix through DHCPv6 Prefix Delegation (0=off,
1=on). Default value: "0"
interfaces.5:725:Address (colon delimited/netmask) \fBrequired\fP
interfaces.5:728:Netmask (number of bits, eg 64) \fBdeprecated\fP
interfaces.5:734:Default gateway (colon delimited)
interfaces.5:746:Accept router advertisements (0=off, 1=on, 2=on+forwarding)
interfaces.5:749:Perform stateless autoconfiguration (0=off, 1=on). Default
value: "0"
interfaces.5:752:Privacy extensions (RFC3041) (0=off, 1=assign, 2=prefer)
interfaces.5:761:Number of attempts to settle DAD (0 to disable DAD). Default
value: "60"
interfaces.5:788:Accept router advertisements (0=off, 1=on, 2=on+forwarding).
Default value: "1"
interfaces.5:791:Perform stateless autoconfiguration (0=off, 1=on)
interfaces.5:794:Request a prefix through DHCPv6 Prefix Delegation (0=off,
1=on). Default value: "0"
interfaces.5:809:Local Address (colon delimited)
interfaces.5:812:Netmask (number of bits, eg 64)
interfaces.5:815:Tunnel type (either IP6GRE, IP6IP6 or IPIP6) \fBrequired\fP
interfaces.5:818:Address of other tunnel endpoint (colon delimited)
\fBrequired\fP
interfaces.5:821:Remote address (remote address inside tunnel)
interfaces.5:824:Address of the local endpoint (colon delimited)
interfaces.5:830:Default gateway (colon delimited)
interfaces.5:839:Encapsulation limit ("none" or integer)
interfaces.5:848:Address (colon delimited/netmask) \fBrequired\fP
interfaces.5:851:Netmask (number of bits, eg 64) \fBdeprecated\fP
interfaces.5:854:Address of other tunnel endpoint (IPv4 dotted quad)
\fBrequired\fP
interfaces.5:857:Address of the local endpoint (IPv4 dotted quad)
interfaces.5:863:Default gateway (colon delimited)
interfaces.5:881:Address of the local endpoint (IPv4 dotted quad) \fBrequired\fP
-.-.
No space is needed before a quote (") at the end of a macro line
516:.BI address " address "
519:.BI netmask " mask "
525:.BI metric " metric "
528:.BI gateway " address "
531:.BI pointopoint " address "
534:.BI hwaddress " address "
537:.BI mtu " size "
549:.BI hwaddress " address "
552:.BI mtu " size "
561:.BI hostname " hostname "
564:.BI metric " metric "
567:.BI leasetime " leasetime "
570:.BI vendor " vendor_id "
573:.BI client " client_id "
576:.BI hwaddress " address "
585:.BI bootfile " file "
591:.BI hwaddr " addr "
600:.BI address " address "
603:.BI mode " type "
606:.BI endpoint " address "
609:.BI dstaddr " address "
612:.BI local " address "
615:.BI metric " metric "
618:.BI gateway " address "
621:.BI ttl " time "
624:.BI mtu " size "
633:.BI provider " name "
636:.BI unit " number "
648:.BI provider " name "
668:.BI frame " type "
671:.BI netnum " id "
680:.BI frame " type "
692:.BI privext " int "
695:.BI accept_ra " int "
698:.BI dhcp " int "
701:.BI request_prefix " int "
724:.BI address " address "
727:.BI netmask " mask "
730:.BI metric " metric "
733:.BI gateway " address "
736:.BI media " type "
739:.BI hwaddress " address "
742:.BI mtu " size "
745:.BI accept_ra " int "
748:.BI autoconf " int "
751:.BI privext " int "
772:.BI hwaddress " address "
775:.BI mtu " size "
784:.BI hwaddress " address "
787:.BI accept_ra " int "
790:.BI autoconf " int "
793:.BI request_prefix " int "
808:.BI address " address "
811:.BI netmask " mask "
814:.BI mode " type "
817:.BI endpoint " address "
820:.BI dstaddr " address "
823:.BI local " address "
826:.BI metric " metric "
829:.BI gateway " address "
832:.BI ttl " time "
835:.BI mtu " size "
838:.BI encaplimit " limit "
847:.BI address " address "
850:.BI netmask " mask "
853:.BI endpoint " address "
856:.BI local " address "
859:.BI metric " metric "
862:.BI gateway " address "
865:.BI ttl " time "
868:.BI mtu " size "
880:.BI local " address "
883:.BI metric " metric "
886:.BI ttl " time "
889:.BI mtu " size "
-.-.
Use thousand markers to make large numbers easy to read
905:bitrate (1..1000000) \fBrequired\fP
947:script. See also Debian bug #101728.
-.-.
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.
14:.TH INTERFACES 5 "24 July 2017" "ifupdown" "File formats"
-.-.
Add lines to use the CR font for groff instead of CW.
.ie \n(.g .ft CR
.el .ft CW
5:. ft CW
-.-.
Section headings (.SH and .SS) do not need quoting.
951:.SH "SEE ALSO"
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
an.tmac:<stdin>:83: misuse, warning: .IR is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
an.tmac:<stdin>:130: misuse, warning: .IR is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
an.tmac:<stdin>:132: misuse, warning: .IR is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
an.tmac:<stdin>:136: misuse, warning: .IR is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
an.tmac:<stdin>:144: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:150: misuse, warning: .IR is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
an.tmac:<stdin>:241: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:243: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:392: misuse, warning: .IR is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
an.tmac:<stdin>:395: misuse, warning: .IR is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
an.tmac:<stdin>:398: misuse, warning: .IR is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
an.tmac:<stdin>:401: misuse, warning: .IR is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
an.tmac:<stdin>:407: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:408: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:409: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:411: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:413: misuse, warning: .IR is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
an.tmac:<stdin>:415: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:417: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:420: misuse, warning: .IR is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
an.tmac:<stdin>:422: misuse, warning: .IR is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
an.tmac:<stdin>:426: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:427: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:428: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:429: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:430: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:432: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:484: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:486: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
troff:<stdin>:503: warning: trailing space in the line
troff:<stdin>:511: warning: trailing space in the line
troff:<stdin>:516: warning: trailing space in the line
troff:<stdin>:519: warning: trailing space in the line
troff:<stdin>:525: warning: trailing space in the line
troff:<stdin>:528: warning: trailing space in the line
troff:<stdin>:531: warning: trailing space in the line
troff:<stdin>:534: warning: trailing space in the line
troff:<stdin>:537: warning: trailing space in the line
an.tmac:<stdin>:540: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
troff:<stdin>:544: warning: trailing space in the line
troff:<stdin>:549: warning: trailing space in the line
troff:<stdin>:552: warning: trailing space in the line
troff:<stdin>:556: warning: trailing space in the line
troff:<stdin>:561: warning: trailing space in the line
troff:<stdin>:564: warning: trailing space in the line
troff:<stdin>:567: warning: trailing space in the line
troff:<stdin>:570: warning: trailing space in the line
troff:<stdin>:573: warning: trailing space in the line
troff:<stdin>:576: warning: trailing space in the line
troff:<stdin>:580: warning: trailing space in the line
troff:<stdin>:585: warning: trailing space in the line
troff:<stdin>:591: warning: trailing space in the line
troff:<stdin>:595: warning: trailing space in the line
troff:<stdin>:600: warning: trailing space in the line
troff:<stdin>:603: warning: trailing space in the line
troff:<stdin>:606: warning: trailing space in the line
troff:<stdin>:609: warning: trailing space in the line
troff:<stdin>:612: warning: trailing space in the line
troff:<stdin>:615: warning: trailing space in the line
troff:<stdin>:618: warning: trailing space in the line
troff:<stdin>:621: warning: trailing space in the line
troff:<stdin>:624: warning: trailing space in the line
troff:<stdin>:628: warning: trailing space in the line
troff:<stdin>:633: warning: trailing space in the line
troff:<stdin>:636: warning: trailing space in the line
troff:<stdin>:643: warning: trailing space in the line
troff:<stdin>:648: warning: trailing space in the line
troff:<stdin>:652: warning: trailing space in the line
troff:<stdin>:663: warning: trailing space in the line
troff:<stdin>:668: warning: trailing space in the line
troff:<stdin>:671: warning: trailing space in the line
troff:<stdin>:675: warning: trailing space in the line
troff:<stdin>:680: warning: trailing space in the line
troff:<stdin>:687: warning: trailing space in the line
troff:<stdin>:692: warning: trailing space in the line
troff:<stdin>:695: warning: trailing space in the line
troff:<stdin>:698: warning: trailing space in the line
troff:<stdin>:701: warning: trailing space in the line
an.tmac:<stdin>:704: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:707: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
troff:<stdin>:711: warning: trailing space in the line
troff:<stdin>:719: warning: trailing space in the line
troff:<stdin>:724: warning: trailing space in the line
troff:<stdin>:727: warning: trailing space in the line
troff:<stdin>:730: warning: trailing space in the line
troff:<stdin>:733: warning: trailing space in the line
troff:<stdin>:736: warning: trailing space in the line
troff:<stdin>:739: warning: trailing space in the line
troff:<stdin>:742: warning: trailing space in the line
troff:<stdin>:745: warning: trailing space in the line
troff:<stdin>:748: warning: trailing space in the line
troff:<stdin>:751: warning: trailing space in the line
an.tmac:<stdin>:754: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:760: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:763: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
troff:<stdin>:767: warning: trailing space in the line
troff:<stdin>:772: warning: trailing space in the line
troff:<stdin>:775: warning: trailing space in the line
troff:<stdin>:779: warning: trailing space in the line
troff:<stdin>:784: warning: trailing space in the line
troff:<stdin>:787: warning: trailing space in the line
troff:<stdin>:790: warning: trailing space in the line
troff:<stdin>:793: warning: trailing space in the line
an.tmac:<stdin>:796: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:799: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
troff:<stdin>:803: warning: trailing space in the line
troff:<stdin>:808: warning: trailing space in the line
troff:<stdin>:811: warning: trailing space in the line
troff:<stdin>:814: warning: trailing space in the line
troff:<stdin>:817: warning: trailing space in the line
troff:<stdin>:820: warning: trailing space in the line
troff:<stdin>:823: warning: trailing space in the line
troff:<stdin>:826: warning: trailing space in the line
troff:<stdin>:829: warning: trailing space in the line
troff:<stdin>:832: warning: trailing space in the line
troff:<stdin>:835: warning: trailing space in the line
troff:<stdin>:838: warning: trailing space in the line
troff:<stdin>:842: warning: trailing space in the line
troff:<stdin>:847: warning: trailing space in the line
troff:<stdin>:850: warning: trailing space in the line
troff:<stdin>:853: warning: trailing space in the line
troff:<stdin>:856: warning: trailing space in the line
troff:<stdin>:859: warning: trailing space in the line
troff:<stdin>:862: warning: trailing space in the line
troff:<stdin>:865: warning: trailing space in the line
troff:<stdin>:868: warning: trailing space in the line
troff:<stdin>:875: warning: trailing space in the line
troff:<stdin>:880: warning: trailing space in the line
troff:<stdin>:883: warning: trailing space in the line
troff:<stdin>:886: warning: trailing space in the line
troff:<stdin>:889: warning: trailing space in the line
troff:<stdin>:899: warning: trailing space in the line
-.-
Additionally:
Change ' eg ' to ' e.g.\& '.
Change '-' in web (file) paths to '\-'.
--- interfaces.5 2025-02-10 22:50:17.428727478 +0000
+++ interfaces.5.new 2025-02-10 23:52:39.941387301 +0000
@@ -2,7 +2,8 @@
.\" macros
.de EX \" Begin Example
. IP
-. ft CW
+. ie \\n(.g .ft CR
+. el .ft CW
. nf
. ne \\$1
..
@@ -11,7 +12,7 @@
. fi
. PP
..
-.TH INTERFACES 5 "24 July 2017" "ifupdown" "File formats"
+.TH INTERFACES 5 "24 July 2017" ifupdown "File formats"
.SH NAME
/etc/network/interfaces \- network interface configuration for ifup and ifdown
.SH DESCRIPTION
@@ -73,14 +74,14 @@ for example when plugging in a USB netwo
Please note that this does not have anything to do with detecting a network
cable being plugged in.)
.P
Lines beginning with "no-auto-down" are used to identify interfaces that should
-not be brought down by the command "ifdown -a". Its main use is to prevent an
+not be brought down by the command "ifdown \-a". Its main use is to prevent an
interface from being brought down during system shutdown time, for example if
the root filesystem is a network filesystem and the interface should stay up
until the very end. Note that you can still bring down the interface by
specifying the interface name explicitly.
.P
Lines beginning with "no-scripts" are used to identify interfaces for which
scripts in
-.IR /etc/network/if\-*.d/
+.I /etc/network/if\-*.d/
should not be run when those interfaces are brought up or down.
he above will match eth0 and eth1, and will bring up both interfaces using the
"iface eth" stanza.
.SH INTERFACE RENAMING
@@ -127,13 +128,13 @@ shell wildcards may be used as well.
When sourcing files or directories, if a path doesn't have a leading slash,
it's considered relative to the directory containing the file in which the
keyword is placed. In the example above, if the file is located at
-.IR /etc/network/interfaces\fR,
+.IR /etc/network/interfaces ,
paths to the included files are understood to be under
-.IR /etc/network\fR.
+.IR /etc/network .
.P
By default, on a freshly installed Debian system, the interfaces file includes
a
line to source files in the
-.IR /etc/network/interfaces.d
+.I /etc/network/interfaces.d
directory.
.SH MAPPINGS
Stanzas beginning with the word "mapping" are used to determine how a
@@ -141,13 +142,13 @@ logical interface name is chosen for a p
brought up. The first line of a mapping stanza consists of the word
"mapping" followed by a pattern in shell glob syntax. Each mapping stanza
must contain a
-.BR script
+.B script
definition. The named script is run with the physical interface name as
its argument and with the contents of all following "map" lines
(\fBwithout\fR the leading "map") in the
stanza provided to it on its standard input. The script must print a
string on its standard output before exiting. See
-.IR /usr/share/doc/ifupdown/examples
+.I /usr/share/doc/ifupdown/examples
for examples of what the script must print.
.P
Mapping a name consists of searching the remaining mapping
@@ -204,7 +205,6 @@ addresses on the same interface (althoug
kernel will normally still perform stateless address autoconfiguration if there
is an IPv6 route advertisement daemon on the network). It can also be used to
configure multiple addresses of the same type on a single interface.
-.P
.SH INTERFACE TEMPLATES
It is possible to define interface definition templates and extend
them using the
@@ -238,9 +238,9 @@ see the
.BR fnmatch (3)
function.
When
-.BR ifup
+.B ifup
or
-.BR ifdown
+.B ifdown
is run, patterns are replaces by all real interfaces that are currently known
to the operating system kernel and whose names match the pattern.
For example, given the following line:
.P
@@ -290,7 +290,7 @@ as its parent interface.
.P
VLAN interfaces are mostly treated as independent interfaces.
As such, a VLAN interface is normally not automatically brought up when its
parent interface is brought up.
-The exception is when ifup is called with the --allow option,
+The exception is when ifup is called with the \-\-allow option,
in which case all VLAN interfaces that are in the same allow class as the
parent interface
are brought up together with the parent interface.
For example:
@@ -309,7 +309,7 @@ iface eth0.2 inet static
.EE
.P
In the above example,
-when "ifup --allow hotplug eth0" is called (either manually or because udev
triggers this when a network device is hotplugged),
+when "ifup \-\-allow hotplug eth0" is called (either manually or because udev
triggers this when a network device is hotplugged),
the interface eth0 and the VLAN interface eth0.1 are brought up, but eth0.2 is
not.
.P
Keep in mind that pattern matching will only match interfaces the kernel knows
about,
@@ -389,51 +389,51 @@ Alias interface by
There are four directories in which scripts can be placed which will always be
run
for any interface during certain phases of ifup and ifdown commands. These are:
.TP
-.IR /etc/network/if-pre-up.d/
+.I /etc/network/if-pre-up.d/
Scripts in this directory are run before bringing the interface up.
.TP
-.IR /etc/network/if-up.d/
+.I /etc/network/if-up.d/
Scripts in this directory are run after bringing the interface up.
.TP
-.IR /etc/network/if-down.d/
+.I /etc/network/if-down.d/
Scripts in this directory are run before bringing the interface down.
.TP
-.IR /etc/network/if-post-down.d/
+.I /etc/network/if-post-down.d/
Scripts in this directory are run after bringing the interface down.
.P
The scripts in which are run (with no arguments) using
.BR run\-parts (8)
after the corresponding
-.BI pre-up\fR,
-.BI up\fR,
-.BI down
+.BR pre-up ,
+.BR up ,
+.B down
and
-.BI post-down
+.B post-down
options in the
-.IR /etc/network/interfaces
+.I /etc/network/interfaces
file itself have been processed. Please note that as
-.BI post\-up
+.B post\-up
and
-.BI pre\-down
+.B pre\-down
are aliases, no files in the corresponding directories are processed.
Please use
-.IR if-up.d
+.B if-up.d
and
-.IR if-down.d
+.B if-down.d
directories instead.
.SH ENVIRONMENT VARIABLES
All hook scripts, and the commands executed by
-.BI pre-up\fR,
-.BI up\fR,
-.BI post-up\fR,
-.BI pre-down\fR,
-.BI down
+.BR pre-up ,
+.BR up ,
+.BR post-up ,
+.BR pre-down ,
+.B down
and
-.BI post-down
+.B post-down
have access to the following environment variables:
.TP
.B IFACE
-The physical name of the interface being processed, or "--all" (see below).
+The physical name of the interface being processed, or "\-\-all" (see below).
.TP
.B LOGICAL
The logical name of the interface being processed, or "auto" (see below).
@@ -443,7 +443,7 @@ The address family of the interface, or
.TP
.B METHOD
The method of the interface (e.g.,
-.IR static ),
+.BR static ),
or "none" (see below).
.TP
.B CLASS
@@ -452,7 +452,7 @@ This is a copy of the value given to the
otherwise it is set to "auto" when the \fB-\-all\fP option is used.
.TP
.B MODE
-.IR start " if run from ifup, " stop " if run from ifdown".
+.BR start " if run from ifup, " stop " if run from ifdown".
.TP
.B PHASE
As per MODE, but with finer granularity, distinguishing the
@@ -481,9 +481,9 @@ However, calls to different interfaces w
It is therefore important that any hook scripts and \fIpre-up\fR, \fIup\fR,
\fIdown\fR and \fIpost-down\fR commands are written with the possibility of
parallel execution in mind.
.P
It is allowed to recursively call
-.BI ifup
+.B ifup
and
-.BI ifdown
+.B ifdown
from hook scripts and interface commands,
as long as these calls refer to a different interface than the one that is
already being (de)configured.
Loops are detected and will result in the call failing instead of a deadlock,
@@ -500,7 +500,7 @@ Please consult the documentation of thos
This section documents the methods available in the
inet address family.
.SS The loopback Method
-This method may be used to define the IPv4 loopback interface.
+This method may be used to define the IPv4 loopback interface.
.PP
.B Options
.RS
@@ -508,148 +508,148 @@ This method may be used to define the IP
(No options)
.RE
.SS The static Method
-This method may be used to define Ethernet interfaces with statically
allocated IPv4 addresses.
+This method may be used to define Ethernet interfaces with statically
allocated IPv4 addresses.
.PP
.B Options
.RS
.TP
-.BI address " address "
+.BI address " address"
Address (dotted quad/netmask) \fBrequired\fP
.TP
-.BI netmask " mask "
+.BI netmask " mask"
Netmask (dotted quad or number of bits) \fBdeprecated\fP
.TP
.BI broadcast " broadcast_address"
-Broadcast address (dotted quad, + or -) \fBdeprecated\fP. Default value: "+"
+Broadcast address (dotted quad, + or \-) \fBdeprecated\fP. Default value: "+"
.TP
-.BI metric " metric "
+.BI metric " metric"
Routing metric for default gateway (integer)
.TP
-.BI gateway " address "
+.BI gateway " address"
Default gateway (dotted quad)
.TP
-.BI pointopoint " address "
+.BI pointopoint " address"
Address of other end point (dotted quad). Note the spelling of "point-to".
.TP
-.BI hwaddress " address "
+.BI hwaddress " address"
Link local address or "random".
.TP
-.BI mtu " size "
+.BI mtu " size"
MTU size
.TP
-.BI scope
+.B scope
Address validity scope. Possible values: global, link, host
.RE
.SS The manual Method
-This method may be used to define interfaces for which no configuration is
done by default. Such interfaces can be configured manually by means of
\fBup\fP and \fBdown\fP commands or /etc/network/if-*.d scripts.
+This method may be used to define interfaces for which no configuration is
done by default. Such interfaces can be configured manually by means of
\fBup\fP and \fBdown\fP commands or /etc/network/if-*.d scripts.
.PP
.B Options
.RS
.TP
-.BI hwaddress " address "
+.BI hwaddress " address"
Link local address or "random".
.TP
-.BI mtu " size "
+.BI mtu " size"
MTU size
.RE
.SS The dhcp Method
-This method may be used to obtain an address via DHCP with any of the tools:
dhclient, udhcpc, dhcpcd. (They have been listed in their order of precedence.)
If you have a complicated DHCP setup you should note that some of these clients
use their own configuration files and do not obtain their configuration
information via \fBifup\fP.
+This method may be used to obtain an address via DHCP with any of the tools:
dhclient, udhcpc, dhcpcd. (They have been listed in their order of precedence.)
If you have a complicated DHCP setup you should note that some of these clients
use their own configuration files and do not obtain their configuration
information via \fBifup\fP.
.PP
.B Options
.RS
.TP
-.BI hostname " hostname "
+.BI hostname " hostname"
Hostname to be requested (dhcpcd, udhcpc)
.TP
-.BI metric " metric "
+.BI metric " metric"
Metric for added routes (dhclient)
.TP
-.BI leasetime " leasetime "
+.BI leasetime " leasetime"
Preferred lease time in seconds (dhcpcd)
.TP
-.BI vendor " vendor_id "
+.BI vendor " vendor_id"
Vendor class identifier (dhcpcd)
.TP
-.BI client " client_id "
+.BI client " client_id"
Client identifier (dhcpcd), or "no" (dhclient)
.TP
-.BI hwaddress " address "
+.BI hwaddress " address"
Hardware address.
.RE
.SS The bootp Method
-This method may be used to obtain an address via bootp.
+This method may be used to obtain an address via bootp.
.PP
.B Options
.RS
.TP
-.BI bootfile " file "
+.BI bootfile " file"
Tell the server to use \fIfile\fP as the bootfile.
.TP
.BI server " address"
Use the IP address \fIaddress\fP to communicate with the server.
.TP
-.BI hwaddr " addr "
+.BI hwaddr " addr"
Use \fIaddr\fP as the hardware address instead of whatever it really is.
.RE
.SS The tunnel Method
-This method is used to create GRE or IPIP tunnels. You need to have the
\fBip\fP binary from the \fBiproute\fP package. For GRE tunnels, you will need
to load the ip_gre module and the ipip module for IPIP tunnels.
+This method is used to create GRE or IPIP tunnels. You need to have the
\fBip\fP binary from the \fBiproute\fP package. For GRE tunnels, you will need
to load the ip_gre module and the ipip module for IPIP tunnels.
.PP
.B Options
.RS
.TP
-.BI address " address "
+.BI address " address"
Local address (dotted quad) \fBrequired\fP
.TP
-.BI mode " type "
+.BI mode " type"
Tunnel type (either GRE or IPIP) \fBrequired\fP
.TP
-.BI endpoint " address "
+.BI endpoint " address"
Address of other tunnel endpoint \fBrequired\fP
.TP
-.BI dstaddr " address "
+.BI dstaddr " address"
Remote address (remote address inside tunnel)
.TP
-.BI local " address "
+.BI local " address"
Address of the local endpoint
.TP
-.BI metric " metric "
+.BI metric " metric"
Routing metric for default gateway (integer)
.TP
-.BI gateway " address "
+.BI gateway " address"
Default gateway
.TP
-.BI ttl " time "
+.BI ttl " time"
TTL setting
.TP
-.BI mtu " size "
+.BI mtu " size"
MTU size
.RE
.SS The ppp Method
-This method uses pon/poff to configure a PPP interface. See those commands for
details.
+This method uses pon/poff to configure a PPP interface. See those commands for
details.
.PP
.B Options
.RS
.TP
-.BI provider " name "
+.BI provider " name"
Use \fIname\fP as the provider (from /etc/ppp/peers).
.TP
-.BI unit " number "
+.BI unit " number"
Use \fInumber\fP as the ppp unit number.
.TP
.BI options " string"
Pass \fIstring\fP as additional options to pon.
.RE
.SS The wvdial Method
-This method uses wvdial to configure a PPP interface. See that command for
more details.
+This method uses wvdial to configure a PPP interface. See that command for
more details.
.PP
.B Options
.RS
.TP
-.BI provider " name "
+.BI provider " name"
Use \fIname\fP as the provider (from /etc/wvdial.conf).
.RE
.SS The ipv4ll Method
-This method uses avahi-autoipd to configure an interface with an IPv4
Link-Layer address (169.254.0.0/16 family). This method is also known as APIPA
or IPAC, and often colloquially referred to as "Zeroconf address".
+This method uses avahi-autoipd to configure an interface with an IPv4
Link-Layer address (169.254.0.0/16 family). This method is also known as APIPA
or IPAC, and often colloquially referred to as "Zeroconf address".
.PP
.B Options
.RS
@@ -660,55 +660,55 @@ This method uses avahi-autoipd to config
This section documents the methods available in the
ipx address family.
.SS The static Method
-This method may be used to setup an IPX interface. It requires the
\fIipx_interface\fP command.
+This method may be used to setup an IPX interface. It requires the
\fIipx_interface\fP command.
.PP
.B Options
.RS
.TP
-.BI frame " type "
-\fItype\fP of Ethernet frames to use (e.g. \fB802.2\fP)
+.BI frame " type"
+\fItype\fP of Ethernet frames to use (e.g., \fB802.2\fP)
.TP
-.BI netnum " id "
+.BI netnum " id"
Network number
.RE
.SS The dynamic Method
-This method may be used to setup an IPX interface dynamically.
+This method may be used to setup an IPX interface dynamically.
.PP
.B Options
.RS
.TP
-.BI frame " type "
-\fItype\fP of Ethernet frames to use (e.g. \fB802.2\fP)
+.BI frame " type"
+\fItype\fP of Ethernet frames to use (e.g., \fB802.2\fP)
.RE
.SH INET6 ADDRESS FAMILY
This section documents the methods available in the
inet6 address family.
.SS The auto Method
-This method may be used to define interfaces with automatically assigned IPv6
addresses. Using this method on its own doesn't mean that RDNSS options will be
applied, too. To make this happen, \fBrdnssd\fP daemon must be installed,
properly configured and running. If stateless DHCPv6 support is turned on, then
additional network configuration parameters such as DNS and NTP servers will be
retrieved from a DHCP server. Please note that on ifdown, the lease is not
currently released (a known bug).
+This method may be used to define interfaces with automatically assigned IPv6
addresses. Using this method on its own doesn't mean that RDNSS options will be
applied, too. To make this happen, \fBrdnssd\fP daemon must be installed,
properly configured and running. If stateless DHCPv6 support is turned on, then
additional network configuration parameters such as DNS and NTP servers will be
retrieved from a DHCP server. Please note that on ifdown, the lease is not
currently released (a known bug).
.PP
.B Options
.RS
.TP
-.BI privext " int "
+.BI privext " int"
Privacy extensions (RFC4941) (0=off, 1=assign, 2=prefer)
.TP
-.BI accept_ra " int "
+.BI accept_ra " int"
Accept router advertisements (0=off, 1=on, 2=on+forwarding). Default value: "2"
.TP
-.BI dhcp " int "
+.BI dhcp " int"
Use stateless DHCPv6 (0=off, 1=on)
.TP
-.BI request_prefix " int "
+.BI request_prefix " int"
Request a prefix through DHCPv6 Prefix Delegation (0=off, 1=on). Default
value: "0"
.TP
-.BI ll-attempts
+.B ll-attempts
Number of attempts to wait for a link-local address. Default value: "60"
.TP
-.BI ll-interval
+.B ll-interval
Link-local address polling interval in seconds. Default value: "0.1"
.RE
.SS The loopback Method
-This method may be used to define the IPv6 loopback interface.
+This method may be used to define the IPv6 loopback interface.
.PP
.B Options
.RS
@@ -716,177 +716,177 @@ This method may be used to define the IP
(No options)
.RE
.SS The static Method
-This method may be used to define interfaces with statically assigned IPv6
addresses. By default, stateless autoconfiguration is disabled for this
interface.
+This method may be used to define interfaces with statically assigned IPv6
addresses. By default, stateless autoconfiguration is disabled for this
interface.
.PP
.B Options
.RS
.TP
-.BI address " address "
+.BI address " address"
Address (colon delimited/netmask) \fBrequired\fP
.TP
-.BI netmask " mask "
-Netmask (number of bits, eg 64) \fBdeprecated\fP
+.BI netmask " mask"
+Netmask (number of bits, e.g.\& 64) \fBdeprecated\fP
.TP
-.BI metric " metric "
+.BI metric " metric"
Routing metric for default gateway (integer)
.TP
-.BI gateway " address "
+.BI gateway " address"
Default gateway (colon delimited)
.TP
-.BI media " type "
+.BI media " type"
Medium type, driver dependent
.TP
-.BI hwaddress " address "
+.BI hwaddress " address"
Hardware address or "random"
.TP
-.BI mtu " size "
+.BI mtu " size"
MTU size
.TP
-.BI accept_ra " int "
+.BI accept_ra " int"
Accept router advertisements (0=off, 1=on, 2=on+forwarding)
.TP
-.BI autoconf " int "
+.BI autoconf " int"
Perform stateless autoconfiguration (0=off, 1=on). Default value: "0"
.TP
-.BI privext " int "
+.BI privext " int"
Privacy extensions (RFC3041) (0=off, 1=assign, 2=prefer)
.TP
-.BI scope
+.B scope
Address validity scope. Possible values: global, site, link, host
.TP
.BI preferred-lifetime " int"
Time that address remains preferred
.TP
-.BI dad-attempts
+.B dad-attempts
Number of attempts to settle DAD (0 to disable DAD). Default value: "60"
.TP
-.BI dad-interval
+.B dad-interval
DAD state polling interval in seconds. Default value: "0.1"
.RE
.SS The manual Method
-This method may be used to define interfaces for which no configuration is
done by default. Such interfaces can be configured manually by means of
\fBup\fP and \fBdown\fP commands or /etc/network/if-*.d scripts.
+This method may be used to define interfaces for which no configuration is
done by default. Such interfaces can be configured manually by means of
\fBup\fP and \fBdown\fP commands or /etc/network/if-*.d scripts.
.PP
.B Options
.RS
.TP
-.BI hwaddress " address "
+.BI hwaddress " address"
Hardware address or "random"
.TP
-.BI mtu " size "
+.BI mtu " size"
MTU size
.RE
.SS The dhcp Method
-This method may be used to obtain network interface configuration via stateful
DHCPv6 with dhclient. In stateful DHCPv6, the DHCP server is responsible for
assigning addresses to clients.
+This method may be used to obtain network interface configuration via stateful
DHCPv6 with dhclient. In stateful DHCPv6, the DHCP server is responsible for
assigning addresses to clients.
.PP
.B Options
.RS
.TP
-.BI hwaddress " address "
+.BI hwaddress " address"
Hardware address or "random"
.TP
-.BI accept_ra " int "
+.BI accept_ra " int"
Accept router advertisements (0=off, 1=on, 2=on+forwarding). Default value: "1"
.TP
-.BI autoconf " int "
+.BI autoconf " int"
Perform stateless autoconfiguration (0=off, 1=on)
.TP
-.BI request_prefix " int "
+.BI request_prefix " int"
Request a prefix through DHCPv6 Prefix Delegation (0=off, 1=on). Default
value: "0"
.TP
-.BI ll-attempts
+.B ll-attempts
Number of attempts to wait for a link-local address. Default value: "60"
.TP
-.BI ll-interval
+.B ll-interval
Link-local address polling interval in seconds. Default value: "0.1"
.RE
.SS The tunnel Method
-This method is used to create IP6GRE, IP6IP6 or IPIP6 tunnels. You need to
have the \fBip\fP binary from the \fBiproute\fP package. For IP6GRE tunnels,
you will need to load the ip6_gre module and the ip6_tunnel module for IP6IP6
or IPIP6 tunnels.
+This method is used to create IP6GRE, IP6IP6 or IPIP6 tunnels. You need to
have the \fBip\fP binary from the \fBiproute\fP package. For IP6GRE tunnels,
you will need to load the ip6_gre module and the ip6_tunnel module for IP6IP6
or IPIP6 tunnels.
.PP
.B Options
.RS
.TP
-.BI address " address "
+.BI address " address"
Local Address (colon delimited)
.TP
-.BI netmask " mask "
-Netmask (number of bits, eg 64)
+.BI netmask " mask"
+Netmask (number of bits, e.g.\& 64)
.TP
-.BI mode " type "
+.BI mode " type"
Tunnel type (either IP6GRE, IP6IP6 or IPIP6) \fBrequired\fP
.TP
-.BI endpoint " address "
+.BI endpoint " address"
Address of other tunnel endpoint (colon delimited) \fBrequired\fP
.TP
-.BI dstaddr " address "
+.BI dstaddr " address"
Remote address (remote address inside tunnel)
.TP
-.BI local " address "
+.BI local " address"
Address of the local endpoint (colon delimited)
.TP
-.BI metric " metric "
+.BI metric " metric"
Routing metric for default gateway (integer)
.TP
-.BI gateway " address "
+.BI gateway " address"
Default gateway (colon delimited)
.TP
-.BI ttl " time "
+.BI ttl " time"
TTL setting
.TP
-.BI mtu " size "
+.BI mtu " size"
MTU size
.TP
-.BI encaplimit " limit "
+.BI encaplimit " limit"
Encapsulation limit ("none" or integer)
.RE
.SS The v4tunnel Method
-This method may be used to setup an IPv6-over-IPv4 tunnel. It requires the
\fBip\fP command from the \fBiproute\fP package.
+This method may be used to setup an IPv6-over-IPv4 tunnel. It requires the
\fBip\fP command from the \fBiproute\fP package.
.PP
.B Options
.RS
.TP
-.BI address " address "
+.BI address " address"
Address (colon delimited/netmask) \fBrequired\fP
.TP
-.BI netmask " mask "
-Netmask (number of bits, eg 64) \fBdeprecated\fP
+.BI netmask " mask"
+Netmask (number of bits, e.g.\& 64) \fBdeprecated\fP
.TP
-.BI endpoint " address "
+.BI endpoint " address"
Address of other tunnel endpoint (IPv4 dotted quad) \fBrequired\fP
.TP
-.BI local " address "
+.BI local " address"
Address of the local endpoint (IPv4 dotted quad)
.TP
-.BI metric " metric "
+.BI metric " metric"
Routing metric for default gateway (integer)
.TP
-.BI gateway " address "
+.BI gateway " address"
Default gateway (colon delimited)
.TP
-.BI ttl " time "
+.BI ttl " time"
TTL setting
.TP
-.BI mtu " size "
+.BI mtu " size"
MTU size
.TP
.BI preferred-lifetime " int"
Time that address remains preferred
.RE
.SS The 6to4 Method
-This method may be used to setup a 6to4 tunnel. It requires the \fBip\fP
command from the \fBiproute\fP package.
+This method may be used to setup a 6to4 tunnel. It requires the \fBip\fP
command from the \fBiproute\fP package.
.PP
.B Options
.RS
.TP
-.BI local " address "
+.BI local " address"
Address of the local endpoint (IPv4 dotted quad) \fBrequired\fP
.TP
-.BI metric " metric "
+.BI metric " metric"
Routing metric for default gateway (integer)
.TP
-.BI ttl " time "
+.BI ttl " time"
TTL setting
.TP
-.BI mtu " size "
+.BI mtu " size"
MTU size
.TP
.BI preferred-lifetime " int"
@@ -896,13 +896,13 @@ Time that address remains preferred
This section documents the methods available in the
can address family.
.SS The static Method
-This method may be used to setup a Controller Area Network (CAN) interface. It
requires the the \fBip\fP command from the \fBiproute\fP package.
+This method may be used to setup a Controller Area Network (CAN) interface. It
requires the \fBip\fP command from the \fBiproute\fP package.
.PP
.B Options
.RS
.TP
.BI bitrate " bitrate "
-bitrate (1..1000000) \fBrequired\fP
+bitrate (1..1.000.000) \fBrequired\fP
.TP
.BI samplepoint " samplepoint"
sample point (0.000..0.999)
@@ -948,7 +948,7 @@ script. See also Debian bug #101728.
.SH AUTHOR
The ifupdown suite was written by Anthony Towns <a...@azure.humbug.org.au>.
This manpage was contributed by Joey Hess <j...@kitenet.net>.
-.SH "SEE ALSO"
+.SH SEE ALSO
.BR ifup (8),
.BR ip (8),
.BR ifconfig (8),
@@ -959,8 +959,8 @@ For advice on configuring this package r
.B Network Configuration
chapter of the \fIDebian Reference\fR manual,
available at
-\fIhttp://www.debian.org/doc/manuals/debian-reference/ch05.en.html\fR
-or in the \fBdebian-reference-en\fR package.
+\fIhttp://www.debian.org/\:doc/\:manuals/\:debian\-reference/\:ch05.en.html\fR
+or in the \fBdebian-reference\-en\fR package.
.P
Examples of how to set up interfaces can be found in
-.BR /usr/share/doc/ifupdown/examples/network-interfaces.gz .
+.BR /usr/share/doc/ifupdown/examples/network\-interfaces.gz .
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>
The same goes for man pages that are used as an input.
For a style guide use
mandoc -T lint
-.-
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.
Not beginning each input sentence on a new line.
Line length should thus be reduced.
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)
-.-
