2 .\" Copyright (c) 2005,2008
4 .\" All rights reserved.
6 .\" Author: Hartmut Brandt <harti@FreeBSD.org>
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that the following conditions
11 .\" 1. Redistributions of source code must retain the above copyright
12 .\" notice, this list of conditions and the following disclaimer.
13 .\" 2. Redistributions in binary form must reproduce the above copyright
14 .\" notice, this list of conditions and the following disclaimer in the
15 .\" documentation and/or other materials provided with the distribution.
17 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
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
36 .Nd building modules for
39 .Fd ".include <bsd.snmpmod.mk>"
43 simplifies the building of modules for the Begemot SNMP daemon,
45 It provides some common functions for building a module and
50 to actually build the shared library.
54 variables control the special functions:
55 .Bl -tag -width ".Va EXTRAMIBDEFS"
57 The short name of the module.
58 The name of the shared library will be
60 There must exist a file
64 which contains the definition of the MIB tree implemented by the module.
66 A list of extra MIB definition files for
69 This file list is given to both calls to
70 .Xr gensnmptree 1 No \(em
71 the one that extracts the symbols in
73 from the MIB definitions and the one that
74 generates the table with OIDs served by this module.
76 A list of extra MIB definition files for
79 This file list is given only to the call to
81 that extracts symbols from MIB definition files.
82 It is useful if there are dependencies on other MIBs or for extracting global
83 definitions for enumeration constants.
85 A list of symbols to be extracted from the MIB definition files by
89 A list of MIB definition files to be installed.
92 A list of textual MIBs to be installed.
96 Three files are automatically created from the MIB definition files and
100 .Bl -tag -width ".Va EXTRAMIBDEFS"
102 This contains a table with the tree implemented by the module.
103 It is automatically included into the
107 This contains preprocessor defines for all the OIDs defined by the module
108 and can be included in the module's source code.
110 OID preprocessor definitions for all the symbols listed in
112 This is to be included into the module's source code.