iwi(4): Hook it into the build again and enable it everywhere else.
[dragonfly.git] / usr.sbin / 802_11 / wpa_supplicant / wpa_supplicant.8
CommitLineData
da211034
SZ
1.\" Copyright (c) 2005 Sam Leffler <sam@errno.com>
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.\"
8e61a47d
RP
25.\" $FreeBSD: head/usr.sbin/wpa/wpa_supplicant/wpa_supplicant.8 195644 2009-07-12 19:58:52Z sam $
26.\" $DragonFly$
da211034 27.\"
8e61a47d 28.Dd March 24, 2008
da211034
SZ
29.Dt WPA_SUPPLICANT 8
30.Os
31.Sh NAME
32.Nm wpa_supplicant
33.Nd "WPA/802.11i Supplicant for wireless network devices"
34.Sh SYNOPSIS
35.Nm
8e61a47d 36.Op Fl BdehLqsvw
da211034
SZ
37.Fl i Ar ifname
38.Fl c Ar config-file
da211034
SZ
39.Sh DESCRIPTION
40The
41.Nm
42utility
43is an implementation of the WPA Supplicant component,
44i.e., the part that runs in the client stations.
45It implements WPA key negotiation with a WPA Authenticator
46and EAP authentication with an Authentication Server.
47In addition,
48.Nm
49controls the roaming and IEEE 802.11
50authentication/association support of the
51.Xr wlan 4
52module and can be used to configure static WEP keys
53based on identified networks.
54.Pp
55The
56.Nm
57utility
58is designed to be a
59.Dq daemon
60program that runs in the
61background and acts as the backend component controlling
62the wireless connection.
63It supports separate frontend programs such as the
64text-based
65.Xr wpa_cli 8
66program.
67.Pp
68The following arguments must be specified on the command line:
69.Bl -tag -width indent
70.It Fl i Ar ifname
71Use the specified wireless interface.
72.It Fl c Ar config-file
73Use the settings in the specified configuration file when managing
74the wireless interface.
75See
76.Xr wpa_supplicant.conf 5
77for a description of the configuration file syntax and contents.
78.Pp
79Changes to the configuration file can be reloaded by sending a
80.Dv SIGHUP
81to the
82.Nm
83process or with the
84.Xr wpa_cli 8
85utility, using
86.Dq Li "wpa_cli reconfigure" .
87.El
88.Sh OPTIONS
89The following options are available:
90.Bl -tag -width indent
91.It Fl d
92Enable debugging messages.
93If this option is supplied twice, more verbose messages are displayed.
94.It Fl e
95Use an external IEEE 802.1X Supplicant program and disable the
96internal Supplicant.
97This option is not normally used.
98.It Fl h
99Show help text.
100.It Fl q
101Decrease debugging verbosity (i.e., counteract the use of the
102.Fl d
103flag).
8e61a47d
RP
104.It Fl s
105Send log messages through
106.Xr syslog 3
107instead of to the terminal.
da211034
SZ
108.It Fl v
109Display version information on the terminal and exit.
110.It Fl w
111If the specified interface is not present, wait for it to be
112added; e.g.\& a cardbus device to be inserted.
8e61a47d
RP
113This option is not normally used; instead,
114.Xr devd 8
115should be configured to launch
116.Nm
117when a device is created.
da211034
SZ
118.It Fl B
119Detach from the controlling terminal and run as a daemon process
120in the background.
121.It Fl K
122Include key information in debugging output.
123.It Fl L
124Display the license for this program on the terminal and exit.
da211034
SZ
125.El
126.Sh SEE ALSO
8e61a47d 127.Xr an 4 ,
a69e7202 128.Xr ath 4 ,
4097c65c 129.\".Xr ipw 4 ,
1d97534a 130.Xr iwi 4 ,
da211034 131.Xr ral 4 ,
4097c65c
SW
132.\".Xr rum 4 ,
133.\".Xr ural 4 ,
da211034
SZ
134.Xr wi 4 ,
135.Xr wlan 4 ,
7fa17bc6 136.Xr wpi 4 ,
4097c65c 137.\".Xr zyd 4 ,
da211034 138.Xr wpa_supplicant.conf 5 ,
8e61a47d 139.Xr devd 8 ,
e8f16c25
SW
140.Xr ifconfig 8 ,
141.Xr wpa_cli 8
da211034
SZ
142.Sh HISTORY
143The
144.Nm
145utility first appeared in
146.Fx 6.0 .
147.Sh AUTHORS
148The
149.Nm
150utility was written by
8e61a47d 151.An Jouni Malinen Aq j@w1.fi .
da211034
SZ
152This manual page is derived from the
153.Pa README
154file included in the
155.Nm
156distribution.