tools/smixlate.1.in

   1 .\"
   2 .\" $Id: smixlate.1.in 1676 2004-08-10 10:58:12Z strauss $
   3 .\"
   4 .TH smixlate 1  "June 18, 2006" "IUB" "SMI Tools"
   5 .SH NAME
   6 smixlate \- translate SMI/SPPI identifiers
   7 .SH SYNOPSIS
   8 .B smixlate
   9 [
  10 .B "-Vhm"
  11 ] [
  12 .BI "-c " file
  13 ] [
  14 .BI "-p " module
  15 ] [
  16 .BI "-l " level
  17 ]
  18 .I "module(s)"
  19 .SH DESCRIPTION
  20
  21 The \fBsmixlate\fP program is used to translate identifiers and
  22 especially OIDs into a more human readable format.
  23 .SH OPTIONS
  24 .TP
  25 \fB-V, --version\fP
  26 Show the smixlate version and exit.
  27 .TP
  28 \fB-h, --help\fP
  29 Show a help text and exit.
  30 .TP
  31 \fB-r, --recursive\fP
  32 Report errors and warnings also for recursively imported modules.
  33 .TP
  34 \fB-c \fIfile\fB, --config=\fIfile\fP
  35 Read \fIfile\fP instead of any other (global and user)
  36 configuration file.
  37 .TP
  38 \fB-p \fImodule\fB, --preload=\fImodule\fP
  39 Preload the module \fImodule\fP before reading the main
  40 module(s). This may be helpful if an incomplete main module misses to
  41 import some definitions.
  42 .TP
  43 \fB-l \fIlevel\fB, --level=\fIlevel\fP
  44 Report errors and warnings up to the given severity \fIlevel\fP. See
  45 the smilint(1) manual page for a description of the error levels. The
  46 default error level is 3.
  47 .TP
  48 \fB-a, --all\fP
  49 Replace all OIDs including OID prefixes. Without this option, smixlate
  50 will only translate OIDs with a corresponding notification, scalar,
  51 column, row, or table definition.
  52 .TP
  53 \fB-f, --format\fP
  54 Preserve the input format as much as possible by inserting/removing
  55 white space characters.
  56 .TP
  57 .I module(s)
  58 These are the modules to be loaded for the subsequent translation. If
  59 a module argument represents a path name (identified by containing at
  60 least one dot or slash character), this is assumed to be the exact
  61 file to read. Otherwise, if a module is identified by its plain module
  62 name, it is searched according to libsmi internal rules. See
  63 \fBsmi_config(3)\fP for more details.
  64 .SH "EXAMPLE"
  65 This example translates numeric OIDs in the input text into a more
  66 human readable format.
  67 .nf
  68
  69   $ echo "what is this oid? 1.3.6.1.2.1.2.2.1.3" | \
  70     ./smixlate -l 0 /usr/local/share/mibs/ietf/*
  71   what is this oid? ifType
  72   $
  73
  74 .fi
  75 .SH "SEE ALSO"
  76 The
  77 .BR libsmi (3)
  78 project is documented at
  79 .BR "http://www.ibr.cs.tu-bs.de/projects/libsmi/" "."
  80 .SH "AUTHORS"
  81 (C) 2006-2006 J. Schoenwaelder, International University Bremen, Germany
  82 .br
  83 and contributions by many other people.
  84 .br