xref: /netbsd-src/external/bsd/ntp/dist/ntpsnmpd/ntpsnmpd-opts.def (revision d11b170b9000ada93db553723522a63d5deac310)
1/* -*- Mode: Text -*- */
2
3autogen definitions options;
4
5#include copyright.def
6#include homerc.def
7#include autogen-version.def
8
9prog-name      = "ntpsnmpd";
10prog-title     = "NTP SNMP MIB agent";
11
12test-main;
13
14flag = {
15    name      = nofork;
16    value     = n;
17    descrip   = "Do not fork";
18    doc = <<-  _EndOfDoc_
19	_EndOfDoc_;
20};
21
22flag = {
23    name      = syslog;
24    value     = p;
25    descrip   = "Log to syslog()";
26    doc = <<-  _EndOfDoc_
27	_EndOfDoc_;
28};
29
30flag = {
31    name      = agentXSocket;
32/*  value     = x; */
33    arg-type  = string;
34    arg-default = "unix:/var/agentx/master";
35    descrip   = "The socket address ntpsnmpd uses to connect to net-snmpd";
36    doc = <<-  _EndOfDoc_
37	[<transport-specifier>:]<transport-address>
38	The default "agent X socket" is the Unix Domain socket
39	@file{unix:/var/agentx/master}.
40	Another common alternative is @file{tcp:localhost:705}.
41	_EndOfDoc_;
42};
43
44/* explain: Additional information whenever the usage routine is invoked */
45explain = <<- _END_EXPLAIN
46	_END_EXPLAIN;
47
48doc-section	= {
49  ds-type	= 'DESCRIPTION';
50  ds-format	= 'mdoc';
51  ds-text	= <<- _END_PROG_MDOC_DESCRIP
52	.Nm
53	is an SNMP MIB agent designed to interface with
54	.Xr ntpd 1ntpdmdoc .
55	_END_PROG_MDOC_DESCRIP;
56};
57
58/*
59prog-info-descrip = <<- _END_PROG_INFO_DESCRIP
60	_END_PROG_INFO_DESCRIP;
61*/
62
63doc-section	= {
64  ds-type	= 'USAGE';
65  ds-format	= 'mdoc';
66  ds-text	= <<- _END_MDOC_USAGE
67	.Nm
68	currently uses a private MIB OID,
69	.Ql enterprises.5597 ,
70	which is the Meinberg top level OEM OID, and
71	.Ql 99
72	is the temporary working space for this project.
73	The final OID has to be registered with IANA
74	and this is done by the RFC Editor
75	when the NTPv4 MIB RFC is standardized.
76	.Pp
77	If you have
78	.Xr snmpwalk 1
79	installed you can run
80	.Dl % snmpwalk -v2c -c public localhost enterprises.5597.99
81	to see a list of all currently supported NTP MIB objects
82	and their current values.
83	_END_MDOC_USAGE;
84};
85
86doc-section	= {
87  ds-type	= 'NOTES';
88  ds-format	= 'mdoc';
89  ds-text	= <<- _END_MDOC_NOTES
90The following objects are currently supported:
91.Pp
92.Bl -tag -width ".Li ntpEntSoftwareVersionVal" -compact -offset indent
93.It Li ntpEntSoftwareName
94please fill me in...
95.It Li ntpEntSoftwareVersion
96please fill me in...
97.It Li ntpEntSoftwareVersionVal
98please fill me in...
99.It Li ntpEntSoftwareVendor
100please fill me in...
101.It Li ntpEntSystemType
102please fill me in...
103.It Li ntpEntTimeResolution
104please fill me in...
105.It Li ntpEntTimeResolutionVal
106please fill me in...
107.It Li ntpEntTimePrecision
108please fill me in...
109.It Li ntpEntTimePrecisionVal
110please fill me in...
111.It Li ntpEntTimeDistance
112please fill me in...
113.El
114.Pp
115This document corresponds to version #VERSION# of NTP.
116	_END_MDOC_NOTES;
117};
118
119doc-section	= {
120  ds-type	= 'AUTHORS';
121  ds-format	= 'mdoc';
122  ds-text	= <<- _END_MDOC_AUTHORS
123.An "Heiko Gerstung"
124	_END_MDOC_AUTHORS;
125};
126
127/*
128doc-section     = {
129  ds-type       = 'SEE ALSO';
130  ds-format     = 'mdoc';
131  ds-text       = <<- _END_MDOC_SEE_ALSO
132.Rs
133.%A H. Gerstung
134.%A C. Elliott
135.%A B. Haberman, Ed.
136.%T Definitions of Managed Objects for Network Time Protocol Version 4: (NTPv4)
137.%O RFC5907
138.Re
139        _END_MDOC_SEE_ALSO;
140};
141*/
142
143/*
144doc-section	= {
145  ds-type	= 'BUGS';
146  ds-format	= 'mdoc';
147  ds-text	= <<- _END_MDOC_BUGS
148	_END_MDOC_BUGS;
149};
150*/
151