[IPROUTE] manpage for lnstat

[IPROUTE] manpage for lnstat

[Michael Prokop]

[-- Attachment #1.1: Type: text/plain, Size: 235 bytes --]

Hello,

I wrote a manpage for lnstat, would be great if it could be applied
to the next release.

@Harald, I'm following your 'If somebody wants to do a manpage, feel
free to send me a patch :)' of lnstat's README. :)

regards,
-mika-

[-- Attachment #1.2: lnstat.1 --]
[-- Type: text/plain, Size: 2087 bytes --]

.TH LNSTAT 1
.SH NAME
lnstat \- unified linux network statistics
.SH SYNOPSIS
.B lnstat
.RI [ options ]
.SH DESCRIPTION
This manual page documents briefly the
.B lnstat
command.
.PP
\fBlnstat\fP is a generalized and more feature-complete replacement for the old rtstat program.
In addition to routing cache statistics, it supports any kind of statistics the linux kernel
exports via a file in /proc/net/stat/.
.SH OPTIONS
These programs follow the usual GNU command line syntax, with long
options starting with two dashes (`-').
lnstat supports the following options.
.TP
.B \-h, \-\-help
Show summary of options.
.TP
.B \-V, \-\-version
Show version of program.
.TP
.B \-c, \-\-count <count>
Print <count> number of intervals.
.TP
.B \-d, \-\-dump
Dump list of available files/keys.
.TP
.B \-f, \-\-file <file>
Statistics file to use.
.TP
.B \-i, \-\-interval <intv>
Set interval to 'intv' seconds.
.TP
.B \-k, \-\-keys k,k,k,...
Display only keys specified.
.TP
.B \-s, \-\-subject [0-2]
Specify display of subject/header. '0' means no header at all, '1' prints a header only at start of the program and '2' prints a header every 20 lines.
.TP
.B \-w, \-\-width n,n,n,...
Width for each field.
.SH USAGE EXAMPLES
.TP
.B # lnstat -d
Get a list of supported statistics files.
.TP
.B # lnstat -k arp_cache:entries,rt_cache:in_hit,arp_cache:destroys
Select the specified files and keys.
.TP
.B # lnstat -i 10
Use an interval of 10 seconds.
.TP
.B # lnstat -f ip_conntrack
Use only the specified file for statistics.
.TP
.B # lnstat -s 0
Do not print a header at all.
.TP
.B # lnstat -s 20
Print a header at start and every 20 lines.
.TP
.B # lnstat -c -1 -i 1 -f rt_cache -k entries,in_hit,in_slow_tot
Display statistics for keys entries, in_hit and in_slow_tot of field rt_cache every second.
.SH SEE ALSO
.BR ip (8),
and /usr/share/doc/iproute-doc/README.lnstat (package iproute-doc on Debian)
.br
.SH AUTHOR
lnstat was written by Harald Welte <laforge@gnumonks.org>.
.PP
This manual page was written by Michael Prokop <mika@grml.org> for the Debian project (but may be used by others).

[-- Attachment #2: Type: application/pgp-signature, Size: 189 bytes --]

Re: [IPROUTE] manpage for lnstat

[Harald Welte]

[-- Attachment #1: Type: text/plain, Size: 628 bytes --]

On Thu, Oct 26, 2006 at 10:41:26PM +0200, Michael Prokop wrote:
> Hello,
> 
> I wrote a manpage for lnstat, would be great if it could be applied
> to the next release.

Stephen: Please include it into your next release, looks fine to me.

> @Harald, I'm following your 'If somebody wants to do a manpage, feel
> free to send me a patch :)' of lnstat's README. :)

thanks a lot!
-- 
- Harald Welte <laforge@gnumonks.org>          	        http://gnumonks.org/
============================================================================
We all know Linux is great...it does infinite loops in 5 seconds. -- Linus

[-- Attachment #2: Type: application/pgp-signature, Size: 189 bytes --]

Re: [IPROUTE] manpage for lnstat

[Stephen Hemminger]

On Thu, 26 Oct 2006 22:41:26 +0200
Michael Prokop <mika@grml.org> wrote:

> -mika-
> 
> [lnstat.1  text/plain (2087 bytes)] 

Added, but I took the liberty of moving it to section 8
(lnstat.8) because that is where the other iproute2
commands are.

-- 
Stephen Hemminger <shemminger@osdl.org>