doc: Remove duplicate description for -t
[mech_eap.git] / wpa_supplicant / doc / docbook / wpa_supplicant.sgml
index 52b62c3..11e0e90 100644 (file)
@@ -12,7 +12,7 @@
   <refsynopsisdiv>
     <cmdsynopsis>
       <command>wpa_supplicant</command>
-      <arg>-BddfhKLqqtuvW</arg>
+      <arg>-BddfhKLqqsTtuvW</arg>
       <arg>-i<replaceable>ifname</replaceable></arg>
       <arg>-c<replaceable>config file</replaceable></arg>
       <arg>-D<replaceable>driver</replaceable></arg>
@@ -66,7 +66,7 @@
 
     <para>Before wpa_supplicant can do its work, the network interface
     must be available.  That means that the physical device must be
-    present and enabled, and the driver for the device must have be
+    present and enabled, and the driver for the device must be
     loaded. The daemon will exit immediately if the device is not already
     available.</para>
 
 
   <refsect1>
     <title>Available Drivers</title>
-    <para>The available drivers to specify with the -D option are:</para>
+    <para>A summary of available driver backends is below. Support for each
+    of the driver backends is chosen at wpa_supplicant compile time. For a
+    list of supported driver backends that may be used with the -D option on
+    your system, refer to the help output of wpa_supplicant
+    (<emphasis>wpa_supplicant -h</emphasis>).</para>
 
     <variablelist>
       <varlistentry>
-       <term>hostap</term>
-       <listitem>
-         <para>(default) Host AP driver (Intersil Prism2/2.5/3).
-         (this can also be used with Linuxant DriverLoader).</para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term>hermes</term>
-       <listitem>
-         <para>Agere Systems Inc. driver (Hermes-I/Hermes-II).</para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term>madwifi</term>
-       <listitem>
-         <para>MADWIFI 802.11 support (Atheros, etc.).</para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term>atmel</term>
-       <listitem>
-         <para>ATMEL AT76C5XXx (USB, PCMCIA).</para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
        <term>wext</term>
        <listitem>
          <para>Linux wireless extensions (generic).</para>
       </varlistentry>
 
       <varlistentry>
-       <term>ndiswrapper</term>
-       <listitem>
-         <para>Linux ndiswrapper.</para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term>broadcom</term>
-       <listitem>
-         <para>Broadcom wl.o driver.</para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term>ipw</term>
+       <term>wired</term>
        <listitem>
-         <para>Intel ipw2100/2200 driver.</para>
+         <para>wpa_supplicant wired Ethernet driver</para>
        </listitem>
       </varlistentry>
 
       <varlistentry>
-       <term>wired</term>
+       <term>roboswitch</term>
        <listitem>
-         <para>wpa_supplicant wired Ethernet driver</para>
+         <para>wpa_supplicant Broadcom switch driver</para>
        </listitem>
       </varlistentry>
 
 
   <refsect1>
     <title>Command Line Options</title>
+    <para>Most command line options have global scope. Some are given per
+    interface, and are only valid if at least one <option>-i</option> option
+    is specified, otherwise they're ignored. Option groups for different
+    interfaces must be separated by <option>-N</option> option.</para>
     <variablelist>
       <varlistentry>
        <term>-b br_ifname</term>
        <listitem>
-         <para>Optional bridge interface name.</para>
+         <para>Optional bridge interface name. (Per interface)</para>
        </listitem>
       </varlistentry>
 
       <varlistentry>
        <term>-c filename</term>
        <listitem>
-         <para>Path to configuration file.</para>
+         <para>Path to configuration file. (Per interface)</para>
        </listitem>
       </varlistentry>
 
       <varlistentry>
        <term>-C ctrl_interface</term>
        <listitem>
-         <para>Path to ctrl_interface socket (only used if -c is not).</para>
+         <para>Path to ctrl_interface socket (Per interface. Only used if
+                 <option>-c</option> is not).</para>
        </listitem>
       </varlistentry>
 
       <varlistentry>
        <term>-i ifname</term>
        <listitem>
-         <para>Interface to listen on.</para>
+         <para>Interface to listen on. Multiple instances of this option can
+         be present, one per interface, separated by <option>-N</option>
+         option (see below).</para>
        </listitem>
       </varlistentry>
 
       <varlistentry>
        <term>-d</term>
        <listitem>
