and added files

[bcm963xx.git] / userapps / opensource / net-snmp / man / snmptable.1.def

diff --git a/userapps/opensource/net-snmp/man/snmptable.1.def b/userapps/opensource/net-snmp/man/snmptable.1.def
new file mode 100644 (file)
index 0000000..a3cc062
--- /dev/null
+++ b/userapps/opensource/net-snmp/man/snmptable.1.def
@@ -0,0 +1,94 @@
+.\" /************************************************************
+.\"    Copyright 1997 Niels Baggesen
+.\" 
+.\"                       All Rights Reserved
+.\" 
+.\" Permission to use, copy, modify, and distribute this software and its 
+.\" documentation for any purpose and without fee is hereby granted, 
+.\" provided that the above copyright notice appear in all copies.
+.\" 
+.\" I DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
+.\" ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
+.\" I BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
+.\" ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
+.\" WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
+.\" ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
+.\" SOFTWARE.
+.\" ******************************************************************/
+.TH SNMPTABLE 1 "08 Feb 2002" VVERSIONINFO "Net-SNMP"
+.UC 4
+.SH NAME
+snmptable - obtain and print an SNMP table
+.SH SYNOPSIS
+.B snmptable
+[COMMON OPTIONS] TABLE-OID
+.SH DESCRIPTION
+.B snmptable
+is an SNMP application that repeatedly uses the SNMP GETNEXT or
+GETBULK requests to query for information on a network entity.  The
+parameter
+.I TABLE-OID
+must specify an SNMP table.
+.SH OPTIONS
+.TP 8
+.B -Cb
+Display only a brief heading. Any common prefix of the table field
+names will be deleted.
+.TP 
+.B -CB
+Do not use GETBULK requests to retrieve data, only GETNEXT.
+.TP
+.BI -Cf " STRING"
+The string
+.I STRING
+is used to separate table columns.  With this option, each table entry
+will be printed in compact form, just with the string given to
+separate the columns (useful if you want to import it into a
+database).  Otherwise it is printed in nicely aligned columns.
+.TP
+.B -Ch
+Display
+.I only
+the column headings.
+.TP
+.B -CH
+Do not display the column headings.
+.TP
+.B -Ci
+This option prepends the index of the entry to all printed lines.
+.TP 
+.BI -Cw " WIDTH"
+Specifies the width of the lines when the table is printed.
+If the lines will be longer, the table will be printed in sections of
+at most 
+.I WIDTH 
+characters.
+.PP
+In addition to these options,
+.B snmptable
+takes the common options described in the 
+.I snmpcmd(1)
+manual page.
+.SH EXAMPLES
+$ snmptable localhost public at.attable
+
+SNMP table: at.atTable
+
+atIfIndex   atPhysAddress   atNetAddress
+        1  8:0:20:20:0:ab 130.225.243.33
+.PP
+$ snmptable localhost public -Cf + at.attable
+
+SNMP table: at.atTable
+
+atIfIndex+atPhysAddress+atNetAddress
+1+8:0:20:20:0:ab+130.225.243.33
+.PP
+.SH "BUGS"
+The test for
+.I TABLE-OID
+actually specifying a table is rather heuristic.  Note also that the
+test requires the defining MIB file to be loaded.
+.PP
+.SH "SEE ALSO"
+snmpcmd(1), variables(5).