usr.sbin/wpa/wpa_supplicant/wpa_supplicant.8

   1 .\" $NetBSD: wpa_supplicant.8,v 1.4 2005/12/12 22:23:22 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 2005 Sam Leffler <sam@errno.com>
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .\" Based on:
  28 .\" $FreeBSD: /repoman/r/ncvs/src/usr.sbin/wpa/wpa_supplicant/wpa_supplicant.8,v 1.2 2005/06/27 06:40:43 ru Exp $
  29 .\"
  30 .Dd October 1, 2005
  31 .Dt WPA_SUPPLICANT 8
  32 .Os
  33 .Sh NAME
  34 .Nm wpa_supplicant
  35 .Nd WPA/802.11i Supplicant for wireless network devices
  36 .Sh SYNOPSIS
  37 .Nm
  38 .Op Fl BdehLqvw
  39 .Fl i Ar ifname
  40 .Fl c Ar config-file
  41 .Op Fl N i Ar ifname Fl c Ar config-file ...
  42 .Sh DESCRIPTION
  43 The
  44 .Nm
  45 utility
  46 is an implementation of the WPA Supplicant component,
  47 i.e., the part that runs in the client stations.
  48 It implements WPA key negotiation with a WPA Authenticator
  49 and EAP authentication with an Authentication Server.
  50 In addition,
  51 .Nm
  52 controls the roaming and IEEE 802.11
  53 authentication/association support
  54 .\" of the
  55 .\" .Xr wlan 4
  56 .\" module
  57 and can be used to configure static WEP keys
  58 based on identified networks.
  59 .Pp
  60 The
  61 .Nm
  62 utility
  63 is designed to be a
  64 .Dq daemon
  65 program that runs in the
  66 background and acts as the backend component controlling
  67 the wireless connection.
  68 It supports separate frontend programs such as the
  69 text-based
  70 .Xr wpa_cli 8
  71 program.
  72 .Pp
  73 The following arguments must be specified on the command line:
  74 .Bl -tag -width indent
  75 .It Fl i Ar ifname
  76 Use the specified wireless interface.
  77 .It Fl c Ar config-file
  78 Use the settings in the specified configuration file when managing
  79 the wireless interface.
  80 See
  81 .Xr wpa_supplicant.conf 5
  82 for a description of the configuration file syntax and contents.
  83 .Pp
  84 Changes to the configuration file can be reloaded by sending a
  85 .Dv SIGHUP
  86 signal to the
  87 .Nm
  88 process or with the
  89 .Xr wpa_cli 8
  90 utility, using
  91 .Dq Li "wpa_cli reconfigure" .
  92 .El
  93 .Sh OPTIONS
  94 The following options are available:
  95 .Bl -tag -width indent
  96 .It Fl B
  97 Detach from the controlling terminal and run as a daemon process
  98 in the background.
  99 .It Fl d
 100 Enable debugging messages.
 101 If this option is supplied twice, more verbose messages are displayed.
 102 .It Fl e
 103 Use an external IEEE 802.1X Supplicant program and disable the
 104 internal Supplicant.
 105 This option is not normally used.
 106 .It Fl h
 107 Show help text.
 108 .It Fl K
 109 Include key information in debugging output.
 110 .It Fl L
 111 Display the license for this program on the terminal and exit.
 112 .It Fl N i Ar ifname Fl c Ar config-file ...
 113 Specify an additional interface and configuration file.
 114 If multiple interfaces are specified then
 115 .Nm
 116 will manage them all with a single process.
 117 .It Fl q
 118 Decrease debugging verbosity (i.e., counteract the use of the
 119 .Fl d
 120 flag).
 121 .It Fl v
 122 Display version information on the terminal and exit.
 123 .It Fl w
 124 If the specified interface is not present, wait for it to be
 125 added; e.g.\& a cardbus device to be inserted.
 126 .\" This option is not normally used; instead,
 127 .\" .Xr devd 8
 128 .\" should be configured to launch
 129 .\" .Nm
 130 .\" when a device is created.
 131 .El
 132 .Sh SEE ALSO
 133 .Xr ath 4 ,
 134 .Xr ipw 4 ,
 135 .Xr iwi 4 ,
 136 .Xr ral 4 ,
 137 .Xr wi 4 ,
 138 .Xr wpa_supplicant.conf 5 ,
 139 .Xr ifconfig 8 ,
 140 .Xr wpa_cli 8
 141 .Sh HISTORY
 142 The
 143 .Nm
 144 utility first appeared in
 145 .Nx 4.0 .
 146 .Sh AUTHORS
 147 The
 148 .Nm
 149 utility was written by
 150 .An Jouni Malinen Aq jkmaline@cc.hut.fi .
 151 This manual page is derived from the
 152 .Pa README
 153 file included in the
 154 .Nm
 155 distribution.