static/freebsd/man7/bsd.snmpmod.mk.7 3.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

<table class="head">
  <tr>
    <td class="head-ltitle">BSD.SNMPMOD.MK(7)</td>
    <td class="head-vol">Miscellaneous Information Manual</td>
    <td class="head-rtitle">BSD.SNMPMOD.MK(7)</td>
  </tr>
</table>
<div class="manual-text">
<section class="Sh">
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
<p class="Pp"><code class="Nm">bsd.snmpmod.mk</code> &#x2014;
    <span class="Nd">building modules for <a class="Xr">bsnmpd(1)</a></span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<p class="Pp"><code class="Fd">.include &lt;bsd.snmpmod.mk&gt;</code></p>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp">The file
    <code class="In">&lt;<a class="In">bsd.snmpmod.mk</a>&gt;</code> simplifies
    the building of modules for the Begemot SNMP daemon,
    <a class="Xr">bsnmpd(1)</a>. It provides some common functions for building
    a module and relies on
    <code class="In">&lt;<a class="In">bsd.lib.mk</a>&gt;</code>, which is
    included by <code class="In">&lt;<a class="In">bsd.snmpmod.mk</a>&gt;</code>
    to actually build the shared library.</p>
<p class="Pp">The following <a class="Xr">make(1)</a> variables control the
    special functions:</p>
<dl class="Bl-tag">
  <dt id="MOD"><var class="Va">MOD</var></dt>
  <dd>The short name of the module. The name of the shared library will be
      <span class="Pa">snmp_${MOD}.so</span>. There must exist a file
      <span class="Pa">${MOD}_tree.def</span> for compilation with
      <a class="Xr">gensnmptree(1)</a> which contains the definition of the MIB
      tree implemented by the module.</dd>
  <dt id="EXTRAMIBDEFS"><var class="Va">EXTRAMIBDEFS</var></dt>
  <dd>A list of extra MIB definition files for <a class="Xr">gensnmptree(1)</a>.
      This is optional. This file list is given to both calls to
      <a class="Xr">gensnmptree(1)</a> <span class="No">&#x2014;</span> the one
      that extracts the symbols in <var class="Va">XSYM</var> from the MIB
      definitions and the one that generates the table with OIDs served by this
      module.</dd>
  <dt id="EXTRAMIBSYMS"><var class="Va">EXTRAMIBSYMS</var></dt>
  <dd>A list of extra MIB definition files for <a class="Xr">gensnmptree(1)</a>.
      This is optional. This file list is given only to the call to
      <a class="Xr">gensnmptree(1)</a> that extracts symbols from MIB definition
      files. It is useful if there are dependencies on other MIBs or for
      extracting global definitions for enumeration constants.</dd>
  <dt id="XSYM"><var class="Va">XSYM</var></dt>
  <dd>A list of symbols to be extracted from the MIB definition files by
      <a class="Xr">gensnmptree(1)</a>. This is optional.</dd>
  <dt id="DEFS"><var class="Va">DEFS</var></dt>
  <dd>A list of MIB definition files to be installed. This is optional.</dd>
  <dt id="BMIBS"><var class="Va">BMIBS</var></dt>
  <dd>A list of textual MIBs to be installed. This is optional.</dd>
</dl>
<p class="Pp">Three files are automatically created from the MIB definition
    files and the <var class="Va">XSYM</var> variable:</p>
<dl class="Bl-tag">
  <dt><span class="Pa">${MOD}_tree.c</span></dt>
  <dd>This contains a table with the tree implemented by the module. It is
      automatically included into the <var class="Va">SRCS</var> variable.</dd>
  <dt><span class="Pa">${MOD}_tree.h</span></dt>
  <dd>This contains preprocessor defines for all the OIDs defined by the module
      and can be included in the module's source code.</dd>
  <dt><span class="Pa">${MOD}_oid.h</span></dt>
  <dd>OID preprocessor definitions for all the symbols listed in
      <var class="Va">XSYMS</var>. This is to be included into the module's
      source code.</dd>
</dl>
</section>
<section class="Sh">
<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
  ALSO</a></h1>
<p class="Pp"><a class="Xr">bsnmpd(1)</a>, <a class="Xr">gensnmptree(1)</a>,
    <a class="Xr">snmpmod(3)</a></p>
</section>
</div>
<table class="foot">
  <tr>
    <td class="foot-date">January 8, 2008</td>
    <td class="foot-os">FreeBSD 15.0</td>
  </tr>
</table>