contrib/bsnmp/gensnmptree/gensnmptree.1

   1 .\"
   2 .\" Copyright (c) 2001-2005
   3 .\"     Fraunhofer Institute for Open Communication Systems (FhG Fokus).
   4 .\"     All rights reserved.
   5 .\" Copyright (c) 2006
   6 .\"     Hartmut Brandt
   7 .\"     All rights reserved.
   8 .\"
   9 .\" Author: Harti Brandt <harti@FreeBSD.org>
  10 .\"
  11 .\" Redistribution and use in source and binary forms, with or without
  12 .\" modification, are permitted provided that the following conditions
  13 .\" are met:
  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.
  19 .\"
  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
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\" $Begemot: gensnmptree.1 383 2006-05-30 07:40:49Z brandt_h $
  33 .\"
  34 .Dd May 26, 2006
  35 .Dt GENSNMPTREE 1
  36 .Os
  37 .Sh NAME
  38 .Nm gensnmptree
  39 .Nd "generate C and header files from a MIB description file"
  40 .Sh SYNOPSIS
  41 .Nm
  42 .Op Fl dEehlt
  43 .Op Fl I Ar directory
  44 .Op Fl i Ar infile
  45 .Op Fl p Ar prefix
  46 .Op Ar name Ar ...
  47 .Sh DESCRIPTION
  48 The
  49 .Nm
  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
  53 .Xr bsnmpd 1
  54 daemon or for module writers.
  55 The second form may be used by SNMP client program writers.
  56 .Pp
  57 If none of the options
  58 .Fl e ,
  59 .Fl E
  60 or
  61 .Fl t
  62 are used
  63 .Nm
  64 reads a MIB description from its standard input and creates two files: a
  65 C-file
  66 .Ar prefix Ns tree.c
  67 containing a table used by
  68 .Xr bsnmpd 1
  69 during PDU processing
  70 and a header file
  71 .Ar prefix Ns tree.h
  72 containing appropriate declarations of the callback functions used in this
  73 table, the table itself and definitions for all enums.
  74 .Pp
  75 The following options are available:
  76 .Bl -tag -width ".Fl E"
  77 .It Fl d
  78 Switch on debugging.
  79 .It 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
  84 values to strings.
  85 .It Fl e
  86 .Nm
  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
  93 .Va struct asn_oid
  94 in the following way:
  95 .Pp
  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.
 101 .El
 102 .It Fl h
 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
 106 directories.
 107 .It Fl i Ar infile
 108 Read from the named file instead of standard input.
 109 .It Fl l
 110 Generate local preprocessor includes.
 111 This is used for bootstrapping
 112 .Xr bsnmpd 1 .
 113 .It Fl t
 114 Instead of normal output print the resulting tree.
 115 .It Fl p Ar prefix
 116 Prefix the file names and the table name with
 117 .Ar prefix .
 118 .El
 119 .Sh MIBS
 120 The syntax of the MIB description file can formally be specified as follows:
 121 .Bd -unfilled -offset indent
 122  file := top | top file
 123
 124  top := tree | typedef | include
 125
 126  tree := head elements ')'
 127
 128  entry := head ':' index STRING elements ')'
 129
 130  leaf := head type STRING ACCESS ')'
 131
 132  column := head type ACCESS ')'
 133
 134  type := BASETYPE | BASETYPE '|' subtype | enum | bits
 135
 136  subtype := STRING
 137
 138  enum := ENUM '(' value ')'
 139
 140  bits := BITS '(' value ')'
 141
 142  value := INT STRING | INT STRING value
 143
 144  head := '(' INT STRING
 145
 146  elements := EMPTY | elements element
 147
 148  element := tree | leaf | column
 149
 150  index := type | index type
 151
 152  typedef := 'typedef' STRING type
 153
 154  include := 'include' filespec
 155
 156  filespec := '"' STRING '"' | '<' STRING '>'
 157 .Ed
 158 .Pp
 159 .Ar BASETYPE
 160 specifies a SNMP data type and may be one of
 161 .Bl -bullet -offset indent -compact
 162 .It
 163 NULL
 164 .It
 165 INTEGER
 166 .It
 167 INTEGER32 (same as INTEGER)
 168 .It
 169 UNSIGNED32 (same as GAUGE)
 170 .It
 171 OCTETSTRING
 172 .It
 173 IPADDRESS
 174 .It
 175 OID
 176 .It
 177 TIMETICKS
 178 .It
 179 COUNTER
 180 .It
 181 GAUGE
 182 .It
 183 COUNTER64
 184 .El
 185 .Pp
 186 .Ar ACCESS
 187 specifies the accessibility of the MIB variable (which operation can be
 188 performed) and is one of
 189 .Bl -bullet -offset indent -compact
 190 .It
 191 GET
 192 .It
 193 SET
 194 .El
 195 .Pp
 196 .Ar INT
 197 is a decimal integer and
 198 .Ar STRING
 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.
 201 .Pp
 202 The
 203 .Ar typedef
 204 directive associates a type with a single name.
 205 .Pp
 206 The
 207 .Ar include
 208 directive is replaced by the contents of the named file.
 209 .Sh EXAMPLES
 210 The following MIB description describes the system group:
 211 .Bd -literal -offset indent
 212 include "tc.def"
 213
 214 typedef AdminStatus ENUM (
 215         1 up
 216         2 down
 217 )
 218
 219 (1 internet
 220   (2 mgmt
 221     (1 mibII
 222       (1 system
 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)
 231         (9 sysORTable
 232           (1 sysOREntry : INTEGER op_or_table
 233             (1 sysORIndex INTEGER)
 234             (2 sysORID OID GET)
 235             (3 sysORDescr OCTETSTRING GET)
 236             (4 sysORUpTime TIMETICKS GET)
 237         ))
 238       )
 239     )
 240   )
 241 )
 242 .Ed
 243 .Sh SEE ALSO
 244 .Xr bsnmpd 1
 245 .Sh AUTHORS
 246 .An Hartmut Brandt Aq harti@FreeBSD.org