added files
[bcm963xx.git] / userapps / opensource / net-snmp / local / mib2c.conf
1 @open -@
2 mib2c has multiple configuration files depending on the type of
3 code you need to write.  You must pick one depending on your need:
4
5
6   GENERATING CODE FOR SCALAR OBJECTS:
7
8     If you're writing code for some scalars, run:
9
10       mib2c -c mib2c.scalar.conf ${name}
11
12     If you want to magically "tie" integer variables to integer scalars,
13     use:
14
15       mib2c -c mib2c.int_watch.conf ${name}
16
17
18   GENERATING CODE FOR TABLES:
19
20     If your table data is kept somewhere else (e.g. it's in the
21     kernel and not in the memory of the agent itself) and you need to
22     "iterate" over it to find the right data for the SNMP row being
23     accessed.  See the agent/mibgroup/mibII/vacm_context.c file for an
24     example:
25
26       mib2c -c mib2c.iterate.conf ${name}
27
28     If your table data is kept in the agent (i.e. it's not located in
29     an external source) and is purely data driven (i.e. you do not need
30     to perform any work when a set occurs).  See the
31     agent/mibgroup/examples/data_set.c file for an example of such a table:
32
33       mib2c -c mib2c.create-dataset.conf ${name}
34
35     If your table data is kept in the agent (i.e. it's not located in
36     an external source), and you can keep your data sorted by the table
37     index but you do need to perform work when a set occurs:
38
39       mib2c -c mib2c.array-user.conf ${name}
40
41
42   GENERATING HEADER FILE DEFINITIONS
43
44     To generate just a header with a define for each column number in
45     your table:
46
47       mib2c -c mib2c.column_defines.conf ${name}
48
49     To generate just a header with a define for each enum for any
50     column containing enums:
51
52       mib2c -c mib2c.column_enums.conf ${name}
53
54   GENERATING CODE FOR THE 4.X LINE OF CODE (THE OLDER API)
55
56       mib2c -c mib2c.old-api.conf ${name}