Sync our ieee80211*(9) manual pages with FreeBSD.
[dragonfly.git] / share / man / man9 / ieee80211_ddb.9
1 .\"
2 .\" Copyright (c) 2009 Sam Leffler, Errno Consulting
3 .\" All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\"    notice, this list of conditions and the following disclaimer in the
12 .\"    documentation and/or other materials provided with the distribution.
13 .\"
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 .\" SUCH DAMAGE.
25 .\"
26 .\" $FreeBSD: src/share/man/man9/ieee80211_ddb.9,v 1.2 2009/09/18 00:33:47 brueffer Exp $
27 .\"
28 .Dd April 28, 2010
29 .Dt IEEE80211_DDB 9
30 .Os
31 .Sh NAME
32 .Nm ieee80211_ddb
33 .Nd 802.11 ddb support
34 .Sh SYNOPSIS
35 .Bd -ragged
36 .Cd options DDB
37 .Ed
38 .Pp
39 .Bd -ragged
40 .Cd show vap [addr]
41 .Cd show all vaps
42 .Cd show com [addr]
43 .Cd show sta [addr]
44 .Cd show statab [addr]
45 .Cd show mesh [addr]
46 .Ed
47 .Sh DESCRIPTION
48 The
49 .Nm net80211
50 layer includes
51 .Xr ddb 4
52 support for displaying important data structures.
53 This is especially important because wireless applications are often
54 built for embedded environments where cross-machine or post-mortem
55 debugging facilities like
56 .Xr kgdb 1
57 are infeasible.
58 .Pp
59 The most commonly used command is
60 .Bd -literal -offset indent
61 show all vaps/a
62 .Ed
63 .Pp
64 which dumps the contents of all
65 .Vt ieee80211vap ,
66 .Vt ieee80211com ,
67 and
68 .Vt ieee80211_node
69 data structures in the system.
70 .Sh SEE ALSO
71 .Xr ddb 4 ,
72 .Xr ieee80211 9