~ubuntu-branches/ubuntu/trusty/net-snmp/trusty

« back to all changes in this revision

Viewing changes to man/netsnmp_read_config.3

  • Committer: Bazaar Package Importer
  • Author(s): Steve Kowalik
  • Date: 2007-12-08 14:59:50 UTC
  • mfrom: (1.1.6 upstream)
  • Revision ID: james.westby@ubuntu.com-20071208145950-u1tykhpw56nyzqik
Tags: 5.4.1~dfsg-4ubuntu1
* Merge from debian unstable.
* Remaining Ubuntu changes:
  - Remove stop links from rc0 and rc6
  - Munge Maintainer field as per spec.
* Ubuntu changes dropped:
  - Symlink common files between the packages, CDBS ought to handle that
    for us automatically.
* The latest Debian changes has dropped history from the changelog. Slot in
  the Ubuntu changes as best I can. 

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.TH "parsing various configuration files at run time" 3 "13 Jul 2006" "Version 5.3.1" "net-snmp" \" -*- nroff -*-
 
1
.TH "parsing various configuration files at run time" 3 "27 Jul 2007" "Version 5.4.1" "net-snmp" \" -*- nroff -*-
2
2
.ad l
3
3
.nh
4
4
.SH NAME
22
22
.RI "\fBconfig_line\fP * \fBregister_app_prenetsnmp_mib_handler\fP (const char *token, void(*parser)(const char *, char *), void(*releaser)(void), const char *help)"
23
23
.br
24
24
.ti -1c
25
 
.RI "\fBconfig_line\fP * \fBregister_config_handler\fP (const char *type_param, const char *token, void(*parser)(const char *, char *), void(*releaser)(void), const char *help)"
 
25
.RI "\fBconfig_line\fP * \fBregister_config_handler\fP (const char *type, const char *token, void(*parser)(const char *, char *), void(*releaser)(void), const char *help)"
26
26
.br
27
27
.RI "\fIregister_config_handler registers handlers for certain tokens specified in certain types of files. \fP"
28
28
.ti -1c
253
253
.PP
254
254
 
255
255
.PP
256
 
Definition at line 1793 of file read_config.c.
 
256
Definition at line 1830 of file read_config.c.
257
257
.PP
258
258
References NULL, read_config_read_objid(), read_config_read_octet_string(), and skip_token().
259
259
.PP
262
262
.PP
263
263
read_config_store intended for use by applications to store permenant configuration information generated by sets or persistent counters. 
264
264
.PP
265
 
Appends line to a file named either ENV(SNMP_PERSISTENT_FILE) or '<PERSISTENT_DIRECTORY>/<type>.conf'. Adds a trailing newline to the stored file if necessary.
 
265
Appends line to a file named either ENV(SNMP_PERSISTENT_FILE) or '<NETSNMP_PERSISTENT_DIRECTORY>/<type>.conf'. Adds a trailing newline to the stored file if necessary.
266
266
.PP
267
267
\fBParameters:\fP
268
268
.RS 4
278
278
.PP
279
279
 
280
280
.PP
281
 
Definition at line 1229 of file read_config.c.
 
281
Definition at line 1266 of file read_config.c.
282
282
.PP
283
283
References get_persistent_directory(), netsnmp_ds_get_boolean(), netsnmp_getenv(), NULL, and snmp_log().
284
284
.PP
285
 
Referenced by netsnmp_oid_stash_store(), netsnmp_save_all_data(), and read_app_config_store().
 
285
Referenced by netsnmp_oid_stash_store(), netsnmp_save_all_data(), read_app_config_store(), and snmp_save_persistent().
286
286
.SS "char* read_config_store_data (int type, char * storeto, void * dataptr, size_t * len)"
287
287
.PP
288
288
read_config_store_data stores data of a given type to a configuration line into the storeto buffer. 
321
321
.PP
322
322
 
323
323
.PP
324
 
Definition at line 1932 of file read_config.c.
 
324
Definition at line 1989 of file read_config.c.
325
325
.PP
326
326
References read_config_store_data_prefix().
327
 
.SS "struct \fBconfig_line\fP* register_config_handler (const char * type_param, const char * token, void(*)(const char *, char *) parser, void(*)(void) releaser, const char * help)"
 
327
.SS "struct \fBconfig_line\fP* register_config_handler (const char * type, const char * token, void(*)(const char *, char *) parser, void(*)(void) releaser, const char * help)"
328
328
.PP
329
329
register_config_handler registers handlers for certain tokens specified in certain types of files. 
330
330
.PP
332
332
.PP
333
333
\fBParameters:\fP
334
334
.RS 4
335
 
\fItype_param\fP the configuration file used, e.g., if snmp.conf is the file where the token is located use 'snmp' here. If NULL the configuration file used will be snmpd.conf.
 
335
\fItype_param\fP the configuration file used, e.g., if snmp.conf is the file where the token is located use 'snmp' here. Multiple colon separated tokens might be used. If NULL or '' then the configuration file used will be <application>.conf.
336
336
.br
337
337
\fItoken\fP the token being parsed from the file. Must be non-NULL.
338
338
.br
350
350
.PP
351
351
 
352
352
.PP
353
 
Definition at line 196 of file read_config.c.
354
 
.PP
355
 
References config_files, netsnmp_ds_get_string(), NULL, and register_config_handler().
356
 
.PP
357
 
Referenced by netsnmp_ds_register_config(), netsnmp_register_save_list(), register_app_config_handler(), register_config_handler(), register_mib_handlers(), and register_prenetsnmp_mib_handler().
 
353
Definition at line 283 of file read_config.c.
 
354
.PP
 
355
Referenced by netsnmp_ds_register_config(), netsnmp_register_save_list(), register_app_config_handler(), and register_mib_handlers().
358
356
.SS "void unregister_config_handler (const char * type_param, const char * token)"
359
357
.PP
360
358
uregister_config_handler un-registers handlers given a specific type_param and token. 
373
371
.PP
374
372
 
375
373
.PP
376
 
Definition at line 301 of file read_config.c.
 
374
Definition at line 314 of file read_config.c.
377
375
.PP
378
376
References config_files, netsnmp_ds_get_string(), config_line::next, NULL, SNMP_FREE, and unregister_config_handler().
379
377
.PP