Browse Source

pages*: add missing mnemonics (part 1) (#12143)

* pages*: add missing mnemonics

---------

Co-authored-by: Lena <126529524+acuteenvy@users.noreply.github.com>
Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com>
Vitor Henrique 1 year ago
parent
commit
814e511bae

+ 1 - 1
pages/android/dumpsys.md

@@ -24,6 +24,6 @@
 
 `dumpsys --skip {{service}}`
 
-- Specify a timeout period in seconds (defaults to 10s):
+- Specify a [t]imeout period in seconds (defaults to 10s):
 
 `dumpsys -t {{8}}`

+ 1 - 1
pages/android/logcat.md

@@ -7,7 +7,7 @@
 
 `logcat`
 
-- Write system logs to a file:
+- Write system logs to a [f]ile:
 
 `logcat -f {{path/to/file}}`
 

+ 2 - 2
pages/android/pm.md

@@ -7,11 +7,11 @@
 
 `pm list packages`
 
-- List all installed system apps:
+- List all installed [s]ystem apps:
 
 `pm list packages -s`
 
-- List all installed 3rd-Party apps:
+- List all installed [3]rd-party apps:
 
 `pm list packages -3`
 

+ 1 - 1
pages/common/ac.md

@@ -15,6 +15,6 @@
 
 `ac -p {{username}}`
 
-- Print how long a particular user has been connected in hours per day (with total):
+- Print how long a particular user has been connected in hours per [d]ay (with total):
 
 `ac -dp {{username}}`

+ 3 - 3
pages/common/adb-install.md

@@ -11,15 +11,15 @@
 
 `adb -s {{serial_number}} install {{path/to/file.apk}}`
 
-- Reinstall an existing app, keeping its data:
+- [r]einstall an existing app, keeping its data:
 
 `adb install -r {{path/to/file.apk}}`
 
-- Push an Android application allowing version code downgrade (debuggable packages only):
+- Push an Android application allowing version code [d]owngrade (debuggable packages only):
 
 `adb install -d {{path/to/file.apk}}`
 
-- Grant all permissions listed in the app manifest:
+- [g]rant all permissions listed in the app manifest:
 
 `adb install -g {{path/to/file.apk}}`
 

+ 1 - 1
pages/common/adb-logcat.md

@@ -7,7 +7,7 @@
 
 `adb logcat`
 
-- Display lines that match a regular expression:
+- Display lines that match a regular [e]xpression:
 
 `adb logcat -e {{regular_expression}}`
 

+ 2 - 2
pages/common/ag.md

@@ -11,11 +11,11 @@
 
 `ag {{foo}} {{path/to/directory}}`
 
-- Find files containing "foo", but only list the filenames:
+- Find files containing "foo", but only [l]ist the filenames:
 
 `ag -l {{foo}}`
 
-- Find files containing "FOO" case-insensitively, and print only the match, rather than the whole line:
+- Find files containing "FOO" case-[i]nsensitively, and print [o]nly the match, rather than the whole line:
 
 `ag -i -o {{FOO}}`
 

+ 1 - 1
pages/common/age-keygen.md

@@ -8,6 +8,6 @@
 
 `age-keygen --output {{path/to/file}}`
 
-- Convert an identity to a recipient and print the public key to `stdout`:
+- Convert an identit[y] to a recipient and print the public key to `stdout`:
 
 `age-keygen -y {{path/to/file}}`

+ 1 - 1
pages/common/airdecap-ng.md

@@ -8,7 +8,7 @@
 
 `airdecap-ng -b {{ap_mac}} {{path/to/capture.cap}}`
 
-- Decrypt a WEP encrypted capture file using the key in hex format:
+- Decrypt a [w]EP encrypted capture file using the key in hex format:
 
 `airdecap-ng -w {{hex_key}} {{path/to/capture.cap}}`
 

+ 1 - 1
pages/common/alacritty.md

@@ -11,7 +11,7 @@
 
 `alacritty --working-directory {{path/to/directory}}`
 
-- Run a command in a new Alacritty window:
+- [e]xecute a command in a new Alacritty window:
 
 `alacritty -e {{command}}`
 

+ 2 - 2
pages/common/amass-db.md

@@ -7,11 +7,11 @@
 
 `amass db -dir {{path/to/database_directory}} -list`
 
-- Show results for a specified enumeration index and domain name:
+- Show results for a specified enumeration index and [d]omain name:
 
 `amass db -dir {{path/to/database_directory}} -d {{domain_name}} -enum {{index_from_list}} -show`
 
-- List all found subdomains of a domain within an enumeration:
+- List all found subdomains of a [d]omain within an enumeration:
 
 `amass db -dir {{path/to/database_directory}} -d {{domain_name}} -enum {{index_from_list}} -names`
 

+ 2 - 2
pages/common/amass-enum.md

@@ -3,11 +3,11 @@
 > Find subdomains of a domain.
 > More information: <https://github.com/OWASP/Amass/blob/master/doc/user_guide.md#the-enum-subcommand>.
 
-- Passively find subdomains of a domain:
+- Passively find subdomains of a [d]omain:
 
 `amass enum -passive -d {{domain_name}}`
 
-- Find subdomains of a domain and actively verify them attempting to resolve the found subdomains:
+- Find subdomains of a [d]omain and actively verify them attempting to resolve the found subdomains:
 
 `amass enum -active -d {{domain_name}} -p {{80,443,8080}}`
 

+ 1 - 1
pages/common/amass-intel.md

@@ -11,7 +11,7 @@
 
 `amass intel -active -addr {{192.168.0.1-254}}`
 
-- Find root domains related to a domain:
+- Find root domains related to a [d]omain:
 
 `amass intel -whois -d {{domain_name}}`
 

+ 4 - 4
pages/common/anki.md

@@ -3,18 +3,18 @@
 > Powerful, intelligent flashcard program.
 > More information: <https://docs.ankiweb.net>.
 
-- Launch `anki`:
+- Launch the GUI:
 
 `anki`
 
-- Launch `anki` with a specific profile:
+- Use a specific [p]rofile:
 
 `anki -p {{profile_name}}`
 
-- Launch `anki` in a specific language:
+- Use a specific [l]anguage:
 
 `anki -l {{language}}`
 
-- Launch `anki` from a specific directory instead of the default (`~/Anki`):
+- Use a non-default directory (`~/Anki` for default):
 
 `anki -b {{path/to/directory}}`

+ 3 - 3
pages/common/ansible-playbook.md

@@ -7,15 +7,15 @@
 
 `ansible-playbook {{playbook}}`
 
-- Run tasks in playbook with custom host inventory:
+- Run tasks in playbook with custom host [i]nventory:
 
 `ansible-playbook {{playbook}} -i {{inventory_file}}`
 
-- Run tasks in playbook with extra variables defined via the command-line:
+- Run tasks in playbook with [e]xtra variables defined via the command-line:
 
 `ansible-playbook {{playbook}} -e "{{variable1}}={{value1}} {{variable2}}={{value2}}"`
 
-- Run tasks in playbook with extra variables defined in a JSON file:
+- Run tasks in playbook with [e]xtra variables defined in a JSON file:
 
 `ansible-playbook {{playbook}} -e "@{{variables.json}}"`
 

+ 2 - 2
pages/common/ansible.md

@@ -8,11 +8,11 @@
 
 `ansible {{group}} --list-hosts`
 
-- Ping a group of hosts by invoking the ping module:
+- Ping a group of hosts by invoking the ping [m]odule:
 
 `ansible {{group}} -m ping`
 
-- Display facts about a group of hosts by invoking the setup module:
+- Display facts about a group of hosts by invoking the setup [m]odule:
 
 `ansible {{group}} -m setup`
 

+ 1 - 1
pages/common/ant.md

@@ -8,7 +8,7 @@
 
 `ant`
 
-- Build a project using build file other than `build.xml`:
+- Build a project using build [f]ile other than `build.xml`:
 
 `ant -f {{buildfile.xml}}`
 

+ 2 - 2
pages/common/apropos.md

@@ -7,10 +7,10 @@
 
 `apropos {{regular_expression}}`
 
-- Search without restricting the output to the terminal width:
+- Search without restricting the output to the terminal width ([l]ong output):
 
 `apropos -l {{regular_expression}}`
 
-- Search for pages that contain all the expressions given:
+- Search for pages that match [a]ll the expressions given:
 
 `apropos {{regular_expression_1}} -a {{regular_expression_2}} -a {{regular_expression_3}}`

+ 2 - 2
pages/common/arp.md

@@ -7,10 +7,10 @@
 
 `arp -a`
 
-- Delete a specific entry:
+- [d]elete a specific entry:
 
 `arp -d {{address}}`
 
-- Create an entry in the ARP table:
+- [s]et up a new entry in the ARP table:
 
 `arp -s {{address}} {{mac_address}}`

+ 4 - 4
pages/common/arping.md

@@ -12,18 +12,18 @@
 
 `arping -I {{interface}} {{host_ip}}`
 
-- Ping a host and stop at the first reply:
+- Ping a host and [f]inish after the first reply:
 
 `arping -f {{host_ip}}`
 
-- Ping a host a specific number of times:
+- Ping a host a specific number ([c]ount) of times:
 
 `arping -c {{count}} {{host_ip}}`
 
-- Broadcast ARP request packets to update neighbours' ARP caches:
+- Broadcast ARP request packets to update neighbours' ARP caches ([U]nsolicited ARP mode):
 
 `arping -U {{ip_to_broadcast}}`
 
-- Detect duplicated IP addresses in the network by sending ARP requests with a 3 second timeout:
+- [D]etect duplicated IP addresses in the network by sending ARP requests with a 3 second timeout:
 
 `arping -D -w {{3}} {{ip_to_check}}`

+ 2 - 2
pages/common/asciinema.md

@@ -23,9 +23,9 @@
 
 `asciinema play https://asciinema.org/a/{{cast_id}}`
 
-- Make a new recording, limiting any idle time to at most 2.5 seconds:
+- Make a new recording, limiting any [i]dle time to at most 2.5 seconds:
 
-`asciinema rec -i {{2.5}}`
+`asciinema rec -i 2.5`
 
 - Print the full output of a locally saved recording:
 

+ 1 - 1
pages/common/atom.md

@@ -8,7 +8,7 @@
 
 `atom {{path/to/file_or_directory}}`
 
-- Open a file or directory in a new window:
+- Open a file or directory in a [n]ew window:
 
 `atom -n {{path/to/file_or_directory}}`
 

+ 5 - 5
pages/common/atoum.md

@@ -11,23 +11,23 @@
 
 `atoum`
 
-- Run tests using the specified configuration file:
+- Run tests using the specified [c]onfiguration file:
 
 `atoum -c {{path/to/file}}`
 
-- Run a specific test file:
+- Run a specific test [f]ile:
 
 `atoum -f {{path/to/file}}`
 
-- Run a specific directory of tests:
+- Run a specific [d]irectory of tests:
 
 `atoum -d {{path/to/directory}}`
 
-- Run all tests under a specific namespace:
+- Run all tests under a specific name[s]pace:
 
 `atoum -ns {{namespace}}`
 
-- Run all tests with a specific tag:
+- Run all tests with a specific [t]ag:
 
 `atoum -t {{tag}}`
 

+ 1 - 1
pages/common/atq.md

@@ -7,7 +7,7 @@
 
 `atq`
 
-- Show jobs from queue named 'a' (queues have single-character names):
+- Show jobs from the 'a' [q]ueue (queues have single-character names):
 
 `atq -q {{a}}`
 

+ 1 - 1
pages/common/atuin.md

@@ -16,7 +16,7 @@
 
 `atuin search {{command}}`
 
-- Register an account on the default sync server:
+- Register an account on the default sync server using the specified [u]sername, [e]mail and [p]assword:
 
 `atuin register -u {{username}} -e {{email}} -p {{password}}`
 

+ 3 - 3
pages/common/autossh.md

@@ -4,15 +4,15 @@
 > Auto-reconnects to keep port forwarding tunnels up. Accepts all `ssh` flags.
 > More information: <https://www.harding.motd.ca/autossh>.
 
-- Start an SSH session, restarting when a monitoring port fails to return data:
+- Start an SSH session, restarting when the [M]onitoring port fails to return data:
 
 `autossh -M {{monitor_port}} "{{ssh_command}}"`
 
-- Forward a local port to a remote one, restarting when necessary:
+- Forward a [L]ocal port to a remote one, restarting when necessary:
 
 `autossh -M {{monitor_port}} -L {{local_port}}:localhost:{{remote_port}} {{user}}@{{host}}`
 
-- Fork `autossh` into the background before executing `ssh` and don't open a remote shell:
+- Fork `autossh` into the background before executing `ssh` and do [N]ot open a remote shell:
 
 `autossh -f -M {{monitor_port}} -N "{{ssh_command}}"`
 

+ 4 - 4
pages/common/avrdude.md

@@ -3,13 +3,13 @@
 > Driver program for Atmel AVR microcontrollers programming.
 > More information: <https://www.nongnu.org/avrdude/>.
 
-- Read AVR microcontroller:
+- [r]ead the flash ROM of a AVR microcontroller with a specific [p]art id:
 
-`avrdude -p {{AVR_device}} -c {{programmer}} -U flash:r:{{file.hex}}:i`
+`avrdude -p {{part_no}} -c {{programmer_id}} -U flash:r:{{file.hex}}:i`
 
-- Write AVR microcontroller:
+- [w]rite to the flash ROM AVR microcontroller:
 
-`avrdude -p {{AVR_device}} -c {{programmer}} -U flash:w:{{file.hex}}`
+`avrdude -p {{part_no}} -c {{programmer}} -U flash:w:{{file.hex}}`
 
 - List available AVR devices:
 

+ 1 - 1
pages/common/aws-google-auth.md

@@ -3,7 +3,7 @@
 > Command-line tool to acquire AWS temporary (STS) credentials using Google Apps as a federated (Single Sign-On) provider.
 > More information: <https://github.com/cevoaustralia/aws-google-auth>.
 
-- Log in with Google SSO using the IDP and SP identifiers and set the credentials duration to one hour:
+- Log in with Google SSO using the specified [u]sername [I]DP and [S]P identifiers and set the credentials [d]uration to one hour:
 
 `aws-google-auth -u {{example@example.com}} -I {{$GOOGLE_IDP_ID}} -S {{$GOOGLE_SP_ID}} -d {{3600}}`
 

+ 4 - 4
pages/common/axel.md

@@ -8,18 +8,18 @@
 
 `axel {{url}}`
 
-- Download and specify filename:
+- Download and specify an [o]utput file:
 
 `axel {{url}} -o {{path/to/file}}`
 
-- Download with multiple connections:
+- Download with a specific [n]umber connections:
 
 `axel -n {{connections_num}} {{url}}`
 
-- Search for mirrors:
+- [S]earch for mirrors:
 
 `axel -S {{mirrors_num}} {{url}}`
 
-- Limit download speed (bytes per second):
+- Limit download [s]peed (bytes per second):
 
 `axel -s {{speed}} {{url}}`

+ 1 - 1
pages/common/az-lock.md

@@ -24,6 +24,6 @@
 
 `az lock list`
 
-- Show a subscription level lock:
+- Show a subscription level lock with a specific [n]ame:
 
 `az lock show -n {{lock_name}}`

+ 2 - 2
pages/common/az-storage-blob.md

@@ -4,11 +4,11 @@
 > Part of `azure-cli` (also known as `az`).
 > More information: <https://learn.microsoft.com/cli/azure/storage/blob>.
 
-- Download a blob to a file path:
+- Download a blob to a [f]ile path specifying a [s]ource container:
 
 `az storage blob download --account-name {{storage_account_name}} --account-key {{storage_account_key}} -c {{container_name}} -n {{path/to/blob}} -f {{path/to/local_file}}`
 
-- Download blobs from a blob container recursively:
+- [d]ownload blobs from a blob container recursively:
 
 `az storage blob download-batch --account-name {{storage_account_name}} --account-key {{storage_account_key}} -s {{container_name}} -d {{path/to/remote}} --pattern {{filename_regex}} --destination {{path/to/destination}}`
 

+ 1 - 1
pages/common/az-storage.md

@@ -4,7 +4,7 @@
 > Part of `azure-cli` (also known as `az`).
 > More information: <https://learn.microsoft.com/cli/azure/storage>.
 
-- Create a storage account:
+- Create a storage account specifying a [l]ocation:
 
 `az storage account create --resource-group {{group_name}} --name {{account_name}} -l {{location}} --sku {{account_sku}}`
 

+ 4 - 8
pages/common/babeld.md

@@ -3,22 +3,18 @@
 > Routing daemon for Babel which uses firewall-style filters.
 > More information: <https://www.irif.fr/~jch/software/babel/babeld.html>.
 
-- Start `babeld` with a specific configuration file:
-
-`babeld -c {{path/to/babeld.conf}}`
-
-- Start `babeld` with multiple configuration files (read in order):
+- Start the daemon with one or more [c]onfiguration files (read in order):
 
 `babeld -c {{path/to/ports.conf}} -c {{path/to/filters.conf}} -c {{path/to/interfaces.conf}}`
 
-- Start `babeld` and daemonise afterwards:
+- [D]eamonize after startup:
 
 `babeld -D`
 
-- Start `babeld` and pass a configuration command:
+- Specify a [C]onfiguration command:
 
 `babeld -C {{'redistribute metric 256'}}`
 
-- Start `babeld` and specify on which interfaces to operate:
+- Specify on which interfaces to operate:
 
 `babeld {{eth0}} {{eth1}} {{wlan0}}`

+ 5 - 5
pages/common/badblocks.md

@@ -8,22 +8,22 @@
 
 `sudo badblocks {{/dev/sdX}}`
 
-- Search an unmounted disk for bad blocks with a non-destructive read-write test:
+- Search an unmounted disk for bad blocks with a [n]on-destructive read-write test:
 
 `sudo badblocks -n {{/dev/sdX}}`
 
-- Search an unmounted disk for bad blocks with a destructive write test:
+- Search an unmounted disk for bad blocks with a destructive [w]rite test:
 
 `sudo badblocks -w {{/dev/sdX}}`
 
-- Search an unmounted disk for bad blocks with a destructive write test and show verbose status:
+- Use the destructive [w]rite test and [s]how [v]erbose progress:
 
 `sudo badblocks -svw {{/dev/sdX}}`
 
-- Search an unmounted disk in destructive mode and output found blocks to a file:
+- In destructive mode, [o]utput found blocks to a file:
 
 `sudo badblocks -o {{path/to/file}} -w {{/dev/sdX}}`
 
-- Search an unmounted disk in destructive mode with improved speed using 4K block size and 64K block count:
+- Use the destructive mode with improved speed using 4K [b]lock size and 64K block [c]ount:
 
 `sudo badblocks -w -b {{4096}} -c {{65536}} {{/dev/sdX}}`