Package: ifupdown Version: 0.8.41 Severity: minor Tags: patch Dear Maintainer,
here are some notes and editorial fixes for the manual
The patch is in the attachment as a compressed file.
#####
Input file is interfaces.5
Output from "mandoc -T lint interfaces.5":
mandoc: interfaces.5:207:2: WARNING: skipping paragraph macro: PP empty
and more lines about input lines being too long.
#######
Remove space characters at the end of lines.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".
503:This method may be used to define the IPv4 loopback interface.
511:This method may be used to define Ethernet interfaces with statically
allocated IPv4 addresses.
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.
580:This method may be used to obtain an address via bootp.
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.
675:This method may be used to setup an IPX interface dynamically.
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).
711:This method may be used to define the IPv6 loopback interface.
719:This method may be used to define interfaces with statically assigned IPv6
addresses. By default, stateless autoconfiguration is disabled for this
interface.
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.
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.
#####
Mark a full stop (.) 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.
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)
#####
Reduce space between words.
161:it is accompanied by a suffix of the form \fI=LOGICAL\fR, in which case
164:mapping specifications, until no further mappings are possible. If the
#####
Change -- in x--y to \(em (em-dash), or, if an
option, to \-\-
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),
#####
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 0x55, 2D) to a minus (\-), if in front of a
name for an option.
76:not be brought down by the command "ifdown -a". Its main use is to prevent an
436:The physical name of the interface being processed, or "--all" (see below).
#####
Find a repeated word
! 899 --> the
#####
Add a thin space (\|) around "|" to increase readability
911:loop back CAN Messages (on|off)
914:listen only mode (on|off)
917:activate triple sampling (on|off)
920:one shot mode (on|off)
923:activate berr reporting (on|off)
#####
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,
#####
Remove trailing spaces in a line after .TP as the default indent is not
too short.
.TP
.BI xxxxxx " yyy "
change to
.TP
.BI xxxxxx " yyy"
###
Not in the patch (too many affected lines)..
Split lines longer than 100 (80) characters into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.
#####
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.
The amount of space between sentences in the output can then be
controlled with the ".ss" request.'
#####
Patch is in the attachment
-- System Information:
Debian Release: trixie/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.1.27-1 (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.134
ii iproute2 6.1.0-3
ii libc6 2.36-9
Versions of packages ifupdown recommends:
ii isc-dhcp-client [dhcp-client] 4.4.3-P1-2
Versions of packages ifupdown suggests:
pn ppp <none>
pn rdnssd <none>
-- Configuration Files:
/etc/default/networking changed [not included]
/etc/init.d/networking changed [not included]
-- no debconf information
interfaces.5.diff.gz
Description: application/gzip
