usr.sbin/802_11/wpa_supplicant/wpa_supplicant.8

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