From 1ba7fb946061915e193e50591f637ad3812131c2 Mon Sep 17 00:00:00 2001 From: Vitor Henrique <87824454+vitorhcl@users.noreply.github.com> Date: Mon, 19 Feb 2024 11:13:42 -0300 Subject: [PATCH] pages*: add missing mnemonics (#12151) * pages*: add missing mnemonics --------- Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com> Co-authored-by: Lena <126529524+acuteenvy@users.noreply.github.com> Co-authored-by: K.B.Dharun Krishna --- pages/android/am.md | 4 ++-- pages/common/banner.md | 4 ++-- pages/common/bash.md | 2 +- pages/common/batch.md | 2 +- pages/common/bb.md | 4 ++-- pages/common/beanstalkd.md | 4 ++-- pages/common/bedtools.md | 14 +++++++------- pages/common/bindkey.md | 6 +++--- pages/common/black.md | 2 +- pages/common/bmaptool.md | 2 +- pages/common/bosh.md | 8 ++++---- pages/common/box.md | 2 +- pages/common/boxes.md | 18 +++++++++++++----- pages/common/brotli.md | 8 ++++---- pages/common/bup.md | 8 ++++---- pages/common/bzip2.md | 4 ++-- pages/common/bzip3.md | 6 +++--- pages/common/c99.md | 2 +- pages/common/calc.md | 2 +- pages/common/calibredb.md | 2 +- pages/common/cancel.md | 8 ++++---- pages/common/carbon-now.md | 12 ++++++------ pages/common/cat.md | 2 +- pages/common/cdk.md | 2 +- pages/common/certutil.md | 8 ++++---- pages/common/chafa.md | 2 +- 26 files changed, 73 insertions(+), 65 deletions(-) diff --git a/pages/android/am.md b/pages/android/am.md index 0e86ce09d..78d1ee24d 100644 --- a/pages/android/am.md +++ b/pages/android/am.md @@ -3,11 +3,11 @@ > Android activity manager. > More information: . -- Start a specific activity: +- Start the activity with a specific component and package [n]ame: `am start -n {{com.android.settings/.Settings}}` -- Start an activity and pass [d]ata to it: +- Start an intent [a]ction and pass [d]ata to it: `am start -a {{android.intent.action.VIEW}} -d {{tel:123}}` diff --git a/pages/common/banner.md b/pages/common/banner.md index d13aba000..dc0c10e9e 100644 --- a/pages/common/banner.md +++ b/pages/common/banner.md @@ -7,9 +7,9 @@ `banner "{{Hello World}}"` -- Print the text message as a banner with a width of 50 characters: +- Use a banner [w]idth of 50 characters: -`banner -w {{50}} "{{Hello World}}"` +`banner -w 50 "{{Hello World}}"` - Read text from `stdin`: diff --git a/pages/common/bash.md b/pages/common/bash.md index c4de5ae2e..0c186fbe1 100644 --- a/pages/common/bash.md +++ b/pages/common/bash.md @@ -20,7 +20,7 @@ `bash {{path/to/script.sh}}` -- Execute a specific script while printing each command before executing it: +- E[x]ecute a specific script, printing each command before executing it: `bash -x {{path/to/script.sh}}` diff --git a/pages/common/batch.md b/pages/common/batch.md index 254225b38..08c6d3ae4 100644 --- a/pages/common/batch.md +++ b/pages/common/batch.md @@ -12,6 +12,6 @@ `echo "{{./make_db_backup.sh}}" | batch` -- Execute commands from a given file: +- Execute commands from a given [f]ile: `batch -f {{path/to/file}}` diff --git a/pages/common/bb.md b/pages/common/bb.md index 84f4f5262..d27e55a86 100644 --- a/pages/common/bb.md +++ b/pages/common/bb.md @@ -11,10 +11,10 @@ `bb -f {{path/to/script.clj}}` -- Bind input to a sequence of lines from `stdin`: +- Bind [i]nput to a sequence of lines from `stdin`: `printf "first\nsecond" | bb -i "(map clojure.string/capitalize *input*)"` -- Bind input to a sequence of EDN(Extensible Data Notation) values from `stdin`: +- Bind [I]nput to a sequence of EDN (Extensible Data Notation) values from `stdin`: `echo "{:key 'val}" | bb -I "(:key (first *input*))"` diff --git a/pages/common/beanstalkd.md b/pages/common/beanstalkd.md index 2a4da04af..23876970b 100644 --- a/pages/common/beanstalkd.md +++ b/pages/common/beanstalkd.md @@ -3,11 +3,11 @@ > A simple and generic work-queue server. > More information: . -- Start Beanstalk, listening on port 11300: +- Start the server, listening on port 11300: `beanstalkd` -- Start Beanstalk listening on a custom port and address: +- Listen on a specific [p]ort and address: `beanstalkd -l {{ip_address}} -p {{port_number}}` diff --git a/pages/common/bedtools.md b/pages/common/bedtools.md index 4c5b76476..2aa49e5d4 100644 --- a/pages/common/bedtools.md +++ b/pages/common/bedtools.md @@ -4,26 +4,26 @@ > Used to intersect, group, convert and count data in BAM, BED, GFF/GTF, VCF format. > More information: . -- Intersect two files regarding the sequences' strand and save the result to the specified file: +- Intersect file [a] and file(s) [b] regarding the sequences' [s]trand and save the result to a specific file: -`bedtools intersect -a {{path/to/file1}} -b {{path/to/file2}} -s > {{path/to/output_file}}` +`bedtools intersect -a {{path/to/file_A}} -b {{path/to/file_B1 path/to/file_B2 ...}} -s > {{path/to/output_file}}` -- Intersect two files with a left outer join, i.e. report each feature from `file1` and NULL if no overlap with `file2`: +- Intersect two files with a [l]eft [o]uter [j]oin, i.e. report each feature from `file1` and NULL if no overlap with `file2`: -`bedtools intersect -a {{path/to/file1}} -b {{path/to/file2}} -lof > {{path/to/output_file}}` +`bedtools intersect -a {{path/to/file1}} -b {{path/to/file2}} -loj > {{path/to/output_file}}` - Using more efficient algorithm to intersect two pre-sorted files: `bedtools intersect -a {{path/to/file1}} -b {{path/to/file2}} -sorted > {{path/to/output_file}}` -- Group file `path/to/file` based on the first three and the fifth column and summarize the sixth column by summing it up: +- [g]roup a file based on the first three and the fifth [c]olumn and apply the sum [o]peration on the sixth column: `bedtools groupby -i {{path/to/file}} -c 1-3,5 -g 6 -o sum` -- Convert bam-formatted file to a bed-formatted one: +- Convert bam-formatted [i]nput file to a bed-formatted one: `bedtools bamtobed -i {{path/to/file.bam}} > {{path/to/file.bed}}` -- Find for all features in `file1.bed` the closest one in `file2.bed` and write their distance in an extra column (input files must be sorted): +- Find for all features in `file1.bed` the closest one in `file2.bed` and write their [d]istance in an extra column (input files must be sorted): `bedtools closest -a {{path/to/file1.bed}} -b {{path/to/file2.bed}} -d` diff --git a/pages/common/bindkey.md b/pages/common/bindkey.md index ec79950dc..d5987e3b0 100644 --- a/pages/common/bindkey.md +++ b/pages/common/bindkey.md @@ -7,14 +7,14 @@ `bindkey "{{^k}}" {{kill-line}}` -- Bind a hotkey to a specific key sequence: +- Bind a hotkey to a specific key [s]equence: `bindkey -s '^o' 'cd ..\n'` -- View keymaps: +- [l]ist keymaps: `bindkey -l` -- View the hotkey in a keymap: +- View the hotkey in a key[M]ap: `bindkey -M main` diff --git a/pages/common/black.md b/pages/common/black.md index 5efb9e74c..9384454dc 100644 --- a/pages/common/black.md +++ b/pages/common/black.md @@ -7,7 +7,7 @@ `black {{path/to/file_or_directory}}` -- Format the code passed in as a string: +- Format the [c]ode passed in as a string: `black -c "{{code}}"` diff --git a/pages/common/bmaptool.md b/pages/common/bmaptool.md index 2f0347b15..f1362bf2b 100644 --- a/pages/common/bmaptool.md +++ b/pages/common/bmaptool.md @@ -3,7 +3,7 @@ > Create or copy block maps intelligently (designed to be faster than `cp` or `dd`). > More information: . -- Create a blockmap from image file: +- [o]utput a blockmap file from image file: `bmaptool create -o {{blockmap.bmap}} {{source.img}}` diff --git a/pages/common/bosh.md b/pages/common/bosh.md index 2b6a9e29e..47762622d 100644 --- a/pages/common/bosh.md +++ b/pages/common/bosh.md @@ -3,9 +3,9 @@ > Deploy and manage the BOSH director. > More information: . -- Create local alias for director: +- Create local alias for director in a specific [e]nvironment: -`bosh alias-env {{environment_name}} -e {{ip_address|url}} --ca-cert {{ca_certificate}}` +`bosh alias-env {{environment_name}} -e {{ip_address|URL}} --ca-cert {{ca_certificate}}` - List environments: @@ -19,11 +19,11 @@ `bosh -e {{environment}} deployments` -- List environment virtual machines: +- List environment virtual machines in a [d]eployment: `bosh -e {{environment}} vms -d {{deployment}}` -- Ssh into virtual machine: +- SSH into virtual machine: `bosh -e {{environment}} ssh {{virtual_machine}} -d {{deployment}}` diff --git a/pages/common/box.md b/pages/common/box.md index 62389e998..ac7cc9d82 100644 --- a/pages/common/box.md +++ b/pages/common/box.md @@ -7,7 +7,7 @@ `box compile` -- Compile a new Phar file using a specific configuration file: +- Compile a new Phar file using a specific [c]onfiguration file: `box compile -c {{path/to/config}}` diff --git a/pages/common/boxes.md b/pages/common/boxes.md index 98dffb1d2..2a6c2db78 100644 --- a/pages/common/boxes.md +++ b/pages/common/boxes.md @@ -7,18 +7,26 @@ `echo "{{string}}" | boxes` -- Remove a box from a string: +- [r]emove a box from a string: `echo "{{string}}" | boxes -r` -- Draw a box with a specific design around a string: +- Specify the box [d]esign: `echo "{{string}}" | boxes -d {{parchment}}` -- Draw a box with a width of 10 and a height of 5: +- Specify the box [s]ize (in columns by lines): `echo "{{string}}" | boxes -s {{10}}x{{5}}` -- Draw a box with centered text: +- [a]lign the box text [h]orizonally (at [l]eft, [c]enter or [r]ight): -`echo "{{string}}" | boxes -a c` +`echo "{{string}}" | boxes -a h{{l|c|r}}` + +- [a]lign the box text [v]ertically (at [t]op, [c]enter or [b]ottom): + +`echo "{{string}}" | boxes -a v{{t|c|b}}` + +- [j]ustify the box text (at [l]eft, [c]enter or [r]ight): + +`echo "{{string}}" | boxes -a j{{l|c|r}}{{vt}}` diff --git a/pages/common/brotli.md b/pages/common/brotli.md index 84b26e368..5e76ba5e3 100644 --- a/pages/common/brotli.md +++ b/pages/common/brotli.md @@ -7,18 +7,18 @@ `brotli {{path/to/file}}` -- Decompress a file, creating an uncompressed version next to the file: +- [d]ecompress a file, creating an uncompressed version next to the file: `brotli -d {{path/to/file.br}}` -- Compress a file specifying the output filename: +- Compress a file specifying the [o]utput filename: `brotli {{path/to/file}} -o {{path/to/compressed_output_file.br}}` -- Decompress a Brotli file specifying the output filename: +- [d]ecompress a Brotli file specifying the [o]utput filename: `brotli -d {{path/to/compressed_file.br}} -o {{path/to/output_file}}` -- Specify the compression level [1=Fastest (Worst), 11=Slowest (Best)]: +- Specify the compression quality (1=fastest (worst), 11=slowest (best)): `brotli -q {{11}} {{path/to/file}} -o {{path/to/compressed_output_file.br}}` diff --git a/pages/common/bup.md b/pages/common/bup.md index 0505e7667..2217e5fa0 100644 --- a/pages/common/bup.md +++ b/pages/common/bup.md @@ -3,15 +3,15 @@ > Backup system based on the Git packfile format, providing incremental saves and global deduplication. > More information: . -- Initialize a backup repository in the specified local directory: +- Initialize a backup repository in a given local [d]irectory: `bup -d {{path/to/repository}} init` -- Prepare a given directory before taking a backup: +- Prepare a given [d]irectory before taking a backup: `bup -d {{path/to/repository}} index {{path/to/directory}}` -- Backup a directory to the repository: +- Backup a [d]irectory to the repository specifying its [n]ame: `bup -d {{path/to/repository}} save -n {{backup_name}} {{path/to/directory}}` @@ -19,6 +19,6 @@ `bup -d {{path/to/repository}} ls` -- Restore a specific backup snapshot to a target directory: +- Restore a specific backup snapshot to a target dire[C]tory: `bup -d {{path/to/repository}} restore -C {{path/to/target_directory}} {{backup_name}}` diff --git a/pages/common/bzip2.md b/pages/common/bzip2.md index 605a51436..85c368b62 100644 --- a/pages/common/bzip2.md +++ b/pages/common/bzip2.md @@ -7,11 +7,11 @@ `bzip2 {{path/to/file_to_compress}}` -- Decompress a file: +- [d]ecompress a file: `bzip2 -d {{path/to/compressed_file.bz2}}` -- Decompress a file to `stdout`: +- [d]ecompress a file to `stdout`: `bzip2 -dc {{path/to/compressed_file.bz2}}` diff --git a/pages/common/bzip3.md b/pages/common/bzip3.md index 3768ca520..5fc749986 100644 --- a/pages/common/bzip3.md +++ b/pages/common/bzip3.md @@ -7,11 +7,11 @@ `bzip3 {{path/to/file_to_compress}}` -- Decompress a file: +- [d]ecompress a file: `bzip3 -d {{path/to/compressed_file.bz3}}` -- Decompress a file to `stdout`: +- Decompress a file to `stdout` ([c]): `bzip3 -dc {{path/to/compressed_file.bz3}}` @@ -25,7 +25,7 @@ - Decompress a file overwriting existing files: -`bzip3 --force {{path/to/compressed_file.bz3}}` +`bzip3 -d --force {{path/to/compressed_file.bz3}}` - Display help: diff --git a/pages/common/c99.md b/pages/common/c99.md index eda70fa9b..ff34631f4 100644 --- a/pages/common/c99.md +++ b/pages/common/c99.md @@ -7,7 +7,7 @@ `c99 {{file.c}}` -- Compile source file(s) and create an executable with a custom name: +- Compile source file(s) and specify the executable [o]utput filename: `c99 -o {{executable_name}} {{file.c}}` diff --git a/pages/common/calc.md b/pages/common/calc.md index 49f327b33..e1a98e016 100644 --- a/pages/common/calc.md +++ b/pages/common/calc.md @@ -11,7 +11,7 @@ `calc '{{85 * (36 / 4)}}'` -- Perform a calculation without any output formatting (for use with pipes): +- Don't format the output (for use with [p]ipes): `calc -p '{{4/3 * pi() * 5^3}}'` diff --git a/pages/common/calibredb.md b/pages/common/calibredb.md index 88cb2d865..2615166d3 100644 --- a/pages/common/calibredb.md +++ b/pages/common/calibredb.md @@ -20,7 +20,7 @@ `calibredb add {{file1 file2 …}}` -- Recursively add all e-books under a directory to the library: +- [r]ecursively add all e-books under a directory to the library: `calibredb add -r {{path/to/directory}}` diff --git a/pages/common/cancel.md b/pages/common/cancel.md index e31ab15de..d8888bce8 100644 --- a/pages/common/cancel.md +++ b/pages/common/cancel.md @@ -8,7 +8,7 @@ `cancel` -- Cancel the jobs of the default printer owned by a specific user: +- Cancel the jobs of the default printer owned by a specific [u]ser: `cancel -u {{username}}` @@ -20,14 +20,14 @@ `cancel {{printer}}-{{job_id}}` -- Cancel all jobs of all printers: +- Cancel [a]ll jobs of all printers: `cancel -a` -- Cancel all jobs of a specific printer: +- Cancel [a]ll jobs of a specific printer: `cancel -a {{printer}}` -- Cancel the current job of a specific server and then delete job data files: +- Cancel the current job of a specific server and then delete ([x]) job data files: `cancel -h {{server}} -x` diff --git a/pages/common/carbon-now.md b/pages/common/carbon-now.md index 10e501065..70f4ce46d 100644 --- a/pages/common/carbon-now.md +++ b/pages/common/carbon-now.md @@ -11,23 +11,23 @@ `carbon-now --from-clipboard` -- Create an image from `stdin` using default settings: +- Create an image from `stdin` using default settings and copy to the clipboard: -`{{input}} | carbon-now` +`{{input}} | carbon-now --to-clipboard` -- Create images interactively for custom settings and optionally save a preset: +- Create images [i]nteractively for custom settings and optionally save a preset: `carbon-now -i {{path/to/file}}` -- Create images from previously saved preset: +- Create images from a previously saved [p]reset: `carbon-now -p {{preset}} {{path/to/file}}` -- Start at a specified line of text: +- [s]tart at a specified line of text: `carbon-now -s {{line}} {{path/to/file}}` -- End at a specific line of text: +- [e]nd at a specific line of text: `carbon-now -e {{line}} {{path/to/file}}` diff --git a/pages/common/cat.md b/pages/common/cat.md index e02f97d0c..eeb695df6 100644 --- a/pages/common/cat.md +++ b/pages/common/cat.md @@ -1,7 +1,7 @@ # cat > Print and concatenate files. -> More information: . +> More information: . - Print the contents of a file to `stdout`: diff --git a/pages/common/cdk.md b/pages/common/cdk.md index c57798700..95cfe5415 100644 --- a/pages/common/cdk.md +++ b/pages/common/cdk.md @@ -23,7 +23,7 @@ `cdk diff {{stack_name}}` -- Create a new CDK project in the current directory for a specified language: +- Create a new CDK project in the current directory for a specified [l]anguage: `cdk init -l {{language}}` diff --git a/pages/common/certutil.md b/pages/common/certutil.md index 903a0aa86..504f4527e 100644 --- a/pages/common/certutil.md +++ b/pages/common/certutil.md @@ -3,7 +3,7 @@ > Manage keys and certificates in both NSS databases and other NSS tokens. > More information: . -- Create a new certificate database: +- Create a [N]ew certificate database in the current [d]irectory: `certutil -N -d .` @@ -11,14 +11,14 @@ `certutil -L -d .` -- List all private keys in a database: +- List all private [K]eys in a database specifying the password [f]ile: `certutil -K -d . -f {{path/to/password_file.txt}}` -- Import the signed certificate into the requesters database: +- [A]dd the signed certificate to the requesters database specifying a [n]ickname, [t]rust attributes and an [i]nput CRT file: `certutil -A -n "{{server_certificate}}" -t ",," -i {{path/to/file.crt}} -d .` -- Add subject alternative names to a given certificate: +- Add subject alternative names to a given [c]ertificate with a specific key size ([g]): `certutil -S -f {{path/to/password_file.txt}} -d . -t ",," -c "{{server_certificate}}" -n "{{server_name}}" -g {{2048}} -s "CN={{common_name}},O={{organization}}"` diff --git a/pages/common/chafa.md b/pages/common/chafa.md index 3721792ac..c166ff32f 100644 --- a/pages/common/chafa.md +++ b/pages/common/chafa.md @@ -2,7 +2,7 @@ > Image printing in the terminal. > See also: `catimg`, `pixterm`. -> More information: . +> More information: . - Render an image directly in the terminal: