Re-initialize hostapd/wpa_supplicant git repository based on 0.6.3 release
[libeap.git] / 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     </cmdsynopsis>
20   </refsynopsisdiv>
21
22   <refsect1>
23     <title>Overview</title>
24
25     <para>wpa_gui is a QT graphical frontend program for interacting
26     with wpa_supplicant. It is used to query current status, change
27     configuration and request interactive user input.</para>
28
29     <para>wpa_gui supports (almost) all of the interactive status and
30     configuration features of the command line client, wpa_cli. Refer
31     to the wpa_cli manpage for a comprehensive list of the
32     interactive mode features.</para>
33   </refsect1>
34   <refsect1>
35     <title>Command Arguments</title>
36     <variablelist>
37       <varlistentry>
38         <term>-p path</term>
39
40         <listitem><para>Change the path where control sockets should
41         be found.</para></listitem>
42       </varlistentry>
43
44       <varlistentry>
45         <term>-i ifname</term>
46
47         <listitem><para>Specify the interface that is being
48         configured. By default, choose the first interface found with
49         a control socket in the socket path.</para></listitem>
50       </varlistentry>
51     </variablelist>
52   </refsect1>
53   <refsect1>
54     <title>See Also</title>
55     <para>
56       <citerefentry>
57         <refentrytitle>wpa_cli</refentrytitle>
58         <manvolnum>8</manvolnum>
59       </citerefentry>
60       <citerefentry>
61         <refentrytitle>wpa_supplicant</refentrytitle>
62         <manvolnum>8</manvolnum>
63       </citerefentry>
64     </para>
65   </refsect1>
66   <refsect1>
67     <title>Legal</title>
68     <para>wpa_supplicant is copyright (c) 2003-2007,
69     Jouni Malinen <email>j@w1.fi</email> and
70     contributors.
71     All Rights Reserved.</para>
72
73     <para>This program is dual-licensed under both the GPL version 2
74     and BSD license. Either license may be used at your option.</para>
75   </refsect1>
76 </refentry>