d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

This is a short man page which describes bsd.snmpmod.mk. It documents

Browse Source 
only the features that this file layers on top of bsd.lib.mk and should
therefore cross-reference to bsd.lib.mk, which doesn't exist.
This commit is contained in:
harti 2005-11-10 10:09:42 +00:00
parent 86929f9937
commit 521ee9798f
2 changed files with 99 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
share/man/man7/Makefile
View File

@ -3,6 +3,7 @@
#MISSING: eqnchar.7 ms.7 term.7
MAN= ascii.7 \
bsd.snmpmod.mk.7 \
build.7 \
clocks.7 \
development.7 \

98
share/man/man7/bsd.snmpmod.mk.7 Normal file
View File

@ -0,0 +1,98 @@
.\"
.\" Copyright (c) 2005
.\" Hartmut Brandt.
.\" All rights reserved.
.\"
.\" Author: Hartmut Brandt <harti@FreeBSD.org>
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd November 9, 2005
.Dt BSD.SNMPMOD.MK 5
.Os
.Sh NAME
.Nm bsd.snmpmod.mk
.Sh SYNOPSIS
.Fd .include <bsd.snmpmod.mk>
.Sh DESCRIPTION
The file
.In bsd.snmpmod.mk
simplifies the building of modules for the Begemot SNMP daemon
.Xr bsnmpd 1 .
It provides some common functions for building a module and
relies on
.In bsd.lib.mk ,
which is included by
.In bsd.snmpmod.mk
to actually build the shared library.
.Pp
The following
.Xr make 1
variables control the special functions:
.Bl -tag -width 'EXTRAMIBDEFS'
.It Va MOD
The short name of the module.
The name of the shared library will be
.Pa snmp_${MOD}.so .
There must exist a file
.Pa ${MOD}_tree.def
for compilation with
.Xr gensnmptree 1
which contains the definition of the MIB tree implemented by the module.
.It Va EXTRAMIBDEFS
A list of extra MIB definition files for
.Xr gensnmptree 1 .
This is optional.
.It Va XSYM
A list of symbols to be extracted from the MIB definition files by
.Xr gensnmptree 1 .
This is optional.
.It Va DEFS
A list of MIB definition files to be installed. This is optional.
.It Va BMIBS
A list of textual MIBs to be installed. This is optional.
.El
.Pp
Three file are automatically created from the MIB definition files and
the
.Va XSYM
variable:
.Bl -tag -width 'EXTRAMIBDEFS'
.It Pa ${MOD}_tree.c
This contains a table with the tree implemented by the module.
It is automatically included into the
.Va SRCS
variable.
.It Pa ${MOD}_tree.h
This contains preprocessor defines for all the OIDs defined by the module
and can be included in the module's source code.
.It Pa ${MOD}_oid.h
OID preprocessor definitions for all the symbols listed in
.Va XSYMS .
This is to be included into the module's source code.
.El
.Sh SEE ALSO
.Xr bsnmpd 1 ,
.Xr gensnmptree 1 ,
.Xr snmpmod 3