Blame tools/smiquery.1

Packit 022b05
.\"
Packit 022b05
.\" $Id: smiquery.1.in 1676 2004-08-10 10:58:12Z strauss $
Packit 022b05
.\"
Packit 022b05
.TH smiquery 1  "August 10, 2004" "IBR" "SMI Tools"
Packit 022b05
.SH NAME
Packit 022b05
smiquery \- query single information from SMI MIB modules
Packit 022b05
.SH SYNOPSIS
Packit 022b05
.B smiquery
Packit 022b05
[
Packit 022b05
.B "-Vh"
Packit 022b05
] [
Packit 022b05
.BI "-p " module
Packit 022b05
]
Packit 022b05
.I command name
Packit 022b05
.SH DESCRIPTION
Packit 022b05
The \fBsmiquery\fP program is used to query information on a single
Packit 022b05
item from an MIB module, e.g. module meta information or a single type
Packit 022b05
definition.
Packit 022b05
.SH OPTIONS
Packit 022b05
.TP
Packit 022b05
\fB-V, --version\fP
Packit 022b05
Show the smiquery version and exit.
Packit 022b05
.TP
Packit 022b05
\fB-h, --help\fP
Packit 022b05
Show a help text and exit. The help text lists all available \fBcommand\fPs.
Packit 022b05
.TP
Packit 022b05
\fB-p \fImodule\fB, --preload \fImodule\fP
Packit 022b05
Preload the module \fImodule\fP before reading the main module. This may
Packit 022b05
be helpful if an incomplete main module misses to import some definitions.
Packit 022b05
.TP
Packit 022b05
.I command name
Packit 022b05
This specifies the kind of information to retrieve (module, imports,
Packit 022b05
revisions, node, parent, compliance, index, members, children, type, or
Packit 022b05
macro) and the item to retrieve.
Packit 022b05
.PP
Packit 022b05
The module in question is searched along a path, which is initialized by
Packit 022b05
the \fBSMIPATH\fP environment variable or by /usr/local/share/mibs if
Packit 022b05
\fBSMIPATH\fP is not set. Files with a \fB.sming\fP extension are
Packit 022b05
expected to be (old-style!) SMIng module files. Files
Packit 022b05
with a \fB.my\fP or without
Packit 022b05
any extension are expected to be SMIv1/v2 module files.
Packit 022b05
.SH "EXAMPLE"
Packit 022b05
This example queries for information on the node ifNumber defined
Packit 022b05
in the module IF-MIB.
Packit 022b05
.nf
Packit 022b05
Packit 022b05
  $ smiquery node IF-MIB::ifNumber
Packit 022b05
       MibNode: IF-MIB::ifNumber
Packit 022b05
	   OID: 1.3.6.1.2.1.2.1
Packit 022b05
	  Type: Integer32
Packit 022b05
   Declaration: OBJECT-TYPE
Packit 022b05
      NodeKind: scalar
Packit 022b05
	Access: read-only
Packit 022b05
	Status: current
Packit 022b05
   Description: The number of network interfaces (regardless of their
Packit 022b05
		current state) present on this system.
Packit 022b05
Packit 022b05
.fi
Packit 022b05
.SH "SEE ALSO"
Packit 022b05
The
Packit 022b05
.BR libsmi (3)
Packit 022b05
project is documented at
Packit 022b05
.BR "http://www.ibr.cs.tu-bs.de/projects/libsmi/" "."
Packit 022b05
.SH "AUTHOR"
Packit 022b05
(C) 1999-2004 F. Strauss, TU Braunschweig, Germany <strauss@ibr.cs.tu-bs.de>
Packit 022b05
.br