missing ','
[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.\"
25.\" $FreeBSD: src/usr.sbin/wpa/wpa_supplicant/wpa_supplicant.8,v 1.2 2005/06/27 06:40:43 ru Exp $
e51785a7 26.\" $DragonFly: src/usr.sbin/802_11/wpa_supplicant/wpa_supplicant.8,v 1.3 2006/07/07 16:12:45 sephe Exp $
da211034
SZ
27.\"
28.Dd June 24, 2006
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
36.Op Fl BdehLqvw
37.Fl i Ar ifname
38.Fl c Ar config-file
39.Op Fl N i Ar ifname Fl c Ar config-file ...
40.Sh DESCRIPTION
41The
42.Nm
43utility
44is an implementation of the WPA Supplicant component,
45i.e., the part that runs in the client stations.
46It implements WPA key negotiation with a WPA Authenticator
47and EAP authentication with an Authentication Server.
48In addition,
49.Nm
50controls the roaming and IEEE 802.11
51authentication/association support of the
52.Xr wlan 4
53module and can be used to configure static WEP keys
54based on identified networks.
55.Pp
56The
57.Nm
58utility
59is designed to be a
60.Dq daemon
61program that runs in the
62background and acts as the backend component controlling
63the wireless connection.
64It supports separate frontend programs such as the
65text-based
66.Xr wpa_cli 8
67program.
68.Pp
69The following arguments must be specified on the command line:
70.Bl -tag -width indent
71.It Fl i Ar ifname
72Use the specified wireless interface.
73.It Fl c Ar config-file
74Use the settings in the specified configuration file when managing
75the wireless interface.
76See
77.Xr wpa_supplicant.conf 5
78for a description of the configuration file syntax and contents.
79.Pp
80Changes to the configuration file can be reloaded by sending a
81.Dv SIGHUP
82to the
83.Nm
84process or with the
85.Xr wpa_cli 8
86utility, using
87.Dq Li "wpa_cli reconfigure" .
88.El
89.Sh OPTIONS
90The following options are available:
91.Bl -tag -width indent
92.It Fl d
93Enable debugging messages.
94If this option is supplied twice, more verbose messages are displayed.
95.It Fl e
96Use an external IEEE 802.1X Supplicant program and disable the
97internal Supplicant.
98This option is not normally used.
99.It Fl h
100Show help text.
101.It Fl q
102Decrease debugging verbosity (i.e., counteract the use of the
103.Fl d
104flag).
105.It Fl v
106Display version information on the terminal and exit.
107.It Fl w
108If the specified interface is not present, wait for it to be
109added; e.g.\& a cardbus device to be inserted.
a26669de 110This option is not normally used.
da211034
SZ
111.It Fl B
112Detach from the controlling terminal and run as a daemon process
113in the background.
114.It Fl K
115Include key information in debugging output.
116.It Fl L
117Display the license for this program on the terminal and exit.
118.It Fl N i Ar ifname Fl c Ar config-file ...
119Specify an additional interface and configuration file.
120If multiple interfaces are specified then
121.Nm
122will manage them all with a single process.
123.El
124.Sh SEE ALSO
125.Xr ipw 4 ,
126.Xr iwi 4 ,
127.Xr ral 4 ,
128.Xr wi 4 ,
129.Xr wlan 4 ,
e51785a7 130.Xr wpa_cli 8 ,
da211034
SZ
131.Xr wpa_supplicant.conf 5 ,
132.Xr ifconfig 8
133.Sh HISTORY
134The
135.Nm
136utility first appeared in
137.Fx 6.0 .
138.Sh AUTHORS
139The
140.Nm
141utility was written by
142.An Jouni Malinen Aq jkmaline@cc.hut.fi .
143This manual page is derived from the
144.Pa README
145file included in the
146.Nm
147distribution.