[Madwifi-cvs] revision 1449 committed by kelmo
Status: Beta
Brought to you by:
otaku
From: kelmo <svn...@ma...> - 2006-02-11 11:31:13
|
Project : madwifi Revision : 1449 Author : kelmo Date : 2006-02-11 12:30:50 +0100 (Sat, 11 Feb 2006) Log Message : Update debug manpages. Fix typo in athdebug.8. Signed-off-by: Kel Modderman <ke...@tp...> Affected Files: * trunk/tools/man/80211debug.8 updated * trunk/tools/man/80211stats.8 updated * trunk/tools/man/athdebug.8 updated Modified: trunk/tools/man/80211debug.8 =================================================================== --- trunk/tools/man/80211debug.8 2006-02-11 10:18:12 UTC (rev 1448) +++ trunk/tools/man/80211debug.8 2006-02-11 11:30:50 UTC (rev 1449) @@ -1,103 +1,120 @@ -.TH "80211DEBUG" "8" "October 2005" "" "" +.TH "80211DEBUG" "8" "February 2006" "" "" .SH "NAME" -\fB80211debug\fp \- toggle debug flags of the madwifi net80211 stack +\fB80211debug\fp \- control the debug output from the madwifi 802.11 stack +.SH "SYNOPSIS" +.B 80211debug +[-i device] +/\- bitmap .SH "DESCRIPTION" -Set and clear debug flags for the madwifi net80211 stack. Each argument is a -flag name prefixed by either "-" to clear or "+" to set the flag. +Set and clear debug bitmaps for the madwifi 802.11 stack. Each argument is a +bitmap (or alias) prefixed by either "-" to clear or "+" to set the bitmap. .PP .SH "OPTIONS" .TP .B \-? -Display usage and list all debug flags. +Display usage and list all debug bitmaps. .TP -.B \-i <interface> -The madwifi interface to apply the settings to. If no interface is specified, -it will default to ath0. +.B \-i device +The madwifi device to debug. If no interface is specified, \fB80211debug\fp +defaults to wifi0. .TP -.B \-/+ <flag> -Set (+) or clear (-) a debug flag. +.B \-/+ bitmap +Set (+) or clear (-) a bitmap. It's quite tedious to remember the bitmaps, +fortunately there is a user friendly interface which can be used to enable or +disable debugging output by giving the name of the component or subsystem. .PP -.SH "FLAGS" -.TP -.B debug -IFF_DEBUG equivalent -.TP -.B dumpkits -IFF_LINK2 equivalant -.TP -.B crypto -crypto work -.TP -.B input -input handling -.TP -.B xrate -rate set handling -.TP -.B elemid -element id parsing -.TP -.B node -node handling -.TP -.B assoc -association handling -.TP -.B auth -authentication handling -.TP -.B scan -scanning -.TP -.B output -output handling -.TP -.B state -state machine -.TP -.B power -power save handling -.TP -.B dot1x -802.1x authenticator -.TP -.B dot1xsm -802.1x state machine -.TP -.B radius -802.1x radius client -.TP -.B raddump -dump 802.1x radius packets -.TP -.B radkeys -dump 802.1x keys -.TP -.B wpa -WPA/RSN protocol -.TP -.B ac1 -ACL handling -.TP -.B wme -WME protocol -.TP -.B mlme -MLME handling +All debugging output can be enabled with the 0xffffffff bitmap, while 0x0 +disables all debug output. .PP +.SH "BITMAP ALIASES" +.BI debug +\- IFF_DEBUG equivalent +.br +.BI dumpkits +\- dump packets +.br +.BI crypto +\- crypto modules +.br +.BI input +\- packet input handling +.br +.BI xrate +\- rate set handling +.br +.BI elemid +\- element id parsing +.br +.BI node +\- node management +.br +.BI assoc +\- association handling +.br +.BI auth +\- authentication handling +.br +.BI scan +\- scanning +.br +.BI output +\- packet output handling +.br +.BI state +\- 802.11 state machine +.br +.BI power +\- power save functions +.br +.BI dot1x +\- 802.1x authenticator +.br +.BI dot1xsm +\- 802.1x state machine +.br +.BI radius +\- 802.1x radius client +.br +.BI raddump +\- 802.1x radius packet dump +.br +.BI radkeys +\- 802.1x key dump +.br +.BI wpa +\- WPA/RSN protocol +.br +.BI ac1 +\- ACL handling +.br +.BI wme +\- WME protocol +.br +.BI superg +\- super g turbo mode +.br +.BI doth +\- 802.11h (DFS/TPC) handling +.br +.BI inact +\- timeout of inactive nodes +.br +.BI roam +\- station mode roaming +.br +.PP .SH "EXAMPLES" .TP -.B 80211debug \-i ath1 +radkeys -Set radkeys debug flag on for the madwifi interface ath1. +.B 80211debug \-i wifi1 0xffffffff +Enable all debug bitmaps on wifi1. .TP -.B 80211debug +state -Set state debug flag on for the default madwifi interface ath0. +.B 80211debug +state +assoc +Set state and assoc bitmaps to on for wifi0. .TP .B 80211debug \-state -Clear state debug flag for the default madwifi interface ath0. +Disable state bitmap for wifi0. .PP .SH "SEE ALSO" -\fBathdebug\fP(8) +\fBathdebug\fP(8), \fBhttp://madwifi.org/wiki/DevDocs/AthDebug\fP .SH "AUTHOR" This manual page was written by Kel Modderman <ke...@tp...> and was based upon previous text written by Eric S. Raymond. Modified: trunk/tools/man/80211stats.8 =================================================================== --- trunk/tools/man/80211stats.8 2006-02-11 10:18:12 UTC (rev 1448) +++ trunk/tools/man/80211stats.8 2006-02-11 11:30:50 UTC (rev 1449) @@ -15,7 +15,7 @@ .SH "OPTIONS" .TP .B \-i device -The madwifi device to derive statistics for. If no device is specified, +The madwifi device to derive statistics for. If no device is specified, \fB80211stats\fp defaults to wifi0. .PP .SH "EXAMPLES" Modified: trunk/tools/man/athdebug.8 =================================================================== --- trunk/tools/man/athdebug.8 2006-02-11 10:18:12 UTC (rev 1448) +++ trunk/tools/man/athdebug.8 2006-02-11 11:30:50 UTC (rev 1449) @@ -1,91 +1,100 @@ -.TH "ATHDEBUG" "8" "October 2005" "" "" +.TH "ATHDEBUG" "8" "February 2006" "" "" .SH "NAME" -\fBathdebug\fp \- toggle debug flags of madwifi interfaces +\fBathdebug\fp \- control the debug output from the madwifi device subsystem +.SH "SYNOPSIS" +.B athdebug +[-i device] +/\- bitmap .SH "DESCRIPTION" -Set and clear debug flags for the madwifi interfaces. Each argument is a flag -name prefixed by either "-" to clear or "+" to set the flag. +Set and clear debug bitmaps for the madwifi ath device subsystem. Each argument +is a bitmap (or alias) prefixed by either "-" to clear or "+" to set the +bitmap. .PP +All debugging output can be enabled with the 0xffffffff bitmap, while 0x0 +disables all debug output. +.PP .SH "OPTIONS" .TP .B \-? Display usage and list all debug flags. .TP -.B \-i <interface> -The madwifi interface to apply the settings to. If no interface is specified, -it will default to ath0. +.B \-i device +The madwifi device to apply the settings to. If no interface is specified, +\fBathdebug\fp defaults to wifi0. .TP -.B \-/+ <flag> +.B \-/+ bitmap Set (+) or clear (-) a debug flag. .PP -.SH "FLAGS" -.TP -.B xmit -basic xmit operation -.TP -.B xmit_desc -xmit descriptors -.TP -.B recv -basic recv operation -.TP -.B recv_desc -recv descriptors -.TP -.B rate -rate control -.TP -.B reset -reset processing -.TP -.B mode -mode init/setup -.TP -.B beacon -beacon handling -.TP -.B watchdog -watchdog timeout -.TP -.B intr -ISR -.TP -.B xmit_proc -tx ISR proc -.TP -.B recv_proc -rx ISR proc -.TP -.B beacon_proc -beacon ISR proc -.TP -.B calibrate -periodic calibration -.TP -.B keycache -key cache management -.TP -.B state -802.11 state transitions -.TP -.B node -node management -.TP -.B fatal +.SH "BITMAP ALIASES" +.BI xmit +\- transmit of packets, just before they go out to the HW +.br +.BI xmit_desc +\- transmit descriptors +.br +.BI recv +\- received packets, directly from the HW +.br +.BI recv_desc +\- recv descriptors +.br +.BI rate +\- rate control modules +.br +.BI reset +\- reset processing and inititalization +.br +.BI mode +\- mode init and changes +.br +.BI beacon +\- beacon handling +.br +.BI watchdog +\- watchdog timeout +.br +.BI intr +\- interrupt processing +.br +.BI xmit_proc +\- processing of transmit descriptors +.br +.BI recv_proc +\- processing of receive descriptors +.br +.BI beacon_proc +\- beacon processing +.br +.BI calibrate +\- periodic re-calibration +.br +.BI keycache +\- key cache management +.br +.BI state +\- 802.11 state transitions +.br +.BI node +\- node management +.BI ff +\- fast frame handling +.br +.BI fatal fatal errors +,br .PP .SH "EXAMPLES" .TP -.B athdebug \-i ath1 +recv -Set recv debug flag on for the madwifi interface ath1. +.B athdebug \-i wifi1 0xffffffff +Enable all debug bitmaps on wifi1. .TP .B athdebug +rate -Set rate debug flag on for the default madwifi interface ath0. +Enable rate debug bitmap on wifi0. .TP .B athdebug \-rate -Clear rate debug flag for the default madwifi interface ath0. +Clear rate bitmap on wifi0. .PP .SH "SEE ALSO" -\fB80211debug\fP(8) +\fB80211debug\fP(8), \fBhttp://madwifi.org/wiki/DevDocs/AthDebug\fP .SH "AUTHOR" This manual page was written by Kel Modderman <ke...@tp...> and was based upon previous text written by Eric S. Raymond. |