diff --git a/pages/common/autoconf.md b/pages/common/autoconf.md index d8b18e9561..0f4c4f9380 100644 --- a/pages/common/autoconf.md +++ b/pages/common/autoconf.md @@ -1,7 +1,7 @@ # autoconf > Generate configuration scripts to automatically configure software source code packages. -> More information: . +> More information: . - Generate a configuration script from `configure.ac` (if present) or `configure.in` and save this script to `configure`: @@ -13,4 +13,4 @@ - Generate a configuration script from the specified template (even if the input file has not changed) and write the output to a file: -`autoconf --force --output {{outfile}} {{template-file}}` +`autoconf {{[-f|--force]}} {{[-o|--output]}} {{outfile}} {{template-file}}` diff --git a/pages/common/b2sum.md b/pages/common/b2sum.md index 03c099346a..7fe7ed467a 100644 --- a/pages/common/b2sum.md +++ b/pages/common/b2sum.md @@ -17,16 +17,16 @@ - Read a file of BLAKE2 checksums and filenames and verify all files have matching checksums: -`b2sum --check {{path/to/file.b2}}` +`b2sum {{[-c|--check]}} {{path/to/file.b2}}` - Only show a message for missing files or when verification fails: -`b2sum --check --quiet {{path/to/file.b2}}` +`b2sum {{[-c|--check]}} --quiet {{path/to/file.b2}}` - Only show a message when verification fails, ignoring missing files: -`b2sum --ignore-missing --check --quiet {{path/to/file.b2}}` +`b2sum --ignore-missing {{[-c|--check]}} --quiet {{path/to/file.b2}}` - Check a known BLAKE2 checksum of a file: -`echo {{known_blake2_checksum_of_the_file}} {{path/to/file}} | b2sum --check` +`echo {{known_blake2_checksum_of_the_file}} {{path/to/file}} | b2sum {{[-c|--check]}}` diff --git a/pages/common/b3sum.md b/pages/common/b3sum.md index 1e4433efc4..5f0ade422e 100644 --- a/pages/common/b3sum.md +++ b/pages/common/b3sum.md @@ -17,12 +17,12 @@ - Read a file of BLAKE3 checksums and filenames and verify all files have matching checksums: -`b3sum --check {{path/to/file.b3}}` +`b3sum {{[-c|--check]}} {{path/to/file.b3}}` - Only show a message for missing files or when verification fails: -`b3sum --check --quiet {{path/to/file.b3}}` +`b3sum {{[-c|--check]}} --quiet {{path/to/file.b3}}` - Check a known BLAKE3 checksum of a file: -`echo {{known_blake3_checksum_of_the_file}} {{path/to/file}} | b3sum --check` +`echo {{known_blake3_checksum_of_the_file}} {{path/to/file}} | b3sum {{[-c|--check]}}` diff --git a/pages/common/bind.md b/pages/common/bind.md index 7c0ba2b77b..2ad896be22 100644 --- a/pages/common/bind.md +++ b/pages/common/bind.md @@ -1,7 +1,7 @@ # bind > Bash builtin to manage bash hotkeys and variables. -> More information: . +> More information: . - List all bound commands and their hotkeys: diff --git a/pages/common/bison.md b/pages/common/bison.md index 0616c9a785..21dcca6b1c 100644 --- a/pages/common/bison.md +++ b/pages/common/bison.md @@ -1,7 +1,7 @@ # bison > GNU parser generator. -> More information: . +> More information: . - Compile a bison definition file: @@ -9,12 +9,12 @@ - Compile in debug mode, which causes the resulting parser to write additional information to `stdout`: -`bison --debug {{path/to/file.y}}` +`bison {{[-t|--debug]}} {{path/to/file.y}}` - Specify the output filename: -`bison --output {{path/to/output.c}} {{path/to/file.y}}` +`bison {{[-o|--output]}} {{path/to/output.c}} {{path/to/file.y}}` - Be verbose when compiling: -`bison --verbose` +`bison {{[-v|--verbose]}}` diff --git a/pages/common/chroot.md b/pages/common/chroot.md index 855e469dee..990e11e747 100644 --- a/pages/common/chroot.md +++ b/pages/common/chroot.md @@ -5,8 +5,8 @@ - Run command as new root directory: -`chroot {{path/to/new/root}} {{command}}` +`sudo chroot {{path/to/new/root}} {{command}}` - Use a specific user and group: -`chroot --userspec={{username_or_id:group_name_or_id}}` +`sudo chroot --userspec {{username_or_id:group_name_or_id}}` diff --git a/pages/common/complete.md b/pages/common/complete.md index b97d0b9d92..a6a7339a40 100644 --- a/pages/common/complete.md +++ b/pages/common/complete.md @@ -1,7 +1,7 @@ # complete > Get argument autocompletion to shell commands. -> More information: . +> More information: . - Apply a function that performs autocompletion to a command: diff --git a/pages/common/cvs.md b/pages/common/cvs.md index db224844e5..462195728d 100644 --- a/pages/common/cvs.md +++ b/pages/common/cvs.md @@ -1,7 +1,7 @@ # cvs > Concurrent Versions System, a revision control system. -> More information: . +> More information: . - Create a new repository (requires the `CVSROOT` environment variable to be set externally): diff --git a/pages/common/date.md b/pages/common/date.md index e08cbbe1a7..44d9aa4765 100644 --- a/pages/common/date.md +++ b/pages/common/date.md @@ -9,7 +9,7 @@ - Display the current date in UTC, using the ISO 8601 format: -`date -u +%Y-%m-%dT%H:%M:%S%Z` +`date {{[-u|--utc]}} +%Y-%m-%dT%H:%M:%S%Z` - Display the current date as a Unix timestamp (seconds since the Unix epoch): @@ -17,11 +17,11 @@ - Convert a date specified as a Unix timestamp to the default format: -`date -d @{{1473305798}}` +`date {{[-d|--date]}} @{{1473305798}}` - Convert a given date to the Unix timestamp format: -`date -d "{{2018-09-01 00:00}}" +%s --utc` +`date {{[-d|--date]}} "{{2018-09-01 00:00}}" +%s {{[-u|--utc]}}` - Display the current date using the RFC-3339 format (`YYYY-MM-DD hh:mm:ss TZ`): diff --git a/pages/common/dc.md b/pages/common/dc.md index 2ff5e930d5..5585dd1e2b 100644 --- a/pages/common/dc.md +++ b/pages/common/dc.md @@ -14,16 +14,16 @@ - Calculate an expression with the specified scale: -`dc --expression='{{10}} k {{5 3 /}} p'` +`dc {{[-e|--expression]}} '{{10}} k {{5 3 /}} p'` - Calculate 4 times 5 (4 5 *), subtract 17 (17 -), and [p]rint the output: -`dc --expression='4 5 * 17 - p'` +`dc {{[-e|--expression]}} '4 5 * 17 - p'` - Specify the number of decimal places to 7 (7 k), calculate 5 divided by -3 (5 _3 /) and [p]rint: -`dc --expression='7 k 5 _3 / p'` +`dc {{[-e|--expression]}} '7 k 5 _3 / p'` - Calculate the golden ratio, phi: set number of decimal places to 100 (100 k), square root of 5 (5 v) plus 1 (1 +), divided by 2 (2 /), and [p]rint result: -`dc --expression='100 k 5 v 1 + 2 / p'` +`dc {{[-e|--expression]}} '100 k 5 v 1 + 2 / p'` diff --git a/pages/common/dircolors.md b/pages/common/dircolors.md index 550aa16cf1..bdbad6d1a2 100644 --- a/pages/common/dircolors.md +++ b/pages/common/dircolors.md @@ -17,12 +17,12 @@ - Output commands for Bourne shell: -`dircolors --bourne-shell` +`dircolors {{[-b|--bourne-shell]}}` - Output commands for C shell: -`dircolors --c-shell` +`dircolors {{[-c|--c-shell]}}` - View the default colors for file types and extensions: -`dircolors --print-data` +`dircolors {{[-p|--print-database]}}` diff --git a/pages/common/dirname.md b/pages/common/dirname.md index ca773286a9..cea79665a1 100644 --- a/pages/common/dirname.md +++ b/pages/common/dirname.md @@ -13,4 +13,4 @@ - Delimit output with a NUL character instead of a newline (useful when combining with `xargs`): -`dirname --zero {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` +`dirname {{[-z|--zero]}} {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` diff --git a/pages/common/emacsclient.md b/pages/common/emacsclient.md index 32ae0ce32c..93decb2bb1 100644 --- a/pages/common/emacsclient.md +++ b/pages/common/emacsclient.md @@ -10,20 +10,20 @@ - Open a file in console mode (without an X window): -`emacsclient --no-window-system {{path/to/file}}` +`emacsclient {{[-nw|--no-window-system]}} {{path/to/file}}` - Open a file in a new Emacs window: -`emacsclient --create-frame {{path/to/file}}` +`emacsclient {{[-c|--create-frame]}} {{path/to/file}}` - Evaluate a command, printing the output to `stdout`, and then quit: -`emacsclient --eval '({{command}})'` +`emacsclient {{[-e|--eval]}} '({{command}})'` - Specify an alternative editor in case no Emacs server is running: -`emacsclient --alternate-editor {{editor}} {{path/to/file}}` +`emacsclient {{[-a|--alternate-editor]}} {{editor}} {{path/to/file}}` - Stop a running Emacs server and all its instances, asking for confirmation on unsaved files: -`emacsclient --eval '(save-buffers-kill-emacs)'` +`emacsclient {{[-e|--eval]}} '(save-buffers-kill-emacs)'` diff --git a/pages/common/enscript.md b/pages/common/enscript.md index 8beb391178..3e7cee95eb 100644 --- a/pages/common/enscript.md +++ b/pages/common/enscript.md @@ -1,19 +1,19 @@ # enscript > Convert text files to PostScript, HTML, RTF, ANSI, and overstrikes. -> More information: . +> More information: . - Generate a PostScript file from a text file: -`enscript {{path/to/input_file}} --output={{path/to/output_file}}` +`enscript {{path/to/input_file}} {{[-o|--output]}} {{path/to/output_file}}` - Generate a file in a different language than PostScript: -`enscript {{path/to/input_file}} --language={{html|rtf|...}} --output={{path/to/output_file}}` +`enscript {{path/to/input_file}} {{[-w|--language]}} {{html|rtf|...}} {{[-o|--output]}} {{path/to/output_file}}` - Generate a PostScript file with a landscape layout, splitting the page into columns (maximum 9): -`enscript {{path/to/input_file}} --columns={{num}} --landscape --output={{path/to/output_file}}` +`enscript {{path/to/input_file}} --columns {{num}} {{[-r|--landscape]}} {{[-o|--output]}} {{path/to/output_file}}` - Display available syntax highlighting languages and file formats: @@ -21,4 +21,4 @@ - Generate a PostScript file with syntax highlighting and color for a specified language: -`enscript {{path/to/input_file}} --color=1 --highlight={{language}} --output={{path/to/output_file}}` +`enscript {{path/to/input_file}} --color 1 {{[-E|--highlight]}} {{language}} {{[-o|--output]}} {{path/to/output_file}}` diff --git a/pages/common/env.md b/pages/common/env.md index 605512a9d6..c5faecf31c 100644 --- a/pages/common/env.md +++ b/pages/common/env.md @@ -13,11 +13,11 @@ - Clear the environment and run a program: -`env -i {{program}}` +`env {{[-i|--ignore-environment]}} {{program}}` - Remove variable from the environment and run a program: -`env -u {{variable}} {{program}}` +`env {{[-u|--unset]}} {{variable}} {{program}}` - Set a variable and run a program: diff --git a/pages/common/expand.md b/pages/common/expand.md index 1a05a8f1b8..c3595c2e5c 100644 --- a/pages/common/expand.md +++ b/pages/common/expand.md @@ -13,12 +13,12 @@ - Do not convert tabs after non blanks: -`expand -i {{path/to/file}}` +`expand {{[-i|--initial]}} {{path/to/file}}` - Have tabs a certain number of characters apart, not 8: -`expand -t {{number}} {{path/to/file}}` +`expand {{[-t|--tabs]}} {{number}} {{path/to/file}}` - Use a comma separated list of explicit tab positions: -`expand -t {{1,4,6}}` +`expand {{[-t|--tabs]}} {{1,4,6}}` diff --git a/pages/common/fgrep.md b/pages/common/fgrep.md index a353340cc1..baaff9b7f4 100644 --- a/pages/common/fgrep.md +++ b/pages/common/fgrep.md @@ -10,20 +10,20 @@ - Search only lines that match entirely in one or more files: -`fgrep -x {{search_string}} {{path/to/file1 path/to/file2 ...}}` +`fgrep {{[-x|--line-regexp]}} {{search_string}} {{path/to/file1 path/to/file2 ...}}` - Count the number of lines that match the given string in a file: -`fgrep -c {{search_string}} {{path/to/file}}` +`fgrep {{[-c|--count]}} {{search_string}} {{path/to/file}}` - Show the line number in the file along with the line matched: -`fgrep -n {{search_string}} {{path/to/file}}` +`fgrep {{[-n|--line-number]}} {{search_string}} {{path/to/file}}` - Display all lines except those that contain the search string: -`fgrep -v {{search_string}} {{path/to/file}}` +`fgrep {{[-v|--invert-match]}} {{search_string}} {{path/to/file}}` - Display filenames whose content matches the search string at least once: -`fgrep -l {{search_string}} {{path/to/file1 path/to/file2 ...}}` +`fgrep {{[-l|--files-with-matches]}} {{search_string}} {{path/to/file1 path/to/file2 ...}}` diff --git a/pages/common/fmt.md b/pages/common/fmt.md index 453c3fabd7..aea3f6795f 100644 --- a/pages/common/fmt.md +++ b/pages/common/fmt.md @@ -9,12 +9,12 @@ - Reformat a file producing output lines of (at most) `n` characters: -`fmt -w {{n}} {{path/to/file}}` +`fmt {{[-w|--width]}} {{n}} {{path/to/file}}` - Reformat a file without joining lines shorter than the given width together: -`fmt -s {{path/to/file}}` +`fmt {{[-s|--split-only]}} {{path/to/file}}` - Reformat a file with uniform spacing (1 space between words and 2 spaces between paragraphs): -`fmt -u {{path/to/file}}` +`fmt {{[-u|--uniform-spacing]}} {{path/to/file}}` diff --git a/pages/common/gnuplot.md b/pages/common/gnuplot.md index 0f21ad88b3..0a4043bc59 100644 --- a/pages/common/gnuplot.md +++ b/pages/common/gnuplot.md @@ -17,4 +17,4 @@ - Persist the graph plot preview window after gnuplot exits: -`gnuplot --persist {{path/to/definition.plt}}` +`gnuplot {{[-p|--persist]}} {{path/to/definition.plt}}` diff --git a/pages/common/gpg-zip.md b/pages/common/gpg-zip.md index 228b2a8d36..c55d9321a5 100644 --- a/pages/common/gpg-zip.md +++ b/pages/common/gpg-zip.md @@ -5,11 +5,11 @@ - Encrypt a directory into `archive.gpg` using a passphrase: -`gpg-zip --symmetric --output {{archive.gpg}} {{path/to/directory}}` +`gpg-zip {{[-c|--symmetric]}} {{[-o|--output]}} {{archive.gpg}} {{path/to/directory}}` - Decrypt `archive.gpg` into a directory of the same name: -`gpg-zip --decrypt {{path/to/archive.gpg}}` +`gpg-zip {{[-d|--decrypt]}} {{path/to/archive.gpg}}` - List the contents of the encrypted `archive.gpg`: diff --git a/pages/common/gpg.md b/pages/common/gpg.md index 7b688f518b..5c890aef5a 100644 --- a/pages/common/gpg.md +++ b/pages/common/gpg.md @@ -5,7 +5,7 @@ - Create a GPG public and private key interactively: -`gpg --full-generate-key` +`gpg {{[--full-gen-key|--full-generate-key]}}` - List all keys from the public keyring: diff --git a/pages/common/gpgconf.md b/pages/common/gpgconf.md index 77c8704afc..60489cc333 100644 --- a/pages/common/gpgconf.md +++ b/pages/common/gpgconf.md @@ -9,7 +9,7 @@ - List the directories used by gpgconf: -`gpgconf --list-dirs` +`gpgconf {{[-L|--list-dirs]}}` - List all options of a component: diff --git a/pages/common/gprof.md b/pages/common/gprof.md index 3a077426ef..3e1ae78963 100644 --- a/pages/common/gprof.md +++ b/pages/common/gprof.md @@ -6,7 +6,7 @@ - Compile binary to default `a.out` with gprof information and run it to get `gmon.out`: -`gcc -pg {{program.c}} && ./a.out` +`gcc {{[-p|-pg]}} {{program.c}} && ./a.out` - Run gprof on default `a.out` and `gmon.out` to obtain profile output: @@ -18,8 +18,8 @@ - Suppress profile field's description: -`gprof -b` +`gprof {{[-b|--brief]}}` - Display routines that have zero usage: -`gprof -bz` +`gprof {{[-bz|--brief --display-unused-functions]}}` diff --git a/pages/common/groff.md b/pages/common/groff.md index 322229200c..70e8904794 100644 --- a/pages/common/groff.md +++ b/pages/common/groff.md @@ -1,7 +1,7 @@ # groff > GNU replacement for the `troff` and `nroff` typesetting utilities. -> More information: . +> More information: . - Format output for a PostScript printer, saving the output to a file: diff --git a/pages/common/hello.md b/pages/common/hello.md index dea693cea7..5c700b992d 100644 --- a/pages/common/hello.md +++ b/pages/common/hello.md @@ -1,7 +1,7 @@ # hello > Print "Hello, world!", "hello, world" or a customizable text. -> More information: . +> More information: . - Print "Hello, world!": @@ -9,8 +9,8 @@ - Print "hello, world", the traditional type: -`hello --traditional` +`hello {{[-t|--traditional]}}` - Print a text message: -`hello --greeting="{{greeting_text}}"` +`hello {{[-g|--greeting]}} "{{greeting_text}}"` diff --git a/pages/common/help2man.md b/pages/common/help2man.md index 2791829d15..86031a9eed 100644 --- a/pages/common/help2man.md +++ b/pages/common/help2man.md @@ -9,15 +9,15 @@ - Specify the "name" paragraph in the man page: -`help2man {{executable}} --name {{name}}` +`help2man {{executable}} {{[-n|--name]}} {{name}}` - Specify the section for the man page (defaults to 1): -`help2man {{executable}} --section {{section}}` +`help2man {{executable}} {{[-s|--section]}} {{section}}` - Output to a file instead of `stdout`: -`help2man {{executable}} --output {{path/to/file}}` +`help2man {{executable}} {{[-o|--output]}} {{path/to/file}}` - Display help: diff --git a/pages/common/history.md b/pages/common/history.md index 1b832fff5f..9133cd1d24 100644 --- a/pages/common/history.md +++ b/pages/common/history.md @@ -1,7 +1,7 @@ # history > Command-line history. -> More information: . +> More information: . - Display the commands history list with line numbers: diff --git a/pages/common/indent.md b/pages/common/indent.md index 38f0c0af9c..e082265810 100644 --- a/pages/common/indent.md +++ b/pages/common/indent.md @@ -1,16 +1,16 @@ # indent > Change the appearance of a C/C++ program by inserting or deleting whitespace. -> More information: . +> More information: . - Format C/C++ source according to the Linux style guide, automatically back up the original files, and replace with the indented versions: -`indent --linux-style {{path/to/source.c}} {{path/to/another_source.c}}` +`indent {{[-linux|--linux-style]}} {{path/to/source.c}} {{path/to/another_source.c}}` - Format C/C++ source according to the GNU style, saving the indented version to a different file: -`indent --gnu-style {{path/to/source.c}} -o {{path/to/indented_source.c}}` +`indent {{[-gnu|--gnu-style]}} {{path/to/source.c}} -o {{path/to/indented_source.c}}` - Format C/C++ source according to the style of Kernighan & Ritchie (K&R), no tabs, 3 spaces per indent, and wrap lines at 120 characters: -`indent --k-and-r-style --indent-level3 --no-tabs --line-length120 {{path/to/source.c}} -o {{path/to/indented_source.c}}` +`indent {{[-kr|--k-and-r-style]}} {{[-il|--indent-level]}}3 {{[-nut|--no-tabs]}} {{[-l|--line-length]}}120 {{path/to/source.c}} -o {{path/to/indented_source.c}}` diff --git a/pages/common/install.md b/pages/common/install.md index 9be5a4e78d..bada5693c6 100644 --- a/pages/common/install.md +++ b/pages/common/install.md @@ -10,19 +10,19 @@ - Copy files to the destination, setting their ownership: -`install --owner {{user}} {{path/to/source_file1 path/to/source_file2 ...}} {{path/to/destination}}` +`install {{[-o|--owner]}} {{user}} {{path/to/source_file1 path/to/source_file2 ...}} {{path/to/destination}}` - Copy files to the destination, setting their group ownership: -`install --group {{user}} {{path/to/source_file1 path/to/source_file2 ...}} {{path/to/destination}}` +`install {{[-g|--group]}} {{user}} {{path/to/source_file1 path/to/source_file2 ...}} {{path/to/destination}}` - Copy files to the destination, setting their `mode`: -`install --mode {{+x}} {{path/to/source_file1 path/to/source_file2 ...}} {{path/to/destination}}` +`install {{[-m|--mode]}} {{+x}} {{path/to/source_file1 path/to/source_file2 ...}} {{path/to/destination}}` - Copy files and apply access/modification times of source to the destination: -`install --preserve-timestamps {{path/to/source_file1 path/to/source_file2 ...}} {{path/to/destination}}` +`install {{[-p|--preserve-timestamps]}} {{path/to/source_file1 path/to/source_file2 ...}} {{path/to/destination}}` - Copy files and create the directories at the destination if they don't exist: diff --git a/pages/common/jcal.md b/pages/common/jcal.md index 4709d81982..b78d308fb9 100644 --- a/pages/common/jcal.md +++ b/pages/common/jcal.md @@ -1,7 +1,7 @@ # jcal > Display calendar information in the Jalali format, with the current day highlighted. -> More information: . +> More information: . - Display a calendar for the current month: diff --git a/pages/common/ls.md b/pages/common/ls.md index ae81525b47..5b950d6ee6 100644 --- a/pages/common/ls.md +++ b/pages/common/ls.md @@ -17,7 +17,7 @@ - List all files in [l]ong format (permissions, ownership, size, and modification date): -`ls {{[-la|--all -l]}}` +`ls {{[-la|-l --all]}}` - List files in [l]ong format with size displayed using human-readable units (KiB, MiB, GiB): diff --git a/pages/common/lzip.md b/pages/common/lzip.md index 4cf44cf40c..ab320a363f 100644 --- a/pages/common/lzip.md +++ b/pages/common/lzip.md @@ -10,28 +10,28 @@ - Archive a file, keeping the input file: -`lzip -k {{path/to/file}}` +`lzip {{[-k|--keep]}} {{path/to/file}}` - Archive a file with the best compression (level=9): -`lzip -k {{path/to/file}} --best` +`lzip {{[-k|--keep]}} {{path/to/file}} --best` - Archive a file at the fastest speed (level=0): -`lzip -k {{path/to/file}} --fast` +`lzip {{[-k|--keep]}} {{path/to/file}} --fast` - Test the integrity of compressed file: -`lzip --test {{path/to/archive.lz}}` +`lzip {{[-t|--test]}} {{path/to/archive.lz}}` - Decompress a file, replacing it with the original uncompressed version: -`lzip -d {{path/to/archive.lz}}` +`lzip {{[-d|--decompress]}} {{path/to/archive.lz}}` - Decompress a file, keeping the archive: -`lzip -d -k {{path/to/archive.lz}}` +`lzip {{[-d|--decompress]}} {{[-k|--keep]}} {{path/to/archive.lz}}` - List files which are in an archive and show compression stats: -`lzip --list {{path/to/archive.lz}}` +`lzip {{[-l|--list]}} {{path/to/archive.lz}}` diff --git a/pages/common/m4.md b/pages/common/m4.md index 9d8c1b314b..3fdbecc155 100644 --- a/pages/common/m4.md +++ b/pages/common/m4.md @@ -9,4 +9,4 @@ - Define a macro before processing files: -`m4 -D{{macro_name}}={{macro_value}} {{path/to/file}}` +`m4 {{[-D|--define]}} {{macro_name}}={{macro_value}} {{path/to/file}}` diff --git a/pages/common/make.md b/pages/common/make.md index 8b9349e21d..623ad178a9 100644 --- a/pages/common/make.md +++ b/pages/common/make.md @@ -14,19 +14,19 @@ - Call a specific target, executing 4 jobs at a time in parallel: -`make -j{{4}} {{target}}` +`make {{[-j|--jobs]}} {{4}} {{target}}` - Use a specific Makefile: -`make --file {{path/to/file}}` +`make {{[-f|--file]}} {{path/to/file}}` - Execute make from another directory: -`make --directory {{path/to/directory}}` +`make {{[-C|--directory]}} {{path/to/directory}}` - Force making of a target, even if source files are unchanged: -`make --always-make {{target}}` +`make {{[-B|--always-make]}} {{target}}` - Override a variable defined in the Makefile: @@ -34,4 +34,4 @@ - Override variables defined in the Makefile by the environment: -`make --environment-overrides {{target}}` +`make {{[-e|--environment-overrides]}} {{target}}` diff --git a/pages/common/md5sum.md b/pages/common/md5sum.md index 865e911b04..b0a8aef0e7 100644 --- a/pages/common/md5sum.md +++ b/pages/common/md5sum.md @@ -17,16 +17,16 @@ - Read a file of MD5 checksums and filenames and verify all files have matching checksums: -`md5sum --check {{path/to/file.md5}}` +`md5sum {{[-c|--check]}} {{path/to/file.md5}}` - Only show a message for missing files or when verification fails: -`md5sum --check --quiet {{path/to/file.md5}}` +`md5sum {{[-c|--check]}} --quiet {{path/to/file.md5}}` - Only show a message when verification fails, ignoring missing files: -`md5sum --ignore-missing --check --quiet {{path/to/file.md5}}` +`md5sum --ignore-missing {{[-c|--check]}} --quiet {{path/to/file.md5}}` - Check a known MD5 checksum of a file: -`echo {{known_md5_checksum_of_the_file}} {{path/to/file}} | md5sum --check` +`echo {{known_md5_checksum_of_the_file}} {{path/to/file}} | md5sum {{[-c|--check]}}` diff --git a/pages/common/mkfifo.md b/pages/common/mkfifo.md index 6d12228cf9..ae22d0171a 100644 --- a/pages/common/mkfifo.md +++ b/pages/common/mkfifo.md @@ -17,4 +17,4 @@ - Share your terminal session in real-time: -`mkfifo {{path/to/pipe}}; script -f {{path/to/pipe}}` +`mkfifo {{path/to/pipe}}; script {{[-f|--flush]}} {{path/to/pipe}}` diff --git a/pages/common/moe.md b/pages/common/moe.md index 63131c8b40..1b0d7fa3ce 100644 --- a/pages/common/moe.md +++ b/pages/common/moe.md @@ -9,15 +9,15 @@ - Open a file as read-only: -`moe --read-only {{path/to/file}}` +`moe {{[-o|--read-only]}} {{path/to/file}}` - Edit a file without creating backups: -`moe --no-backup {{path/to/file}}` +`moe {{[-B|--no-backup]}} {{path/to/file}}` - Edit a file ignoring case in searches: -`moe --ignore-case {{path/to/file}}` +`moe {{[-i|--ignore-case]}} {{path/to/file}}` - Save and Quit: diff --git a/pages/common/numfmt.md b/pages/common/numfmt.md index f4971b72c4..37258b5829 100644 --- a/pages/common/numfmt.md +++ b/pages/common/numfmt.md @@ -5,12 +5,12 @@ - Convert 1.5K (SI Units) to 1500: -`numfmt --from=si 1.5K` +`numfmt --from si 1.5K` - Convert 5th field (1-indexed) to IEC Units without converting header: -`ls -l | numfmt --header=1 --field=5 --to=iec` +`ls -l | numfmt --header=1 --field 5 --to iec` - Convert to IEC units, pad with 5 characters, left aligned: -`du -s * | numfmt --to=iec --format="%-5f"` +`du {{[-s|--summarize]}} * | numfmt --to iec --format "%-5f"` diff --git a/pages/common/oathtool.md b/pages/common/oathtool.md index 25089253ee..7e445f9a66 100644 --- a/pages/common/oathtool.md +++ b/pages/common/oathtool.md @@ -5,12 +5,12 @@ - Generate TOTP token (behaves like Google Authenticator): -`oathtool --totp --base32 "{{secret}}"` +`oathtool --totp {{[-b|--base32]}} "{{secret}}"` - Generate a TOTP token for a specific time: -`oathtool --totp --now "{{2004-02-29 16:21:42}}" --base32 "{{secret}}"` +`oathtool --totp {{[-N|--now]}} "{{2004-02-29 16:21:42}}" {{[-b|--base32]}} "{{secret}}"` - Validate a TOTP token: -`oathtool --totp --base32 "{{secret}}" "{{token}}"` +`oathtool --totp {{[-b|--base32]}} "{{secret}}" "{{token}}"` diff --git a/pages/common/od.md b/pages/common/od.md index 83412ad009..5d47faf334 100644 --- a/pages/common/od.md +++ b/pages/common/od.md @@ -10,20 +10,20 @@ - Display file in verbose mode, i.e. without replacing duplicate lines with `*`: -`od -v {{path/to/file}}` +`od {{[-v|--output-duplicates]}} {{path/to/file}}` - Display file in hexadecimal format (2-byte units), with byte offsets in decimal format: -`od --format={{x}} --address-radix={{d}} -v {{path/to/file}}` +`od {{[-t|--format]}} {{x}} {{[-A|--address-radix]}} {{d}} {{[-v|--output-duplicates]}} {{path/to/file}}` - Display file in hexadecimal format (1-byte units), and 4 bytes per line: -`od --format={{x1}} --width={{4}} -v {{path/to/file}}` +`od {{[-t|--format]}} {{x1}} {{[-w|--width=]}}{{4}} {{[-v|--output-duplicates]}} {{path/to/file}}` - Display file in hexadecimal format along with its character representation, and do not print byte offsets: -`od --format={{xz}} --address-radix={{n}} -v {{path/to/file}}` +`od {{[-t|--format]}} {{xz}} {{[-A|--address-radix]}} {{n}} {{[-v|--output-duplicates]}} {{path/to/file}}` - Read only 100 bytes of a file starting from the 500th byte: -`od --read-bytes 100 --skip-bytes=500 -v {{path/to/file}}` +`od {{[-N|--read-bytes]}} 100 {{[-j|--skip-bytes]}} 500 {{[-v|--output-duplicates]}} {{path/to/file}}` diff --git a/pages/common/parallel.md b/pages/common/parallel.md index 352fab201a..2d9b2e6642 100644 --- a/pages/common/parallel.md +++ b/pages/common/parallel.md @@ -29,8 +29,8 @@ - Download 4 files simultaneously from a text file containing links showing progress: -`parallel -j4 --bar --eta wget -q {} :::: {{path/to/links.txt}}` +`parallel -j4 --bar --eta wget {{[-q|--quote]}} {} :::: {{path/to/links.txt}}` - Print the jobs which `parallel` is running in `stderr`: -`parallel -t {{command}} ::: {{args}}` +`parallel {{[-t|--verbose]}} {{command}} ::: {{args}}` diff --git a/pages/common/paste.md b/pages/common/paste.md index 186ae6c80e..bc9e3e01aa 100644 --- a/pages/common/paste.md +++ b/pages/common/paste.md @@ -5,11 +5,11 @@ - Join all the lines into a single line, using TAB as delimiter: -`paste -s {{path/to/file}}` +`paste {{[-s|--serial]}} {{path/to/file}}` - Join all the lines into a single line, using the specified delimiter: -`paste -s -d {{delimiter}} {{path/to/file}}` +`paste {{[-s|--serial]}} {{[-d|--delimiters]}} {{delimiter}} {{path/to/file}}` - Merge two files side by side, each in its column, using TAB as delimiter: @@ -17,8 +17,8 @@ - Merge two files side by side, each in its column, using the specified delimiter: -`paste -d {{delimiter}} {{path/to/file1}} {{path/to/file2}}` +`paste {{[-d|--delimiters]}} {{delimiter}} {{path/to/file1}} {{path/to/file2}}` - Merge two files, with lines added alternatively: -`paste -d '\n' {{path/to/file1}} {{path/to/file2}}` +`paste {{[-d|--delimiters]}} '\n' {{path/to/file1}} {{path/to/file2}}` diff --git a/pages/common/popd.md b/pages/common/popd.md index 6a2e0a8adb..7894d5df8a 100644 --- a/pages/common/popd.md +++ b/pages/common/popd.md @@ -2,7 +2,7 @@ > Remove a directory placed on the directory stack via the pushd shell built-in. > See also `pushd` to place a directory on the stack and `dirs` to display directory stack contents. -> More information: . +> More information: . - Remove the top directory from the stack and cd to it: diff --git a/pages/common/pr.md b/pages/common/pr.md index 7ba1fc59e3..60b3f55ffc 100644 --- a/pages/common/pr.md +++ b/pages/common/pr.md @@ -9,20 +9,20 @@ - Print with a custom centered header: -`pr -h "{{header}}" {{path/to/file1 path/to/file2 ...}}` +`pr {{[-h|--header]}} "{{header}}" {{path/to/file1 path/to/file2 ...}}` - Print with numbered lines and a custom date format: -`pr -n -D "{{format}}" {{path/to/file1 path/to/file2 ...}}` +`pr {{[-n|--number-lines]}} {{[-D|--date-format]}} "{{format}}" {{path/to/file1 path/to/file2 ...}}` - Print all files together, one in each column, without a header or footer: -`pr -m -T {{path/to/file1 path/to/file2 ...}}` +`pr {{[-m|--merge]}} {{[-T|--omit-pagination]}} {{path/to/file1 path/to/file2 ...}}` - Print, beginning at page 2 up to page 5, with a given page length (including header and footer): -`pr +2:5 -l {{page_length}} {{path/to/file1 path/to/file2 ...}}` +`pr +2:5 {{[-l|--length]}} {{page_length}} {{path/to/file1 path/to/file2 ...}}` - Print with an offset for each line and a truncating custom page width: -`pr -o {{offset}} -W {{width}} {{path/to/file1 path/to/file2 ...}}` +`pr {{[-o|--indent]}} {{offset}} {{[-W|--page_width]}} {{width}} {{path/to/file1 path/to/file2 ...}}` diff --git a/pages/common/printenv.md b/pages/common/printenv.md index 8ccc696a1f..65deb6356c 100644 --- a/pages/common/printenv.md +++ b/pages/common/printenv.md @@ -13,4 +13,4 @@ - Display the value of a variable and end with NUL instead of newline: -`printenv --null {{HOME}}` +`printenv {{[-0|--null]}} {{HOME}}` diff --git a/pages/common/qcp.md b/pages/common/qcp.md index 5e26423b4b..0a9f91b645 100644 --- a/pages/common/qcp.md +++ b/pages/common/qcp.md @@ -1,7 +1,7 @@ # qcp > Copy files using the default text editor to define the filenames. -> More information: . +> More information: . - Copy a single file (open an editor with the source filename on the left and the target filename on the right): @@ -13,4 +13,4 @@ - Copy files, but swap the positions of the source and the target filenames in the editor: -`qcp --option swap {{*.jpg}}` +`qcp {{[-o|--option]}} swap {{*.jpg}}` diff --git a/pages/common/qmv.md b/pages/common/qmv.md index 2a1d31a30a..d406d6a586 100644 --- a/pages/common/qmv.md +++ b/pages/common/qmv.md @@ -1,7 +1,7 @@ # qmv > Move files and directories using the default text editor to define the filenames. -> More information: . +> More information: . - Move a single file (open an editor with the source filename on the left and the target filename on the right): @@ -13,16 +13,16 @@ - Move multiple directories: -`qmv -d {{path/to/directory1}} {{path/to/directory2}} {{path/to/directory3}}` +`qmv {{[-d|--directory]}} {{path/to/directory1}} {{path/to/directory2}} {{path/to/directory3}}` - Move all files and directories inside a directory: -`qmv --recursive {{path/to/directory}}` +`qmv {{[-R|--recursive]}} {{path/to/directory}}` - Move files, but swap the positions of the source and the target filenames in the editor: -`qmv --option swap {{*.jpg}}` +`qmv {{[-o|--option]}} swap {{*.jpg}}` - Rename all files and folders in the current directory, but show only target filenames in the editor (you can think of it as a kind of simple mode): -`qmv --format=do .` +`qmv {{[-f|--format]}} do .` diff --git a/pages/common/readlink.md b/pages/common/readlink.md index 5093e27b39..955a8eaaee 100644 --- a/pages/common/readlink.md +++ b/pages/common/readlink.md @@ -9,4 +9,4 @@ - Get the absolute path to a file: -`readlink -f {{path/to/file}}` +`readlink {{[-f|--canonicalize]}} {{path/to/file}}` diff --git a/pages/common/realpath.md b/pages/common/realpath.md index 6b5b30ac24..7ff82493a9 100644 --- a/pages/common/realpath.md +++ b/pages/common/realpath.md @@ -9,16 +9,16 @@ - Require all path components to exist: -`realpath --canonicalize-existing {{path/to/file_or_directory}}` +`realpath {{[-e|--canonicalize-existing]}} {{path/to/file_or_directory}}` - Resolve ".." components before symlinks: -`realpath --logical {{path/to/file_or_directory}}` +`realpath {{[-L|--logical]}} {{path/to/file_or_directory}}` - Disable symlink expansion: -`realpath --no-symlinks {{path/to/file_or_directory}}` +`realpath {{[-s|--no-symlinks]}} {{path/to/file_or_directory}}` - Suppress error messages: -`realpath --quiet {{path/to/file_or_directory}}` +`realpath {{[-q|--quiet]}} {{path/to/file_or_directory}}` diff --git a/pages/common/recsel.md b/pages/common/recsel.md index 4962356c25..4e345ce057 100644 --- a/pages/common/recsel.md +++ b/pages/common/recsel.md @@ -1,16 +1,16 @@ # recsel > Print records from a recfile: a human-editable, plain text database. -> More information: . +> More information: . - Extract name and version field: -`recsel -p name,version {{data.rec}}` +`recsel {{[-p|--print]}} name,version {{data.rec}}` - Use "~" to match a string with a given regular expression: -`recsel -e "{{field_name}} ~ '{{regular_expression}}' {{data.rec}}"` +`recsel {{[-e|--expression]}} "{{field_name}} ~ '{{regular_expression}}' {{data.rec}}"` - Use a predicate to match a name and a version: -`recsel -e "name ~ '{{regular_expression}}' && version ~ '{{regular_expression}}'" {{data.rec}}` +`recsel {{[-e|--expression]}} "name ~ '{{regular_expression}}' && version ~ '{{regular_expression}}'" {{data.rec}}` diff --git a/pages/common/rgrep.md b/pages/common/rgrep.md index c3bf985145..e996f1ed4d 100644 --- a/pages/common/rgrep.md +++ b/pages/common/rgrep.md @@ -2,7 +2,7 @@ > Recursively find patterns in files using regular expressions. > Equivalent to `grep -r`. -> More information: . +> More information: . - Recursively search for a pattern in the current working directory: @@ -10,15 +10,15 @@ - Recursively search for a case-insensitive pattern in the current working directory: -`rgrep --ignore-case "{{search_pattern}}"` +`rgrep {{[-i|--ignore-case]}} "{{search_pattern}}"` - Recursively search for an extended regular expression pattern (supports `?`, `+`, `{}`, `()` and `|`) in the current working directory: -`rgrep --extended-regexp "{{search_pattern}}"` +`rgrep {{[-E|--extended-regexp]}} "{{search_pattern}}"` - Recursively search for an exact string (disables regular expressions) in the current working directory: -`rgrep --fixed-strings "{{exact_string}}"` +`rgrep {{[-F|--fixed-strings]}} "{{exact_string}}"` - Recursively search for a pattern in a specified directory (or file): diff --git a/pages/common/scheme.md b/pages/common/scheme.md index db9bacd033..fe6fab8f3b 100644 --- a/pages/common/scheme.md +++ b/pages/common/scheme.md @@ -1,7 +1,7 @@ # scheme > MIT Scheme language interpreter and REPL (interactive shell). -> More information: . +> More information: . - Start a REPL (interactive shell): diff --git a/pages/common/sha1sum.md b/pages/common/sha1sum.md index aa20673b4b..1699904eb1 100644 --- a/pages/common/sha1sum.md +++ b/pages/common/sha1sum.md @@ -17,16 +17,16 @@ - Read a file of SHA1 checksums and filenames and verify all files have matching checksums: -`sha1sum --check {{path/to/file.sha1}}` +`sha1sum {{[-c|--check]}} {{path/to/file.sha1}}` - Only show a message for missing files or when verification fails: -`sha1sum --check --quiet {{path/to/file.sha1}}` +`sha1sum {{[-c|--check]}} --quiet {{path/to/file.sha1}}` - Only show a message when verification fails, ignoring missing files: -`sha1sum --ignore-missing --check --quiet {{path/to/file.sha1}}` +`sha1sum --ignore-missing {{[-c|--check]}} --quiet {{path/to/file.sha1}}` - Check a known SHA1 checksum of a file: -`echo {{known_sha1_checksum_of_the_file}} {{path/to/file}} | sha1sum --check` +`echo {{known_sha1_checksum_of_the_file}} {{path/to/file}} | sha1sum {{[-c|--check]}}` diff --git a/pages/common/sha224sum.md b/pages/common/sha224sum.md index 582aa07a75..97c8ce2888 100644 --- a/pages/common/sha224sum.md +++ b/pages/common/sha224sum.md @@ -17,16 +17,16 @@ - Read a file of SHA224 checksums and filenames and verify all files have matching checksums: -`sha224sum --check {{path/to/file.sha224}}` +`sha224sum {{[-c|--check]}} {{path/to/file.sha224}}` - Only show a message for missing files or when verification fails: -`sha224sum --check --quiet {{path/to/file.sha224}}` +`sha224sum {{[-c|--check]}} --quiet {{path/to/file.sha224}}` - Only show a message when verification fails, ignoring missing files: -`sha224sum --ignore-missing --check --quiet {{path/to/file.sha224}}` +`sha224sum --ignore-missing {{[-c|--check]}} --quiet {{path/to/file.sha224}}` - Check a known SHA224 checksum of a file: -`echo {{known_sha224_checksum_of_the_file}} {{path/to/file}} | sha224sum --check` +`echo {{known_sha224_checksum_of_the_file}} {{path/to/file}} | sha224sum {{[-c|--check]}}` diff --git a/pages/common/sha256sum.md b/pages/common/sha256sum.md index 3af623464f..8d8d813e47 100644 --- a/pages/common/sha256sum.md +++ b/pages/common/sha256sum.md @@ -17,16 +17,16 @@ - Read a file of SHA256 checksums and filenames and verify all files have matching checksums: -`sha256sum --check {{path/to/file.sha256}}` +`sha256sum {{[-c|--check]}} {{path/to/file.sha256}}` - Only show a message for missing files or when verification fails: -`sha256sum --check --quiet {{path/to/file.sha256}}` +`sha256sum {{[-c|--check]}} --quiet {{path/to/file.sha256}}` - Only show a message when verification fails, ignoring missing files: -`sha256sum --ignore-missing --check --quiet {{path/to/file.sha256}}` +`sha256sum --ignore-missing {{[-c|--check]}} --quiet {{path/to/file.sha256}}` - Check a known SHA256 checksum of a file: -`echo {{known_sha256_checksum_of_the_file}} {{path/to/file}} | sha256sum --check` +`echo {{known_sha256_checksum_of_the_file}} {{path/to/file}} | sha256sum {{[-c|--check]}}` diff --git a/pages/common/sha384sum.md b/pages/common/sha384sum.md index 9797d33e24..4ebd8289d1 100644 --- a/pages/common/sha384sum.md +++ b/pages/common/sha384sum.md @@ -17,16 +17,16 @@ - Read a file of SHA384 checksums and filenames and verify all files have matching checksums: -`sha384sum --check {{path/to/file.sha384}}` +`sha384sum {{[-c|--check]}} {{path/to/file.sha384}}` - Only show a message for missing files or when verification fails: -`sha384sum --check --quiet {{path/to/file.sha384}}` +`sha384sum {{[-c|--check]}} --quiet {{path/to/file.sha384}}` - Only show a message when verification fails, ignoring missing files: -`sha384sum --ignore-missing --check --quiet {{path/to/file.sha384}}` +`sha384sum --ignore-missing {{[-c|--check]}} --quiet {{path/to/file.sha384}}` - Check a known SHA384 checksum of a file: -`echo {{known_sha384_checksum_of_the_file}} {{path/to/file}} | sha384sum --check` +`echo {{known_sha384_checksum_of_the_file}} {{path/to/file}} | sha384sum {{[-c|--check]}}` diff --git a/pages/common/sha512sum.md b/pages/common/sha512sum.md index 6f7cccbe69..2a723bbd36 100644 --- a/pages/common/sha512sum.md +++ b/pages/common/sha512sum.md @@ -17,16 +17,16 @@ - Read a file of SHA512 checksums and filenames and verify all files have matching checksums: -`sha512sum --check {{path/to/file.sha512}}` +`sha512sum {{[-c|--check]}} {{path/to/file.sha512}}` - Only show a message for missing files or when verification fails: -`sha512sum --check --quiet {{path/to/file.sha512}}` +`sha512sum {{[-c|--check]}} --quiet {{path/to/file.sha512}}` - Only show a message when verification fails, ignoring missing files: -`sha512sum --ignore-missing --check --quiet {{path/to/file.sha512}}` +`sha512sum --ignore-missing {{[-c|--check]}} --quiet {{path/to/file.sha512}}` - Check a known SHA512 checksum of a file: -`echo {{known_sha512_checksum_of_the_file}} {{path/to/file}} | sha512sum --check` +`echo {{known_sha512_checksum_of_the_file}} {{path/to/file}} | sha512sum {{[-c|--check]}}` diff --git a/pages/common/shasum.md b/pages/common/shasum.md index b58e6b462a..1020aedb31 100644 --- a/pages/common/shasum.md +++ b/pages/common/shasum.md @@ -21,16 +21,16 @@ - Read a file of SHA checksums and filenames and verify all files have matching checksums (the algorithm will be automatically detected): -`shasum --check {{path/to/file}}` +`shasum {{[-c|--check]}} {{path/to/file}}` - Only show a message for missing files or when verification fails: -`shasum --check --quiet {{path/to/file}}` +`shasum {{[-c|--check]}} --quiet {{path/to/file}}` - Only show a message when verification fails, ignoring missing files: -`shasum --ignore-missing --check --quiet {{path/to/file}}` +`shasum --ignore-missing {{[-c|--check]}} --quiet {{path/to/file}}` - Check a known SHA checksum of a file: -`echo {{known_sha_checksum_of_the_file}} {{path/to/file}} | shasum --check` +`echo {{known_sha_checksum_of_the_file}} {{path/to/file}} | shasum {{[-c|--check]}}` diff --git a/pages/common/shuf.md b/pages/common/shuf.md index e732bcd34a..e052431dcf 100644 --- a/pages/common/shuf.md +++ b/pages/common/shuf.md @@ -9,12 +9,12 @@ - Only output the first 5 entries of the result: -`shuf --head-count=5 {{path/to/file}}` +`shuf {{[-n|--head-count]}} 5 {{path/to/file}}` - Write the output to another file: -`shuf {{path/to/input_file}} --output={{path/to/output_file}}` +`shuf {{path/to/input_file}} {{[-o|--output]}} {{path/to/output_file}}` - Generate 3 random numbers in the range 1-10 (inclusive): -`shuf --head-count=3 --input-range=1-10 --repeat` +`shuf {{[-n|--head-count]}} 3 {{[-i|--input-range]}} 1-10 {{[-r|--repeat]}}` diff --git a/pages/common/split.md b/pages/common/split.md index fe41ea388d..afa987c36a 100644 --- a/pages/common/split.md +++ b/pages/common/split.md @@ -5,16 +5,16 @@ - Split a file, each split having 10 lines (except the last split): -`split -l 10 {{path/to/file}}` +`split {{[-l|--lines]}} 10 {{path/to/file}}` - Split a file into 5 files. File is split such that each split has same size (except the last split): -`split -n 5 {{path/to/file}}` +`split {{[-n|--number]}} 5 {{path/to/file}}` - Split a file with 512 bytes in each split (except the last split; use 512k for kilobytes and 512m for megabytes): -`split -b 512 {{path/to/file}}` +`split {{[-b|--bytes]}} 512 {{path/to/file}}` - Split a file with at most 512 bytes in each split without breaking lines: -`split -C 512 {{path/to/file}}` +`split {{[-C|--line-bytes]}} 512 {{path/to/file}}` diff --git a/pages/common/stat.md b/pages/common/stat.md index 3f36f96fc7..3849c6999d 100644 --- a/pages/common/stat.md +++ b/pages/common/stat.md @@ -9,20 +9,20 @@ - Display properties about a specific file such as size, permissions, creation and access dates among others without labels: -`stat --terse {{path/to/file}}` +`stat {{[-t|--terse]}} {{path/to/file}}` - Display information about the filesystem where a specific file is located: -`stat --file-system {{path/to/file}}` +`stat {{[-f|--file-system]}} {{path/to/file}}` - Show only octal file permissions: -`stat --format="%a %n" {{path/to/file}}` +`stat {{[-c|--format]}} "%a %n" {{path/to/file}}` - Show the owner and group of a specific file: -`stat --format="%U %G" {{path/to/file}}` +`stat {{[-c|--format]}} "%U %G" {{path/to/file}}` - Show the size of a specific file in bytes: -`stat --format="%s %n" {{path/to/file}}` +`stat {{[-c|--format]}} "%s %n" {{path/to/file}}` diff --git a/pages/common/stdbuf.md b/pages/common/stdbuf.md index 063dc42929..7b4a7753d2 100644 --- a/pages/common/stdbuf.md +++ b/pages/common/stdbuf.md @@ -5,12 +5,12 @@ - Change `stdin` buffer size to 512 KiB: -`stdbuf --input=512K {{command}}` +`stdbuf {{[-i|--input]}} 512K {{command}}` - Change `stdout` buffer to line-buffered: -`stdbuf --output=L {{command}}` +`stdbuf {{[-o|--output]}} L {{command}}` - Change `stderr` buffer to unbuffered: -`stdbuf --error=0 {{command}}` +`stdbuf {{[-e|--error]}} 0 {{command}}` diff --git a/pages/common/stow.md b/pages/common/stow.md index 8437cde984..07790c0990 100644 --- a/pages/common/stow.md +++ b/pages/common/stow.md @@ -3,24 +3,24 @@ > Symlink manager. > Often used to manage dotfiles. > See also: `chezmoi`, `tuckr`, `vcsh`, `homeshick`. -> More information: . +> More information: . - Symlink all files recursively to a given directory: -`stow --target={{path/to/target_directory}} {{file1 directory1 file2 directory2}}` +`stow {{[-t|--target]}} {{path/to/target_directory}} {{file1 directory1 file2 directory2}}` - Delete symlinks recursively from a given directory: -`stow --delete --target={{path/to/target_directory}} {{file1 directory1 file2 directory2}}` +`stow {{[-D|--delete]}} {{[-t|--target]}} {{path/to/target_directory}} {{file1 directory1 file2 directory2}}` - Simulate to see what the result would be like: -`stow --simulate --target={{path/to/target_directory}} {{file1 directory1 file2 directory2}}` +`stow {{[-n|--simulate]}} {{[-t|--target]}} {{path/to/target_directory}} {{file1 directory1 file2 directory2}}` - Delete and resymlink: -`stow --restow --target={{path/to/target_directory}} {{file1 directory1 file2 directory2}}` +`stow {{[-R|--restow]}} {{[-t|--target]}} {{path/to/target_directory}} {{file1 directory1 file2 directory2}}` - Exclude files matching a regular expression: -`stow --ignore={{regular_expression}} --target={{path/to/target_directory}} {{file1 directory1 file2 directory2}}` +`stow --ignore={{regular_expression}} {{[-t|--target]}} {{path/to/target_directory}} {{file1 directory1 file2 directory2}}` diff --git a/pages/common/stty.md b/pages/common/stty.md index 87df694132..fc415405e7 100644 --- a/pages/common/stty.md +++ b/pages/common/stty.md @@ -5,7 +5,7 @@ - Display all settings for the current terminal: -`stty --all` +`stty {{[-a|--all]}}` - Set the number of rows or columns: @@ -13,7 +13,7 @@ - Get the actual transfer speed of a device: -`stty --file {{path/to/device_file}} speed` +`stty {{[-F|--file]}} {{path/to/device_file}} speed` - Reset all modes to reasonable values for the current terminal: diff --git a/pages/common/sum.md b/pages/common/sum.md index 8a17180784..0ea3ec41b6 100644 --- a/pages/common/sum.md +++ b/pages/common/sum.md @@ -10,4 +10,4 @@ - Compute a checksum with System V-compatible algorithm and 512-byte blocks: -`sum --sysv {{path/to/file}}` +`sum {{[-s|--sysv]}} {{path/to/file}}` diff --git a/pages/common/timeout.md b/pages/common/timeout.md index 0ef8ef6a32..90899f7f25 100644 --- a/pages/common/timeout.md +++ b/pages/common/timeout.md @@ -7,18 +7,18 @@ `timeout 3s sleep 10` -- Send a [s]ignal to the command after the time limit expires (`TERM` by default, `kill -l` to list all signals): +- Send a signal to the command after the time limit expires (`TERM` by default, `kill -l` to list all signals): -`timeout --signal {{INT|HUP|KILL|...}} {{5s}} {{sleep 10}}` +`timeout {{[-s|--signal]}} {{INT|HUP|KILL|...}} {{5s}} {{sleep 10}}` -- Send [v]erbose output to `stderr` showing signal sent upon timeout: +- Send verbose output to `stderr` showing signal sent upon timeout: -`timeout --verbose {{0.5s|1m|1h|1d|...}} {{command}}` +`timeout {{[-v|--verbose]}} {{0.5s|1m|1h|1d|...}} {{command}}` - Preserve the exit status of the command regardless of timing out: -`timeout --preserve-status {{1s|1m|1h|1d|...}} {{command}}` +`timeout {{[-p|--preserve-status]}} {{1s|1m|1h|1d|...}} {{command}}` - Send a forceful `KILL` signal after certain duration if the command ignores initial signal upon timeout: -`timeout --kill-after={{5m}} {{30s}} {{command}}` +`timeout {{[-k|--kill-after]}} {{5m}} {{30s}} {{command}}` diff --git a/pages/common/tr.md b/pages/common/tr.md index 67e03063cd..705758a773 100644 --- a/pages/common/tr.md +++ b/pages/common/tr.md @@ -17,11 +17,11 @@ - Delete all occurrences of the specified set of characters from the input: -`tr -d '{{input_characters}}' < {{path/to/file}}` +`tr {{[-d|--delete]}} '{{input_characters}}' < {{path/to/file}}` - Compress a series of identical characters to a single character: -`tr -s '{{input_characters}}' < {{path/to/file}}` +`tr {{[-s|--squeeze-repeats]}} '{{input_characters}}' < {{path/to/file}}` - Translate the contents of a file to upper-case: @@ -29,4 +29,4 @@ - Strip out non-printable characters from a file: -`tr -cd "[:print:]" < {{path/to/file}}` +`tr {{[-cd|--complement --delete]}} "[:print:]" < {{path/to/file}}` diff --git a/pages/common/truncate.md b/pages/common/truncate.md index 8f81741f24..5e03695e5f 100644 --- a/pages/common/truncate.md +++ b/pages/common/truncate.md @@ -5,20 +5,20 @@ - Set a size of 10 GB to an existing file, or create a new file with the specified size: -`truncate --size 10G {{path/to/file}}` +`truncate {{[-s|--size]}} 10G {{path/to/file}}` - Extend the file size by 50 MiB, fill with holes (which reads as zero bytes): -`truncate --size +50M {{path/to/file}}` +`truncate {{[-s|--size]}} +50M {{path/to/file}}` - Shrink the file by 2 GiB, by removing data from the end of file: -`truncate --size -2G {{path/to/file}}` +`truncate {{[-s|--size]}} -2G {{path/to/file}}` - Empty the file's content: -`truncate --size 0 {{path/to/file}}` +`truncate {{[-s|--size]}} 0 {{path/to/file}}` - Empty the file's content, but do not create the file if it does not exist: -`truncate --no-create --size 0 {{path/to/file}}` +`truncate {{[-c|--no-create]}} {{[-s|--size]}} 0 {{path/to/file}}` diff --git a/pages/common/unexpand.md b/pages/common/unexpand.md index 96feae3012..bf6d4c237d 100644 --- a/pages/common/unexpand.md +++ b/pages/common/unexpand.md @@ -13,7 +13,7 @@ - Convert all blanks, instead of just initial blanks: -`unexpand -a {{path/to/file}}` +`unexpand {{[-a|--all]}} {{path/to/file}}` - Convert only leading sequences of blanks (overrides -a): @@ -21,4 +21,4 @@ - Have tabs a certain number of characters apart, not 8 (enables -a): -`unexpand -t {{number}} {{path/to/file}}` +`unexpand {{[-t|--tabs]}} {{number}} {{path/to/file}}` diff --git a/pages/common/until.md b/pages/common/until.md index a592815e98..f6974b3aa2 100644 --- a/pages/common/until.md +++ b/pages/common/until.md @@ -9,4 +9,4 @@ - Wait for a systemd service to be active: -`until systemctl is-active --quiet {{nginx}}; do {{echo "Waiting..."}}; sleep 1; done; {{echo "Launched!"}}` +`until systemctl is-active {{[-q|--quiet]}} {{nginx}}; do {{echo "Waiting..."}}; sleep 1; done; {{echo "Launched!"}}` diff --git a/pages/common/virt-sysprep.md b/pages/common/virt-sysprep.md index 863a1ae6ba..7fa9afb704 100644 --- a/pages/common/virt-sysprep.md +++ b/pages/common/virt-sysprep.md @@ -9,19 +9,19 @@ - Remove sensitive system data from a virtual machine image: -`sudo virt-sysprep --add {{path/to/image.qcow2}}` +`sudo virt-sysprep {{[-a|--add]}} {{path/to/image.qcow2}}` - Specify a virtual machine by its name and run all enabled operations but don't actually apply the changes: -`sudo virt-sysprep --domain {{vm_name}} --dry-run` +`sudo virt-sysprep {{[-d|--domain]}} {{vm_name}} {{[-n|--dry-run]}}` - Run only the specified operations: -`sudo virt-sysprep --domain {{vm_name}} --operations {{operation1,operation2,...}}` +`sudo virt-sysprep {{[-d|--domain]}} {{vm_name}} --operations {{operation1,operation2,...}}` - Generate a new `/etc/machine-id` file and enable customizations to be able to change the host name to avoid network conflicts: -`sudo virt-sysprep --domain {{vm_name}} --enable {{customizations}} --hostname {{host_name}} --operation {{machine-id}}` +`sudo virt-sysprep {{[-d|--domain]}} {{vm_name}} --enable {{customizations}} --hostname {{host_name}} --operation {{machine-id}}` - Display help: diff --git a/pages/common/wdiff.md b/pages/common/wdiff.md index d90a38ef81..5034078b79 100644 --- a/pages/common/wdiff.md +++ b/pages/common/wdiff.md @@ -1,7 +1,7 @@ # wdiff > Display word differences between text files. -> More information: . +> More information: . - Compare two files: @@ -9,8 +9,8 @@ - Ignore case when comparing: -`wdiff --ignore-case {{path/to/file1}} {{path/to/file2}}` +`wdiff {{[-i|--ignore-case]}} {{path/to/file1}} {{path/to/file2}}` - Display how many words are deleted, inserted or replaced: -`wdiff --statistics {{path/to/file1}} {{path/to/file2}}` +`wdiff {{[-s|--statistics]}} {{path/to/file1}} {{path/to/file2}}` diff --git a/pages/common/wget2.md b/pages/common/wget2.md index 922d7cbae8..4baab81216 100644 --- a/pages/common/wget2.md +++ b/pages/common/wget2.md @@ -3,7 +3,7 @@ > An improved version of `wget` for downloading files from the web. > Supports HTTP, HTTPS, and HTTP/2 protocols with enhanced performance. > By default, `wget2` uses multiple threads for faster downloads. -> More information: . +> More information: . - Download the contents of a URL to a file using multiple threads (default behavior differs from `wget`): @@ -11,28 +11,28 @@ - Limit the number of threads used for downloading (default is 5 threads): -`wget2 --max-threads={{10}} {{https://example.com/foo}}` +`wget2 --max-threads {{10}} {{https://example.com/foo}}` - Download a single web page and all its resources (scripts, stylesheets, images, etc.): -`wget2 --page-requisites --convert-links {{https://example.com/somepage.html}}` +`wget2 {{[-p|--page-requisites]}} {{[-k|--convert-links]}} {{https://example.com/somepage.html}}` - Mirror a website, but do not ascend to the parent directory (does not download embedded page elements): -`wget2 --mirror --no-parent {{https://example.com/somepath/}}` +`wget2 {{[-m|--mirror]}} {{[-np|--no-parent]}} {{https://example.com/somepath/}}` - Limit the download speed and the number of connection retries: -`wget2 --limit-rate={{300k}} --tries={{100}} {{https://example.com/somepath/}}` +`wget2 --limit-rate {{300k}} {{[-t|--tries]}} {{100}} {{https://example.com/somepath/}}` - Continue an incomplete download (behavior is consistent with `wget`): -`wget2 --continue {{https://example.com}}` +`wget2 {{[-c|--continue]}} {{https://example.com}}` - Download all URLs stored in a text file to a specific directory: -`wget2 --directory-prefix {{path/to/directory}} --input-file {{URLs.txt}}` +`wget2 {{[-P|--directory-prefix]}} {{path/to/directory}} {{[-i|--input-file]}} {{URLs.txt}}` - Download a file from an HTTP server using Basic Auth (also works for HTTPS): -`wget2 --user={{username}} --password={{password}} {{https://example.com}}` +`wget2 --user {{username}} --password {{password}} {{https://example.com}}` diff --git a/pages/common/zcat.md b/pages/common/zcat.md index bfe74c9824..7a6ae109f6 100644 --- a/pages/common/zcat.md +++ b/pages/common/zcat.md @@ -9,4 +9,4 @@ - Print compression details of a `gzip` archive to `stdout`: -`zcat -l {{file.txt.gz}}` +`zcat {{[-l|--list]}} {{file.txt.gz}}` diff --git a/pages/linux/ac.md b/pages/linux/ac.md index 5318fe6626..7caea58c19 100644 --- a/pages/linux/ac.md +++ b/pages/linux/ac.md @@ -9,15 +9,15 @@ - Print how long users have been connected in hours: -`ac --individual-totals` +`ac {{[-p|--individual-totals]}}` - Print how long a particular user has been connected in hours: -`ac --individual-totals {{username}}` +`ac {{[-p|--individual-totals]}} {{username}}` - Print how long a particular user has been connected in hours per day (with total): -`ac --daily-totals --individual-totals {{username}}` +`ac {{[-d|--daily-totals]}} {{[-p|--individual-totals]}} {{username}}` - Also display additional details: diff --git a/pages/linux/atool.md b/pages/linux/atool.md index d0e034d45c..ab976540ce 100644 --- a/pages/linux/atool.md +++ b/pages/linux/atool.md @@ -1,20 +1,20 @@ # atool > Manage archives of various formats. -> More information: . +> More information: . - List files in a Zip archive: -`atool --list {{path/to/archive.zip}}` +`atool {{[-l|--list]}} {{path/to/archive.zip}}` - Unpack a tar.gz archive into a new subdirectory (or current directory if it contains only one file): -`atool --extract {{path/to/archive.tar.gz}}` +`atool {{[-x|--extract]}} {{path/to/archive.tar.gz}}` - Create a new 7z archive with two files: -`atool --add {{path/to/archive.7z}} {{path/to/file1 path/to/file2 ...}}` +`atool {{[-a|--add]}} {{path/to/archive.7z}} {{path/to/file1 path/to/file2 ...}}` - Extract all Zip and rar archives in the current directory: -`atool --each --extract {{*.zip *.rar}}` +`atool {{[-e|--each]}} {{[-E|--extract]}} {{*.zip *.rar}}` diff --git a/pages/linux/chcon.md b/pages/linux/chcon.md index c12603a147..e199dee0e8 100644 --- a/pages/linux/chcon.md +++ b/pages/linux/chcon.md @@ -6,11 +6,11 @@ - View security context of a file: -`ls -lZ {{path/to/file}}` +`ls {{[-lZ|-l --context]}} {{path/to/file}}` - Change the security context of a target file, using a reference file: -`chcon --reference={{reference_file}} {{target_file}}` +`chcon --reference {{reference_file}} {{target_file}}` - Change the full SELinux security context of a file: @@ -18,16 +18,16 @@ - Change only the user part of SELinux security context: -`chcon -u {{user}} {{filename}}` +`chcon {{[-u|--user]}} {{user}} {{filename}}` - Change only the role part of SELinux security context: -`chcon -r {{role}} {{filename}}` +`chcon {{[-r|--role]}} {{role}} {{filename}}` - Change only the type part of SELinux security context: -`chcon -t {{type}} {{filename}}` +`chcon {{[-t|--type]}} {{type}} {{filename}}` - Change only the range/level part of SELinux security context: -`chcon -l {{range/level}} {{filename}}` +`chcon {{[-l|--range]}} {{range/level}} {{filename}}` diff --git a/pages/linux/chfn.md b/pages/linux/chfn.md index dabb6c4d57..604a132bc5 100644 --- a/pages/linux/chfn.md +++ b/pages/linux/chfn.md @@ -5,16 +5,16 @@ - Update a user's "Name" field in the output of `finger`: -`chfn -f {{new_display_name}} {{username}}` +`chfn {{[-f|--full-name]}} {{new_display_name}} {{username}}` - Update a user's "Office Room Number" field for the output of `finger`: -`chfn -o {{new_office_room_number}} {{username}}` +`chfn {{[-o|--office]}} {{new_office_room_number}} {{username}}` - Update a user's "Office Phone Number" field for the output of `finger`: -`chfn -p {{new_office_telephone_number}} {{username}}` +`chfn {{[-p|--office-phone]}} {{new_office_telephone_number}} {{username}}` - Update a user's "Home Phone Number" field for the output of `finger`: -`chfn -h {{new_home_telephone_number}} {{username}}` +`chfn {{[-h|--home-phone]}} {{new_home_telephone_number}} {{username}}` diff --git a/pages/linux/csplit.md b/pages/linux/csplit.md index 0b1a55e8b2..ebf03fc9c3 100644 --- a/pages/linux/csplit.md +++ b/pages/linux/csplit.md @@ -14,11 +14,11 @@ - Split a file every 5 lines, ignoring exact-division error: -`csplit -k {{path/to/file}} 5 {*}` +`csplit {{[-k|--keep-files]}} {{path/to/file}} 5 {*}` - Split a file at line 5 and use a custom prefix for the output files: -`csplit {{path/to/file}} 5 -f {{prefix}}` +`csplit {{path/to/file}} 5 {{[-f|--prefix]}} {{prefix}}` - Split a file at a line matching a regular expression: diff --git a/pages/linux/datamash.md b/pages/linux/datamash.md index 80ebfa5fda..db0c73388e 100644 --- a/pages/linux/datamash.md +++ b/pages/linux/datamash.md @@ -1,7 +1,7 @@ # datamash > Perform basic numeric, textual and statistical operations on input textual data files. -> More information: . +> More information: . - Get max, min, mean and median of a single column of numbers: @@ -13,7 +13,7 @@ - Get the mean of a single column of numbers with a given decimal precision: -`echo -e '1\n2\n3\n4\n5\n5' | datamash -R {{number_of_decimals_wanted}} mean 1` +`echo -e '1\n2\n3\n4\n5\n5' | datamash {{[-R|--round]}} {{number_of_decimals_wanted}} mean 1` - Get the mean of a single column of numbers ignoring "Na" and "NaN" (literal) strings: diff --git a/pages/linux/ddrescue.md b/pages/linux/ddrescue.md index 11a76bd56a..ae1d705659 100644 --- a/pages/linux/ddrescue.md +++ b/pages/linux/ddrescue.md @@ -1,7 +1,7 @@ # ddrescue > Data recovery tool that reads data from damaged block devices. -> More information: . +> More information: . - Take an image of a device, creating a log file: @@ -9,4 +9,4 @@ - Clone Disk A to Disk B, creating a log file: -`sudo ddrescue --force --no-scrape {{/dev/sdX}} {{/dev/sdY}} {{path/to/log.txt}}` +`sudo ddrescue {{[-f|--force]}} {{[-n|--no-scrape]}} {{/dev/sdX}} {{/dev/sdY}} {{path/to/log.txt}}` diff --git a/pages/linux/diff3.md b/pages/linux/diff3.md index 879402b06c..4124921b22 100644 --- a/pages/linux/diff3.md +++ b/pages/linux/diff3.md @@ -9,4 +9,4 @@ - Show all changes, outlining conflicts: -`diff3 --show-all {{path/to/file1}} {{path/to/file2}} {{path/to/file3}}` +`diff3 {{[-A|--show-all]}} {{path/to/file1}} {{path/to/file2}} {{path/to/file3}}` diff --git a/pages/linux/fold.md b/pages/linux/fold.md index 95f47f324c..e29ff8c5c0 100644 --- a/pages/linux/fold.md +++ b/pages/linux/fold.md @@ -5,12 +5,12 @@ - Fold lines in a fixed width: -`fold --width {{width}} {{path/to/file}}` +`fold {{[-w|--width]}} {{width}} {{path/to/file}}` - Count width in bytes (the default is to count in columns): -`fold --bytes --width {{width_in_bytes}} {{path/to/file}}` +`fold {{[-b|--bytes]}} {{[-w|--width]}} {{width_in_bytes}} {{path/to/file}}` - Break the line after the rightmost blank within the width limit: -`fold --spaces --width {{width}} {{path/to/file}}` +`fold {{[-s|--spaces]}} {{[-w|--width]}} {{width}} {{path/to/file}}` diff --git a/pages/linux/gcov.md b/pages/linux/gcov.md index c03c9d059a..11548c19e3 100644 --- a/pages/linux/gcov.md +++ b/pages/linux/gcov.md @@ -10,20 +10,20 @@ - Write individual execution counts for every basic block: -`gcov --all-blocks {{path/to/file.cpp}}` +`gcov {{[-a|--all-blocks]}} {{path/to/file.cpp}}` - Write branch frequencies to the output file and print summary information to `stdout` as a percentage: -`gcov --branch-probabilities {{path/to/file.cpp}}` +`gcov {{[-b|--branch-probabilities]}} {{path/to/file.cpp}}` - Write branch frequencies as the number of branches taken, rather than the percentage: -`gcov --branch-counts {{path/to/file.cpp}}` +`gcov {{[-c|--branch-counts]}} {{path/to/file.cpp}}` - Do not create a `gcov` output file: -`gcov --no-output {{path/to/file.cpp}}` +`gcov {{[-n|--no-output]}} {{path/to/file.cpp}}` - Write file level as well as function level summaries: -`gcov --function-summaries {{path/to/file.cpp}}` +`gcov {{[-f|--function-summaries]}} {{path/to/file.cpp}}` diff --git a/pages/linux/getopt.md b/pages/linux/getopt.md index 5811d91cc0..72d59a06eb 100644 --- a/pages/linux/getopt.md +++ b/pages/linux/getopt.md @@ -1,20 +1,20 @@ # getopt > Parse command-line arguments. -> More information: . +> More information: . - Parse optional `verbose`/`version` flags with shorthands: -`getopt --options vV --longoptions verbose,version -- --version --verbose` +`getopt {{[-o|--options]}} vV {{[-l|--longoptions]}} verbose,version -- --version --verbose` - Add a `--file` option with a required argument with shorthand `-f`: -`getopt --options f: --longoptions file: -- --file=somefile` +`getopt {{[-o|--options]}} f: {{[-l|--longoptions]}} file: -- --file=somefile` - Add a `--verbose` option with an optional argument with shorthand `-v`, and pass a non-option parameter `arg`: -`getopt --options v:: --longoptions verbose:: -- --verbose arg` +`getopt {{[-o|--options]}} v:: {{[-l|--longoptions]}} verbose:: -- --verbose arg` - Accept a `-r` and `--verbose` flag, a `--accept` option with an optional argument and add a `--target` with a required argument option with shorthands: -`getopt --options rv::s::t: --longoptions verbose,source::,target: -- -v --target target` +`getopt {{[-o|--options]}} rv::s::t: {{[-l|--longoptions]}} verbose,source::,target: -- -v --target target` diff --git a/pages/linux/grub-install.md b/pages/linux/grub-install.md index 9be6c8a166..6f63080230 100644 --- a/pages/linux/grub-install.md +++ b/pages/linux/grub-install.md @@ -5,12 +5,12 @@ - Install GRUB on a BIOS system: -`grub-install --target={{i386-pc}} {{path/to/device}}` +`grub-install --target {{i386-pc}} {{path/to/device}}` - Install GRUB on an UEFI system: -`grub-install --target={{x86_64-efi}} --efi-directory={{path/to/efi_directory}} --bootloader-id={{GRUB}}` +`grub-install --target {{x86_64-efi}} --efi-directory {{path/to/efi_directory}} --bootloader-id {{GRUB}}` - Install GRUB pre-loading specific modules: -`grub-install --target={{x86_64-efi}} --efi-directory={{path/to/efi_directory}} --modules="{{part_gpt part_msdos}}"` +`grub-install --target {{x86_64-efi}} --efi-directory {{path/to/efi_directory}} --modules "{{part_gpt part_msdos}}"` diff --git a/pages/linux/grub-mkconfig.md b/pages/linux/grub-mkconfig.md index 9cd8e7327c..e93aeca813 100644 --- a/pages/linux/grub-mkconfig.md +++ b/pages/linux/grub-mkconfig.md @@ -9,7 +9,7 @@ - Generate the configuration file: -`sudo grub-mkconfig --output={{/boot/grub/grub.cfg}}` +`sudo grub-mkconfig {{[-o|--output]}} {{/boot/grub/grub.cfg}}` - Display help: diff --git a/pages/linux/grub-script-check.md b/pages/linux/grub-script-check.md index a65022d890..853da84936 100644 --- a/pages/linux/grub-script-check.md +++ b/pages/linux/grub-script-check.md @@ -10,7 +10,7 @@ - Display each line of input after reading it: -`grub-script-check --verbose` +`grub-script-check {{[-v|--verbose]}}` - Display help: diff --git a/pages/linux/guix-package.md b/pages/linux/guix-package.md index 20eeba0147..3d80491a50 100644 --- a/pages/linux/guix-package.md +++ b/pages/linux/guix-package.md @@ -5,23 +5,23 @@ - Install a new package: -`guix package -i {{package}}` +`guix package {{[-i|--install]}} {{package}}` - Remove a package: -`guix package -r {{package}}` +`guix package {{[-r|--remove]}} {{package}}` - Search the package database for a regular expression: -`guix package -s "{{search_pattern}}"` +`guix package {{[-s|--search]}} "{{search_pattern}}"` - List installed packages: -`guix package -I` +`guix package {{[-I|--list-installed]}}` - List generations: -`guix package -l` +`guix package {{[-l|--list-generations]}}` - Roll back to the previous generation: diff --git a/pages/linux/ipcs.md b/pages/linux/ipcs.md index a913e6e3ef..1ed0f14be7 100644 --- a/pages/linux/ipcs.md +++ b/pages/linux/ipcs.md @@ -12,26 +12,26 @@ `ipcs {{--shmems|--queues|--semaphores}}` -- Show full details on the resource with a specific [i]D: +- Show full details on the resource with a specific ID: -`ipcs {{--shmems|--queues|--semaphores}} --id {{resource_id}}` +`ipcs {{--shmems|--queues|--semaphores}} {{[-i|--id]}} {{resource_id}}` -- Show [l]imits in [b]ytes or in a human-readable format: +- Show limits in [b]ytes or in a human-readable format: -`ipcs --limits {{--bytes|--human}}` +`ipcs {{[-l|--limits]}} {{--bytes|--human}}` - Show s[u]mmary about current usage: -`ipcs --summary` +`ipcs {{[-u|--summary]}}` -- Show [c]reator's and owner's UIDs and PIDs for all IPC facilities: +- Show creator's and owner's UIDs and PIDs for all IPC facilities: -`ipcs --creator` +`ipcs {{[-c|--creator]}}` -- Show the [p]ID of the last operators for all IPC facilities: +- Show the PID of the last operators for all IPC facilities: -`ipcs --pid` +`ipcs {{[-p|--pid]}}` -- Show last access [t]imes for all IPC facilities: +- Show last access times for all IPC facilities: -`ipcs --time` +`ipcs {{[-t|--time]}}` diff --git a/pages/linux/libtool.md b/pages/linux/libtool.md index 0bc5afcf77..8dccacb1bf 100644 --- a/pages/linux/libtool.md +++ b/pages/linux/libtool.md @@ -5,11 +5,11 @@ - Compile a source file into a `libtool` object: -`libtool --mode=compile gcc -c {{path/to/source.c}} -o {{path/to/source.lo}}` +`libtool --mode=compile gcc {{[-c|--compile]}} {{path/to/source.c}} {{[-o|--output]}} {{path/to/source.lo}}` - Create a library or an executable: -`libtool --mode=link gcc -o {{path/to/library.lo}} {{path/to/source.lo}}` +`libtool --mode=link gcc {{[-o|--output]}} {{path/to/library.lo}} {{path/to/source.lo}}` - Automatically set the library path so that another program can use uninstalled `libtool` generated programs or libraries: diff --git a/pages/linux/libtoolize.md b/pages/linux/libtoolize.md index d563d7bfbe..bbd123f849 100644 --- a/pages/linux/libtoolize.md +++ b/pages/linux/libtoolize.md @@ -6,4 +6,4 @@ - Initialize a project for `libtool` by copying necessary files (avoiding symbolic links) and overwriting existing files if needed: -`libtoolize --copy --force` +`libtoolize {{[-c|--copy]}} {{[-f|--force]}}` diff --git a/pages/linux/mknod.md b/pages/linux/mknod.md index 927aff5ecb..f495ade955 100644 --- a/pages/linux/mknod.md +++ b/pages/linux/mknod.md @@ -17,4 +17,4 @@ - Create a device file with default SELinux security context: -`sudo mknod -Z {{path/to/device_file}} {{type}} {{major_device_number}} {{minor_device_number}}` +`sudo mknod {{[-Z |--context=]}}{{path/to/device_file}} {{type}} {{major_device_number}} {{minor_device_number}}` diff --git a/pages/linux/mktemp.md b/pages/linux/mktemp.md index f86c1b6094..530c2ae9ec 100644 --- a/pages/linux/mktemp.md +++ b/pages/linux/mktemp.md @@ -9,7 +9,7 @@ - Use a custom directory (defaults to `$TMPDIR`, or `/tmp`): -`mktemp --tmpdir={{/path/to/tempdir}}` +`mktemp {{[-p |--tmpdir=]}}{{/path/to/tempdir}}` - Use a custom path template (`X`s are replaced with random alphanumeric characters): diff --git a/pages/linux/parted.md b/pages/linux/parted.md index b4fe3a539f..71e8ec7fce 100644 --- a/pages/linux/parted.md +++ b/pages/linux/parted.md @@ -2,19 +2,19 @@ > A partition manipulation program. > See also: `parted-interactive`, `partprobe`. -> More information: . +> More information: . - List partitions on all block devices: -`sudo parted --list` +`sudo parted {{[-l|--list]}}` - Create a new partition table of the specified label-type: -`sudo parted {{/dev/sdX}} --script mklabel {{aix|amiga|bsd|dvh|gpt|loop|mac|msdos|pc98|sun}}` +`sudo parted {{/dev/sdX}} {{[-s|--script]}} mklabel {{aix|amiga|bsd|dvh|gpt|loop|mac|msdos|pc98|sun}}` - Create a new `gpt` partition table with a 500MiB boot partition and give the rest for the system partition: -`sudo parted {{/dev/sdX}} --script mklabel gpt mkpart primary 0% 500MiB mkpart primary 500MiB 100%` +`sudo parted {{/dev/sdX}} {{[-s|--script]}} mklabel gpt mkpart primary 0% 500MiB mkpart primary 500MiB 100%` - Start interactive mode with the specified disk selected: diff --git a/pages/linux/ptx.md b/pages/linux/ptx.md index d629b7146a..9e5d5e2898 100644 --- a/pages/linux/ptx.md +++ b/pages/linux/ptx.md @@ -5,20 +5,20 @@ - Generate a permuted index where the first field of each line is an index reference: -`ptx --references {{path/to/file}}` +`ptx {{[-r|--references]}} {{path/to/file}}` - Generate a permuted index with automatically generated index references: -`ptx --auto-reference {{path/to/file}}` +`ptx {{[-A|--auto-reference]}} {{path/to/file}}` - Generate a permuted index with a fixed width: -`ptx --width={{width_in_columns}} {{path/to/file}}` +`ptx {{[-w|--width]}} {{width_in_columns}} {{path/to/file}}` - Generate a permuted index with a list of filtered words: -`ptx --only-file={{path/to/filter}} {{path/to/file}}` +`ptx {{[-o|--only-file]}} {{path/to/filter}} {{path/to/file}}` - Generate a permuted index with SYSV-style behaviors: -`ptx --traditional {{path/to/file}}` +`ptx {{[-G|--traditional]}} {{path/to/file}}` diff --git a/pages/linux/pw-profiler.md b/pages/linux/pw-profiler.md index 2b95230d4e..9f2be0fb52 100644 --- a/pages/linux/pw-profiler.md +++ b/pages/linux/pw-profiler.md @@ -9,12 +9,12 @@ - Change the log output file: -`pw-profiler --output {{path/to/file.log}}` +`pw-profiler {{[-o|--output]}} {{path/to/file.log}}` - Profile a remote instance: -`pw-profiler --remote {{remote_name}}` +`pw-profiler {{[-r|--remote]}} {{remote_name}}` - Display help: -`pw-profiler --help` +`pw-profiler {{[-h|--help]}}` diff --git a/pages/linux/rcp.md b/pages/linux/rcp.md index 4cefe9f73c..bbbb974283 100644 --- a/pages/linux/rcp.md +++ b/pages/linux/rcp.md @@ -10,12 +10,12 @@ - Copy a directory recursively: -`rcp -r {{path/to/local_directory}} {{username}}@{{remote_host}}:{{/path/to/destination/}}` +`rcp {{[-r|--recursive]}} {{path/to/local_directory}} {{username}}@{{remote_host}}:{{/path/to/destination/}}` - Preserve the file attributes: -`rcp -p {{path/to/local_file}} {{username}}@{{remote_host}}:{{/path/to/destination/}}` +`rcp {{[-p|--preserve]}} {{path/to/local_file}} {{username}}@{{remote_host}}:{{/path/to/destination/}}` - Force copy without a confirmation: -`rcp -f {{path/to/local_file}} {{username}}@{{remote_host}}:{{/path/to/destination/}}` +`rcp {{[-f|--from]}} {{path/to/local_file}} {{username}}@{{remote_host}}:{{/path/to/destination/}}` diff --git a/pages/linux/rexec.md b/pages/linux/rexec.md index e7cc6b7f48..dc440e8bf9 100644 --- a/pages/linux/rexec.md +++ b/pages/linux/rexec.md @@ -4,18 +4,18 @@ > Note: Use `rexec` with caution, as it transmits data in plain text. Consider secure alternatives like SSH for encrypted communication. > More information: . -- Execute a command on a remote [h]ost: +- Execute a command on a remote host: -`rexec -h={{remote_host}} {{ls -l}}` +`rexec {{[-h|--host]}} {{remote_host}} {{ls -l}}` -- Specify the remote [u]sername on a remote [h]ost: +- Specify the remote username on a remote host: -`rexec -username={{username}} -h={{remote_host}} {{ps aux}}` +`rexec {{[-u|--username]}} {{username}} {{[-h|--host]}} {{remote_host}} {{ps aux}}` -- Redirect `stdin` from `/dev/null` on a remote [h]ost: +- Redirect `stdin` from `/dev/null` on a remote host: -`rexec --no-err -h={{remote_host}} {{ls -l}}` +`rexec {{[-n|--noerr]}} {{[-h|--host]}} {{remote_host}} {{ls -l}}` -- Specify the remote [P]ort on a remote [h]ost: +- Specify the remote port on a remote host: -`rexec -P={{1234}} -h={{remote_host}} {{ls -l}}` +`rexec {{[-P|--port]}} {{1234}} {{[-h|--host]}} {{remote_host}} {{ls -l}}` diff --git a/pages/linux/rlogin.md b/pages/linux/rlogin.md index 65ace67ccc..2e65cd90be 100644 --- a/pages/linux/rlogin.md +++ b/pages/linux/rlogin.md @@ -9,4 +9,4 @@ - Log in to a remote host with a specific username: -`rlogin -l {{username}} {{remote_host}}` +`rlogin {{[-l|--user]}} {{username}} {{remote_host}}` diff --git a/pages/linux/rsh.md b/pages/linux/rsh.md index cfc260a0d8..870c23b8c2 100644 --- a/pages/linux/rsh.md +++ b/pages/linux/rsh.md @@ -9,7 +9,7 @@ - Execute a command on a remote host with a specific username: -`rsh {{remote_host}} -l {{username}} {{ls -l}}` +`rsh {{remote_host}} {{[-l|--user]}} {{username}} {{ls -l}}` - Redirect `stdin` to `/dev/null` when executing a command on a remote host: diff --git a/pages/linux/runcon.md b/pages/linux/runcon.md index ad9b4fc2d2..2ffc78a1de 100644 --- a/pages/linux/runcon.md +++ b/pages/linux/runcon.md @@ -10,11 +10,11 @@ - Specify the domain to run a command in: -`runcon -t {{domain}}_t {{command}}` +`runcon {{[-t|--type]}} {{domain}}_t {{command}}` - Specify the context role to run a command with: -`runcon -r {{role}}_r {{command}}` +`runcon {{[-r|--role]}} {{role}}_r {{command}}` - Specify the full context to run a command with: diff --git a/pages/linux/sed.md b/pages/linux/sed.md index 04897c43bd..48c0a2f9f1 100644 --- a/pages/linux/sed.md +++ b/pages/linux/sed.md @@ -18,7 +18,7 @@ - Execute a specific script file and print the result to `stdout`: -`{{command}} | sed {{-f|--file}} {{path/to/script.sed}}` +`{{command}} | sed {{[-f|--file]}} {{path/to/script.sed}}` - Print just the first line to `stdout`: diff --git a/pages/linux/shar.md b/pages/linux/shar.md index f2c4443512..9b5ec05c79 100644 --- a/pages/linux/shar.md +++ b/pages/linux/shar.md @@ -5,20 +5,20 @@ - Create a shell script that when executed extracts the given files from itself: -`shar --vanilla-operation {{path/to/file1 path/to/file2 ...}} > {{path/to/archive.sh}}` +`shar {{[-V|--vanilla-operation]}} {{path/to/file1 path/to/file2 ...}} > {{path/to/archive.sh}}` - Compress the files in the archive: -`shar --compactor {{xz}} {{path/to/file1 path/to/file2 ...}} > {{path/to/archive.sh}}` +`shar {{[-C|--compactor]}} {{xz}} {{path/to/file1 path/to/file2 ...}} > {{path/to/archive.sh}}` - Treat all files as binary (i.e. `uuencode` everything): -`shar --uuencode {{path/to/file1 path/to/file2 ...}} > {{path/to/archive.sh}}` +`shar {{[-B|--uuencode]}} {{path/to/file1 path/to/file2 ...}} > {{path/to/archive.sh}}` - Treat all files as text (i.e. `uuencode` nothing): -`shar --text-files {{path/to/file1 path/to/file2 ...}} > {{path/to/archive.sh}}` +`shar {{[-T|--text-files]}} {{path/to/file1 path/to/file2 ...}} > {{path/to/archive.sh}}` - Include a name and cut mark in the header comment of the archive: -`shar --archive-name "{{My files}}" --cut-mark {{path/to/file1 path/to/file2 ...}} > {{path/to/archive.sh}}` +`shar {{[-n|--archive-name]}} "{{My files}}" {{[-c|--cut-mark]}} {{path/to/file1 path/to/file2 ...}} > {{path/to/archive.sh}}` diff --git a/pages/linux/steamos-chroot.md b/pages/linux/steamos-chroot.md index 8a804112bc..fdbc268878 100644 --- a/pages/linux/steamos-chroot.md +++ b/pages/linux/steamos-chroot.md @@ -5,12 +5,12 @@ - Switch to the other A/B partition: -`steamos-chroot --partset other` +`steamos-chroot {{[-p|--partset]}} other` - Switch to a partition on another drive: -`steamos-chroot --disk {{/dev/sdX}} --partset {{A|B}}` +`steamos-chroot {{[-d|--disk]}} {{/dev/sdX}} {{[-p|--partset]}} {{A|B}}` - Display help: -`steamos-chroot --help` +`steamos-chroot {{[-h|--help]}}` diff --git a/pages/osx/head.md b/pages/osx/head.md index 80a740f900..78fa4e7c49 100644 --- a/pages/osx/head.md +++ b/pages/osx/head.md @@ -5,16 +5,16 @@ - Output the first few lines of a file: -`head --lines {{8}} {{path/to/file}}` +`head {{[-n|--lines]}} {{8}} {{path/to/file}}` - Output the first few bytes of a file: -`head --bytes {{8}} {{path/to/file}}` +`head {{[-c|--bytes]}} {{8}} {{path/to/file}}` - Output everything but the last few lines of a file: -`head --lines -{{8}} {{path/to/file}}` +`head {{[-n|--lines]}} -{{8}} {{path/to/file}}` - Output everything but the last few bytes of a file: -`head --bytes -{{8}} {{path/to/file}}` +`head {{[-c|--bytes]}} -{{8}} {{path/to/file}}`