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