sbin/hammer: Move cache to tailq end when get_buffer_data() has a valid cache
[dragonfly.git] / usr.sbin / wlandebug / wlandebug.8
blob44811fb3a596104f9c9f5ff1cde85b41e4496c74
1 .\" Copyright (c) 2007 Sam Leffler, Errno Consulting
2 .\" All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\"
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23 .\" SUCH DAMAGE.
24 .\"
25 .\" $FreeBSD: src/usr.sbin/wlandebug/wlandebug.8,v 1.8 2009/07/17 21:11:08 sam Exp $
26 .\"
27 .Dd April 26, 2010
28 .Dt WLANDEBUG 8
29 .Os
30 .Sh NAME
31 .Nm wlandebug
32 .Nd "set/query 802.11 wireless debugging messages"
33 .Sh SYNOPSIS
34 .Nm
35 .Op Fl d | Fl i Ar ifnet
36 .Op Fl flag|+flag Ar ...
37 .Sh DESCRIPTION
38 The
39 .Nm
40 command is a tool for enabling and disabling
41 debugging messages in the
42 .Xr wlan 4
43 module.
44 Running
45 .Nm
46 without any options will display the current messages
47 enabled for the specified network interface
48 (by default, ``ath0').
49 The default debugging level for new interfaces can be set
50 by specifying the
51 .Fl d
52 option.
53 When run as the super-user
54 .Nm
55 can be used to enable and/or disable debugging messages.
56 .Pp
57 To enable debugging messages of a certain
58 .Ar type
59 use
60 .Ar +type ;
61 to disable such messages use
62 .Ar -type .
63 Multiple messages can be enabled and disabled with a single command.
64 .Pp
65 Messages are organized in the following groups:
66 .Bl -tag -width ".Ar dumppkts"
67 .It Ar debug
68 general debugging facilities; equivalent to setting the debug
69 parameter with
70 .Xr ifconfig 8 .
71 .It Ar dumppkts
72 dump packet contents on transmit and receive.
73 .It Ar crypto
74 crypto-related work.
75 .It Ar input
76 errors encountered during input handling.
77 .It Ar xrate
78 extended rate set handling (for 802.11g).
79 .It Ar elemid
80 information element processing in 802.11 management frames.
81 .It Ar node
82 management of per-station state.
83 .It Ar assoc
84 802.11 station association processing; particularly useful to
85 see when stations join and leave a BSS.
86 .It Ar auth
87 802.11 station authentication processing.
88 .It Ar scan
89 scanning operation; especially useful for debugging problems
90 with not locating an access point.
91 .It Ar output
92 errors encountered during output handling.
93 .It Ar state
94 .Xr wlan 4
95 state machine operation.
96 .It Ar power
97 802.11 power save operation; in hostap mode this enables
98 copious information about buffered frames for stations operating
99 in power save mode.
100 .It Ar hwmp
101 trace operation of Hybrid Wireless Mesh Protocol processing.
102 .It Ar dot1xsm
103 802.1x state machine operation; not presently meaningful as 802.1x protocol
104 support is implemented in user mode by the
105 .Xr hostapd 8
106 program.
107 .It Ar radius
108 radius backend operation as it relates to 802.1x operation;
109 not presently meaningful as 802.1x protocol
110 support is implemented in user mode by the
111 .Xr hostapd 8
112 program.
113 .It Ar raddump
114 dump packets exchanged with the radius backend for 802.1x operation;
115 not presently meaningful as 802.1x protocol
116 support is implemented in user mode by the
117 .Xr hostapd 8
118 program.
119 .It Ar mesh
120 trace operation of 802.11s mesh protocol processing.
121 .It Ar wpa
122 trace operation of the WPA protocol;
123 only partly meaningful as WPA protocol
124 support is mostly implemented in user mode by the
125 .Xr hostapd 8
127 .Xr wpa_supplicant 8
128 programs.
129 .It Ar acl
130 trace operation of the Access Control List (ACL) support; see
131 .Xr wlan_acl 4
132 for more details.
133 .It Ar wme
134 trace operation of WME/WMM protocol processing.
135 .It Ar superg
136 trace operation of Atheros SuperG protocol processing.
137 .It Ar doth
138 trace operation of IEEE 802.11h protocol processing.
139 .It Ar inact
140 trace station inactivity processing; in particular,
141 show when stations associated to an access point are dropped due to
142 inactivity.
143 .It Ar roam
144 trace station mode roaming between access points.
145 .It Ar rate
146 trace transmit rate control operation.
148 .Sh EXAMPLES
149 The following might be used to debug basic station mode operation:
151 .Dl "wlandebug -i ral0 scan+auth+assoc"
153 it enables debug messages while scanning, authenticating to
154 an access point, and associating to an access point.
155 .Sh SEE ALSO
156 .Xr ifconfig 8
157 .Sh NOTES
158 Different wireless drivers support different debugging messages.
159 Drivers such as
160 .Xr ath 4
162 .Xr ral 4
163 that depend on the
164 .Xr wlan 4
165 module for 802.11 protocol processing typically support
166 most of the debugging messages while devices that
167 implement parts of the 802.11 protocol in firmware do not.
169 For some more
170 .Xr wlan 4
171 related debugging tools, see the
172 .Pa /usr/src/tools/tools/net80211
174 .Pa /usr/src/tools/tools/ath
175 directories, with the latter being specific to
176 .Xr ath 4 .
178 Some debugging messages are no longer meaningful
179 because protocol processing has moved from the operating
180 system to user mode programs such as
181 .Xr hostapd 8
183 .Xr wpa_supplicant 8 .