tools/smidump.1.in

   1 .\"
   2 .\" $Id: smidump.1.in 7608 2008-01-22 13:05:41Z schoenw $
   3 .\"
   4 .TH smidump 1  "August 10, 2004" "IBR" "SMI Tools"
   5 .SH NAME
   6 smidump \- dump SMI or SPPI modules in various formats
   7 .SH SYNOPSIS
   8 .B smidump
   9 [
  10 .B "-Vhqusmk"
  11 ] [
  12 .BI "-c " file
  13 ] [
  14 .BI "-o " name
  15 ] [
  16 .BI "-p " module
  17 ] [
  18 .BI "-l " level
  19 ] [
  20 .BI "-f " format
  21 ]
  22 .I "module(s)"
  23 .SH DESCRIPTION
  24 The \fBsmidump\fP program is used to dump the contents of a single MIB
  25 or PIB
  26 module or a collection of modules to stdout in a selectable output
  27 format.  This format may be a simple tree of nodes, types or imported
  28 modules, but also a format fully compliant to SMIv1, SMIv2, SPPI or SMIng or
  29 CORBA IDL or C source code. Smidump can thus be used to convert
  30 modules from SMIv2 to SMIng and from SMIng to SMIv2, or to develop
  31 template based agent code.
  32 .SH OPTIONS
  33 .TP
  34 \fB-V, --version\fP
  35 Show the smidump version and exit.
  36 .TP
  37 \fB-h, --help\fP
  38 Show a help text and exit. The help text contains a list of all
  39 supported output formats.
  40 .TP
  41 \fB-c \fIfile\fB, --config=\fIfile\fP
  42 Read \fIfile\fP instead of any other (global and user)
  43 configuration file.
  44 .TP
  45 \fB-f \fIformat\fB, --format=\fIformat\fP
  46 Use \fIformat\fP when dumping a module. Supported output formats are described
  47 below. The default output format is SMIng. The \fIformat\fP argument is
  48 case insensitive.
  49 .TP
  50 \fB-l \fIlevel\fB, --level=\fIlevel\fP
  51 Report errors and warnings up to the given severity \fIlevel\fP. See
  52 the smilint(1) manual page for a description of the error levels. The
  53 default error level is 3.
  54 .TP
  55 \fB-s, --severity\fP
  56 Show the error severity in brackets before error messages.
  57 .TP
  58 \fB-m, --error-names\fP
  59 Show the error names in braces before error messages.
  60 .TP
  61 \fB-o \fIname\fB, --output=\fIname\fB
  62 Write the output in one or multiple files instead of stdout. The file
  63 name(s) are derived from the \fIname\fP argument.  Not all format
  64 support this option.
  65 .TP
  66 \fB-p \fImodule\fB, --preload=\fImodule\fP
  67 Preload the module \fImodule\fP before reading the main module(s). This may
  68 be helpful if an incomplete main module misses to import some definitions.
  69 .TP
  70 \fB-q, --quiet\fP
  71 Suppress comments from dumped modules. What kind of information
  72 gets suppressed depends on the output format.
  73 .TP
  74 \fB-u, --unified\fP
  75 Dump a unified output in case of multiple \fImodule(s)\fP instead of
  76 multiple concatenated output sections. This is not supported for all
  77 output formats.
  78 .TP
  79 \fB-k, --keep-going\fP
  80 Continue as much as possible after serious parse errors. Note that
  81 the output generated after serious parse errors may be incomplete
  82 and should be used with care.
  83 .TP
  84 .I module(s)
  85 These are the module(s) to be dumped. If a module argument represents a
  86 path name (identified by containing at least one dot or slash character),
  87 this is assumed to be the exact file to read. Otherwise, if a module is
  88 identified by its plain module name, it is searched according to libsmi
  89 internal rules. See \fBsmi_config(3)\fP for more details.
  90 .SH "OUTPUT FORMATS"
  91 The \fBsmidump\fP program supports the following output formats:
  92 .TP 12
  93 sming
  94 SMIng compliant format as defined in the SMIng Internet-Draft.
  95 .TP
  96 smiv2
  97 SMIv2 compliant format as defined in RFC 2578, RFC 2579, RFC 2580.
  98 .TP
  99 smiv1
 100 SMIv2 compliant format as defined in RFC 1155, RFC 1212, RFC 1215.
 101 .TP
 102 sppi
 103 SPPI compliant format as defined in RFC 3159. If the underlying module
 104 is not SPPI, there might be some mandatory information missing.
 105 .TP
 106 mosy
 107 Format generated by the mosy compiler.
 108 .TP
 109 imports
 110 Import hierarchy of a module.
 111 .TP
 112 types
 113 Types defined in a module.
 114 .TP
 115 tree
 116 OID registration tree structure of a module.
 117 .TP
 118 metrics
 119 Metrics derived from a module (experimental).
 120 .TP
 121 identifiers
 122 List of identifiers defined in a module.
 123 .TP
 124 compliances
 125 Compliance definitions with all included objects and notifications.
 126 .TP
 127 corba
 128 CORBA IDL and OID definitions following the JIDM specification translation
 129 rules.
 130 .TP
 131 netsnmp
 132 C source code files for usage within the net-snmp package (experimental).
 133 .TP
 134 scli
 135 ANSI C manager stubs for usage within the scli package (experimental).
 136 .TP
 137 cm
 138 Reverse engineered conceptual model in DIA XML file format (experimental).
 139 .TP
 140 svg
 141 SVG diagram of a module (experimental). Use with \fB-u\fP when dumping multiple \fImodules\fP.
 142 .TP
 143 jax
 144 Java AgentX sub-agent classes in separate files (experimental).
 145 .TP
 146 perl
 147 Perl represention of the MIB module
 148 (contributed by Martin Schulz <schulz@videotron.ca>).
 149 .TP
 150 python
 151 Python dictionaries represention of the MIB module
 152 (contributed by Pat Knight <pat@ktgroup.co.uk>).
 153 .TP
 154 xml
 155 SMI in XML format (experimental).
 156 .TP
 157 xsd
 158 SMI in XML schema format (experimental).
 159 .TP
 160 sizes
 161 SNMP best case / worst case RFC 3416 PDU sizes for typical PDUs
 162 excluding SNMP message and transport headers (experimental).
 163
 164 .SH "EXAMPLE"
 165 This example converts the SMIv2 module IF-MIB in the current directory
 166 to IF-MIB.sming in SMIng format. Note that the ./ prefix is used to
 167 ensure reading the module from the current directory and not from a
 168 place that libsmi guesses on its own.
 169 .nf
 170
 171   $ smidump -f sming ./IF-MIB > IF-MIB.sming
 172 .fi
 173 .SH "SEE ALSO"
 174 The
 175 .BR libsmi (3)
 176 project is documented at
 177 .BR "http://www.ibr.cs.tu-bs.de/projects/libsmi/" "."
 178 .PP
 179 .BR smilint "(1)"
 180 .SH "AUTHORS"
 181 (C) 1999-2004 F. Strauss, TU Braunschweig, Germany <strauss@ibr.cs.tu-bs.de>
 182 .br
 183 (C) 1999-2002 J. Schoenwaelder, TU Braunschweig, Germany <schoenw@ibr.cs.tu-bs.de>
 184 .br
 185 (C) 2002-2003 J. Schoenwaelder, University of Osnabrueck, Germany
 186 .br
 187 (C) 2003-2004 J. Schoenwaelder, International University Bremen, Germany
 188 .br
 189 (C) 2001-2002 T. Klie, TU Braunschweig, Germany <tklie@ibr.cs.tu-bs.de>
 190 .br
 191 (C) 2002 M. Bunkus, TU Braunschweig, Germany <bunkus@ibr.cs.tu-bs.de>
 192 .br
 193 and contributions by many other people.
 194 .br