Imported Upstream version 0.4.8
[platform/upstream/libsmi.git] / tools / smidiff.1.in
1 .\"
2 .\" $Id: smidiff.1.in 1677 2004-08-10 11:10:27Z strauss $
3 .\"
4 .TH smidiff 1  "August 10, 2004" "IBR" "SMI Tools"
5 .SH NAME
6 smidiff \- check differences between a pair of SMI or SPPI modules
7 .SH SYNOPSIS
8 .B smidiff
9 [
10 .B "-Vhsm"
11 ] [
12 .BI "-c " file
13 ] [
14 .BI "-l " level
15 ] [
16 .BI "-i " error-pattern
17 ] [
18 .BI "-p " module
19 ]
20 .I "oldmodule newmodule"
21 .SH DESCRIPTION
22 The \fBsmidiff\fP program is used to check differences between a pair
23 of SMI MIB modules or SPPI PIB modules.
24 E.g., it can be used to detect changes in updated MIB
25 modules that can cause interoperability problems with existing
26 implementations. SMIv1/v2 and SPPI style MIB/PIB modules are
27 supported.
28 .PP
29 Note that conformance statements are currently not checked.
30 .PP
31 Messages describing the differences are written to the standard output
32 channel while error and warning messages generated by the parser
33 are written to the standard error channel.
34 .SH OPTIONS
35 .TP
36 \fB-V, --version\fP
37 Show the smidump version and exit.
38 .TP
39 \fB-h, --help\fP
40 Show a help text and exit.
41 .TP
42 \fB-s, --severity\fP
43 Show the error severity in brackets before error messages.
44 .TP
45 \fB-m, --error-names\fP
46 Show the error names in braces before error messages.
47 .TP
48 \fB-c \fIfile\fB, --config=\fIfile\fP
49 Read \fIfile\fP instead of any other (global and user)
50 configuration file.
51 .TP
52 \fB-p \fImodule\fB, --preload=\fImodule\fP
53 Preload the module \fImodule\fP before reading the main
54 module(s). This may be helpful if an incomplete main module misses to
55 import some definitions.
56 .TP
57 \fB-l \fIlevel\fB, --level=\fIlevel\fP
58 Report errors and warnings up to the given severity \fIlevel\fP. See
59 the smilint(1) manual page for a description of the error levels. The
60 default error level is 3.
61 .TP
62 \fB-i \fIprefix\fB, --ignore=\fIprefix\fP
63 Ignore all errors that have a tag which matches \fIprefix\fP.
64 .TP
65 .I oldmodule
66 The original module.
67 .TP
68 .I newmodule
69 The updated module. 
70 .PP
71 If a module argument represents a path name (identified by containing
72 at least one dot or slash character), this is assumed to be the exact
73 file to read. Otherwise, if a module is identified by its plain module
74 name, it is searched according to libsmi internal rules. See
75 \fBsmi_config(3)\fP for more details.
76 .SH "SEE ALSO"
77 The 
78 .BR libsmi (3)
79 project is documented at
80 .BR "http://www.ibr.cs.tu-bs.de/projects/libsmi/" "."
81 .SH "AUTHOR"
82 (C) 2001 T. Klie, TU Braunschweig, Germany <tklie@ibr.cs.tu-bs.de>
83 .br
84 (C) 2001 J. Schoenwaelder, TU Braunschweig, Germany <schoenw@ibr.cs.tu-bs.de>
85 .br
86 and contributions by many other people.
87 .br