"Fossies" - the Fresh Open Source Software Archive 
Member "ntp-4.2.8p15/ntpsnmpd/invoke-ntpsnmpd.texi" (23 Jun 2020, 6620 Bytes) of package /linux/misc/ntp-4.2.8p15.tar.gz:
As a special service "Fossies" has tried to format the requested text file into HTML format (style:
standard) with prefixed line numbers.
Alternatively you can here
view or
download the uninterpreted source code file.
See also the latest
Fossies "Diffs" side-by-side code changes report for "invoke-ntpsnmpd.texi":
4.2.8p14_vs_4.2.8p15.
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 June 23, 2020 at 02:21:00 AM 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.8p13
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 The following option preset mechanisms are supported:
69 - reading file $HOME/.ntprc
70 - reading file ./.ntprc
71 - examining environment variables named NTPSNMPD_*
72
73 Please send bug reports to: <http://bugs.ntp.org, bugs@@ntp.org>
74 @end example
75 @exampleindent 4
76
77 @node ntpsnmpd agentxsocket
78 @subsection agentxsocket option
79 @cindex ntpsnmpd-agentxsocket
80
81 This is the ``the socket address ntpsnmpd uses to connect to net-snmpd'' option.
82 This option takes a string argument.
83 [<transport-specifier>:]<transport-address>
84 The default "agent X socket" is the Unix Domain socket
85 @file{unix:/var/agentx/master}.
86 Another common alternative is @file{tcp:localhost:705}.
87
88
89 @node ntpsnmpd config
90 @subsection presetting/configuring ntpsnmpd
91
92 Any option that is not marked as @i{not presettable} may be preset by
93 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
94 the options listed above in upper case and segmented with underscores.
95 The @code{NTPSNMPD} variable will be tokenized and parsed like
96 the command line. The remaining variables are tested for existence and their
97 values are treated like option arguments.
98
99
100 @noindent
101 @code{libopts} will search in 2 places for configuration files:
102 @itemize @bullet
103 @item
104 $HOME
105 @item
106 $PWD
107 @end itemize
108 The environment variables @code{HOME}, and @code{PWD}
109 are expanded and replaced when @file{ntpsnmpd} runs.
110 For any of these that are plain files, they are simply processed.
111 For any that are directories, then a file named @file{.ntprc} is searched for
112 within that directory and processed.
113
114 Configuration files may be in a wide variety of formats.
115 The basic format is an option name followed by a value (argument) on the
116 same line. Values may be separated from the option name with a colon,
117 equal sign or simply white space. Values may be continued across multiple
118 lines by escaping the newline with a backslash.
119
120 Multiple programs may also share the same initialization file.
121 Common options are collected at the top, followed by program specific
122 segments. The segments are separated by lines like:
123 @example
124 [NTPSNMPD]
125 @end example
126 @noindent
127 or by
128 @example
129 <?program ntpsnmpd>
130 @end example
131 @noindent
132 Do not mix these styles within one configuration file.
133
134 Compound values and carefully constructed string values may also be
135 specified using XML syntax:
136 @example
137 <option-name>
138 <sub-opt>...<...>...</sub-opt>
139 </option-name>
140 @end example
141 @noindent
142 yielding 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
147 hierarchicly valued option. @code{AutoOpts} does provide a means for searching
148 the associated name/value pair list (see: optionFindValue).
149
150 The command line options relating to configuration and/or usage help are:
151
152 @subsubheading version (-)
153
154 Print the program version to standard out, optionally with licensing
155 information, then exit 0. The optional argument specifies how much licensing
156 detail to provide. The default is to print just the version. The licensing infomation may be selected with an option argument.
157 Only the first letter of the argument is examined:
158
159 @table @samp
160 @item version
161 Only print the version. This is the default.
162 @item copyright
163 Name the copyright usage licensing terms.
164 @item verbose
165 Print the full copyright usage licensing terms.
166 @end table
167
168 @node ntpsnmpd exit status
169 @subsection ntpsnmpd exit status
170
171 One of the following exit values will be returned:
172 @table @samp
173 @item 0 (EXIT_SUCCESS)
174 Successful program execution.
175 @item 1 (EXIT_FAILURE)
176 The operation failed or the command syntax was not valid.
177 @item 66 (EX_NOINPUT)
178 A specified configuration file could not be loaded.
179 @item 70 (EX_SOFTWARE)
180 libopts had an internal operational error. Please report
181 it 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