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