Package: net-tools
Severity: minor
----- Forwarded message from [EMAIL PROTECTED] -----
Envelope-to: [EMAIL PROTECTED]
Delivery-date: Tue, 06 Feb 2007 22:11:45 +0100
From: [EMAIL PROTECTED]
To: [EMAIL PROTECTED]
Subject: problems in netstat.8
X-Scanned-By: MIMEDefang 2.58 on 62.111.65.66
X-Spam-Checker-Version: SpamAssassin 3.0.3 (2005-04-27) on
calista.eckenfels.net
X-Spam-Level:
X-Spam-Status: No, score=0.1 required=4.7 tests=AWL,BAYES_50,NO_REAL_NAME
autolearn=no version=3.0.3
This is automatically generated email about problems in a man page for which
you appear to be responsible. If you are not the right person or list, tell
me and I will attempt to correct my database.
See http://catb.org/~esr/doclifter/problems.html for details on how and
why these patches were generated. Feel free to email me with any questions.
Note: These patches do not change the mod date of any manual page. You
may wish to do that by hand.
Problems with netstat.8:
1. Broken command synopsis syntax. This may mean you're using a
construction in the command synopsis other than the standard
[ ] | { }, or it may mean you have running text in the command synopsis
section (the latter is not technically an error, but it's impossible
to translate into DocBook markup).
2. .TP or other markup used where .SS is needed, or the reverse.
--- netstat.8-orig 2007-02-06 15:23:07.000000000 -0500
+++ netstat.8 2007-02-06 15:23:16.000000000 -0500
@@ -16,7 +16,13 @@
.SH SYNOPSIS
.B netstat
-.RI [ address_family_options ]
+.RB [ \-\-protocol= { inet , unix , ipx , ax25 , netrom , ddp }[, ...] ]
+.RB [ \-\-unix | \-x ]
+.RB [ \-\-inet | \-\-ip ]
+.RB [ \-\-ax25 ]
+.RB [ \-\-ipx ]
+.RB [ \-\-netrom ]
+.RB [ \-\-ddp ]
.RB [ \-\-tcp | \-t ]
.RB [ \-\-udp | \-u ]
.RB [ \-\-raw | \-w ]
@@ -34,7 +40,13 @@
.P
.B netstat
.RB { \-\-route | \-r }
-.RI [ address_family_options ]
+.RB [ \-\-protocol= { inet , unix , ipx , ax25 , netrom , ddp }[, ...] ]
+.RB [ \-\-unix | \-x ]
+.RB [ \-\-inet | \-\-ip ]
+.RB [ \-\-ax25 ]
+.RB [ \-\-ipx ]
+.RB [ \-\-netrom ]
+.RB [ \-\-ddp ]
.RB [ \-\-extend | \-e [ \-\-extend | \-e] ]
.RB [ \-\-verbose | \-v ]
.RB [ \-\-numeric | \-n ]
@@ -81,16 +93,6 @@
.P
.B netstat
.RB { \-\-help | \-h }
-.P
-.IR address_family_options :
-.PP
-.RB [ \-\-protocol= { inet , unix , ipx , ax25 , netrom , ddp }[, ...] ]
-.RB [ \-\-unix | \-x ]
-.RB [ \-\-inet | \-\-ip ]
-.RB [ \-\-ax25 ]
-.RB [ \-\-ipx ]
-.RB [ \-\-netrom ]
-.RB [ \-\-ddp ]
.SH DESCRIPTION
.B Netstat
@@ -103,35 +105,45 @@
displays a list of open sockets. If you don't specify any
address families, then the active sockets of all configured address
families will be printed.
-.SS "\-\-route , \-r"
+.TP
+.B "\-\-route , \-r"
Display the kernel routing tables.
-.SS "\-\-groups , \-g"
+.TP
+.B "\-\-groups , \-g"
Display multicast group membership information for IPv4 and IPv6.
-.SS "\-\-interface=\fIiface \fR, \fB\-i"
-Display a table of all network interfaces, or the specified
-.IR iface ) .
-.SS "\-\-masquerade , \-M"
+.TP
+.B "\-\-interface=\fIiface \fR, \fB\-i"
+Display a table of all network interfaces, or the specified
+.IR iface ).
+.TP
+.B "\-\-masquerade , \-M"
Display a list of masqueraded connections.
-.SS "\-\-statistics , \-s"
+.TP
+.B "\-\-statistics , \-s"
Display summary statistics for each protocol.
.SH OPTIONS
-.SS "\-\-verbose , \-v"
+.TP
+.B "\-\-verbose , \-v"
Tell the user what is going on by being verbose. Especially print some
useful information about unconfigured address families.
-.SS "\-\-numeric , \-n"
+.TP
+.B "\-\-numeric , \-n"
Show numerical addresses instead of trying to determine symbolic host, port
or user names.
-.SS "\-\-numeric-hosts"
+.TP
+.B "\-\-numeric-hosts"
shows numerical host addresses but does not affect the resolution of
port or user names.
-.SS "\-\-numeric-ports"
+.TP
+.B "\-\-numeric-ports"
shows numerical port numbers but does not affect the resolution of
host or user names.
-.SS "\-\-numeric-users"
+.TP
+.B "\-\-numeric-users"
shows numerical user IDs but does not affect the resolution of host or
port names.
-
-.SS "\-\-protocol=\fIfamily \fR, \fB\-A"
+.TP
+.B "\-\-protocol=\fIfamily \fR, \fB\-A"
Specifies the address families (perhaps better described as low level
protocols) for which connections are to be shown.
.I family
@@ -156,31 +168,42 @@
The address family
.B inet
includes raw, udp and tcp protocol sockets.
-.SS "\-c, \-\-continuous"
+.TP
+.B "\-c, \-\-continuous"
This will cause
.B netstat
to print the selected information every second continuously.
-.SS "\-e, \-\-extend"
+.TP
+.B "\-e, \-\-extend"
Display additional information. Use this option twice for maximum detail.
-.SS "\-o, \-\-timers"
+.TP
+.B "\-o, \-\-timers"
Include information related to networking timers.
-.SS "\-p, \-\-program"
+.TP
+.B "\-p, \-\-program"
Show the PID and name of the program to which each socket belongs.
-.SS "\-l, \-\-listening"
+.TP
+.B "\-l, \-\-listening"
Show only listening sockets. (These are omitted by default.)
-.SS "\-a, \-\-all"
+.TP
+.B "\-a, \-\-all"
Show both listening and non-listening sockets. With the
.B --interfaces
option, show interfaces that are not marked
-.SS "\-F"
+.TP
+.B "\-F"
Print routing information from the FIB. (This is the default.)
-.SS "\-C"
+.TP
+.B "\-C"
Print routing information from the route cache.
-.SS "\-Z \-\-context"
+.TP
+.B "\-Z \-\-context"
If SELinux enabled print SELinux context.
-.SS "\-T \-\-notrim"
+.TP
+.B "\-T \-\-notrim"
Stop trimming long addresses.
-.SS delay
+.TP
+.B delay
Netstat will cycle printing through statistics every
.B delay
seconds.
@@ -189,66 +212,63 @@
.SH OUTPUT
.P
.SS Active Internet connections \fR(TCP, UDP, raw)\fR
-.SS "Proto"
+.TP
+.B "Proto"
The protocol (tcp, udp, raw) used by the socket.
-.SS "Recv-Q"
+.TP
+.B "Recv-Q"
The count of bytes not copied by the user program connected to this socket.
-.SS "Send-Q"
+.TP
+.B "Send-Q"
The count of bytes not acknowledged by the remote host.
-.SS "Local Address"
+.TP
+.B "Local Address"
Address and port number of the local end of the socket. Unless the
.BR \-\-numeric " (" \-n )
option is specified, the socket address is resolved to its canonical
host name (FQDN), and the port number is translated into the
corresponding service name.
-.SS "Foreign Address"
+.TP
+.B "Foreign Address"
Address and port number of the remote end of the socket.
Analogous to "Local Address."
-.SS "State"
+.TP
+.B "State"
The state of the socket. Since there are no states in raw mode and usually no
states used in UDP, this column may be left blank. Normally this can be one
of several values:
+.RS
.TP
-.I
-ESTABLISHED
+.I ESTABLISHED
The socket has an established connection.
.TP
-.I
-SYN_SENT
+.I SYN_SENT
The socket is actively attempting to establish a connection.
.TP
-.I
-SYN_RECV
+.I SYN_RECV
A connection request has been received from the network.
.TP
-.I
-FIN_WAIT1
+.I FIN_WAIT1
The socket is closed, and the connection is shutting down.
.TP
-.I
-FIN_WAIT2
+.I FIN_WAIT2
Connection is closed, and the socket is waiting for a shutdown from the
remote end.
.TP
-.I
-TIME_WAIT
+.I TIME_WAIT
The socket is waiting after close to handle packets still in the network.
.TP
-.I
-CLOSED
+.I CLOSED
The socket is not being used.
.TP
-.I
-CLOSE_WAIT
+.I CLOSE_WAIT
The remote end has shut down, waiting for the socket to close.
.TP
-.I
-LAST_ACK
+.I LAST_ACK
The remote end has shut down, and the socket is closed. Waiting for
acknowledgement.
.TP
-.I
-LISTEN
+.I LISTEN
The socket is listening for incoming connections. Such sockets are
not included in the output unless you specify the
.BR \-\-listening " (" \-l )
@@ -256,17 +276,18 @@
.BR \-\-all " (" \-a )
option.
.TP
-.I
-CLOSING
+.I CLOSING
Both sockets are shut down but we still don't have all our data
sent.
.TP
-.I
-UNKNOWN
+.I UNKNOWN
The state of the socket is unknown.
-.SS "User"
+.RE
+.TP
+.B "User"
The username or the user id (UID) of the owner of the socket.
-.SS "PID/Program name"
+.TP
+.B "PID/Program name"
Slash-separated pair of the process id (PID) and process name of the
process that owns the socket.
.B --program
@@ -274,15 +295,19 @@
.I superuser
privileges to see this information on sockets you don't own. This
identification information is not yet available for IPX sockets.
-.SS "Timer"
+.TP
+.B "Timer"
(this needs to be written)
.P
.SS Active UNIX domain Sockets
-.SS "Proto"
+.TP
+.B "Proto"
The protocol (usually unix) used by the socket.
-.SS "RefCnt"
+.TP
+.B "RefCnt"
The reference count (i.e. attached processes via this socket).
-.SS "Flags"
+.TP
+.B "Flags"
The flags displayed is SO_ACCEPTON (displayed as
.BR ACC ),
SO_WAITDATA
@@ -293,39 +318,37 @@
is used on unconnected sockets if their corresponding
processes are waiting for a connect request. The other flags are not
of normal interest.
-.SS "Type"
+.TP
+.B "Type"
There are several types of socket access:
.TP
.I
SOCK_DGRAM
The socket is used in Datagram (connectionless) mode.
+.RS
.TP
-.I
-SOCK_STREAM
+.I SOCK_STREAM
This is a stream (connection) socket.
.TP
-.I
-SOCK_RAW
+.I SOCK_RAW
The socket is used as a raw socket.
.TP
-.I
-SOCK_RDM
+.I SOCK_RDM
This one serves reliably-delivered messages.
.TP
-.I
-SOCK_SEQPACKET
+.I SOCK_SEQPACKET
This is a sequential packet socket.
.TP
-.I
-SOCK_PACKET
+.I SOCK_PACKET
Raw interface access socket.
.TP
-.I
-UNKNOWN
+.I UNKNOWN
Who ever knows what the future will bring us - just fill in here :-)
-.PP
-.SS "State"
-This field will contain one of the following Keywords:
+.RE
+.TP
+.B "State"
+This field will contain one of the following keywords:
+.RS
.TP
.I FREE
The socket is not allocated
@@ -352,12 +375,15 @@
.TP
.I UNKNOWN
This state should never happen.
-.SS "PID/Program name"
+.RE
+.TP
+.B "PID/Program name"
Process ID (PID) and process name of the process that has the socket open.
More info available in
.B "Active Internet connections"
section written above.
-.SS "Path"
+.TP
+.B "Path"
This is the path name as which the corresponding processes attached
to the socket.
.P
@@ -379,65 +405,64 @@
command.
.SH FILES
-.ta
+.TP
.I /etc/services
-- The services translation file
-
+.TP
.I /proc
-- Mount point for the proc filesystem, which gives access to kernel
status information via the following files.
-
+.TP
.I /proc/net/dev
-- device information
-
+.TP
.I /proc/net/raw
-- raw socket information
-
+.TP
.I /proc/net/tcp
-- TCP socket information
-
+.TP
.I /proc/net/udp
-- UDP socket information
-
+.TP
.I /proc/net/igmp
-- IGMP multicast information
-
+.TP
.I /proc/net/unix
-- Unix domain socket information
-
+.TP
.I /proc/net/ipx
-- IPX socket information
-
+.TP
.I /proc/net/ax25
-- AX25 socket information
-
+.TP
.I /proc/net/appletalk
-- DDP (appletalk) socket information
-
+.TP
.I /proc/net/nr
-- NET/ROM socket information
-
+.TP
.I /proc/net/route
-- IP routing information
-
+.TP
.I /proc/net/ax25_route
-- AX25 routing information
-
+.TP
.I /proc/net/ipx_route
-- IPX routing information
-
+.TP
.I /proc/net/nr_nodes
-- NET/ROM nodelist
-
+.TP
.I /proc/net/nr_neigh
-- NET/ROM neighbours
-
+.TP
.I /proc/net/ip_masquerade
-- masqueraded connections
-
+.TP
.I /proc/net/snmp
-- statistics
-.fi
.P
.SH SEE ALSO
.BR route (8),
@@ -457,7 +482,7 @@
Alan Cox <[EMAIL PROTECTED]> but could do with a bit more
work. It was updated again by Tuan Hoang
<[EMAIL PROTECTED]>.
-.br
+.LP
The man page and the command included in the net-tools
package is totally rewritten by Bernd Eckenfels
<[EMAIL PROTECTED]>.
-----------------------------
--
Eric S. Raymond
----- End forwarded message -----
--
(OO) -- [EMAIL PROTECTED] --
( .. ) [EMAIL PROTECTED],linux.de,debian.org} http://www.eckes.org/
o--o 1024D/E383CD7E [EMAIL PROTECTED] v:+497211603874 f:+49721151516129
(O____O) When cryptography is outlawed, bayl bhgynjf jvyy unir cevinpl!
--
To UNSUBSCRIBE, email to [EMAIL PROTECTED]
with a subject of "unsubscribe". Trouble? Contact [EMAIL PROTECTED]
