2 .\" Copyright (c) 2001-2005
3 .\" Fraunhofer Institute for Open Communication Systems (FhG Fokus).
4 .\" All rights reserved.
7 .\" All rights reserved.
9 .\" Author: Harti Brandt <harti@FreeBSD.org>
11 .\" Redistribution and use in source and binary forms, with or without
12 .\" modification, are permitted provided that the following conditions
14 .\" 1. Redistributions of source code must retain the above copyright
15 .\" notice, this list of conditions and the following disclaimer.
16 .\" 2. Redistributions in binary form must reproduce the above copyright
17 .\" notice, this list of conditions and the following disclaimer in the
18 .\" documentation and/or other materials provided with the distribution.
20 .\" THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .\" $Begemot: gensnmptree.1 383 2006-05-30 07:40:49Z brandt_h $
39 .Nd "generate C and header files from a MIB description file"
50 utility is used to either generate C language tables and header files from
51 a MIB description or to numeric OIDs from MIB descriptions.
52 The first form is used only for maintaining the
54 daemon or for module writers.
55 The second form may be used by SNMP client program writers.
57 If none of the options
64 reads a MIB description from its standard input and creates two files: a
67 containing a table used by
72 containing appropriate declarations of the callback functions used in this
73 table, the table itself and definitions for all enums.
75 The following options are available:
76 .Bl -tag -width ".Fl E"
80 Extract enumerations and bit constructs.
81 In this mode the tool emits
82 a header file that contains for each type given on the command line a
83 C-enum definition and a preprocessor define that may be used to map
87 expects MIB variable names (only the last component) on its command line.
88 It reads a MIB specification from standard input and for each MIB variable
89 name emits three C preprocessor defines on its standard output:
90 .Bl -tag -width ".Va OIDLEN_ Ns Ar Name"
91 .It Va OIDX_ Ns Ar name
92 This define can be used to initialize a
96 .Dl const struct asn_oid oid_sysDescr = OIDX_sysDescr;
97 .It Va OIDLEN_ Ns Ar name
98 is the length of the OID.
99 .It Va OID_ Ns Ar name
100 is the last component of the OID.
103 Print a short help page.
104 .It Fl I Ar directory
105 Add the named directory to the include path just before the standard include
108 Read from the named file instead of standard input.
110 Generate local preprocessor includes.
111 This is used for bootstrapping
114 Instead of normal output print the resulting tree.
116 Prefix the file names and the table name with
120 The syntax of the MIB description file can formally be specified as follows:
121 .Bd -unfilled -offset indent
122 file := top | top file
124 top := tree | typedef | include
126 tree := head elements ')'
128 entry := head ':' index STRING elements ')'
130 leaf := head type STRING ACCESS ')'
132 column := head type ACCESS ')'
134 type := BASETYPE | BASETYPE '|' subtype | enum | bits
138 enum := ENUM '(' value ')'
140 bits := BITS '(' value ')'
142 value := INT STRING | INT STRING value
144 head := '(' INT STRING
146 elements := EMPTY | elements element
148 element := tree | leaf | column
150 index := type | index type
152 typedef := 'typedef' STRING type
154 include := 'include' filespec
156 filespec := '"' STRING '"' | '<' STRING '>'
160 specifies a SNMP data type and may be one of
161 .Bl -bullet -offset indent -compact
167 INTEGER32 (same as INTEGER)
169 UNSIGNED32 (same as GAUGE)
187 specifies the accessibility of the MIB variable (which operation can be
188 performed) and is one of
189 .Bl -bullet -offset indent -compact
197 is a decimal integer and
199 is any string starting with a letter or underscore and consisting of
200 letters, digits, underscores and minuses, that is not one of the keywords.
204 directive associates a type with a single name.
208 directive is replaced by the contents of the named file.
210 The following MIB description describes the system group:
211 .Bd -literal -offset indent
214 typedef AdminStatus ENUM (
223 (1 sysDescr OCTETSTRING op_system_group GET)
224 (2 sysObjectId OID op_system_group GET)
225 (3 sysUpTime TIMETICKS op_system_group GET)
226 (4 sysContact OCTETSTRING op_system_group GET SET)
227 (5 sysName OCTETSTRING op_system_group GET SET)
228 (6 sysLocation OCTETSTRING op_system_group GET SET)
229 (7 sysServices INTEGER op_system_group GET)
230 (8 sysORLastChange TIMETICKS op_system_group GET)
232 (1 sysOREntry : INTEGER op_or_table
233 (1 sysORIndex INTEGER)
235 (3 sysORDescr OCTETSTRING GET)
236 (4 sysORUpTime TIMETICKS GET)
246 .An Hartmut Brandt Aq harti@FreeBSD.org