usr.sbin/wpa/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$
  26 .\"
  27 .Dd March 24, 2008
  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 BdehLqsvw
  36 .Fl i Ar ifname
  37 .Fl c Ar config-file
  38 .Sh DESCRIPTION
  39 The
  40 .Nm
  41 utility
  42 is an implementation of the WPA Supplicant component,
  43 i.e., the part that runs in the client stations.
  44 It implements WPA key negotiation with a WPA Authenticator
  45 and EAP authentication with an Authentication Server.
  46 In addition,
  47 .Nm
  48 controls the roaming and IEEE 802.11
  49 authentication/association support of the
  50 .Xr wlan 4
  51 module and can be used to configure static WEP keys
  52 based on identified networks.
  53 .Pp
  54 The
  55 .Nm
  56 utility
  57 is designed to be a
  58 .Dq daemon
  59 program that runs in the
  60 background and acts as the backend component controlling
  61 the wireless connection.
  62 It supports separate frontend programs such as the
  63 text-based
  64 .Xr wpa_cli 8
  65 program.
  66 .Pp
  67 The following arguments must be specified on the command line:
  68 .Bl -tag -width indent
  69 .It Fl i Ar ifname
  70 Use the specified wireless interface.
  71 .It Fl c Ar config-file
  72 Use the settings in the specified configuration file when managing
  73 the wireless interface.
  74 See
  75 .Xr wpa_supplicant.conf 5
  76 for a description of the configuration file syntax and contents.
  77 .Pp
  78 Changes to the configuration file can be reloaded by sending a
  79 .Dv SIGHUP
  80 to the
  81 .Nm
  82 process or with the
  83 .Xr wpa_cli 8
  84 utility, using
  85 .Dq Li "wpa_cli reconfigure" .
  86 .El
  87 .Sh OPTIONS
  88 The following options are available:
  89 .Bl -tag -width indent
  90 .It Fl d
  91 Enable debugging messages.
  92 If this option is supplied twice, more verbose messages are displayed.
  93 .It Fl e
  94 Use an external IEEE 802.1X Supplicant program and disable the
  95 internal Supplicant.
  96 This option is not normally used.
  97 .It Fl h
  98 Show help text.
  99 .It Fl q
 100 Decrease debugging verbosity (i.e., counteract the use of the
 101 .Fl d
 102 flag).
 103 .It Fl s
 104 Send log messages through
 105 .Xr syslog 3
 106 instead of to the terminal.
 107 .It Fl v
 108 Display version information on the terminal and exit.
 109 .It Fl w
 110 If the specified interface is not present, wait for it to be
 111 added; e.g.\& a cardbus device to be inserted.
 112 This option is not normally used; instead,
 113 .Xr devd 8
 114 should be configured to launch
 115 .Nm
 116 when a device is created.
 117 .It Fl B
 118 Detach from the controlling terminal and run as a daemon process
 119 in the background.
 120 .It Fl K
 121 Include key information in debugging output.
 122 .It Fl L
 123 Display the license for this program on the terminal and exit.
 124 .El
 125 .Sh SEE ALSO
 126 .Xr an 4 ,
 127 .Xr ath 4 ,
 128 .Xr ipw 4 ,
 129 .Xr iwi 4 ,
 130 .Xr ral 4 ,
 131 .Xr rum 4 ,
 132 .Xr ural 4 ,
 133 .Xr wi 4 ,
 134 .Xr wlan 4 ,
 135 .Xr wpi 4 ,
 136 .Xr zyd 4 ,
 137 .Xr wpa_supplicant.conf 5 ,
 138 .Xr devd 8 ,
 139 .Xr ifconfig 8 ,
 140 .Xr wpa_cli 8
 141 .Sh HISTORY
 142 The
 143 .Nm
 144 utility first appeared in
 145 .Fx 6.0 .
 146 .Sh AUTHORS
 147 The
 148 .Nm
 149 utility was written by
 150 .An Jouni Malinen Aq j@w1.fi .
 151 This manual page is derived from the
 152 .Pa README
 153 file included in the
 154 .Nm
 155 distribution.