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