1.\" 2.\" Copyright (c) 2005,2008 3.\" Hartmut Brandt. 4.\" All rights reserved. 5.\" 6.\" Author: Hartmut Brandt <harti@FreeBSD.org> 7.\" 8.\" Redistribution and use in source and binary forms, with or without 9.\" modification, are permitted provided that the following conditions 10.\" are met: 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. 16.\" 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 27.\" SUCH DAMAGE. 28.\" 29.Dd January 8, 2008 30.Dt BSD.SNMPMOD.MK 7 31.Os 32.Sh NAME 33.Nm bsd.snmpmod.mk 34.Nd building modules for 35.Xr bsnmpd 1 36.Sh SYNOPSIS 37.Fd ".include <bsd.snmpmod.mk>" 38.Sh DESCRIPTION 39The file 40.In bsd.snmpmod.mk 41simplifies the building of modules for the Begemot SNMP daemon, 42.Xr bsnmpd 1 . 43It provides some common functions for building a module and 44relies on 45.In bsd.lib.mk , 46which is included by 47.In bsd.snmpmod.mk 48to actually build the shared library. 49.Pp 50The following 51.Xr make 1 52variables control the special functions: 53.Bl -tag -width ".Va EXTRAMIBDEFS" 54.It Va MOD 55The short name of the module. 56The name of the shared library will be 57.Pa snmp_${MOD}.so . 58There must exist a file 59.Pa ${MOD}_tree.def 60for compilation with 61.Xr gensnmptree 1 62which contains the definition of the MIB tree implemented by the module. 63.It Va EXTRAMIBDEFS 64A list of extra MIB definition files for 65.Xr gensnmptree 1 . 66This is optional. 67This file list is given to both calls to 68.Xr gensnmptree 1 No \(em 69the one that extracts the symbols in 70.Va XSYM 71from the MIB definitions and the one that 72generates the table with OIDs served by this module. 73.It Va EXTRAMIBSYMS 74A list of extra MIB definition files for 75.Xr gensnmptree 1 . 76This is optional. 77This file list is given only to the call to 78.Xr gensnmptree 1 79that extracts symbols from MIB definition files. 80It is useful if there are dependencies on other MIBs or for extracting global 81definitions for enumeration constants. 82.It Va XSYM 83A list of symbols to be extracted from the MIB definition files by 84.Xr gensnmptree 1 . 85This is optional. 86.It Va DEFS 87A list of MIB definition files to be installed. 88This is optional. 89.It Va BMIBS 90A list of textual MIBs to be installed. 91This is optional. 92.El 93.Pp 94Three files are automatically created from the MIB definition files and 95the 96.Va XSYM 97variable: 98.Bl -tag -width ".Va EXTRAMIBDEFS" 99.It Pa ${MOD}_tree.c 100This contains a table with the tree implemented by the module. 101It is automatically included into the 102.Va SRCS 103variable. 104.It Pa ${MOD}_tree.h 105This contains preprocessor defines for all the OIDs defined by the module 106and can be included in the module's source code. 107.It Pa ${MOD}_oid.h 108OID preprocessor definitions for all the symbols listed in 109.Va XSYMS . 110This is to be included into the module's source code. 111.El 112.Sh SEE ALSO 113.Xr bsnmpd 1 , 114.Xr gensnmptree 1 , 115.Xr snmpmod 3 116