contrib/ntp/ntpsnmpd/invoke-ntpsnmpd.texi

   1 @node ntpsnmpd Invocation
   2 @section Invoking ntpsnmpd
   3 @pindex ntpsnmpd
   4 @cindex NTP SNMP MIB agent
   5 @ignore
   6 #
   7 # EDIT THIS FILE WITH CAUTION  (invoke-ntpsnmpd.texi)
   8 #
   9 # It has been AutoGen-ed  February 27, 2018 at 05:15:36 PM by AutoGen 5.18.5
  10 # From the definitions    ntpsnmpd-opts.def
  11 # and the template file   agtexi-cmd.tpl
  12 @end ignore
  13
  14
  15
  16 @code{ntpsnmpd}
  17 is an SNMP MIB agent designed to interface with
  18 @code{ntpd(1ntpdmdoc)}.
  19
  20 This section was generated by @strong{AutoGen},
  21 using the @code{agtexi-cmd} template and the option descriptions for the @code{ntpsnmpd} program.
  22 This software is released under the NTP license, <http://ntp.org/license>.
  23
  24 @menu
  25 * ntpsnmpd usage::                  ntpsnmpd help/usage (@option{--help})
  26 * ntpsnmpd agentxsocket::           agentxsocket option
  27 * ntpsnmpd config::                 presetting/configuring ntpsnmpd
  28 * ntpsnmpd exit status::            exit status
  29 * ntpsnmpd Usage::                  Usage
  30 * ntpsnmpd Notes::                  Notes
  31 * ntpsnmpd Authors::                Authors
  32 @end menu
  33
  34 @node ntpsnmpd usage
  35 @subsection ntpsnmpd help/usage (@option{--help})
  36 @cindex ntpsnmpd help
  37
  38 This is the automatically generated usage text for ntpsnmpd.
  39
  40 The text printed is the same whether selected with the @code{help} option
  41 (@option{--help}) or the @code{more-help} option (@option{--more-help}).  @code{more-help} will print
  42 the usage text by passing it through a pager program.
  43 @code{more-help} is disabled on platforms without a working
  44 @code{fork(2)} function.  The @code{PAGER} environment variable is
  45 used to select the program, defaulting to @file{more}.  Both will exit
  46 with a status code of 0.
  47
  48 @exampleindent 0
  49 @example
  50 ntpsnmpd - NTP SNMP MIB agent - Ver. 4.2.7p245
  51 USAGE:  ntpsnmpd [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]...
  52   Flg Arg Option-Name    Description
  53    -n no  nofork         Do not fork
  54    -p no  syslog         Log to syslog()
  55       Str agentxsocket   The socket address ntpsnmpd uses to connect to net-snmpd
  56       opt version        Output version information and exit
  57    -? no  help           Display extended usage information and exit
  58    -! no  more-help      Extended usage information passed thru pager
  59    -> opt save-opts      Save the option state to a config file
  60    -< Str load-opts      Load options from a config file
  61                                 - disabled as --no-load-opts
  62                                 - may appear multiple times
  63
  64 Options are specified by doubled hyphens and their name or by a single
  65 hyphen and the flag character.
  66
  67
  68
  69 The following option preset mechanisms are supported:
  70  - reading file $HOME/.ntprc
  71  - reading file ./.ntprc
  72  - examining environment variables named NTPSNMPD_*
  73
  74 please send bug reports to:  http://bugs.ntp.org, bugs@@ntp.org
  75 @end example
  76 @exampleindent 4
  77
  78 @node ntpsnmpd agentxsocket
  79 @subsection agentxsocket option
  80 @cindex ntpsnmpd-agentxsocket
  81
  82 This is the ``the socket address ntpsnmpd uses to connect to net-snmpd'' option.
  83 This option takes a string argument.
  84 [<transport-specifier>:]<transport-address>
  85 The default "agent X socket" is the Unix Domain socket
  86 @file{unix:/var/agentx/master}.
  87 Another common alternative is @file{tcp:localhost:705}.
  88
  89
  90 @node ntpsnmpd config
  91 @subsection presetting/configuring ntpsnmpd
  92
  93 Any option that is not marked as @i{not presettable} may be preset by
  94 loading values from configuration ("rc" or "ini") files, and values from environment variables named @code{NTPSNMPD} and @code{NTPSNMPD_<OPTION_NAME>}.  @code{<OPTION_NAME>} must be one of
  95 the options listed above in upper case and segmented with underscores.
  96 The @code{NTPSNMPD} variable will be tokenized and parsed like
  97 the command line.  The remaining variables are tested for existence and their
  98 values are treated like option arguments.
  99
 100
 101 @noindent
 102 @code{libopts} will search in 2 places for configuration files:
 103 @itemize @bullet
 104 @item
 105 $HOME
 106 @item
 107 $PWD
 108 @end itemize
 109 The environment variables @code{HOME}, and @code{PWD}
 110 are expanded and replaced when @file{ntpsnmpd} runs.
 111 For any of these that are plain files, they are simply processed.
 112 For any that are directories, then a file named @file{.ntprc} is searched for
 113 within that directory and processed.
 114
 115 Configuration files may be in a wide variety of formats.
 116 The basic format is an option name followed by a value (argument) on the
 117 same line.  Values may be separated from the option name with a colon,
 118 equal sign or simply white space.  Values may be continued across multiple
 119 lines by escaping the newline with a backslash.
 120
 121 Multiple programs may also share the same initialization file.
 122 Common options are collected at the top, followed by program specific
 123 segments.  The segments are separated by lines like:
 124 @example
 125 [NTPSNMPD]
 126 @end example
 127 @noindent
 128 or by
 129 @example
 130 <?program ntpsnmpd>
 131 @end example
 132 @noindent
 133 Do not mix these styles within one configuration file.
 134
 135 Compound values and carefully constructed string values may also be
 136 specified using XML syntax:
 137 @example
 138 <option-name>
 139    <sub-opt>...&lt;...&gt;...</sub-opt>
 140 </option-name>
 141 @end example
 142 @noindent
 143 yielding an @code{option-name.sub-opt} string value of
 144 @example
 145 "...<...>..."
 146 @end example
 147 @code{AutoOpts} does not track suboptions.  You simply note that it is a
 148 hierarchicly valued option.  @code{AutoOpts} does provide a means for searching
 149 the associated name/value pair list (see: optionFindValue).
 150
 151 The command line options relating to configuration and/or usage help are:
 152
 153 @subsubheading version (-)
 154
 155 Print the program version to standard out, optionally with licensing
 156 information, then exit 0.  The optional argument specifies how much licensing
 157 detail to provide.  The default is to print just the version.  The licensing infomation may be selected with an option argument.
 158 Only the first letter of the argument is examined:
 159
 160 @table @samp
 161 @item version
 162 Only print the version.  This is the default.
 163 @item copyright
 164 Name the copyright usage licensing terms.
 165 @item verbose
 166 Print the full copyright usage licensing terms.
 167 @end table
 168
 169 @node ntpsnmpd exit status
 170 @subsection ntpsnmpd exit status
 171
 172 One of the following exit values will be returned:
 173 @table @samp
 174 @item 0 (EXIT_SUCCESS)
 175 Successful program execution.
 176 @item 1 (EXIT_FAILURE)
 177 The operation failed or the command syntax was not valid.
 178 @item 66 (EX_NOINPUT)
 179 A specified configuration file could not be loaded.
 180 @item 70 (EX_SOFTWARE)
 181 libopts had an internal operational error.  Please report
 182 it to autogen-users@@lists.sourceforge.net.  Thank you.
 183 @end table
 184 @node ntpsnmpd Usage
 185 @subsection ntpsnmpd Usage
 186 @node ntpsnmpd Notes
 187 @subsection ntpsnmpd Notes
 188 @node ntpsnmpd Authors
 189 @subsection ntpsnmpd Authors