Blame tools/smistrip.1.in

Packit 022b05
.\"
Packit 022b05
.\" $Id: smistrip.1.in 1676 2004-08-10 10:58:12Z strauss $
Packit 022b05
.\"
Packit 022b05
.TH smistrip 1  "August 10, 2004" "IBR" "SMI Tools"
Packit 022b05
.SH NAME
Packit 022b05
smistrip \- extract MIB or PIB modules from text files, like RFCs or I-Ds
Packit 022b05
.SH SYNOPSIS
Packit 022b05
.B smistrip
Packit 022b05
[
Packit 022b05
.B "-Vhn"
Packit 022b05
] [
Packit 022b05
.BI "-d " dir
Packit 022b05
] [
Packit 022b05
.BI "-m " module
Packit 022b05
]
Packit 022b05
[
Packit 022b05
.I file(s)
Packit 022b05
]
Packit 022b05
.SH DESCRIPTION
Packit 022b05
The \fBsmistrip\fP program is used to extract MIB and PIB module
Packit 022b05
files from ASCII documents like RFCs or Internet Drafts. Modules are
Packit 022b05
identified by a starting ASN.1 DEFINITIONS clause and the matching
Packit 022b05
END clause. The output is written to files named by the modules' names.
Packit 022b05
.SH OPTIONS
Packit 022b05
.TP
Packit 022b05
.B "-V"
Packit 022b05
Show the smistrip version and exit.
Packit 022b05
.TP
Packit 022b05
.B "-h"
Packit 022b05
Show a help text and exit.
Packit 022b05
.TP
Packit 022b05
.B "-n"
Packit 022b05
Print only what would be extracted, but do not write any output file.
Packit 022b05
.TP
Packit 022b05
.BI "-d " dir
Packit 022b05
Write module file(s) to directory \fIdir\fP instead of the current
Packit 022b05
working directory.
Packit 022b05
.TP
Packit 022b05
.BI "-m " module
Packit 022b05
Extract only the module \fImodule\fP instead of all modules found in
Packit 022b05
the input file(s).
Packit 022b05
.TP
Packit 022b05
.I file(s)
Packit 022b05
The input text file(s) from which modules will be extracted. If no file
Packit 022b05
is given, input is read from stdin.
Packit 022b05
.PP
Packit 022b05
Note that \fBsmistrip\fP tries to be smart about locating module start
Packit 022b05
and end, detecting page breaks and blank lines near page breaks. It
Packit 022b05
also tries to cut off blank prefixing columns from all lines of a
Packit 022b05
modules. However, there might by documents that cannot be parsed
Packit 022b05
correctly by \fBsmistrip\fP and probably produce incorrect output.
Packit 022b05
You might consider to use \fBsmilint\fP on every extracted module file
Packit 022b05
to check its syntactical correctness.
Packit 022b05
.SH "EXAMPLE"
Packit 022b05
This example extracts only the module IPV6-MIB from the file rfc2465 and
Packit 022b05
writes it to the directory /usr/local/tmp.
Packit 022b05
.nf
Packit 022b05
  $ smistrip -d /usr/local/tmp -m IPV6-MIB rfc2465
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
.PP
Packit 022b05
.BR smilint "(1)"
Packit 022b05
.SH "AUTHOR"
Packit 022b05
(C) 1999-2004 F. Strauss, TU Braunschweig, Germany <strauss@ibr.cs.tu-bs.de>
Packit 022b05
.br
Packit 022b05
(C) 2002 M. Bunkus, TU Braunschweig, Germany <bunkus@ibr.cs.tu-bs.de>
Packit 022b05
.br
Packit 022b05
and contributions by many other people.
Packit 022b05
.br