-         <para>Increase debugging verbosity (-dd even more).</para>
+         <para>Increase debugging verbosity (<option>-dd</option> even
+                 more).</para>
        </listitem>
       </varlistentry>
 
       <varlistentry>
        <term>-D driver</term>
        <listitem>
-         <para>Driver to use.  See the available options below.</para>
+         <para>Driver to use (can be multiple drivers: nl80211,wext).
+                 (Per interface, see the available options below.)</para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term>-e entropy file</term>
+       <listitem>
+         <para>File for <command>wpa_supplicant</command> to use to
+         maintain its internal entropy store in over restarts.</para>
        </listitem>
       </varlistentry>
 
       <varlistentry>
        <term>-f output file</term>
        <listitem>
-         <para>Log output to specified file instead of stdout.</para>
+         <para>Log output to specified file instead of stdout. (This
+         is only available if <command>wpa_supplicant</command> was
+         built with the <literal>CONFIG_DEBUG_FILE</literal>
+         option.)</para>
        </listitem>
       </varlistentry>
 
       <varlistentry>
        <term>-g global ctrl_interface</term>
        <listitem>
-         <para>Path to global ctrl_interface socket.</para>
+         <para>Path to global ctrl_interface socket. If specified, interface
+         definitions may be omitted.</para>
        </listitem>
       </varlistentry>
 
       </varlistentry>
 
       <varlistentry>
-       <term>-t</term>
+       <term>-h</term>
        <listitem>
-         <para>Include timestamp in debug messages.</para>
+         <para>Help.  Show a usage message.</para>
        </listitem>
       </varlistentry>
 
       <varlistentry>
-       <term>-h</term>
+       <term>-L</term>
        <listitem>
-         <para>Help.  Show a usage message.</para>
+         <para>Show license (BSD).</para>
        </listitem>
       </varlistentry>
 
       <varlistentry>
-       <term>-L</term>
+       <term>-o override driver</term>
+       <listitem>
+         <para>Override the driver parameter for new
+         interfaces.</para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term>-O override ctrl_interface</term>
        <listitem>
-         <para>Show license (GPL and BSD).</para>
+         <para>Override the ctrl_interface parameter for new
+         interfaces.</para>
        </listitem>
       </varlistentry>
 
       <varlistentry>
        <term>-p</term>
        <listitem>
-         <para>Driver parameters.</para>
+         <para>Driver parameters. (Per interface)</para>
        </listitem>
       </varlistentry>
 
       <varlistentry>
        <term>-q</term>
        <listitem>
-         <para>Decrease debugging verbosity (-qq even less).</para>
+         <para>Decrease debugging verbosity (<option>-qq</option> even
+                 less).</para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term>-s</term>
+       <listitem>
+         <para>Log output to syslog instead of stdout. (This is only
+         available if <command>wpa_supplicant</command> was built
+         with the <literal>CONFIG_DEBUG_SYSLOG</literal>
+         option.)</para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term>-T</term>
+       <listitem>
+         <para>Log output to Linux tracing in addition to any other
+         destinations. (This is only available
+         if <command>wpa_supplicant</command> was built with
+         the <literal>CONFIG_DEBUG_LINUX_TRACING</literal>
+         option.)</para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term>-t</term>
+       <listitem>
+         <para>Include timestamp in debug messages.</para>
        </listitem>
       </varlistentry>
 
       <varlistentry>
        <term>-u</term>
        <listitem>
-         <para>Enabled DBus control interface.</para>
+         <para>Enable DBus control interface. If enabled, interface
+         definitions may be omitted. (This is only available
+         if <command>wpa_supplicant</command> was built with
+         the <literal>CONFIG_DBUS</literal> option.)</para>
        </listitem>
       </varlistentry>
 
@@ -486,6 +509,15 @@ wpa_supplicant -B -c/etc/wpa_supplicant.conf -iwlan0
 wpa_supplicant -c/etc/wpa_supplicant.conf -iwlan0 -d
 </programlisting></blockquote>
 
