bin/wpa_supplicant/wpa_supplicant.8

.\" $NetBSD: wpa_supplicant.8,v 1.10 2022/09/10 12:39:06 rillig Exp $
.\"
.\" Copyright (c) 2005 Sam Leffler <sam@errno.com>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" Based on:
.\" $FreeBSD: /repoman/r/ncvs/src/usr.sbin/wpa/wpa_supplicant/wpa_supplicant.8,v 1.2 2005/06/27 06:40:43 ru Exp $
.\"
.Dd June 19, 2019
.Dt WPA_SUPPLICANT 8
.Os
.Sh NAME
.Nm wpa_supplicant
.Nd WPA/802.11i Supplicant for wireless network devices
.Sh SYNOPSIS
.Nm
.Op Fl BdhKLqstvW
.Op Fl b Ar br_ifname
.Op Fl C Ar ctrl
.Fl c Ar config-file
.Op Fl D Ar driver
.Op Fl e Ar entropy-file
.Op Fl f Ar debug-file
.Op Fl G Ar global-ctrl-group
.Op Fl g Ar global-ctrl
.Op Fl I Ar additional-config-file
.Op Fl i Ar ifname
.Op Fl O Ar override-ctrl
.Op Fl o Ar override-driver
.Op Fl P Ar pidfile
.Op Fl p Ar parameters
.Op Fl M Oo Fl i Ar ifname Oc Fl c Ar config-file ...
.Op Fl N Fl i Ar ifname Fl c Ar config-file ...
.Sh DESCRIPTION
The
.Nm
utility
is an implementation of the WPA Supplicant component,
i.e., the part that runs in the client stations.
It implements WPA key negotiation with a WPA Authenticator
and EAP authentication with an Authentication Server.
In addition,
.Nm
controls the roaming and IEEE 802.11
authentication/association support
.\" of the
.\" .Xr wlan 4
.\" module
and can be used to configure static WEP keys
based on identified networks.
.Pp
The
.Nm
utility
is designed to be a
.Dq daemon
program that runs in the
background and acts as the backend component controlling
the wireless connection.
It supports separate frontend programs such as the
text-based
.Xr wpa_cli 8
program.
.Pp
The following arguments must be specified on the command line:
.Bl -tag -width indent
.It Fl i Ar ifname
Use the specified wireless interface.
.It Fl c Ar config-file
Use the settings in the specified configuration file when managing
the wireless interface.
See
.Xr wpa_supplicant.conf 5
for a description of the configuration file syntax and contents.
.Pp
Changes to the configuration file can be reloaded by sending a
.Dv SIGHUP
signal to the
.Nm
process or with the
.Xr wpa_cli 8
utility, using
.Dq Li "wpa_cli reconfigure" .
.El
.Sh OPTIONS
The following options are available:
.Bl -tag -width indent
.It Fl B
Detach from the controlling terminal and run as a daemon process
in the background.
.It Fl b Ar br_ifname
Optional bridge interface name.
.It Fl C Ar ctrl
Control interface parameter.
.It Fl D Ar driver
Driver name (can be either bsd or wired)
.It Fl d
Enable debugging messages.
If this option is supplied twice, more verbose messages are displayed.
Messages are sent to stdout by default, even when daemonised.
This can be changed with the
.Fl f
flag.
.It Fl e Ar entropy-file
Specifies a file to store entropy.
.It Fl f Ar debug-file
Specifies a file to send debug messages to when enabled with the
.Fl d
flag.
.It Fl G Ar global-ctrl-group
Global control interface group.
.It Fl g Ar global-ctrl
Global control interface.
.It Fl h
Show help text.
.It Fl I Ar additional-config-file
Additional configuration file.
.It Fl K
Include key information in debugging output.
.It Fl L
Display the license for this program on the terminal and exit.
.It Fl M Oo Fl i Ar matchifname Oc Fl c Ar config-file ...
Matches the interface name using
.Xr fnmatch 3 ,
or all interfaces if
.Fl i
is not specified.
If multiple interfaces are matched then
.Nm
will manage them all with a single process.
.It Fl N i Ar ifname Fl c Ar config-file ...
Specify an additional interface and configuration file.
If multiple interfaces are specified then
.Nm
will manage them all with a single process.
.It Fl O Ar override-ctrl
Override ctrl_interface parameter for new interface.
.It Fl o Ar override-driver
Override driver parameter for new interface.
.It Fl P Ar pidfile
File in which to save the process PID.
.It Fl p Ar parameters
Specify driver parameters.
.It Fl q
Decrease debugging verbosity (i.e., counteract the use of the
.Fl d
flag).
.It Fl s
Send log messages through
.Xr syslog 3
instead of to the terminal.
.It Fl t
Include timestamp in debug messages.
.It Fl v
Display version information on the terminal and exit.
.It Fl W
Wait for a control interface monitor before starting.
.El
.Sh SEE ALSO
.Xr fnmatch 3 ,
.Xr ath 4 ,
.Xr ipw 4 ,
.Xr iwi 4 ,
.Xr iwn 4 ,
.Xr ral 4 ,
.Xr rum 4 ,
.Xr wi 4 ,
.Xr wpi 4 ,
.Xr zyd 4 ,
.Xr wpa_supplicant.conf 5 ,
.Xr ifconfig 8 ,
.Xr wpa_cli 8 ,
.Xr wpa_passphrase 8
.Sh HISTORY
The
.Nm
utility first appeared in
.Nx 4.0 .
.Sh AUTHORS
The
.Nm
utility was written by
.An Jouni Malinen Aq Mt jkmaline@cc.hut.fi .
This manual page is derived from the
.Pa README
file included in the
.Nm
distribution.