diff --git a/pages/common/cjxl.md b/pages/common/cjxl.md index 1db026bdfb6a64..a6f974bc0d0856 100644 --- a/pages/common/cjxl.md +++ b/pages/common/cjxl.md @@ -2,7 +2,7 @@ > Compress images to JPEG XL. > Accepted input extensions are PNG, APNG, GIF, JPEG, EXR, PPM, PFM, PAM, PGX, and JXL. -> More information: . +> More information: . - Convert an image to JPEG XL: diff --git a/pages/common/cosign.md b/pages/common/cosign.md index 83acb4ea9c6750..28003706fb79e3 100644 --- a/pages/common/cosign.md +++ b/pages/common/cosign.md @@ -1,7 +1,7 @@ # cosign > Container Signing, Verification and Storage in an OCI registry. -> More information: . +> More information: . - Generate a key-pair: @@ -9,11 +9,11 @@ - Sign a container and store the signature in the registry: -`cosign sign -key {{cosign.key}} {{image}}` +`cosign sign --key {{cosign.key}} {{image}}` - Sign a container image with a key pair stored in a Kubernetes secret: -`cosign sign -key k8s://{{namespace}}/{{key}} {{image}}` +`cosign sign --key k8s://{{namespace}}/{{key}} {{image}}` - Sign a blob with a local key pair file: @@ -21,7 +21,7 @@ - Verify a container against a public key: -`cosign verify -key {{cosign.pub}} {{image}}` +`cosign verify --key {{cosign.pub}} {{image}}` - Verify images with a public key in a Dockerfile: @@ -29,7 +29,7 @@ - Verify an image with a public key stored in a Kubernetes secret: -`cosign verify -key k8s://{{namespace}}/{{key}} {{image}}` +`cosign verify --key k8s://{{namespace}}/{{key}} {{image}}` - Copy a container image and its signatures: diff --git a/pages/common/direnv.md b/pages/common/direnv.md index 78ccb1c0390c5d..f6b2197e2cb1c1 100644 --- a/pages/common/direnv.md +++ b/pages/common/direnv.md @@ -1,7 +1,7 @@ # direnv > Shell extension to load and unload environment variables depending on the current directory. -> More information: . +> More information: . - Grant direnv permission to load the `.envrc` present in the current directory: diff --git a/pages/common/djxl.md b/pages/common/djxl.md index 8a8284935199a2..cbe6f1cd7e4203 100644 --- a/pages/common/djxl.md +++ b/pages/common/djxl.md @@ -2,7 +2,7 @@ > Decompress JPEG XL images. > Accepted output extensions are PNG, APNG, JPEG, EXR, PGM, PPM, PNM, PFM, PAM, EXIF, XMP and JUMBF. -> More information: . +> More information: . - Decompress a JPEG XL image to another format: diff --git a/pages/common/eget.md b/pages/common/eget.md index 91a58011f82380..eccfaf94da750d 100644 --- a/pages/common/eget.md +++ b/pages/common/eget.md @@ -1,7 +1,7 @@ # eget > Easily install prebuilt binaries from GitHub. -> More information: . +> More information: . - Download a prebuilt binary for the current system from a repository on GitHub: @@ -13,11 +13,11 @@ - Specify the location to place the downloaded files: -`eget {{zyedidia/micro}} --to={{path/to/directory}}` +`eget {{zyedidia/micro}} --to {{path/to/directory}}` - Specify a Git tag instead of using the latest version: -`eget {{zyedidia/micro}} --tag={{v2.0.10}}` +`eget {{zyedidia/micro}} {{[-t|--tag]}} {{v2.0.10}}` - Install the latest pre-release instead of the latest stable version: @@ -25,7 +25,7 @@ - Only download the asset, skipping extraction: -`eget {{zyedidia/micro}} --download-only` +`eget {{zyedidia/micro}} {{[-d|--download-only]}}` - Only download if there is a newer release then the currently downloaded version: diff --git a/pages/common/eol.md b/pages/common/eol.md index cc8840cfc7e6d1..667547b8152bb3 100644 --- a/pages/common/eol.md +++ b/pages/common/eol.md @@ -1,7 +1,7 @@ # eol > Show end-of-life dates (EoLs) for a number of products. -> More information: . +> More information: . - List all available products: @@ -13,16 +13,16 @@ - Open the product webpage: -`eol {{product}} --web` +`eol {{product}} {{[-w|--web]}}` - Get EoLs of a one or more products in a specific format: -`eol {{product1 product2 ...}} --format {{html|json|md|markdown|pretty|rst|csv|tsv|yaml}}` +`eol {{product1 product2 ...}} --{{html|json|md|markdown|pretty|rst|csv|tsv|yaml}}` - Get EoLs of one or more products as a single markdown file: -`eol {{product1 product2 ...}} --format {{markdown}} > {{eol_report.md}}` +`eol {{product1 product2 ...}} --{{markdown}} > {{eol_report.md}}` - Display help: -`eol --help` +`eol {{[-h|--help]}}` diff --git a/pages/common/eva.md b/pages/common/eva.md index 52c02675dbd8e5..75f6912d430f29 100644 --- a/pages/common/eva.md +++ b/pages/common/eva.md @@ -1,7 +1,7 @@ # eva > Simple calculator REPL, similar to `bc`, with syntax highlighting and persistent history. -> More information: . +> More information: . - Run the calculator in interactive mode: diff --git a/pages/common/fdroidcl.md b/pages/common/fdroidcl.md index c196902df41b34..4af2e91a185427 100644 --- a/pages/common/fdroidcl.md +++ b/pages/common/fdroidcl.md @@ -1,7 +1,7 @@ # fdroidcl > Manage F-Droid apps of devices connected via ADB. -> More information: . +> More information: . - Fetch the F-Droid index: diff --git a/pages/common/fkill.md b/pages/common/fkill.md index 9bebad58d9d1ab..cdfc3e7d2b855f 100644 --- a/pages/common/fkill.md +++ b/pages/common/fkill.md @@ -1,7 +1,7 @@ # fkill > Fabulously kill processes. Cross-platform. -> More information: . +> More information: . - Run without arguments to use the interactive interface: diff --git a/pages/common/gcpdiag.md b/pages/common/gcpdiag.md index 78ff03c67b4072..36d6fb332fe3c7 100644 --- a/pages/common/gcpdiag.md +++ b/pages/common/gcpdiag.md @@ -2,23 +2,23 @@ > Google Cloud Platform troubleshooting and diagnostics tool. > Run in a Docker container or in GCP Cloudshell. -> More information: . +> More information: . - Run `gcpdiag` on your project, returning all rules: -`gcpdiag lint --project={{gcp_project_id}}` +`gcpdiag lint --project {{gcp_project_id}}` - Hide rules that are ok: -`gcpdiag lint --project={{gcp_project_id}} --hide-ok` +`gcpdiag lint --project {{gcp_project_id}} --hide-ok` - Authenticate using a service account private key file: -`gcpdiag lint --project={{gcp_project_id}} --auth-key {{path/to/private_key}}` +`gcpdiag lint --project {{gcp_project_id}} --auth-key {{path/to/private_key}}` - Search logs and metrics from a number of days back (default: 3 days): -`gcpdiag lint --project={{gcp_project_id}} --within-days {{number}}` +`gcpdiag lint --project {{gcp_project_id}} --within-days {{number}}` - Display help: diff --git a/pages/common/gist.md b/pages/common/gist.md index 4a517bcf375cfd..39081def94703f 100644 --- a/pages/common/gist.md +++ b/pages/common/gist.md @@ -13,7 +13,7 @@ - Create a private gist with a description: -`gist --private --description "{{A meaningful description}}" {{file.txt}}` +`gist {{[-p|--private]}} {{[-d|--description]}} "{{A meaningful description}}" {{file.txt}}` - Read contents from `stdin` and create a gist from it: @@ -21,12 +21,12 @@ - List your public and private gists: -`gist --list` +`gist {{[-l|--list]}}` - List all public gists for any user: -`gist --list {{username}}` +`gist {{[-l|--list]}} {{username}}` - Update a gist using the ID from URL: -`gist --update {{GIST_ID}} {{file.txt}}` +`gist {{[-u|--update]}} {{GIST_ID}} {{file.txt}}` diff --git a/pages/common/gitleaks.md b/pages/common/gitleaks.md index e8f619eb0cbf8e..54c295301c3947 100644 --- a/pages/common/gitleaks.md +++ b/pages/common/gitleaks.md @@ -1,7 +1,7 @@ # gitleaks > Detect secrets and API keys leaked in Git repositories. -> More information: . +> More information: . - Scan a remote repository: @@ -9,19 +9,19 @@ - Scan a local directory: -`gitleaks detect --source {{path/to/repository}}` +`gitleaks detect {{[-s|--source]}} {{path/to/repository}}` - Output scan results to a JSON file: -`gitleaks detect --source {{path/to/repository}} --report {{path/to/report.json}}` +`gitleaks detect {{[-s|--source]}} {{path/to/repository}} --report {{path/to/report.json}}` - Use a custom rules file: -`gitleaks detect --source {{path/to/repository}} --config-path {{path/to/config.toml}}` +`gitleaks detect {{[-s|--source]}} {{path/to/repository}} --config-path {{path/to/config.toml}}` - Start scanning from a specific commit: -`gitleaks detect --source {{path/to/repository}} --log-opts {{--since=commit_id}}` +`gitleaks detect {{[-s|--source]}} {{path/to/repository}} --log-opts {{--since=commit_id}}` - Scan uncommitted changes before a commit: diff --git a/pages/common/gitsome.md b/pages/common/gitsome.md index 261cbaaf59370f..ae6d20d03dde7b 100644 --- a/pages/common/gitsome.md +++ b/pages/common/gitsome.md @@ -2,7 +2,7 @@ > A terminal-based interface for GitHub, accessed via the `gh` command. > It also provides menu-style autocomplete suggestions for `git` commands. -> More information: . +> More information: . - Enter the gitsome shell (optional), to enable autocompletion and interactive help for Git (and gh) commands: @@ -26,4 +26,4 @@ - View the recent activity feed for a given GitHub user, using the default pager (e.g. `less`): -`gh feed {{torvalds}} -p` +`gh feed {{torvalds}} {{[-p|--pager]}}` diff --git a/pages/common/gnomon.md b/pages/common/gnomon.md index 7d35a4a8b55e09..23e10ab86599a1 100644 --- a/pages/common/gnomon.md +++ b/pages/common/gnomon.md @@ -1,7 +1,7 @@ # gnomon > Utility to annotate console logging statements with timestamps and find slow processes. -> More information: . +> More information: . - Use UNIX (or DOS) pipes to pipe `stdout` of any command through gnomon: @@ -9,16 +9,16 @@ - Show number of seconds since the start of the process: -`{{npm test}} | gnomon --type=elapsed-total` +`{{npm test}} | gnomon {{[-t|--type]}} elapsed-total` - Show an absolute timestamp in UTC: -`{{npm test}} | gnomon --type=absolute` +`{{npm test}} | gnomon {{[-t|--type]}} absolute` - Use a high threshold of 0.5 seconds, exceeding which the timestamp will be colored bright red: -`{{npm test}} | gnomon --high 0.5` +`{{npm test}} | gnomon {{[-h|--high]}} 0.5` - Use a medium threshold of 0.2 seconds, exceeding which the timestamp will be colored bright yellow: -`{{npm test}} | gnomon --medium {{0.2}}` +`{{npm test}} | gnomon {{[-m|--medium]}} 0.2` diff --git a/pages/common/guetzli.md b/pages/common/guetzli.md index fe2162110ba88d..14c784bead6fa1 100644 --- a/pages/common/guetzli.md +++ b/pages/common/guetzli.md @@ -1,7 +1,7 @@ # guetzli > JPEG image compression utility. -> More information: . +> More information: . - Compress a JPEG image: diff --git a/pages/common/hashid.md b/pages/common/hashid.md index 2ee5511eef684c..e83228116cf452 100644 --- a/pages/common/hashid.md +++ b/pages/common/hashid.md @@ -1,7 +1,7 @@ # hashid > Python3 program that identifies data and password hashes. -> More information: . +> More information: . - Identify hashes from `stdin` (through typing, copying and pasting, or piping the hash into the program): @@ -17,12 +17,12 @@ - Show all possible hash types (including salted hashes): -`hashid --extended {{hash}}` +`hashid {{[-e|--extended]}} {{hash}}` - Show `hashcat`'s mode number and `john`'s format string of the hash types: -`hashid --mode --john {{hash}}` +`hashid {{[-m|--mode]}} {{[-j|--john]}} {{hash}}` - Save output to a file instead of printing to `stdout`: -`hashid --outfile {{path/to/output.txt}} {{hash}}` +`hashid {{[-o|--outfile]}} {{path/to/output.txt}} {{hash}}` diff --git a/pages/common/hcloud.md b/pages/common/hcloud.md index e63c47083eec2e..483088471ba990 100644 --- a/pages/common/hcloud.md +++ b/pages/common/hcloud.md @@ -1,16 +1,16 @@ # hcloud > Show how to use the CLI for Hetzner Cloud. -> More information: . +> More information: . - Show available commands and flags: `hcloud` -- Display help: - -`hcloud -h` - - Show available commands and flags for `hcloud` contexts: `hcloud context` + +- Display help: + +`hcloud -h` diff --git a/pages/common/hping3.md b/pages/common/hping3.md index 4c66d76493b3e4..6abd20ff3ae69d 100644 --- a/pages/common/hping3.md +++ b/pages/common/hping3.md @@ -2,32 +2,32 @@ > Advanced ping utility which supports protocols such TCP, UDP, and raw IP. > Best run with elevated privileges. -> More information: . +> More information: . - Ping a destination with 4 ICMP ping requests: -`hping3 --icmp --count {{4}} {{ip_or_hostname}}` +`hping3 {{[-1|--icmp]}} {{[-c|--count]}} 4 {{ip_or_hostname}}` - Ping an IP address over UDP on port 80: -`hping3 --udp --destport {{80}} --syn {{ip_or_hostname}}` +`hping3 {{[-2|--udp]}} {{[-p|--destport]}} 80 {{[-S|--syn]}} {{ip_or_hostname}}` - Scan TCP port 80, scanning from the specific local source port 5090: -`hping3 --verbose --syn --destport {{80}} --baseport {{5090}} {{ip_or_hostname}}` +`hping3 {{[-V|--verbose]}} {{[-S|--syn]}} {{[-p|--destport]}} 80 {{[-s|--baseport]}} 5090 {{ip_or_hostname}}` - Traceroute using a TCP scan to a specific destination port: -`hping3 --traceroute --verbose --syn --destport {{80}} {{ip_or_hostname}}` +`hping3 {{[-T|--traceroute]}} {{[-V|--verbose]}} {{[-S|--syn]}} {{[-p|--destport]}} {{80}} {{ip_or_hostname}}` - Scan a set of TCP ports on a specific IP address: -`hping3 --scan {{80,3000,9000}} --syn {{ip_or_hostname}}` +`hping3 {{[-8|--scan]}} {{80,3000,9000}} {{[-S|--syn]}} {{ip_or_hostname}}` - Perform a TCP ACK scan to check if a given host is alive: -`hping3 --count {{2}} --verbose --destport {{80}} --ack {{ip_or_hostname}}` +`hping3 {{[-c|--count]}} {{2}} {{[-V|--verbose]}} {{[-p|--destport]}} {{80}} {{[-A|--ack]}} {{ip_or_hostname}}` - Perform a charge test on port 80: -`hping3 --flood --destport {{80}} --syn {{ip_or_hostname}}` +`hping3 --flood {{[-p|--destport]}} 80 {{[-S|--syn]}} {{ip_or_hostname}}` diff --git a/pages/common/htmlq.md b/pages/common/htmlq.md index ca56e697917bb2..62fc8f600ecd16 100644 --- a/pages/common/htmlq.md +++ b/pages/common/htmlq.md @@ -1,7 +1,7 @@ # htmlq > Use CSS selectors to extract content from HTML files. -> More information: . +> More information: . - Return all elements of class `card`: @@ -9,16 +9,16 @@ - Get the text content of the first paragraph: -`cat {{path/to/file.html}} | htmlq --text 'p:first-of-type'` +`cat {{path/to/file.html}} | htmlq {{[-t|--text]}} 'p:first-of-type'` - Find all the links in a page: -`cat {{path/to/file.html}} | htmlq --attribute href 'a'` +`cat {{path/to/file.html}} | htmlq {{[-a|--attribute]}} href 'a'` - Remove all images and SVGs from a page: -`cat {{path/to/file.html}} | htmlq --remove-nodes 'img' --remove-nodes 'svg'` +`cat {{path/to/file.html}} | htmlq {{[-r|--remove-nodes]}} 'img' {{[-r|--remove-nodes]}} 'svg'` - Pretty print and write the output to a file: -`htmlq --pretty --filename {{path/to/input.html}} --output {{path/to/output.html}}` +`htmlq {{[-p|--pretty]}} {{[-f|--filename]}} {{path/to/input.html}} {{[-o|--output]}} {{path/to/output.html}}` diff --git a/pages/common/hunspell.md b/pages/common/hunspell.md index 21551668efe29b..7ae4d02fc6e929 100644 --- a/pages/common/hunspell.md +++ b/pages/common/hunspell.md @@ -1,7 +1,7 @@ # hunspell > Check spelling. -> More information: . +> More information: . - Check the spelling of a file: diff --git a/pages/common/inkmake.md b/pages/common/inkmake.md index e094b6173e9c46..1e0dd7c5816d30 100644 --- a/pages/common/inkmake.md +++ b/pages/common/inkmake.md @@ -1,7 +1,7 @@ # inkmake > GNU Makefile-style SVG exporting using Inkscape's backend. -> More information: . +> More information: . - Export an SVG file executing the specified Inkfile: @@ -9,16 +9,16 @@ - Execute an Inkfile and show detailed information: -`inkmake --verbose {{path/to/Inkfile}}` +`inkmake {{[-v|--verbose]}} {{path/to/Inkfile}}` - Execute an Inkfile, specifying SVG input file(s) and an output file: -`inkmake --svg {{path/to/file.svg}} --out {{path/to/output_image}} {{path/to/Inkfile}}` +`inkmake {{[-s|--svg]}} {{path/to/file.svg}} {{[-o|--out]}} {{path/to/output_image}} {{path/to/Inkfile}}` - Use a custom Inkscape binary as the backend: -`inkmake --inkscape {{/Applications/Inkscape.app/Contents/Resources/bin/inkscape}} {{path/to/Inkfile}}` +`inkmake {{[-i|--inkscape]}} {{/Applications/Inkscape.app/Contents/Resources/bin/inkscape}} {{path/to/Inkfile}}` - Display help: -`inkmake --help` +`inkmake {{[-h|--help]}}` diff --git a/pages/common/tuckr.md b/pages/common/tuckr.md index 7619fb3e528a3a..957097b1f59d43 100644 --- a/pages/common/tuckr.md +++ b/pages/common/tuckr.md @@ -2,7 +2,7 @@ > Dotfile manager written in Rust. > See also: `chezmoi`, `vcsh`, `homeshick`, `stow`. -> More information: . +> More information: . - Check dotfile status: