-
Notifications
You must be signed in to change notification settings - Fork 67
Wifi-menu: Multi-interface support and man page. #178
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from 4 commits
d6424e2
eebfa4c
a7b4fed
4286f3f
5cb834a
50b2b4b
a300cae
8a52db6
cada564
acf1c31
19e32dc
7964888
1aca5aa
7e39099
ab52366
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,118 @@ | ||||||||||||
| WIFI-MENU(8) | ||||||||||||
| ============ | ||||||||||||
|
|
||||||||||||
| NAME | ||||||||||||
| ---- | ||||||||||||
| wifi-menu - Interactively connect to a wireless network | ||||||||||||
|
|
||||||||||||
|
|
||||||||||||
| SYNOPSIS | ||||||||||||
| -------- | ||||||||||||
| *wifi-menu* [-o | --obscure] [+INTERFACE+] | ||||||||||||
|
|
||||||||||||
| *wifi-menu* [-h | --help] | ||||||||||||
|
|
||||||||||||
|
|
||||||||||||
| DESCRIPTION | ||||||||||||
| ----------- | ||||||||||||
| *wifi-menu* allows a user to interactively connect to a wireless network | ||||||||||||
| over INTERFACE using a auto-generated netctl profile. If only one | ||||||||||||
|
tetrakist marked this conversation as resolved.
Outdated
|
||||||||||||
| 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. | ||||||||||||
|
tetrakist marked this conversation as resolved.
Outdated
|
||||||||||||
|
|
||||||||||||
| 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: | ||||||||||||
|
tetrakist marked this conversation as resolved.
Outdated
|
||||||||||||
|
|
||||||||||||
| ***:: | ||||||||||||
| An active connect is present. | ||||||||||||
|
|
||||||||||||
| *:*:: | ||||||||||||
| A hand-made profile is present. | ||||||||||||
|
|
||||||||||||
| *.*:: | ||||||||||||
| An automatically-generated profile is present. | ||||||||||||
|
tetrakist marked this conversation as resolved.
Outdated
|
||||||||||||
|
|
||||||||||||
| 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. | ||||||||||||
|
tetrakist marked this conversation as resolved.
Outdated
|
||||||||||||
|
|
||||||||||||
| OPTIONS | ||||||||||||
| ------- | ||||||||||||
|
|
||||||||||||
| *-h, --help*:: | ||||||||||||
| Show help | ||||||||||||
|
tetrakist marked this conversation as resolved.
Outdated
|
||||||||||||
|
|
||||||||||||
| *-o, --obscure*:: | ||||||||||||
| Show asterisks for the characters of the password and store the password | ||||||||||||
| as a hexadecimal string. | ||||||||||||
|
tetrakist marked this conversation as resolved.
Outdated
|
||||||||||||
|
|
||||||||||||
| +INTERFACE+:: | ||||||||||||
| Specifies the wireless network interface to use when connecting to a | ||||||||||||
| wireless network. | ||||||||||||
|
tetrakist marked this conversation as resolved.
Outdated
|
||||||||||||
|
|
||||||||||||
|
|
||||||||||||
| EXIT STATUS | ||||||||||||
| ----------- | ||||||||||||
|
|
||||||||||||
| *0*:: | ||||||||||||
| The interface connected to the wireless network successfully. | ||||||||||||
|
|
||||||||||||
| *1*:: | ||||||||||||
| The connection attempt was cancelled. | ||||||||||||
|
|
||||||||||||
| *2*:: | ||||||||||||
| The connection attempt failed. | ||||||||||||
|
|
||||||||||||
| *3*:: | ||||||||||||
| No wireless networks were found. | ||||||||||||
|
|
||||||||||||
| *4*:: | ||||||||||||
| Invalid passphrase length (WEP keys must be between 8 and 63 characters | ||||||||||||
| in length). | ||||||||||||
|
|
||||||||||||
| *7*:: | ||||||||||||
| An unexpected error code was received. | ||||||||||||
|
|
||||||||||||
| *255*:: | ||||||||||||
| The connection attempt was aborted (or an error occurred). | ||||||||||||
|
tetrakist marked this conversation as resolved.
|
||||||||||||
|
|
||||||||||||
|
|
||||||||||||
| NOTES | ||||||||||||
| ----- | ||||||||||||
| The program may display a black screen for up to a minute when starting a | ||||||||||||
| connection. | ||||||||||||
|
tetrakist marked this conversation as resolved.
Outdated
Comment on lines
+71
to
+72
Owner
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I believe this one got lost somewhere. If you disagree with my preference to make 'minute' refer less to a specific unit of time, I'd like to hear why.
Suggested change
|
||||||||||||
|
|
||||||||||||
|
Owner
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Maybe here? I'd appreciate your comments. Rather than me just adding a commit on top of yours, I think it is nice to make this part of your commit.
Suggested change
|
||||||||||||
|
|
||||||||||||
| 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. | ||||||||||||
|
tetrakist marked this conversation as resolved.
Outdated
|
||||||||||||
|
|
||||||||||||
|
|
||||||||||||
| ENVIRONMENT | ||||||||||||
| ----------- | ||||||||||||
| +$NETCTL_DEBUG+:: | ||||||||||||
| If set to "yes", debugging output is generated. | ||||||||||||
|
tetrakist marked this conversation as resolved.
Outdated
|
||||||||||||
|
|
||||||||||||
|
|
||||||||||||
| FILES | ||||||||||||
| ----- | ||||||||||||
| +/etc/netctl+:: | ||||||||||||
| Directory where created netctl profiles are stored. | ||||||||||||
|
tetrakist marked this conversation as resolved.
Owner
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This one got lost too. Here, 'generated' is more specific than 'created' and 'netctl' is implied.
Suggested change
|
||||||||||||
|
|
||||||||||||
|
|
||||||||||||
| SEE ALSO | ||||||||||||
| -------- | ||||||||||||
| *netctl*(1), *wpa_supplicant*(8), *iwd*(8) | ||||||||||||
|
tetrakist marked this conversation as resolved.
Outdated
tetrakist marked this conversation as resolved.
Outdated
|
||||||||||||
Uh oh!
There was an error while loading. Please reload this page.