documentation cleanup

8821cu.conf

@@ -43,7 +43,7 @@ options 8821cu rtw_drv_log_level=1 rtw_led_ctrl=1 rtw_vht_enable=1 rtw_power_mgn
 #
 # sudo ./save-log.sh
 #
-# Note: The name of the log file will be ```rtw.log```.
+# Note: The name of the log file will be `rtw.log`.
 #
 # -----
 #

LICENSE

@@ -1,6 +1,6 @@
 /******************************************************************************
  *
- * Copyright(c) 2007 - 2022 Realtek Corporation.
+ * Copyright(c) 2007 - 2023 Realtek Corporation.
  *
  * This program is free software; you can redistribute it and/or modify it
  * under the terms of version 2 of the GNU General Public License as

README.md

@@ -385,6 +385,12 @@ Note: For automated builds (non-interactive), use `NoPrompt` as an option.
 sudo ./install-driver.sh
 ```
 
+or
+
+```
+sudo sh install-driver.sh
+```
+
 Note: If you elect to skip the reboot at the end of the installation
 script, the driver may not load immediately and the driver options will
 not be applied. Rebooting is strongly recommended.
@@ -396,9 +402,9 @@ enroll the key:
 sudo mokutil --import /var/lib/dkms/mok.pub
 ```
 
-Manual build instructions: The above script automates the installation
+Manual build and installation instructions: The above installation steps
-process, however, if you want to or need to do a command line
+automate the installation process, however, if you want to or need to do a
-installation, use the following:
+command line installation, use the following:
 
 ```
 make clean
@@ -407,7 +413,14 @@ sudo make install
 sudo reboot
 ```
 
-Note: If you use the manual build instructions, you will need to repeat
+To remove the driver if installed by the manual installation instructions:
+
+```
+sudo make uninstall
+sudo reboot
+```
+
+Note: If you use the manual installation instructions, you will need to repeat
 the process each time a new kernel is installed in your distro.
 
 -----
@@ -415,7 +428,7 @@ the process each time a new kernel is installed in your distro.
 ### Driver Options (`edit-options.sh`)
 
 A file called `8821cu.conf` will be installed in `/etc/modprobe.d` by
-default if you use the `./install-driver.sh` script.
+default if you use the `install-driver.sh` script.
 
 Note: The installation script will prompt you to edit the options.
 
@@ -556,6 +569,8 @@ dtoverlay=disable-wifi
 sudo ${EDITOR} /etc/wpa_supplicant/wpa_supplicant.conf
 ```
 
+Note: Replace ${EDITOR} with the name of the text editor you wish to use.
+
 #### Step 2: Delete the relevant WiFi network block (including the '`network=`' and opening/closing braces).
 
 #### Step 3: Press ctrl-x followed by '`y`' and enter to save the file.
@@ -661,7 +676,7 @@ reports of success or failure are needed. If you have yet to buy an
 adapter to use with monitor mode, there are adapters available that are
 known to work very well with monitor mode. My recommendation for those
 looking to buy an adapter for monitor mode is to buy adapters based on
-the following chipsets: mt7921au, mt7612u, mt7610u, rtl8812au and
+the following chipsets: mt7921au, mt7612u, mt7610u, rtl8812au, rtl8821cu and
 rtl8811au. My specific recommendations for adapters in order of
 preference are:
 

docs/alpha-2_Country_Codes

@@ -0,0 +1,604 @@
+2023-01-26
+
+Note: The following information may not work on all distros.
+
+Instructions for setting the ISO 3166-1 alpha-2 Country Code in your Linux
+distro. If it is not set, you may have problems using some channels, especially
+5 Ghz and 6 GHz channels. To set your Country Code from the command line
+interface:
+
+Note: Package "iw" must be installed.
+
+```
+sudo iw reg set XX
+```
+
+Where XX is the country code for your country. See the list of country codes
+below.
+
+To check if your country code is properly set:
+
+```
+iw reg get
+```
+
+```
+ISO 3166-1 alpha-2 Country Codes
+
+Code	Name
+
+AF		Afghanistan
+
+AX		Aland Islands
+
+AL		Albania
+
+DZ		Algeria
+
+AS		American Samoa
+
+AD		Andorra
+
+AO		Angola
+
+AI		Anguilla
+
+AQ		Antarctica
+
+AG		Antigua and Barbuda
+
+Argentina			AR
+
+Armenia				AM
+
+Aruba				AW
+
+Australia			AU
+
+Austria				AT
+
+Azerbaijan			AZ
+
+Bahamas				BS
+
+Bahrain				BH
+
+Bangladesh			BD
+
+Barbados			BB
+
+Belarus				BY
+
+Belgium				BE
+
+Belize				BZ
+
+Benin				BJ
+
+Bermuda				BM
+
+Bhutan				BT
+
+Bolivia				BO
+
+Bonaire, Sint
+Eustatius and
+Saba				BQ
+
+Bosnia and
+Herzegovina			BA
+
+Botswana			BW
+
+Bouvet
+Island				BV
+
+Brazil				BR
+
+British Indian
+Ocean
+Territory			IO
+
+Brunei
+Darussalam			BN
+
+Bulgaria			BG
+
+Burkina
+Faso				BF
+
+Burundi				BI
+
+Cambodia			KH
+
+Cameroon			CM
+
+Canada				CA
+
+Cape Verde			CV
+
+Cayman
+Islands				KY
+
+Central
+African
+Republic			CF
+
+Chad				TD
+
+Chile				CL
+
+China				CN
+
+Christmas
+Island				CX
+
+Cocos
+(Keeling)
+Islands				CC
+
+Colombia			CO
+
+Comoros				KM
+
+Congo				CG
+
+Congo				CD
+
+Cook
+Islands				CK
+
+Costa Rica			CR
+
+Côte
+d'Ivoire			CI
+
+Croatia				HR
+
+Cuba				CU
+
+Curaçao				CW
+
+Cyprus				CY
+
+Czech
+Republic			CZ
+
+Denmark				DK
+
+Djibouti			DJ
+
+Dominica			DM
+
+Dominican
+Republic			DO
+
+Ecuador				EC
+
+Egypt				EG
+
+El Salvador			SV
+
+Equatorial
+Guinea				GQ
+
+Eritrea				ER
+
+Estonia				EE
+
+Ethiopia			ET
+
+Falkland
+Islands
+(Malvinas)			FK
+
+Faroe
+Islands				FO
+
+Fiji				FJ
+
+Finland				FI
+
+France				FR
+
+French
+Guiana				GF
+
+French
+Polynesia			PF
+
+French
+Southern
+Territories			TF
+
+Gabon				GA
+
+Gambia				GM
+
+Georgia				GE
+
+Germany				DE
+
+Ghana				GH
+
+Gibraltar			GI
+
+Greece				GR
+
+Greenland			GL
+
+Grenada				GD
+
+Guadeloupe			GP
+
+Guam				GU
+
+Guatemala			GT
+
+Guernsey			GG
+
+Guinea				GN
+
+Guinea-
+Bissau				GW
+
+Guyana				GY
+
+Haiti				HT
+
+Heard Island
+and
+McDonald
+Islands				HM
+
+Holy See
+(Vatican City
+State)				VA
+
+Honduras			HN
+
+Hong Kong			HK
+
+Hungary				HU
+
+Iceland				IS
+
+India				IN
+
+Indonesia			ID
+
+Iran, Islamic
+Republic of			IR
+
+Iraq				IQ
+
+Ireland				IE
+
+Isle of Man			IM
+
+Israel				IL
+
+Italy				IT
+
+Jamaica				JM
+
+Japan				JP
+
+Jersey				JE
+
+Jordan				JO
+
+Kazakhstan			KZ
+
+Kenya				KE
+
+Kiribati			KI
+
+Korea,
+Democratic
+People's
+Republic of			KP
+
+Korea,
+Republic of			KR
+
+Kuwait				KW
+
+Kyrgyzstan			KG
+
+Lao People's
+Democratic
+Republic			LA
+
+Latvia				LV
+
+Lebanon				LB
+
+Lesotho				LS
+
+Liberia				LR
+
+Libya				LY
+
+LI		Liechtenstein
+
+Lithuania			LT
+
+Luxembourg			LU
+
+Macao				MO
+
+Macedonia,
+the Former
+Yugoslav
+Republic of			MK
+
+Madagascar			MG
+
+Malawi				MW
+
+Malaysia			MY
+
+Maldives			MV
+
+Mali				ML
+
+Malta				MT
+
+Marshall
+Islands				MH
+
+Martinique			MQ
+
+Mauritania			MR
+
+Mauritius			MU
+
+Mayotte				YT
+
+Mexico				MX
+
+Micronesia,
+Federated
+States of			FM
+
+Moldova,
+Republic of			MD
+
+Monaco				MC
+
+Mongolia			MN
+
+Montenegro			ME
+
+Montserrat			MS
+
+Morocco				MA
+
+Mozambique			MZ
+
+Myanmar				MM
+
+Namibia				NA
+
+Nauru				NR
+
+Nepal				NP
+
+Netherlands			NL
+
+New
+Caledonia			NC
+
+New Zealand			NZ
+
+Nicaragua			NI
+
+Niger				NE
+
+Nigeria				NG
+
+Niue				NU
+
+NF		Norfolk Island
+
+Northern
+Mariana
+Islands				MP
+
+Norway				NO
+
+><
+
+Oman				OM
+
+Pakistan			PK
+
+Palau				PW
+
+Palestine			PS
+
+Panama				PA
+
+Papua New
+Guinea				PG
+
+Paraguay			PY
+
+Peru				PE
+
+Philippines			PH
+
+Pitcairn			PN
+
+Poland				PL
+
+Portugal			PT
+
+Puerto Rico			PR
+
+Qatar				QA
+
+Réunion				RE
+
+Romania				RO
+
+Russia				RU
+
+Rwanda				RW
+
+Saint
+Barthélemy			BL
+
+Saint Helena,
+Ascension
+and Tristan
+da Cunha			SH
+
+Saint Kitts
+and Nevis			KN
+
+Saint Lucia			LC
+
+MF		Saint Martin (French part)
+
+PM		Saint Pierre and Miquelon
+
+Saint Vincent
+and the
+Grenadines			VC
+
+Samoa				WS
+
+San Marino			SM
+
+ST		Sao Tome and Principe
+
+SA		Saudi Arabia
+
+Senegal				SN
+
+Serbia				RS
+
+Seychelles			SC
+
+SL		Sierra Leone
+
+Singapore			SG
+
+SX		Sint Maarten (Dutch part)
+
+Slovakia			SK
+
+Slovenia			SI
+
+Solomon
+Islands				SB
+
+Somalia				SO
+
+ZA		South Africa
+
+South
+Georgia and
+the South
+Sandwich
+Islands				GS
+
+South Sudan			SS
+
+Spain				ES
+
+Sri Lanka			LK
+
+Sudan				SD
+
+Suriname			SR
+
+Svalbard and
+Jan Mayen			SJ
+
+Swaziland			SZ
+
+Sweden				SE
+
+Switzerland			CH
+
+Syrian Arab
+Republic			SY
+
+Taiwan				TW
+
+Tajikistan			TJ
+
+Tanzania,
+United
+Republic of			TZ
+
+Thailand			TH
+
+Timor-Leste			TL
+
+Togo				TG
+
+Tokelau				TK
+
+Tonga				TO
+
+Trinidad and
+Tobago				TT
+
+Tunisia				TN
+
+Turkey				TR
+
+TM		Turkmenistan
+
+Turks and
+Caicos
+Islands				TC
+
+Tuvalu				TV
+
+Uganda				UG
+
+Ukraine				UA
+
+United Arab
+Emirates			AE
+
+GB		United Kingdom
+
+US		United States
+
+United States
+Minor
+Outlying
+Islands				UM
+
+Uruguay				UY
+
+Uzbekistan			UZ
+
+Vanuatu				VU
+
+Venezuela			VE
+
+Viet Nam			VN
+
+Virgin Islands,
+British				VG
+
+VI      Virgin Islands, U.S.
+
+WF		Wallis and Futuna
+
+EH		Western Sahara
+
+YE		Yemen
+
+ZM		Zambia
+
+ZW		Zimbabwe
+
+```

edit-options.sh

@@ -41,7 +41,7 @@ for TEXT_EDITOR in "${VISUAL}" "${EDITOR}" "${DEFAULT_EDITOR}" vi; do
 done
 # failure message if no editor was found
 if ! command -v "${TEXT_EDITOR}" >/dev/null 2>&1; then
-        echo "No text editor found (default: ${DEFAULT_EDITOR})."
+        echo "No text editor was found (default: ${DEFAULT_EDITOR})."
         echo "Please install ${DEFAULT_EDITOR} or edit the file 'default-editor.txt' to specify your editor."
         echo "Once complete, please run \"sudo ./${SCRIPT_NAME}\""
         exit 1

install-driver.sh

@@ -164,9 +164,10 @@ if command -v mokutil >/dev/null 2>&1; then
 	echo ": ""${sb_state}"
 fi
 
+# needs work
 # display ISO 3166-1 alpha-2 Country Code
-a2_country_code=$(iw reg get | grep -i country)
+#a2_country_code=$(iw reg get | grep -i country)
-echo ": Location: ""${a2_country_code}"
+#echo ": Location: ""${a2_country_code}"
 #if [[ $a2_country_code == *"00"* ]];
 #then
 #    echo "The Country Code may not be properly set."

save-log.sh

@@ -1,7 +1,5 @@
 #!/bin/sh
-#
+
-SCRIPT_NAME="save-log.sh"
-#
 # Purpose: Save a log file with RTW lines only.
 #
 # To make this file executable:
@@ -11,7 +9,9 @@ SCRIPT_NAME="save-log.sh"
 # To execute this file:
 #
 # $ sudo ./edit-options.sh
-#
+
+SCRIPT_NAME="save-log.sh"
+
 if [ "$(id -u)" -ne 0 ]; then
 	echo "You must run this script with superuser (root) privileges."
 	echo "Try: \"sudo ./${SCRIPT_NAME}\""