Invoking ntpsnmpd
=================

ntpsnmpd is an SNMP MIB agent designed to interface with ntpd(1ntpdmdoc).

This section was generated by AutoGen, using the agtexi-cmd template and the option descriptions for the ntpsnmpd program. This software is released under the NTP license, <http://ntp.org/license>.

ntpsnmpd help/usage (--help)
----------------------------

This is the automatically generated usage text for ntpsnmpd.

The text printed is the same whether selected with the help option (--help) or the more-help option (--more-help).  more-help will print the usage text by passing it through a pager program. more-help is disabled on platforms without a working fork(2) function.  The PAGER environment variable is used to select the program, defaulting to more.  Both will exit with a status code of 0.

     ntpsnmpd - NTP SNMP MIB agent - Ver. 4.2.8
     Usage:  ntpsnmpd [ -<flag> [<val>] | --<name>[{=| }<val>] ]...
       Flg Arg Option-Name    Description
        -n no  nofork         Do not fork
        -p no  syslog         Log to syslog()
           Str agentxsocket   The socket address ntpsnmpd uses to connect to net-snmpd
           opt version        output version information and exit
        -? no  help           display extended usage information and exit
        -! no  more-help      extended usage information passed thru pager
        -> opt save-opts      save the option state to a config file
        -< Str load-opts      load options from a config file
                                     - disabled as '--no-load-opts'
                                     - may appear multiple times

     Options are specified by doubled hyphens and their name or by a single
     hyphen and the flag character.

     The following option preset mechanisms are supported:
      - reading file $HOME/.ntprc
      - reading file ./.ntprc
      - examining environment variables named NTPSNMPD_*

     Please send bug reports to:  <http://bugs.ntp.org, bugs@ntp.org>

agentxsocket option
-------------------

This is the ``the socket address ntpsnmpd uses to connect to net-snmpd'' option. This option takes a string argument. [<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.

presetting/configuring ntpsnmpd
-------------------------------

Any option that is not marked as not presettable may be preset by loading values from configuration ("rc" or "ini") files, and values from environment variables named NTPSNMPD and NTPSNMPD_<OPTION_NAME>.  <OPTION_NAME> must be one of the options listed above in upper case and segmented with underscores. The NTPSNMPD variable will be tokenized and parsed like the command line.  The remaining variables are tested for existence and their values are treated like option arguments.

libopts will search in 2 places for configuration files:

  * $HOME

  * $PWD

The environment variables HOME, and PWD are expanded and replaced when ntpsnmpd runs. For any of these that are plain files, they are simply processed. For any that are directories, then a file named .ntprc is searched for within that directory and processed.

Configuration files may be in a wide variety of formats. The basic format is an option name followed by a value (argument) on the same line.  Values may be separated from the option name with a colon, equal sign or simply white space.  Values may be continued across multiple lines by escaping the newline with a backslash.

Multiple programs may also share the same initialization file. Common options are collected at the top, followed by program specific segments.  The segments are separated by lines like:

     [NTPSNMPD]

or by

     <?program ntpsnmpd>

Do not mix these styles within one configuration file.

Compound values and carefully constructed string values may also be specified using XML syntax:

     <option-name>
        <sub-opt>...&lt;...&gt;...</sub-opt>
     </option-name>

yielding an option-name.sub-opt string value of

     "...<...>..."

AutoOpts does not track suboptions.  You simply note that it is a hierarchicly valued option.  AutoOpts does provide a means for searching the associated name/value pair list (see: optionFindValue).

The command line options relating to configuration and/or usage help are:

version (-)
...........

Print the program version to standard out, optionally with licensing information, then exit 0.  The optional argument specifies how much licensing detail to provide.  The default is to print just the version.  The licensing infomation may be selected with an option argument. Only the first letter of the argument is examined:

version
     Only print the version.  This is the default.

copyright
     Name the copyright usage licensing terms.

verbose
     Print the full copyright usage licensing terms.

ntpsnmpd exit status
--------------------

One of the following exit values will be returned:

0 (EXIT_SUCCESS)
     Successful program execution.

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

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

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

ntpsnmpd Usage
--------------

ntpsnmpd Notes
--------------

ntpsnmpd Authors
----------------