Sync usage with man page.
[netbsd-mini2440.git] / share / man / man4 / ipw.4
blobe8053673fa7e648c7d33ce9d5ae27793e9c3ed53
1 .\" $NetBSD: ipw.4,v 1.4 2008/11/07 16:46:00 wiz Exp $
2 .\" Id: ipw.4,v 1.1.2.2 2004/08/19 16:25:41 damien Exp
3 .\"
4 .\" Copyright (c) 2004
5 .\"     Damien Bergamini <damien.bergamini@free.fr>. All rights reserved.
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\"    notice unmodified, this list of conditions, and the following
12 .\"    disclaimer.
13 .\" 2. Redistributions in binary form must reproduce the above copyright
14 .\"    notice, this list of conditions and the following disclaimer in the
15 .\"    documentation and/or other materials provided with the distribution.
16 .\"
17 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 .\" SUCH DAMAGE.
28 .\"
29 .Dd November 7, 2008
30 .Dt IPW 4
31 .Os
32 .Sh NAME
33 .Nm ipw
34 .Nd Intel PRO/Wireless 2100 IEEE 802.11 driver
35 .Sh SYNOPSIS
36 .Cd "ipw* at pci? dev ? function ?"
37 .Sh DESCRIPTION
38 The
39 .Nm
40 driver provides support for the Intel PRO/Wireless 2100 MiniPCI network
41 adapter.
42 .Pp
43 The Intel firmware requires acceptance of the End User License Agreement.
44 The full license text can be found in
45 /libdata/firmware/if_ipw/LICENSE.
46 The license is agreed to by setting the sysctl variable
47 .Dv hw.ipw.accept_eula
48 to 1.
49 .Pp
50 By default, the
51 .Nm
52 driver configures the adapter for BSS operation (aka infrastructure mode).
53 This mode requires the use of an access point.
54 .Pp
55 For more information on configuring this device, see
56 .Xr ifconfig 8 .
57 .Sh EXAMPLES
58 Join an existing BSS network (i.e.: connect to an access point):
59 .Pp
60 .Dl "ifconfig ipw0 inet 192.168.0.20 netmask 0xffffff00"
61 .Pp
62 Join a specific BSS network with network name
63 .Dq Li my_net :
64 .Pp
65 .Dl "ifconfig ipw0 inet 192.168.0.20 netmask 0xffffff00 nwid my_net"
66 .Pp
67 Join a specific BSS network with 64 bits WEP encryption:
68 .Bd -literal -offset indent
69 ifconfig ipw0 inet 192.168.0.20 netmask 0xffffff00 nwid my_net \e
70         nwkey 0x1234567890
71 .Ed
72 .Pp
73 Join a specific BSS network with 128bits WEP encryption:
74 .Bd -literal -offset indent
75 ifconfig ipw0 inet 192.168.0.20 netmask 0xffffff00 nwid my_net \e
76         nwkey 0x01020304050607080910111213
77 .Ed
78 .Sh DIAGNOSTICS
79 .Bl -diag
80 .It "ipw%d: device timeout"
81 The driver will reset the hardware.
82 This should not happen.
83 .El
84 .Sh SEE ALSO
85 .Xr an 4 ,
86 .Xr awi 4 ,
87 .Xr pci 4 ,
88 .Xr wi 4 ,
89 .Xr ifconfig 8 ,
90 .Xr ipwctl 8
91 .Rs
92 .%T The IPW Web Page
93 .%O http://damien.bergamini.free.fr/ipw/
94 .Re
95 .Sh AUTHORS
96 The
97 .Nm
98 driver and this man page were written by
99 .An Damien Bergamini Aq damien.bergamini@free.fr .