NGINX: Upstream update to version 1.4.4
[tomato.git] / release / src / router / snmp / man / netsnmp_debug.3
blob3cec1e05851b44532f50fe29940c9be93af9462d
1 .TH "debug: print out debugging information about the handler chain being called." 3 "5 Sep 2003" "net-snmp" \" -*- nroff -*-
2 .ad l
3 .nh
4 .SH NAME
5 debug: print out debugging information about the handler chain being called. \- This is a useful module for run-time debugging of requests as the pass this handler in a calling chain. 
6 More...
7 .SS "handler"
9 .in +1c
10 .ti -1c
11 .RI "void \fBnetsnmp_init_debug_helper\fP (void)"
12 .br
13 .RI "\fIinitializes the debug helper which then registers a debug handler as a run-time injectable handler for configuration file use.\fP"
14 .ti -1c
15 .RI "void \fBnetsnmp_init_serialize\fP (void)"
16 .br
17 .RI "\fIinitializes the serialize helper which then registers a serialize handler as a run-time injectable handler for configuration file use.\fP"
18 .ti -1c
19 .RI "void \fBnetsnmp_init_read_only_helper\fP (void)"
20 .br
21 .RI "\fIinitializes the read_only helper which then registers a read_only handler as a run-time injectable handler for configuration file use.\fP"
22 .ti -1c
23 .RI "void \fBnetsnmp_init_bulk_to_next_helper\fP (void)"
24 .br
25 .RI "\fIinitializes the bulk_to_next helper which then registers a bulk_to_next handler as a run-time injectable handler for configuration file use.\fP"
26 .ti -1c
27 .RI "void \fBnetsnmp_init_helpers\fP (void)"
28 .br
29 .RI "\fIcall the initialization sequence for all handlers with init_ routines.\fP"
30 .in -1c
31 .SS "Functions"
33 .in +1c
34 .ti -1c
35 .RI "netsnmp_mib_handler * \fBnetsnmp_get_debug_handler\fP (void)"
36 .br
37 .RI "\fIreturns a debug handler that can be injected into a given handler chain.\fP"
38 .in -1c
39 .SH "DETAILED DESCRIPTION"
40 .PP 
41 This is a useful module for run-time debugging of requests as the pass this handler in a calling chain.
42 .PP
43 All debugging output is done via the standard debugging routines with a token name of 'helper:debug', so use the -Dhelper:debug command line flag to see the output when running the snmpd demon. It's not recommended you compile this into a handler chain during compile time, but instead use the 'injectHandler' token in the snmpd.conf file (or similar) to add it to the chain later:
44 .PP
45 injectHandler debug my_module_name
46 .PP
47 to see an example output, try:
48 .PP
49 injectHandler debug mibII/system
50 .PP
51 and then run snmpwalk on the 'system' group. 
52 .SH "FUNCTION DOCUMENTATION"
53 .PP 
54 .SS "netsnmp_mib_handler* netsnmp_get_debug_handler (void)"
55 .PP
56 returns a debug handler that can be injected into a given handler chain.
57 .PP
58 Definition at line 44 of file debug_handler.c.
59 .PP
60 References netsnmp_create_handler().
61 .PP
62 Referenced by netsnmp_init_debug_helper().
63 .SS "void netsnmp_init_bulk_to_next_helper (void)"
64 .PP
65 initializes the bulk_to_next helper which then registers a bulk_to_next handler as a run-time injectable handler for configuration file use.
66 .PP
67 Definition at line 95 of file bulk_to_next.c.
68 .PP
69 References netsnmp_get_bulk_to_next_handler(), and netsnmp_register_handler_by_name().
70 .PP
71 Referenced by netsnmp_init_helpers().
72 .SS "void netsnmp_init_debug_helper (void)"
73 .PP
74 initializes the debug helper which then registers a debug handler as a run-time injectable handler for configuration file use.
75 .PP
76 Definition at line 147 of file debug_handler.c.
77 .PP
78 References netsnmp_get_debug_handler(), and netsnmp_register_handler_by_name().
79 .PP
80 Referenced by netsnmp_init_helpers().
81 .SS "void netsnmp_init_helpers (void)"
82 .PP
83 call the initialization sequence for all handlers with init_ routines.
84 .PP
85 Definition at line 31 of file all_helpers.c.
86 .PP
87 References netsnmp_init_bulk_to_next_helper(), netsnmp_init_debug_helper(), netsnmp_init_read_only_helper(), and netsnmp_init_serialize().
88 .SS "void netsnmp_init_read_only_helper (void)"
89 .PP
90 initializes the read_only helper which then registers a read_only handler as a run-time injectable handler for configuration file use.
91 .PP
92 Definition at line 71 of file read_only.c.
93 .PP
94 References netsnmp_get_read_only_handler(), and netsnmp_register_handler_by_name().
95 .PP
96 Referenced by netsnmp_init_helpers().
97 .SS "void netsnmp_init_serialize (void)"
98 .PP
99 initializes the serialize helper which then registers a serialize handler as a run-time injectable handler for configuration file use.
101 Definition at line 96 of file serialize.c.
103 References netsnmp_get_serialize_handler(), and netsnmp_register_handler_by_name().
105 Referenced by netsnmp_init_helpers().