xref: /freebsd/contrib/ntp/ntpsnmpd/ntpsnmpd.man.in (revision a0ee8cc636cd5c2374ec44ca71226564ea0bca95)
. it 1 an-trap . if \\n[.$] \,\\$*\/ ..
ntpsnmpd @NTPSNMPD_MS@ "07 Jan 2016" "4.2.8p5" "User Commands"

EDIT THIS FILE WITH CAUTION (/tmp/.ag-dZaaSu/ag-qZa4Qu)

It has been AutoGen-ed January 7, 2016 at 11:32:12 PM by AutoGen 5.18.5
From the definitions ntpsnmpd-opts.def
and the template file agman-cmd.tpl
NAME
\f\*[B-Font]ntpsnmpd - NTP SNMP MIB agent
SYNOPSIS
\f\*[B-Font]ntpsnmpd Mixture of short (flag) options and long options
[\f\*[B-Font]-flags\f[]] [\f\*[B-Font]-flag\f[] [\f\*[I-Font]value\f[]]] [\f\*[B-Font]--option-name\f[][[=| ]\f\*[I-Font]value\f[]]] All arguments must be options.
DESCRIPTION
\f\*[B-Font]ntpsnmpd is an SNMP MIB agent designed to interface with ntpd\f[](@NTPD_MS@)\f[].
"OPTIONS"

.NOP \f\*[B-Font]-n\f[], \f\*[B-Font]--nofork\f[] Do not fork.

.NOP \f\*[B-Font]-p\f[], \f\*[B-Font]--syslog\f[] Log to syslog().

.NOP \f\*[B-Font]--agentxsocket\f[]=\f\*[I-Font]string\f[] The socket address ntpsnmpd uses to connect to net-snmpd. The default \f\*[I-Font]string\f[] for this option is: unix:/var/agentx/master [<transport-specifier>:]<transport-address> The default "agent X socket" is the Unix Domain socket unix:/var/agentx/master. Another common alternative is tcp:localhost:705.

.NOP \f\*[B-Font]-?\f[], \f\*[B-Font]--help\f[] Display usage information and exit.

.NOP \f\*[B-Font]-!\f[], \f\*[B-Font]--more-help\f[] Pass the extended usage information through a pager.

.NOP \f\*[B-Font]->\f[] [\f\*[I-Font]cfgfile\f[]], \f\*[B-Font]--save-opts\f[] [=\f\*[I-Font]cfgfile\f[]] Save the option state to cfgfile. The default is the last configuration file listed in the OPTION PRESETS section, below. The command will exit after updating the config file.

.NOP \f\*[B-Font]-<\f[] \f\*[I-Font]cfgfile\f[], \f\*[B-Font]--load-opts\f[]=\f\*[I-Font]cfgfile\f[], \f\*[B-Font]--no-load-opts\f[] Load options from cfgfile. The no-load-opts form will disable the loading of earlier config/rc/ini files. --no-load-opts is handled early, out of order.

.NOP \f\*[B-Font]--version\f[] [{\f\*[I-Font]v|c|n\f[]}] 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.

"OPTION PRESETS"
Any option that is not marked as not presettable may be preset by loading values from configuration ("RC" or ".INI") file(s) and values from environment variables named:
 NTPSNMPD_<option-name> or NTPSNMPD
The environmental presets take precedence (are processed later than) the configuration files. The homerc files are "$HOME", and ".". If any of these are directories, then the file .ntprc is searched for within those directories.
USAGE
\f\*[B-Font]ntpsnmpd currently uses a private MIB OID, \[oq]enterprises.5597\[cq], which is the Meinberg top level OEM OID, and \[oq]99\[cq] 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. If you have snmpwalk\f[](1)\f[] 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.
"ENVIRONMENT"
See OPTION PRESETS for configuration environment variables.
"FILES"
See OPTION PRESETS for configuration files.
"EXIT STATUS"
One of the following exit values will be returned:

.NOP 0 " (EXIT_SUCCESS)" Successful program execution.

.NOP 1 " (EXIT_FAILURE)" The operation failed or the command syntax was not valid.

.NOP 66 " (EX_NOINPUT)" A specified configuration file could not be loaded.

.NOP 70 " (EX_SOFTWARE)" libopts had an internal operational error. Please report it to autogen-users@lists.sourceforge.net. Thank you.

AUTHORS
.NOP "Heiko Gerstung"

"COPYRIGHT"
Copyright (C) 1992-2015 The University of Delaware and Network Time Foundation all rights reserved. This program is released under the terms of the NTP license, <http://ntp.org/license>.
"BUGS"
Please send bug reports to: http://bugs.ntp.org, bugs@ntp.org
NOTES
The following objects are currently supported:

29 .NOP \f[C]ntpEntSoftwareName\f[] please fill me in...

.ns

29 .NOP \f[C]ntpEntSoftwareVersion\f[] please fill me in...

.ns

29 .NOP \f[C]ntpEntSoftwareVersionVal\f[] please fill me in...

.ns

29 .NOP \f[C]ntpEntSoftwareVendor\f[] please fill me in...

.ns

29 .NOP \f[C]ntpEntSystemType\f[] please fill me in...

.ns

29 .NOP \f[C]ntpEntTimeResolution\f[] please fill me in...

.ns

29 .NOP \f[C]ntpEntTimeResolutionVal\f[] please fill me in...

.ns

29 .NOP \f[C]ntpEntTimePrecision\f[] please fill me in...

.ns

29 .NOP \f[C]ntpEntTimePrecisionVal\f[] please fill me in...

.ns

29 .NOP \f[C]ntpEntTimeDistance\f[] please fill me in...

This manual page was AutoGen-erated from the ntpsnmpd option definitions.