libeap/wpa_supplicant/doc/docbook/wpa_gui.sgml

   1 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
   2
   3 <refentry>
   4   <refmeta>
   5     <refentrytitle>wpa_gui</refentrytitle>
   6     <manvolnum>8</manvolnum>
   7   </refmeta>
   8   <refnamediv>
   9     <refname>wpa_gui</refname>
  10
  11     <refpurpose>WPA Graphical User Interface</refpurpose>
  12   </refnamediv>
  13
  14   <refsynopsisdiv>
  15     <cmdsynopsis>
  16       <command>wpa_gui</command>
  17       <arg>-p <replaceable>path to ctrl sockets</replaceable></arg>
  18       <arg>-i <replaceable>ifname</replaceable></arg>
  19       <arg>-m <replaceable>seconds</replaceable></arg>
  20       <arg>-t</arg>
  21       <arg>-q</arg>
  22     </cmdsynopsis>
  23   </refsynopsisdiv>
  24
  25   <refsect1>
  26     <title>Overview</title>
  27
  28     <para>wpa_gui is a QT graphical frontend program for interacting
  29     with wpa_supplicant. It is used to query current status, change
  30     configuration and request interactive user input.</para>
  31
  32     <para>wpa_gui supports (almost) all of the interactive status and
  33     configuration features of the command line client, wpa_cli. Refer
  34     to the wpa_cli manpage for a comprehensive list of the
  35     interactive mode features.</para>
  36   </refsect1>
  37   <refsect1>
  38     <title>Command Arguments</title>
  39     <variablelist>
  40       <varlistentry>
  41         <term>-p path</term>
  42
  43         <listitem><para>Change the path where control sockets should
  44         be found.</para></listitem>
  45       </varlistentry>
  46
  47       <varlistentry>
  48         <term>-i ifname</term>
  49
  50         <listitem><para>Specify the interface that is being
  51         configured. By default, choose the first interface found with
  52         a control socket in the socket path.</para></listitem>
  53       </varlistentry>
  54
  55       <varlistentry>
  56         <term>-m seconds</term>
  57
  58         <listitem><para>Set the update interval in seconds for the signal
  59         strength meter. This value must be a positive integer, otherwise
  60         meter is not enabled (default behavior).</para></listitem>
  61       </varlistentry>
  62
  63       <varlistentry>
  64         <term>-t</term>
  65
  66         <listitem><para>Start program in the system tray only (if the window
  67         manager supports it). By default the main status window is
  68         shown.</para></listitem>
  69       </varlistentry>
  70
  71       <varlistentry>
  72         <term>-q</term>
  73
  74         <listitem><para>Run program in the quiet mode - do not display tray
  75         icon pop-up messages.</para></listitem>
  76       </varlistentry>
  77     </variablelist>
  78   </refsect1>
  79   <refsect1>
  80     <title>See Also</title>
  81     <para>
  82       <citerefentry>
  83         <refentrytitle>wpa_cli</refentrytitle>
  84         <manvolnum>8</manvolnum>
  85       </citerefentry>
  86       <citerefentry>
  87         <refentrytitle>wpa_supplicant</refentrytitle>
  88         <manvolnum>8</manvolnum>
  89       </citerefentry>
  90     </para>
  91   </refsect1>
  92   <refsect1>
  93     <title>Legal</title>
  94     <para>wpa_supplicant is copyright (c) 2003-2015,
  95     Jouni Malinen <email>j@w1.fi</email> and
  96     contributors.
  97     All Rights Reserved.</para>
  98
  99     <para>This program is licensed under the BSD license (the one with
 100     advertisement clause removed).</para>
 101   </refsect1>
 102 </refentry>