-
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 all 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,89 @@ | ||||||||||||
| 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 an existing netctl profile, or an automatically | ||||||||||||
| generated profile for basic configurations. If only one wireless | ||||||||||||
|
Comment on lines
+19
to
+20
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. The fact that only basic configurations are supported for generating profiles is already stressed in the next paragraph. No need to state it twice.
Suggested change
(pending reflow to the proper number of columns) |
||||||||||||
| interface is available, INTERFACE can be omitted. If no interface is | ||||||||||||
|
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.
Suggested change
(for consistency) |
||||||||||||
| 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. | ||||||||||||
|
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.
Suggested change
This man-page is about wifi-menu, so we assume the intent is to use netctl. |
||||||||||||
|
|
||||||||||||
| OPTIONS | ||||||||||||
| ------- | ||||||||||||
|
|
||||||||||||
| *-h, --help*:: | ||||||||||||
| Print a short help text and exit. | ||||||||||||
|
|
||||||||||||
| *-o, --obscure*:: | ||||||||||||
| Do not echo password, and store derived pre-shared key | ||||||||||||
| in profile instead of plaintext password. | ||||||||||||
|
Comment on lines
+36
to
+37
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.
Ah, thanks for this remark! That reminds me of why I chose this wording. The 'do not echo' wording applies more to what you see for instance when you type your password on a login terminal (i.e. nothing at all).
Suggested change
|
||||||||||||
|
|
||||||||||||
| +INTERFACE+:: | ||||||||||||
| The wireless network interface to use for connecting. | ||||||||||||
|
|
||||||||||||
|
|
||||||||||||
| 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. | ||||||||||||
|
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
|
||||||||||||
|
|
||||||||||||
| ENVIRONMENT | ||||||||||||
| ----------- | ||||||||||||
| +$NETCTL_DEBUG+:: | ||||||||||||
| If set to +"yes"+, debugging output is generated. | ||||||||||||
|
|
||||||||||||
|
|
||||||||||||
| 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), *netctl-auto*(1) | ||||||||||||
| 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. | ||||||||||
|
Comment on lines
+18
to
+19
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. Sorry about this ;-).
Suggested change
|
||||||||||
| END | ||||||||||
| } | ||||||||||
|
|
||||||||||
|
|
@@ -242,13 +242,19 @@ cd / # We do not want to spawn anything that can block unmounting | |||||||||
|
|
||||||||||
| INTERFACE=$1 | ||||||||||
| if [[ -z "$INTERFACE" ]]; then | ||||||||||
| INTERFACE=(/sys/class/net/*/wireless/) | ||||||||||
| if [[ ${#INTERFACE[@]} -ne 1 || ! -d "$INTERFACE" ]]; then | ||||||||||
| report_error "Invalid interface specification" | ||||||||||
| INTERFACES=(/sys/class/net/*/wireless/) | ||||||||||
| if [[ ${#INTERFACES[@]} -gt 1 ]]; then | ||||||||||
| INTERFACES=$(for INTERFACE in ${INTERFACES[@]}; do | ||||||||||
| echo ${INTERFACE:15:-10} | ||||||||||
| done) | ||||||||||
| INTERFACE=$(dialog --no-items --menu "Select the interface you wish to use" 24 50 12 $INTERFACES --stdout) | ||||||||||
| elif [[ -d "$INTERFACES" ]]; then | ||||||||||
| INTERFACE=${INTERFACES:15:-10} | ||||||||||
| else | ||||||||||
| report_error "No wireless interfaces found" | ||||||||||
| usage | ||||||||||
| exit 255 | ||||||||||
| fi | ||||||||||
| INTERFACE=${INTERFACE:15:-10} | ||||||||||
|
tetrakist marked this conversation as resolved.
|
||||||||||
| report_debug "Using interface '$INTERFACE'" | ||||||||||
| elif ! is_interface "$INTERFACE"; then | ||||||||||
| exit_error "No such interface: $INTERFACE" | ||||||||||
|
|
||||||||||
Uh oh!
There was an error while loading. Please reload this page.