userapps/opensource/net-snmp/man/mib2c.1.def

   1 .TH MIB2C 1 "04 April 2002" VVERSIONINFO "Net-SNMP"
   2 .UC 4
   3 .SH NAME
   4 mib2c -- produces template code from mib definitions
   5 .SH SYNOPSIS
   6 .B mib2c
   7 [-h] -c CONFIGFILE [-f OUTNAME] MIBNODE
   8 .SH DESCRIPTION
   9 .B mib2c
  10 merely takes a given OID and converts the MIB structures within it
  11 into template C code which can then be compiled into the agent.  It is
  12 .B not
  13 necessarily expected that the code can be used without a real human
  14 editing the code.  It is only a template.  (Now, having said that the
  15 mib2c.create-dataset.conf file actually produces code which doesn't
  16 necessarily need to be edited further, though it's likely you'll want
  17 to anyway).
  18 .PP
  19 You
  20 .B must
  21 give mib2c a mib node (e.g., ifTable) not a mib file on the
  22 command line.  (this is the most common mistake).
  23 .PP
  24 The default mib2c.conf file really does nothing but explain to the
  25 caller that other mib2c.conf files should actually be used.   We can't
  26 predict what type of tables you want to generate code for, so you must
  27 select an appropriate mib2c.conf file to use.  Run "
  28 .I "mib2c ifTable"
  29 " for help, as it'll display and explain the currently available
  30 mib2c.conf files you can use.
  31 .SH "OPTIONS"
  32 .TP
  33 .BI -h
  34 Display a help message.
  35 .TP
  36 .BI -c " CONFIGFILE"
  37 Use CONFIGFILE when generating code.  These files will be searched for
  38 first in the current directory and then in the DATADIR directory
  39 (which is where the default mib2c configuration files can be found).
  40 .TP
  41 .BI -f " OUTNAME"
  42 Places the output code into OUTNAME.c and OUTNAME.h. Normally, mib2c
  43 will place the output code into files which correspond to the table
  44 names it is generating code for, which is probably what you want anyway.