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: head/usr.sbin/wpa/wpa_supplicant/wpa_supplicant.8 242696 2012-11-07 15:47:36Z issyl0 $
26.\"
27.Dd May 21, 2020
28.Dt WPA_SUPPLICANT 8
29.Os
30.Sh NAME
31.Nm wpa_supplicant
32.Nd "WPA/802.11i Supplicant for wireless network devices"
33.Sh SYNOPSIS
34.Nm
35.Op Fl BdhKLqstuvW
36.Op Fl b Ar br_ifname
37.Fl c Ar config-file
38.Op Fl C Ar ctrl
39.Op Fl D Ar driver
40.Op Fl f Ar debug file
41.Op Fl g Ar global ctrl
42.Fl i Ar ifname
43.Op Fl o Ar override driver
44.Op Fl O Ar override ctrl
45.Op Fl P Ar pid file
46.Oo Fl N
47.Fl i Ar ifname
48.Fl c Ar config-file
49.Op Fl C Ar ctrl
50.Op Fl D Ar driver
51.Op Fl p Ar driver_param
52.Op Fl b Ar br_ifname
53.Oc
54.Oo Fl M
55.Fl i Ar ifpattern
56.Fl c Ar config-file
57.Op Fl D Ar driver
58.Oc
59.No ...
60.Sh DESCRIPTION
61The
62.Nm
63utility
64is an implementation of the WPA Supplicant component,
65i.e., the part that runs in the client stations.
66It implements WPA key negotiation with a WPA Authenticator
67and EAP authentication with an Authentication Server.
68In addition,
69.Nm
70controls the roaming and IEEE 802.11
71authentication/association support of the
72.Xr wlan 4
73module and can be used to configure static WEP keys
74based on identified networks.
75.Pp
76The
77.Nm
78utility
79is designed to be a
80.Dq daemon
81program that runs in the
82background and acts as the backend component controlling
83the wireless connection.
84It supports separate frontend programs such as the
85text-based
86.Xr wpa_cli 8
87program.
88.Pp
89The following arguments must be specified on the command line:
90.Bl -tag -width indent
91.It Fl i Ar ifname
92Use the specified wireless interface.
93.Pp
94If combined with -M, this is actually a pattern used to match
95an interface when it becomes available, for example 'wlan*'.
96.It Fl c Ar config-file
97Use the settings in the specified configuration file when managing
98the wireless interface.
99See
100.Xr wpa_supplicant.conf 5
101for a description of the configuration file syntax and contents.
102.Pp
103Changes to the configuration file can be reloaded by sending a
104.Dv SIGHUP
105to the
106.Nm
107process or with the
108.Xr wpa_cli 8
109utility, using
110.Dq Li "wpa_cli reconfigure" .
111.El
112.Sh OPTIONS
113The following options are available:
114.Bl -tag -width indent
115.It Fl b
116Optional bridge interface name.
117.It Fl B
118Detach from the controlling terminal and run as a daemon process
119in the background.
120.It Fl d
121Enable debugging messages.
122If this option is supplied twice, more verbose messages are displayed.
123.It Fl D
124Driver name ('bsd' or 'wired')
125.It Fl f
126Log output to debug file instead of stdout.
127.It Fl g
128Global ctrl_interface.
129.It Fl h
130Show help text.
131.It Fl K
132Include key information in debugging output.
133.It Fl L
134Display the license for this program on the terminal and exit.
135.It Fl M
136Start describing a new interface matching given pattern.
137.It Fl N
138Start describing a new interface.
139.It Fl o
140Overrides driver parameter for new interfaces.
141.It Fl O
142Override ctrl_interface parameter for new interfaces.
143.It Fl p
144Specify driver parameters.
145.It Fl P
146File in which to save the process PID.
147.It Fl q
148Decrease debugging verbosity (i.e., counteract the use of the
149.Fl d
150flag).
151.It Fl s
152Send log messages through
153.Xr syslog 3
154instead of to the terminal.
155.It Fl t
156Include timestamp in debug messages.
157.It Fl u
158Enable DBus control interface.
159.It Fl v
160Display version information on the terminal and exit.
161.It Fl W
162Wait for a control interface monitor before starting.
163.El
164.Sh SEE ALSO
165.Xr ath 4 ,
166.\".Xr ipw 4 ,
167.Xr iwi 4 ,
168.Xr ral 4 ,
169.Xr rum 4 ,
170.Xr wi 4 ,
171.Xr wlan 4 ,
172.Xr wpi 4 ,
173.Xr wpa_supplicant.conf 5 ,
174.Xr devd 8 ,
175.Xr ifconfig 8 ,
176.Xr wpa_cli 8
177.Sh HISTORY
178The
179.Nm
180utility first appeared in
181.Fx 6.0 .
182.Sh AUTHORS
183The
184.Nm
185utility was written by
186.An Jouni Malinen Aq Mt j@w1.fi .
187This manual page is derived from the
188.Pa README
189file included in the
190.Nm
191distribution.
192