tools/smiquery.1

   1 .\"
   2 .\" $Id: smiquery.1.in 1676 2004-08-10 10:58:12Z strauss $
   3 .\"
   4 .TH smiquery 1  "August 10, 2004" "IBR" "SMI Tools"
   5 .SH NAME
   6 smiquery \- query single information from SMI MIB modules
   7 .SH SYNOPSIS
   8 .B smiquery
   9 [
  10 .B "-Vh"
  11 ] [
  12 .BI "-p " module
  13 ]
  14 .I command name
  15 .SH DESCRIPTION
  16 The \fBsmiquery\fP program is used to query information on a single
  17 item from an MIB module, e.g. module meta information or a single type
  18 definition.
  19 .SH OPTIONS
  20 .TP
  21 \fB-V, --version\fP
  22 Show the smiquery version and exit.
  23 .TP
  24 \fB-h, --help\fP
  25 Show a help text and exit. The help text lists all available \fBcommand\fPs.
  26 .TP
  27 \fB-p \fImodule\fB, --preload \fImodule\fP
  28 Preload the module \fImodule\fP before reading the main module. This may
  29 be helpful if an incomplete main module misses to import some definitions.
  30 .TP
  31 .I command name
  32 This specifies the kind of information to retrieve (module, imports,
  33 revisions, node, parent, compliance, index, members, children, type, or
  34 macro) and the item to retrieve.
  35 .PP
  36 The module in question is searched along a path, which is initialized by
  37 the \fBSMIPATH\fP environment variable or by /usr/local/share/mibs if
  38 \fBSMIPATH\fP is not set. Files with a \fB.sming\fP extension are
  39 expected to be (old-style!) SMIng module files. Files
  40 with a \fB.my\fP or without
  41 any extension are expected to be SMIv1/v2 module files.
  42 .SH "EXAMPLE"
  43 This example queries for information on the node ifNumber defined
  44 in the module IF-MIB.
  45 .nf
  46
  47   $ smiquery node IF-MIB::ifNumber
  48        MibNode: IF-MIB::ifNumber
  49            OID: 1.3.6.1.2.1.2.1
  50           Type: Integer32
  51    Declaration: OBJECT-TYPE
  52       NodeKind: scalar
  53         Access: read-only
  54         Status: current
  55    Description: The number of network interfaces (regardless of their
  56                 current state) present on this system.
  57
  58 .fi
  59 .SH "SEE ALSO"
  60 The
  61 .BR libsmi (3)
  62 project is documented at
  63 .BR "http://www.ibr.cs.tu-bs.de/projects/libsmi/" "."
  64 .SH "AUTHOR"
  65 (C) 1999-2004 F. Strauss, TU Braunschweig, Germany <strauss@ibr.cs.tu-bs.de>
  66 .br