Skip to content

Commit

Permalink
Fix hypen in man pages (Debian Bug#288343 from Andrew Moise)
Browse files Browse the repository at this point in the history
Move man pages to sysadmin books
update samples for route(8) (Debian Bug#400844, #368697 Danny Rathjens)
update see also for ifconfig(8) (Debian Bug#365916 Dan Jacobs)
  • Loading branch information
Bernd Eckenfels committed Oct 2, 2008
1 parent 11b7232 commit 0009712
Show file tree
Hide file tree
Showing 11 changed files with 91 additions and 88 deletions.
2 changes: 1 addition & 1 deletion man/en_US/arp.8
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH ARP 8 "2008-10-03" "net\-tools" "Linux System Administrator's Manual"
.TH ARP 8 "2008\-10\-03" "net\-tools" "Linux System Administrator's Manual"
.SH NAME
arp \- manipulate the system ARP cache
.SH SYNOPSIS
Expand Down
8 changes: 4 additions & 4 deletions man/en_US/ethers.5
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH ETHERS 5 "May 15th, 2005" "" "File formats"
.TH ETHERS 5 "2008\-10\-03" "net\-tools" "Linux System Administrator's Manual"
.SH NAME \"{{{roff}}}\"{{{
ethers \- Ethernet address to IP number database
.\"}}}
Expand All @@ -7,17 +7,17 @@ ethers \- Ethernet address to IP number database
IP numbers, one line for each IP number:
.sp
.RS
\fIEthernet-address\fP \fIIP-number\fP
\fIEthernet\-address\fP \fIIP\-number\fP
.RE
.sp
The two items are separated by any number of SPACE and/or TAB characters.
A \fB#\fP at the beginning of a line starts a comment
which extends to the end of the line. The \fIEthernet-address\fP is
which extends to the end of the line. The \fIEthernet\-address\fP is
written as
.IR x : x : x : x : x : x ,
where \fIx\fP is a hexadecimal number between \fB0\fP and \fBff\fP
which represents one byte of the address, which is in network byte
order (big-endian). The \fIIP-number\fP may be a hostname which
order (big-endian). The \fIIP\-number\fP may be a hostname which
can be resolved by DNS or a dot separated number.
.\"}}}
.SH EXAMPLES \"{{{
Expand Down
10 changes: 5 additions & 5 deletions man/en_US/hostname.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH HOSTNAME 1 "28 Jan 1996" "net-tools" "Linux Programmer's Manual"
.TH HOSTNAME 1 "2008\-10\-03" "net\-tools" "Linux System Administrator's Manual"

.SH NAME
hostname \- show or set the system's host name
Expand All @@ -23,7 +23,7 @@ nodename \- show or set the system's DECnet node name
.RB [ \-f ]
.RB [ \-\-fqdn ]
.RB [ \-i ]
.RB [ \-\-ip-address ]
.RB [ \-\-ip\-address ]
.RB [ \-\-long ]
.RB [ \-s ]
.RB [ \-\-short ]
Expand Down Expand Up @@ -181,7 +181,7 @@ part of the FQDN) in the \fI/etc/hosts\fR file.
.I "\-h, \-\-help"
Print a usage message and exit.
.TP
.I "\-i, \-\-ip-address"
.I "\-i, \-\-ip\-address"
Display the IP address(es) of the host.
.TP
.I "\-n, \-\-node"
Expand All @@ -205,9 +205,9 @@ Display the NIS domain name. If a parameter is given (or
.SH FILES
.B /etc/hosts
.SH AUTHOR
Peter Tobias, <[email protected]>
Peter Tobias, <tobias@et\-inf.fho\-emden.de>
.br
Bernd Eckenfels, <[email protected]> (NIS and manpage).
Bernd Eckenfels, <net\-[email protected]> (NIS and manpage).
.br
Steve Whitehouse, <[email protected]> (DECnet support and manpage).

16 changes: 8 additions & 8 deletions man/en_US/ifconfig.8
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH IFCONFIG 8 "2007-11-07" "net-tools" "Linux Programmer's Manual"
.TH IFCONFIG 8 "2008\-10\-03" "net\-tools" "Linux System Administrator's Manual"
.SH NAME
ifconfig \- configure a network interface
.SH SYNOPSIS
Expand All @@ -18,7 +18,7 @@ a single
.B interface
argument is given, it displays the status of the given interface
only; if a single
.B -a
.B \-a
argument is given, it displays the status of all interfaces, even
those that are down. Otherwise, it configures an interface.

Expand Down Expand Up @@ -138,13 +138,13 @@ are
can be used to tell the driver to auto-sense the media. Again, not
all drivers can do this.
.TP
.B "[-]broadcast [addr]"
.B "[\-]broadcast [addr]"
If the address argument is given, set the protocol broadcast
address for this interface. Otherwise, set (or clear) the
.B IFF_BROADCAST
flag for the interface.
.TP
.B "[-]pointopoint [addr]"
.B "[\-]pointopoint [addr]"
This keyword enables the
.B point-to-point
mode of an interface, meaning that it is a direct link between two
Expand Down Expand Up @@ -194,15 +194,15 @@ or
.BR iptables (8)
command.
.LP
Since net-tools 1.61 ifconfig is printing byte counters and human readable
Since net\-tools 1.60\-4 ifconfig is printing byte counters and human readable
counters with IEC 60027-2 units. So 1 KiB are 2^10 byte. Note, the numbers
are truncated to one decimal (which can by quite a large error if you
consider 0.1 PiB is 112.589.990.684.262 bytes :)
.LP
Interrupt problems with Ethernet device drivers fail with EAGAIN
.I (SIOCSIIFLAGS: Resource temporarily unavailable)
it is most likely a interrupt conflict. See
.I http://www.scyld.com/expert/irq-conflict.html
.I http://www.scyld.com/expert/irq\-conflict.html
for more information.
.SH FILES
.I /proc/net/socket
Expand All @@ -214,7 +214,7 @@ for more information.
While appletalk DDP and IPX addresses will be displayed they cannot be
altered by this command.
.SH SEE ALSO
route(8), netstat(8), arp(8), rarp(8), ipchains(8), iptables(8)
route(8), netstat(8), arp(8), rarp(8), ipchains(8), iptables(8), ifup(8), interfaces(5).
.br
http://physics.nist.gov/cuu/Units/binary.html - Prefixes for binary multiples
.SH AUTHORS
Expand All @@ -226,4 +226,4 @@ Phil Blundell, <[email protected]>
.br
Andi Kleen
.br
Bernd Eckenfels, <[email protected]>
Bernd Eckenfels, <net\-[email protected]>
12 changes: 6 additions & 6 deletions man/en_US/mii-tool.8
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
.\" Copyright (C) 2000 David A. Hinds -- [email protected]
.\" mii-tool.8 1.5 2000/04/25 22:58:19
.\"
.TH MII-TOOL 8 "2004/03/28 23:30:00" "net-tools"
.TH MII\-TOOL 8 "2008\-10\-03" "net\-tools" "Linux System Administrator's Manual"

.SH NAME
mii-tool \- view, manipulate media-independent interface status
mii\-tool \- view, manipulate media-independent interface status

.SH SYNOPSIS
.B mii-tool
.B mii\-tool
[\fB\-v\fR, \fB\-\-verbose\fR]
[\fB\-V\fR, \fB\-\-version\fR]
[\fB\-R\fR, \fB\-\-reset\fR]
Expand All @@ -32,12 +32,12 @@ single-speed hubs, are unable to autonegotiate. To handle such
devices, the MII protocol also allows for establishing a link by
simply detecting either a 10baseT or 100baseT link beat. The \fB\-F\fR
or \fB\-\-force\fR options can be used to force the MII to operate in
one mode, instead of autonegotiating. The \fB\-A\fR and \fB-F\fR
one mode, instead of autonegotiating. The \fB\-A\fR and \fB\-F\fR
options are mutually exclusive.
.PP
The default short output reports the negotiated link speed and link
status for each interface. If an interface or interfaces are not
specified on the command line, then \fBmii-tool\fR will check any
specified on the command line, then \fBmii\-tool\fR will check any
available interfaces from \fBeth0\fR through \fBeth7\fR.
.SH OPTIONS
.TP
Expand All @@ -59,7 +59,7 @@ Watch interface(s) and report changes in link status. The MII
interfaces are polled at one second intervals.
.TP
\fB\-l\fR, \fB\-\-log\fR
Used with \fB-w\fR, records link status changes in the system log
Used with \fB\-w\fR, records link status changes in the system log
instead of printing on standard output.
.TP
\fB\-F\fI media\fR, \fB\-\-force=\fImedia\fR
Expand Down
10 changes: 5 additions & 5 deletions man/en_US/nameif.8
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
.TH NAMEIF 8 "18 Oct 2000" "net-tools" "Linux's Administrator's Manual"
.TH NAMEIF 8 "2008\-10\-03" "net\-tools" "Linux System Administrator's Manual"
.SH NAME
nameif \- name network interfaces based on MAC addresses
.SH SYNOPSIS
.B "nameif [-c configfile] [-s]"
.B "nameif [\-c configfile] [\-s]"
.br
.B "nameif [-c configfile] [-s] {interface macaddress}"
.B "nameif [\-c configfile] [\-s] {interface macaddress}"
.SH DESCRIPTION
.B nameif
renames network interfaces based on mac addresses. When no arguments are
Expand All @@ -18,11 +18,11 @@ looks for the interface with the given MAC address and renames it to the
name given.

When the
.I -s
.I \-s
argument is given all error messages go to the syslog.

When the
.I -c
.I \-c
argument is given with a file name that file is read instead of /etc/mactab.

.SH NOTES
Expand Down
30 changes: 15 additions & 15 deletions man/en_US/netstat.8
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
.\" Modified: Tuan Hoang [email protected]
.\"
.\"
.TH NETSTAT 8 "2008-10-04" "net-tools" "Linux System Administrator's Manual"
.TH NETSTAT 8 "2008\-10\-03" "net\-tools" "Linux System Administrator's Manual"

.SH NAME
netstat \- Print network connections, routing tables, interface statistics, masquerade connections, and multicast memberships
Expand All @@ -23,7 +23,7 @@ netstat \- Print network connections, routing tables, interface statistics, masq
.RB [ \-\-listening | \-l ]
.RB [ \-\-all | \-a ]
.RB [ \-\-numeric | \-n ]
.RB [ \-\-numeric-hosts "] [" \-\-numeric-ports "] [" \-\-numeric-users ]
.RB [ \-\-numeric\-hosts "] [" \-\-numeric\-ports "] [" \-\-numeric\-users ]
.RB [ \-\-symbolic | \-N ]
.RB [ \-\-extend | \-e [ \-\-extend | \-e] ]
.RB [ \-\-timers | \-o ]
Expand All @@ -37,7 +37,7 @@ netstat \- Print network connections, routing tables, interface statistics, masq
.RB [ \-\-extend | \-e [ \-\-extend | \-e] ]
.RB [ \-\-verbose | \-v ]
.RB [ \-\-numeric | \-n ]
.RB [ \-\-numeric-hosts "] [" \-\-numeric-ports "] [" \-\-numeric-users ]
.RB [ \-\-numeric\-hosts "] [" \-\-numeric\-ports "] [" \-\-numeric\-users ]
.RB [ \-\-continuous | \-c]
.P
.B netstat
Expand All @@ -53,14 +53,14 @@ netstat \- Print network connections, routing tables, interface statistics, masq
.B netstat
.RB { \-\-groups | \-g }
.RB [ \-\-numeric | \-n ]
.RB [ \-\-numeric-hosts "] [" \-\-numeric-ports "] [" \-\-numeric-users ]
.RB [ \-\-numeric\-hosts "] [" \-\-numeric\-ports "] [" \-\-numeric\-users ]
.RB [ \-\-continuous | \-c]
.P
.B netstat
.RB { \-\-masquerade | \-M }
.RB [ \-\-extend | \-e ]
.RB [ \-\-numeric | \-n ]
.RB [ \-\-numeric-hosts "] [" \-\-numeric-ports "] [" \-\-numeric-users ]
.RB [ \-\-numeric\-hosts "] [" \-\-numeric\-ports "] [" \-\-numeric\-users ]
.RB [ \-\-continuous | \-c]
.P
.B netstat
Expand Down Expand Up @@ -121,13 +121,13 @@ useful information about unconfigured address families.
.SS "\-\-numeric , \-n"
Show numerical addresses instead of trying to determine symbolic host, port
or user names.
.SS "\-\-numeric-hosts"
.SS "\-\-numeric\-hosts"
shows numerical host addresses but does not affect the resolution of
port or user names.
.SS "\-\-numeric-ports"
.SS "\-\-numeric\-ports"
shows numerical port numbers but does not affect the resolution of
host or user names.
.SS "\-\-numeric-users"
.SS "\-\-numeric\-users"
shows numerical user IDs but does not affect the resolution of host or
port names.

Expand Down Expand Up @@ -170,7 +170,7 @@ Show the PID and name of the program to which each socket belongs.
Show only listening sockets. (These are omitted by default.)
.SS "\-a, \-\-all"
Show both listening and non-listening sockets. With the
.B --interfaces
.B \-\-interfaces
option, show interfaces that are not up
.SS "\-F"
Print routing information from the FIB. (This is the default.)
Expand All @@ -182,10 +182,10 @@ Print routing information from the route cache.
.SS Active Internet connections \fR(TCP, UDP, raw)\fR
.SS "Proto"
The protocol (tcp, udp, raw) used by the socket.
.SS "Recv-Q"
.SS "Recv\-Q"
Established: The count of bytes not copied by the user program connected to this socket.
Listening: Since Kernel 2.6.18 this column contains the current syn backlog.
.SS "Send-Q"
.SS "Send\-Q"
Established: The count of bytes not acknowledged by the remote host.
Listening: Since Kernel 2.6.18 this column contains the maximum size of the syn backlog.
.SS "Local Address"
Expand Down Expand Up @@ -262,7 +262,7 @@ The username or the user id (UID) of the owner of the socket.
.SS "PID/Program name"
Slash-separated pair of the process id (PID) and process name of the
process that owns the socket.
.B --program
.B \-\-program
causes this column to be included. You will also need
.I superuser
privileges to see this information on sockets you don't own. This
Expand Down Expand Up @@ -365,7 +365,7 @@ to the socket.
.PP
.SH NOTES
Starting with Linux release 2.2
.B netstat -i
.B netstat \-i
does not show interface statistics for alias interfaces. To get per
alias interface counters you need to setup explicit rules using the
.BR ipchains(8)
Expand Down Expand Up @@ -445,12 +445,12 @@ as it is viewed. This is unlikely to occur.
.P
.SH AUTHORS
The netstat user interface was written by Fred Baumgarten
<[email protected]>, the man page basically
<[email protected]\-karlsruhe.de>, the man page basically
by Matt Welsh <[email protected]>. It was updated by
Alan Cox <[email protected]> but could do with a bit more
work. It was updated again by Tuan Hoang
<[email protected]>.
.br
The man page and the command included in the net-tools
The man page and the command included in the net\-tools
package is totally rewritten by Bernd Eckenfels
<[email protected]>.
2 changes: 1 addition & 1 deletion man/en_US/plipconfig.8
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH PLIPCONFIG 8 "17 February 1995" "" ""
.TH PLIPCONFIG 8 "2008\-10\-03" "net\-tools" "Linux System Administrator's Manual"
.SH NAME
plipconfig \- fine tune PLIP device parameters
.SH SYNOPSIS
Expand Down
12 changes: 6 additions & 6 deletions man/en_US/rarp.8
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
.TH RARP 8 "4 August 1997" "net-tools" "Linux Programmer's Manual"
.TH RARP 8 "2008\-10\-03" "net\-tools" "Linux System Administrator's Manual"
.SH NAME
rarp \- manipulate the system RARP table
.SH SYNOPSIS
.B "rarp [-V] [--version] [-h] [--help]"
.B "rarp [\-V] [\-\-version] [\-h] [\-\-help]"
.br
.B "rarp -a"
.B "rarp \-a"
.br
.B "rarp [-v] -d hostname ..."
.B "rarp [\-v] \-d hostname ..."
.br
.B "rarp [-v] [-t type] -s hostname hw_addr"
.B "rarp [\-v] [\-t type] \-s hostname hw_addr"
.SH NOTE
.P
This program is obsolete. From version 2.3, the Linux kernel
no longer contains RARP support. For a replacement RARP daemon, see
.I
ftp://ftp.dementia.org/pub/net-tools
ftp://ftp.dementia.org/pub/net\-tools
.SH DESCRIPTION
.B Rarp
manipulates the kernel's RARP table in various ways. The primary options
Expand Down
Loading

0 comments on commit 0009712

Please sign in to comment.