ntpsnmpd.mdoc.in revision 285612 
1134411Ssimon.Dd June 29 2015
2134411Ssimon.Dt NTPSNMPD @NTPSNMPD_MS@ User Commands
3134411Ssimon.Os
4134411Ssimon.\"  EDIT THIS FILE WITH CAUTION  (ntpsnmpd-opts.mdoc)
5134411Ssimon.\"
6134411Ssimon.\"  It has been AutoGen-ed  June 29, 2015 at 04:31:56 PM by AutoGen 5.18.5
7134411Ssimon.\"  From the definitions    ntpsnmpd-opts.def
8134411Ssimon.\"  and the template file   agmdoc-cmd.tpl
9134411Ssimon.Sh NAME
10134411Ssimon.Nm ntpsnmpd
11134411Ssimon.Nd NTP SNMP MIB agent
12134411Ssimon.Sh SYNOPSIS
13134411Ssimon.Nm
14134411Ssimon.\" Mixture of short (flag) options and long options
15134411Ssimon.Op Fl flags
16134411Ssimon.Op Fl flag Op Ar value
17134411Ssimon.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc
18134411Ssimon.Pp
19134411SsimonAll arguments must be options.
20134411Ssimon.Pp
21134411Ssimon.Sh DESCRIPTION
22134411Ssimon.Nm
23134411Ssimonis an SNMP MIB agent designed to interface with
24134411Ssimon.Xr ntpd @NTPD_MS@ .
25134411Ssimon.Sh "OPTIONS"
26134411Ssimon.Bl -tag
27153459Sjoel.It  Fl n , Fl \-nofork 
28134411SsimonDo not fork.
29134411Ssimon.sp
30134411Ssimon.It  Fl p , Fl \-syslog 
31134411SsimonLog to syslog().
32134411Ssimon.sp
33134411Ssimon.It  Fl \-agentxsocket  Ns = Ns Ar string 
34153459SjoelThe socket address ntpsnmpd uses to connect to net\-snmpd.
35153459SjoelThe default
36153459Sjoel.Ar string
37134938Srufor this option is:
38134411Ssimon.ti +4
39153459Sjoel unix:/var/agentx/master
40153459Sjoel.sp
41153459Sjoel[<transport\-specifier>:]<transport\-address>
42153459SjoelThe default "agent X socket" is the Unix Domain socket
43153459Sjoel\fIunix:/var/agentx/master\fP.
44153459SjoelAnother common alternative is \fItcp:localhost:705\fP.
45153459Sjoel.It Fl \&? , Fl \-help
46153459SjoelDisplay usage information and exit.
47134411Ssimon.It Fl \&! , Fl \-more\-help
48134411SsimonPass the extended usage information through a pager.
49134411Ssimon.It Fl > Oo Ar cfgfile Oc , Fl \-save\-opts Oo Ns = Ns Ar cfgfile Oc
50134411SsimonSave the option state to \fIcfgfile\fP.  The default is the \fIlast\fP
51134411Ssimonconfiguration file listed in the \fBOPTION PRESETS\fP section, below.
52134411SsimonThe command will exit after updating the config file.
53134411Ssimon.It Fl < Ar cfgfile , Fl \-load\-opts Ns = Ns Ar cfgfile , Fl \-no\-load\-opts
54134411SsimonLoad options from \fIcfgfile\fP.
55134411SsimonThe \fIno\-load\-opts\fP form will disable the loading
56146489Sbruefferof earlier config/rc/ini files.  \fI\-\-no\-load\-opts\fP is handled early,
57134411Ssimonout of order.
58134411Ssimon.It Fl \-version Op Brq Ar v|c|n
59134411SsimonOutput version of program and exit.  The default mode is `v', a simple
60149198Sjoelversion.  The `c' mode will print copyright information and `n' will
61134411Ssimonprint the full copyright notice.
62149198Sjoel.El
63149198Sjoel.Sh "OPTION PRESETS"
64134411SsimonAny option that is not marked as \fInot presettable\fP may be preset
65149198Sjoelby loading values from configuration ("RC" or ".INI") file(s) and values from
66149198Sjoelenvironment variables named:
67134411Ssimon.nf
68134411Ssimon  \fBNTPSNMPD_<option\-name>\fP or \fBNTPSNMPD\fP
69134411Ssimon.fi
70134411Ssimon.ad
71134411SsimonThe environmental presets take precedence (are processed later than)
72134411Ssimonthe configuration files.
73152895SjoelThe \fIhomerc\fP files are "\fI$HOME\fP", and "\fI.\fP".
74152895SjoelIf any of these are directories, then the file \fI.ntprc\fP
75134411Ssimonis searched for within those directories.
76134411Ssimon.Sh USAGE
77.Nm
78currently uses a private MIB OID,
79.Ql enterprises.5597 ,
80which is the Meinberg top level OEM OID, and
81.Ql 99
82is the temporary working space for this project. 
83The final OID has to be registered with IANA
84and this is done by the RFC Editor
85when the NTPv4 MIB RFC is standardized. 
86.Pp
87If you have
88.Xr snmpwalk 1
89installed you can run
90.Dl % snmpwalk \-v2c \-c public localhost enterprises.5597.99
91to see a list of all currently supported NTP MIB objects
92and their current values.
93.Sh "ENVIRONMENT"
94See \fBOPTION PRESETS\fP for configuration environment variables.
95.Sh "FILES"
96See \fBOPTION PRESETS\fP for configuration files.
97.Sh "EXIT STATUS"
98One of the following exit values will be returned:
99.Bl -tag
100.It 0 " (EXIT_SUCCESS)"
101Successful program execution.
102.It 1 " (EXIT_FAILURE)"
103The operation failed or the command syntax was not valid.
104.It 66 " (EX_NOINPUT)"
105A specified configuration file could not be loaded.
106.It 70 " (EX_SOFTWARE)"
107libopts had an internal operational error.  Please report
108it to autogen\-users@lists.sourceforge.net.  Thank you.
109.El
110.Sh AUTHORS
111.An "Heiko Gerstung"
112.Sh "COPYRIGHT"
113Copyright (C) 1992\-2015 The University of Delaware and Network Time Foundation all rights reserved.
114This program is released under the terms of the NTP license, <http://ntp.org/license>.
115.Sh "BUGS"
116Please send bug reports to: http://bugs.ntp.org, bugs@ntp.org
117.Sh NOTES
118The following objects are currently supported:
119.Pp
120.Bl -tag -width ".Li ntpEntSoftwareVersionVal" -compact -offset indent
121.It Li ntpEntSoftwareName
122please fill me in...
123.It Li ntpEntSoftwareVersion
124please fill me in...
125.It Li ntpEntSoftwareVersionVal
126please fill me in...
127.It Li ntpEntSoftwareVendor
128please fill me in...
129.It Li ntpEntSystemType
130please fill me in...
131.It Li ntpEntTimeResolution
132please fill me in...
133.It Li ntpEntTimeResolutionVal
134please fill me in...
135.It Li ntpEntTimePrecision
136please fill me in...
137.It Li ntpEntTimePrecisionVal
138please fill me in...
139.It Li ntpEntTimeDistance
140please fill me in...
141.El
142.Pp
143This manual page was \fIAutoGen\fP\-erated from the \fBntpsnmpd\fP
144option definitions.
145