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.2 2005/06/27 06:40:43 ru Exp $
  26 .\" $DragonFly: src/usr.sbin/802_11/wpa_supplicant/wpa_supplicant.8,v 1.6 2007/09/16 18:52:17 swildner Exp $
  27 .\"
  28 .Dd July 22, 2007
  29 .Dt WPA_SUPPLICANT 8
  30 .Os
  31 .Sh NAME
  32 .Nm wpa_supplicant
  33 .Nd "WPA/802.11i Supplicant for wireless network devices"
  34 .Sh SYNOPSIS
  35 .Nm
  36 .Op Fl BdehLqvw
  37 .Fl i Ar ifname
  38 .Fl c Ar config-file
  39 .Op Fl N i Ar ifname Fl c Ar config-file ...
  40 .Sh DESCRIPTION
  41 The
  42 .Nm
  43 utility
  44 is an implementation of the WPA Supplicant component,
  45 i.e., the part that runs in the client stations.
  46 It implements WPA key negotiation with a WPA Authenticator
  47 and EAP authentication with an Authentication Server.
  48 In addition,
  49 .Nm
  50 controls the roaming and IEEE 802.11
  51 authentication/association support of the
  52 .Xr wlan 4
  53 module and can be used to configure static WEP keys
  54 based on identified networks.
  55 .Pp
  56 The
  57 .Nm
  58 utility
  59 is designed to be a
  60 .Dq daemon
  61 program that runs in the
  62 background and acts as the backend component controlling
  63 the wireless connection.
  64 It supports separate frontend programs such as the
  65 text-based
  66 .Xr wpa_cli 8
  67 program.
  68 .Pp
  69 The following arguments must be specified on the command line:
  70 .Bl -tag -width indent
  71 .It Fl i Ar ifname
  72 Use the specified wireless interface.
  73 .It Fl c Ar config-file
  74 Use the settings in the specified configuration file when managing
  75 the wireless interface.
  76 See
  77 .Xr wpa_supplicant.conf 5
  78 for a description of the configuration file syntax and contents.
  79 .Pp
  80 Changes to the configuration file can be reloaded by sending a
  81 .Dv SIGHUP
  82 to the
  83 .Nm
  84 process or with the
  85 .Xr wpa_cli 8
  86 utility, using
  87 .Dq Li "wpa_cli reconfigure" .
  88 .El
  89 .Sh OPTIONS
  90 The following options are available:
  91 .Bl -tag -width indent
  92 .It Fl d
  93 Enable debugging messages.
  94 If this option is supplied twice, more verbose messages are displayed.
  95 .It Fl e
  96 Use an external IEEE 802.1X Supplicant program and disable the
  97 internal Supplicant.
  98 This option is not normally used.
  99 .It Fl h
 100 Show help text.
 101 .It Fl q
 102 Decrease debugging verbosity (i.e., counteract the use of the
 103 .Fl d
 104 flag).
 105 .It Fl v
 106 Display version information on the terminal and exit.
 107 .It Fl w
 108 If the specified interface is not present, wait for it to be
 109 added; e.g.\& a cardbus device to be inserted.
 110 This option is not normally used.
 111 .It Fl B
 112 Detach from the controlling terminal and run as a daemon process
 113 in the background.
 114 .It Fl K
 115 Include key information in debugging output.
 116 .It Fl L
 117 Display the license for this program on the terminal and exit.
 118 .It Fl N i Ar ifname Fl c Ar config-file ...
 119 Specify an additional interface and configuration file.
 120 If multiple interfaces are specified then
 121 .Nm
 122 will manage them all with a single process.
 123 .El
 124 .Sh SEE ALSO
 125 .Xr acx 4 ,
 126 .Xr ath 4 ,
 127 .Xr bwi 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 wpa_supplicant.conf 5 ,
 136 .Xr ifconfig 8 ,
 137 .Xr wpa_cli 8
 138 .Sh HISTORY
 139 The
 140 .Nm
 141 utility first appeared in
 142 .Fx 6.0 .
 143 .Sh AUTHORS
 144 The
 145 .Nm
 146 utility was written by
 147 .An Jouni Malinen Aq jkmaline@cc.hut.fi .
 148 This manual page is derived from the
 149 .Pa README
 150 file included in the
 151 .Nm
 152 distribution.