1275970Scy@node ntpsnmpd Invocation 2275970Scy@section Invoking ntpsnmpd 3275970Scy@pindex ntpsnmpd 4275970Scy@cindex NTP SNMP MIB agent 5275970Scy@ignore 6275970Scy# 7275970Scy# EDIT THIS FILE WITH CAUTION (invoke-ntpsnmpd.texi) 8275970Scy# 9330567Sgordon# It has been AutoGen-ed February 27, 2018 at 05:15:36 PM by AutoGen 5.18.5 10275970Scy# From the definitions ntpsnmpd-opts.def 11275970Scy# and the template file agtexi-cmd.tpl 12275970Scy@end ignore 13275970Scy 14275970Scy 15275970Scy 16275970Scy@code{ntpsnmpd} 17275970Scyis an SNMP MIB agent designed to interface with 18275970Scy@code{ntpd(1ntpdmdoc)}. 19275970Scy 20275970ScyThis section was generated by @strong{AutoGen}, 21275970Scyusing the @code{agtexi-cmd} template and the option descriptions for the @code{ntpsnmpd} program. 22275970ScyThis software is released under the NTP license, <http://ntp.org/license>. 23275970Scy 24275970Scy@menu 25275970Scy* ntpsnmpd usage:: ntpsnmpd help/usage (@option{--help}) 26275970Scy* ntpsnmpd agentxsocket:: agentxsocket option 27275970Scy* ntpsnmpd config:: presetting/configuring ntpsnmpd 28275970Scy* ntpsnmpd exit status:: exit status 29275970Scy* ntpsnmpd Usage:: Usage 30275970Scy* ntpsnmpd Notes:: Notes 31275970Scy* ntpsnmpd Authors:: Authors 32275970Scy@end menu 33275970Scy 34275970Scy@node ntpsnmpd usage 35275970Scy@subsection ntpsnmpd help/usage (@option{--help}) 36275970Scy@cindex ntpsnmpd help 37275970Scy 38275970ScyThis is the automatically generated usage text for ntpsnmpd. 39275970Scy 40275970ScyThe text printed is the same whether selected with the @code{help} option 41275970Scy(@option{--help}) or the @code{more-help} option (@option{--more-help}). @code{more-help} will print 42275970Scythe usage text by passing it through a pager program. 43275970Scy@code{more-help} is disabled on platforms without a working 44275970Scy@code{fork(2)} function. The @code{PAGER} environment variable is 45275970Scyused to select the program, defaulting to @file{more}. Both will exit 46275970Scywith a status code of 0. 47275970Scy 48275970Scy@exampleindent 0 49275970Scy@example 50316722Sdelphijntpsnmpd - NTP SNMP MIB agent - Ver. 4.2.7p245 51316722SdelphijUSAGE: ntpsnmpd [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]... 52275970Scy Flg Arg Option-Name Description 53275970Scy -n no nofork Do not fork 54275970Scy -p no syslog Log to syslog() 55275970Scy Str agentxsocket The socket address ntpsnmpd uses to connect to net-snmpd 56316722Sdelphij opt version Output version information and exit 57316722Sdelphij -? no help Display extended usage information and exit 58316722Sdelphij -! no more-help Extended usage information passed thru pager 59316722Sdelphij -> opt save-opts Save the option state to a config file 60316722Sdelphij -< Str load-opts Load options from a config file 61316722Sdelphij - disabled as --no-load-opts 62275970Scy - may appear multiple times 63275970Scy 64275970ScyOptions are specified by doubled hyphens and their name or by a single 65275970Scyhyphen and the flag character. 66275970Scy 67275970Scy 68316722Sdelphij 69275970ScyThe following option preset mechanisms are supported: 70275970Scy - reading file $HOME/.ntprc 71275970Scy - reading file ./.ntprc 72275970Scy - examining environment variables named NTPSNMPD_* 73275970Scy 74316722Sdelphijplease send bug reports to: http://bugs.ntp.org, bugs@@ntp.org 75275970Scy@end example 76275970Scy@exampleindent 4 77275970Scy 78275970Scy@node ntpsnmpd agentxsocket 79275970Scy@subsection agentxsocket option 80275970Scy@cindex ntpsnmpd-agentxsocket 81275970Scy 82275970ScyThis is the ``the socket address ntpsnmpd uses to connect to net-snmpd'' option. 83275970ScyThis option takes a string argument. 84275970Scy[<transport-specifier>:]<transport-address> 85275970ScyThe default "agent X socket" is the Unix Domain socket 86275970Scy@file{unix:/var/agentx/master}. 87275970ScyAnother common alternative is @file{tcp:localhost:705}. 88275970Scy 89275970Scy 90275970Scy@node ntpsnmpd config 91275970Scy@subsection presetting/configuring ntpsnmpd 92275970Scy 93275970ScyAny option that is not marked as @i{not presettable} may be preset by 94275970Scyloading 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 95275970Scythe options listed above in upper case and segmented with underscores. 96275970ScyThe @code{NTPSNMPD} variable will be tokenized and parsed like 97275970Scythe command line. The remaining variables are tested for existence and their 98275970Scyvalues are treated like option arguments. 99275970Scy 100275970Scy 101275970Scy@noindent 102275970Scy@code{libopts} will search in 2 places for configuration files: 103275970Scy@itemize @bullet 104275970Scy@item 105275970Scy$HOME 106275970Scy@item 107275970Scy$PWD 108275970Scy@end itemize 109275970ScyThe environment variables @code{HOME}, and @code{PWD} 110275970Scyare expanded and replaced when @file{ntpsnmpd} runs. 111275970ScyFor any of these that are plain files, they are simply processed. 112275970ScyFor any that are directories, then a file named @file{.ntprc} is searched for 113275970Scywithin that directory and processed. 114275970Scy 115275970ScyConfiguration files may be in a wide variety of formats. 116275970ScyThe basic format is an option name followed by a value (argument) on the 117275970Scysame line. Values may be separated from the option name with a colon, 118275970Scyequal sign or simply white space. Values may be continued across multiple 119275970Scylines by escaping the newline with a backslash. 120275970Scy 121275970ScyMultiple programs may also share the same initialization file. 122275970ScyCommon options are collected at the top, followed by program specific 123275970Scysegments. The segments are separated by lines like: 124275970Scy@example 125275970Scy[NTPSNMPD] 126275970Scy@end example 127275970Scy@noindent 128275970Scyor by 129275970Scy@example 130275970Scy<?program ntpsnmpd> 131275970Scy@end example 132275970Scy@noindent 133275970ScyDo not mix these styles within one configuration file. 134275970Scy 135275970ScyCompound values and carefully constructed string values may also be 136275970Scyspecified using XML syntax: 137275970Scy@example 138275970Scy<option-name> 139275970Scy <sub-opt>...<...>...</sub-opt> 140275970Scy</option-name> 141275970Scy@end example 142275970Scy@noindent 143275970Scyyielding an @code{option-name.sub-opt} string value of 144275970Scy@example 145275970Scy"...<...>..." 146275970Scy@end example 147275970Scy@code{AutoOpts} does not track suboptions. You simply note that it is a 148275970Scyhierarchicly valued option. @code{AutoOpts} does provide a means for searching 149275970Scythe associated name/value pair list (see: optionFindValue). 150275970Scy 151275970ScyThe command line options relating to configuration and/or usage help are: 152275970Scy 153275970Scy@subsubheading version (-) 154275970Scy 155275970ScyPrint the program version to standard out, optionally with licensing 156275970Scyinformation, then exit 0. The optional argument specifies how much licensing 157275970Scydetail to provide. The default is to print just the version. The licensing infomation may be selected with an option argument. 158275970ScyOnly the first letter of the argument is examined: 159275970Scy 160275970Scy@table @samp 161275970Scy@item version 162275970ScyOnly print the version. This is the default. 163275970Scy@item copyright 164275970ScyName the copyright usage licensing terms. 165275970Scy@item verbose 166275970ScyPrint the full copyright usage licensing terms. 167275970Scy@end table 168275970Scy 169275970Scy@node ntpsnmpd exit status 170275970Scy@subsection ntpsnmpd exit status 171275970Scy 172275970ScyOne of the following exit values will be returned: 173275970Scy@table @samp 174275970Scy@item 0 (EXIT_SUCCESS) 175275970ScySuccessful program execution. 176275970Scy@item 1 (EXIT_FAILURE) 177275970ScyThe operation failed or the command syntax was not valid. 178275970Scy@item 66 (EX_NOINPUT) 179275970ScyA specified configuration file could not be loaded. 180275970Scy@item 70 (EX_SOFTWARE) 181275970Scylibopts had an internal operational error. Please report 182275970Scyit to autogen-users@@lists.sourceforge.net. Thank you. 183275970Scy@end table 184275970Scy@node ntpsnmpd Usage 185275970Scy@subsection ntpsnmpd Usage 186275970Scy@node ntpsnmpd Notes 187275970Scy@subsection ntpsnmpd Notes 188275970Scy@node ntpsnmpd Authors 189275970Scy@subsection ntpsnmpd Authors 190