contrib/ntp/ntpsnmpd/ntpsnmpd.1ntpsnmpdman

   1 .de1 NOP
   2 .  it 1 an-trap
   3 .  if \\n[.$] \,\\$*\/
   4 ..
   5 .ie t \
   6 .ds B-Font [CB]
   7 .ds I-Font [CI]
   8 .ds R-Font [CR]
   9 .el \
  10 .ds B-Font B
  11 .ds I-Font I
  12 .ds R-Font R
  13 .TH ntpsnmpd 1ntpsnmpdman "27 Feb 2018" "4.2.8p11" "User Commands"
  14 .\"
  15 .\" EDIT THIS FILE WITH CAUTION (/tmp/.ag-_Ia4FU/ag-lJaWEU)
  16 .\"
  17 .\" It has been AutoGen-ed February 27, 2018 at 05:15:33 PM by AutoGen 5.18.5
  18 .\" From the definitions ntpsnmpd-opts.def
  19 .\" and the template file agman-cmd.tpl
  20 .SH NAME
  21 \f\*[B-Font]ntpsnmpd\fP
  22 \- NTP SNMP MIB agent
  23 .SH SYNOPSIS
  24 \f\*[B-Font]ntpsnmpd\fP
  25 .\" Mixture of short (flag) options and long options
  26 [\f\*[B-Font]\-flags\f[]]
  27 [\f\*[B-Font]\-flag\f[] [\f\*[I-Font]value\f[]]]
  28 [\f\*[B-Font]\-\-option-name\f[][[=| ]\f\*[I-Font]value\f[]]]
  29 .sp \n(Ppu
  30 .ne 2
  31
  32 All arguments must be options.
  33 .sp \n(Ppu
  34 .ne 2
  35
  36 .SH DESCRIPTION
  37 \f\*[B-Font]ntpsnmpd\fP
  38 is an SNMP MIB agent designed to interface with
  39 \fCntpd\f[]\fR(1ntpdmdoc)\f[].
  40 .SH "OPTIONS"
  41 .TP
  42 .NOP \f\*[B-Font]\-n\f[], \f\*[B-Font]\-\-nofork\f[]
  43 Do not fork.
  44 .sp
  45 .TP
  46 .NOP \f\*[B-Font]\-p\f[], \f\*[B-Font]\-\-syslog\f[]
  47 Log to syslog().
  48 .sp
  49 .TP
  50 .NOP \f\*[B-Font]\-\-agentxsocket\f[]=\f\*[I-Font]string\f[]
  51 The socket address ntpsnmpd uses to connect to net-snmpd.
  52 The default
  53 \f\*[I-Font]string\f[]
  54 for this option is:
  55 .ti +4
  56  unix:/var/agentx/master
  57 .sp
  58 [<transport-specifier>:]<transport-address>
  59 The default "agent X socket" is the Unix Domain socket
  60 \fIunix:/var/agentx/master\fP.
  61 Another common alternative is \fItcp:localhost:705\fP.
  62 .TP
  63 .NOP \f\*[B-Font]\-\&?\f[], \f\*[B-Font]\-\-help\f[]
  64 Display usage information and exit.
  65 .TP
  66 .NOP \f\*[B-Font]\-\&!\f[], \f\*[B-Font]\-\-more-help\f[]
  67 Pass the extended usage information through a pager.
  68 .TP
  69 .NOP \f\*[B-Font]\->\f[] [\f\*[I-Font]cfgfile\f[]], \f\*[B-Font]\-\-save-opts\f[] [=\f\*[I-Font]cfgfile\f[]]
  70 Save the option state to \fIcfgfile\fP.  The default is the \fIlast\fP
  71 configuration file listed in the \fBOPTION PRESETS\fP section, below.
  72 The command will exit after updating the config file.
  73 .TP
  74 .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[]
  75 Load options from \fIcfgfile\fP.
  76 The \fIno-load-opts\fP form will disable the loading
  77 of earlier config/rc/ini files.  \fI\-\-no-load-opts\fP is handled early,
  78 out of order.
  79 .TP
  80 .NOP \f\*[B-Font]\-\-version\f[] [{\f\*[I-Font]v|c|n\f[]}]
  81 Output version of program and exit.  The default mode is `v', a simple
  82 version.  The `c' mode will print copyright information and `n' will
  83 print the full copyright notice.
  84 .PP
  85 .SH "OPTION PRESETS"
  86 Any option that is not marked as \fInot presettable\fP may be preset
  87 by loading values from configuration ("RC" or ".INI") file(s) and values from
  88 environment variables named:
  89 .nf
  90   \fBNTPSNMPD_<option-name>\fP or \fBNTPSNMPD\fP
  91 .fi
  92 .ad
  93 The environmental presets take precedence (are processed later than)
  94 the configuration files.
  95 The \fIhomerc\fP files are "\fI$HOME\fP", and "\fI.\fP".
  96 If any of these are directories, then the file \fI.ntprc\fP
  97 is searched for within those directories.
  98 .SH USAGE
  99 \f\*[B-Font]ntpsnmpd\fP
 100 currently uses a private MIB OID,
 101 \[oq]enterprises.5597\[cq],
 102 which is the Meinberg top level OEM OID, and
 103 \[oq]99\[cq]
 104 is the temporary working space for this project.
 105 The final OID has to be registered with IANA
 106 and this is done by the RFC Editor
 107 when the NTPv4 MIB RFC is standardized.
 108 .sp \n(Ppu
 109 .ne 2
 110
 111 If you have
 112 \fCsnmpwalk\f[]\fR(1)\f[]
 113 installed you can run
 114 .Dl % snmpwalk \-v2c \-c public localhost enterprises.5597.99
 115 to see a list of all currently supported NTP MIB objects
 116 and their current values.
 117 .SH "ENVIRONMENT"
 118 See \fBOPTION PRESETS\fP for configuration environment variables.
 119 .SH "FILES"
 120 See \fBOPTION PRESETS\fP for configuration files.
 121 .SH "EXIT STATUS"
 122 One of the following exit values will be returned:
 123 .TP
 124 .NOP 0 " (EXIT_SUCCESS)"
 125 Successful program execution.
 126 .TP
 127 .NOP 1 " (EXIT_FAILURE)"
 128 The operation failed or the command syntax was not valid.
 129 .TP
 130 .NOP 66 " (EX_NOINPUT)"
 131 A specified configuration file could not be loaded.
 132 .TP
 133 .NOP 70 " (EX_SOFTWARE)"
 134 libopts had an internal operational error.  Please report
 135 it to autogen-users@lists.sourceforge.net.  Thank you.
 136 .PP
 137 .SH AUTHORS
 138 .NOP  "Heiko Gerstung"
 139 .br
 140 .SH "COPYRIGHT"
 141 Copyright (C) 1992-2017 The University of Delaware and Network Time Foundation all rights reserved.
 142 This program is released under the terms of the NTP license, <http://ntp.org/license>.
 143 .SH "BUGS"
 144 Please send bug reports to: http://bugs.ntp.org, bugs@ntp.org
 145 .SH NOTES
 146 The following objects are currently supported:
 147 .sp \n(Ppu
 148 .ne 2
 149
 150 .TP 29
 151 .NOP \f[C]ntpEntSoftwareName\f[]
 152 please fill me in...
 153 .br
 154 .ns
 155 .TP 29
 156 .NOP \f[C]ntpEntSoftwareVersion\f[]
 157 please fill me in...
 158 .br
 159 .ns
 160 .TP 29
 161 .NOP \f[C]ntpEntSoftwareVersionVal\f[]
 162 please fill me in...
 163 .br
 164 .ns
 165 .TP 29
 166 .NOP \f[C]ntpEntSoftwareVendor\f[]
 167 please fill me in...
 168 .br
 169 .ns
 170 .TP 29
 171 .NOP \f[C]ntpEntSystemType\f[]
 172 please fill me in...
 173 .br
 174 .ns
 175 .TP 29
 176 .NOP \f[C]ntpEntTimeResolution\f[]
 177 please fill me in...
 178 .br
 179 .ns
 180 .TP 29
 181 .NOP \f[C]ntpEntTimeResolutionVal\f[]
 182 please fill me in...
 183 .br
 184 .ns
 185 .TP 29
 186 .NOP \f[C]ntpEntTimePrecision\f[]
 187 please fill me in...
 188 .br
 189 .ns
 190 .TP 29
 191 .NOP \f[C]ntpEntTimePrecisionVal\f[]
 192 please fill me in...
 193 .br
 194 .ns
 195 .TP 29
 196 .NOP \f[C]ntpEntTimeDistance\f[]
 197 please fill me in...
 198 .PP
 199 .sp \n(Ppu
 200 .ne 2
 201
 202 This manual page was \fIAutoGen\fP-erated from the \fBntpsnmpd\fP
 203 option definitions.