| gensnmptree.1 (150920) | gensnmptree.1 (156066) |
|---|---|
| 1.\" 2.\" Copyright (c) 2001-2005 3.\" Fraunhofer Institute for Open Communication Systems (FhG Fokus). 4.\" All rights reserved. 5.\" 6.\" Author: Harti Brandt <harti@freebsd.org> 7.\" 8.\" Redistribution and use in source and binary forms, with or without --- 12 unchanged lines hidden (view full) --- 21.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27.\" SUCH DAMAGE. 28.\" | 1.\" 2.\" Copyright (c) 2001-2005 3.\" Fraunhofer Institute for Open Communication Systems (FhG Fokus). 4.\" All rights reserved. 5.\" 6.\" Author: Harti Brandt <harti@freebsd.org> 7.\" 8.\" Redistribution and use in source and binary forms, with or without --- 12 unchanged lines hidden (view full) --- 21.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27.\" SUCH DAMAGE. 28.\" |
| 29.\" $Begemot: bsnmp/gensnmptree/gensnmptree.1,v 1.5 2005/06/15 11:31:25 brandt_h Exp $ | 29.\" $Begemot: bsnmp/gensnmptree/gensnmptree.1,v 1.7 2006/02/27 09:52:08 brandt_h Exp $ |
| 30.\" | 30.\" |
| 31.Dd June 14, 2005 | 31.Dd February 27, 2006 |
| 32.Dt GENSNMPTREE 1 33.Os 34.Sh NAME 35.Nm gensnmptree 36.Nd "generate C and header files from a MIB description file" 37.Sh SYNOPSIS 38.Nm 39.Op Fl helt 40.Op Fl p Ar prefix 41.Op Ar name Ar ... 42.Sh DESCRIPTION 43The 44.Nm 45utility is used to either generate C language tables and header files from 46a MIB description or to numeric OIDs from MIB descriptions. 47The first form is used only for maintaining the | 32.Dt GENSNMPTREE 1 33.Os 34.Sh NAME 35.Nm gensnmptree 36.Nd "generate C and header files from a MIB description file" 37.Sh SYNOPSIS 38.Nm 39.Op Fl helt 40.Op Fl p Ar prefix 41.Op Ar name Ar ... 42.Sh DESCRIPTION 43The 44.Nm 45utility is used to either generate C language tables and header files from 46a MIB description or to numeric OIDs from MIB descriptions. 47The first form is used only for maintaining the |
| 48.Xr snmpd 1 | 48.Xr bsnmpd 1 |
| 49daemon or for module writers. 50The second form may be used by SNMP client program writers. 51.Pp 52If the 53.Fl e 54option is not used 55.Nm 56reads a MIB description from its standard input and creates two files: a 57C-file 58.Ar prefix Ns tree.c 59containing a table used by | 49daemon or for module writers. 50The second form may be used by SNMP client program writers. 51.Pp 52If the 53.Fl e 54option is not used 55.Nm 56reads a MIB description from its standard input and creates two files: a 57C-file 58.Ar prefix Ns tree.c 59containing a table used by |
| 60.Xr snmpd 1 | 60.Xr bsnmpd 1 |
| 61during PDU processing 62and a header file 63.Ar prefix Ns tree.h 64containing appropriate declarations of the callback functions used in this table 65and the table itself. 66.Pp 67If the 68.Fl e 69option is specified 70.Nm 71expects MIB variable names (only the last component) on its command line. 72It reads a MIB specification from standard input and for each MIB variable | 61during PDU processing 62and a header file 63.Ar prefix Ns tree.h 64containing appropriate declarations of the callback functions used in this table 65and the table itself. 66.Pp 67If the 68.Fl e 69option is specified 70.Nm 71expects MIB variable names (only the last component) on its command line. 72It reads a MIB specification from standard input and for each MIB variable |
| 73name emits two C preprocessor defines on its standard output. 74One define 75.Va OID_ Ns Ar name 76can be used as an array initialized to initialize a 77.Va struct asn_oid . 78The other define 79.Va OIDLEN_ Ns Ar name 80contains the length of the OID. | 73name emits three C preprocessor defines on its standard output: 74.Bl -tag -width ".Va OIDLEN_ Ns Ar Name" 75.It Va OIDX_ Ns Ar name 76This define can be used to initialize a 77.Va struct asn_oid 78in the following way: |
| 81.Pp | 79.Pp |
| 80.Dl const struct asn_oid oid_sysDescr = OIDX_sysDescr; 81.It Va OIDLEN_ Ns Ar name 82is the length of the OID. 83.It Va OID_ Ns Ar name 84is the last component of the OID. 85.El 86.Pp |
|
| 82The options are as follows: 83.Bl -tag -width ".Fl d Ar argument" 84.It Fl h 85Print a short help page. 86.It Fl e 87Enter extract mode. 88.It Fl l 89Generate local preprocessor includes. 90This is used for bootstrapping | 87The options are as follows: 88.Bl -tag -width ".Fl d Ar argument" 89.It Fl h 90Print a short help page. 91.It Fl e 92Enter extract mode. 93.It Fl l 94Generate local preprocessor includes. 95This is used for bootstrapping |
| 91.Xr snmpd 1 . | 96.Xr bsnmpd 1 . |
| 92.It Fl t 93Instead of normal output print the resulting tree. 94.It Fl p Ar prefix 95Prefix the file names and the table name with 96.Ar prefix . 97.El 98.Sh MIBS 99The syntax of the MIB description file can formally be specified as follows: --- 82 unchanged lines hidden (view full) --- 182 (4 sysORUpTime TIMETICKS GET) 183 )) 184 ) 185 ) 186 ) 187) 188.Ed 189.Sh SEE ALSO | 97.It Fl t 98Instead of normal output print the resulting tree. 99.It Fl p Ar prefix 100Prefix the file names and the table name with 101.Ar prefix . 102.El 103.Sh MIBS 104The syntax of the MIB description file can formally be specified as follows: --- 82 unchanged lines hidden (view full) --- 187 (4 sysORUpTime TIMETICKS GET) 188 )) 189 ) 190 ) 191 ) 192) 193.Ed 194.Sh SEE ALSO |
| 190.Xr snmpd 1 | 195.Xr bsnmpd 1 |
| 191.Sh AUTHORS 192.An Hartmut Brandt Aq harti@freebsd.org | 196.Sh AUTHORS 197.An Hartmut Brandt Aq harti@freebsd.org |