xref: /netbsd-src/external/bsd/wpa/bin/wpa_supplicant/wpa_supplicant.8 (revision 75f6d617e282811cb173c2ccfbf5df0dd71f7045)
1.\" $NetBSD: wpa_supplicant.8,v 1.6 2016/01/10 20:31:13 wiz 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 9, 2016
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 BdhKLqstvW
39.Op Fl b Ar br_ifname
40.Op Fl C Ar ctrl
41.Fl c Ar config-file
42.Op Fl D Ar driver
43.Op Fl e Ar entropy-file
44.Op Fl f Ar debug-file
45.Op Fl G Ar global-ctrl-group
46.Op Fl g Ar global-ctrl
47.Op Fl I Ar additional-config-file
48.Fl i Ar ifname
49.Op Fl O Ar override-ctrl
50.Op Fl o Ar override-driver
51.Op Fl P Ar pidfile
52.Op Fl p Ar parameters
53.Op Fl N i Ar ifname Fl c Ar config-file ...
54.Sh DESCRIPTION
55The
56.Nm
57utility
58is an implementation of the WPA Supplicant component,
59i.e., the part that runs in the client stations.
60It implements WPA key negotiation with a WPA Authenticator
61and EAP authentication with an Authentication Server.
62In addition,
63.Nm
64controls the roaming and IEEE 802.11
65authentication/association support
66.\" of the
67.\" .Xr wlan 4
68.\" module
69and can be used to configure static WEP keys
70based on identified networks.
71.Pp
72The
73.Nm
74utility
75is designed to be a
76.Dq daemon
77program that runs in the
78background and acts as the backend component controlling
79the wireless connection.
80It supports separate frontend programs such as the
81text-based
82.Xr wpa_cli 8
83program.
84.Pp
85The following arguments must be specified on the command line:
86.Bl -tag -width indent
87.It Fl i Ar ifname
88Use the specified wireless interface.
89.It Fl c Ar config-file
90Use the settings in the specified configuration file when managing
91the wireless interface.
92See
93.Xr wpa_supplicant.conf 5
94for a description of the configuration file syntax and contents.
95.Pp
96Changes to the configuration file can be reloaded by sending a
97.Dv SIGHUP
98signal to the
99.Nm
100process or with the
101.Xr wpa_cli 8
102utility, using
103.Dq Li "wpa_cli reconfigure" .
104.El
105.Sh OPTIONS
106The following options are available:
107.Bl -tag -width indent
108.It Fl B
109Detach from the controlling terminal and run as a daemon process
110in the background.
111.It Fl b Ar br_ifname
112Optional bridge interface name.
113.It Fl C Ar ctrl
114Control interface parameter.
115.It Fl D Ar driver
116Driver name (can be either bsd or wired)
117.It Fl d
118Enable debugging messages.
119If this option is supplied twice, more verbose messages are displayed.
120Messages are sent to stdout by default, even when daemonised.
121This can be changed with the
122.Fl f
123flag.
124.It Fl e Ar entropy-file
125Specifies a file to store entropy.
126.It Fl f Ar debug-file
127Specifies a file to send debug messages to when enabled with the
128.Fl d
129flag.
130.It Fl G Ar global-ctrl-group
131Global control interface group.
132.It Fl g Ar global-ctrl
133Global control interface.
134.It Fl h
135Show help text.
136.It Fl I Ar additional-config-file
137Additional configuration file.
138.It Fl K
139Include key information in debugging output.
140.It Fl L
141Display the license for this program on the terminal and exit.
142.It Fl N i Ar ifname Fl c Ar config-file ...
143Specify an additional interface and configuration file.
144If multiple interfaces are specified then
145.Nm
146will manage them all with a single process.
147.It Fl O Ar override-ctrl
148Override ctrl_interface parameter for new interface.
149.It Fl o Ar override-driver
150Override driver paramter for new interface.
151.It Fl P Ar pidfile
152File in which to save the process PID.
153.It Fl p Ar parameters
154Specify driver parameters.
155.It Fl q
156Decrease debugging verbosity (i.e., counteract the use of the
157.Fl d
158flag).
159.It Fl s
160Send log messages through
161.Xr syslog 3
162instead of to the terminal.
163.It Fl t
164Include timestamp in debug messages.
165.It Fl v
166Display version information on the terminal and exit.
167.It Fl W
168Wait for a control interface monitor before starting.
169.El
170.Sh SEE ALSO
171.Xr ath 4 ,
172.Xr ipw 4 ,
173.Xr iwi 4 ,
174.Xr iwn 4 ,
175.Xr ral 4 ,
176.Xr rum 4 ,
177.Xr wi 4 ,
178.Xr wpi 4 ,
179.Xr zyd 4 ,
180.Xr wpa_supplicant.conf 5 ,
181.Xr ifconfig 8 ,
182.Xr wpa_cli 8
183.Sh HISTORY
184The
185.Nm
186utility first appeared in
187.Nx 4.0 .
188.Sh AUTHORS
189The
190.Nm
191utility was written by
192.An Jouni Malinen Aq Mt jkmaline@cc.hut.fi .
193This manual page is derived from the
194.Pa README
195file included in the
196.Nm
197distribution.
198