Restructuring the repository layout in response to ath5k.
[madwifi/.git] / tools / man / athdebug.8
1 .TH "ATHDEBUG" "8" "February 2006" "" ""
2 .SH "NAME"
3 \fBathdebug\fP \- control the debug output from the madwifi device subsystem
4 .SH "SYNOPSIS"
5 .B athdebug
6 [-i device] +/\- bitmap
7 .SH "DESCRIPTION"
8 Set and clear debug bitmaps for the madwifi ath device subsystem. Each argument
9 is a bitmap or its alias. If a bitmap alias is used then it must be prefixed by 
10 either "-" to clear or "+" to set the corresponding bitmap.
11 .PP
12 All debugging output can be enabled with the 0xffffffff bitmap, while 0x0
13 disables all debug output.
14 .PP
15 .SH "OPTIONS"
16 .TP
17 .B \-?
18 Display usage and list all debug flags.
19 .TP
20 .B \-i device
21 The madwifi device to apply the settings to. If no interface is specified, 
22 \fBathdebug\fP defaults to wifi0.
23 .TP
24 .B +/\- bitmap
25 Set (+) or clear (-) a debug flag.
26 .PP
27 .SH "BITMAP ALIASES"
28 .BI xmit
29 \- transmit of packets, just before they go out to the HW
30 .br
31 .BI xmit_desc
32 \- transmit descriptors
33 .br
34 .BI recv
35 \- received packets, directly from the HW
36 .br
37 .BI recv_desc
38 \- recv descriptors
39 .br
40 .BI rate
41 \- rate control modules
42 .br
43 .BI reset
44 \- reset processing and inititalization
45 .br
46 .BI mode
47 \- mode initialization and changes
48 .br
49 .BI beacon
50 \- beacon handling
51 .br
52 .BI watchdog
53 \- watchdog timeout
54 .br
55 .BI intr
56 \- interrupt processing
57 .br
58 .BI xmit_proc
59 \- processing of transmit descriptors
60 .br
61 .BI recv_proc
62 \- processing of receive descriptors
63 .br
64 .BI beacon_proc
65 \- beacon processing
66 .br
67 .BI calibrate
68 \- periodic re-calibration
69 .br
70 .BI keycache
71 \- key cache management
72 .br
73 .BI state
74 \- 802.11 state transitions
75 .br
76 .BI node
77 \- node management
78 .BI ff
79 \- fast frame handling
80 .br
81 .BI fatal
82 fatal errors
83 .br
84 .PP
85 .SH "EXAMPLES"
86 .TP
87 .B athdebug \-i wifi1 0xffffffff
88 Enable all debug bitmaps on wifi1.
89 .TP
90 .B athdebug +rate
91 Enable rate debug bitmap on wifi0.
92 .TP
93 .B athdebug \-rate
94 Clear rate bitmap on wifi0.
95 .PP
96 .SH "SEE ALSO"
97 \fB80211debug\fP(8), \fBhttp://madwifi.org/wiki/DevDocs/AthDebug\fP
98 .SH "AUTHOR"
99 This manual page was written by Kel Modderman <kelrin@tpg.com.au> and was based
100 upon previous text written by Eric S. Raymond.