1.\" $NetBSD: wpa_supplicant.8,v 1.1 2010/08/04 17:12:34 christos Exp $
2.\"
3.\" Copyright (c) 2005 Sam Leffler <sam@errno.com>
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
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 the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25.\" SUCH DAMAGE.
26.\"
27.\" Based on:
28.\" $FreeBSD: /repoman/r/ncvs/src/usr.sbin/wpa/wpa_supplicant/wpa_supplicant.8,v 1.2 2005/06/27 06:40:43 ru Exp $
29.\"
30.Dd January 22, 2010
31.Dt WPA_SUPPLICANT 8
32.Os
33.Sh NAME
34.Nm wpa_supplicant
35.Nd WPA/802.11i Supplicant for wireless network devices
36.Sh SYNOPSIS
37.Nm
38.Op Fl BdehLqvw
39.Op Fl f Ar debug-file
40.Fl i Ar ifname
41.Fl c Ar config-file
42.Op Fl N i Ar ifname Fl c Ar config-file ...
43.Sh DESCRIPTION
44The
45.Nm
46utility
47is an implementation of the WPA Supplicant component,
48i.e., the part that runs in the client stations.
49It implements WPA key negotiation with a WPA Authenticator
50and EAP authentication with an Authentication Server.
51In addition,
52.Nm
53controls the roaming and IEEE 802.11
54authentication/association support
55.\" of the
56.\" .Xr wlan 4
57.\" module
58and can be used to configure static WEP keys
59based on identified networks.
60.Pp
61The
62.Nm
63utility
64is designed to be a
65.Dq daemon
66program that runs in the
67background and acts as the backend component controlling
68the wireless connection.
69It supports separate frontend programs such as the
70text-based
71.Xr wpa_cli 8
72program.
73.Pp
74The following arguments must be specified on the command line:
75.Bl -tag -width indent
76.It Fl i Ar ifname
77Use the specified wireless interface.
78.It Fl c Ar config-file
79Use the settings in the specified configuration file when managing
80the wireless interface.
81See
82.Xr wpa_supplicant.conf 5
83for a description of the configuration file syntax and contents.
84.Pp
85Changes to the configuration file can be reloaded by sending a
86.Dv SIGHUP
87signal to the
88.Nm
89process or with the
90.Xr wpa_cli 8
91utility, using
92.Dq Li "wpa_cli reconfigure" .
93.El
94.Sh OPTIONS
95The following options are available:
96.Bl -tag -width indent
97.It Fl B
98Detach from the controlling terminal and run as a daemon process
99in the background.
100.It Fl d
101Enable debugging messages.
102If this option is supplied twice, more verbose messages are displayed.
103Messages are sent to stdout by default, even when daemonised.
104This can be changed with the
105.Fl f
106flag.
107.It Fl e
108Use an external IEEE 802.1X Supplicant program and disable the
109internal Supplicant.
110This option is not normally used.
111.It Fl f
112Specifies a file to send debug messages to when enabled with the
113.Fl d
114flag.
115.It Fl h
116Show help text.
117.It Fl K
118Include key information in debugging output.
119.It Fl L
120Display the license for this program on the terminal and exit.
121.It Fl N i Ar ifname Fl c Ar config-file ...
122Specify an additional interface and configuration file.
123If multiple interfaces are specified then
124.Nm
125will manage them all with a single process.
126.It Fl q
127Decrease debugging verbosity (i.e., counteract the use of the
128.Fl d
129flag).
130.It Fl v
131Display version information on the terminal and exit.
132.It Fl w
133If the specified interface is not present, wait for it to be
134added; e.g.\& a cardbus device to be inserted.
135.\" This option is not normally used; instead,
136.\" .Xr devd 8
137.\" should be configured to launch
138.\" .Nm
139.\" when a device is created.
140.El
141.Sh SEE ALSO
142.Xr ath 4 ,
143.Xr ipw 4 ,
144.Xr iwi 4 ,
145.Xr ral 4 ,
146.Xr wi 4 ,
147.Xr wpa_supplicant.conf 5 ,
148.Xr ifconfig 8 ,
149.Xr wpa_cli 8
150.Sh HISTORY
151The
152.Nm
153utility first appeared in
154.Nx 4.0 .
155.Sh AUTHORS
156The
157.Nm
158utility was written by
159.An Jouni Malinen Aq jkmaline@cc.hut.fi .
160This manual page is derived from the
161.Pa README
162file included in the
163.Nm
164distribution.
165