Fix some groff warnings.
[dragonfly.git] / usr.sbin / iwicontrol / iwicontrol.8
1 .\"
2 .\" Copyright (c) 2004, 2005
3 .\"     Damien Bergamini <damien.bergamini@free.fr>.
4 .\"     Andrew Atrens <atrens@nortelnetworks.com>.
5 .\"
6 .\" All rights reserved.
7 .\"
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that the following conditions
10 .\" are met:
11 .\" 1. Redistributions of source code must retain the above copyright
12 .\"    notice unmodified, this list of conditions, and the following
13 .\"    disclaimer.
14 .\" 2. Redistributions in binary form must reproduce the above copyright
15 .\"    notice, this list of conditions and the following disclaimer in the
16 .\"    documentation and/or other materials provided with the distribution.
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" SUCH DAMAGE.
29 .\"
30 .\" $DragonFly: src/usr.sbin/iwicontrol/iwicontrol.8,v 1.2 2005/03/08 20:29:55 swildner Exp $
31 .\"
32 .Dd September 26, 2004
33 .Os
34 .Dt IWICONTROL 8
35 .Sh NAME
36 .Nm iwicontrol
37 .Nd configure Intel(R) PRO/Wireless 2200BG/2915ABG network adapters
38 .Sh SYNOPSIS
39 .Nm
40 .Op Fl i
41 .Ar iface
42 .Nm
43 .Op Fl i
44 .Ar iface Fl d Ar directory
45 .Op Fl m Ar bss|ibss
46 .Nm
47 .Op Fl i
48 .Ar iface Fl k
49 (kill firmware)
50 .Nm
51 .Op Fl i
52 .Ar iface Fl r
53 (display radio transmitter state)
54 .Nm
55 .Op Fl i
56 .Ar iface Fl D
57 (dump firmware event and error logs)
58 .Sh DESCRIPTION
59 The
60 .Nm
61 utility controls the operation of Intel(R) PRO/Wireless 2200BG/2915ABG
62 networking devices via
63 .Xr iwi 4
64 driver.
65 .Pp
66 You should not use this program to configure IEEE 802.11 parameters. Use
67 .Xr ifconfig 8
68 instead.
69 .Sh OPTIONS
70 The options are as follows:
71 .Bl -tag -width indent
72 .It Oo Fl i Oc Ar iface
73 Displays adapter's internal statistics.
74 .It Oo Fl i Oc Ar iface Fl d Ar directory Oo Fl m Ar bss|ibss Oc
75 Download firmware binary image to the adapter. The image is read from the
76 .Ar directory
77 directory. By default, the firmware binary image for BSS (aka infrastructure
78 mode) mode is downloaded unless the
79 .Fl m
80 flag is given.
81 .It Oo Fl i Oc Ar iface Fl k
82 Kill the firmware and reset the adapter.
83 .It Oo Fl i Oc Ar iface Fl r
84 Displays the radio transmitter state (on or off).
85 .It Oo Fl i Oc Ar iface Fl D
86 Dumps the contents of the firmware event and error logs. Information is
87 mostly in hexadecimal form and as such isn't overly useful (yet).
88 .El
89 .Sh SEE ALSO
90 .Xr iwi 4 ,
91 .Xr ifconfig 8
92 .Sh AUTHORS
93 The
94 .Nm
95 utility and this man page were written by
96 .An Damien Bergamini Aq damien.bergamini@free.fr .
97 .Pp
98 The not-so-useful-yet
99 .Fl D
100 option and its write up were added by 
101 .An Andrew Atrens Aq atrens@nortelnetworks.com .