xref: /freebsd/contrib/bsnmp/gensnmpdef/gensnmpdef.1 (revision d37ea99837e6ad50837fd9fe1771ddf1c3ba6002)
1.\"
2.\" Copyright (c) 2004
3.\"	Hartmut Brandt
4.\"	All rights reserved.
5.\"
6.\" Redistribution of this software and documentation and use in source and
7.\" binary forms, with or without modification, are permitted provided that
8.\" the following conditions are met:
9.\"
10.\" 1. Redistributions of source code or documentation must retain the above
11.\"    copyright notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\" 3. Neither the name of the author nor the names of its contributors
16.\"    may be used to endorse or promote products derived from this software
17.\"    without specific prior written permission.
18.\"
19.\" THIS SOFTWARE AND DOCUMENTATION IS PROVIDED BY THE AUTHOR
20.\" AND ITS CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
21.\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
22.\" FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
23.\" THE AUTHOR OR ITS CONTRIBUTORS  BE LIABLE FOR ANY DIRECT, INDIRECT,
24.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
26.\" OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27.\" LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28.\" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
29.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30.\"
31.\" $Begemot: bsnmp/gensnmpdef/gensnmpdef.1,v 1.1 2004/04/14 09:54:51 novo Exp $
32.\"
33.\" Author: Harti Brandt <harti@freebsd.org>
34.\"
35.Dd April 14, 2004
36.Dt gensnmpdef 1
37.Os
38.Sh NAME
39.Nm gensnmpdef
40.Nd "generate a MIB description file from MIBs"
41.Sh SYNOPSIS
42.Nm
43.Op Fl h
44.Op Fl c Ar cut
45.Ar name Op Ar ...
46.Sh DESCRIPTION
47The
48.Nm
49utility is used to create an initial MIB description file from
50one or more MIBs. The description file must be edited to be actually useful
51for feeding it into
52.Xr gensnmptree 1 .
53.Pp
54The
55.Fl c
56option specifies the number of initial sub-oids that should be omitted
57from the tree.
58.Xr gensnmptree 1
59automatically adds 1.3.6 in front of all OIDs so the default value
60of 3 is just correct in most cases.
61.Pp
62.Nm
63does no attempt on sorting the OID tree so in case of complex and
64non-standard MIBs it is necessay to sort the tree in the resulting definition
65file by hand.
66.Sh SEE ALSO
67.Xr snmpd 1
68.Sh BUGS
69The utility is by no means bullet-proof and may fail for complex
70or non-standard MIBs.
71Its output is expected to be edited by hand.
72.Sh AUTHORS
73.An Hartmut Brandt Aq harti@freebsd.org
74