usr.sbin/wlandebug/wlandebug.8

   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$
  26 .\"
  27 .Dd January 8, 2007
  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 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 When run as the super-user
  50 .Nm
  51 can be used to enable and/or disable debugging messages.
  52 .Pp
  53 To enable debugging messages of a certain
  54 .Ar type
  55 use
  56 .Ar +type ;
  57 to disable such messages use
  58 .Ar -type .
  59 Multiple messages can be enabled and disabled with a single command.
  60 .Pp
  61 Messages are organized in the following groups:
  62 .Bl -tag -width ".Ar dumppkts"
  63 .It Ar debug
  64 general debugging facilities; equivalent to setting the debug
  65 parameter with
  66 .Xr ifconfig 8 .
  67 .It Ar dumppkts
  68 dump packet contents on transmit and receive.
  69 .It Ar crypto
  70 crypto-related work.
  71 .It Ar input
  72 errors encountered during input handling.
  73 .It Ar xrate
  74 extended rate set handling (for 802.11g).
  75 .It Ar elemid
  76 information element processing in 802.11 management frames.
  77 .It Ar node
  78 management of per-station state.
  79 .It Ar assoc
  80 802.11 station association processing; particularly useful to
  81 see when stations join and leave a BSS.
  82 .It Ar auth
  83 802.11 station authentication processing.
  84 .It Ar scan
  85 scanning operation; especially useful for debugging problems
  86 with not locating an access point.
  87 .It Ar output
  88 errors encountered during output handling.
  89 .It Ar state
  90 .Xr wlan 4
  91 state machine operation.
  92 .It Ar power
  93 802.11 power save operation; in hostap mode this enables
  94 copious information about buffered frames for stations operating
  95 in power save mode.
  96 .It Ar dot1x
  97 802.1x operation; not presently meaningful as 802.1x protocol
  98 support is implemented in user mode by the
  99 .Xr hostapd 8
 100 program.
 101 .It Ar dot1xsm
 102 802.1x state machine operation; not presently meaningful as 802.1x protocol
 103 support is implemented in user mode by the
 104 .Xr hostapd 8
 105 program.
 106 .It Ar radius
 107 radius backend operation as it relates to 802.1x operation;
 108 not presently meaningful as 802.1x protocol
 109 support is implemented in user mode by the
 110 .Xr hostapd 8
 111 program.
 112 .It Ar raddump
 113 dump packets exchanged with the radius backend for 802.1x operation;
 114 not presently meaningful as 802.1x protocol
 115 support is implemented in user mode by the
 116 .Xr hostapd 8
 117 program.
 118 .It Ar radkeys
 119 include key contents when dumping packets exchanged with the
 120 radius backend for 802.1x operation;
 121 not presently meaningful as 802.1x protocol
 122 support is implemented in user mode by the
 123 .Xr hostapd 8
 124 program.
 125 .It Ar wpa
 126 trace operation of the WPA protocol;
 127 only partly meaningful as WPA protocol
 128 support is mostly implemented in user mode by the
 129 .Xr hostapd 8
 130 and
 131 .Xr wpa_supplicant 8
 132 programs.
 133 .It Ar acl
 134 trace operation of the Access Control List (ACL) support; see
 135 .Xr wlan_acl 4
 136 for more details.
 137 .It Ar wme
 138 trace operation of WME/WMM protocol processing.
 139 .It Ar superg
 140 trace operation of Atheros SuperG protocol processing.
 141 .It Ar doth
 142 trace operation of IEEE 802.11h protocol processing.
 143 .It Ar inact
 144 trace station inactivity processing; in particular,
 145 show when stations associated to an access point are dropped due to
 146 inactivity.
 147 .It Ar roam
 148 trace station mode roaming between access points.
 149 .It Ar rate
 150 trace transmit rate control operation.
 151 .El
 152 .Sh EXAMPLES
 153 The following might be used to debug basic station mode operation:
 154 .Pp
 155 .Dl "wlandebug -i ral0 scan+auth+assoc"
 156 .Pp
 157 it enables debug messages while scanning, authenticating to
 158 an access point, and associating to an access point.
 159 .Sh SEE ALSO
 160 .Xr ifconfig 8 ,
 161 .Xr wlanstats 8 ,
 162 .Xr athdebug 8 ,
 163 .Xr athstats 8 .
 164 .Sh NOTES
 165 Different wireless drivers support different debugging messages.
 166 Drivers such as
 167 .Xr ath 4
 168 and
 169 .Xr ral 4
 170 that depend on the
 171 .Xr wlan 4
 172 module for 802.11 protocol processing typically support
 173 most of the debugging messages while devices that
 174 implement parts of the 802.11 protocol in firmware do not.
 175 .Pp
 176 Some debugging messages are no longer meaningful
 177 because protocol processing has moved from the operating
 178 system to user mode programs such as
 179 .Xr hostapd 8
 180 and
 181 .Xr wpa_supplicant 8 .