invoke-ntpsnmpd.texi revision 310419
1230491Sjimharris@node ntpsnmpd Invocation 2230491Sjimharris@section Invoking ntpsnmpd 3230491Sjimharris@pindex ntpsnmpd 4230491Sjimharris@cindex NTP SNMP MIB agent 5230491Sjimharris@ignore 6230491Sjimharris# 7230491Sjimharris# EDIT THIS FILE WITH CAUTION (invoke-ntpsnmpd.texi) 8230491Sjimharris# 9230491Sjimharris# It has been AutoGen-ed November 21, 2016 at 08:03:22 AM by AutoGen 5.18.5 10230491Sjimharris# From the definitions ntpsnmpd-opts.def 11230491Sjimharris# and the template file agtexi-cmd.tpl 12230491Sjimharris@end ignore 13230491Sjimharris 14230491Sjimharris 15230491Sjimharris 16230491Sjimharris@code{ntpsnmpd} 17230491Sjimharrisis an SNMP MIB agent designed to interface with 18230491Sjimharris@code{ntpd(1ntpdmdoc)}. 19230491Sjimharris 20230491SjimharrisThis section was generated by @strong{AutoGen}, 21230491Sjimharrisusing the @code{agtexi-cmd} template and the option descriptions for the @code{ntpsnmpd} program. 22230491SjimharrisThis software is released under the NTP license, <http://ntp.org/license>. 23230491Sjimharris 24230491Sjimharris@menu 25230491Sjimharris* ntpsnmpd usage:: ntpsnmpd help/usage (@option{--help}) 26230491Sjimharris* ntpsnmpd agentxsocket:: agentxsocket option 27230491Sjimharris* ntpsnmpd config:: presetting/configuring ntpsnmpd 28230491Sjimharris* ntpsnmpd exit status:: exit status 29230491Sjimharris* ntpsnmpd Usage:: Usage 30230491Sjimharris* ntpsnmpd Notes:: Notes 31230491Sjimharris* ntpsnmpd Authors:: Authors 32230491Sjimharris@end menu 33230491Sjimharris 34230491Sjimharris@node ntpsnmpd usage 35230491Sjimharris@subsection ntpsnmpd help/usage (@option{--help}) 36230491Sjimharris@cindex ntpsnmpd help 37230491Sjimharris 38230491SjimharrisThis is the automatically generated usage text for ntpsnmpd. 39230491Sjimharris 40230491SjimharrisThe text printed is the same whether selected with the @code{help} option 41230491Sjimharris(@option{--help}) or the @code{more-help} option (@option{--more-help}). @code{more-help} will print 42230491Sjimharristhe usage text by passing it through a pager program. 43230491Sjimharris@code{more-help} is disabled on platforms without a working 44230491Sjimharris@code{fork(2)} function. The @code{PAGER} environment variable is 45230491Sjimharrisused to select the program, defaulting to @file{more}. Both will exit 46230491Sjimharriswith a status code of 0. 47230491Sjimharris 48230491Sjimharris@exampleindent 0 49230491Sjimharris@example 50230491Sjimharrisntpsnmpd - NTP SNMP MIB agent - Ver. 4.2.8p9 51230491SjimharrisUsage: ntpsnmpd [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]... 52230491Sjimharris Flg Arg Option-Name Description 53230491Sjimharris -n no nofork Do not fork 54230491Sjimharris -p no syslog Log to syslog() 55232167Sbrueffer Str agentxsocket The socket address ntpsnmpd uses to connect to net-snmpd 56230491Sjimharris opt version output version information and exit 57230491Sjimharris -? no help display extended usage information and exit 58230491Sjimharris -! no more-help extended usage information passed thru pager 59230491Sjimharris -> opt save-opts save the option state to a config file 60231695Sjimharris -< Str load-opts load options from a config file 61230491Sjimharris - disabled as '--no-load-opts' 62230491Sjimharris - may appear multiple times 63230491Sjimharris 64230491SjimharrisOptions are specified by doubled hyphens and their name or by a single 65230491Sjimharrishyphen and the flag character. 66230491Sjimharris 67230491Sjimharris 68230491SjimharrisThe following option preset mechanisms are supported: 69230491Sjimharris - reading file $HOME/.ntprc 70230491Sjimharris - reading file ./.ntprc 71230491Sjimharris - examining environment variables named NTPSNMPD_* 72230491Sjimharris 73230491SjimharrisPlease send bug reports to: <http://bugs.ntp.org, bugs@@ntp.org> 74230491Sjimharris@end example 75230491Sjimharris@exampleindent 4 76230491Sjimharris 77230491Sjimharris@node ntpsnmpd agentxsocket 78230491Sjimharris@subsection agentxsocket option 79230491Sjimharris@cindex ntpsnmpd-agentxsocket 80231695Sjimharris 81231695SjimharrisThis is the ``the socket address ntpsnmpd uses to connect to net-snmpd'' option. 82231695SjimharrisThis option takes a string argument. 83231695Sjimharris[<transport-specifier>:]<transport-address> 84231695SjimharrisThe default "agent X socket" is the Unix Domain socket 85230491Sjimharris@file{unix:/var/agentx/master}. 86230491SjimharrisAnother common alternative is @file{tcp:localhost:705}. 87230491Sjimharris 88230491Sjimharris 89230491Sjimharris@node ntpsnmpd config 90230491Sjimharris@subsection presetting/configuring ntpsnmpd 91230491Sjimharris 92230491SjimharrisAny option that is not marked as @i{not presettable} may be preset by 93230491Sjimharrisloading 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 94230491Sjimharristhe options listed above in upper case and segmented with underscores. 95230491SjimharrisThe @code{NTPSNMPD} variable will be tokenized and parsed like 96231695Sjimharristhe command line. The remaining variables are tested for existence and their 97230491Sjimharrisvalues are treated like option arguments. 98230491Sjimharris 99230491Sjimharris 100230491Sjimharris@noindent 101235578Sgjb@code{libopts} will search in 2 places for configuration files: 102235578Sgjb@itemize @bullet 103230491Sjimharris@item 104230491Sjimharris$HOME 105230491Sjimharris@item 106230491Sjimharris$PWD 107230491Sjimharris@end itemize 108230491SjimharrisThe environment variables @code{HOME}, and @code{PWD} 109230491Sjimharrisare expanded and replaced when @file{ntpsnmpd} runs. 110230491SjimharrisFor any of these that are plain files, they are simply processed. 111230491SjimharrisFor any that are directories, then a file named @file{.ntprc} is searched for 112230491Sjimharriswithin that directory and processed. 113230491Sjimharris 114Configuration files may be in a wide variety of formats. 115The basic format is an option name followed by a value (argument) on the 116same line. Values may be separated from the option name with a colon, 117equal sign or simply white space. Values may be continued across multiple 118lines by escaping the newline with a backslash. 119 120Multiple programs may also share the same initialization file. 121Common options are collected at the top, followed by program specific 122segments. The segments are separated by lines like: 123@example 124[NTPSNMPD] 125@end example 126@noindent 127or by 128@example 129<?program ntpsnmpd> 130@end example 131@noindent 132Do not mix these styles within one configuration file. 133 134Compound values and carefully constructed string values may also be 135specified using XML syntax: 136@example 137<option-name> 138 <sub-opt>...<...>...</sub-opt> 139</option-name> 140@end example 141@noindent 142yielding an @code{option-name.sub-opt} string value of 143@example 144"...<...>..." 145@end example 146@code{AutoOpts} does not track suboptions. You simply note that it is a 147hierarchicly valued option. @code{AutoOpts} does provide a means for searching 148the associated name/value pair list (see: optionFindValue). 149 150The command line options relating to configuration and/or usage help are: 151 152@subsubheading version (-) 153 154Print the program version to standard out, optionally with licensing 155information, then exit 0. The optional argument specifies how much licensing 156detail to provide. The default is to print just the version. The licensing infomation may be selected with an option argument. 157Only the first letter of the argument is examined: 158 159@table @samp 160@item version 161Only print the version. This is the default. 162@item copyright 163Name the copyright usage licensing terms. 164@item verbose 165Print the full copyright usage licensing terms. 166@end table 167 168@node ntpsnmpd exit status 169@subsection ntpsnmpd exit status 170 171One of the following exit values will be returned: 172@table @samp 173@item 0 (EXIT_SUCCESS) 174Successful program execution. 175@item 1 (EXIT_FAILURE) 176The operation failed or the command syntax was not valid. 177@item 66 (EX_NOINPUT) 178A specified configuration file could not be loaded. 179@item 70 (EX_SOFTWARE) 180libopts had an internal operational error. Please report 181it to autogen-users@@lists.sourceforge.net. Thank you. 182@end table 183@node ntpsnmpd Usage 184@subsection ntpsnmpd Usage 185@node ntpsnmpd Notes 186@subsection ntpsnmpd Notes 187@node ntpsnmpd Authors 188@subsection ntpsnmpd Authors 189