Skip to content

Commit

Permalink
Clean up wifi-menu man page per suggestions.
Browse files Browse the repository at this point in the history
  • Loading branch information
admash committed May 26, 2020
1 parent 7964888 commit c46add5
Showing 2 changed files with 17 additions and 45 deletions.
58 changes: 15 additions & 43 deletions docs/wifi-menu.8.txt
Original file line number Diff line number Diff line change
@@ -15,34 +15,16 @@ SYNOPSIS

DESCRIPTION
-----------
*wifi-menu* allows a user to interactively connect to a wireless network
over INTERFACE using a auto-generated netctl profile. If only one
wireless interface is available, INTERFACE can be omitted. Additionally,
if INTERFACE is omitted and more than one wireless interface is found,
the user is prompted to select which interface should be used.

Once a valid interface is specified, wifi-menu uses *wpa_supplicant*(8)
to scan for available wireless networks, and presents the results to the
user in a menu. Entries are marked with one of the following flags to
indicate their status:

***::
An active connect is present.

*:*::
A hand-made profile is present.

*.*::
An automatically-generated profile is present.

If a network is selected that already has a profile, the profile is
immediately started with no further interaction. However, if the selected
network lacks a profile, the user is given the option of accepting or
changing the provided profile name. Next, if the selected network is
encrypted, the user is prompted to enter a passphrase or pre-shared key,
as appropriate. Once this is done, a *netctl*(1) profile is created and
then started. If the connection is successful, the program exits; if
unsuccessful, the user is asked whether the profile should still be saved.
*wifi-menu* allows a user to interactively connect to a wireless network
over INTERFACE using an existing netctl profile, or an automatically
generated profile for basic configurations. If only one wireless
interface is available, INTERFACE can be omitted. If no interface is
specified and more than one is detected, a choice of interfaces is
offered.

*wifi-menu* is only able to generate netctl profiles for simple network
configurations. Profiles for more complex configurations must be set up
manually, or through the use of other tools.

OPTIONS
-------
@@ -51,8 +33,8 @@ OPTIONS
Print a short help text and exit.

*-o, --obscure*::
Show asterisks for the characters of the password and store the password
as a hexadecimal string.
Do not echo password, and store derived pre-shared key
in profile instead of plaintext password.

+INTERFACE+::
The wireless network interface to use for connecting.
@@ -86,18 +68,8 @@ EXIT STATUS

NOTES
-----
Establishing a connection may take a minute. While establishing a connection,
nothing is shown on screen.


BUGS
----
This program is not capable of setting up and establishing connections that
require configurations more complex than the specification of a passphrase.
In such situations, one should manually configure and establish the
connection using a network manager such as *netctl*(1), or use lower-level
utilities such as *wpa_supplicant*(8) directly, along with *ip*(8) or
*dhcpcd*(8) for configuring IP connectivity.
The program may display a black screen for up to a minute when starting a
connection.


ENVIRONMENT
@@ -109,7 +81,7 @@ ENVIRONMENT
FILES
-----
+/etc/netctl+::
Directory where generated profiles are stored.
Directory where created netctl profiles are stored.


SEE ALSO
4 changes: 2 additions & 2 deletions src/wifi-menu
Original file line number Diff line number Diff line change
@@ -15,8 +15,8 @@ If only one wireless interface is available, INTERFACE can be omitted.
Arguments:
-h, --help Show this help
-o, --obscure Show asterisks for the characters of the password
and store the password as a hexadecimal string
-o, --obscure Do not echo password, and store derived pre-shared
key in profile instead of plaintext password.
END
}

0 comments on commit c46add5

Please sign in to comment.