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