Capitalize and add period to all alias descriptions

adrianbartyczak · adrianbartyczak · commit acd69a2cff54 · 2018-01-23T22:38:38.000-06:00
diff --git a/aliases/file_management-output_only/directory_information/directory-context-information-retrieval.aliases b/aliases/file_management-output_only/directory_information/directory-context-information-retrieval.aliases
@@ -6,5 +6,5 @@
 #   Directory context information retrieval aliases
 # 
 
-alias numfiles='echo "$(ls -1 | wc -l)"'                                         # numfiles: print the number of non-hidden files and directories in the current directory
+alias numfiles='echo "$(ls -1 | wc -l)"'                                         # numfiles: Print the number of non-hidden files and directories in the current directory.
 
diff --git a/aliases/file_management-output_only/file_finding/first-match-file-finding.aliases b/aliases/file_management-output_only/file_finding/first-match-file-finding.aliases
@@ -6,11 +6,11 @@
 #   First match file finding aliases
 # 
 
-fff() { find . -type f -name "*${1}*" -print -quit; }                            # fff: recursively find the first file matching a name; $1: file name
-fdf() { find . -type d -name "*${1}*" -print -quit; }                            # fdf: recursively find the first directory matching a name; $1: directory name
-fffa() { find "$PWD" -type f -name "*${1}*" -print -quit; }                      # fffa: recursively find the first file matching a name and return its absolute path; $1: file name
-fdfa() { find "$PWD" -type d -name "*${1}*" -print -quit; }                      # fdfa: recursively find the first directory matching a name and return its absolute path; $1: directory name
+fff() { find . -type f -name "*${1}*" -print -quit; }                            # fff: Recursively find the first file matching a name; $1: file name.
+fdf() { find . -type d -name "*${1}*" -print -quit; }                            # fdf: Recursively find the first directory matching a name; $1: directory name.
+fffa() { find "$PWD" -type f -name "*${1}*" -print -quit; }                      # fffa: Recursively find the first file matching a name and return its absolute path; $1: file name.
+fdfa() { find "$PWD" -type d -name "*${1}*" -print -quit; }                      # fdfa: Recursively find the first directory matching a name and return its absolute path; $1: directory name.
 
 ffd() { echo "$(find . -type f -name "*${1}*" -exec sh -c 'echo "${1%/*}"; \
-  kill "$PPID"' sh {} \;)" ;}                                                    # ffd: recursively find the first file matching a name and return its parent directory; $1: file name
+  kill "$PPID"' sh {} \;)" ;}                                                    # ffd: Recursively find the first file matching a name and return its parent directory; $1: file name.
 
diff --git a/aliases/file_management-output_only/file_finding/single-step-file-finding.aliases b/aliases/file_management-output_only/file_finding/single-step-file-finding.aliases
@@ -6,6 +6,6 @@
 #   Single step file finding aliases
 # 
 
-ff() { find . -type f -name "*${1}*"; }                                          # ff: recursively find all files matching a name name; $1: file name
-fd() { find . -type d -name "*${1}*"; }                                          # fd: recursively find all directories matching a name name; $1: directory name
+ff() { find . -type f -name "*${1}*"; }                                          # ff: Recursively find all files matching a name name; $1: file name.
+fd() { find . -type d -name "*${1}*"; }                                          # fd: Recursively find all directories matching a name name; $1: directory name.
 
diff --git a/aliases/file_management-output_only/file_finding/text-based-file-finding.aliases b/aliases/file_management-output_only/file_finding/text-based-file-finding.aliases
@@ -6,5 +6,5 @@
 #   Text based file finding aliases
 # 
 
-ffgr() { /usr/bin/grep -l -R "${1}" .; }                                         # ffgr: recursively find all files containing a given text; $1: text to search
+ffgr() { /usr/bin/grep -l -R "${1}" .; }                                         # ffgr: Recursively find all files containing a given text; $1: text to search.
 
diff --git a/aliases/file_management-output_only/file_permission_information/recursive-file-permission-information-retrieval.aliases b/aliases/file_management-output_only/file_permission_information/recursive-file-permission-information-retrieval.aliases
@@ -6,5 +6,5 @@
 #   Recursive file permission information retrieval aliases
 # 
 
-alias ll='command ls -FGlAhp'                                                    # ll: list the permissions and owner of each file in the current directory
+alias ll='command ls -FGlAhp'                                                    # ll: List the permissions and owner of each file in the current directory.
 
diff --git a/aliases/file_management/file_permissions/multiple-permission-change.aliases b/aliases/file_management/file_permissions/multiple-permission-change.aliases
@@ -6,6 +6,6 @@
 #   Multiple permission change aliases
 # 
 
-alias permusergroupreadwrite='chmod ug+rw'                                       # permusergroupreadwrite: give the user and group read and write permissions to a file.
-alias permusergroupreadwritexec='chmod ug+rwx'                                   # permusergroupreadwriteexec: give the user and group read, write and execute permissions to a file.
+alias permusergroupreadwrite='chmod ug+rw'                                       # permusergroupreadwrite: Give the user and group read and write permissions to a file.
+alias permusergroupreadwritexec='chmod ug+rwx'                                   # permusergroupreadwriteexec: Give the user and group read, write and execute permissions to a file.
 
diff --git a/aliases/file_management/file_permissions/single-permission-change.aliases b/aliases/file_management/file_permissions/single-permission-change.aliases
@@ -6,5 +6,5 @@
 #   Single permission change aliases
 # 
 
-alias permreadonly='chmod a-w'                                                   # permreadonly: change the permisson status of a file to read-only
+alias permreadonly='chmod a-w'                                                   # permreadonly: Change the permisson status of a file to read-only.
 
diff --git a/aliases/hardware_management-output_only/power_supply/power-supply-status-information-retrieval.aliases b/aliases/hardware_management-output_only/power_supply/power-supply-status-information-retrieval.aliases
@@ -6,5 +6,5 @@
 #   Power supply status information retrieval aliases
 # 
 
-alias batthrs='upower -i /org/freedesktop/UPower/devices/DisplayDevice | sed -n 12,12p | awk "{print $4}"' # batthrs: get the number of remaining hours for the battery power
+alias batthrs='upower -i /org/freedesktop/UPower/devices/DisplayDevice | sed -n 12,12p | awk "{print $4}"' # batthrs: Get the number of remaining hours for the battery power.
 
diff --git a/aliases/hardware_management/monitor/monitor-power-management.aliases b/aliases/hardware_management/monitor/monitor-power-management.aliases
@@ -6,5 +6,5 @@
 #   Monitor power management aliases
 # 
 
-alias suspendmonitor='sleep .7; xset dpms force off'                             # suspendmonitor: suspend the monitor
+alias suspendmonitor='sleep .7; xset dpms force off'                             # suspendmonitor: Suspend the monitor.
 
diff --git a/aliases/mobile_device_management-android/network_management/internet-network-management.aliases b/aliases/mobile_device_management-android/network_management/internet-network-management.aliases
@@ -6,5 +6,5 @@
 #   Android internet network management aliases
 # 
 
-alias androidcellip="adb shell ip -f inet addr show rmnet0|sed -n '2{p;q}'|tr -s ' '|awk -F'[/ ]' '{print \$3}'" # androidcellip: get the cell network IP address of an Android device
+alias androidcellip="adb shell ip -f inet addr show rmnet0|sed -n '2{p;q}'|tr -s ' '|awk -F'[/ ]' '{print \$3}'" # androidcellip: Get the cell network IP address of an Android device.
 
diff --git a/aliases/mobile_device_management-android/network_management/local-network-network-management.aliases b/aliases/mobile_device_management-android/network_management/local-network-network-management.aliases
@@ -6,5 +6,5 @@
 #   Android local network network management aliases
 # 
 
-alias androidwlanip="adb shell ip -f inet addr show wlan0|sed -n '2{p;q}'|tr -s ' '|awk -F'[/ ]' '{print \$3}'" # androidwlanip: get the WLAN IP address of an Android device (if not working, replace "wlan0" with "eth0" or "tiwlan0")
+alias androidwlanip="adb shell ip -f inet addr show wlan0|sed -n '2{p;q}'|tr -s ' '|awk -F'[/ ]' '{print \$3}'" # androidwlanip: Get the WLAN IP address of an Android device (if not working, replace "wlan0" with "eth0" or "tiwlan0").
 
diff --git a/aliases/network_management-output_only/internet_information/internet-ip-information-retrieval.aliases b/aliases/network_management-output_only/internet_information/internet-ip-information-retrieval.aliases
@@ -6,6 +6,6 @@
 #   Internet IP information retrieval aliases
 # 
 
-alias myip='curl ipecho.net/plain; echo'                                         # myip: get the public IPv4 address
-alias myiploc='curl ipinfo.io'                                                   # myiploc: get the public IPv4 address with location information
+alias myip='curl ipecho.net/plain; echo'                                         # myip: Get the public IPv4 address.
+alias myiploc='curl ipinfo.io'                                                   # myiploc: Get the public IPv4 address with location information.
 
diff --git a/aliases/network_management-output_only/ssh_information/ssh-tcp-information-retrieval.aliases b/aliases/network_management-output_only/ssh_information/ssh-tcp-information-retrieval.aliases
@@ -6,5 +6,5 @@
 #   SSH TCP information retrieval aliases
 # 
 
-alias sshlistports='ss -tnlp'                                                     # sshlistports: list the ports listening for a SSH connection
+alias sshlistports='ss -tnlp'                                                     # sshlistports: List the ports listening for a SSH connection.
 
diff --git a/aliases/network_management-output_only/ssh_information/ssh-tunnel-information-retrieval.aliases b/aliases/network_management-output_only/ssh_information/ssh-tunnel-information-retrieval.aliases
@@ -6,6 +6,6 @@
 #   SSH tunnel information retrieval aliases
 # 
 
-alias sshtunn='sudo lsof -i -n | egrep \<ssh\>'                                  # sshtunn: list all tunnels created by the SSH daemon
-alias sshconntunn='sudo lsof -i -n | egrep \<sshd\>'                             # sshconntunn: list all tunnels connected to the SSH daemon
+alias sshtunn='sudo lsof -i -n | egrep \<ssh\>'                                  # sshtunn: List all tunnels created by the SSH daemon.
+alias sshconntunn='sudo lsof -i -n | egrep \<sshd\>'                             # sshconntunn: List all tunnels connected to the SSH daemon.
 
diff --git a/aliases/network_management-output_only/tcp_and_udp_information/tcp-and-udp-port-information-retrieval.aliases b/aliases/network_management-output_only/tcp_and_udp_information/tcp-and-udp-port-information-retrieval.aliases
@@ -6,7 +6,7 @@
 #   TCP and UDP port information retrieval aliases
 # 
 
-alias openports='sudo ss -antu'                                                  # openports: list all open TCP and UDP ports
-alias openportspids='sudo lsof -i -P'                                            # openportspids: list all open ports with their PIDs
-alias listnports='sudo ss -lntu'                                                 # listnports: list all listening ports
+alias openports='sudo ss -antu'                                                  # openports: List all open TCP and UDP ports.
+alias openportspids='sudo lsof -i -P'                                            # openportspids: List all open ports with their PIDs.
+alias listnports='sudo ss -lntu'                                                 # listnports: List all listening ports.
 
diff --git a/aliases/network_management/internet/internet-dns-management.aliases b/aliases/network_management/internet/internet-dns-management.aliases
@@ -6,5 +6,5 @@
 #   Internet DNS management aliases
 # 
 
-alias flushdns='dscacheutil -flushcache'                                         # flushdns: flush the DNS Cache
+alias flushdns='dscacheutil -flushcache'                                         # flushdns: Flush the DNS Cache.
 
diff --git a/aliases/number_processing/conversion/base-conversion.aliases b/aliases/number_processing/conversion/base-conversion.aliases
@@ -6,6 +6,6 @@
 #   Base conversion aliases
 # 
 
-hextodec() { local hexFrmtd="${1#*'0x'}"; echo "$((16#"${hexFrmtd}"))"; }        # hextodec: convert a hexidecimal number to decimal
-dectohex() { printf '%#010x\n' "${1}"; }                                         # dectohex: convert a decimal number to hexidecimal
+hextodec() { local hexFrmtd="${1#*'0x'}"; echo "$((16#"${hexFrmtd}"))"; }        # hextodec: Convert a hexidecimal number to decimal.
+dectohex() { printf '%#010x\n' "${1}"; }                                         # dectohex: Convert a decimal number to hexidecimal.
 
diff --git a/aliases/system_management-output_only/process_information/process-general-information-retrieval.aliases b/aliases/system_management-output_only/process_information/process-general-information-retrieval.aliases
@@ -6,5 +6,5 @@
 #   Process general information retrieval aliases
 # 
 
-owndprocs() { ps -u "${USER}" -o pid,%cpu,%mem,start,time,bsdtime; }             # owndprocs: list all processes owned by the current user
+owndprocs() { ps -u "${USER}" -o pid,%cpu,%mem,start,time,bsdtime; }             # owndprocs: List all processes owned by the current user.
 
diff --git a/aliases/system_management-output_only/process_information/process-search-information-retrieval.aliases b/aliases/system_management-output_only/process_information/process-search-information-retrieval.aliases
@@ -6,5 +6,5 @@
 #   Process search information retrieval aliases
 # 
 
-getprocidbyname() { lsof -t -c "${@}" 2>/dev/null; }                             # getprocidbyname: get the ID of a process by name; $1: process name (e.g. "/d$/" to get PIDs for processes ending in "d")
+getprocidbyname() { lsof -t -c "${@}" 2>/dev/null; }                             # getprocidbyname: Get the ID of a process by name; $1: process name (e.g. "/d$/" to get PIDs for processes ending in "d").
 
diff --git a/aliases/text_processing/numeric_processing/basic-numberic-processing.aliases b/aliases/text_processing/numeric_processing/basic-numberic-processing.aliases
@@ -6,5 +6,5 @@
 #   Basic numberic processing aliases
 # 
 
-countchars() { echo "${@}" | wc -c; }                                            # countchars: count the number of characters in a string
+countchars() { echo "${@}" | wc -c; }                                            # countchars: Count the number of characters in a string.
 
diff --git a/aliases/x11_management-output_only/event_monitoring/input-event-monitoring.aliases b/aliases/x11_management-output_only/event_monitoring/input-event-monitoring.aliases
@@ -6,5 +6,5 @@
 #   Input event monitoring aliases
 # 
 
-alias watchmousepos='watch -t -n 0.0001 xdotool getmouselocation'                # watchmousepos: watch and print the current mouse position
+alias watchmousepos='watch -t -n 0.0001 xdotool getmouselocation'                # watchmousepos: Watch and print the current mouse position.
 

Original file line number	Diff line number	Diff line change
`@@ -6,5 +6,5 @@`
`6`	`6`	`# Directory context information retrieval aliases`
`7`	`7`	`#`
`8`	`8`
`9`		`-alias numfiles='echo "$(ls -1 \| wc -l)"' # numfiles: print the number of non-hidden files and directories in the current directory`
	`9`	`+alias numfiles='echo "$(ls -1 \| wc -l)"' # numfiles: Print the number of non-hidden files and directories in the current directory.`
`10`	`10`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,6 @@`
`6`	`6`	`# Single step file finding aliases`
`7`	`7`	`#`
`8`	`8`
`9`		`-ff() { find . -type f -name "${1}"; } # ff: recursively find all files matching a name name; $1: file name`
`10`		`-fd() { find . -type d -name "${1}"; } # fd: recursively find all directories matching a name name; $1: directory name`
	`9`	`+ff() { find . -type f -name "${1}"; } # ff: Recursively find all files matching a name name; $1: file name.`
	`10`	`+fd() { find . -type d -name "${1}"; } # fd: Recursively find all directories matching a name name; $1: directory name.`
`11`	`11`
Original file line number	Diff line number	Diff line change
`@@ -6,5 +6,5 @@`
`6`	`6`	`# Text based file finding aliases`
`7`	`7`	`#`
`8`	`8`
`9`		`-ffgr() { /usr/bin/grep -l -R "${1}" .; } # ffgr: recursively find all files containing a given text; $1: text to search`
	`9`	`+ffgr() { /usr/bin/grep -l -R "${1}" .; } # ffgr: Recursively find all files containing a given text; $1: text to search.`
`10`	`10`
Original file line number	Diff line number	Diff line change
`@@ -6,5 +6,5 @@`
`6`	`6`	`# Recursive file permission information retrieval aliases`
`7`	`7`	`#`
`8`	`8`
`9`		`-alias ll='command ls -FGlAhp' # ll: list the permissions and owner of each file in the current directory`
	`9`	`+alias ll='command ls -FGlAhp' # ll: List the permissions and owner of each file in the current directory.`
`10`	`10`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,6 @@`
`6`	`6`	`# Multiple permission change aliases`
`7`	`7`	`#`
`8`	`8`
`9`		`-alias permusergroupreadwrite='chmod ug+rw' # permusergroupreadwrite: give the user and group read and write permissions to a file.`
`10`		`-alias permusergroupreadwritexec='chmod ug+rwx' # permusergroupreadwriteexec: give the user and group read, write and execute permissions to a file.`
	`9`	`+alias permusergroupreadwrite='chmod ug+rw' # permusergroupreadwrite: Give the user and group read and write permissions to a file.`
	`10`	`+alias permusergroupreadwritexec='chmod ug+rwx' # permusergroupreadwriteexec: Give the user and group read, write and execute permissions to a file.`
`11`	`11`
Original file line number	Diff line number	Diff line change
`@@ -6,5 +6,5 @@`
`6`	`6`	`# Single permission change aliases`
`7`	`7`	`#`
`8`	`8`
`9`		`-alias permreadonly='chmod a-w' # permreadonly: change the permisson status of a file to read-only`
	`9`	`+alias permreadonly='chmod a-w' # permreadonly: Change the permisson status of a file to read-only.`
`10`	`10`
Original file line number	Diff line number	Diff line change
`@@ -6,5 +6,5 @@`
`6`	`6`	`# Power supply status information retrieval aliases`
`7`	`7`	`#`
`8`	`8`
`9`		`-alias batthrs='upower -i /org/freedesktop/UPower/devices/DisplayDevice \| sed -n 12,12p \| awk "{print $4}"' # batthrs: get the number of remaining hours for the battery power`
	`9`	`+alias batthrs='upower -i /org/freedesktop/UPower/devices/DisplayDevice \| sed -n 12,12p \| awk "{print $4}"' # batthrs: Get the number of remaining hours for the battery power.`
`10`	`10`
Original file line number	Diff line number	Diff line change
`@@ -6,5 +6,5 @@`
`6`	`6`	`# Monitor power management aliases`
`7`	`7`	`#`
`8`	`8`
`9`		`-alias suspendmonitor='sleep .7; xset dpms force off' # suspendmonitor: suspend the monitor`
	`9`	`+alias suspendmonitor='sleep .7; xset dpms force off' # suspendmonitor: Suspend the monitor.`
`10`	`10`
Original file line number	Diff line number	Diff line change
`@@ -6,5 +6,5 @@`
`6`	`6`	`# Android internet network management aliases`
`7`	`7`	`#`
`8`	`8`
`9`		`-alias androidcellip="adb shell ip -f inet addr show rmnet0\|sed -n '2{p;q}'\|tr -s ' '\|awk -F'[/ ]' '{print \$3}'" # androidcellip: get the cell network IP address of an Android device`
	`9`	`+alias androidcellip="adb shell ip -f inet addr show rmnet0\|sed -n '2{p;q}'\|tr -s ' '\|awk -F'[/ ]' '{print \$3}'" # androidcellip: Get the cell network IP address of an Android device.`
`10`	`10`