+    <para>If the specific driver wrapper is not known beforehand, it is
+    possible to specify multiple comma separated driver wrappers on the command
+    line. <command>wpa_supplicant</command> will use the first driver
+    wrapper that is able to initialize the interface.</para>
+
+<blockquote><programlisting>
+wpa_supplicant -Dnl80211,wext -c/etc/wpa_supplicant.conf -iwlan0
+</programlisting></blockquote>
+
     <para><command>wpa_supplicant</command> can control multiple
     interfaces (radios) either by running one process for each
     interface separately or by running just one process and list of
@@ -495,8 +527,8 @@ wpa_supplicant -c/etc/wpa_supplicant.conf -iwlan0 -d
 
 <blockquote><programlisting>
 wpa_supplicant \
-       -c wpa1.conf -i wlan0 -D hostap -N \
-       -c wpa2.conf -i ath0 -D madwifi
+       -c wpa1.conf -i wlan0 -D nl80211 -N \
+       -c wpa2.conf -i ath0 -D wext
 </programlisting></blockquote>
   </refsect1>
 
@@ -526,93 +558,6 @@ wpa_supplicant \
     <title>Supported Drivers</title>
     <variablelist>
       <varlistentry>
-       <term>Host AP driver for Prism2/2.5/3 (development
-       snapshot/v0.2.x)</term>
-       <listitem>
-         <para> (http://hostap.epitest.fi/) Driver needs to be set in
-         Managed mode (<emphasis>iwconfig wlan0 mode managed</emphasis>).
-         Please note that station firmware version needs to be 1.7.0 or
-         newer to work in WPA mode.</para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term>Linuxant DriverLoader</term>
-       <listitem>
-         <para>(http://www.linuxant.com/driverloader/)
-       with Windows NDIS driver for your wlan card supporting WPA.</para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term>Agere Systems Inc. Linux Driver</term>
-       <listitem>
-         <para> (http://www.agere.com/support/drivers/) Please note
-       that the driver interface file (driver_hermes.c) and hardware
-       specific include files are not included in the wpa_supplicant
-       distribution. You will need to copy these from the source
-       package of the Agere driver.</para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term>madwifi driver for cards based on Atheros chip set (ar521x)</term>
-       <listitem>
-         <para> (http://sourceforge.net/projects/madwifi/) Please
-       note that you will need to modify the wpa_supplicant .config
-       file to use the correct path for the madwifi driver root
-       directory (CFLAGS += -I../madwifi/wpa line in example
-       defconfig).</para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term>ATMEL AT76C5XXx driver for USB and PCMCIA cards</term>
-       <listitem>
-         <para> (http://atmelwlandriver.sourceforge.net/).</para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term>Linux ndiswrapper</term>
-       <listitem>
-         <para> (http://ndiswrapper.sourceforge.net/) with Windows
-       NDIS driver.</para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term>Broadcom wl.o driver</term>
-       <listitem>
-         <para> This is a generic Linux driver for Broadcom IEEE
-       802.11a/g cards.  However, it is proprietary driver that is
-       not publicly available except for couple of exceptions, mainly
-       Broadcom-based APs/wireless routers that use Linux. The driver
-       binary can be downloaded, e.g., from Linksys support site
-       (http://www.linksys.com/support/gpl.asp) for Linksys
-       WRT54G. The GPL tarball includes cross-compiler and the needed
-       header file, wlioctl.h, for compiling wpa_supplicant.  This
-       driver support in wpa_supplicant is expected to work also with
-       other devices based on Broadcom driver (assuming the driver
-       includes client mode support).</para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term> Intel ipw2100 driver</term>
-       <listitem>
-         <para> (http://sourceforge.net/projects/ipw2100/)</para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term>Intel ipw2200 driver</term>
-       <listitem>
-         <para> (http://sourceforge.net/projects/ipw2200/)</para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
        <term>Linux wireless extensions</term>
        <listitem>
          <para>In theory, any driver that supports Linux wireless
@@ -784,12 +729,12 @@ fi
   </refsect1>
   <refsect1>
     <title>Legal</title>
-    <para>wpa_supplicant is copyright (c) 2003-2007,
+    <para>wpa_supplicant is copyright (c) 2003-2016,
     Jouni Malinen <email>j@w1.fi</email> and
     contributors.
     All Rights Reserved.</para>
 
-    <para>This program is dual-licensed under both the GPL version 2
-    and BSD license. Either license may be used at your option.</para>
+    <para>This program is licensed under the BSD license (the one with
+    advertisement clause removed).</para>
   </refsect1>
 </refentry>