Blame tools/smiquery.1

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