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