*: add option placeholders (#15956)

pages/common/cpio.md

@@ -4,14 +4,14 @@
 > Supports the following archive formats: cpio's custom binary, old ASCII, new ASCII, crc, HPUX binary, HPUX old ASCII, old tar, and POSIX.1 tar.
 > More information: <https://www.gnu.org/software/cpio>.
 
-- Take a list of file names from `stdin` and add them [o]nto an archive in cpio's binary format:
+- Take a list of file names from `stdin` and add them onto an archive (copy-[o]ut) in cpio's binary forma:
 
-`echo "{{path/to/file1 path/to/file2 ...}}" | cpio -o > {{archive.cpio}}`
+`echo "{{path/to/file1 path/to/file2 ...}}" | cpio {{[-o|--create]}} > {{archive.cpio}}`
 
-- Copy all files and directories in a directory and add them [o]nto an archive, in [v]erbose mode:
+- Copy all files and directories in a directory and add them onto an archive (copy-[o]ut), in verbose mode:
 
-`find {{path/to/directory}} | cpio -ov > {{archive.cpio}}`
+`find {{path/to/directory}} | cpio {{[-ov|--create --verbose]}} > {{archive.cpio}}`
 
-- P[i]ck all files from an archive, generating [d]irectories where needed, in [v]erbose mode:
+- Pick all files from an archive (copy-[i]n), generating directories where needed, in verbose mode:
 
-`cpio -idv < {{archive.cpio}}`
+`cpio {{[-idv|--extract --make-directories --verbose]}} < {{archive.cpio}}`

pages/common/cut.md

@@ -7,14 +7,14 @@
 
 `{{command}} | cut --{{characters|fields}} {{1|1,10|1-10|1-|-10}}`
 
-- Print a [f]ield range of each line with a specific [d]elimiter:
+- Print a field range of each line with a specific delimiter:
 
-`{{command}} | cut --delimiter "{{delimiter}}" --fields {{1|1,10|1-10|1-|-10}}`
+`{{command}} | cut {{[-d|--delimiter]}} "{{delimiter}}" {{[-f|--fields]}} {{1|1,10|1-10|1-|-10}}`
 
-- Print a [c]haracter range of each line of the specific file:
+- Print a character range of each line of the specific file:
 
-`cut --characters {{1}} {{path/to/file}}`
+`cut {{[-c|--characters]}} {{1}} {{path/to/file}}`
 
-- Print specific [f]ields of `NUL` terminated lines (e.g. as in `find . -print0`) instead of newlines:
+- Print specific fields of `NUL` terminated lines (e.g. as in `find . -print0`) instead of newlines:
 
-`{{command}} | cut --zero-terminated --fields {{1}}`
+`{{command}} | cut {{[-z|--zero-terminated]}} {{[-f|--fields]}} {{1}}`

pages/common/git-am.md

@@ -10,7 +10,7 @@
 
 - Apply and commit changes following a remote patch file:
 
-`curl -L {{https://example.com/file.patch}} | git apply`
+`curl {{[-L|--location]}} {{https://example.com/file.patch}} | git apply`
 
 - Abort the process of applying a patch file:
 

pages/common/git-clone.md

@@ -13,15 +13,15 @@
 
 - Clone only the `.git` directory of an existing repository:
 
-`git clone --no-checkout {{remote_repository_location}}`
+`git clone {{[-n|--no-checkout]}} {{remote_repository_location}}`
 
 - Clone a local repository:
 
-`git clone --local {{path/to/local/repository}}`
+`git clone {{[-l|--local]]} {{path/to/local/repository}}`
 
 - Clone quietly:
 
-`git clone --quiet {{remote_repository_location}}`
+`git clone {{[-q|--quiet]}} {{remote_repository_location}}`
 
 - Clone an existing repository only fetching the 10 most recent commits on the default branch (useful to save time):
 
@@ -29,8 +29,8 @@
 
 - Clone an existing repository only fetching a specific branch:
 
-`git clone --branch {{name}} --single-branch {{remote_repository_location}}`
+`git clone {{[-b|--branch]}} {{name}} --single-branch {{remote_repository_location}}`
 
 - Clone an existing repository using a specific SSH command:
 
-`git clone --config core.sshCommand="{{ssh -i path/to/private_ssh_key}}" {{remote_repository_location}}`
+`git clone {{[-c|--config]}} core.sshCommand="{{ssh -i path/to/private_ssh_key}}" {{remote_repository_location}}`

pages/common/git-push.md

@@ -13,7 +13,7 @@
 
 - Send changes from a specific local branch to its remote counterpart, and set the remote one as the default push/pull target of the local one:
 
-`git push -u {{remote_name}} {{local_branch}}`
+`git push {{[-u|--set-upstream]}} {{remote_name}} {{local_branch}}`
 
 - Send changes from a specific local branch to a specific remote branch:
 
@@ -25,7 +25,7 @@
 
 - Delete a branch in a remote repository:
 
-`git push {{remote_name}} --delete {{remote_branch}}`
+`git push {{remote_name}} {{[-d|--delete]}} {{remote_branch}}`
 
 - Remove remote branches that don't have a local counterpart:
 

pages/common/killall.md

@@ -8,13 +8,13 @@
 
 `killall {{process_name}}`
 
-- [l]ist available signal names (to be used without the 'SIG' prefix):
+- List available signal names (to be used without the 'SIG' prefix):
 
-`killall -l`
+`killall {{[-l|--list]}}`
 
 - Interactively ask for confirmation before termination:
 
-`killall -i {{process_name}}`
+`killall {{[-i|--interactive]}} {{process_name}}`
 
 - Terminate a process using the SIGINT (interrupt) signal, which is the same signal sent by pressing `<Ctrl c>`:
 

pages/common/llm.md

@@ -11,22 +11,22 @@
 
 `llm "{{Ten fun names for a pet pelican}}"`
 
-- Run a [s]ystem prompt against a file:
+- Run a system prompt against a file:
 
-`cat {{path/to/file.py}} | llm --system "{{Explain this code}}"`
+`cat {{path/to/file.py}} | llm {{[-s|--system]}} "{{Explain this code}}"`
 
 - Install packages from PyPI into the same environment as LLM:
 
 `llm install {{package1 package2 ...}}`
 
-- Download and run a prompt against a [m]odel:
+- Download and run a prompt against a model:
 
-`llm --model {{orca-mini-3b-gguf2-q4_0}} "{{What is the capital of France?}}"`
+`llm {{[-m|--model]}} {{orca-mini-3b-gguf2-q4_0}} "{{What is the capital of France?}}"`
 
-- Create a [s]ystem prompt and [s]ave it with a template name:
+- Create a system prompt and save it with a template name:
 
-`llm --system '{{You are a sentient cheesecake}}' --save {{sentient_cheesecake}}`
+`llm {{[-s|--system]}} '{{You are a sentient cheesecake}}' --save {{sentient_cheesecake}}`
 
-- Have an interactive chat with a specific [m]odel using a specific [t]emplate:
+- Have an interactive chat with a specific model using a specific template:
 
-`llm chat --model {{chatgpt}} --template {{sentient_cheesecake}}`
+`llm chat {{[-m|--model]}} {{chatgpt}} {{[-t|--template]}} {{sentient_cheesecake}}`

pages/common/look.md

@@ -9,14 +9,14 @@
 
 `look {{prefix}} {{path/to/file}}`
 
-- Case-insensitively ([f]) search only on alphanumeric characters ([d]):
+- Case-insensitively search only on alphanumeric characters:
 
-`look -f -d {{prefix}} {{path/to/file}}`
+`look {{[-f|--ignore-case]}} {{[-d|--alphanum]}} {{prefix}} {{path/to/file}}`
 
-- Specify a string [t]ermination character (space by default):
+- Specify a string termination character (space by default):
 
-`look -t {{,}}`
+`look {{[-t|--terminate]}} {{,}}`
 
-- Search in `/usr/share/dict/words` (`-d` and `-f` are assumed):
+- Search in `/usr/share/dict/words` (`--alphanum` and `--ignore-case` are assumed):
 
 `look {{prefix}}`

pages/common/lstopo.md

@@ -11,13 +11,13 @@
 
 `lstopo --no-factorize`
 
-- Show the summarized system topology with only [p]hysical indices (i.e. as seen by the OS):
+- Show the summarized system topology with only physical indices (i.e. as seen by the OS):
 
-`lstopo --physical`
+`lstopo {{[-p|--physical]}}`
 
 - Write the full system topology to a file in the specified format:
 
-`lstopo --no-factorize --output-format {{console|ascii|tex|fig|svg|pdf|ps|png|xml}} {{path/to/file}}`
+`lstopo --no-factorize {{[--of|--output-format]}} {{console|ascii|tex|fig|svg|pdf|ps|png|xml}} {{path/to/file}}`
 
 - Output in monochrome or greyscale:
 

pages/common/shred.md

@@ -9,20 +9,20 @@
 
 - Overwrite a file and show progress on the screen:
 
-`shred --verbose {{path/to/file}}`
+`shred {{[-v|--verbose]}} {{path/to/file}}`
 
-- Overwrite a file, leaving [z]eros instead of random data:
+- Overwrite a file, leaving zeros instead of random data:
 
-`shred --zero {{path/to/file}}`
+`shred {{[-z|--zero]}} {{path/to/file}}`
 
-- Overwrite a file a specific [n]umber of times:
+- Overwrite a file a specific number of times:
 
-`shred --iterations {{25}} {{path/to/file}}`
+`shred {{[-n|--iterations]}} {{25}} {{path/to/file}}`
 
 - Overwrite a file and remove it:
 
 `shred --remove {{path/to/file}}`
 
-- Overwrite a file 100 times, add a final overwrite with [z]eros, remove the file after overwriting it and show [v]erbose progress on the screen:
+- Overwrite a file 100 times, add a final overwrite with zeros, remove the file after overwriting it and show verbose progress on the screen:
 
-`shred -vzun 100 {{path/to/file}}`
+`shred {{[-vzun|--verbose --zero -u --iterations]}} 100 {{path/to/file}}`

pages/linux/asterisk.md

@@ -3,11 +3,11 @@
 > Run and manage telephone and exchange (phone) server instances.
 > More information: <https://docs.asterisk.org>.
 
-- [R]econnect to a running server, and turn on logging 3 levels of [v]erbosity:
+- [r]econnect to a running server, and turn on logging 3 levels of [v]erbosity:
 
 `asterisk -r -vvv`
 
-- [R]econnect to a running server, run a single command, and return:
+- [r]econnect to a running server, run a single command, and return:
 
 `asterisk -r -x "{{command}}"`
 

pages/linux/cal.md

@@ -11,7 +11,7 @@
 
 `cal {{[-3|--three]}}`
 
-- Display the whole calendar for the current [y]ear:
+- Display the whole calendar for the current year:
 
 `cal {{[-y|--year]}}`
 

pages/linux/ionice.md

@@ -7,24 +7,24 @@
 
 - Run a command with the given scheduling class and priority:
 
-`ionice -c {{scheduling_class}} -n {{priority}} {{command}}`
+`ionice {{[-c|--class]}} {{scheduling_class}} {{[-n|--classdata]}} {{priority}} {{command}}`
 
-- Set I/O scheduling [c]lass of a running process with a specific [p]id, [P]gid or [u]id:
+- Set I/O scheduling class of a running process with a specific [p]id, [P]gid or [u]id:
 
-`ionice -c {{scheduling_class}} -{{p|P|u}} {{id}}`
+`ionice {{[-c|--class]}} {{scheduling_class}} -{{p|P|u}} {{id}}`
 
-- Run a command with custom I/O scheduling [c]lass and priority:
+- Run a command with custom I/O scheduling class and priority:
 
-`ionice -c {{scheduling_class}} -n {{priority}} {{command}}`
+`ionice {{[-c|--class]}} {{scheduling_class}} {{[-n|--classdata]}} {{priority}} {{command}}`
 
 - Ignore failure to set the requested priority:
 
-`ionice -t -n {{priority}} -p {{pid}}`
+`ionice {{[-t|--ignore]}} {{[-n|--classdata]}} {{priority}} {{[-p|--pid]}} {{pid}}`
 
 - Run the command even in case it was not possible to set the desired priority (this can happen due to insufficient privileges or an old kernel version):
 
-`ionice -t -n {{priority}} -p {{pid}}`
+`ionice {{[-t|--ignore]}} {{[-n|--classdata]}} {{priority}} {{[-p|--pid]}} {{pid}}`
 
 - Print the I/O scheduling class and priority of a running process:
 
-`ionice -p {{pid}}`
+`ionice {{[-p|--pid]}} {{pid}}`

pages/linux/kde-builder.md

@@ -12,17 +12,17 @@
 
 `kde-builder {{component_name}}`
 
-- Compile a component without updating its local code and without compiling its [D]ependencies:
+- Compile a component without updating its local code and without compiling its dependencies:
 
-`kde-builder --no-src --no-include-dependencies {{component_name}}`
+`kde-builder {{[-S|--no-src]}} {{[-D|--no-include-dependencies]}} {{component_name}}`
 
-- [r]efresh the build directories before compiling:
+- Refresh the build directories before compiling:
 
-`kde-builder --refresh-build {{component_name}}`
+`kde-builder {{[-r|--refresh-build]}} {{component_name}}`
 
 - Resume compilation from a specific dependency:
 
-`kde-builder --resume-from {{dependency_component}} {{component_name}}`
+`kde-builder {{[-f|--resume-from]}} {{dependency_component}} {{component_name}}`
 
 - Run a component with a specified executable name:
 

pages/linux/loginctl.md

@@ -9,7 +9,7 @@
 
 - Print all properties of a specific session:
 
-`loginctl show-session {{session_id}} --all`
+`loginctl show-session {{session_id}} {{[-a|--all]}}`
 
 - Print all properties of a specific user:
 
@@ -17,11 +17,11 @@
 
 - Print a specific property of a user:
 
-`loginctl show-user {{username}} --property {{property_name}}`
+`loginctl show-user {{username}} {{[-p|--property]}} {{property_name}}`
 
 - Execute a `loginctl` operation on a remote host:
 
-`loginctl list-users -H {{hostname}}`
+`loginctl list-users {{[-H|--host]}} {{hostname}}`
 
 - Log a user out on all of their sessions:
 

pages/linux/pw-config.md

@@ -9,24 +9,24 @@
 
 - List all configuration files that will be used by the PipeWire PulseAudio server:
 
-`pw-config --name pipewire-pulse.conf`
+`pw-config {{[-n|--name]}} pipewire-pulse.conf`
 
 - List all configuration sections used by the PipeWire PulseAudio server:
 
-`pw-config --name pipewire-pulse.conf list`
+`pw-config {{[-n|--name]}} pipewire-pulse.conf list`
 
 - List the `context.properties` fragments used by the JACK clients:
 
-`pw-config --name jack.conf list context.properties`
+`pw-config {{[-n|--name]}} jack.conf list context.properties`
 
 - List the merged `context.properties` used by the JACK clients:
 
-`pw-config --name jack.conf merge context.properties`
+`pw-config {{[-n|--name]}} jack.conf merge context.properties`
 
-- List the merged `context.modules` used by the PipeWire server and [r]eformat:
+- List the merged `context.modules` used by the PipeWire server and reformat:
 
-`pw-config --name pipewire.conf --recurse merge context.modules`
+`pw-config {{[-n|--name]}} pipewire.conf {{[-r|--recurse]}} merge context.modules`
 
 - Display help:
 
-`pw-config --help`
+`pw-config {{[-h|--help]}}`

pages/linux/pw-dump.md

@@ -12,18 +12,18 @@
 
 `pw-dump {{object_id}}`
 
-- Dump the current state [m]onitoring changes, printing it again:
+- Dump the current state monitoring changes, printing it again:
 
-`pw-dump --monitor`
+`pw-dump {{[-m|--monitor]}}`
 
-- Dump the current state of a [r]emote instance to a file:
+- Dump the current state of a remote instance to a file:
 
-`pw-dump --remote {{remote_name}} > {{path/to/dump_file.json}}`
+`pw-dump {{[-r|--remote]}} {{remote_name}} > {{path/to/dump_file.json}}`
 
-- Set a [C]olor configuration:
+- Set a color configuration:
 
-`pw-dump --color {{never|always|auto}}`
+`pw-dump {{[-C|--color]}} {{never|always|auto}}`
 
 - Display help:
 
-`pw-dump --help`
+`pw-dump {{[-h|--help]}}`

pages/linux/shutdown.md

@@ -7,11 +7,11 @@
 
 `shutdown -h now`
 
-- [r]eboot immediately:
+- Reboot immediately:
 
 `shutdown {{[-r|--reboot]}} now`
 
-- [r]eboot in 5 minutes:
+- Reboot in 5 minutes:
 
 `shutdown {{[-r|--reboot]}} +{{5}} &`
 

pages/linux/systemd-analyze.md

@@ -22,7 +22,7 @@
 
 - Plot a dependency graph and convert it to an SVG file:
 
-`systemd-analyze dot | dot -T{{svg}} > {{path/to/file.svg}}`
+`systemd-analyze dot | dot -T {{svg}} > {{path/to/file.svg}}`
 
 - Show security scores of running units:
 

pages/linux/xsel.md

@@ -3,26 +3,26 @@
 > X11 selection and clipboard manipulation tool.
 > More information: <https://manned.org/xsel>.
 
-- Use a command's output as input of the clip[b]oard (equivalent to `<Ctrl c>`):
+- Use a command's output as input of the clipboard (equivalent to `<Ctrl c>`):
 
-`echo 123 | xsel -ib`
+`echo 123 | xsel {{[-ib|--input --clipboard]}}`
 
 - Use the contents of a file as input of the clipboard:
 
-`cat {{path/to/file}} | xsel -ib`
+`cat {{path/to/file}} | xsel {{[-ib|--input --clipboard]}}`
 
 - Output the clipboard's contents into the terminal (equivalent to `<Ctrl v>`):
 
-`xsel -ob`
+`xsel {{[-ob|--output --clipboard]}}`
 
 - Output the clipboard's contents into a file:
 
-`xsel -ob > {{path/to/file}}`
+`xsel {{[-ob|--output --clipboard]}} > {{path/to/file}}`
 
 - Clear the clipboard:
 
-`xsel -cb`
+`xsel {{[-cb|--clear --clipboard]}}`
 
 - Output the X11 primary selection's contents into the terminal (equivalent to a mouse `<MiddleClick>`):
 
-`xsel -op`
+`xsel {{[-op|--output --primary]}}`

pages/linux/zip.md

@@ -24,7 +24,7 @@
 
 `zip {{[-r|--recurse-paths]}} {{[-e|--encrypt]}} {{path/to/compressed.zip}} {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}`
 
-- Archive files/directories to a multi-part [s]plit Zip archive (e.g. 3 GB parts):
+- Archive files/directories to a multi-part split Zip archive (e.g. 3 GB parts):
 
 `zip {{[-r|--recurse-paths]}} {{[-s|--split-size]}} {{3g}} {{path/to/compressed.zip}} {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}`