[Python-modules-commits] r12942 - in packages/python-pysnmp4-apps/trunk/debian (pysnmpcmd.1)
deepak-guest at users.alioth.debian.org
deepak-guest at users.alioth.debian.org
Sat May 15 12:11:14 UTC 2010
Date: Saturday, May 15, 2010 @ 12:11:09
Author: deepak-guest
Revision: 12942
updated man page, removed hypen error
Modified:
packages/python-pysnmp4-apps/trunk/debian/pysnmpcmd.1
Modified: packages/python-pysnmp4-apps/trunk/debian/pysnmpcmd.1
===================================================================
--- packages/python-pysnmp4-apps/trunk/debian/pysnmpcmd.1 2010-05-15 12:09:14 UTC (rev 12941)
+++ packages/python-pysnmp4-apps/trunk/debian/pysnmpcmd.1 2010-05-15 12:11:09 UTC (rev 12942)
@@ -59,7 +59,7 @@
.\" ******************************************************************/
.TH PYSNMPCMD 1 "1 May 2007" "Version 4" "PySNMP"
.SH NAME
-pysnmpcmd - options and behaviour common to most of the PySNMP command-line tools
+pysnmpcmd \- options and behaviour common to most of the PySNMP command-line tools
.SH SYNOPSIS
.B pysnmpcmd
[OPTIONS] AGENT [PARAMETERS]
@@ -74,54 +74,54 @@
parameters are documented in the manual pages for each application.
.SH OPTIONS
.TP
-.BI -a " authProtocol"
+.BI \-a " authProtocol"
Set the authentication protocol (MD5 or SHA) used for authenticated SNMPv3
messages.
.TP
-.BI -A " authPassword"
+.BI \-A " authPassword"
Set the authentication pass phrase used for authenticated SNMPv3
messages.
.TP
-.BI -c " community"
+.BI \-c " community"
Set the community string for SNMPv1/v2c transactions.
.TP
-.B -d
+.B \-d
Dump (in hexadecimal) the raw SNMP packets sent and received.
.TP
-.B -D \fITOKEN[,...]
+.B \-D \fITOKEN[,...]
Turn on debugging output for the given
.IR "TOKEN" "(s)."
Try
.IR all
for extremely verbose output.
.TP
-.BI -e " engineID"
+.BI \-e " engineID"
Set the authoritative (security) engineID used for SNMPv3 REQUEST
messages. It is typically not necessary to specify this, as it will
usually be discovered automatically.
.TP
-.BI -E " engineID"
+.BI \-E " engineID"
Set the context engineID used for SNMPv3 REQUEST messages scopedPdu.
If not specified, this will default to the authoritative engineID.
.TP
-.B -h, --help
+.B \-h, \-\-help
Display a brief usage message and then exit.
.TP
-.B -H
+.B \-H
Display a list of configuration file directives understood by the
command and then exit.
.TP
-.BI -I " [hu]"
+.BI \-I " [hu]"
Specifies input parsing options. See
.B INPUT OPTIONS
below.
.TP
-.BI -l " secLevel"
+.BI \-l " secLevel"
Set the securityLevel used for SNMPv3 messages
(noAuthNoPriv|authNoPriv|authPriv). Appropriate pass phrase(s) must
provided when using any level higher than noAuthNoPriv.
.TP
-.BI -m " MIBLIST"
+.BI \-m " MIBLIST"
Specifies a colon separated list of MIB modules (not files) to load for
this application.
.IP
@@ -131,44 +131,44 @@
Every file whose name does not begin with "." will be parsed as
if it were a MIB file.
.TP
-.BI -M " DIRLIST"
+.BI \-M " DIRLIST"
Specifies a colon separated list of directories to search for MIBs.
-Note that MIBs specified using the -m option will be loaded from one
-of the directories listed by the -M option (or equivalents).
+Note that MIBs specified using the \-m option will be loaded from one
+of the directories listed by the \-M option (or equivalents).
.TP
-.BI -n " contextName"
+.BI \-n " contextName"
Set the contextName used for SNMPv3 messages. The default
contextName is the empty string "".
.TP
-.BI -O " [abeEfnqQsStTuUvxX]"
+.BI \-O " [abeEfnqQsStTuUvxX]"
Specifies output printing options. See
.B OUTPUT OPTIONS
below.
.TP
-.BI -r " retries"
+.BI \-r " retries"
Specifies the number of retries to be used in the requests. The default
is 5.
.TP
-.BI -t " timeout"
+.BI \-t " timeout"
Specifies the timeout in seconds between retries. The default is 1.
.TP
-.BI -u " secName"
+.BI \-u " secName"
Set the securityName used for authenticated SNMPv3 messages.
.TP
-.B -v \fI1\fR | \fI2c\fR | \fI3
+.B \-v \fI1\fR | \fI2c\fR | \fI3
Specifies the protocol version to use: 1 (RFCs 1155-1157), 2c (RFCs 1901-1908),
or 3 (RFCs 2571-2574). The default is typically version 3.
.TP
-.B -V, --version
+.B \-V, \-\-version
Display version information for the application and then exit.
.TP
-.BI -x " privProtocol"
+.BI \-x " privProtocol"
Set the privacy protocol (DES or AES) used for encrypted SNMPv3 messages.
.TP
-.BI -X " privPassword"
+.BI \-X " privPassword"
Set the privacy pass phrase used for encrypted SNMPv3 messages.
.TP
-.BI -Z " boots,time"
+.BI \-Z " boots,time"
Set the engineBoots and engineTime used for authenticated SNMPv3
messages. This will initialize the local notion of the agents
boots/time with an authenticated value stored in the LCD.
@@ -227,13 +227,13 @@
the following default output (unless otherwise specified):
.RS
.nf
-\fC$ snmpget -c public -v 1 localhost sysUpTime.0
+\fC$ snmpget \-c public \-v 1 localhost sysUpTime.0
SNMPv2-MIB::sysUpTime.0 = Timeticks: (14096763) 1 day, 15:09:27.63\fR
.fi
.RE
.TP
-.B -Oa
+.B \-Oa
Display string values as ASCII strings (unless there is a
\fCDISPLAY-HINT\fR defined for the corresponding MIB object).
By default, the library attempts to determine whether the value is
@@ -241,43 +241,43 @@
This option does not affect objects that \fIdo\fR have a Display Hint.
.TP
-.B -Ob
+.B \-Ob
Display table indexes numerically, rather than trying to interpret
the instance subidentifiers as string or OID values:
.RS
.nf
-\fC $ snmpgetnext -c public -v 1 localhost vacmSecurityModel
+\fC $ snmpgetnext \-c public \-v 1 localhost vacmSecurityModel
SNMP-VIEW-BASED-ACM-MIB::vacmSecurityModel.0."wes" = xxx
- $ snmpgetnext -c public -v 1 \fB-Ob\fP localhost vacmSecurityModel
- SNMP-VIEW-BASED-ACM-MIB::vacmSecurityModel.0.3.119.101.115 = xxx\fR
+ $ snmpgetnext \-c public \-v 1 \fB-Ob\fP localhost vacmSecurityModel
+ SNMP\-VIEW-BASED-ACM-MIB::vacmSecurityModel.0.3.119.101.115 = xxx\fR
.fi
.RE
.TP
-.B -Oe
+.B \-Oe
Removes the symbolic labels from enumeration values:
.RS
.nf
-\fC $ snmpget -c public -v 1 localhost ipForwarding.0
+\fC $ snmpget \-c public \-v 1 localhost ipForwarding.0
IP-MIB::ipForwarding.0 = INTEGER: forwarding(1)
-\fC $ snmpget -c public -v 1 \fB-Oe\fP localhost ipForwarding.0
+\fC $ snmpget \-c public \-v 1 \fB-Oe\fP localhost ipForwarding.0
IP-MIB::ipForwarding.0 = INTEGER: 1\fR
.fi
.RE
.TP
-.B -OE
+.B \-OE
Modifies index strings to escape the quote characters:
.RS
.nf
-\fC $ snmpgetnext -c public -v 1 localhost vacmSecurityModel
+\fC $ snmpgetnext \-c public \-v 1 localhost vacmSecurityModel
SNMP-VIEW-BASED-ACM-MIB::vacmSecurityModel.0."wes" = xxx
- $ snmpgetnext -c public -v 1 \fB-OE\fP localhost vacmSecurityModel
+ $ snmpgetnext \-c public \-v 1 \fB-OE\fP localhost vacmSecurityModel
SNMP-VIEW-BASED-ACM-MIB::vacmSecurityModel.0.\\"wes\\" = xxx\fR
.fi
.RE
.IP
This allows the output to be reused in shell commands.
.TP
-.B -Of
+.B \-Of
Include the full list of MIB objects when displaying an OID:
.RS
\fC .iso.org.dod.internet.mgmt.mib-2.system.sysUpTime.0 =\fR
@@ -286,43 +286,43 @@
.RE
.RE
.TP
-.B -On
+.B \-On
Displays the OID numerically:
.br
\fC .1.3.6.1.2.1.1.3.0 = Timeticks: (14096763) 1 day, 15:09:27.63\fR
.TP
-.B -Oq
+.B \-Oq
Removes the equal sign and type information when displaying varbind values:
.br
\fC SNMPv2-MIB::sysUpTime.0 1:15:09:27.63\fR
.TP
-.B -OQ
+.B \-OQ
Removes the type information when displaying varbind values:
.br
\fC SNMPv2-MIB::sysUpTime.0 = 1:15:09:27.63\fR
.TP
-.B -Os
+.B \-Os
Display the MIB object name (plus any instance or other subidentifiers):
.br
\fC sysUpTime.0 = Timeticks: (14096763) 1 day, 15:09:27.63\fR
.TP
-.B -OS
+.B \-OS
Display the name of the MIB, as well as the object name:
.br
-\fC SNMPv2-MIB::sysUpTime.0 = Timeticks: (14096763) 1 day, 15:09:27.63\fR
+\fC SNMPv2\-MIB::sysUpTime.0 = Timeticks: (14096763) 1 day, 15:09:27.63\fR
.IP
This is the default OID output format.
.TP
-.B -Ot
+.B \-Ot
Display \fCTimeTicks\fR values as raw numbers:
.br
\fC SNMPv2-MIB::sysUpTime.0 = 14096763\fR
.TP
-.B -OT
+.B \-OT
If values are printed as Hex strings,
display a printable version as well.
.TP
-.B -Ou
+.B \-Ou
Display the OID in the traditional UCD-style (inherited from the original
CMU code).
That means removing a series of "standard" prefixes from the OID,
@@ -331,19 +331,19 @@
.br
\fC system.sysUpTime.0 = Timeticks: (14096763) 1 day, 15:09:27.63\fR
.TP
-.B -OU
+.B \-OU
Do not print the UNITS suffix at the end of the value.
.TP
-.B -Ov
+.B \-Ov
Display the varbind value only, not the OID:
.RS
.nf
-\fC $ snmpget -c public -v 1 \fB-Oe\fP localhost ipForwarding.0
+\fC $ snmpget \-c public \-v 1 \fB-Oe\fP localhost ipForwarding.0
INTEGER: forwarding(1)\fR
.fi
.RE
.TP
-.B -Ox
+.B \-Ox
Display string values as Hex strings (unless there is a
\fCDISPLAY-HINT\fR defined for the corresponding MIB object).
By default, the library attempts to determine whether the value is
@@ -351,14 +351,14 @@
This option does not affect objects that \fIdo\fR have a Display Hint.
.TP
-.B -OX
+.B \-OX
Display table indexes in a more "program like" output, imitating
a traditional array-style index format:
.RS
.nf
-\fC $ snmpgetnext -c public -v 1 localhost ipv6RouteTable
+\fC $ snmpgetnext \-c public \-v 1 localhost ipv6RouteTable
IPv6-MIB::ipv6RouteIfIndex.63.254.1.0.255.0.0.0.0.0.0.0.0.0.0.0.64.1 = INTEGER: 2
- $ snmpgetnext -c public -v 1 \fB-OE\fP localhost ipv6RouteTable
+ $ snmpgetnext \-c public \-v 1 \fB-OE\fP localhost ipv6RouteTable
IPv6-MIB::ipv6RouteIfIndex[3ffe:100:ff00:0:0:0:0:0][64][1] = INTEGER: 2
.fi
.RE
@@ -370,16 +370,16 @@
.SH "INPUT OPTIONS"
The interpretation of input object names and the values to be assigned
-can be controlled using various parameters of the \fB-I\fR flag.
+can be controlled using various parameters of the \fB\-I\fR flag.
The default behaviour will be described at the end of this section.
.TP
-.B -Ib
+.B \-Ib
specifies that the given name should be regarded as a regular expression,
to match (case-insensitively) against object names in the MIB tree.
-The "best" match will be used - calculated as the one that matches the
+The "best" match will be used \- calculated as the one that matches the
closest to the beginning of the node name and the highest in the tree.
.\"
-.\" XXX - This is not a particularly clear description.
+.\" XXX \- This is not a particularly clear description.
.\" Need to check the code and/or experiment to
.\" discover exactly what Wes means by this!
For example, the MIB object \fCvacmSecurityModel\fR could be matched by
@@ -396,7 +396,7 @@
Similarly, specifying a MIB module name will not succeed
(so \fISNMPv2-MIB::sys.*ontact\fR would not match either).
.TP
-.B -Ih
+.B \-Ih
disables the use of DISPLAY-HINT information when assigning values.
This would then require providing the raw value:
.br
@@ -410,7 +410,7 @@
.br
= 2002-12-10,2:4:6.8\fR
.TP
-.B -Ir
+.B \-Ir
disables checking table indexes and the value to be assigned against the
relevant MIB definitions. This will (hopefully) result in the remote
agent reporting an invalid request, rather than checking (and rejecting)
@@ -420,7 +420,7 @@
tend to be more precise), but disabling this behaviour is particularly
useful when testing the remote agent.
.TP
-.B -IR
+.B \-IR
enables "random access" lookup of MIB names.
Rather than providing a full OID path to the desired MIB object
(or qualifying this object with an explicit MIB module name),
@@ -440,12 +440,12 @@
as well as being slightly more efficient (and automatically
loading the necessary MIB file if necessary).
.TP
-.B -Is SUFFIX
+.B \-Is SUFFIX
adds the specified suffix to each textual OID given on the command line.
This can be used to retrieve multiple objects from the same row of
a table, by specifying a common index value.
.TP
-.B -IS PREFIX
+.B \-IS PREFIX
adds the specified prefix to each textual OID given on the command line.
This can be used to specify an explicit MIB module name for all objects
being retrieved (or for incurably lazy typists).
@@ -477,12 +477,12 @@
The list of MIBs to load. Defaults to
SNMPv2-TC:SNMPv2-MIB:IF-MIB:IP-MIB:TCP-MIB:UDP-MIB:SNMP-VACM-MIB.
Overridden by the
-.B -m
+.B \-m
option.
.IP MIBDIRS
The list of directories to search for MIBs. Defaults to DATADIR/snmp/mibs.
Overridden by the
-.B -M
+.B \-M
option.
.SH FILES
More information about the Python-modules-commits
mailing list