Add some standard examples to the wireless driver manual pages and adjust
[dragonfly.git] / share / man / man4 / iwl.4
1 .\"
2 .\" Copyright (c) 2008
3 .\"     The DragonFly Project.  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 .\" 
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in
13 .\"    the documentation and/or other materials provided with the
14 .\"    distribution.
15 .\" 3. Neither the name of The DragonFly Project nor the names of its
16 .\"    contributors may be used to endorse or promote products derived
17 .\"    from this software without specific, prior written permission.
18 .\" 
19 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
23 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
24 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
25 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
29 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\" $DragonFly: src/share/man/man4/iwl.4,v 1.2 2008/07/26 15:09:32 swildner Exp $
33 .\"
34 .Dd July 26, 2008
35 .Os
36 .Dt IWL 4
37 .Sh NAME
38 .Nm iwl
39 .Nd Intel(R) PRO/Wireless 2100 IEEE 802.11 driver
40 .Sh SYNOPSIS
41 To compile this driver into the kernel,
42 place the following lines in your
43 kernel configuration file:
44 .Bd -ragged -offset indent
45 .Cd "device iwl"
46 .Ed
47 .Pp
48 Alternatively, to load the driver as a
49 module at boot time, place the following line in
50 .Xr loader.conf 5 :
51 .Bd -literal -offset indent
52 if_iwl_load="YES"
53 .Ed
54 .Sh DESCRIPTION
55 The
56 .Nm
57 driver provides support for the Intel(R) PRO/Wireless 2100 MiniPCI network
58 adapter.
59 .Pp
60 By default, the
61 .Nm
62 driver configures the adapter for BSS operation (aka infrastructure mode).
63 This mode requires the use of an access point.
64 .Pp
65 For more information on configuring this device, see
66 .Xr ifconfig 8 .
67 .Sh FILES
68 The firmware for the adapter is not shipped with
69 .Dx
70 and must be obtained separately.
71 An archive with firmware files that are known to work can be found at:
72 .Bd -literal -offset indent
73 http://ipw2100.sourceforge.net/firmware.php?fid=4
74 .Ed
75 .Pp
76 The firmware files have to reside in
77 .Pa /etc/firmware/iwl/2100/1.3
78 and will be loaded when the interface is brought up.
79 .Sh EXAMPLES
80 Join an existing BSS network (i.e., connect to an access point):
81 .Pp
82 .Dl "ifconfig iwl0 inet 192.168.0.20 netmask 0xffffff00"
83 .Pp
84 Join a specific BSS network with network name
85 .Dq Li my_net :
86 .Pp
87 .Dl "ifconfig iwl0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net"
88 .Pp
89 Join a specific BSS network with 64 bit WEP encryption:
90 .Bd -literal -offset indent
91 ifconfig iwl0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
92         wepmode on wepkey 0x1234567890 weptxkey 1
93 .Ed
94 .Pp
95 Join a specific BSS network with 128 bit WEP encryption:
96 .Bd -literal -offset indent
97 ifconfig iwl0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
98         wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
99 .Ed
100 .Pp
101 Join/create an 802.11b IBSS network:
102 .Bd -literal -offset indent
103 ifconfig iwl0 192.168.0.20 netmask 0xffffff00 ssid my_net \e
104         mediaopt adhoc
105 .Ed
106 .Pp
107 To debug a network setup, you may wish to enable interface debugging:
108 .Bd -literal -offset indent
109 ifconfig iwl0 down debug up
110 .Ed
111 .Pp
112 To disable debugging, you may simply use:
113 .Bd -literal -offset indent
114 ifconfig iwl0 down -debug up
115 .Ed
116 .\".Sh DIAGNOSTICS
117 .\".Bl -diag
118 .\".It "iwl%d: device timeout"
119 .\"The driver will reset the hardware. This should not happen.
120 .\".El
121 .Sh SEE ALSO
122 .Xr arp 4 ,
123 .Xr ifmedia 4 ,
124 .Xr pci 4 ,
125 .Xr wlan 4 ,
126 .Xr ifconfig 8 ,
127 .Xr wpa_supplicant 8
128 .Sh HISTORY
129 The
130 .Nm
131 first appeared in
132 .Dx 1.13 .
133 .Sh AUTHORS
134 The
135 .Nm
136 driver was written by
137 .An Sepherosa Ziehau .