diff --git a/tldr/bash-it b/tldr/bash-it index 93847910..31a42e50 100644 --- a/tldr/bash-it +++ b/tldr/bash-it @@ -12,7 +12,7 @@ source: https://github.com/tldr-pages/tldr.git `bash-it update {{stable|dev}}` -- Reload Bash profile (set `BASH_IT_AUTOMATIC_RELOAD_AFTER_CONFIG_CHANGE` to non-empty value for an automatic reload): +- Reload Bash profile (set `$BASH_IT_AUTOMATIC_RELOAD_AFTER_CONFIG_CHANGE` to non-empty value for an automatic reload): `bash-it reload` diff --git a/tldr/clear b/tldr/clear index 26460d96..e42471ca 100644 --- a/tldr/clear +++ b/tldr/clear @@ -16,7 +16,7 @@ source: https://github.com/tldr-pages/tldr.git `clear -x` -- Indicate the type of terminal to clean (defaults to the value of the environment variable `TERM`): +- Indicate the type of terminal to clean (defaults to the value of the environment variable `$TERM`): `clear -T {{type_of_terminal}}` diff --git a/tldr/compgen b/tldr/compgen index 1c4387f5..89aafde7 100644 --- a/tldr/compgen +++ b/tldr/compgen @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git `compgen -c` -- List all commands that you could run that start with a specified string and save results to `COMPREPLY`: +- List all commands that you could run that start with a specified string and save results to `$COMPREPLY`: `compgen -V COMPREPLY -c {{str}}` diff --git a/tldr/complete b/tldr/complete index 930f267a..1cb24fde 100644 --- a/tldr/complete +++ b/tldr/complete @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git > See also: `compgen`, `compopt`. > More information: . -- Set arguments of a command to autocomplete through a function (completion response is sent in `COMPREPLY` variable): +- Set arguments of a command to autocomplete through a function (completion response is sent in `$COMPREPLY` variable): `complete -F {{function}} {{command}}` diff --git a/tldr/conda-init b/tldr/conda-init index 19911632..e8104924 100644 --- a/tldr/conda-init +++ b/tldr/conda-init @@ -25,7 +25,7 @@ source: https://github.com/tldr-pages/tldr.git `conda init --no-user` -- Add `condabin/` directory to PATH: +- Add `condabin/` directory to `$PATH`: `conda init --condabin` diff --git a/tldr/cosign b/tldr/cosign index 5409e1cb..43af729a 100644 --- a/tldr/cosign +++ b/tldr/cosign @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # cosign > Container Signing, Verification and Storage in an OCI registry. -> More information: . +> More information: . - Generate a key-pair: @@ -14,11 +14,11 @@ source: https://github.com/tldr-pages/tldr.git - 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: @@ -26,7 +26,7 @@ source: https://github.com/tldr-pages/tldr.git - 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: @@ -34,7 +34,7 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/crane-registry b/tldr/crane-registry index c41787b9..8d424682 100644 --- a/tldr/crane-registry +++ b/tldr/crane-registry @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # crane registry -> This command serves a registry implementation on an automatically chosen port (:0), $PORT or --address. +> This command serves a registry implementation on an automatically chosen port (:0), `$PORT` or --address. > The command blocks while the server accepts pushes and pulls and contents are can be stored in memory, and disk. > More information: . diff --git a/tldr/cups-config b/tldr/cups-config index 81248706..a6b323e4 100644 --- a/tldr/cups-config +++ b/tldr/cups-config @@ -24,6 +24,6 @@ source: https://github.com/tldr-pages/tldr.git `cups-config --help` -- Display CUPS version: +- Display version: `cups-config --version` diff --git a/tldr/cvs b/tldr/cvs index a8f52f3a..ef5c004c 100644 --- a/tldr/cvs +++ b/tldr/cvs @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Concurrent Versions System, a revision control system. > More information: . -- Create a new repository (requires the `CVSROOT` environment variable to be set externally): +- Create a new repository (requires the `$CVSROOT` environment variable to be set externally): `cvs -d {{path/to/repository}} init` diff --git a/tldr/dillo b/tldr/dillo index 81379fa8..aeafc28c 100644 --- a/tldr/dillo +++ b/tldr/dillo @@ -28,10 +28,10 @@ source: https://github.com/tldr-pages/tldr.git `dillo {{[-f|--fullwindow]}}` -- Display version: - -`dillo {{[-v|--version]}}` - - Display help: `dillo {{[-h|--help]}}` + +- Display version: + +`dillo {{[-v|--version]}}` diff --git a/tldr/dircolors b/tldr/dircolors index 6bd0a360..fb9f12ec 100644 --- a/tldr/dircolors +++ b/tldr/dircolors @@ -5,10 +5,10 @@ source: https://github.com/tldr-pages/tldr.git --- # dircolors -> Output commands to set the LS_COLOR environment variable and style `ls`, `dir`, etc. +> Output commands to set the `$LS_COLOR` environment variable and style `ls`, `dir`, etc. > More information: . -- Output commands to set LS_COLOR using default colors: +- Output commands to set `$LS_COLOR` using default colors: `dircolors` @@ -16,7 +16,7 @@ source: https://github.com/tldr-pages/tldr.git `dircolors --print-ls-colors` -- Output commands to set LS_COLOR using colors from a file: +- Output commands to set `$LS_COLOR` using colors from a file: `dircolors {{path/to/file}}` diff --git a/tldr/direnv b/tldr/direnv index 742e6a80..961f8064 100644 --- a/tldr/direnv +++ b/tldr/direnv @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # 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/tldr/dnsmasq b/tldr/dnsmasq index 8cce007e..1e5fce83 100644 --- a/tldr/dnsmasq +++ b/tldr/dnsmasq @@ -28,6 +28,6 @@ source: https://github.com/tldr-pages/tldr.git `dnsmasq --dhcp-range={{192.168.0.50,192.168.0.150,12h}}` -- Print dnsmasq version: +- Display version: `dnsmasq --version` diff --git a/tldr/docker-context b/tldr/docker-context index 68729050..5f6a905c 100644 --- a/tldr/docker-context +++ b/tldr/docker-context @@ -12,7 +12,7 @@ source: https://github.com/tldr-pages/tldr.git `docker context create {{my_context}} --docker "host={{tcp://remote-host:2375}}"` -- Create a context based on the `DOCKER_HOST` environment variable: +- Create a context based on the `$DOCKER_HOST` environment variable: `docker context create {{my_context}}` diff --git a/tldr/docker-slim b/tldr/docker-slim index caaba742..76d0b3d1 100644 --- a/tldr/docker-slim +++ b/tldr/docker-slim @@ -5,25 +5,8 @@ source: https://github.com/tldr-pages/tldr.git --- # docker-slim -> Analyze and optimize Docker images. -> More information: . +> This command is an alias of `slim`. -- Start DockerSlim on interactive mode: +- View documentation for the original command: -`docker-slim` - -- Analyze Docker layers from a specific image: - -`docker-slim xray --target {{image:tag}}` - -- Lint a Dockerfile: - -`docker-slim lint --target {{path/to/Dockerfile}}` - -- Analyze and generate an optimized Docker image: - -`docker-slim build {{image:tag}}` - -- Display help for a subcommand: - -`docker-slim {{subcommand}} --help` +`tldr slim` diff --git a/tldr/eget b/tldr/eget index a5c91fe5..ff78513d 100644 --- a/tldr/eget +++ b/tldr/eget @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # eget > Easily install prebuilt binaries from GitHub. -> More information: . +> More information: . - Download a prebuilt binary for the current system from a repository on GitHub: @@ -18,11 +18,11 @@ source: https://github.com/tldr-pages/tldr.git - 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: @@ -30,7 +30,7 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/eol b/tldr/eol index fcb16cd1..fe96d7ff 100644 --- a/tldr/eol +++ b/tldr/eol @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # eol > Show end-of-life dates (EoLs) for a number of products. -> More information: . +> More information: . - List all available products: @@ -18,16 +18,16 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/eva b/tldr/eva index e937d610..0f75d945 100644 --- a/tldr/eva +++ b/tldr/eva @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # 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/tldr/export b/tldr/export index d1000d75..e5170514 100644 --- a/tldr/export +++ b/tldr/export @@ -12,6 +12,6 @@ source: https://github.com/tldr-pages/tldr.git `export {{VARIABLE}}={{value}}` -- Append a pathname to the environment variable `PATH`: +- Append a pathname to the environment variable `$PATH`: `export PATH=$PATH:{{path/to/append}}` diff --git a/tldr/fdroidcl b/tldr/fdroidcl index 0b698498..627237a6 100644 --- a/tldr/fdroidcl +++ b/tldr/fdroidcl @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # fdroidcl > Manage F-Droid apps of devices connected via ADB. -> More information: . +> More information: . - Fetch the F-Droid index: diff --git a/tldr/fkill b/tldr/fkill index 14b43a8b..5ef32825 100644 --- a/tldr/fkill +++ b/tldr/fkill @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # fkill > Fabulously kill processes. Cross-platform. -> More information: . +> More information: . - Run without arguments to use the interactive interface: diff --git a/tldr/flask b/tldr/flask index 29250937..d9f74462 100644 --- a/tldr/flask +++ b/tldr/flask @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # flask -> A general utility script for Flask applications. Loads the application defined in the `FLASK_APP` environment variable. +> A general utility script for Flask applications. Loads the application defined in the `$FLASK_APP` environment variable. > More information: . - Run a development server: diff --git a/tldr/flyctl b/tldr/flyctl index 26a489d8..7c3555c3 100644 --- a/tldr/flyctl +++ b/tldr/flyctl @@ -36,6 +36,6 @@ source: https://github.com/tldr-pages/tldr.git `flyctl status --app {{app_name}}` -- Display version information: +- Display version: `flyctl version` diff --git a/tldr/gcpdiag b/tldr/gcpdiag index aebdd072..860f46c7 100644 --- a/tldr/gcpdiag +++ b/tldr/gcpdiag @@ -7,23 +7,23 @@ source: https://github.com/tldr-pages/tldr.git > 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/tldr/gdm b/tldr/gdm index a7f513d2..f5f0df81 100644 --- a/tldr/gdm +++ b/tldr/gdm @@ -21,7 +21,7 @@ source: https://github.com/tldr-pages/tldr.git `gdm --no-console` -- Prevent sanitizing environment variables that start with `LD_`: +- Prevent sanitizing environment variables that start with `$LD_`: `gdm --preserve-ld-vars` diff --git a/tldr/gettext b/tldr/gettext index f1f9dc18..82c830b8 100644 --- a/tldr/gettext +++ b/tldr/gettext @@ -18,6 +18,6 @@ source: https://github.com/tldr-pages/tldr.git `gettext {{[-h|--help]}}` -- Display gettext version: +- Display version: `gettext {{[-V|--version]}}` diff --git a/tldr/gist b/tldr/gist index 3c8a07b7..af798c6f 100644 --- a/tldr/gist +++ b/tldr/gist @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - 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: @@ -26,12 +26,12 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/github-label-sync b/tldr/github-label-sync index 5b4be884..af6ba7c9 100644 --- a/tldr/github-label-sync +++ b/tldr/github-label-sync @@ -24,6 +24,6 @@ source: https://github.com/tldr-pages/tldr.git `github-label-sync --access-token {{token}} --allow-added-labels {{repository_name}}` -- Synchronize using the `GITHUB_ACCESS_TOKEN` environment variable: +- Synchronize using the `$GITHUB_ACCESS_TOKEN` environment variable: `github-label-sync {{repository_name}}` diff --git a/tldr/gitleaks b/tldr/gitleaks index 22462dd7..03d99b55 100644 --- a/tldr/gitleaks +++ b/tldr/gitleaks @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # gitleaks > Detect secrets and API keys leaked in Git repositories. -> More information: . +> More information: . - Scan a remote repository: @@ -14,19 +14,19 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/gitsome b/tldr/gitsome index 36b5d18f..01f73a5b 100644 --- a/tldr/gitsome +++ b/tldr/gitsome @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > 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: @@ -31,4 +31,4 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/gnomon b/tldr/gnomon index 8947e2e9..d5989157 100644 --- a/tldr/gnomon +++ b/tldr/gnomon @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # 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: @@ -14,16 +14,16 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/guetzli b/tldr/guetzli index c274b0c6..34f3408e 100644 --- a/tldr/guetzli +++ b/tldr/guetzli @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # guetzli > JPEG image compression utility. -> More information: . +> More information: . - Compress a JPEG image: diff --git a/tldr/hashid b/tldr/hashid index 9a3644ac..1616e6e2 100644 --- a/tldr/hashid +++ b/tldr/hashid @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # 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): @@ -22,12 +22,12 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/hcloud b/tldr/hcloud index 1b13f477..822de594 100644 --- a/tldr/hcloud +++ b/tldr/hcloud @@ -6,16 +6,16 @@ source: https://github.com/tldr-pages/tldr.git # 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/tldr/hping3 b/tldr/hping3 index 022f387e..66f0555d 100644 --- a/tldr/hping3 +++ b/tldr/hping3 @@ -7,32 +7,32 @@ source: https://github.com/tldr-pages/tldr.git > 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/tldr/htmlq b/tldr/htmlq index 7623f3ae..d0563e21 100644 --- a/tldr/htmlq +++ b/tldr/htmlq @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # htmlq > Use CSS selectors to extract content from HTML files. -> More information: . +> More information: . - Return all elements of class `card`: @@ -14,16 +14,16 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/hunspell b/tldr/hunspell index b80be67c..5d6f0614 100644 --- a/tldr/hunspell +++ b/tldr/hunspell @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # hunspell > Check spelling. -> More information: . +> More information: . - Check the spelling of a file: diff --git a/tldr/inkmake b/tldr/inkmake index ffee30ec..2016ceb9 100644 --- a/tldr/inkmake +++ b/tldr/inkmake @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # inkmake > GNU Makefile-style SVG exporting using Inkscape's backend. -> More information: . +> More information: . - Export an SVG file executing the specified Inkfile: @@ -14,16 +14,16 @@ source: https://github.com/tldr-pages/tldr.git - 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/tldr/iverilog b/tldr/iverilog index b552dfca..d39e0942 100644 --- a/tldr/iverilog +++ b/tldr/iverilog @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # iverilog > Preprocesses and compiles Verilog HDL (IEEE-1364) code into executable programs for simulation. -> More information: . +> More information: . - Compile a source file into an executable: diff --git a/tldr/kcat b/tldr/kcat index 2193e303..214ea028 100644 --- a/tldr/kcat +++ b/tldr/kcat @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # kcat > Apache Kafka producer and consumer tool. -> More information: . +> More information: . - Consume messages starting with the newest offset: diff --git a/tldr/krunvm b/tldr/krunvm index 17b48f94..66d91873 100644 --- a/tldr/krunvm +++ b/tldr/krunvm @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # krunvm > Create MicroVMs from OCI images. -> More information: . +> More information: . - Create MicroVM based on Fedora: diff --git a/tldr/lambo-new b/tldr/lambo-new index ca0310d7..ad60288a 100644 --- a/tldr/lambo-new +++ b/tldr/lambo-new @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # lambo new > A super-powered `laravel new` for Laravel and Valet. -> More information: . +> More information: . - Create a new Laravel application: @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Install the application in a specific path: -`lambo new --path={{path/to/directory}} {{app_name}}` +`lambo new {{[-p|--path]}} {{path/to/directory}} {{app_name}}` - Include authentication scaffolding: @@ -30,7 +30,7 @@ source: https://github.com/tldr-pages/tldr.git - Create a Valet site after the project has been created: -`lambo new --link {{app_name}}` +`lambo new {{[-l|--link]}} {{app_name}}` - Create a new MySQL database with the same name as the project: @@ -38,4 +38,4 @@ source: https://github.com/tldr-pages/tldr.git - Open a specific editor after the project has been created: -`lambo new --editor="{{editor}}" {{app_name}}` +`lambo new {{[-e|--editor]}} "{{editor}}" {{app_name}}` diff --git a/tldr/lazygit b/tldr/lazygit index b146ada5..ec20438c 100644 --- a/tldr/lazygit +++ b/tldr/lazygit @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # lazygit > A simple terminal UI for Git commands, providing an intuitive interface for managing repositories. -> More information: . +> More information: . - Open Lazygit in the current repository: @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Open Lazygit for a specific Git repository: -`lazygit --path {{path/to/repository}}` +`lazygit {{[-p|--path]}} {{path/to/repository}}` - Start Lazygit with focus on a specific panel: @@ -22,16 +22,16 @@ source: https://github.com/tldr-pages/tldr.git - Print the default Lazygit configuration: -`lazygit --config` +`lazygit {{[-c|--config]}}` - Tail the Lazygit logs (useful with debug mode in another terminal): -`lazygit --logs` +`lazygit {{[-l|--logs]}}` - Run Lazygit in debug mode: -`lazygit --debug` +`lazygit {{[-d|--debug]}}` - Print the configuration directory: -`lazygit --print-config-dir` +`lazygit {{[-cd|--print-config-dir]}}` diff --git a/tldr/light-arionum-cli b/tldr/light-arionum-cli index d11274c2..3072e203 100644 --- a/tldr/light-arionum-cli +++ b/tldr/light-arionum-cli @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # light-arionum-cli > The PHP light wallet for the Arionum cryptocurrency. -> More information: . +> More information: . - Generate a new public/private key pair: diff --git a/tldr/lighthouse b/tldr/lighthouse index 94148b9b..c2f4a8a1 100644 --- a/tldr/lighthouse +++ b/tldr/lighthouse @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # lighthouse > Analyzes web applications and web pages, collecting modern performance metrics and insights on developer best practices. -> More information: . +> More information: . - Generate an HTML report for a specific website and save it to a file in the current directory: diff --git a/tldr/linux/agetty b/tldr/linux/agetty index d52d4669..517029a9 100644 --- a/tldr/linux/agetty +++ b/tldr/linux/agetty @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git `agetty {{[-t|--timeout]}} {{timeout_in_seconds}} -` -- Assume the `tty` is 8-bit, overriding the `TERM` environment variable set by `init`: +- Assume the `tty` is 8-bit, overriding the `$TERM` environment variable set by `init`: `agetty {{[-8|--8bits]}} - {{term_var}}` diff --git a/tldr/linux/eselect-locale b/tldr/linux/eselect-locale index 284a7c1a..dd825ef3 100644 --- a/tldr/linux/eselect-locale +++ b/tldr/linux/eselect-locale @@ -5,17 +5,17 @@ source: https://github.com/tldr-pages/tldr.git --- # eselect locale -> An `eselect` module for managing the `LANG` environment variable, which sets the system language. +> An `eselect` module for managing the `$LANG` environment variable, which sets the system language. > More information: . - List available locales: `eselect locale list` -- Set the `LANG` environment variable in `/etc/profile.env` by name or index from the `list` command: +- Set the `$LANG` environment variable in `/etc/profile.env` by name or index from the `list` command: `eselect locale set {{name|index}}` -- Display the value of `LANG` in `/etc/profile.env`: +- Display the value of `$LANG` in `/etc/profile.env`: `eselect locale show` diff --git a/tldr/linux/export b/tldr/linux/export index 3d4b6cc9..6901e527 100644 --- a/tldr/linux/export +++ b/tldr/linux/export @@ -20,7 +20,7 @@ source: https://github.com/tldr-pages/tldr.git `export -f {{FUNCTION_NAME}}` -- Append a pathname to the environment variable `PATH`: +- Append a pathname to the environment variable `$PATH`: `export PATH=$PATH:{{path/to/append}}` diff --git a/tldr/linux/gnome-screenshot b/tldr/linux/gnome-screenshot index f19549ec..0d44f8b3 100644 --- a/tldr/linux/gnome-screenshot +++ b/tldr/linux/gnome-screenshot @@ -36,6 +36,6 @@ source: https://github.com/tldr-pages/tldr.git `gnome-screenshot {{[-d|--delay]}} {{10}} {{[-c|--clipboard]}}` -- Display the version: +- Display version: `gnome-screenshot --version` diff --git a/tldr/linux/gnome-software b/tldr/linux/gnome-software index e51fa487..2511ce7e 100644 --- a/tldr/linux/gnome-software +++ b/tldr/linux/gnome-software @@ -20,6 +20,6 @@ source: https://github.com/tldr-pages/tldr.git `gnome-software --details {{package}}` -- Display the version: +- Display version: `gnome-software --version` diff --git a/tldr/linux/rkhunter b/tldr/linux/rkhunter index ed1312c3..2ae98f57 100644 --- a/tldr/linux/rkhunter +++ b/tldr/linux/rkhunter @@ -20,10 +20,10 @@ source: https://github.com/tldr-pages/tldr.git `sudo rkhunter --list` -- Display version: - -`sudo rkhunter --versioncheck` - - Display help: `sudo rkhunter --help` + +- Display version: + +`sudo rkhunter --versioncheck` diff --git a/tldr/linux/systemctl-import-environment b/tldr/linux/systemctl-import-environment new file mode 100644 index 00000000..3a500fa9 --- /dev/null +++ b/tldr/linux/systemctl-import-environment @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# systemctl import-environment + +> Import environment variables from the shell into systemd's environment. +> See also: `show-environment`, `unset-environment`. +> More information: . + +- Import a variable: + +`systemctl import-environment {{variable}}` + +- Import multiple variables: + +`systemctl import-environment {{variable_1 variable_2 ...}}` + +- Import variables for user services: + +`systemctl import-environment {{variable}} --user` diff --git a/tldr/linux/torsocks b/tldr/linux/torsocks index f821d9cb..4f605d96 100644 --- a/tldr/linux/torsocks +++ b/tldr/linux/torsocks @@ -21,7 +21,7 @@ source: https://github.com/tldr-pages/tldr.git `torsocks --shell` -- Check if current shell is Tor enabled (`LD_PRELOAD` value will be empty if disabled): +- Check if current shell is Tor enabled (`$LD_PRELOAD` value will be empty if disabled): `torsocks show` diff --git a/tldr/liquidctl b/tldr/liquidctl index 0f918d8b..1c0a6354 100644 --- a/tldr/liquidctl +++ b/tldr/liquidctl @@ -22,4 +22,4 @@ source: https://github.com/tldr-pages/tldr.git - Match a string in product name to pick a device and set its fan speed to 0% at 20°C, 50% at 50°C and 100% at 70°C: -`liquidctl --match {{string}} set fan speed {{20 0 50 50 70 100}}` +`liquidctl {{[-m|--match]}} {{string}} set fan speed {{20 0 50 50 70 100}}` diff --git a/tldr/lspath b/tldr/lspath index 0a29ea23..bd95fef4 100644 --- a/tldr/lspath +++ b/tldr/lspath @@ -5,13 +5,13 @@ source: https://github.com/tldr-pages/tldr.git --- # lspath -> List the contents of the `PATH` environment variable, with optional paging. +> List the contents of the `$PATH` environment variable, with optional paging. > More information: . -- Print the contents of the system `PATH` variable, with one element per line: +- Print the contents of the system `$PATH` variable, with one element per line: `lspath` -- Print the current contents of the system `PATH` variable, with one element per line, with the output paged: +- Print the current contents of the system `$PATH` variable, with one element per line, with the output paged: `lspath --page` diff --git a/tldr/lsyncd b/tldr/lsyncd index ab573933..206738cd 100644 --- a/tldr/lsyncd +++ b/tldr/lsyncd @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Watch files and directories and run `rsync` when they change. > It is often used to keep two directories on separate systems in sync, ensuring that changes made in one directory are immediately mirrored to the other. -> More information: . +> More information: . - Watch the source for changes and run `rsync` to synchronize files to the destination on every change: diff --git a/tldr/man b/tldr/man index ed129034..5919063a 100644 --- a/tldr/man +++ b/tldr/man @@ -12,7 +12,7 @@ source: https://github.com/tldr-pages/tldr.git `man {{command}}` -- Open the man page for a command in a browser (`BROWSER` environment variable can replace `=browser_name`): +- Open the man page for a command in a browser (`$BROWSER` environment variable can replace `=browser_name`): `man {{[-H|--html=]}}{{browser_name}} {{command}}` diff --git a/tldr/mkcert b/tldr/mkcert index 6c4d9686..b11fadab 100644 --- a/tldr/mkcert +++ b/tldr/mkcert @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # mkcert > Make locally-trusted development certificates. -> More information: . +> More information: . - Install the local CA in the system trust store: diff --git a/tldr/ned b/tldr/ned index 32825150..759ae198 100644 --- a/tldr/ned +++ b/tldr/ned @@ -7,11 +7,11 @@ source: https://github.com/tldr-pages/tldr.git > Like `grep` but with powerful replace capabilities. > Unlike `sed`, as it isn't restricted to line oriented editing. -> More information: . +> More information: . - Recursively search starting in the current directory, ignoring case: -`ned --ignore-case --recursive '{{^[dl]og}}' {{.}}` +`ned {{[-i|--ignore-case]}} {{[-R|--recursive]}} '{{^[dl]og}}' {{.}}` - Search always showing colored output: @@ -19,24 +19,24 @@ source: https://github.com/tldr-pages/tldr.git - Search never showing colored output: -`ned --colors=never '{{^[dl]og}}' {{.}}` +`ned --colors never '{{^[dl]og}}' {{.}}` - Search ignoring certain files: -`ned --recursive --exclude '{{*.htm}}' '{{^[dl]og}}' {{.}}` +`ned {{[-R|--recursive]}} --exclude '{{*.htm}}' '{{^[dl]og}}' {{.}}` - Simple replace: -`ned '{{dog}}' --replace '{{cat}}' {{.}}` +`ned '{{dog}}' {{[-r|--replace]}} '{{cat}}' {{.}}` - Replace using numbered group references: -`ned '{{the ([a-z]+) dog and the ([a-z]+) dog}}' --replace '{{the $2 dog and the $1 dog}}' {{.}}` +`ned '{{the ([a-z]+) dog and the ([a-z]+) dog}}' {{[-r|--replace]}} '{{the $2 dog and the $1 dog}}' {{.}}` - Replace changing case: -`ned '{{([a-z]+) dog}}' --case-replacements --replace '{{\U$1! dog}}' --stdout {{.}}` +`ned '{{([a-z]+) dog}}' --case-replacements {{[-r|--replace]}} '{{\U$1! dog}}' --stdout {{.}}` - Preview results of a find and replace without updating the target files: -`ned '{{^[sb]ad}}' --replace '{{happy}}' --stdout {{.}}` +`ned '{{^[sb]ad}}' {{[-r|--replace]}} '{{happy}}' --stdout {{.}}` diff --git a/tldr/newman b/tldr/newman index 5eb2e257..0a1ce742 100644 --- a/tldr/newman +++ b/tldr/newman @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # newman > Collection runner for Postman. -> More information: . +> More information: . - Run a collection (from a file): diff --git a/tldr/ng b/tldr/ng index 175c4012..2b3cbc18 100644 --- a/tldr/ng +++ b/tldr/ng @@ -36,6 +36,6 @@ source: https://github.com/tldr-pages/tldr.git `ng test` -- Display the version of your current Angular installation: +- Display version: `ng version` diff --git a/tldr/nix-edit b/tldr/nix-edit index e3b11570..0e639707 100644 --- a/tldr/nix-edit +++ b/tldr/nix-edit @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # nix edit -> Open the Nix expression of a Nix package in $EDITOR. +> Open the Nix expression of a Nix package in `$EDITOR`. > More information: . - Open the source of the Nix expression of a package from nixpkgs in your `$EDITOR`: diff --git a/tldr/nixpkgs-review b/tldr/nixpkgs-review index e50f9f38..0f11c4e3 100644 --- a/tldr/nixpkgs-review +++ b/tldr/nixpkgs-review @@ -13,7 +13,7 @@ source: https://github.com/tldr-pages/tldr.git `nixpkgs-review pr {{pr_number|pr_url}}` -- Build changed packages and post a comment with a report (requires setting up a token in `hub`, `gh`, or the `GITHUB_TOKEN` environment variable): +- Build changed packages and post a comment with a report (requires setting up a token in `hub`, `gh`, or the `$GITHUB_TOKEN` environment variable): `nixpkgs-review pr --post-result {{pr_number|pr_url}}` diff --git a/tldr/nnn b/tldr/nnn index d834e620..716629f8 100644 --- a/tldr/nnn +++ b/tldr/nnn @@ -20,7 +20,7 @@ source: https://github.com/tldr-pages/tldr.git `nnn -H` -- Open an existing [b]ookmark (defined in the `NNN_BMS` environment variable): +- Open an existing [b]ookmark (defined in the `$NNN_BMS` environment variable): `nnn -b {{bookmark_name}}` diff --git a/tldr/nrm b/tldr/nrm index f5abec50..e4d8fe05 100644 --- a/tldr/nrm +++ b/tldr/nrm @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > npm registry manager. > Helps to easily switch between different npm registries. -> More information: . +> More information: . - List all registries: diff --git a/tldr/nvm b/tldr/nvm index 7f9b3be4..1caf8bef 100644 --- a/tldr/nvm +++ b/tldr/nvm @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Install, uninstall or switch between Node.js versions. > Supports version numbers like "12.8" or "v16.13.1", and labels like "stable", "system", etc. > See also: `asdf`. -> More information: . +> More information: . - Install a specific version of Node.js: diff --git a/tldr/oxipng b/tldr/oxipng index f514d843..f8d912e5 100644 --- a/tldr/oxipng +++ b/tldr/oxipng @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # oxipng > Losslessly improve compression of PNG files. -> More information: . +> More information: . - Compress a PNG file (overwrites the file by default): @@ -22,19 +22,19 @@ source: https://github.com/tldr-pages/tldr.git - Compress a file with a set optimization level (default is 2): -`oxipng --opt {{0|1|2|3|4|5|6|max}} {{path/to/file.png}}` +`oxipng {{[-o|--opt]}} {{0|1|2|3|4|5|6|max}} {{path/to/file.png}}` - Set the PNG interlacing type (`0` removes interlacing, `1` applies Adam7 interlacing, `keep` preserves existing interlacing; default is `0`): -`oxipng --interlace {{0|1|keep}} {{path/to/file.png}}` +`oxipng {{[-i|--interlace]}} {{0|1|keep}} {{path/to/file.png}}` - Perform additional optimization on images with an alpha channel: -`oxipng --alpha {{path/to/file.png}}` +`oxipng {{[-a|--alpha]}} {{path/to/file.png}}` - Use the much slower but stronger Zopfli compressor with max optimization: -`oxipng --zopfli --opt max {{path/to/file.png}}` +`oxipng {{[-Z|--zopfli]}} {{[-o|--opt]}} max {{path/to/file.png}}` - Strip all non-critical metadata chunks: diff --git a/tldr/paci b/tldr/paci index 34d8d85c..f82d4016 100644 --- a/tldr/paci +++ b/tldr/paci @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # paci > A package manager for Bash scripts. -> More information: . +> More information: . - Update the list of available packages and versions (it's recommended to run this before other `paci` commands): diff --git a/tldr/peco b/tldr/peco index 42fc18b9..d10cbf08 100644 --- a/tldr/peco +++ b/tldr/peco @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # peco > Interactive filtering tool. -> More information: . +> More information: . - Start `peco` on all files in the specified directory: diff --git a/tldr/picard b/tldr/picard index cb685b3c..fa56152f 100644 --- a/tldr/picard +++ b/tldr/picard @@ -16,6 +16,6 @@ source: https://github.com/tldr-pages/tldr.git `picard {{path/to/file1.mp3 path/to/file2.mp3 ...}}` -- Display the version of Picard installed: +- Display version: `picard {{[-V|--long-version]}}` diff --git a/tldr/picom b/tldr/picom index 62994683..920a7b0c 100644 --- a/tldr/picom +++ b/tldr/picom @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # picom > Standalone compositor for Xorg. -> More information: . +> More information: . - Enable `picom` during a session: diff --git a/tldr/picom-trans b/tldr/picom-trans index 56fc7632..a993faa7 100644 --- a/tldr/picom-trans +++ b/tldr/picom-trans @@ -6,20 +6,20 @@ source: https://github.com/tldr-pages/tldr.git # picom-trans > Set the window opacity for the `picom` window compositor. -> More information: . +> More information: . - Set the currently focused window opacity to a specific percentage: -`picom-trans --current --opacity {{90}}` +`picom-trans {{[-c|--current]}} {{[-o|--opacity]}} {{percentage}}` - Set the opacity of a window with a specific name: -`picom-trans --name {{Firefox}} --opacity {{90}}` +`picom-trans {{[-n|--name]}} {{Firefox}} {{[-o|--opacity]}} {{percentage}}` - Set the opacity of a specific window selected via mouse cursor: -`picom-trans --select --opacity {{90}}` +`picom-trans {{[-s|--select]}} {{[-o|--opacity]}} {{percentage}}` - Toggle the opacity of a specific window: -`picom-trans --name {{Firefox}} --toggle` +`picom-trans {{[-n|--name]}} {{Firefox}} {{[-t|--toggle]}}` diff --git a/tldr/picotool b/tldr/picotool index a66e9d04..f74c7767 100755 --- a/tldr/picotool +++ b/tldr/picotool @@ -28,10 +28,10 @@ source: https://github.com/tldr-pages/tldr.git `picotool otp list` -- Display version: - -`picotool version` - - Display help: `picotool help` + +- Display version: + +`picotool version` diff --git a/tldr/pipx b/tldr/pipx index e58ee5b9..334e7d7e 100644 --- a/tldr/pipx +++ b/tldr/pipx @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # pipx > Install and run Python applications in isolated environments. -> More information: . +> More information: . - Run an app in a temporary virtual environment: diff --git a/tldr/pixterm b/tldr/pixterm index d142de88..91e0d7c7 100644 --- a/tldr/pixterm +++ b/tldr/pixterm @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Image printing in the terminal. > See also: `chafa`, `catimg`. -> More information: . +> More information: . - Render a static image directly in the terminal: diff --git a/tldr/plenv b/tldr/plenv index bf62e8ff..a3f76b1b 100644 --- a/tldr/plenv +++ b/tldr/plenv @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # plenv > Switch between multiple versions of Perl. -> More information: . +> More information: . - Show the currently selected Perl version and how it was selected: diff --git a/tldr/protector b/tldr/protector index e7423310..8ab899a0 100644 --- a/tldr/protector +++ b/tldr/protector @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # protector > Protect or unprotect branches on GitHub repositories. -> More information: . +> More information: . - Protect branches of a GitHub repository (create branch protection rules): diff --git a/tldr/pueue-edit b/tldr/pueue-edit index 78f9df74..b0585305 100644 --- a/tldr/pueue-edit +++ b/tldr/pueue-edit @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # pueue edit > Edit the command or path of a stashed or queued task. -> More information: . +> More information: . - Edit a task, see `pueue status` to get the task ID: diff --git a/tldr/pueue-follow b/tldr/pueue-follow index 21b525a6..5b8b9d1e 100644 --- a/tldr/pueue-follow +++ b/tldr/pueue-follow @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Follow the output of a currently running task. > See also: `pueue log`. -> More information: . +> More information: . - Follow the output of a task (`stdout` + `stderr`): diff --git a/tldr/pueue-help b/tldr/pueue-help index b3d4dd8a..f6fd826e 100644 --- a/tldr/pueue-help +++ b/tldr/pueue-help @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # pueue help > Display help for subcommands. -> More information: . +> More information: . - Show all available subcommands and flags: diff --git a/tldr/pueue-send b/tldr/pueue-send index ef80328f..76e8f147 100644 --- a/tldr/pueue-send +++ b/tldr/pueue-send @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # pueue send > Send input to a task. -> More information: . +> More information: . - Send input to a running command: diff --git a/tldr/pueue-shutdown b/tldr/pueue-shutdown index 71215bdc..0acc9b95 100644 --- a/tldr/pueue-shutdown +++ b/tldr/pueue-shutdown @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Remotely shut down the daemon. > Only use this subcommand if the daemon isn't started by a service manager. -> More information: . +> More information: . - Shutdown the daemon without a service manager: diff --git a/tldr/pueue-switch b/tldr/pueue-switch index a71f9059..1bb04edb 100644 --- a/tldr/pueue-switch +++ b/tldr/pueue-switch @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # pueue switch > Switches the queue position of two enqueued or stashed commands. -> More information: . +> More information: . - Switch the priority of two tasks: diff --git a/tldr/pulumi-state b/tldr/pulumi-state index df000d34..4f039841 100644 --- a/tldr/pulumi-state +++ b/tldr/pulumi-state @@ -24,7 +24,7 @@ source: https://github.com/tldr-pages/tldr.git `pulumi state repair` -- Edit a stack's state in the editor specified by the `EDITOR` environment variable: +- Edit a stack's state in the editor specified by the `$EDITOR` environment variable: `pulumi state edit --stack {{stack_name}}` diff --git a/tldr/pyenv b/tldr/pyenv index 5989674e..464c88e0 100644 --- a/tldr/pyenv +++ b/tldr/pyenv @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Switch between multiple versions of Python easily. > See also: `asdf`. -> More information: . +> More information: . - List all available commands: diff --git a/tldr/qpdf b/tldr/qpdf index 3ddf0eaf..cd891412 100644 --- a/tldr/qpdf +++ b/tldr/qpdf @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # qpdf > Versatile PDF transformation software. -> More information: . +> More information: . - Extract pages 1-3, 5 and 6-10 from a PDF file and save them as another one: diff --git a/tldr/rbenv b/tldr/rbenv index 26b0601e..5e89dc74 100644 --- a/tldr/rbenv +++ b/tldr/rbenv @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Easily install Ruby versions and manage application environments. > See also: `asdf`. -> More information: . +> More information: . - Install a Ruby version: diff --git a/tldr/reflex b/tldr/reflex index 30f4e620..4f6040fc 100644 --- a/tldr/reflex +++ b/tldr/reflex @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # reflex > Watch a directory and rerun a command when certain files change. -> More information: . +> More information: . - Rebuild with `make` if any file changes: @@ -14,15 +14,15 @@ source: https://github.com/tldr-pages/tldr.git - Compile and run Go application if any `.go` file changes: -`reflex --regex='{{\.go$}}' {{go run .}}` +`reflex {{[-r|--regex]}} '{{\.go$}}' {{go run .}}` - Ignore a directory when watching for changes: -`reflex --inverse-regex='{{^dir/}}' {{command}}` +`reflex {{[-G|--inverse-regex]}} '{{^dir/}}' {{command}}` - Run command when reflex starts and restarts on file changes: -`reflex --start-service=true {{command}}` +`reflex {{[-s|--start-service]}} true {{command}}` - Substitute the filename that changed in: diff --git a/tldr/regex b/tldr/regex new file mode 100644 index 00000000..0998c7f1 --- /dev/null +++ b/tldr/regex @@ -0,0 +1,38 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# regex + +> Regular expressions (`regex`) are patterns used to match, search, and manipulate text. +> Not a direct command, but syntax to be used with other commands. +> More information: . + +- Match any single character: + +`.` + +- Match the start of a line: + +`^{{hello}}` + +- Match the end of a line: + +`{{world}}$` + +- Match zero or more repeated characters: + +`{{a}}*` + +- Match a set of characters: + +`[{{abc}}]` + +- Match a range of characters: + +`[{{a-z3-9}}]` + +- Match anything but the specified character: + +`[^{{a}}]` diff --git a/tldr/retry b/tldr/retry index 998028a3..2c2fbb9d 100644 --- a/tldr/retry +++ b/tldr/retry @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # retry > Repeat command until it succeeds or a criterion is met. -> More information: . +> More information: . - Retry a command until it succeeds: @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - Retry a command every n seconds until it succeeds: -`retry --delay={{n}} {{command}}` +`retry {{[-d|--delay]}} {{n}} {{command}}` - Give up after n attempts: -`retry --times={{n}} {{command}}` +`retry {{[-t|--times]}} {{n}} {{command}}` diff --git a/tldr/rscript b/tldr/rscript index 9bcebe06..71bb3fe7 100644 --- a/tldr/rscript +++ b/tldr/rscript @@ -20,6 +20,6 @@ source: https://github.com/tldr-pages/tldr.git `Rscript -e {{expression1}} -e {{expression2}}` -- Display R version: +- Display version: `Rscript --version` diff --git a/tldr/slim b/tldr/slim new file mode 100644 index 00000000..9ea4f173 --- /dev/null +++ b/tldr/slim @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# slim + +> Analyze and optimize Docker images. +> More information: . + +- Start Slim on interactive mode: + +`slim` + +- Analyze Docker layers from a specific image: + +`slim xray --target {{image:tag}}` + +- Lint a Dockerfile: + +`slim lint --target {{path/to/Dockerfile}}` + +- Analyze and generate an optimized Docker image: + +`slim build {{image:tag}}` + +- Display help for a subcommand: + +`slim {{subcommand}} --help` diff --git a/tldr/travis b/tldr/travis index 1a06ebe5..541c8387 100644 --- a/tldr/travis +++ b/tldr/travis @@ -8,10 +8,6 @@ source: https://github.com/tldr-pages/tldr.git > Interface with Travis CI. > More information: . -- Display the client version: - -`travis version` - - Authenticate the CLI client against the server, using an authentication token: `travis login` @@ -27,3 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - Generate a `.travis.yml` file and enable the project: `travis init` + +- Display version: + +`travis version` diff --git a/tldr/tre b/tldr/tre index 3a66cbf9..7f9b68c2 100644 --- a/tldr/tre +++ b/tldr/tre @@ -33,10 +33,10 @@ source: https://github.com/tldr-pages/tldr.git `tre {{[-E|--exclude]}} {{regex}}` -- Display version: - -`tre {{[-V|--version]}}` - - Display help: `tre {{[-h|--help]}}` + +- Display version: + +`tre {{[-V|--version]}}` diff --git a/tldr/tuckr b/tldr/tuckr index 71733107..79ab0148 100644 --- a/tldr/tuckr +++ b/tldr/tuckr @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Dotfile manager written in Rust. > See also: `chezmoi`, `vcsh`, `homeshick`, `stow`. -> More information: . +> More information: . - Check dotfile status: diff --git a/tldr/virsh b/tldr/virsh index f098968c..127e2187 100644 --- a/tldr/virsh +++ b/tldr/virsh @@ -25,7 +25,7 @@ source: https://github.com/tldr-pages/tldr.git `virsh create {{path/to/config_file.xml}}` -- Edit a guest's configuration file (editor can be changed with $EDITOR): +- Edit a guest's configuration file (editor can be changed with `$EDITOR`): `virsh edit {{guest_id}}` diff --git a/tldr/visudo b/tldr/visudo index e290ffd8..cae6b33d 100644 --- a/tldr/visudo +++ b/tldr/visudo @@ -20,6 +20,6 @@ source: https://github.com/tldr-pages/tldr.git `sudo EDITOR={{editor}} visudo` -- Display version information: +- Display version: `visudo {{[-V|--version]}}` diff --git a/tldr/whence b/tldr/whence index 9f8b3058..2983916d 100644 --- a/tldr/whence +++ b/tldr/whence @@ -24,6 +24,6 @@ source: https://github.com/tldr-pages/tldr.git `whence -ca "{{command}}"` -- Search only the `PATH` for `command`, ignoring builtins, aliases or shell functions (equivalent to the `where` command): +- Search only the `$PATH` for `command`, ignoring builtins, aliases or shell functions (equivalent to the `where` command): `whence -p "{{command}}"` diff --git a/tldr/where b/tldr/where index 90722cd7..a760bf47 100644 --- a/tldr/where +++ b/tldr/where @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # where > Reports all known instances of a command. -> It could be an executable in the PATH environment variable, an alias, or a shell builtin. +> It could be an executable in the `$PATH` environment variable, an alias, or a shell builtin. > More information: . - Find all instances of a command: diff --git a/tldr/which b/tldr/which index f28d41d2..c041841f 100644 --- a/tldr/which +++ b/tldr/which @@ -9,7 +9,7 @@ source: https://github.com/tldr-pages/tldr.git > See also: `whereis`, `whatis`, `type`. > More information: . -- Search the PATH environment variable and display the location of any matching executables: +- Search the `$PATH` environment variable and display the location of any matching executables: `which {{executable}}` diff --git a/tldr/windows/scb b/tldr/windows/scb index 308673f8..6c522595 100644 --- a/tldr/windows/scb +++ b/tldr/windows/scb @@ -7,6 +7,6 @@ source: https://github.com/tldr-pages/tldr.git > This command is an alias of `Set-Clipboard`. -- View documentation: +- View documentation for the original command: `tldr Set-Clipboard` diff --git a/tldr/xzmore b/tldr/xzmore index 4abe93f3..4b468116 100644 --- a/tldr/xzmore +++ b/tldr/xzmore @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # xzmore > Display text from `xz` or `lzma` compressed files. -> Almost equivalent to `xzless`, except it respects the `PAGER` environment variable, uses `more` by default and you cannot pass options to the pager. +> Almost equivalent to `xzless`, except it respects the `$PAGER` environment variable, uses `more` by default and you cannot pass options to the pager. > More information: . - View a compressed file: