diff options
Diffstat (limited to 'ntpsnmpd/ntpsnmpd.mdoc.in')
| -rw-r--r-- | ntpsnmpd/ntpsnmpd.mdoc.in | 144 |
1 files changed, 144 insertions, 0 deletions
diff --git a/ntpsnmpd/ntpsnmpd.mdoc.in b/ntpsnmpd/ntpsnmpd.mdoc.in new file mode 100644 index 000000000000..d85df74e59c6 --- /dev/null +++ b/ntpsnmpd/ntpsnmpd.mdoc.in @@ -0,0 +1,144 @@ +.Dd December 19 2014 +.Dt NTPSNMPD @NTPSNMPD_MS@ User Commands +.Os +.\" EDIT THIS FILE WITH CAUTION (ntpsnmpd-opts.mdoc) +.\" +.\" It has been AutoGen-ed December 19, 2014 at 07:50:34 AM by AutoGen 5.18.5pre4 +.\" From the definitions ntpsnmpd-opts.def +.\" and the template file agmdoc-cmd.tpl +.Sh NAME +.Nm ntpsnmpd +.Nd NTP SNMP MIB agent +.Sh SYNOPSIS +.Nm +.\" Mixture of short (flag) options and long options +.Op Fl flags +.Op Fl flag Op Ar value +.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc +.Pp +All arguments must be options. +.Pp +.Sh DESCRIPTION +.Nm +is an SNMP MIB agent designed to interface with +.Xr ntpd @NTPD_MS@ . +.Sh "OPTIONS" +.Bl -tag +.It Fl n , Fl \-nofork +Do not fork. +.sp +.It Fl p , Fl \-syslog +Log to syslog(). +.sp +.It Fl \-agentxsocket Ns = Ns Ar string +The socket address ntpsnmpd uses to connect to net\-snmpd. +The default +.Ar string +for this option is: +.ti +4 + unix:/var/agentx/master +.sp +[<transport\-specifier>:]<transport\-address> +The default "agent X socket" is the Unix Domain socket +\fIunix:/var/agentx/master\fP. +Another common alternative is \fItcp:localhost:705\fP. +.It Fl \&? , Fl \-help +Display usage information and exit. +.It Fl \&! , Fl \-more\-help +Pass the extended usage information through a pager. +.It Fl > Oo Ar cfgfile Oc , Fl \-save\-opts Oo Ns = Ns Ar cfgfile Oc +Save the option state to \fIcfgfile\fP. The default is the \fIlast\fP +configuration file listed in the \fBOPTION PRESETS\fP section, below. +The command will exit after updating the config file. +.It Fl < Ar cfgfile , Fl \-load\-opts Ns = Ns Ar cfgfile , Fl \-no\-load\-opts +Load options from \fIcfgfile\fP. +The \fIno\-load\-opts\fP form will disable the loading +of earlier config/rc/ini files. \fI\-\-no\-load\-opts\fP is handled early, +out of order. +.It Fl \-version Op Brq Ar v|c|n +Output version of program and exit. The default mode is `v', a simple +version. The `c' mode will print copyright information and `n' will +print the full copyright notice. +.El +.Sh "OPTION PRESETS" +Any option that is not marked as \fInot presettable\fP may be preset +by loading values from configuration ("RC" or ".INI") file(s) and values from +environment variables named: +.nf + \fBNTPSNMPD_<option\-name>\fP or \fBNTPSNMPD\fP +.fi +.ad +The environmental presets take precedence (are processed later than) +the configuration files. +The \fIhomerc\fP files are "\fI$HOME\fP", and "\fI.\fP". +If any of these are directories, then the file \fI.ntprc\fP +is searched for within those directories. +.Sh USAGE +.Nm +currently uses a private MIB OID, +.Ql enterprises.5597 , +which is the Meinberg top level OEM OID, and +.Ql 99 +is the temporary working space for this project. +The final OID has to be registered with IANA +and this is done by the RFC Editor +when the NTPv4 MIB RFC is standardized. +.Pp +If you have +.Xr snmpwalk 1 +installed you can run +.Dl % snmpwalk \-v2c \-c public localhost enterprises.5597.99 +to see a list of all currently supported NTP MIB objects +and their current values. +.Sh "ENVIRONMENT" +See \fBOPTION PRESETS\fP for configuration environment variables. +.Sh "FILES" +See \fBOPTION PRESETS\fP for configuration files. +.Sh "EXIT STATUS" +One of the following exit values will be returned: +.Bl -tag +.It 0 " (EXIT_SUCCESS)" +Successful program execution. +.It 1 " (EXIT_FAILURE)" +The operation failed or the command syntax was not valid. +.It 66 " (EX_NOINPUT)" +A specified configuration file could not be loaded. +.It 70 " (EX_SOFTWARE)" +libopts had an internal operational error. Please report +it to autogen\-users@lists.sourceforge.net. Thank you. +.El +.Sh AUTHORS +.An "Heiko Gerstung" +.Sh "COPYRIGHT" +Copyright (C) 1970\-2014 The University of Delaware all rights reserved. +This program is released under the terms of the NTP license, <http://ntp.org/license>. +.Sh "BUGS" +Please send bug reports to: http://bugs.ntp.org, bugs@ntp.org +.Sh NOTES +The following objects are currently supported: +.Pp +.Bl -tag -width ".Li ntpEntSoftwareVersionVal" -compact -offset indent +.It Li ntpEntSoftwareName +please fill me in... +.It Li ntpEntSoftwareVersion +please fill me in... +.It Li ntpEntSoftwareVersionVal +please fill me in... +.It Li ntpEntSoftwareVendor +please fill me in... +.It Li ntpEntSystemType +please fill me in... +.It Li ntpEntTimeResolution +please fill me in... +.It Li ntpEntTimeResolutionVal +please fill me in... +.It Li ntpEntTimePrecision +please fill me in... +.It Li ntpEntTimePrecisionVal +please fill me in... +.It Li ntpEntTimeDistance +please fill me in... +.El +.Pp +This manual page was \fIAutoGen\fP\-erated from the \fBntpsnmpd\fP +option definitions. |