From d6424e25a888a5104255ecffe0f6a745bff1547b Mon Sep 17 00:00:00 2001 From: tetrakist <65480094+tetrakist@users.noreply.github.com> Date: Tue, 19 May 2020 08:52:14 +0000 Subject: [PATCH 01/15] Create asciidoc for wifi-menu man page. --- docs/wifi-menu.1.txt | 118 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 118 insertions(+) create mode 100644 docs/wifi-menu.1.txt diff --git a/docs/wifi-menu.1.txt b/docs/wifi-menu.1.txt new file mode 100644 index 0000000..150b6c0 --- /dev/null +++ b/docs/wifi-menu.1.txt @@ -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 +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. + +OPTIONS +------- + +*-h, --help*:: + Show help + +*-o, --obscure*:: + Show asterisks for the characters of the password and store the password + as a hexadecimal string. + ++INTERFACE+:: + Specifies the wireless network interface to use when connecting to a + wireless network. + + +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). + + +NOTES +----- +The program may display a black screen for up to a minute when starting a +connection. + + +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). Alternately, lower- +level utilities such as *wpa_supplicant*(8) may be used directly, in +conjunction with *ip*(8) or *dhcpcd*(8) for configuring IP connectivity. + + +ENVIRONMENT +----------- ++$NETCTL_DEBUG*:: + If set to "yes", debugging output is generated. + + +FILES +----- ++/etc/netctl+:: + Directory where created netctl profiles are stored. + + +SEE ALSO +-------- + *netctl*(1), *wpa_supplicant*(8), *iwd*(8) From eebfa4c3880704846ebf3c1b4760d2697b187321 Mon Sep 17 00:00:00 2001 From: tetrakist <65480094+tetrakist@users.noreply.github.com> Date: Tue, 19 May 2020 08:52:53 +0000 Subject: [PATCH 02/15] Add support for multiple interfaces. --- src/wifi-menu | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/src/wifi-menu b/src/wifi-menu index f2030ae..deea167 100755 --- a/src/wifi-menu +++ b/src/wifi-menu @@ -242,13 +242,27 @@ 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 + INTERFACES=(/sys/class/net/*/wireless/) + if [[ ${#INTERFACES[@]} -eq 1 && -d "$INTERFACES" ]]; then + INTERFACE=${INTERFACES:15:-10} + elif [[ ${#INTERFACES[@]} -gt 1 ]]; then + report_debug "Multiple wireless interfaces found: '${INTERFACES[@]}'" + WIRELESS_INTERFACES=() + for WIRELESS_IDX in ${!INTERFACES[@]}; do + if [[ -d ${INTERFACES[$WIRELESS_IDX]} ]]; then + echo $WIRELESS_IDX ${INTERFACES[$WIRELESS_IDX]} + WIRELESS_INTERFACES+=($WIRELESS_IDX ${INTERFACES[$WIRELESS_IDX]:15:-10}) + fi + done + echo Interface: ${WIRELESS_INTERFACES[@]} + IFACE_CHOICE=$(dialog --menu "Select wireless interface you wish to use:" 24 50 12 "${WIRELESS_INTERFACES[@]}" --stdout) + INTERFACE=${INTERFACES[$IFACE_CHOICE]:15:-10} + report_debug "Wireless interface selected: '$INTERFACE'" + else report_error "Invalid interface specification" usage exit 255 fi - INTERFACE=${INTERFACE:15:-10} report_debug "Using interface '$INTERFACE'" elif ! is_interface "$INTERFACE"; then exit_error "No such interface: $INTERFACE" From a7b4fed6e77d6055f34cd57017a692ccaa0fea6d Mon Sep 17 00:00:00 2001 From: Tetrakist <> Date: Tue, 19 May 2020 02:19:20 -0700 Subject: [PATCH 03/15] Renamed asciidoc file and corrected errors. --- docs/Makefile | 2 +- docs/wifi-menu.1.txt | 118 ------------------------------------------- 2 files changed, 1 insertion(+), 119 deletions(-) delete mode 100644 docs/wifi-menu.1.txt diff --git a/docs/Makefile b/docs/Makefile index 4da4a11..79a62b8 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -1,6 +1,6 @@ # Makefile for netctl documentation -MANPAGES = netctl.1 netctl-auto.1 netctl.profile.5 netctl.special.7 +MANPAGES = netctl.1 netctl-auto.1 netctl.profile.5 netctl.special.7 wifi-menu.8 .PHONY: manpages install $(MANPAGES:=-install) clean diff --git a/docs/wifi-menu.1.txt b/docs/wifi-menu.1.txt deleted file mode 100644 index 150b6c0..0000000 --- a/docs/wifi-menu.1.txt +++ /dev/null @@ -1,118 +0,0 @@ -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 -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. - -OPTIONS -------- - -*-h, --help*:: - Show help - -*-o, --obscure*:: - Show asterisks for the characters of the password and store the password - as a hexadecimal string. - -+INTERFACE+:: - Specifies the wireless network interface to use when connecting to a - wireless network. - - -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). - - -NOTES ------ -The program may display a black screen for up to a minute when starting a -connection. - - -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). Alternately, lower- -level utilities such as *wpa_supplicant*(8) may be used directly, in -conjunction with *ip*(8) or *dhcpcd*(8) for configuring IP connectivity. - - -ENVIRONMENT ------------ -+$NETCTL_DEBUG*:: - If set to "yes", debugging output is generated. - - -FILES ------ -+/etc/netctl+:: - Directory where created netctl profiles are stored. - - -SEE ALSO --------- - *netctl*(1), *wpa_supplicant*(8), *iwd*(8) From 4286f3f44da27b82a3f249e2f512d43040927dd2 Mon Sep 17 00:00:00 2001 From: Tetrakist <> Date: Tue, 19 May 2020 02:19:41 -0700 Subject: [PATCH 04/15] Add renamed wifi-menu ascii doc file. --- docs/wifi-menu.8.txt | 118 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 118 insertions(+) create mode 100644 docs/wifi-menu.8.txt diff --git a/docs/wifi-menu.8.txt b/docs/wifi-menu.8.txt new file mode 100644 index 0000000..6b22883 --- /dev/null +++ b/docs/wifi-menu.8.txt @@ -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 +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. + +OPTIONS +------- + +*-h, --help*:: + Show help + +*-o, --obscure*:: + Show asterisks for the characters of the password and store the password + as a hexadecimal string. + ++INTERFACE+:: + Specifies the wireless network interface to use when connecting to a + wireless network. + + +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). + + +NOTES +----- +The program may display a black screen for up to a minute when starting a +connection. + + +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. + + +ENVIRONMENT +----------- ++$NETCTL_DEBUG+:: + If set to "yes", debugging output is generated. + + +FILES +----- ++/etc/netctl+:: + Directory where created netctl profiles are stored. + + +SEE ALSO +-------- +*netctl*(1), *wpa_supplicant*(8), *iwd*(8) From 5cb834a38b9d7f47861795613bf4686901f5475a Mon Sep 17 00:00:00 2001 From: Tetrakist <> Date: Thu, 21 May 2020 11:03:58 -0700 Subject: [PATCH 05/15] Clean up code for wireless interface selection --- src/wifi-menu | 21 ++++++--------------- 1 file changed, 6 insertions(+), 15 deletions(-) diff --git a/src/wifi-menu b/src/wifi-menu index deea167..7f16fb3 100755 --- a/src/wifi-menu +++ b/src/wifi-menu @@ -243,23 +243,14 @@ cd / # We do not want to spawn anything that can block unmounting INTERFACE=$1 if [[ -z "$INTERFACE" ]]; then INTERFACES=(/sys/class/net/*/wireless/) - if [[ ${#INTERFACES[@]} -eq 1 && -d "$INTERFACES" ]]; then - INTERFACE=${INTERFACES:15:-10} - elif [[ ${#INTERFACES[@]} -gt 1 ]]; then + if [[ ${#INTERFACES[@]} -gt 1 ]]; then report_debug "Multiple wireless interfaces found: '${INTERFACES[@]}'" - WIRELESS_INTERFACES=() - for WIRELESS_IDX in ${!INTERFACES[@]}; do - if [[ -d ${INTERFACES[$WIRELESS_IDX]} ]]; then - echo $WIRELESS_IDX ${INTERFACES[$WIRELESS_IDX]} - WIRELESS_INTERFACES+=($WIRELESS_IDX ${INTERFACES[$WIRELESS_IDX]:15:-10}) - fi - done - echo Interface: ${WIRELESS_INTERFACES[@]} - IFACE_CHOICE=$(dialog --menu "Select wireless interface you wish to use:" 24 50 12 "${WIRELESS_INTERFACES[@]}" --stdout) - INTERFACE=${INTERFACES[$IFACE_CHOICE]:15:-10} - report_debug "Wireless interface selected: '$INTERFACE'" + INTERFACE_LIST=$(for IFACE in ${INTERFACES[@]}; do echo ${IFACE:15:-10}; done) + INTERFACE=$(dialog --no-items --menu "Select wireless interface you wish to use:" 13 50 12 $INTERFACE_LIST --stdout) + elif [[ -d "$INTERFACES" ]]; then + INTERFACE=${INTERFACES:15:-10} else - report_error "Invalid interface specification" + report_error "No wireless interfaces found" usage exit 255 fi From 50b2b4ba307bf309ab0d553aff0cc08c0b69aed1 Mon Sep 17 00:00:00 2001 From: tetrakist <65480094+tetrakist@users.noreply.github.com> Date: Tue, 26 May 2020 17:39:42 +0000 Subject: [PATCH 06/15] Update docs/wifi-menu.8.txt Better phrasing on --help option description. Co-authored-by: Jouke Witteveen --- docs/wifi-menu.8.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/wifi-menu.8.txt b/docs/wifi-menu.8.txt index 6b22883..b240239 100644 --- a/docs/wifi-menu.8.txt +++ b/docs/wifi-menu.8.txt @@ -48,7 +48,7 @@ OPTIONS ------- *-h, --help*:: - Show help + Print a short help text and exit. *-o, --obscure*:: Show asterisks for the characters of the password and store the password From a300caebb24a67a53eee80c8ff286848e9581f9c Mon Sep 17 00:00:00 2001 From: tetrakist <65480094+tetrakist@users.noreply.github.com> Date: Tue, 26 May 2020 17:40:58 +0000 Subject: [PATCH 07/15] better formatting in docs/wifi-menu.8.txt Co-authored-by: Jouke Witteveen --- docs/wifi-menu.8.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/wifi-menu.8.txt b/docs/wifi-menu.8.txt index b240239..9a3678e 100644 --- a/docs/wifi-menu.8.txt +++ b/docs/wifi-menu.8.txt @@ -104,7 +104,7 @@ utilities such as *wpa_supplicant*(8) directly, along with *ip*(8) or ENVIRONMENT ----------- +$NETCTL_DEBUG+:: - If set to "yes", debugging output is generated. + If set to +"yes"+, debugging output is generated. FILES From 8a52db60bb6a49173f4e0cff71a8b553793e7e31 Mon Sep 17 00:00:00 2001 From: tetrakist <65480094+tetrakist@users.noreply.github.com> Date: Tue, 26 May 2020 17:41:32 +0000 Subject: [PATCH 08/15] Better phrasing for file location in docs/wifi-menu.8.txt Co-authored-by: Jouke Witteveen --- docs/wifi-menu.8.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/wifi-menu.8.txt b/docs/wifi-menu.8.txt index 9a3678e..124acbc 100644 --- a/docs/wifi-menu.8.txt +++ b/docs/wifi-menu.8.txt @@ -110,7 +110,7 @@ ENVIRONMENT FILES ----- +/etc/netctl+:: - Directory where created netctl profiles are stored. + Directory where generated profiles are stored. SEE ALSO From cada564a21d7d36fbd8845200fbe9c515d4bade8 Mon Sep 17 00:00:00 2001 From: tetrakist <65480094+tetrakist@users.noreply.github.com> Date: Tue, 26 May 2020 18:06:55 +0000 Subject: [PATCH 09/15] Simplify interface option description in docs/wifi-menu.8.txt Co-authored-by: Jouke Witteveen --- docs/wifi-menu.8.txt | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/wifi-menu.8.txt b/docs/wifi-menu.8.txt index 124acbc..a306a8f 100644 --- a/docs/wifi-menu.8.txt +++ b/docs/wifi-menu.8.txt @@ -55,8 +55,7 @@ OPTIONS as a hexadecimal string. +INTERFACE+:: - Specifies the wireless network interface to use when connecting to a - wireless network. + The wireless network interface to use for connecting. EXIT STATUS From acf1c31f9434b4af97c9effda7ef213b64b70afe Mon Sep 17 00:00:00 2001 From: tetrakist <65480094+tetrakist@users.noreply.github.com> Date: Tue, 26 May 2020 18:08:05 +0000 Subject: [PATCH 10/15] Eliminate unneeded See-Alsos from docs/wifi-menu.8.txt Co-authored-by: Jouke Witteveen --- docs/wifi-menu.8.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/wifi-menu.8.txt b/docs/wifi-menu.8.txt index a306a8f..86e4c9c 100644 --- a/docs/wifi-menu.8.txt +++ b/docs/wifi-menu.8.txt @@ -114,4 +114,4 @@ FILES SEE ALSO -------- -*netctl*(1), *wpa_supplicant*(8), *iwd*(8) +*netctl*(1), *netctl-auto*(1) From 19e32dcc094feba413dff2f8baba5c7d5587c9e5 Mon Sep 17 00:00:00 2001 From: tetrakist <65480094+tetrakist@users.noreply.github.com> Date: Tue, 26 May 2020 18:10:16 +0000 Subject: [PATCH 11/15] Maintain interface dimensions in src/wifi-menu Co-authored-by: Jouke Witteveen --- src/wifi-menu | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/src/wifi-menu b/src/wifi-menu index 7f16fb3..62e25c7 100755 --- a/src/wifi-menu +++ b/src/wifi-menu @@ -244,9 +244,10 @@ INTERFACE=$1 if [[ -z "$INTERFACE" ]]; then INTERFACES=(/sys/class/net/*/wireless/) if [[ ${#INTERFACES[@]} -gt 1 ]]; then - report_debug "Multiple wireless interfaces found: '${INTERFACES[@]}'" - INTERFACE_LIST=$(for IFACE in ${INTERFACES[@]}; do echo ${IFACE:15:-10}; done) - INTERFACE=$(dialog --no-items --menu "Select wireless interface you wish to use:" 13 50 12 $INTERFACE_LIST --stdout) + 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 From 7964888d4f6f92837ccc7de168fc5df4cfe1649b Mon Sep 17 00:00:00 2001 From: tetrakist <65480094+tetrakist@users.noreply.github.com> Date: Tue, 26 May 2020 18:13:26 +0000 Subject: [PATCH 12/15] Better wording about connecting in docs/wifi-menu.8.txt Co-authored-by: Jouke Witteveen --- docs/wifi-menu.8.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/wifi-menu.8.txt b/docs/wifi-menu.8.txt index 86e4c9c..483e0b3 100644 --- a/docs/wifi-menu.8.txt +++ b/docs/wifi-menu.8.txt @@ -86,8 +86,8 @@ EXIT STATUS NOTES ----- -The program may display a black screen for up to a minute when starting a -connection. +Establishing a connection may take a minute. While establishing a connection, +nothing is shown on screen. BUGS From 1aca5aa5bbf681d27ad0e5a0b7b16f07943fc2fc Mon Sep 17 00:00:00 2001 From: Tetrakist Date: Tue, 26 May 2020 12:09:12 -0700 Subject: [PATCH 13/15] Improved --obscure description --- docs/wifi-menu.8.txt | 4 ++-- src/wifi-menu | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/wifi-menu.8.txt b/docs/wifi-menu.8.txt index 483e0b3..ce4b3e8 100644 --- a/docs/wifi-menu.8.txt +++ b/docs/wifi-menu.8.txt @@ -51,8 +51,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. diff --git a/src/wifi-menu b/src/wifi-menu index 62e25c7..8dc8532 100755 --- a/src/wifi-menu +++ b/src/wifi-menu @@ -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 } From 7e39099b4285c8c2ede5c61024af3c44e58c6b78 Mon Sep 17 00:00:00 2001 From: Tetrakist Date: Tue, 26 May 2020 12:11:49 -0700 Subject: [PATCH 14/15] Remove Bugs section and simplify Description in wifi-menu.8.txt --- docs/wifi-menu.8.txt | 46 +++++++++----------------------------------- 1 file changed, 9 insertions(+), 37 deletions(-) diff --git a/docs/wifi-menu.8.txt b/docs/wifi-menu.8.txt index ce4b3e8..6ad853e 100644 --- a/docs/wifi-menu.8.txt +++ b/docs/wifi-menu.8.txt @@ -16,33 +16,15 @@ 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. +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 ------- @@ -90,16 +72,6 @@ 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. - - ENVIRONMENT ----------- +$NETCTL_DEBUG+:: From ab52366dac3a8348df395c405561d57ef7c3e242 Mon Sep 17 00:00:00 2001 From: Tetrakist Date: Tue, 26 May 2020 12:15:04 -0700 Subject: [PATCH 15/15] Update phrasing for NOTES and FILES sections in wifi-menu.8.txt --- docs/wifi-menu.8.txt | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/wifi-menu.8.txt b/docs/wifi-menu.8.txt index 6ad853e..937010a 100644 --- a/docs/wifi-menu.8.txt +++ b/docs/wifi-menu.8.txt @@ -15,7 +15,7 @@ SYNOPSIS DESCRIPTION ----------- -*wifi-menu* allows a user to interactively connect to a wireless network +*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 @@ -68,8 +68,8 @@ EXIT STATUS NOTES ----- -Establishing a connection may take a minute. While establishing a connection, -nothing is shown on screen. +The program may display a black screen for up to a minute when starting a +connection. ENVIRONMENT @@ -81,7 +81,7 @@ ENVIRONMENT FILES ----- +/etc/netctl+:: - Directory where generated profiles are stored. + Directory where created netctl profiles are stored. SEE ALSO