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