From 94c28849c9970d738df6458f1736faae26f58b1e Mon Sep 17 00:00:00 2001 From: ivuorinen Date: Wed, 23 Apr 2025 00:19:06 +0000 Subject: [PATCH] Update cheatsheets --- tldr/a2ping | 2 +- tldr/acme.sh | 14 +++++++------- tldr/agate | 2 +- tldr/ansible-doc | 10 +++++----- tldr/ansible-inventory | 4 ++-- tldr/ansible-pull | 8 ++++---- tldr/asciidoctor | 6 +++--- tldr/brew-bundle | 2 +- tldr/cbonsai | 10 +++++----- tldr/charm | 2 +- tldr/cheat | 8 ++++---- tldr/chkfont | 18 ++++++++++++++++++ tldr/circup | 4 ++-- tldr/clamscan | 8 ++++---- tldr/clj | 6 +++--- tldr/conda | 10 +++++----- tldr/conda-create | 6 +++--- tldr/conda-install | 8 ++++---- tldr/core-validate-commit | 8 ++++---- tldr/cowsay | 2 +- tldr/crunch | 2 +- tldr/csvcut | 8 ++++---- tldr/csvformat | 10 +++++----- tldr/csvgrep | 6 +++--- tldr/csvkit | 10 +++++----- tldr/csvsort | 8 ++++---- tldr/csvstat | 6 +++--- tldr/ctest | 8 ++++---- tldr/daps | 8 ++++---- tldr/ddgr | 6 +++--- tldr/deluge | 6 +++--- tldr/deluged | 8 ++++---- tldr/detox | 4 ++-- tldr/dexdump | 2 +- tldr/dexter | 4 ++-- tldr/dhcpig | 12 ++++++------ tldr/dict | 8 ++++---- tldr/docker-build | 8 ++++---- tldr/docker-commit | 10 +++++----- tldr/docker-compose | 10 +++++----- tldr/docker-cp | 2 +- tldr/docker-image | 2 +- tldr/docker-images | 2 +- tldr/docker-inspect | 10 +++++----- tldr/docker-load | 4 ++-- tldr/docker-login | 6 +++--- tldr/docker-network | 2 +- tldr/docker-rmi | 2 +- tldr/docker-save | 6 +++--- tldr/docker-stats | 2 +- tldr/docker-system | 4 ++-- tldr/docker-volume | 2 +- tldr/dolt-add | 2 +- tldr/dolt-branch | 8 ++++---- tldr/dolt-clone | 4 ++-- tldr/dolt-commit | 6 +++--- tldr/dolt-gc | 2 +- tldr/dolt-init | 2 +- tldr/dolt-merge | 2 +- tldr/dolt-sql | 4 ++-- tldr/dotnet-add-package | 6 +++--- tldr/dotnet-build | 8 ++++---- tldr/dotnet-publish | 10 +++++----- tldr/dotnet-restore | 2 +- tldr/dotnet-run | 4 ++-- tldr/dotnet-tool | 10 +++++----- tldr/dub | 4 ++-- tldr/dumpcap | 8 ++++---- tldr/duplicacy | 2 +- tldr/egrep | 6 +++--- tldr/electrum | 8 ++++---- tldr/elixir | 2 +- tldr/enca | 6 +++--- tldr/entr | 2 +- tldr/eslint | 2 +- tldr/exiftool | 4 ++-- tldr/exiv2 | 10 +++++----- tldr/faker | 12 ++++++------ tldr/fastd | 10 +++++----- tldr/fc-cache | 4 ++-- tldr/fc-list | 2 +- tldr/fc-match | 2 +- tldr/fc-pattern | 4 ++-- tldr/fdupes | 10 +++++----- tldr/ffe | 12 ++++++------ tldr/ffprobe | 10 +++++----- tldr/fiascotopnm | 10 +++++----- tldr/fin | 2 +- tldr/flac | 6 +++--- tldr/fly | 14 +++++++------- tldr/fswatch | 8 ++++---- tldr/fswebcam | 4 ++-- tldr/gdrive | 2 +- tldr/gendesk | 4 ++-- tldr/git | 4 ++-- tldr/git-checkout | 2 +- tldr/git-force-clone | 4 ++-- tldr/git-guilt | 6 +++--- tldr/git-sed | 2 +- tldr/git-show | 2 +- tldr/git-standup | 2 +- tldr/git-subtree | 12 ++++++------ tldr/git-symbolic-ref | 4 ++-- tldr/git-sync | 4 ++-- tldr/glab-repo | 6 +++--- tldr/glow | 2 +- tldr/gnmic | 10 +++++----- tldr/gnmic-get | 8 ++++---- tldr/gnmic-set | 8 ++++---- tldr/gnmic-subscribe | 10 +++++----- tldr/godot | 6 +++--- tldr/googler | 10 +++++----- tldr/goreload | 2 +- tldr/gotty | 4 ++-- tldr/gource | 20 ++++++++++++++------ tldr/gradle | 2 +- tldr/grex | 10 +++++----- tldr/hexyl | 2 +- tldr/hive | 2 +- tldr/hledger | 12 ++++++------ tldr/hledger-accounts | 14 +++++++------- tldr/hledger-add | 4 ++-- tldr/hledger-aregister | 8 ++++---- tldr/hledger-balance | 8 ++++---- tldr/hledger-balancesheet | 12 ++++++------ tldr/hledger-import | 4 ++-- tldr/hledger-incomestatement | 6 +++--- tldr/hledger-print | 8 ++++---- tldr/hledger-ui | 8 ++++---- tldr/hledger-web | 4 ++-- tldr/http-server | 6 +++--- tldr/hyperfine | 8 ++++---- tldr/iconv | 6 +++--- tldr/impacket-ping | 12 ++++++++++++ tldr/impacket-ping6 | 12 ++++++++++++ tldr/in-toto-record | 4 ++-- tldr/in-toto-run | 8 ++++---- tldr/in-toto-sign | 10 +++++----- tldr/in2csv | 2 +- tldr/inkscape | 14 +++++++------- tldr/interdiff | 2 +- tldr/ioping | 6 +++--- tldr/ipcalc | 29 +++++++++++++++++++++++++++++ tldr/ippfind | 8 ++++---- tldr/irssi | 6 +++--- tldr/jc | 4 ++-- tldr/jhat | 2 +- tldr/jmtpfs | 2 +- tldr/jq | 2 +- tldr/jtbl | 4 ++-- tldr/julia | 8 ++++---- tldr/just.1 | 4 ++-- tldr/jwt | 6 +++--- tldr/k6 | 6 +++--- tldr/k8s-unused-secret-detector | 4 ++-- tldr/k8sec | 4 ++-- tldr/kaggle | 2 +- tldr/kismet | 2 +- tldr/kompose | 6 +++--- tldr/kops | 8 ++++---- tldr/kube-capacity | 4 ++-- tldr/kubectl | 2 +- tldr/kubectl-apply | 8 ++++---- tldr/kubectl-create | 4 ++-- tldr/kubectl-delete | 2 +- tldr/kubectl-edit | 2 +- tldr/kubectl-expose | 2 +- tldr/kubectl-label | 2 +- tldr/kubectl-logs | 4 ++-- tldr/kubectl-replace | 6 +++--- tldr/kubectl-scale | 2 +- tldr/kubectx | 2 +- tldr/kubetail | 4 ++-- tldr/kustomize | 2 +- tldr/ldapsearch | 16 ++++++++-------- tldr/lilypond | 8 ++++---- tldr/linux/fuzzel | 2 +- tldr/linux/virt-viewer | 2 +- tldr/linux/virt-xml | 4 ++-- tldr/loc | 2 +- tldr/lolcat | 4 ++-- tldr/lsd | 16 ++++++++-------- tldr/lychee | 2 +- tldr/lz4 | 8 ++++---- tldr/lzop | 10 +++++++++- tldr/mailx | 12 ++++++------ tldr/mc | 2 +- tldr/minifab | 10 +++++----- tldr/mitmdump | 6 +++--- tldr/mktorrent | 10 +++++----- tldr/mlr | 4 ++-- tldr/mmv | 4 ++-- tldr/monop | 6 +++--- tldr/mosquitto_pub | 12 ++++++------ tldr/mosquitto_sub | 6 +++--- tldr/mpg321 | 10 +++++----- tldr/mr | 2 +- tldr/msedge | 4 ++-- tldr/msfvenom | 14 +++++++------- tldr/multipass | 2 +- tldr/mysql | 12 ++++++------ tldr/mysqlbinlog | 2 +- tldr/mysqlcheck | 2 +- tldr/mysqlsh | 2 +- tldr/mytop | 6 +++--- tldr/naabu | 12 ++++++------ tldr/newsboat | 6 +++--- tldr/nikto | 10 +++++----- tldr/nim | 8 ++++---- tldr/nimble | 2 +- tldr/nix | 2 +- tldr/nix-classic | 8 ++++---- tldr/nix-env | 16 ++++++++-------- tldr/nix-shell | 6 +++--- tldr/nix-store | 6 +++--- tldr/node | 4 ++-- tldr/noti | 2 +- tldr/npm-access | 4 ++-- tldr/npm-adduser | 8 ++++---- tldr/npm-audit | 2 +- tldr/npm-check | 6 +++--- tldr/npm-ci | 2 +- tldr/npm-dedupe | 4 ++-- tldr/npm-find-dupes | 10 +++++----- tldr/npm-fund | 4 ++-- tldr/npm-home | 6 +++--- tldr/npm-init | 2 +- tldr/npm-login | 4 ++-- tldr/npm-logout | 2 +- tldr/npm-ls | 6 +++--- tldr/npm-outdated | 2 +- tldr/npm-query | 4 ++-- tldr/npm-root | 2 +- tldr/npm-uninstall | 2 +- tldr/npm-unpublish | 2 +- tldr/npm-update | 2 +- tldr/npm-version | 2 +- tldr/nth | 8 ++++---- tldr/nxc | 2 +- tldr/objdump | 10 +++++----- tldr/olevba | 6 +++--- tldr/onionsearch | 2 +- tldr/open | 2 +- tldr/openscad | 2 +- tldr/openttd | 2 +- tldr/optipng | 4 ++-- tldr/p7zip | 8 ++++---- tldr/parallel | 6 +++--- tldr/pass | 6 +++--- tldr/patch | 6 +++--- tldr/pathchk | 2 +- tldr/peerindex | 2 +- tldr/pg_ctl | 10 +++++----- tldr/pg_dump | 10 +++++----- tldr/pg_isready | 4 ++-- tldr/pg_restore | 12 ++++++------ tldr/phing | 6 +++--- tldr/phpspec | 4 ++-- tldr/pigz | 8 ++++---- tldr/ping.py | 18 ++++++++++++++++++ tldr/ping6.py | 18 ++++++++++++++++++ tldr/pip | 4 ++-- tldr/pip-freeze | 2 +- tldr/pip-install | 6 +++--- tldr/pip-uninstall | 4 ++-- tldr/pip3 | 4 ++-- tldr/pnmtofiasco | 2 +- tldr/podman-compose | 6 +++--- tldr/popeye | 6 +++--- tldr/powershell | 2 +- tldr/progress | 6 +++--- tldr/proxify | 4 ++-- tldr/psql | 8 ++++---- tldr/pssh | 12 ++++++------ tldr/pt | 6 +++--- tldr/ptpython | 2 +- tldr/pueue | 4 ++-- tldr/pueue-add | 8 ++++---- tldr/pueue-clean | 2 +- tldr/pueue-enqueue | 10 +++++----- tldr/pueue-group | 4 ++-- tldr/pueue-kill | 4 ++-- tldr/pueue-log | 2 +- tldr/pueue-parallel | 2 +- tldr/pueue-pause | 4 ++-- tldr/pueue-reset | 2 +- tldr/pueue-restart | 8 ++++---- tldr/pueue-start | 2 +- tldr/pueue-status | 2 +- tldr/pushd | 2 +- tldr/pv | 10 +++++----- tldr/py-spy | 6 +++--- tldr/q | 8 ++++---- tldr/qrencode | 10 +++++----- tldr/quilt | 2 +- tldr/quota | 10 +++++----- tldr/r | 6 +++--- tldr/rails | 4 ++-- tldr/rails-console | 6 +++--- tldr/rails-new | 6 +++--- tldr/rails-routes | 4 ++-- tldr/rails-server | 8 ++++---- tldr/rapper | 4 ++-- tldr/rbac-lookup | 4 ++-- tldr/rclone | 6 +++--- tldr/route | 2 +- tldr/rss2email | 2 +- tldr/rsstail | 2 +- tldr/rtmpdump | 8 ++++---- tldr/rustc | 4 ++-- tldr/salt-call | 2 +- tldr/salt-key | 8 ++++---- tldr/samtools | 6 +++--- tldr/scc | 8 ++++---- tldr/sd | 2 +- tldr/sdiff | 8 ++++---- tldr/serverless | 2 +- tldr/shred | 2 +- tldr/skaffold | 10 +++++----- tldr/sonar-scanner | 6 +++--- tldr/sort | 2 +- tldr/sox | 8 ++++---- tldr/sphinx-build | 4 ++-- tldr/sponge | 2 +- tldr/sqlite-utils | 2 +- tldr/sqlmap | 10 +++++----- tldr/srm | 6 +++--- tldr/st-util | 2 +- tldr/strings | 6 +++--- tldr/subliminal | 2 +- tldr/supervisord | 4 ++-- tldr/svgo | 10 +++++----- tldr/swagger-codegen | 4 ++-- tldr/tcpreplay | 10 +++++----- tldr/tee | 2 +- tldr/telnet | 2 +- tldr/tokei | 6 +++--- tldr/topgrade | 4 ++-- tldr/tox | 4 ++-- tldr/tqdm | 4 ++-- tldr/traceroute | 6 +++--- tldr/trans | 4 ++-- tldr/transmission-cli | 14 +++++++------- tldr/transmission-create | 14 +++++++------- tldr/transmission-daemon | 6 +++--- tldr/transmission-edit | 10 +++++++--- tldr/transmission-remote | 16 ++++++++-------- tldr/transmission-show | 4 ++-- tldr/trivy | 4 ++-- tldr/tspin | 4 ++-- tldr/tuc | 10 +++++----- tldr/twm | 10 +++++----- tldr/twurl | 10 +++++----- tldr/ulimit | 2 +- tldr/unar | 8 ++++---- tldr/uuencode | 2 +- tldr/vinmap | 10 +++++----- tldr/visudo | 4 ++-- tldr/viu | 8 ++++---- tldr/wafw00f | 2 +- tldr/wakeonlan | 6 +++--- tldr/wasm-objdump | 8 ++++---- tldr/wasm-opt | 6 +++--- tldr/wasm2c | 2 +- tldr/wasm2wat | 2 +- tldr/wat2wasm | 4 ++-- tldr/watchexec | 8 ++++---- tldr/waymore | 8 ++++---- tldr/webstorm | 2 +- tldr/whatweb | 10 +++++----- tldr/which | 2 +- tldr/wondershaper | 8 ++++---- tldr/wrk | 6 +++--- tldr/x_x | 4 ++-- tldr/xkcdpass | 4 ++-- tldr/xmake | 10 +++++----- tldr/xxd | 10 +++++----- tldr/ya | 4 ++-- tldr/youtube-dl | 12 ++++++------ tldr/yt-dlp | 14 +++++++------- tldr/zipgrep | 6 +++--- tldr/zmap | 6 +++--- 382 files changed, 1183 insertions(+), 1056 deletions(-) create mode 100644 tldr/chkfont create mode 100644 tldr/impacket-ping create mode 100644 tldr/impacket-ping6 create mode 100644 tldr/ipcalc create mode 100644 tldr/ping.py create mode 100644 tldr/ping6.py diff --git a/tldr/a2ping b/tldr/a2ping index 9c05226a..40490fd0 100644 --- a/tldr/a2ping +++ b/tldr/a2ping @@ -34,4 +34,4 @@ source: https://github.com/tldr-pages/tldr.git - Display help: -`a2ping -h` +`a2ping {{[-h|--help]}}` diff --git a/tldr/acme.sh b/tldr/acme.sh index 9938c4f4..78c1a4fc 100644 --- a/tldr/acme.sh +++ b/tldr/acme.sh @@ -11,28 +11,28 @@ source: https://github.com/tldr-pages/tldr.git - Issue a certificate using webroot mode: -`acme.sh --issue --domain {{example.com}} --webroot {{/path/to/webroot}}` +`acme.sh --issue {{[-d|--domain]}} {{example.com}} {{[-w|--webroot]}} {{/path/to/webroot}}` - Issue a certificate for multiple domains using standalone mode using port 80: -`acme.sh --issue --standalone --domain {{example.com}} --domain {{www.example.com}}` +`acme.sh --issue --standalone {{[-d|--domain]}} {{example.com}} {{[-d|--domain]}} {{www.example.com}}` - Issue a certificate using standalone TLS mode using port 443: -`acme.sh --issue --alpn --domain {{example.com}}` +`acme.sh --issue --alpn {{[-d|--domain]}} {{example.com}}` - Issue a certificate using a working Nginx configuration: -`acme.sh --issue --nginx --domain {{example.com}}` +`acme.sh --issue --nginx {{[-d|--domain]}} {{example.com}}` - Issue a certificate using a working Apache configuration: -`acme.sh --issue --apache --domain {{example.com}}` +`acme.sh --issue --apache {{[-d|--domain]}} {{example.com}}` - Issue a wildcard (\*) certificate using an automatic DNS API mode: -`acme.sh --issue --dns {{dns_cf}} --domain {{*.example.com}}` +`acme.sh --issue --dns {{dns_cf}} {{[-d|--domain]}} {{*.example.com}}` - Install certificate files into the specified locations (useful for automatic certificate renewal): -`acme.sh --install-cert -d {{example.com}} --key-file {{/path/to/example.com.key}} --fullchain-file {{/path/to/example.com.cer}} --reloadcmd "{{systemctl force-reload nginx}}"` +`acme.sh {{[-i|--install-cert]}} {{[-d|--domain]}} {{example.com}} --key-file {{/path/to/example.com.key}} --fullchain-file {{/path/to/example.com.cer}} --reloadcmd "{{systemctl force-reload nginx}}"` diff --git a/tldr/agate b/tldr/agate index bee909c8..ff06fb39 100644 --- a/tldr/agate +++ b/tldr/agate @@ -18,4 +18,4 @@ source: https://github.com/tldr-pages/tldr.git - Display help: -`agate -h` +`agate {{[-h|--help]}}` diff --git a/tldr/ansible-doc b/tldr/ansible-doc index 41bf1060..8b8b1b58 100644 --- a/tldr/ansible-doc +++ b/tldr/ansible-doc @@ -11,11 +11,11 @@ source: https://github.com/tldr-pages/tldr.git - List available action plugins (modules): -`ansible-doc --list` +`ansible-doc {{[-l|--list]}}` - List available plugins of a specific type: -`ansible-doc --type {{become|cache|callback|cliconf|connection|...}} --list` +`ansible-doc {{[-t|--type]}} {{become|cache|callback|cliconf|connection|...}} {{[-l|--list]}}` - Show information about a specific action plugin (module): @@ -23,12 +23,12 @@ source: https://github.com/tldr-pages/tldr.git - Show information about a plugin with a specific type: -`ansible-doc --type {{become|cache|callback|cliconf|connection|...}} {{plugin_name}}` +`ansible-doc {{[-t|--type]}} {{become|cache|callback|cliconf|connection|...}} {{plugin_name}}` - Show the playbook snippet for action plugin (modules): -`ansible-doc --snippet {{plugin_name}}` +`ansible-doc {{[-s|--snippet]}} {{plugin_name}}` - Show information about an action plugin (module) as JSON: -`ansible-doc --json {{plugin_name}}` +`ansible-doc {{[-j|--json]}} {{plugin_name}}` diff --git a/tldr/ansible-inventory b/tldr/ansible-inventory index 15e9817e..0f733289 100644 --- a/tldr/ansible-inventory +++ b/tldr/ansible-inventory @@ -15,11 +15,11 @@ source: https://github.com/tldr-pages/tldr.git - Display a custom inventory: -`ansible-inventory --list --inventory {{path/to/file_or_script_or_directory}}` +`ansible-inventory --list {{[-i|--inventory-file]}} {{path/to/file_or_script_or_directory}}` - Display the default inventory in YAML: -`ansible-inventory --list --yaml` +`ansible-inventory --list {{[-y|--yaml]}}` - Dump the default inventory to a file: diff --git a/tldr/ansible-pull b/tldr/ansible-pull index da6bc27f..29b8f4fd 100644 --- a/tldr/ansible-pull +++ b/tldr/ansible-pull @@ -10,16 +10,16 @@ source: https://github.com/tldr-pages/tldr.git - Pull a playbook from a VCS and execute a default local.yml playbook: -`ansible-pull -U {{repository_url}}` +`ansible-pull {{[-U|--url]}} {{repository_url}}` - Pull a playbook from a VCS and execute a specific playbook: -`ansible-pull -U {{repository_url}} {{playbook}}` +`ansible-pull {{[-U|--url]}} {{repository_url}} {{playbook}}` - Pull a playbook from a VCS at a specific branch and execute a specific playbook: -`ansible-pull -U {{repository_url}} -C {{branch}} {{playbook}}` +`ansible-pull {{[-U|--url]}} {{repository_url}} {{[-C|--checkout]}} {{branch}} {{playbook}}` - Pull a playbook from a VCS, specify hosts file and execute a specific playbook: -`ansible-pull -U {{repository_url}} -i {{hosts_file}} {{playbook}}` +`ansible-pull {{[-U|--url]}} {{repository_url}} {{[-i|--inventory-file]}} {{hosts_file}} {{playbook}}` diff --git a/tldr/asciidoctor b/tldr/asciidoctor index 7e80ee59..f95903c8 100644 --- a/tldr/asciidoctor +++ b/tldr/asciidoctor @@ -14,12 +14,12 @@ source: https://github.com/tldr-pages/tldr.git - Convert a specific `.adoc` file to HTML and link a CSS stylesheet: -`asciidoctor -a stylesheet {{path/to/stylesheet.css}} {{path/to/file.adoc}}` +`asciidoctor {{[-a|--attribute]}} stylesheet {{path/to/stylesheet.css}} {{path/to/file.adoc}}` - Convert a specific `.adoc` file to embeddable HTML, removing everything except the body: -`asciidoctor --embedded {{path/to/file.adoc}}` +`asciidoctor {{[-e|--embedded]}} {{path/to/file.adoc}}` - Convert a specific `.adoc` file to a PDF using the `asciidoctor-pdf` library: -`asciidoctor --backend {{pdf}} --require {{asciidoctor-pdf}} {{path/to/file.adoc}}` +`asciidoctor {{[-b|--backend]}} {{pdf}} {{[-r|--require ]}}{{asciidoctor-pdf}} {{path/to/file.adoc}}` diff --git a/tldr/brew-bundle b/tldr/brew-bundle index 2ef859b7..e1b698cb 100644 --- a/tldr/brew-bundle +++ b/tldr/brew-bundle @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # brew bundle > Bundler for Homebrew, Homebrew Cask and the Mac App Store. -> More information: . +> More information: . - Install packages from a Brewfile at the current path: diff --git a/tldr/cbonsai b/tldr/cbonsai index 083083a4..44480d28 100644 --- a/tldr/cbonsai +++ b/tldr/cbonsai @@ -10,20 +10,20 @@ source: https://github.com/tldr-pages/tldr.git - Generate a bonsai in live mode: -`cbonsai -l` +`cbonsai {{[-l|--live]}}` - Generate a bonsai in infinite mode: -`cbonsai -i` +`cbonsai {{[-i|--infinite]}}` - Append a message to the bonsai: -`cbonsai -m "{{message}}"` +`cbonsai {{[-m|--message]}} "{{message}}"` - Display extra information about the bonsai: -`cbonsai -v` +`cbonsai {{[-v|--verbose]}}` - Display help: -`cbonsai -h` +`cbonsai {{[-h|--help]}}` diff --git a/tldr/charm b/tldr/charm index 3d2da76f..0c2f7cbb 100644 --- a/tldr/charm +++ b/tldr/charm @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Backup Charm account keys to a specific location: -`charm backup-keys -o {{path/to/output_file.tar}}` +`charm backup-keys {{[-o|--output]}} {{path/to/output_file.tar}}` - Import previously backed up Charm account keys: diff --git a/tldr/cheat b/tldr/cheat index 36b41338..1c464ad0 100644 --- a/tldr/cheat +++ b/tldr/cheat @@ -14,16 +14,16 @@ source: https://github.com/tldr-pages/tldr.git - Edit the cheat sheet for a command: -`cheat -e {{command}}` +`cheat {{[-e|--edit]}} {{command}}` - List the available cheat sheets: -`cheat -l` +`cheat {{[-l|--list]}}` - Search available the cheat sheets for a specified command name: -`cheat -s {{command}}` +`cheat {{[-s|--search]}} {{command}}` - Display version: -`cheat -v` +`cheat {{[-v|--version]}}` diff --git a/tldr/chkfont b/tldr/chkfont new file mode 100644 index 00000000..2764eeb1 --- /dev/null +++ b/tldr/chkfont @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# chkfont + +> Verify the format of a FIGlet font file (`.flf`). +> See also: `figlet`, `figlist`, `showfigfonts`. +> More information: . + +- Check a font file for formatting errors: + +`chkfont {{path/to/font.flf}}` + +- Check all `.flf` font files in a directory: + +`chkfont {{path/to/fonts}}/*.flf` diff --git a/tldr/circup b/tldr/circup index 34243fa7..94752f76 100644 --- a/tldr/circup +++ b/tldr/circup @@ -24,6 +24,6 @@ source: https://github.com/tldr-pages/tldr.git `circup freeze` -- Save all libraries on a connected device in the current directory: +- Save all libraries on a connected device in `requirements.txt` in current directory: -`circup freeze -r` +`circup freeze {{[-r|--requirement]}}` diff --git a/tldr/clamscan b/tldr/clamscan index 36afb329..3293aede 100644 --- a/tldr/clamscan +++ b/tldr/clamscan @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Scan all files recursively in a specific directory: -`clamscan -r {{path/to/directory}}` +`clamscan {{[-r|--recursive]}} {{path/to/directory}}` - Scan data from `stdin`: @@ -22,15 +22,15 @@ source: https://github.com/tldr-pages/tldr.git - Specify a virus database file or directory of files: -`clamscan --database {{path/to/database_file_or_directory}}` +`clamscan {{[-d|--database]}} {{path/to/database_file_or_directory}}` - Scan the current directory and output only infected files: -`clamscan --infected` +`clamscan {{[-i|--infected]}}` - Print the scan report to a log file: -`clamscan --log {{path/to/log_file}}` +`clamscan {{[-l|--log]}} {{path/to/log_file}}` - Move infected files to a specific directory: diff --git a/tldr/clj b/tldr/clj index d4ce9055..b9d4c049 100644 --- a/tldr/clj +++ b/tldr/clj @@ -19,7 +19,7 @@ source: https://github.com/tldr-pages/tldr.git - Run the main function of a specified namespace: -`clj -M -m {{namespace}} {{args}}` +`clj -M {{[-m|--main]}} {{namespace}} {{args}}` - Prepare a project by resolving dependencies, downloading libraries, and making/caching classpaths: @@ -27,8 +27,8 @@ source: https://github.com/tldr-pages/tldr.git - Start an nREPL server with the CIDER middleware: -`clj -Sdeps '{:deps {nrepl {:mvn/version "0.7.0"} cider/cider-nrepl {:mvn/version "0.25.2"}}}' -m nrepl.cmdline --middleware '["cider.nrepl/cider-middleware"]' --interactive` +`clj -Sdeps '{:deps {nrepl {:mvn/version "0.7.0"} cider/cider-nrepl {:mvn/version "0.25.2"}}}' {{[-m|--main]}} nrepl.cmdline --middleware '["cider.nrepl/cider-middleware"]' --interactive` - Start a REPL for ClojureScript and open a web browser: -`clj -Sdeps '{:deps {org.clojure/clojurescript {:mvn/version "1.10.758"}}}' --main cljs.main --repl` +`clj -Sdeps '{:deps {org.clojure/clojurescript {:mvn/version "1.10.758"}}}' {{[-m|--main]}} cljs.main {{[-r|--repl]}}` diff --git a/tldr/conda b/tldr/conda index 818130a2..1d214e1e 100644 --- a/tldr/conda +++ b/tldr/conda @@ -7,15 +7,15 @@ source: https://github.com/tldr-pages/tldr.git > Package, dependency and environment management for any programming language. > Some subcommands such as `create` have their own usage documentation. -> More information: . +> More information: . - Create a new environment, installing named packages into it: -`conda create --name {{environment_name}} {{python=3.9 matplotlib}}` +`conda create {{[-n|--name]}} {{environment_name}} {{python=3.9 matplotlib}}` - List all environments: -`conda info --envs` +`conda info {{[-e|--envs]}}` - Load an environment: @@ -27,7 +27,7 @@ source: https://github.com/tldr-pages/tldr.git - Delete an environment (remove all packages): -`conda remove --name {{environment_name}} --all` +`conda remove {{[-n|--name]}} {{environment_name}} --all` - Install packages into the current environment: @@ -39,4 +39,4 @@ source: https://github.com/tldr-pages/tldr.git - Delete unused packages and caches: -`conda clean --all` +`conda clean {{[-a|--all]}}` diff --git a/tldr/conda-create b/tldr/conda-create index 453e39af..aa7c540d 100644 --- a/tldr/conda-create +++ b/tldr/conda-create @@ -10,12 +10,12 @@ source: https://github.com/tldr-pages/tldr.git - Create a new environment named `py39`, and install Python 3.9 and NumPy v1.11 or above in it: -`conda create --yes --name {{py39}} python={{3.9}} "{{numpy>=1.11}}"` +`conda create {{[-y|--yes]}} {{[-n|--name]}} {{py39}} python={{3.9}} "{{numpy>=1.11}}"` - Make exact copy of an environment: -`conda create --clone {{py39}} --name {{py39-copy}}` +`conda create --clone {{py39}} {{[-n|--name]}} {{py39-copy}}` - Create a new environment with a specified name and install a given package: -`conda create --name {{env_name}} {{package}}` +`conda create {{[-n|--name]}} {{env_name}} {{package}}` diff --git a/tldr/conda-install b/tldr/conda-install index 7630025e..01b7caa7 100644 --- a/tldr/conda-install +++ b/tldr/conda-install @@ -14,11 +14,11 @@ source: https://github.com/tldr-pages/tldr.git - Install a single package into the currently active conda environment using channel conda-forge: -`conda install -c conda-forge {{package}}` +`conda install {{[-c|--channel]}} conda-forge {{package}}` - Install a single package into the currently active conda environment using channel conda-forge and ignoring other channels: -`conda install -c conda-forge --override-channels {{package}}` +`conda install {{[-c|--channel]}} conda-forge --override-channels {{package}}` - Install a specific version of a package: @@ -26,7 +26,7 @@ source: https://github.com/tldr-pages/tldr.git - Install a package into a specific environment: -`conda install --name {{environment}} {{package}}` +`conda install {{[-n|--name]}} {{environment}} {{package}}` - Update a package in the current environment: @@ -34,4 +34,4 @@ source: https://github.com/tldr-pages/tldr.git - Install a package and agree to the transactions without prompting: -`conda install --yes {{package}}` +`conda install {{[-y|--yes]}} {{package}}` diff --git a/tldr/core-validate-commit b/tldr/core-validate-commit index 60a7f3a4..ff2b2867 100644 --- a/tldr/core-validate-commit +++ b/tldr/core-validate-commit @@ -22,16 +22,16 @@ source: https://github.com/tldr-pages/tldr.git - List all validation rules: -`core-validate-commit --list` +`core-validate-commit {{[-l|--list]}}` - List all valid Node.js subsystems: -`core-validate-commit --list-subsystem` +`core-validate-commit {{[-ls|--list-subsystem]}}` - Validate the current commit formatting the output in tap format: -`core-validate-commit --tap` +`core-validate-commit {{[-t|--tap]}}` - Display help: -`core-validate-commit --help` +`core-validate-commit {{[-h|--help]}}` diff --git a/tldr/cowsay b/tldr/cowsay index 7ad054c1..6040b9e9 100644 --- a/tldr/cowsay +++ b/tldr/cowsay @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # cowsay > Print ASCII art (by default a cow) saying or thinking something. -> More information: . +> More information: . - Print an ASCII cow saying "hello, world": diff --git a/tldr/crunch b/tldr/crunch index a9e34fed..db95fd37 100644 --- a/tldr/crunch +++ b/tldr/crunch @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # crunch > Wordlist generator. -> More information: . +> More information: . - Output a list of words of length 1 to 3 with only lowercase characters: diff --git a/tldr/csvcut b/tldr/csvcut index 770d8fd8..43b51bc5 100644 --- a/tldr/csvcut +++ b/tldr/csvcut @@ -11,16 +11,16 @@ source: https://github.com/tldr-pages/tldr.git - Print indices and names of all columns: -`csvcut -n {{data.csv}}` +`csvcut {{[-n|--names]}} {{data.csv}}` - Extract the first and third columns: -`csvcut -c {{1,3}} {{data.csv}}` +`csvcut {{[-c|--columns]}} {{1,3}} {{data.csv}}` - Extract all columns except the fourth one: -`csvcut -C {{4}} {{data.csv}}` +`csvcut {{[-C|--not-columns]}} {{4}} {{data.csv}}` - Extract the columns named "id" and "first name" (in that order): -`csvcut -c {{id,"first name"}} {{data.csv}}` +`csvcut {{[-c|--columns]}} {{id,"first name"}} {{data.csv}}` diff --git a/tldr/csvformat b/tldr/csvformat index e5f984ea..cae7aca2 100644 --- a/tldr/csvformat +++ b/tldr/csvformat @@ -11,21 +11,21 @@ source: https://github.com/tldr-pages/tldr.git - Convert to a tab-delimited file (TSV): -`csvformat -T {{data.csv}}` +`csvformat {{[-T|--out-tabs]}} {{data.csv}}` - Convert delimiters to a custom character: -`csvformat -D "{{custom_character}}" {{data.csv}}` +`csvformat {{[-D|--out-delimiter]}} "{{custom_character}}" {{data.csv}}` - Convert line endings to carriage return (^M) + line feed: -`csvformat -M "{{ +`csvformat {{[-M|--out-lineterminator]}} "{{ }}" {{data.csv}}` - Minimize use of quote characters: -`csvformat -U 0 {{data.csv}}` +`csvformat {{[-U|--out-quoting]}} 0 {{data.csv}}` - Maximize use of quote characters: -`csvformat -U 1 {{data.csv}}` +`csvformat {{[-U|--out-quoting]}} 1 {{data.csv}}` diff --git a/tldr/csvgrep b/tldr/csvgrep index 95c41ea3..4099f3b5 100644 --- a/tldr/csvgrep +++ b/tldr/csvgrep @@ -11,12 +11,12 @@ source: https://github.com/tldr-pages/tldr.git - Find rows that have a certain string in column 1: -`csvgrep -c {{1}} -m {{string_to_match}} {{data.csv}}` +`csvgrep {{[-c|--columns]}} {{1}} {{[-m|--match]}} {{string_to_match}} {{data.csv}}` - Find rows in which columns 3 or 4 match a certain regular expression: -`csvgrep -c {{3,4}} -r {{regular_expression}} {{data.csv}}` +`csvgrep {{[-c|--columns]}} {{3,4}} {{[-r|--regex]}} {{regular_expression}} {{data.csv}}` - Find rows in which the "name" column does NOT include the string "John Doe": -`csvgrep -i -c {{name}} -m "{{John Doe}}" {{data.csv}}` +`csvgrep {{[-i|--invert-match]}} {{[-c|--columns]}} {{name}} {{[-m|--match]}} "{{John Doe}}" {{data.csv}}` diff --git a/tldr/csvkit b/tldr/csvkit index 8e7c8e2f..93f8f4e8 100644 --- a/tldr/csvkit +++ b/tldr/csvkit @@ -7,20 +7,20 @@ source: https://github.com/tldr-pages/tldr.git > Manipulation toolkit for CSV files. > See also: `csvclean`, `csvcut`, `csvformat`, `csvgrep`, `csvlook`, `csvpy`, `csvsort`, `csvstat`. -> More information: . +> More information: . - Run a command on a CSV file with a custom delimiter: -`{{command}} -d {{delimiter}} {{path/to/file.csv}}` +`{{command}} {{[-d|--delimiter]}} {{delimiter}} {{path/to/file.csv}}` - Run a command on a CSV file with a tab as a delimiter (overrides -d): -`{{command}} -t {{path/to/file.csv}}` +`{{command}} {{[-t|--tabs]}} {{path/to/file.csv}}` - Run a command on a CSV file with a custom quote character: -`{{command}} -q {{quote_char}} {{path/to/file.csv}}` +`{{command}} {{[-q|--quotechar]}} {{quote_char}} {{path/to/file.csv}}` - Run a command on a CSV file with no header row: -`{{command}} -H {{path/to/file.csv}}` +`{{command}} {{[-H|--no-header-row]}} {{path/to/file.csv}}` diff --git a/tldr/csvsort b/tldr/csvsort index 082aaeba..ee4260a3 100644 --- a/tldr/csvsort +++ b/tldr/csvsort @@ -11,16 +11,16 @@ source: https://github.com/tldr-pages/tldr.git - Sort a CSV file by column 9: -`csvsort -c {{9}} {{data.csv}}` +`csvsort {{[-c|--columns]}} {{9}} {{data.csv}}` - Sort a CSV file by the "name" column in descending order: -`csvsort -r -c {{name}} {{data.csv}}` +`csvsort {{[-r|--reverse]}} {{[-c|--columns]}} {{name}} {{data.csv}}` - Sort a CSV file by column 2, then by column 4: -`csvsort -c {{2,4}} {{data.csv}}` +`csvsort {{[-c|--columns]}} {{2,4}} {{data.csv}}` - Sort a CSV file without inferring data types: -`csvsort --no-inference -c {{columns}} {{data.csv}}` +`csvsort {{[-I|--no-inference]}} {{[-c|--columns]}} {{columns}} {{data.csv}}` diff --git a/tldr/csvstat b/tldr/csvstat index 3e041d3c..0161a11a 100644 --- a/tldr/csvstat +++ b/tldr/csvstat @@ -15,7 +15,7 @@ source: https://github.com/tldr-pages/tldr.git - Show all stats for columns 2 and 4: -`csvstat -c {{2,4}} {{data.csv}}` +`csvstat {{[-c|--columns]}} {{2,4}} {{data.csv}}` - Show sums for all columns: @@ -23,8 +23,8 @@ source: https://github.com/tldr-pages/tldr.git - Show the max value length for column 3: -`csvstat -c {{3}} --len {{data.csv}}` +`csvstat {{[-c|--columns]}} {{3}} --len {{data.csv}}` - Show the number of unique values in the "name" column: -`csvstat -c {{name}} --unique {{data.csv}}` +`csvstat {{[-c|--columns]}} {{name}} --unique {{data.csv}}` diff --git a/tldr/ctest b/tldr/ctest index e5117ec3..68f9cea3 100644 --- a/tldr/ctest +++ b/tldr/ctest @@ -8,14 +8,14 @@ source: https://github.com/tldr-pages/tldr.git > CMake test driver program. > More information: . -- Run all tests defined in the CMake project, executing 4 jobs at a time in parallel: +- Run all tests defined in the CMake project, executing 4 [j]obs at a time in parallel: -`ctest -j{{4}} --output-on-failure` +`ctest {{[-j|--parallel]}} {{4}} --output-on-failure` - List available tests: -`ctest -N` +`ctest {{[-N|--show-only]}}` - Run a single test based on its name, or filter on a regular expression: -`ctest --output-on-failure -R '^{{test_name}}$'` +`ctest --output-on-failure {{[-R|--tests-regex]}} '^{{test_name}}$'` diff --git a/tldr/daps b/tldr/daps index cd6a3512..c99f72f2 100644 --- a/tldr/daps +++ b/tldr/daps @@ -10,19 +10,19 @@ source: https://github.com/tldr-pages/tldr.git - Check if a DocBook XML file is valid: -`daps -d {{path/to/file.xml}} validate` +`daps {{[-d|--docconfig]}} {{path/to/file.xml}} validate` - Convert a DocBook XML file into PDF: -`daps -d {{path/to/file.xml}} pdf` +`daps {{[-d|--docconfig]}} {{path/to/file.xml}} pdf` - Convert a DocBook XML file into a single HTML file: -`daps -d {{path/to/file.xml}} html --single` +`daps {{[-d|--docconfig]}} {{path/to/file.xml}} html --single` - Display help: -`daps --help` +`daps {{[-h|--help]}}` - Display version: diff --git a/tldr/ddgr b/tldr/ddgr index 2634c183..cd6b2818 100644 --- a/tldr/ddgr +++ b/tldr/ddgr @@ -18,11 +18,11 @@ source: https://github.com/tldr-pages/tldr.git - Limit the number of search results to `n`: -`ddgr -n {{n}} {{keyword}}` +`ddgr {{[-n|--num]}} {{n}} {{keyword}}` - Display the complete URL in search results: -`ddgr -x {{keyword}}` +`ddgr {{[-x|--expand]}} {{keyword}}` - Search DuckDuckGo for a keyword and open the first result in the browser: @@ -30,7 +30,7 @@ source: https://github.com/tldr-pages/tldr.git - Perform a website-specific search: -`ddgr -w {{site}} {{keyword}}` +`ddgr {{[-w|--site]}} {{site}} {{keyword}}` - Search for a specific file type: diff --git a/tldr/deluge b/tldr/deluge index 7919f1d0..dd47e068 100644 --- a/tldr/deluge +++ b/tldr/deluge @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # deluge > A command-line BitTorrent client. -> More information: . +> More information: . - Download a torrent: @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Download a torrent using a specific configuration file: -`deluge -c {{path/to/configuration_file}} {{url|magnet|path/to/file}}` +`deluge {{[-c|--config]}} {{path/to/configuration_file}} {{url|magnet|path/to/file}}` - Download a torrent and launch the specified user interface: @@ -22,4 +22,4 @@ source: https://github.com/tldr-pages/tldr.git - Download a torrent and output the log to a file: -`deluge -l {{path/to/log_file}} {{url|magnet|path/to/file}}` +`deluge {{[-l|--logfile]}} {{path/to/log_file}} {{url|magnet|path/to/file}}` diff --git a/tldr/deluged b/tldr/deluged index 5a2c9f68..51ceec19 100644 --- a/tldr/deluged +++ b/tldr/deluged @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # deluged > A daemon process for the Deluge BitTorrent client. -> More information: . +> More information: . - Start the Deluge daemon: @@ -14,12 +14,12 @@ source: https://github.com/tldr-pages/tldr.git - Start the Deluge daemon on a specific port: -`deluged -p {{port}}` +`deluged {{[-p|--port]}} {{port}}` - Start the Deluge daemon using a specific configuration file: -`deluged -c {{path/to/configuration_file}}` +`deluged {{[-c|--config]}} {{path/to/configuration_file}}` - Start the Deluge daemon and output the log to a file: -`deluged -l {{path/to/log_file}}` +`deluged {{[-l|--logfile]}} {{path/to/log_file}}` diff --git a/tldr/detox b/tldr/detox index 4e3f0020..ab880f82 100644 --- a/tldr/detox +++ b/tldr/detox @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Renames files to make them easier to work with. > It removes spaces and other such annoyances like duplicate underline characters. -> More information: . +> More information: . - Remove spaces and other undesirable characters from a file's name: @@ -15,7 +15,7 @@ source: https://github.com/tldr-pages/tldr.git - Show how detox would rename all the files in a directory tree: -`detox --dry-run -r {{path/to/directory}}` +`detox {{[-n|--dry-run]}} -r {{path/to/directory}}` - Remove spaces and other undesirable characters from all files in a directory tree: diff --git a/tldr/dexdump b/tldr/dexdump index d69b5760..160762cc 100644 --- a/tldr/dexdump +++ b/tldr/dexdump @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # dexdump > Display information about Android DEX files. -> More information: . +> More information: . - Extract classes and methods from an APK file: diff --git a/tldr/dexter b/tldr/dexter index dea91a46..5ff42dac 100644 --- a/tldr/dexter +++ b/tldr/dexter @@ -10,8 +10,8 @@ source: https://github.com/tldr-pages/tldr.git - Create and authenticate a user with Google OIDC: -`dexter auth -i {{client_id}} -s {{client_secret}}` +`dexter auth {{[-i|--client-id]}} {{client_id}} {{[-s|--client-secret]}} {{client_secret}}` - Override the default kube configuration file location: -`dexter auth -i {{client_id}} -s {{client_secret}} --kube-config {{sample/config}}` +`dexter auth {{[-i|--client-id]}} {{client_id}} {{[-s|--client-secret]}} {{client_secret}} {{[-k|--kube-config]}} {{sample/config}}` diff --git a/tldr/dhcpig b/tldr/dhcpig index 0f4d5cb9..1f6ebfbe 100644 --- a/tldr/dhcpig +++ b/tldr/dhcpig @@ -15,24 +15,24 @@ source: https://github.com/tldr-pages/tldr.git - Exhaust IPv6 addresses using eth1 interface: -`sudo ./pig.py -6 {{eth1}}` +`sudo ./pig.py {{[-6|--ipv6]}} {{eth1}}` - Send fuzzed/malformed data packets using the interface: -`sudo ./pig.py --fuzz {{eth1}}` +`sudo ./pig.py {{[-f|--fuzz]}} {{eth1}}` - Enable color output: -`sudo ./pig.py -c {{eth1}}` +`sudo ./pig.py {{[-c|--color]}} {{eth1}}` - Enable minimal verbosity and color output: -`sudo ./pig.py -c --verbosity=1 {{eth1}}` +`sudo ./pig.py {{[-c|--color]}} {{[-v|--verbosity]}} 1 {{eth1}}` - Use a debug verbosity of 100 and scan network of neighboring devices using ARP packets: -`sudo ./pig.py -c --verbosity=100 --neighbors-scan-arp {{eth1}}` +`sudo ./pig.py {{[-c|--color]}} {{[-v|--verbosity]}} 100 {{[-n|--neighbors-scan-arp]}} {{eth1}}` - Enable printing lease information, attempt to scan and release all neighbor IP addresses: -`sudo ./pig.py --neighbors-scan-arp -r --show-options {{eth1}}` +`sudo ./pig.py {{[-n|--neighbors-scan-arp]}} {{[-r|--neighbors-attack-release]}} {{[-o|--show-options]}} {{eth1}}` diff --git a/tldr/dict b/tldr/dict index bc842c1e..eb9ec8e9 100644 --- a/tldr/dict +++ b/tldr/dict @@ -10,15 +10,15 @@ source: https://github.com/tldr-pages/tldr.git - List available databases: -`dict -D` +`dict {{[-D|--dbs]}}` - Get information about a database: -`dict -i {{database_name}}` +`dict {{[-i|--info]}} {{database_name}}` - Look up a word in a specific database: -`dict -d {{database_name}} {{word}}` +`dict {{[-d|--database]}} {{database_name}} {{word}}` - Look up a word in all available databases: @@ -26,4 +26,4 @@ source: https://github.com/tldr-pages/tldr.git - Show information about the DICT server: -`dict -I` +`dict {{[-I|--serverinfo]}}` diff --git a/tldr/docker-build b/tldr/docker-build index 40b14892..7260b5a9 100644 --- a/tldr/docker-build +++ b/tldr/docker-build @@ -18,19 +18,19 @@ source: https://github.com/tldr-pages/tldr.git - Build a Docker image and tag it: -`docker build --tag {{name:tag}} .` +`docker build {{[-t|--tag]}} {{name:tag}} .` - Build a Docker image with no build context: -`docker build --tag {{name:tag}} - < {{Dockerfile}}` +`docker build {{[-t|--tag]}} {{name:tag}} - < {{Dockerfile}}` - Do not use the cache when building the image: -`docker build --no-cache --tag {{name:tag}} .` +`docker build --no-cache {{[-t|--tag]}} {{name:tag}} .` - Build a Docker image using a specific Dockerfile: -`docker build --file {{Dockerfile}} .` +`docker build {{[-f|--file]}} {{Dockerfile}} .` - Build with custom build-time variables: diff --git a/tldr/docker-commit b/tldr/docker-commit index f1689f66..f18c9db5 100644 --- a/tldr/docker-commit +++ b/tldr/docker-commit @@ -14,23 +14,23 @@ source: https://github.com/tldr-pages/tldr.git - Apply a `CMD` Dockerfile instruction to the created image: -`docker commit --change "CMD {{command}}" {{container}} {{image}}:{{tag}}` +`docker commit {{[-c|--change]}} "CMD {{command}}" {{container}} {{image}}:{{tag}}` - Apply an `ENV` Dockerfile instruction to the created image: -`docker commit --change "ENV {{name}}={{value}}" {{container}} {{image}}:{{tag}}` +`docker commit {{[-c|--change]}} "ENV {{name}}={{value}}" {{container}} {{image}}:{{tag}}` - Create an image with a specific author in the metadata: -`docker commit --author "{{author}}" {{container}} {{image}}:{{tag}}` +`docker commit {{[-a|--author]}} "{{author}}" {{container}} {{image}}:{{tag}}` - Create an image with a specific comment in the metadata: -`docker commit --message "{{comment}}" {{container}} {{image}}:{{tag}}` +`docker commit {{[-m|--message]}} "{{comment}}" {{container}} {{image}}:{{tag}}` - Create an image without pausing the container during commit: -`docker commit --pause {{false}} {{container}} {{image}}:{{tag}}` +`docker commit {{[-p|--pause]}} {{false}} {{container}} {{image}}:{{tag}}` - Display help: diff --git a/tldr/docker-compose b/tldr/docker-compose index b98eaa3a..f06f8ee5 100644 --- a/tldr/docker-compose +++ b/tldr/docker-compose @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Create and start all containers in the background using a `docker-compose.yml` file from the current directory: -`docker compose up --detach` +`docker compose up {{[-d|--detach]}}` - Start all containers, rebuild if necessary: @@ -22,7 +22,7 @@ source: https://github.com/tldr-pages/tldr.git - Start all containers by specifying a project name and using an alternate compose file: -`docker compose -p {{project_name}} --file {{path/to/file}} up` +`docker compose {{[-p|--project-name]}} {{project_name}} {{[-f|--file]}} {{path/to/file}} up` - Stop all running containers: @@ -30,12 +30,12 @@ source: https://github.com/tldr-pages/tldr.git - Stop and remove all containers, networks, images, and volumes: -`docker compose down --rmi all --volumes` +`docker compose down --rmi all {{[-v|--volumes]}}` - Follow logs for all containers: -`docker compose logs --follow` +`docker compose logs {{[-f|--follow]}}` - Follow logs for a specific container: -`docker compose logs --follow {{container_name}}` +`docker compose logs {{[-f|--follow]}} {{container_name}}` diff --git a/tldr/docker-cp b/tldr/docker-cp index 47924ce1..02b042ee 100644 --- a/tldr/docker-cp +++ b/tldr/docker-cp @@ -18,4 +18,4 @@ source: https://github.com/tldr-pages/tldr.git - Copy a file or directory from the host to a container, following symlinks (copies the symlinked files directly, not the symlinks themselves): -`docker cp --follow-link {{path/to/symlink_on_host}} {{container_name}}:{{path/to/file_or_directory_in_container}}` +`docker cp {{[-L|--follow-link]}} {{path/to/symlink_on_host}} {{container_name}}:{{path/to/file_or_directory_in_container}}` diff --git a/tldr/docker-image b/tldr/docker-image index cedec941..04bd3761 100644 --- a/tldr/docker-image +++ b/tldr/docker-image @@ -19,7 +19,7 @@ source: https://github.com/tldr-pages/tldr.git - Delete all unused images (not just those without a tag): -`docker image prune --all` +`docker image prune {{[-a|--all]}}` - Show the history of a local Docker image: diff --git a/tldr/docker-images b/tldr/docker-images index 4f131803..9d8f0104 100644 --- a/tldr/docker-images +++ b/tldr/docker-images @@ -30,4 +30,4 @@ source: https://github.com/tldr-pages/tldr.git - Sort images by size: -`docker images --format "\{\{.ID\}\} \{\{.Size\}\} \{\{.Repository\}\}:\{\{.Tag\}\}" | sort -k 2 -h` +`docker images --format "\{\{.ID\}\} \{\{.Size\}\} \{\{.Repository\}\}:\{\{.Tag\}\}" | sort {{[-k|--key]}} 2 {{[-h|--human-numeric-sort]}}` diff --git a/tldr/docker-inspect b/tldr/docker-inspect index a464fad7..c88da679 100644 --- a/tldr/docker-inspect +++ b/tldr/docker-inspect @@ -18,20 +18,20 @@ source: https://github.com/tldr-pages/tldr.git - Display a container's IP address: -`docker inspect --format '\{\{range.NetworkSettings.Networks\}\}\{\{.IPAddress\}\}\{\{end\}\}' {{container}}` +`docker inspect {{[-f|--format]}} '\{\{range.NetworkSettings.Networks\}\}\{\{.IPAddress\}\}\{\{end\}\}' {{container}}` - Display the path to the container's log file: -`docker inspect --format='\{\{.LogPath\}\}' {{container}}` +`docker inspect {{[-f|--format]}} '\{\{.LogPath\}\}' {{container}}` - Display the image name of the container: -`docker inspect --format='\{\{.Config.Image\}\}' {{container}}` +`docker inspect {{[-f|--format]}} '\{\{.Config.Image\}\}' {{container}}` - Display the configuration information as JSON: -`docker inspect --format='\{\{json .Config\}\}' {{container}}` +`docker inspect {{[-f|--format]}} '\{\{json .Config\}\}' {{container}}` - Display all port bindings: -`docker inspect --format='\{\{range $p, $conf := .NetworkSettings.Ports\}\} \{\{$p\}\} -> \{\{(index $conf 0).HostPort\}\} \{\{end\}\}' {{container}}` +`docker inspect {{[-f|--format]}} '\{\{range $p, $conf := .NetworkSettings.Ports\}\} \{\{$p\}\} -> \{\{(index $conf 0).HostPort\}\} \{\{end\}\}' {{container}}` diff --git a/tldr/docker-load b/tldr/docker-load index 950319ff..6862553b 100644 --- a/tldr/docker-load +++ b/tldr/docker-load @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - Load a Docker image from a specific file: -`docker load --input {{path/to/image_file.tar}}` +`docker load {{[-i|--input]}} {{path/to/image_file.tar}}` - Load a Docker image from a specific file in quiet mode: -`docker load --quiet --input {{path/to/image_file.tar}}` +`docker load {{[-q|--quiet]}} {{[-i|--input]}} {{path/to/image_file.tar}}` diff --git a/tldr/docker-login b/tldr/docker-login index bc16e9fc..66c35978 100644 --- a/tldr/docker-login +++ b/tldr/docker-login @@ -14,12 +14,12 @@ source: https://github.com/tldr-pages/tldr.git - Log into a registry with a specific username (user will be prompted for a password): -`docker login --username {{username}}` +`docker login {{[-u|--username]}} {{username}}` - Log into a registry with username and password: -`docker login --username {{username}} --password {{password}} {{server}}` +`docker login {{[-u|--username]}} {{username}} {{[-p|--password]}} {{password}} {{server}}` - Log into a registry with password from `stdin`: -`echo "{{password}}" | docker login --username {{username}} --password-stdin` +`echo "{{password}}" | docker login {{[-u|--username]}} {{username}} --password-stdin` diff --git a/tldr/docker-network b/tldr/docker-network index cb65fe61..e5135c87 100644 --- a/tldr/docker-network +++ b/tldr/docker-network @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Create a user-defined network: -`docker network create --driver {{driver_name}} {{network_name}}` +`docker network create {{[-d|--driver]}} {{driver_name}} {{network_name}}` - Display detailed information about one or more networks: diff --git a/tldr/docker-rmi b/tldr/docker-rmi index e5068bf7..b031c24b 100644 --- a/tldr/docker-rmi +++ b/tldr/docker-rmi @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Force remove an image: -`docker rmi --force {{image}}` +`docker rmi {{[-f|--force]}} {{image}}` - Remove an image without deleting untagged parents: diff --git a/tldr/docker-save b/tldr/docker-save index 496f7e16..5a139fa6 100644 --- a/tldr/docker-save +++ b/tldr/docker-save @@ -14,12 +14,12 @@ source: https://github.com/tldr-pages/tldr.git - Save an image to a tar archive: -`docker save --output {{path/to/file.tar}} {{image}}:{{tag}}` +`docker save {{[-o|--output]}} {{path/to/file.tar}} {{image}}:{{tag}}` - Save all tags of the image: -`docker save --output {{path/to/file.tar}} {{image_name}}` +`docker save {{[-o|--output]}} {{path/to/file.tar}} {{image_name}}` - Cherry-pick particular tags of an image to save: -`docker save --output {{path/to/file.tar}} {{image_name:tag1 image_name:tag2 ...}}` +`docker save {{[-o|--output]}} {{path/to/file.tar}} {{image_name:tag1 image_name:tag2 ...}}` diff --git a/tldr/docker-stats b/tldr/docker-stats index 6e267e08..bdc501c9 100644 --- a/tldr/docker-stats +++ b/tldr/docker-stats @@ -22,7 +22,7 @@ source: https://github.com/tldr-pages/tldr.git - Display statistics for all containers (both running and stopped): -`docker stats --all` +`docker stats {{[-a|--all]}}` - Disable streaming stats and only pull the current stats: diff --git a/tldr/docker-system b/tldr/docker-system index 71dac095..c31222dc 100644 --- a/tldr/docker-system +++ b/tldr/docker-system @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Show detailed information on disk usage: -`docker system df --verbose` +`docker system df {{[-v|--verbose]}}` - Remove unused data (append `--volumes` to remove unused volumes as well): @@ -34,7 +34,7 @@ source: https://github.com/tldr-pages/tldr.git - Display real-time events from containers streamed as valid JSON Lines: -`docker system events --filter 'type=container' --format '{{json .}}'` +`docker system events {{[-f|--filter]}} 'type=container' --format '{{json .}}'` - Display system-wide information: diff --git a/tldr/docker-volume b/tldr/docker-volume index 242e04db..20fc61fb 100644 --- a/tldr/docker-volume +++ b/tldr/docker-volume @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Create a `tmpfs` volume a size of 100 MiB and an uid of 1000: -`docker volume create --opt {{type}}={{tmpfs}} --opt {{device}}={{tmpfs}} --opt {{o}}={{size=100m,uid=1000}} {{volume_name}}` +`docker volume create {{[-o|--opt]}} {{type}}={{tmpfs}} {{[-o|--opt]}} {{device}}={{tmpfs}} {{[-o|--opt]}} {{o}}={{size=100m,uid=1000}} {{volume_name}}` - List all volumes: diff --git a/tldr/dolt-add b/tldr/dolt-add index 7cc73133..c6199398 100644 --- a/tldr/dolt-add +++ b/tldr/dolt-add @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Stage all tables: -`dolt add --all` +`dolt add {{[-A|--all]}}` diff --git a/tldr/dolt-branch b/tldr/dolt-branch index ab559a17..e62881df 100644 --- a/tldr/dolt-branch +++ b/tldr/dolt-branch @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - List all local and remote branches: -`dolt branch --all` +`dolt branch {{[-A|--all]}}` - Create a new branch based on the current branch: @@ -26,15 +26,15 @@ source: https://github.com/tldr-pages/tldr.git - Rename a branch: -`dolt branch --move {{branch_name1}} {{branch_name2}}` +`dolt branch {{[-m|--move]}} {{branch_name1}} {{branch_name2}}` - Duplicate a branch: -`dolt branch --copy {{branch_name1}} {{branch_name2}}` +`dolt branch {{[-c|--copy]}} {{branch_name1}} {{branch_name2}}` - Delete a branch: -`dolt branch --delete {{branch_name}}` +`dolt branch {{[-d|--delete]}} {{branch_name}}` - Display the name of the current branch: diff --git a/tldr/dolt-clone b/tldr/dolt-clone index c1eeabec..2144a7ca 100644 --- a/tldr/dolt-clone +++ b/tldr/dolt-clone @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # dolt clone > Clone a repository into a new directory. -> More information: . +> More information: . - Clone an existing repository into a specific directory (defaults to the repository name): @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Clone an existing repository only fetching a specific branch (defaults to all branches): -`dolt clone --branch {{branch_name}} {{repository_url}}` +`dolt clone {{[-b|--branch]}} {{branch_name}} {{repository_url}}` - Clone a repository, using an AWS region (uses the profile's default region if none is provided): diff --git a/tldr/dolt-commit b/tldr/dolt-commit index 97ca884e..94a6d4d3 100644 --- a/tldr/dolt-commit +++ b/tldr/dolt-commit @@ -14,11 +14,11 @@ source: https://github.com/tldr-pages/tldr.git - Commit all staged changes with the specified message: -`dolt commit --message "{{commit_message}}"` +`dolt commit {{[-m|--message]}} "{{commit_message}}"` - Stage all unstaged changes to tables before committing: -`dolt commit --all` +`dolt commit {{[-a|--all]}}` - Use the specified ISO 8601 commit date (defaults to current date and time): @@ -34,4 +34,4 @@ source: https://github.com/tldr-pages/tldr.git - Ignore foreign key warnings: -`dolt commit --force` +`dolt commit {{[-f|--force]}}` diff --git a/tldr/dolt-gc b/tldr/dolt-gc index c74f6902..ace34698 100644 --- a/tldr/dolt-gc +++ b/tldr/dolt-gc @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Initiate a faster but less thorough garbage collection process: -`dolt gc --shallow` +`dolt gc {{[-s|--shallow]}}` diff --git a/tldr/dolt-init b/tldr/dolt-init index a54de195..6a6014cd 100644 --- a/tldr/dolt-init +++ b/tldr/dolt-init @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Initialize a new Dolt data repository creating a commit with the specified metadata: -`dolt init --name "{{name}}" --email "{{email}}" --date "{{2021-12-31T00:00:00}}" -b "{{branch_name}}"` +`dolt init --name "{{name}}" --email "{{email}}" --date "{{2021-12-31T00:00:00}}" {{[-b|--initial-branch]}} "{{branch_name}}"` diff --git a/tldr/dolt-merge b/tldr/dolt-merge index da76c35d..ac2b6e44 100644 --- a/tldr/dolt-merge +++ b/tldr/dolt-merge @@ -22,7 +22,7 @@ source: https://github.com/tldr-pages/tldr.git - Merge a branch and create a merge commit with a specific commit message: -`dolt merge --no-ff -m "{{message}}" {{branch_name}}` +`dolt merge --no-ff {{[-m|--message]}} "{{message}}" {{branch_name}}` - Abort the current conflict resolution process: diff --git a/tldr/dolt-sql b/tldr/dolt-sql index c17bf631..1ba15af2 100644 --- a/tldr/dolt-sql +++ b/tldr/dolt-sql @@ -10,8 +10,8 @@ source: https://github.com/tldr-pages/tldr.git - Run a single query: -`dolt sql --query "{{INSERT INTO t values (1, 3);}}"` +`dolt sql {{[-q|--query]}} "{{INSERT INTO t values (1, 3);}}"` - List all saved queries: -`dolt sql --list-saved` +`dolt sql {{[-l|--list-saved]}}` diff --git a/tldr/dotnet-add-package b/tldr/dotnet-add-package index 5b164dde..74b8bc5b 100644 --- a/tldr/dotnet-add-package +++ b/tldr/dotnet-add-package @@ -18,15 +18,15 @@ source: https://github.com/tldr-pages/tldr.git - Add a specific version of a package to the project: -`dotnet add package {{package}} --version {{1.0.0}}` +`dotnet add package {{package}} {{[-v|--version]}} {{1.0.0}}` - Add a package using a specific NuGet source: -`dotnet add package {{package}} --source {{https://api.nuget.org/v3/index.json}}` +`dotnet add package {{package}} {{[-s|--source]}} {{https://api.nuget.org/v3/index.json}}` - Add a package only when targeting a specific framework: -`dotnet add package {{package}} --framework {{net7.0}}` +`dotnet add package {{package}} {{[-f|--framework]}} {{net7.0}}` - Add and specify the directory where to restore packages (`~/.nuget/packages` by default): diff --git a/tldr/dotnet-build b/tldr/dotnet-build index eb07ed32..b56dab18 100644 --- a/tldr/dotnet-build +++ b/tldr/dotnet-build @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Compile in release mode: -`dotnet build --configuration {{Release}}` +`dotnet build {{[-c|--configuration]}} {{Release}}` - Compile without restoring dependencies: @@ -26,12 +26,12 @@ source: https://github.com/tldr-pages/tldr.git - Compile with a specific verbosity level: -`dotnet build --verbosity {{quiet|minimal|normal|detailed|diagnostic}}` +`dotnet build {{[-v|--verbosity]}} {{quiet|minimal|normal|detailed|diagnostic}}` - Compile for a specific runtime: -`dotnet build --runtime {{runtime_identifier}}` +`dotnet build {{[-r|--runtime]}} {{runtime_identifier}}` - Specify the output directory: -`dotnet build --output {{path/to/directory}}` +`dotnet build {{[-o|--output]}} {{path/to/directory}}` diff --git a/tldr/dotnet-publish b/tldr/dotnet-publish index 83bd0de2..8fbcd8ac 100644 --- a/tldr/dotnet-publish +++ b/tldr/dotnet-publish @@ -10,19 +10,19 @@ source: https://github.com/tldr-pages/tldr.git - Compile a .NET project in release mode: -`dotnet publish --configuration Release {{path/to/project_file}}` +`dotnet publish {{[-c|--configuration]}} Release {{path/to/project_file}}` - Publish the .NET Core runtime with your application for the specified runtime: -`dotnet publish --self-contained true --runtime {{runtime_identifier}} {{path/to/project_file}}` +`dotnet publish {{[-sc|--self-contained]}} true {{[-r|--runtime]}} {{runtime_identifier}} {{path/to/project_file}}` - Package the application into a platform-specific single-file executable: -`dotnet publish --runtime {{runtime_identifier}} -p:PublishSingleFile=true {{path/to/project_file}}` +`dotnet publish {{[-r|--runtime]}} {{runtime_identifier}} -p:PublishSingleFile=true {{path/to/project_file}}` - Trim unused libraries to reduce the deployment size of an application: -`dotnet publish --self-contained true --runtime {{runtime_identifier}} -p:PublishTrimmed=true {{path/to/project_file}}` +`dotnet publish {{[-sc|--self-contained]}} true {{[-r|--runtime]}} {{runtime_identifier}} -p:PublishTrimmed=true {{path/to/project_file}}` - Compile a .NET project without restoring dependencies: @@ -30,4 +30,4 @@ source: https://github.com/tldr-pages/tldr.git - Specify the output directory: -`dotnet publish --output {{path/to/directory}} {{path/to/project_file}}` +`dotnet publish {{[-o|--output]}} {{path/to/directory}} {{path/to/project_file}}` diff --git a/tldr/dotnet-restore b/tldr/dotnet-restore index 6602c921..47a76371 100644 --- a/tldr/dotnet-restore +++ b/tldr/dotnet-restore @@ -30,4 +30,4 @@ source: https://github.com/tldr-pages/tldr.git - Restore dependencies with a specific verbosity level: -`dotnet restore --verbosity {{quiet|minimal|normal|detailed|diagnostic}}` +`dotnet restore {{[-v|--verbosity]}} {{quiet|minimal|normal|detailed|diagnostic}}` diff --git a/tldr/dotnet-run b/tldr/dotnet-run index 56d27c67..a6ace37f 100644 --- a/tldr/dotnet-run +++ b/tldr/dotnet-run @@ -22,8 +22,8 @@ source: https://github.com/tldr-pages/tldr.git - Run the project using a target framework moniker: -`dotnet run --framework {{net7.0}}` +`dotnet run {{[-f|--framework]}} {{net7.0}}` - Specify architecture and OS, available since .NET 6 (Don't use `--runtime` with these options): -`dotnet run --arch {{x86|x64|arm|arm64}} --os {{win|win7|osx|linux|ios|android}}` +`dotnet run {{[-a|--arch]}} {{x86|x64|arm|arm64}} --os {{win|win7|osx|linux|ios|android}}` diff --git a/tldr/dotnet-tool b/tldr/dotnet-tool index 96c9b61a..c22186c8 100644 --- a/tldr/dotnet-tool +++ b/tldr/dotnet-tool @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Install a global tool (don't use `--global` for local tools): -`dotnet tool install --global {{dotnetsay}}` +`dotnet tool install {{[-g|--global]}} {{dotnetsay}}` - Install tools defined in the local tool manifest: @@ -18,15 +18,15 @@ source: https://github.com/tldr-pages/tldr.git - Update a specific global tool (don't use `--global` for local tools): -`dotnet tool update --global {{tool_name}}` +`dotnet tool update {{[-g|--global]}} {{tool_name}}` - Uninstall a global tool (don't use `--global` for local tools): -`dotnet tool uninstall --global {{tool_name}}` +`dotnet tool uninstall {{[-g|--global]}} {{tool_name}}` - List installed global tools (don't use `--global` for local tools): -`dotnet tool list --global` +`dotnet tool list {{[-g|--global]}}` - Search tools in NuGet: @@ -34,4 +34,4 @@ source: https://github.com/tldr-pages/tldr.git - Display help: -`dotnet tool --help` +`dotnet tool {{[-h|--help]}}` diff --git a/tldr/dub b/tldr/dub index f53072b7..509acaad 100644 --- a/tldr/dub +++ b/tldr/dub @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Non-interactively create a new D project: -`dub init {{project_name}} -n` +`dub init {{project_name}} {{[-n|--non-interactive]}}` - Build and run a D project: @@ -30,4 +30,4 @@ source: https://github.com/tldr-pages/tldr.git - Display help: -`dub --help` +`dub {{[-h|--help]}}` diff --git a/tldr/dumpcap b/tldr/dumpcap index 4d7b60d5..eb7db254 100644 --- a/tldr/dumpcap +++ b/tldr/dumpcap @@ -10,16 +10,16 @@ source: https://github.com/tldr-pages/tldr.git - Display available interfaces: -`dumpcap --list-interfaces` +`dumpcap {{[-D|--list-interfaces]}}` - Capture packets on a specific interface: -`dumpcap --interface {{1}}` +`dumpcap {{[-i|--interface]}} {{1}}` - Capture packets to a specific location: -`dumpcap --interface {{1}} -w {{path/to/output_file.pcapng}}` +`dumpcap {{[-i|--interface]}} {{1}} -w {{path/to/output_file.pcapng}}` - Write to a ring buffer with a specific max file limit of a specific size: -`dumpcap --interface {{1}} -w {{path/to/output_file.pcapng}} --ring-buffer filesize:{{500000}} --ring-buffer files:{{10}}` +`dumpcap {{[-i|--interface]}} {{1}} -w {{path/to/output_file.pcapng}} {{[-b|--ring-buffer]}} filesize:{{500000}} {{[-b|--ring-buffer]}} files:{{10}}` diff --git a/tldr/duplicacy b/tldr/duplicacy index 2b22e7a9..8a3db9b2 100644 --- a/tldr/duplicacy +++ b/tldr/duplicacy @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Use current directory as the repository, initialize a SFTP storage and encrypt the storage with a password: -`duplicacy init -e {{snapshot_id}} {{sftp://user@192.168.2.100/path/to/storage/}}` +`duplicacy init {{[-e|-encrypt]}} {{snapshot_id}} {{sftp://user@192.168.2.100/path/to/storage/}}` - Save a snapshot of the repository to the default storage: diff --git a/tldr/egrep b/tldr/egrep index b3c016b3..238c14d4 100644 --- a/tldr/egrep +++ b/tldr/egrep @@ -22,12 +22,12 @@ source: https://github.com/tldr-pages/tldr.git - Print file name and line number for each match: -`egrep --with-filename --line-number "{{search_pattern}}" {{path/to/file}}` +`egrep {{[-H|--with-filename]}} {{[-n|--line-number]}} "{{search_pattern}}" {{path/to/file}}` - Search for a pattern in all files recursively in a directory, ignoring binary files: -`egrep --recursive --binary-files={{without-match}} "{{search_pattern}}" {{path/to/directory}}` +`egrep {{[-r|--recursive]}} --binary-files={{without-match}} "{{search_pattern}}" {{path/to/directory}}` - Search for lines that do not match a pattern: -`egrep --invert-match "{{search_pattern}}" {{path/to/file}}` +`egrep {{[-v|--invert-match]}} "{{search_pattern}}" {{path/to/file}}` diff --git a/tldr/electrum b/tldr/electrum index fb8248ee..f51a2354 100644 --- a/tldr/electrum +++ b/tldr/electrum @@ -10,15 +10,15 @@ source: https://github.com/tldr-pages/tldr.git - Create a new wallet: -`electrum -w {{new_wallet.dat}} create` +`electrum {{[-w|--wallet]}} {{path/to/new_wallet.dat}} create` - Restore an existing wallet from seed offline: -`electrum -w {{recovery_wallet.dat}} restore -o` +`electrum {{[-w|--wallet]}} {{path/to/recovery_wallet.dat}} restore {{[-o|--offline]}}` - Create a signed transaction offline: -`electrum mktx {{recipient}} {{amount}} -f 0.0000001 -F {{from}} -o` +`electrum mktx {{recipient}} {{amount}} {{[-f|--fee]}} 0.0000001 {{[-F|--from-addr]}} {{from}} {{[-o|--offline]}}` - Display all wallet receiving addresses: @@ -34,4 +34,4 @@ source: https://github.com/tldr-pages/tldr.git - Connect only to a specific electrum-server instance: -`electrum -p socks5:{{127.0.0.1}}:9050 -s {{56ckl5obj37gypcu.onion}}:50001:t -1` +`electrum {{[-p|--proxy]}} socks5:{{127.0.0.1}}:9050 {{[-s|--server]}} {{56ckl5obj37gypcu.onion}}:50001:t {{[-1|--oneserver]}}` diff --git a/tldr/elixir b/tldr/elixir index 1a21df05..a78d6fb4 100644 --- a/tldr/elixir +++ b/tldr/elixir @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Evaluate Elixir code by passing it as an argument: -`elixir -e "{{code}}"` +`elixir {{[-e|--eval]}} "{{code}}"` diff --git a/tldr/enca b/tldr/enca index 65dd0ee1..45a0b25f 100644 --- a/tldr/enca +++ b/tldr/enca @@ -14,12 +14,12 @@ source: https://github.com/tldr-pages/tldr.git - Detect file(s) encoding specifying a language in the POSIX/C locale format (e.g. zh_CN, en_US): -`enca -L {{language}} {{path/to/file1 path/to/file2 ...}}` +`enca {{[-L|--language]}} {{language}} {{path/to/file1 path/to/file2 ...}}` - Convert file(s) to a specific encoding: -`enca -L {{language}} -x {{to_encoding}} {{path/to/file1 path/to/file2 ...}}` +`enca {{[-L|--language]}} {{language}} {{[-x|--convert-to]}} {{to_encoding}} {{path/to/file1 path/to/file2 ...}}` - Create a copy of an existing file using a different encoding: -`enca -L {{language}} -x {{to_encoding}} < {{original_file}} > {{new_file}}` +`enca {{[-L|--language]}} {{language}} {{[-x|--convert-to]}} {{to_encoding}} < {{original_file}} > {{new_file}}` diff --git a/tldr/entr b/tldr/entr index 16c68a38..96283da6 100644 --- a/tldr/entr +++ b/tldr/entr @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Rebuild with `make` if any file in any subdirectory changes: -`{{ag -l}} | entr {{make}}` +`{{ag --files-with-matches}} | entr {{make}}` - Rebuild and test with `make` if any `.c` source files in the current directory change: diff --git a/tldr/eslint b/tldr/eslint index aa8f6e22..90650bc8 100644 --- a/tldr/eslint +++ b/tldr/eslint @@ -22,4 +22,4 @@ source: https://github.com/tldr-pages/tldr.git - Lint using the specified configuration file: -`eslint -c {{path/to/config_file}} {{path/to/file1.js path/to/file2.js}}` +`eslint {{[-c|--config]}} {{path/to/config_file}} {{path/to/file1.js path/to/file2.js}}` diff --git a/tldr/exiftool b/tldr/exiftool index 714bbfb1..7fd1f5a7 100644 --- a/tldr/exiftool +++ b/tldr/exiftool @@ -30,7 +30,7 @@ source: https://github.com/tldr-pages/tldr.git - Move the date at which all JPEG photos in the current directory were taken 1 day and 2 hours backward: -`exiftool "-AllDates-=0:0:1 2:0:0" -ext jpg` +`exiftool "-AllDates-=0:0:1 2:0:0" {{[-ext|-extension]}} jpg` - Only change the `DateTimeOriginal` field subtracting 1.5 hours, without keeping backups: @@ -38,4 +38,4 @@ source: https://github.com/tldr-pages/tldr.git - Recursively rename all JPEG photos in a directory based on the `DateTimeOriginal` field: -`exiftool '-filename Specifies the command to generate a `.desktop` file and a download icon with minimal information. -> More information: . +> More information: . - Create a `.desktop` file named `app`: @@ -18,4 +18,4 @@ source: https://github.com/tldr-pages/tldr.git - Display help: -`gendesk -h` +`gendesk {{[-h|--help]}}` diff --git a/tldr/git b/tldr/git index 48134df8..2e1ebc28 100644 --- a/tldr/git +++ b/tldr/git @@ -23,7 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - Display help: -`git --help` +`git {{[-h|--help]}}` - Display help for a specific subcommand (like `clone`, `add`, `push`, `log`, etc.): @@ -31,4 +31,4 @@ source: https://github.com/tldr-pages/tldr.git - Display version: -`git --version` +`git {{[-v|--version]}}` diff --git a/tldr/git-checkout b/tldr/git-checkout index 57055df1..246daac1 100644 --- a/tldr/git-checkout +++ b/tldr/git-checkout @@ -26,7 +26,7 @@ source: https://github.com/tldr-pages/tldr.git - Switch to an existing remote branch: -`git checkout --track {{remote_name}}/{{branch_name}}` +`git checkout {{[-t|--track]}} {{remote_name}}/{{branch_name}}` - Discard all unstaged changes in the current directory (see `git reset` for more undo-like commands): diff --git a/tldr/git-force-clone b/tldr/git-force-clone index 94dca170..940c9ba7 100644 --- a/tldr/git-force-clone +++ b/tldr/git-force-clone @@ -15,8 +15,8 @@ source: https://github.com/tldr-pages/tldr.git - Clone a Git repository into a new directory, checking out an specific branch: -`git force-clone -b {{branch_name}} {{remote_repository_location}} {{path/to/directory}}` +`git force-clone {{[-b|--branch]}} {{branch_name}} {{remote_repository_location}} {{path/to/directory}}` - Clone a Git repository into an existing directory of a Git repository, performing a force-reset to resemble it to the remote and checking out an specific branch: -`git force-clone -b {{branch_name}} {{remote_repository_location}} {{path/to/directory}}` +`git force-clone {{[-b|--branch]}} {{branch_name}} {{remote_repository_location}} {{path/to/directory}}` diff --git a/tldr/git-guilt b/tldr/git-guilt index c2c41c09..fa4302d2 100644 --- a/tldr/git-guilt +++ b/tldr/git-guilt @@ -19,15 +19,15 @@ source: https://github.com/tldr-pages/tldr.git - Show author emails instead of names: -`git guilt --email` +`git guilt {{[-e|--email]}}` - Ignore whitespace only changes when attributing blame: -`git guilt --ignore-whitespace` +`git guilt {{[-w|--ignore-whitespace]}}` - Find blame delta over the last three weeks: -`git guilt 'git log --until="3 weeks ago" --format="%H" -n 1'` +`git guilt 'git log --until="3 weeks ago" --format="%H" {{[-n|--max-count]}} 1'` - Find blame delta over the last three weeks (git 1.8.5+): diff --git a/tldr/git-sed b/tldr/git-sed index 6b864120..8be47484 100644 --- a/tldr/git-sed +++ b/tldr/git-sed @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Replace patterns in git-controlled files using sed. > Part of `git-extras`. -> More information: . +> More information: . - Replace the specified text in the current repository: diff --git a/tldr/git-show b/tldr/git-show index e3a04cb3..14a6a669 100644 --- a/tldr/git-show +++ b/tldr/git-show @@ -26,7 +26,7 @@ source: https://github.com/tldr-pages/tldr.git - Show a commit's message in a single line, suppressing the diff output: -`git show --oneline -s {{commit}}` +`git show --oneline {{[-s|--no-patch]}} {{commit}}` - Show only statistics (added/removed characters) about the changed files: diff --git a/tldr/git-standup b/tldr/git-standup index 518a645b..17aa4569 100644 --- a/tldr/git-standup +++ b/tldr/git-standup @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > See commits from a specified user. > Part of `git-extras`. -> More information: . +> More information: . - Show a given author's commits from the last 10 days: diff --git a/tldr/git-subtree b/tldr/git-subtree index a6d423c6..184e21e2 100644 --- a/tldr/git-subtree +++ b/tldr/git-subtree @@ -6,24 +6,24 @@ source: https://github.com/tldr-pages/tldr.git # git subtree > Manage project dependencies as subprojects. -> More information: . +> More information: . - Add a Git repository as a subtree: -`git subtree add --prefix={{path/to/directory/}} --squash {{repository_url}} {{branch_name}}` +`git subtree add {{[-P|--prefix]}} {{path/to/directory/}} --squash {{repository_url}} {{branch_name}}` - Update subtree repository to its latest commit: -`git subtree pull --prefix={{path/to/directory/}} {{repository_url}} {{branch_name}}` +`git subtree pull {{[-P|--prefix]}} {{path/to/directory/}} {{repository_url}} {{branch_name}}` - Merge recent changes up to the latest subtree commit into the subtree: -`git subtree merge --prefix={{path/to/directory/}} --squash {{repository_url}} {{branch_name}}` +`git subtree merge {{[-P|--prefix]}} {{path/to/directory/}} --squash {{repository_url}} {{branch_name}}` - Push commits to a subtree repository: -`git subtree push --prefix={{path/to/directory/}} {{repository_url}} {{branch_name}}` +`git subtree push {{[-P|--prefix]}} {{path/to/directory/}} {{repository_url}} {{branch_name}}` - Extract a new project history from the history of a subtree: -`git subtree split --prefix={{path/to/directory/}} {{repository_url}} -b {{branch_name}}` +`git subtree split {{[-P|--prefix]}} {{path/to/directory/}} {{repository_url}} {{[-b|--branch]}} {{branch_name}}` diff --git a/tldr/git-symbolic-ref b/tldr/git-symbolic-ref index 8f411e16..66253502 100644 --- a/tldr/git-symbolic-ref +++ b/tldr/git-symbolic-ref @@ -22,8 +22,8 @@ source: https://github.com/tldr-pages/tldr.git - Delete a reference by name: -`git symbolic-ref --delete refs/{{name}}` +`git symbolic-ref {{[-d|--delete]}} refs/{{name}}` - For scripting, hide errors with `--quiet` and use `--short` to simplify ("refs/heads/X" prints as "X"): -`git symbolic-ref --quiet --short refs/{{name}}` +`git symbolic-ref {{[-q|--quiet]}} --short refs/{{name}}` diff --git a/tldr/git-sync b/tldr/git-sync index c50ec180..c0665707 100644 --- a/tldr/git-sync +++ b/tldr/git-sync @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Sync local branches with remote branches. > Part of `git-extras`. -> More information: . +> More information: . - Sync the current local branch with its remote branch: @@ -19,4 +19,4 @@ source: https://github.com/tldr-pages/tldr.git - Sync without cleaning untracked files: -`git sync -s {{remote_name}} {{branch_name}}` +`git sync {{[-s|--soft]}} {{remote_name}} {{branch_name}}` diff --git a/tldr/glab-repo b/tldr/glab-repo index 66a36299..68f7b1aa 100644 --- a/tldr/glab-repo +++ b/tldr/glab-repo @@ -18,12 +18,12 @@ source: https://github.com/tldr-pages/tldr.git - Fork and clone a repository: -`glab repo fork {{owner}}/{{repository}} --clone` +`glab repo fork {{owner}}/{{repository}} {{[-c|--clone]}}` - View a repository in the default web browser: -`glab repo view {{owner}}/{{repository}} --web` +`glab repo view {{owner}}/{{repository}} {{[-w|--web]}}` - Search some repositories in the GitLab instance: -`glab repo search -s {{search_string}}` +`glab repo search {{[-s|--search]}} {{search_string}}` diff --git a/tldr/glow b/tldr/glow index 3dd740a4..9be10ce7 100644 --- a/tldr/glow +++ b/tldr/glow @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - View a Markdown file using a paginator: -`glow -p {{path/to/file}}` +`glow {{[-p|--pager]}} {{path/to/file}}` - View a file from a URL: diff --git a/tldr/gnmic b/tldr/gnmic index 162418c2..71f5dbd1 100644 --- a/tldr/gnmic +++ b/tldr/gnmic @@ -11,20 +11,20 @@ source: https://github.com/tldr-pages/tldr.git - Request device capabilities: -`gnmic --address {{ip:port}} capabilities` +`gnmic {{[-a|--address]}} {{ip:port}} capabilities` - Provide a username and password to fetch device capabilities: -`gnmic --address {{ip:port}} --username {{username}} --password {{password}} capabilities` +`gnmic {{[-a|--address]}} {{ip:port}} {{[-u|--username]}} {{username}} {{[-p|--password]}} {{password}} capabilities` - Get a snapshot of the device state at a specific path: -`gnmic -a {{ip:port}} get --path {{path}}` +`gnmic {{[-a|--address]}} {{ip:port}} get --path {{path}}` - Update device state at a specific path: -`gnmic -a {{ip:port}} set --update-path {{path}} --update-value {{value}}` +`gnmic {{[-a|--address]}} {{ip:port}} set --update-path {{path}} --update-value {{value}}` - Subscribe to target state updates under the subtree at a specific path: -`gnmic -a {{ip:port}} subscribe --path {{path}}` +`gnmic {{[-a|--address]}} {{ip:port}} subscribe --path {{path}}` diff --git a/tldr/gnmic-get b/tldr/gnmic-get index 415d5dab..a1143940 100644 --- a/tldr/gnmic-get +++ b/tldr/gnmic-get @@ -10,16 +10,16 @@ source: https://github.com/tldr-pages/tldr.git - Get a snapshot of the device state at a specific path: -`gnmic --address {{ip:port}} get --path {{path}}` +`gnmic {{[-a|--address]}} {{ip:port}} get --path {{path}}` - Query the device state at multiple paths: -`gnmic -a {{ip:port}} get --path {{path/to/file_or_directory1}} --path {{path/to/file_or_directory2}}` +`gnmic {{[-a|--address]}} {{ip:port}} get --path {{path/to/file_or_directory1}} --path {{path/to/file_or_directory2}}` - Query the device state at multiple paths with a common prefix: -`gnmic -a {{ip:port}} get --prefix {{prefix}} --path {{path/to/file_or_directory1}} --path {{path/to/file_or_directory2}}` +`gnmic {{[-a|--address]}} {{ip:port}} get --prefix {{prefix}} --path {{path/to/file_or_directory1}} --path {{path/to/file_or_directory2}}` - Query the device state and specify response encoding (json_ietf): -`gnmic -a {{ip:port}} get --path {{path}} --encoding json_ietf` +`gnmic {{[-a|--address]}} {{ip:port}} get --path {{path}} {{[-e|--encoding]}} json_ietf` diff --git a/tldr/gnmic-set b/tldr/gnmic-set index 20170ad2..c660e7a9 100644 --- a/tldr/gnmic-set +++ b/tldr/gnmic-set @@ -10,16 +10,16 @@ source: https://github.com/tldr-pages/tldr.git - Update the value of a path: -`gnmic --address {{ip:port}} set --update-path {{path}} --update-value {{value}}` +`gnmic {{[-a|--address]}} {{ip:port}} set --update-path {{path}} --update-value {{value}}` - Update the value of a path to match the contents of a JSON file: -`gnmic -a {{ip:port}} set --update-path {{path}} --update-file {{filepath}}` +`gnmic {{[-a|--address]}} {{ip:port}} set --update-path {{path}} --update-file {{filepath}}` - Replace the value of a path to match the contents of a JSON file: -`gnmic -a {{ip:port}} set --replace-path {{path}} --replace-file {{filepath}}` +`gnmic {{[-a|--address]}} {{ip:port}} set --replace-path {{path}} --replace-file {{filepath}}` - Delete the node at a given path: -`gnmic -a {{ip:port}} set --delete {{path}}` +`gnmic {{[-a|--address]}} {{ip:port}} set --delete {{path}}` diff --git a/tldr/gnmic-subscribe b/tldr/gnmic-subscribe index 7b92c575..86544ea0 100644 --- a/tldr/gnmic-subscribe +++ b/tldr/gnmic-subscribe @@ -10,20 +10,20 @@ source: https://github.com/tldr-pages/tldr.git - Subscribe to target state updates under the subtree of a specific path: -`gnmic --address {{ip:port}} subscribe --path {{path}}` +`gnmic {{[-a|--address]}} {{ip:port}} subscribe --path {{path}}` - Subscribe to a target with a sample interval of 30s (default is 10s): -`gnmic -a {{ip:port}} subscribe --path {{path}} --sample-interval 30s` +`gnmic {{[-a|--address]}} {{ip:port}} subscribe --path {{path}} --sample-interval 30s` - Subscribe to a target with sample interval and updates only on change: -`gnmic -a {{ip:port}} subscribe --path {{path}} --stream-mode on-change --heartbeat-interval 1m` +`gnmic {{[-a|--address]}} {{ip:port}} subscribe --path {{path}} --stream-mode on-change --heartbeat-interval 1m` - Subscribe to a target for only one update: -`gnmic -a {{ip:port}} subscribe --path {{path}} --mode once` +`gnmic {{[-a|--address]}} {{ip:port}} subscribe --path {{path}} --mode once` - Subscribe to a target and specify response encoding (json_ietf): -`gnmic -a {{ip:port}} subscribe --path {{path}} --encoding json_ietf` +`gnmic {{[-a|--address]}} {{ip:port}} subscribe --path {{path}} {{[-e|--encoding]}} json_ietf` diff --git a/tldr/godot b/tldr/godot index 60828251..761b7c9c 100644 --- a/tldr/godot +++ b/tldr/godot @@ -14,11 +14,11 @@ source: https://github.com/tldr-pages/tldr.git - Edit a project (the current directory must contain a `project.godot` file): -`godot -e` +`godot {{[-e|--editor]}}` - Open the project manager even if the current directory contains a `project.godot` file: -`godot -p` +`godot {{[-p|--project-manager]}}` - Export a project for a given export preset (the preset must be defined in the project): @@ -26,4 +26,4 @@ source: https://github.com/tldr-pages/tldr.git - Execute a standalone GDScript file (the script must inherit from `SceneTree` or `MainLoop`): -`godot -s {{script.gd}}` +`godot {{[-s|--script]}} {{script.gd}}` diff --git a/tldr/googler b/tldr/googler index 9af32c73..c51fc2b2 100644 --- a/tldr/googler +++ b/tldr/googler @@ -14,19 +14,19 @@ source: https://github.com/tldr-pages/tldr.git - Search Google and open the first result in web browser: -`googler -j {{keyword}}` +`googler {{[-j|--first]}} {{keyword}}` - Show `n` search results (default: 10): -`googler -n {{n}} {{keyword}}` +`googler {{[-n|--count]}} {{n}} {{keyword}}` - Disable automatic spelling correction: -`googler -x {{keyword}}` +`googler {{[-x|--exact]}} {{keyword}}` - Search one site for a keyword: -`googler -w {{site}} {{keyword}}` +`googler {{[-w|--site]}} {{site}} {{keyword}}` - Show Google search result in JSON format: @@ -34,7 +34,7 @@ source: https://github.com/tldr-pages/tldr.git - Perform in-place self-upgrade: -`googler -u` +`googler {{[-u|--upgrade]}}` - Display help in interactive mode: diff --git a/tldr/goreload b/tldr/goreload index 8508e398..a2884e10 100644 --- a/tldr/goreload +++ b/tldr/goreload @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Watch a binary file (defaults to `.goreload`): -`goreload -b {{path/to/binary}} {{path/to/file.go}}` +`goreload {{[-b|--bin]}} {{path/to/binary}} {{path/to/file.go}}` - Set a custom log prefix (defaults to `goreload`): diff --git a/tldr/gotty b/tldr/gotty index 359da9e7..dc10b26a 100644 --- a/tldr/gotty +++ b/tldr/gotty @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - Share with write permission: -`gotty -w {{shell}}` +`gotty {{[-w|--permit-write]}} {{shell}}` - Share with credential (Basic Auth): -`gotty -w -c {{username}}:{{password}} {{shell}}` +`gotty {{[-w|--permit-write]}} {{[-c|--credential]}} {{username}}:{{password}} {{shell}}` diff --git a/tldr/gource b/tldr/gource index 9dec8ba4..98dfc0d1 100644 --- a/tldr/gource +++ b/tldr/gource @@ -17,18 +17,26 @@ source: https://github.com/tldr-pages/tldr.git `gource -{{width}}x{{height}}` -- Specify the timescale for the animation: - -`gource -c {{time_scale_multiplier}}` - - Specify how long each day should be in the animation (this combines with -c, if provided): -`gource -s {{seconds}}` +`gource {{[-s|--seconds-per-day]}} {{seconds}}` - Use fullscreen mode and a custom background color: -`gource -f -b {{hex_color_code}}` +`gource {{[-f|--fullscreen ]}} {{[-b|--background-colour]}} {{hex_color_code}}` - Specify the animation title: `gource --title {{title}}` + +- Pause the animation: + +`` + +- Adjust simulation speed: + +`<{{+|-}}>` + +- Display help: + +`gource {{[-h|--help]}}` diff --git a/tldr/gradle b/tldr/gradle index 4c809c25..54970fbe 100644 --- a/tldr/gradle +++ b/tldr/gradle @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Exclude test task: -`gradle build -x {{test}}` +`gradle build {{[-x|--exclude-task]}} {{test}}` - Run in offline mode to prevent Gradle from accessing the network during builds: diff --git a/tldr/grex b/tldr/grex index 8fb8d108..82b03caf 100644 --- a/tldr/grex +++ b/tldr/grex @@ -14,20 +14,20 @@ source: https://github.com/tldr-pages/tldr.git - Generate a case-insensitive regular expression: -`grex -i {{space_separated_strings}}` +`grex {{[-i|--ignore-case]}} {{space_separated_strings}}` - Replace digits with '\d': -`grex -d {{space_separated_strings}}` +`grex {{[-d|--digits]}} {{space_separated_strings}}` - Replace Unicode word character with '\w': -`grex -w {{space_separated_strings}}` +`grex {{[-w|--words]}} {{space_separated_strings}}` - Replace spaces with '\s': -`grex -s {{space_separated_strings}}` +`grex {{[-s|--spaces]}} {{space_separated_strings}}` - Add {min, max} quantifier representation for repeating sub-strings: -`grex -r {{space_separated_strings}}` +`grex {{[-r|--repetitions]}} {{space_separated_strings}}` diff --git a/tldr/hexyl b/tldr/hexyl index 3211fe8c..95aa3cf9 100644 --- a/tldr/hexyl +++ b/tldr/hexyl @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Print the hexadecimal representation of the first n bytes of a file: -`hexyl -n {{n}} {{path/to/file}}` +`hexyl {{[-n|--length]}} {{n}} {{path/to/file}}` - Print bytes 512 through 1024 of a file: diff --git a/tldr/hive b/tldr/hive index 19014e37..ae7fef28 100644 --- a/tldr/hive +++ b/tldr/hive @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Run a HiveQL file with a variable substitution: -`hive --define {{key}}={{value}} -f {{path/to/file.sql}}` +`hive {{[-d|--define]}} {{key}}={{value}} -f {{path/to/file.sql}}` - Run a HiveQL with HiveConfig (e.g. `mapred.reduce.tasks=32`): diff --git a/tldr/hledger b/tldr/hledger index 46bfe0d0..8dd6eb2b 100644 --- a/tldr/hledger +++ b/tldr/hledger @@ -19,24 +19,24 @@ source: https://github.com/tldr-pages/tldr.git - Print all transactions, reading from multiple specified journal files: -`hledger print --file {{path/to/prices-2024.journal}} --file {{path/to/prices-2023.journal}}` +`hledger print {{[-f|--file]}} {{path/to/prices-2024.journal}} {{[-f|--file]}} {{path/to/prices-2023.journal}}` - Show all accounts, as a hierarchy, and their types: -`hledger accounts --tree --types` +`hledger accounts {{[-t|--tree]}} --types` - Show asset and liability account balances, including zeros, hierarchically: -`hledger balancesheet --empty --tree --no-elide` +`hledger {{[bs|balancesheet]}} {{[-E|--empty]}} {{[-t|--tree]}} --no-elide` - Show monthly incomes/expenses/totals, largest first, summarised to 2 levels: -`hledger incomestatement --monthly --row-total --average --sort --depth 2` +`hledger {{[is|incomestatement]}} {{[-M|--monthly]}} {{[-T|--row-total]}} {{[-A|--average]}} --sort --depth 2` - Show the `assets:bank:checking` account's transactions and running balance: -`hledger aregister assets:bank:checking` +`hledger {{[areg|aregister]}} assets:bank:checking` - Show the amount spent on food from the `assets:cash` account: -`hledger print assets:cash | hledger -f- -I aregister expenses:food` +`hledger print assets:cash | hledger {{-f|--file}} - {{[-I|--ignore-assertions]}} aregister expenses:food` diff --git a/tldr/hledger-accounts b/tldr/hledger-accounts index 15034a48..5fb9f451 100644 --- a/tldr/hledger-accounts +++ b/tldr/hledger-accounts @@ -10,31 +10,31 @@ source: https://github.com/tldr-pages/tldr.git - Show all accounts used or declared in the default journal file: -`hledger accounts` +`hledger {{[acc|accounts]}}` - Show accounts used by transactions: -`hledger accounts --used` +`hledger {{[acc|accounts]}} {{[-u|--used]}}` - Show accounts declared with account directives: -`hledger accounts --declared` +`hledger {{[acc|accounts]}} {{[-d|--declared]}}` - Add new account directives, for accounts used but not declared, to the journal: -`hledger accounts --undeclared --directives >> {{2024-accounts.journal}}` +`hledger {{[acc|accounts]}} --undeclared --directives >> {{2024-accounts.journal}}` - Show accounts with `asset` in their name, and their declared/inferred types: -`hledger accounts asset --types` +`hledger {{[acc|accounts]}} asset --types` - Show accounts of the `Asset` type: -`hledger accounts type:A` +`hledger {{[acc|accounts]}} type:A` - Show the first two levels of the accounts hierarchy: -`hledger accounts --tree --depth 2` +`hledger {{[acc|accounts]}} {{[-t|--tree]}} --depth 2` - Short form of the above: diff --git a/tldr/hledger-add b/tldr/hledger-add index fbc060de..a10ff4b2 100644 --- a/tldr/hledger-add +++ b/tldr/hledger-add @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Add transactions to `2024.journal`, but also load `2023.journal` for completions: -`hledger add --file {{path/to/2024.journal}} --file {{path/to/2023.journal}}` +`hledger add {{[-f|--file]}} {{path/to/2024.journal}} {{[-f|--file]}} {{path/to/2023.journal}}` - Provide answers for the first four prompts: @@ -22,7 +22,7 @@ source: https://github.com/tldr-pages/tldr.git - Show `add`'s options and documentation with `$PAGER`: -`hledger add --help` +`hledger add {{[-h|--help]}}` - Show `add`'s documentation with `info` or `man` if available: diff --git a/tldr/hledger-aregister b/tldr/hledger-aregister index 9ac64cd9..73f45e8d 100644 --- a/tldr/hledger-aregister +++ b/tldr/hledger-aregister @@ -10,16 +10,16 @@ source: https://github.com/tldr-pages/tldr.git - Show transactions and running balance in the `assets:bank:checking` account: -`hledger aregister assets:bank:checking` +`hledger {{[areg|aregister]}} assets:bank:checking` - Show transactions and running balance in the first account named `*savings*`: -`hledger aregister savings` +`hledger {{[areg|aregister]}} savings` - Show the checking account's cleared transactions, with a specified width: -`hledger aregister checking --cleared --width {{120}}` +`hledger {{[areg|aregister]}} checking {{[-C|--cleared]}} {{[-w|--width]}} {{120}}` - Show the checking register, including transactions from forecast rules: -`hledger aregister checking --forecast` +`hledger {{[areg|aregister]}} checking --forecast` diff --git a/tldr/hledger-balance b/tldr/hledger-balance index 3f74e721..bc9d5d06 100644 --- a/tldr/hledger-balance +++ b/tldr/hledger-balance @@ -11,15 +11,15 @@ source: https://github.com/tldr-pages/tldr.git - Show the balance change in all accounts from all postings over all time: -`hledger balance` +`hledger {{[bal|balance]}}` - Show the balance change in accounts named `*expenses*`, as a tree, summarising the top two levels only: -`hledger balance {{expenses}} --tree --depth {{2}}` +`hledger {{[bal|balance]}} {{expenses}} {{[-t|--tree]}} --depth {{2}}` - Show expenses each month, and their totals and averages, sorted by total; and their monthly budget goals: -`hledger balance {{expenses}} --monthly --row-total --average --sort-amount --budget` +`hledger {{[bal|balance]}} {{expenses}} {{[-M|--monthly]}} {{[-T|--row-total]}} {{[-A|--average]}} {{[-S|--sort-amount]}} --budget` - Similar to the above, shorter form, matching accounts by `Expense` type, as a two level tree without squashing boring accounts: @@ -27,7 +27,7 @@ source: https://github.com/tldr-pages/tldr.git - Show end balances (including from postings before the start date), quarterly in 2024, in accounts named `*assets*` or `*liabilities*`: -`hledger balance --historical --period '{{quarterly in 2024}}' {{assets}} {{liabilities}}` +`hledger {{[bal|balance]}} {{[-H|--historical]}} {{[-p|--period]}} '{{quarterly in 2024}}' {{assets}} {{liabilities}}` - Similar to the above, shorter form; also show zero balances, sort by total and summarise to three levels: diff --git a/tldr/hledger-balancesheet b/tldr/hledger-balancesheet index 2d43d3dd..f627a14f 100644 --- a/tldr/hledger-balancesheet +++ b/tldr/hledger-balancesheet @@ -11,27 +11,27 @@ source: https://github.com/tldr-pages/tldr.git - Show the current balances in `Asset` and `Liability` accounts, excluding zeros: -`hledger balancesheet` +`hledger {{[bs|balancesheet]}}` - Show just the liquid assets (`Cash` account type): -`hledger balancesheet type:C` +`hledger {{[bs|balancesheet]}} type:C` - Include accounts with zero balances, and show the account hierarchy: -`hledger balancesheet --empty --tree` +`hledger {{[bs|balancesheet]}} {{[-E|--empty]}} {{[-t|--tree]}}` - Show the balances at the end of each month: -`hledger balancesheet --monthly` +`hledger {{[bs|balancesheet]}} {{[-M|--monthly]}}` - Show the balances' market value in home currency at the end of each month: -`hledger balancesheet --monthly -V` +`hledger {{[bs|balancesheet]}} {{[-M|--monthly]}} {{[-V|--market]}}` - Show quarterly balances, with just the top two levels of account hierarchy: -`hledger balancesheet --quarterly --tree --depth 2` +`hledger {{[bs|balancesheet]}} {{[-Qt|--quarterly --tree]}} {{[-2|--depth 2]}}` - Short form of the above, and generate HTML output in `bs.html`: diff --git a/tldr/hledger-import b/tldr/hledger-import index c12f6ca6..cad56c59 100644 --- a/tldr/hledger-import +++ b/tldr/hledger-import @@ -22,7 +22,7 @@ source: https://github.com/tldr-pages/tldr.git - Show conversion errors or results while editing `bank.csv.rules`: -`watchexec -- hledger -f {{path/to/bank.csv}} print` +`watchexec -- hledger {{[-f|--file]}} {{path/to/bank.csv}} print` - Mark `bank.csv`'s current data as seen, as if already imported: @@ -30,4 +30,4 @@ source: https://github.com/tldr-pages/tldr.git - Mark `bank.csv` as all new, as if not yet imported: -`rm -f .latest.bank.csv` +`rm {{[-f|--force]}} .latest.bank.csv` diff --git a/tldr/hledger-incomestatement b/tldr/hledger-incomestatement index 48cd4401..24d492e4 100644 --- a/tldr/hledger-incomestatement +++ b/tldr/hledger-incomestatement @@ -11,15 +11,15 @@ source: https://github.com/tldr-pages/tldr.git - Show revenues and expenses (changes in `Revenue` and `Expense` accounts): -`hledger incomestatement` +`hledger {{[is|incomestatement]}}` - Show revenues and expenses each month: -`hledger incomestatement --monthly` +`hledger {{[is|incomestatement]}} {{[-M|--monthly]}}` - Show monthly revenues/expenses/totals, largest first, summarised to 2 levels: -`hledger incomestatement --monthly --row-total --average --sort --depth 2` +`hledger {{[is|incomestatement]}} {{[-MTAS|--monthly --row-total --average --sort-amount]}} {{[-2|--depth 2]}}` - Short form of the above, and generate HTML output in `is.html`: diff --git a/tldr/hledger-print b/tldr/hledger-print index f683851e..384e0ca3 100644 --- a/tldr/hledger-print +++ b/tldr/hledger-print @@ -14,11 +14,11 @@ source: https://github.com/tldr-pages/tldr.git - Show transactions, with any implied amounts or costs made explicit: -`hledger print --explicit --infer-costs` +`hledger print {{[-x|--explicit]}} --infer-costs` - Show transactions from two specified files, with amounts converted to cost: -`hledger print --file {{path/to/2023.journal}} --file {{path/to/2024.journal}} --cost` +`hledger print {{[-f|--file]}} {{path/to/2023.journal}} {{[-f|--file]}} {{path/to/2024.journal}} {{[-B|--cost]}}` - Show `$` transactions in `*food*` but not `*groceries*` accounts this month: @@ -30,8 +30,8 @@ source: https://github.com/tldr-pages/tldr.git - Show cleared transactions, with `EUR` amounts rounded and with decimal commas: -`hledger print --cleared --commodity '1000, EUR' --round hard` +`hledger print {{[-C|--cleared]}} --commodity '1000, EUR' --round hard` - Write transactions from `foo.journal` as a CSV file: -`hledger print --file {{path/to/foo.journal}} --output-file {{path/to/output_file.csv}}` +`hledger print {{[-f|--file]}} {{path/to/foo.journal}} {{[-o|--output-file]}} {{path/to/output_file.csv}}` diff --git a/tldr/hledger-ui b/tldr/hledger-ui index b42550a1..ded3d81d 100644 --- a/tldr/hledger-ui +++ b/tldr/hledger-ui @@ -18,15 +18,15 @@ source: https://github.com/tldr-pages/tldr.git - Start in the balance sheet accounts screen, showing hierarchy down to level 3: -`hledger-ui --bs --tree --depth 3` +`hledger-ui --bs {{[-t|--tree]}} --depth 3` - Start in this account's screen, showing cleared transactions, and reload on change: -`hledger-ui --register {{assets:bank:checking}} --cleared --watch` +`hledger-ui --register {{assets:bank:checking}} {{[-C|--cleared]}} {{[-w|--watch]}}` - Read two journal files, and show amounts as current value when known: -`hledger-ui --file {{path/to/2024.journal}} --file {{path/to/2024-prices.journal}} --value now` +`hledger-ui {{[-f|--file]}} {{path/to/2024.journal}} {{[-f|--file]}} {{path/to/2024-prices.journal}} --value now` - Show the manual in Info format, if possible: @@ -34,4 +34,4 @@ source: https://github.com/tldr-pages/tldr.git - Display help: -`hledger-ui --help` +`hledger-ui {{[-h|--help]}}` diff --git a/tldr/hledger-web b/tldr/hledger-web index a21c027c..14702b69 100644 --- a/tldr/hledger-web +++ b/tldr/hledger-web @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - As above but with a specified file, and allow editing of existing data: -`hledger-web --file {{path/to/file.journal}} --allow edit` +`hledger-web {{[-f|--file]}} {{path/to/file.journal}} --allow edit` - Start just the web app, and accept incoming connections to the specified host and port: @@ -34,4 +34,4 @@ source: https://github.com/tldr-pages/tldr.git - Display help: -`hledger-web --help` +`hledger-web {{[-h|--help]}}` diff --git a/tldr/http-server b/tldr/http-server index df4c9349..17aae34b 100644 --- a/tldr/http-server +++ b/tldr/http-server @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Start an HTTP server on a specific port to serve a specific directory: -`http-server {{path/to/directory}} --port {{port}}` +`http-server {{path/to/directory}} {{[-p|--port]}} {{port}}` - Start an HTTP server using basic authentication: @@ -26,7 +26,7 @@ source: https://github.com/tldr-pages/tldr.git - Start an HTTPS server on the default port using the specified certificate: -`http-server --ssl --cert {{path/to/cert.pem}} --key {{path/to/key.pem}}` +`http-server {{[-S|--ssl]}} {{[-C|--cert]}} {{path/to/cert.pem}} {{[-K|--key]}} {{path/to/key.pem}}` - Start an HTTP server and include the client's IP address in the output logging: @@ -38,4 +38,4 @@ source: https://github.com/tldr-pages/tldr.git - Start an HTTP server with logging disabled: -`http-server --silent` +`http-server {{[-s|--silent]}}` diff --git a/tldr/hyperfine b/tldr/hyperfine index 54bd98f2..e8eeeb40 100644 --- a/tldr/hyperfine +++ b/tldr/hyperfine @@ -18,16 +18,16 @@ source: https://github.com/tldr-pages/tldr.git - Change minimum number of benchmarking runs: -`hyperfine --min-runs {{7}} '{{make}}'` +`hyperfine {{[-m|--min-runs]}} {{7}} '{{make}}'` - Perform benchmark with warmup: -`hyperfine --warmup {{5}} '{{make}}'` +`hyperfine {{[-w|--warmup]}} {{5}} '{{make}}'` - Run a command before each benchmark run (to clear caches, etc.): -`hyperfine --prepare '{{make clean}}' '{{make}}'` +`hyperfine {{[-p|--prepare]}} '{{make clean}}' '{{make}}'` - Run a benchmark where a single parameter changes for each run: -`hyperfine --prepare '{{make clean}}' --parameter-scan {{num_threads}} {{1}} {{10}} '{{make -j {num_threads}}}'` +`hyperfine {{[-p|--prepare]}} '{{make clean}}' {{[-P|--parameter-scan]}} {{num_threads}} {{1}} {{10}} '{{make {{[-j|--jobs]}} {num_threads}}}'` diff --git a/tldr/iconv b/tldr/iconv index d88f7ff9..4f26026e 100644 --- a/tldr/iconv +++ b/tldr/iconv @@ -10,12 +10,12 @@ source: https://github.com/tldr-pages/tldr.git - Convert file to a specific encoding, and print to `stdout`: -`iconv -f {{from_encoding}} -t {{to_encoding}} {{input_file}}` +`iconv {{[-f|--from-code]}} {{from_encoding}} {{[-t|--to-code]}} {{to_encoding}} {{input_file}}` - Convert file to the current locale's encoding, and output to a file: -`iconv -f {{from_encoding}} {{input_file}} > {{output_file}}` +`iconv {{[-f|--from-code]}} {{from_encoding}} {{input_file}} > {{output_file}}` - List supported encodings: -`iconv -l` +`iconv {{[-l|--list]}}` diff --git a/tldr/impacket-ping b/tldr/impacket-ping new file mode 100644 index 00000000..c93b5295 --- /dev/null +++ b/tldr/impacket-ping @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# impacket-ping + +> This command is an alias of `ping.py`. + +- View documentation for the original command: + +`tldr ping.py` diff --git a/tldr/impacket-ping6 b/tldr/impacket-ping6 new file mode 100644 index 00000000..fe284961 --- /dev/null +++ b/tldr/impacket-ping6 @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# impacket-ping6 + +> This command is an alias of `ping6.py`. + +- View documentation for the original command: + +`tldr ping6.py` diff --git a/tldr/in-toto-record b/tldr/in-toto-record index d225724d..3d5026fb 100644 --- a/tldr/in-toto-record +++ b/tldr/in-toto-record @@ -10,8 +10,8 @@ source: https://github.com/tldr-pages/tldr.git - Start the record (creates a preliminary link file): -`in-toto-record start -n {{path/to/edit_file1 path/to/edit_file2 ...}} -k {{path/to/key_file}} -m {{.}}` +`in-toto-record start {{[-n|--step-name]}} {{path/to/edit_file1 path/to/edit_file2 ...}} -k {{path/to/key_file}} {{[-m|--materials]}} {{.}}` - Stop the record (expects a preliminary link file): -`in-toto-record stop -n {{path/to/edit_file1 path/to/edit_file2 ...}} -k {{path/to/key_file}} -p {{.}}` +`in-toto-record stop {{[-n|--step-name]}} {{path/to/edit_file1 path/to/edit_file2 ...}} -k {{path/to/key_file}} {{[-p|--products]}} {{.}}` diff --git a/tldr/in-toto-run b/tldr/in-toto-run index 8e522e8a..3d9c3c30 100644 --- a/tldr/in-toto-run +++ b/tldr/in-toto-run @@ -10,16 +10,16 @@ source: https://github.com/tldr-pages/tldr.git - Tag a Git repo and signing the resulting link file: -`in-toto-run -n {{tag}} --products {{.}} -k {{key_file}} -- {{git tag v1.0}}` +`in-toto-run {{[-n|--step-name]}} {{tag}} {{[-p|--products]}} {{.}} -k {{key_file}} -- {{git tag v1.0}}` - Create a tarball, storing files as materials and the tarball as product: -`in-toto-run -n {{package}} -m {{project}} -p {{project.tar.gz}} -- {{tar czf project.tar.gz project}}` +`in-toto-run {{[-n|--step-name]}} {{package}} {{[-m|--materials]}} {{project}} {{[-p|--products]}} {{project.tar.gz}} -- {{tar czf project.tar.gz project}}` - Generate signed attestations for review work: -`in-toto-run -n {{review}} -k {{key_file}} -m {{document.pdf}} -x` +`in-toto-run {{[-n|--step-name]}} {{review}} -k {{key_file}} {{[-m|--materials]}} {{document.pdf}} {{[-x|--no-command]}}` - Scan the image using Trivy and generate link file: -`in-toto-run -n {{scan}} -k {{key_file}} -p {{report.json}} -- {{/bin/sh -c "trivy -o report.json -f json "}}` +`in-toto-run {{[-n|--step-name]}} {{scan}} -k {{key_file}} {{[-p|--products]}} {{report.json}} -- {{/bin/sh -c "trivy {{[-o|--output]}} report.json {{[-f|--format]}} json "}}` diff --git a/tldr/in-toto-sign b/tldr/in-toto-sign index 876c902a..bf001b9a 100644 --- a/tldr/in-toto-sign +++ b/tldr/in-toto-sign @@ -10,20 +10,20 @@ source: https://github.com/tldr-pages/tldr.git - Sign 'unsigned.layout' with two keys and write it to 'root.layout': -`in-toto-sign -f {{unsigned.layout}} -k {{priv_key1}} {{priv_key2}} -o {{root.layout}}` +`in-toto-sign {{[-f|--file]}} {{unsigned.layout}} {{[-k|--keep]}} {{priv_key1}} {{priv_key2}} {{[-o|--output]}} {{root.layout}}` - Replace signature in link file and write to default filename: -`in-toto-sign -f {{package.2f89b927.link}} -k {{priv_key}}` +`in-toto-sign {{[-f|--file]}} {{package.2f89b927.link}} {{[-k|--keep]}} {{priv_key}}` - Verify a layout signed with 3 keys: -`in-toto-sign -f {{root.layout}} -k {{pub_key0}} {{pub_key1}} {{pub_key2}} --verify` +`in-toto-sign {{[-f|--file]}} {{root.layout}} {{[-k|--keep]}} {{pub_key0}} {{pub_key1}} {{pub_key2}} --verify` - Sign a layout with the default GPG key in default GPG keyring: -`in-toto-sign -f {{root.layout}} --gpg` +`in-toto-sign {{[-f|--file]}} {{root.layout}} {{[-g|--gpg]}}` - Verify a layout with a GPG key identified by keyid '...439F3C2': -`in-toto-sign -f {{root.layout}} --verify --gpg {{...439F3C2}}` +`in-toto-sign {{[-f|--file]}} {{root.layout}} --verify {{[-g|--gpg]}} {{...439F3C2}}` diff --git a/tldr/in2csv b/tldr/in2csv index de19ea60..62c6b5a6 100644 --- a/tldr/in2csv +++ b/tldr/in2csv @@ -23,4 +23,4 @@ source: https://github.com/tldr-pages/tldr.git - Pipe a JSON file to in2csv: -`cat {{data.json}} | in2csv -f json > {{data.csv}}` +`cat {{data.json}} | in2csv {{[-f|--format]}} json > {{data.csv}}` diff --git a/tldr/inkscape b/tldr/inkscape index 76ceac19..72c55c44 100644 --- a/tldr/inkscape +++ b/tldr/inkscape @@ -11,28 +11,28 @@ source: https://github.com/tldr-pages/tldr.git - Open an SVG file in the Inkscape GUI: -`inkscape {{path/to/filename.svg}}` +`inkscape {{path/to/file.svg}}` - Export an SVG file into a bitmap with the default format (PNG) and the default resolution (96 DPI): -`inkscape {{path/to/filename.svg}} -o {{path/to/filename.png}}` +`inkscape {{path/to/file.svg}} {{[-o|--export-filename]}} {{path/to/filename.png}}` - Export an SVG file into a bitmap of 600x400 pixels (aspect ratio distortion may occur): -`inkscape {{path/to/filename.svg}} -o {{path/to/filename.png}} -w {{600}} -h {{400}}` +`inkscape {{path/to/file.svg}} {{[-o|--export-filename]}} {{path/to/filename.png}} {{[-w|--export-width]}} {{600}} {{[-h|--export-height]}} {{400}}` - Export the drawing (bounding box of all objects) of an SVG file into a bitmap: -`inkscape {{path/to/filename.svg}} -o {{path/to/filename.png}} -D` +`inkscape {{path/to/file.svg}} {{[-o|--export-filename]}} {{path/to/filename.png}} {{[-D|--export-area-drawing]}}` - Export a single object, given its ID, into a bitmap: -`inkscape {{path/to/filename.svg}} -i {{id}} -o {{object.png}}` +`inkscape {{path/to/file.svg}} {{[-i|--export-id]}} {{id}} {{[-o|--export-filename]}} {{object.png}}` - Export an SVG document to PDF, converting all texts to paths: -`inkscape {{path/to/filename.svg}} -o {{path/to/filename.pdf}} --export-text-to-path` +`inkscape {{path/to/file.svg}} {{[-o|--export-filename]}} {{path/to/filename.pdf}} {{[-T|--export-text-to-path]}}` - Duplicate the object with id="path123", rotate the duplicate 90 degrees, save the file, and quit Inkscape: -`inkscape {{path/to/filename.svg}} --select=path123 --verb="{{EditDuplicate;ObjectRotate90;FileSave;FileQuit}}"` +`inkscape {{path/to/file.svg}} --select=path123 --verb="{{EditDuplicate;ObjectRotate90;FileSave;FileQuit}}"` diff --git a/tldr/interdiff b/tldr/interdiff index b1a22f26..ffb85648 100644 --- a/tldr/interdiff +++ b/tldr/interdiff @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Compare diff files, ignoring whitespace: -`interdiff -w {{old_file}} {{new_file}}` +`interdiff {{[-w|--ignore-all-space]}} {{old_file}} {{new_file}}` diff --git a/tldr/ioping b/tldr/ioping index 85592af5..a6bf0612 100644 --- a/tldr/ioping +++ b/tldr/ioping @@ -14,12 +14,12 @@ source: https://github.com/tldr-pages/tldr.git - Measure latency on /tmp using 10 requests of 1 megabyte each: -`ioping -c 10 -s 1M /tmp` +`ioping {{[-c|-count]}} 10 {{[-s|-size]}} 1M /tmp` - Measure disk seek rate on `/dev/sdX`: -`ioping -R {{/dev/sdX}}` +`ioping {{[-R|-rapid]}} {{/dev/sdX}}` - Measure disk sequential speed on `/dev/sdX`: -`ioping -RL {{/dev/sdX}}` +`ioping {{[-RL|-rapid -linear]}} {{/dev/sdX}}` diff --git a/tldr/ipcalc b/tldr/ipcalc new file mode 100644 index 00000000..511a202b --- /dev/null +++ b/tldr/ipcalc @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ipcalc + +> A tool to calculate IP information (subnet, broadcast, host range) from an IP address and netmask. +> More information: . + +- Display network info for an IP address: + +`ipcalc {{192.168.0.1}}` + +- Display network info using CIDR notation: + +`ipcalc {{192.168.0.1/24}}` + +- Display network info using a separate netmask: + +`ipcalc {{192.168.0.1}} {{255.255.255.0}}` + +- Show only CIDR notation output: + +`ipcalc {{[-c|--class]}} {{192.168.0.1/24}}` + +- Show version information: + +`ipcalc --version` diff --git a/tldr/ippfind b/tldr/ippfind index bb3f6a1b..dfefc1d3 100644 --- a/tldr/ippfind +++ b/tldr/ippfind @@ -11,16 +11,16 @@ source: https://github.com/tldr-pages/tldr.git - List IPP printers registered on the network with their status: -`ippfind --ls` +`ippfind {{[-l|--ls]}}` - Send a specific PostScript document to every PostScript printer on the network: -`ippfind --txt-pdl application/postscript --exec ipptool -f {{path/to/document.ps}} '{}' print-job.test \;` +`ippfind --txt-pdl application/postscript {{[-x|--exec]}} ipptool -f {{path/to/document.ps}} '{}' print-job.test \;` - Send a PostScript test document to every PostScript printer on the network: -`ippfind --txt-pdl application/postscript --exec ipptool -f onepage-letter.ps '{}' print-job.test \;` +`ippfind --txt-pdl application/postscript {{[-x|--exec]}} ipptool -f onepage-letter.ps '{}' print-job.test \;` - Send a PostScript test document to every PostScript printer on the network, whose name matches a regular expression: -`ippfind --txt-pdl application/postscript --host {{regex}} --exec ipptool -f onepage-letter.ps '{}' print-job.test \;` +`ippfind --txt-pdl application/postscript {{[-h|--host]}} {{regex}} {{[-x|--exec]}} ipptool -f onepage-letter.ps '{}' print-job.test \;` diff --git a/tldr/irssi b/tldr/irssi index 5eee6a33..6b504fe0 100644 --- a/tldr/irssi +++ b/tldr/irssi @@ -10,15 +10,15 @@ source: https://github.com/tldr-pages/tldr.git - Open Irssi and connect to a server with a nickname: -`irssi -n {{nickname}} -c {{irc.example.com}}` +`irssi {{[-n|--nick]}} {{nickname}} {{[-c|--connect]}} {{irc.example.com}}` - Open Irssi and connect with a specific server on a given port: -`irssi -c {{irc.example.com}} -p {{port}}` +`irssi {{[-c|--connect]}} {{irc.example.com}} {{[-p|--port]}} {{port}}` - Display help: -`irssi --help` +`irssi {{[-?|--help]}}` - Join a channel: diff --git a/tldr/jc b/tldr/jc index c4d8bbe9..51a25377 100644 --- a/tldr/jc +++ b/tldr/jc @@ -18,8 +18,8 @@ source: https://github.com/tldr-pages/tldr.git - Output pretty JSON via pipe: -`{{ifconfig}} | jc {{--ifconfig}} -p` +`{{ifconfig}} | jc {{--ifconfig}} {{[-p|--pretty]}}` - Output pretty JSON via magic syntax: -`jc -p {{ifconfig}}` +`jc {{[-p|--pretty]}} {{ifconfig}}` diff --git a/tldr/jhat b/tldr/jhat index 15eb1d3f..6f9e053e 100644 --- a/tldr/jhat +++ b/tldr/jhat @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Analyze a heap dump, specifying an alternate port for the HTTP server: -`jhat -p {{port}} {{dump_file.bin}}` +`jhat {{[-p|-port]}} {{port}} {{dump_file.bin}}` - Analyze a dump letting `jhat` use up to 8 GB RAM (2-4x dump size recommended): diff --git a/tldr/jmtpfs b/tldr/jmtpfs index 49d177be..edf4950f 100644 --- a/tldr/jmtpfs +++ b/tldr/jmtpfs @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - List available MTP devices: -`jmtpfs --listDevices` +`jmtpfs {{[-l|--listDevices]}}` - If multiple devices are present, mount a specific device: diff --git a/tldr/jq b/tldr/jq index 2383b61c..373fd370 100644 --- a/tldr/jq +++ b/tldr/jq @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Execute a specific script: -`{{cat path/to/file.json}} | jq --from-file {{path/to/script.jq}}` +`{{cat path/to/file.json}} | jq {{[-f|--from-file]}} {{path/to/script.jq}}` - Pass specific arguments: diff --git a/tldr/jtbl b/tldr/jtbl index 600a5b94..baf0013a 100644 --- a/tldr/jtbl +++ b/tldr/jtbl @@ -18,8 +18,8 @@ source: https://github.com/tldr-pages/tldr.git - Print a table and truncate rows instead of wrapping: -`cat {{file.json}} | jtbl -t` +`cat {{file.json}} | jtbl {{[-t|--truncate]}}` - Print a table and don't wrap or truncate rows: -`cat {{file.json}} | jtbl -n` +`cat {{file.json}} | jtbl {{[-n|--no-wrap]}}` diff --git a/tldr/julia b/tldr/julia index 72698663..bd8f2ca5 100644 --- a/tldr/julia +++ b/tldr/julia @@ -22,16 +22,16 @@ source: https://github.com/tldr-pages/tldr.git - Evaluate a string containing Julia code: -`julia -e '{{julia_code}}'` +`julia {{[-e|--eval]}} '{{julia_code}}'` - Evaluate a string of Julia code, passing arguments to it: -`julia -e '{{for x in ARGS; println(x); end}}' {{arguments}}` +`julia {{[-e|--eval]}} '{{for x in ARGS; println(x); end}}' {{arguments}}` - Evaluate an expression and print the result: -`julia -E '{{(1 - cos(pi/4))/2}}'` +`julia {{[-E|--print]}} '{{(1 - cos(pi/4))/2}}'` - Start Julia in multithreaded mode, using `n` threads: -`julia -t {{n}}` +`julia {{[-t|--threads]}} {{n}}` diff --git a/tldr/just.1 b/tldr/just.1 index ad09ac31..166e2cc5 100644 --- a/tldr/just.1 +++ b/tldr/just.1 @@ -18,11 +18,11 @@ source: https://github.com/tldr-pages/tldr.git - Edit justfile in the default editor: -`just -e` +`just {{[-e|--edit]}}` - List available recipes in the justfile: -`just -l` +`just {{[-l|--list]}}` - Print justfile: diff --git a/tldr/jwt b/tldr/jwt index 84082815..888bb842 100644 --- a/tldr/jwt +++ b/tldr/jwt @@ -15,12 +15,12 @@ source: https://github.com/tldr-pages/tldr.git - Decode a JWT as a JSON string: -`jwt decode -j {{jwt_string}}` +`jwt decode {{[-j|--json]}} {{jwt_string}}` - Encode a JSON string to a JWT: -`jwt encode --alg {{HS256}} --secret {{1234567890}} '{{json_string}}'` +`jwt encode {{[-A|--alg]}} {{HS256}} {{[-S|--secret]}} {{1234567890}} '{{json_string}}'` - Encode key pair payload to JWT: -`jwt encode --alg {{HS256}} --secret {{1234567890}} -P {{key=value}}` +`jwt encode {{[-A|--alg]}} {{HS256}} {{[-S|--secret]}} {{1234567890}} {{[-P|--payload]}} {{key=value}}` diff --git a/tldr/k6 b/tldr/k6 index b28a9f2c..fca3c6b3 100644 --- a/tldr/k6 +++ b/tldr/k6 @@ -14,15 +14,15 @@ source: https://github.com/tldr-pages/tldr.git - Run load test locally with a given number of virtual users and duration: -`k6 run --vus {{10}} --duration {{30s}} {{script.js}}` +`k6 run {{[-u|--vus]}} {{10}} {{[-d|--duration]}} {{30s}} {{script.js}}` - Run load test locally with a given environment variable: -`k6 run -e {{HOSTNAME=example.com}} {{script.js}}` +`k6 run {{[-e|--env]}} {{HOSTNAME=example.com}} {{script.js}}` - Run load test locally using InfluxDB to store results: -`k6 run --out influxdb={{http://localhost:8086/k6db}} {{script.js}}` +`k6 run {{[-o|--out]}} influxdb={{http://localhost:8086/k6db}} {{script.js}}` - Run load test locally and discard response bodies (significantly faster): diff --git a/tldr/k8s-unused-secret-detector b/tldr/k8s-unused-secret-detector index 81988c00..2e19cd77 100644 --- a/tldr/k8s-unused-secret-detector +++ b/tldr/k8s-unused-secret-detector @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - Detect unused secrets in a specific namespace: -`k8s-unused-secret-detector -n {{namespace}}` +`k8s-unused-secret-detector {{[-n|--namespace]}} {{namespace}}` - Delete unused secrets in a specific namespace: -`k8s-unused-secret-detector -n {{namespace}} | kubectl delete secret -n {{namespace}}` +`k8s-unused-secret-detector {{[-n|--namespace]}} {{namespace}} | kubectl delete secret {{[-n|--namespace]}} {{namespace}}` diff --git a/tldr/k8sec b/tldr/k8sec index 56d2878a..9532404b 100644 --- a/tldr/k8sec +++ b/tldr/k8sec @@ -30,8 +30,8 @@ source: https://github.com/tldr-pages/tldr.git - Load secrets from a file: -`k8sec load -f {{path/to/file}} {{secret_name}}` +`k8sec load {{[-f|--filename]}} {{path/to/file}} {{secret_name}}` - Dump secrets to a file: -`k8sec dump -f {{path/to/file}} {{secret_name}}` +`k8sec dump {{[-f|--filename]}} {{path/to/file}} {{secret_name}}` diff --git a/tldr/kaggle b/tldr/kaggle index b86adfdc..ac0ec265 100644 --- a/tldr/kaggle +++ b/tldr/kaggle @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Download a specific file from a competition dataset: -`kaggle competitions download {{competition}} -f {{filename}}` +`kaggle competitions download {{competition}} {{[-f|--file]}} {{filename}}` diff --git a/tldr/kismet b/tldr/kismet index be2e8e2e..2d5d3eb2 100644 --- a/tldr/kismet +++ b/tldr/kismet @@ -22,7 +22,7 @@ source: https://github.com/tldr-pages/tldr.git - Start Kismet with a specific configuration file: -`sudo kismet -c {{wlan0}} -f {{path/to/config.conf}}` +`sudo kismet -c {{wlan0}} {{[-f|--config-file]}} {{path/to/config.conf}}` - Monitor and log data to an SQLite database: diff --git a/tldr/kompose b/tldr/kompose index 300469d5..057cc79d 100644 --- a/tldr/kompose +++ b/tldr/kompose @@ -10,12 +10,12 @@ source: https://github.com/tldr-pages/tldr.git - Deploy a dockerized application to Kubernetes: -`kompose up -f {{docker-compose.yml}}` +`kompose up {{[-f|--file]}} {{docker-compose.yml}}` - Delete instantiated services/deployments from Kubernetes: -`kompose down -f {{docker-compose.yml}}` +`kompose down {{[-f|--file]}} {{docker-compose.yml}}` - Convert a docker-compose file into Kubernetes resources file: -`kompose convert -f {{docker-compose.yml}}` +`kompose convert {{[-f|--file]}} {{docker-compose.yml}}` diff --git a/tldr/kops b/tldr/kops index 6e8ded4b..cb9d063a 100644 --- a/tldr/kops +++ b/tldr/kops @@ -10,11 +10,11 @@ source: https://github.com/tldr-pages/tldr.git - Create a cluster from the configuration specification: -`kops create cluster -f {{cluster_name.yaml}}` +`kops create cluster {{[-f|--filename]}} {{cluster_name.yaml}}` - Create a new SSH public key: -`kops create secret sshpublickey {{key_name}} -i {{~/.ssh/id_rsa.pub}}` +`kops create sshpublickey {{key_name}} {{[-i|--ssh-public-key]}} {{~/.ssh/id_rsa.pub}}` - Export the cluster configuration to the `~/.kube/config` file: @@ -22,11 +22,11 @@ source: https://github.com/tldr-pages/tldr.git - Get the cluster configuration as YAML: -`kops get cluster {{cluster_name}} -o yaml` +`kops get cluster {{cluster_name}} {{[-o|--output]}} yaml` - Delete a cluster: -`kops delete cluster {{cluster_name}} --yes` +`kops delete cluster {{cluster_name}} {{[-y|--yes]}}` - Validate a cluster: diff --git a/tldr/kube-capacity b/tldr/kube-capacity index a1300cde..c62d4128 100644 --- a/tldr/kube-capacity +++ b/tldr/kube-capacity @@ -15,8 +15,8 @@ source: https://github.com/tldr-pages/tldr.git - Include pods: -`kube-capacity -p` +`kube-capacity {{[-p|--pods]}}` - Include utilization: -`kube-capacity -u` +`kube-capacity {{[-u|--util]}}` diff --git a/tldr/kubectl b/tldr/kubectl index 743ed26f..9163b91e 100644 --- a/tldr/kubectl +++ b/tldr/kubectl @@ -11,7 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - List information about a resource with more details: -`kubectl get {{pod|service|deployment|ingress|...}} -o wide` +`kubectl get {{pod|service|deployment|ingress|...}} {{[-o|--output]}} wide` - Update specified pod with the label 'unhealthy' and the value 'true': diff --git a/tldr/kubectl-apply b/tldr/kubectl-apply index f50d1271..f924ccc4 100644 --- a/tldr/kubectl-apply +++ b/tldr/kubectl-apply @@ -11,16 +11,16 @@ source: https://github.com/tldr-pages/tldr.git - Apply a configuration to a resource by file name or `stdin`: -`kubectl apply -f {{resource_filename}}` +`kubectl apply {{[-f|--filename]}} {{resource_filename}}` - Edit the latest last-applied-configuration annotations of resources from the default editor: -`kubectl apply edit-last-applied -f {{resource_filename}}` +`kubectl apply edit-last-applied {{[-f|--filename]}} {{resource_filename}}` - Set the latest last-applied-configuration annotations by setting it to match the contents of a file: -`kubectl apply set-last-applied -f {{resource_filename}}` +`kubectl apply set-last-applied {{[-f|--filename]}} {{resource_filename}}` - View the latest last-applied-configuration annotations by type/name or file: -`kubectl apply view-last-applied -f {{resource_filename}}` +`kubectl apply view-last-applied {{[-f|--filename]}} {{resource_filename}}` diff --git a/tldr/kubectl-create b/tldr/kubectl-create index 5aed4a28..411ce7fb 100644 --- a/tldr/kubectl-create +++ b/tldr/kubectl-create @@ -10,11 +10,11 @@ source: https://github.com/tldr-pages/tldr.git - Create a resource using the resource definition file: -`kubectl create -f {{path/to/file.yml}}` +`kubectl create {{[-f|--filename]}} {{path/to/file.yml}}` - Create a resource from `stdin`: -`kubectl create -f -` +`kubectl create {{[-f|--filename]}} -` - Create a deployment: diff --git a/tldr/kubectl-delete b/tldr/kubectl-delete index a7daaa04..35ffc2d8 100644 --- a/tldr/kubectl-delete +++ b/tldr/kubectl-delete @@ -34,4 +34,4 @@ source: https://github.com/tldr-pages/tldr.git - Delete resources defined in a YAML manifest: -`kubectl delete --filename {{path/to/manifest.yaml}}` +`kubectl delete {{[-f|--filename]}} {{path/to/manifest.yaml}}` diff --git a/tldr/kubectl-edit b/tldr/kubectl-edit index 6d94589f..5a56fec0 100644 --- a/tldr/kubectl-edit +++ b/tldr/kubectl-edit @@ -26,4 +26,4 @@ source: https://github.com/tldr-pages/tldr.git - Edit a resource in JSON format: -`kubectl edit {{resource}}/{{resource_name}} --output json` +`kubectl edit {{resource}}/{{resource_name}} {{[-o|--output]}} json` diff --git a/tldr/kubectl-expose b/tldr/kubectl-expose index 890d673f..d6e34e58 100644 --- a/tldr/kubectl-expose +++ b/tldr/kubectl-expose @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Create a service for a resource identified by a file: -`kubectl expose -f {{path/to/file.yml}} --port={{node_port}} --target-port={{container_port}}` +`kubectl expose {{[-f|--filename]}} {{path/to/file.yml}} --port={{node_port}} --target-port={{container_port}}` - Create a service with a name, to serve to a node port which will be same for container port: diff --git a/tldr/kubectl-label b/tldr/kubectl-label index fbd5dd35..77c290a4 100644 --- a/tldr/kubectl-label +++ b/tldr/kubectl-label @@ -22,7 +22,7 @@ source: https://github.com/tldr-pages/tldr.git - Label a pod identified by the pod definition file: -`kubectl label -f {{pod_definition_file}} {{key}}={{value}}` +`kubectl label {{[-f|--filename]}} {{pod_definition_file}} {{key}}={{value}}` - Remove the label from a pod: diff --git a/tldr/kubectl-logs b/tldr/kubectl-logs index b7c43044..957e0b0d 100644 --- a/tldr/kubectl-logs +++ b/tldr/kubectl-logs @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Show logs for a specified container in a pod: -`kubectl logs --container {{container_name}} {{pod_name}}` +`kubectl logs {{[-c|--container]}} {{container_name}} {{pod_name}}` - Show logs for all containers in a pod: @@ -22,7 +22,7 @@ source: https://github.com/tldr-pages/tldr.git - Stream pod logs: -`kubectl logs --follow {{pod_name}}` +`kubectl logs {{[-f|--follow]}} {{pod_name}}` - Show pod logs newer than a relative time like `10s`, `5m`, or `1h`: diff --git a/tldr/kubectl-replace b/tldr/kubectl-replace index 6f693a80..dd41e7c0 100644 --- a/tldr/kubectl-replace +++ b/tldr/kubectl-replace @@ -10,12 +10,12 @@ source: https://github.com/tldr-pages/tldr.git - Replace the resource using the resource definition file: -`kubectl replace -f {{path/to/file.yml}}` +`kubectl replace {{[-f|--filename]}} {{path/to/file.yml}}` - Replace the resource using the input passed into `stdin`: -`kubectl replace -f -` +`kubectl replace {{[-f|--filename]}} -` - Force replace, delete and then re-create the resource: -`kubectl replace --force -f {{path/to/file.yml}}` +`kubectl replace --force {{[-f|--filename]}} {{path/to/file.yml}}` diff --git a/tldr/kubectl-scale b/tldr/kubectl-scale index 75037396..8250a4cd 100644 --- a/tldr/kubectl-scale +++ b/tldr/kubectl-scale @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Scale a resource identified by a file: -`kubectl scale --replicas={{number_of_replicas}} -f {{path/to/file.yml}}` +`kubectl scale --replicas={{number_of_replicas}} {{[-f|--filename]}} {{path/to/file.yml}}` - Scale a deployment based on current number of replicas: diff --git a/tldr/kubectx b/tldr/kubectx index d6789f19..c617ec01 100644 --- a/tldr/kubectx +++ b/tldr/kubectx @@ -26,7 +26,7 @@ source: https://github.com/tldr-pages/tldr.git - Show the current named context: -`kubectx -c` +`kubectx {{[-c|--current]}}` - Delete a named context: diff --git a/tldr/kubetail b/tldr/kubetail index c8d0d64a..4427d459 100644 --- a/tldr/kubetail +++ b/tldr/kubetail @@ -14,11 +14,11 @@ source: https://github.com/tldr-pages/tldr.git - Tail only a specific container from multiple pods: -`kubetail {{my_app}} -c {{my_container}}` +`kubetail {{my_app}} {{[-c|--container]}} {{my_container}}` - To tail multiple containers from multiple pods: -`kubetail {{my_app}} -c {{my_container_1}} -c {{my_container_2}}` +`kubetail {{my_app}} {{[-c|--container]}} {my_container_1}} {{[-c|--container]}} {my_container_2}}` - To tail multiple applications at the same time separate them by comma: diff --git a/tldr/kustomize b/tldr/kustomize index d4ee555b..f7e72430 100644 --- a/tldr/kustomize +++ b/tldr/kustomize @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Build a kustomization file and deploy it with `kubectl`: -`kustomize build . | kubectl apply -f -` +`kustomize build . | kubectl apply {{[-f|--filename]}} -` - Set an image in the kustomization file: diff --git a/tldr/ldapsearch b/tldr/ldapsearch index e83e6f0b..c8c02786 100644 --- a/tldr/ldapsearch +++ b/tldr/ldapsearch @@ -10,32 +10,32 @@ source: https://github.com/tldr-pages/tldr.git - Query an LDAP server for all items that are a member of the given group and return the object's displayName value: -`ldapsearch -D '{{admin_DN}}' -w '{{password}}' -h {{ldap_host}} -b {{base_ou}} '{{memberOf=group1}}' displayName` +`ldapsearch {{[-D|--bindDN]}} '{{admin_DN}}' {{[-w|--bindPassword]}} '{{password}}' {{[-h|--hostname]}} {{ldap_host}} {{[-b|--baseDN]}} {{base_ou}} '{{memberOf=group1}}' displayName` - Query an LDAP server with a no-newline password file for all items that are a member of the given group and return the object's displayName value: -`ldapsearch -D '{{admin_DN}}' -y '{{password_file}}' -h {{ldap_host}} -b {{base_ou}} '{{memberOf=group1}}' displayName` +`ldapsearch {{[-D|--bindDN]}} '{{admin_DN}}' {{[-u|--keyStorePasswordFile]}} '{{password_file}}' {{[-h|--hostname]}} {{ldap_host}} {{[-b|--baseDN]}} {{base_ou}} '{{memberOf=group1}}' displayName` - Return 5 items that match the given filter: -`ldapsearch -D '{{admin_DN}}' -w '{{password}}' -h {{ldap_host}} -b {{base_ou}} '{{memberOf=group1}}' -z 5 displayName` +`ldapsearch {{[-D|--bindDN]}} '{{admin_DN}}' {{[-w|--bindPassword]}} '{{password}}' {{[-h|--hostname]}} {{ldap_host}} {{[-b|--baseDN]}} {{base_ou}} '{{memberOf=group1}}' {{[-z|--sizeLimit]}} 5 displayName` - Wait up to 7 seconds for a response: -`ldapsearch -D '{{admin_DN}}' -w '{{password}}' -h {{ldap_host}} -b {{base_ou}} '{{memberOf=group1}}' -l 7 displayName` +`ldapsearch {{[-D|--bindDN]}} '{{admin_DN}}' {{[-w|--bindPassword]}} '{{password}}' {{[-h|--hostname]}} {{ldap_host}} {{[-b|--baseDN]}} {{base_ou}} '{{memberOf=group1}}' {{[-l|--timeLimitSeconds]}} 7 displayName` - Invert the filter: -`ldapsearch -D '{{admin_DN}}' -w '{{password}}' -h {{ldap_host}} -b {{base_ou}} '(!(memberOf={{group1}}))' displayName` +`ldapsearch {{[-D|--bindDN]}} '{{admin_DN}}' {{[-w|--bindPassword]}} '{{password}}' {{[-h|--hostname]}} {{ldap_host}} {{[-b|--baseDN]}} {{base_ou}} '(!(memberOf={{group1}}))' displayName` - Return all items that are part of multiple groups, returning the display name for each item: -`ldapsearch -D '{{admin_DN}}' -w '{{password}}' -h {{ldap_host}} '(&({{memberOf=group1}})({{memberOf=group2}})({{memberOf=group3}}))' "displayName"` +`ldapsearch {{[-D|--bindDN]}} '{{admin_DN}}' {{[-w|--bindPassword]}} '{{password}}' {{[-h|--hostname]}} {{ldap_host}} '(&({{memberOf=group1}})({{memberOf=group2}})({{memberOf=group3}}))' "displayName"` - Return all items that are members of at least 1 of the specified groups: -`ldapsearch -D '{{admin_DN}}' -w '{{password}}' -h {{ldap_host}} '(|({{memberOf=group1}})({{memberOf=group1}})({{memberOf=group3}}))' displayName` +`ldapsearch {{[-D|--bindDN]}} '{{admin_DN}}' {{[-w|--bindPassword]}} '{{password}}' {{[-h|--hostname]}} {{ldap_host}} '(|({{memberOf=group1}})({{memberOf=group1}})({{memberOf=group3}}))' displayName` - Combine multiple boolean logic filters: -`ldapsearch -D '{{admin_DN}}' -w '{{password}}' -h {{ldap_host}} '(&({{memberOf=group1}})({{memberOf=group2}})(!({{memberOf=group3}})))' displayName` +`ldapsearch {{[-D|--bindDN]}} '{{admin_DN}}' {{[-w|--bindPassword]}} '{{password}}' {{[-h|--hostname]}} {{ldap_host}} '(&({{memberOf=group1}})({{memberOf=group2}})(!({{memberOf=group3}})))' displayName` diff --git a/tldr/lilypond b/tldr/lilypond index 7facb6b7..1800e4c0 100644 --- a/tldr/lilypond +++ b/tldr/lilypond @@ -15,16 +15,16 @@ source: https://github.com/tldr-pages/tldr.git - Compile into the specified format: -`lilypond --formats={{format_dump}} {{path/to/file}}` +`lilypond {{[-f|--format]}} {{format_dump}} {{path/to/file}}` - Compile the specified file, suppressing progress updates: -`lilypond -s {{path/to/file}}` +`lilypond {{[-s|--silent]}} {{path/to/file}}` - Compile the specified file, and also specify the output filename: -`lilypond --output={{path/to/output_file}} {{path/to/input_file}}` +`lilypond {{[-o|--output]}} {{path/to/output_file}} {{path/to/input_file}}` - Show the current version of lilypond: -`lilypond --version` +`lilypond {{[-v|--version]}}` diff --git a/tldr/linux/fuzzel b/tldr/linux/fuzzel index 958bc5ce..4f9e2ea9 100644 --- a/tldr/linux/fuzzel +++ b/tldr/linux/fuzzel @@ -37,7 +37,7 @@ source: https://github.com/tldr-pages/tldr.git `rm {{[-v|--verbose]}} $HOME/.cache/fuzzel` -- Launch `fuzzel` on a specific monitor, see `wlr-randr` or `swaymsg -t get_outputs`: +- Launch `fuzzel` on a specific monitor, see `wlr-randr` or `swaymsg --type get_outputs`: `fuzzel {{[-o|--output]}} "{{DP-1}}"` diff --git a/tldr/linux/virt-viewer b/tldr/linux/virt-viewer index 4a522958..e7e2f39c 100644 --- a/tldr/linux/virt-viewer +++ b/tldr/linux/virt-viewer @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # virt-viewer > Minimal graphical interface for a virtual machine (VM). -> Note: 'domain' refers to the name, UUID or ID for the existing VMs (See: tldr virsh). +> Note: 'domain' refers to the name, UUID or ID for the existing VMs (See: `tldr virsh`). > More information: . - Launch `virt-viewer` with a prompt to select running virtual machines: diff --git a/tldr/linux/virt-xml b/tldr/linux/virt-xml index 19f35e97..8f80f867 100644 --- a/tldr/linux/virt-xml +++ b/tldr/linux/virt-xml @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # virt-xml > Edit libvirt Domain XML files with explicit command-line options. -> Note: 'domain' refers to the name, UUID or ID for the existing VMs (See: tldr virsh). +> Note: 'domain' refers to the name, UUID or ID for the existing VMs (See: `tldr virsh`). > More information: . - List all the suboptions for a specific option: @@ -29,6 +29,6 @@ source: https://github.com/tldr-pages/tldr.git `virt-xml {{domain}} --edit --boot bootmenu={{on|off}}` -- Attach host USB hub to a running VM (See: tldr lsusb): +- Attach host USB hub to a running VM (See: `tldr lsusb`): `virt-xml {{domain}} --update --add-device --hostdev {{bus}}.{{device}}` diff --git a/tldr/loc b/tldr/loc index e24464d3..e80d5afb 100644 --- a/tldr/loc +++ b/tldr/loc @@ -22,4 +22,4 @@ source: https://github.com/tldr-pages/tldr.git - Print lines of code without .gitignore (etc.) files (e.g. two -u flags will additionally count hidden files and dirs): -`loc -u` +`loc {{[-u|--unrestricted]}}` diff --git a/tldr/lolcat b/tldr/lolcat index 97c62032..67bd3f4b 100644 --- a/tldr/lolcat +++ b/tldr/lolcat @@ -18,8 +18,8 @@ source: https://github.com/tldr-pages/tldr.git - Print a file to the console with animated rainbow colors: -`lolcat -a {{path/to/file}}` +`lolcat {{[-a|--animate]}} {{path/to/file}}` - Print a file to the console with 24-bit (truecolor) rainbow colors: -`lolcat -t {{path/to/file}}` +`lolcat {{[-t|--truecolor]}} {{path/to/file}}` diff --git a/tldr/lsd b/tldr/lsd index 7538eff8..3644a04a 100644 --- a/tldr/lsd +++ b/tldr/lsd @@ -11,32 +11,32 @@ source: https://github.com/tldr-pages/tldr.git - List files and directories, one per line: -`lsd -1` +`lsd {{[-1|--oneline]}}` - List all files and directories, including hidden ones, in the current directory: -`lsd -a` +`lsd {{[-a|--all]}}` - List files and directories with trailing `/` added to directory names: -`lsd -F` +`lsd {{[-F|--classify]}}` - List all files and directories in long format (permissions, ownership, size in human-readable format, and modification date): -`lsd -lha` +`lsd {{[-lha|--long --human-readable --all]}}` - List files and directories in long format, sorted by size (descending): -`lsd -lS` +`lsd {{[-lS|--long --sizesort]}}` - List files and directories in long format, sorted by modification date (oldest first): -`lsd -ltr` +`lsd {{[-ltr|--long --timesort --reverse]}}` - Only list directories: -`lsd -d {{*/}}` +`lsd {{[-d|--directory-only]}} {{*/}}` - Recursively list all directories in a tree format: -`lsd --tree -d` +`lsd --tree {{[-d|--directory-only]}}` diff --git a/tldr/lychee b/tldr/lychee index 04abc300..03d99d43 100644 --- a/tldr/lychee +++ b/tldr/lychee @@ -22,7 +22,7 @@ source: https://github.com/tldr-pages/tldr.git - Check files in a directory structure for any broken URLs: -`grep -r "{{pattern}}" | lychee -` +`grep {{[-r|--recursive]}} "{{pattern}}" | lychee -` - Display help: diff --git a/tldr/lz4 b/tldr/lz4 index eae5bad4..37c0169c 100644 --- a/tldr/lz4 +++ b/tldr/lz4 @@ -14,11 +14,11 @@ source: https://github.com/tldr-pages/tldr.git - Decompress a file: -`lz4 -d {{file.lz4}}` +`lz4 {{[-d|--decompress]}} {{file.lz4}}` - Decompress a file and write to `stdout`: -`lz4 -dc {{file.lz4}}` +`lz4 {{[-dc|--decompress --stdout]}} {{file.lz4}}` - Package and compress a directory and its contents: @@ -26,8 +26,8 @@ source: https://github.com/tldr-pages/tldr.git - Decompress and unpack a directory and its contents: -`lz4 -dc {{dir.tar.lz4}} | tar -xv` +`lz4 {{[-dc|--decompress --stdout]}} {{dir.tar.lz4}} | tar -xv` - Compress a file using the best compression: -`lz4 -9 {{path/to/file}}` +`lz4 {{[-12|--best]}} {{path/to/file}}` diff --git a/tldr/lzop b/tldr/lzop index e0092a56..c3b0a589 100644 --- a/tldr/lzop +++ b/tldr/lzop @@ -14,8 +14,16 @@ source: https://github.com/tldr-pages/tldr.git - Decompress a file: -`lzop -d {{path/to/file.lzo}}` +`lzop {{[-d|--decompress]}} {{path/to/file.lzo}}` - Compress a file, while specifying the compression level. 0 = Worst, 9 = Best (Default level is 3): `lzop -{{level}} {{path/to/file}}` + +- Compress a file with the best compression level: + +`lzop {{[-9|--best]}} {{[path/to/file]}}` + +- Compress a file with the fastest compression level: + +`lzop {{[-1|--fast]}} {{[path/to/file]}}` diff --git a/tldr/mailx b/tldr/mailx index 4ce41b7a..d56db19c 100644 --- a/tldr/mailx +++ b/tldr/mailx @@ -10,24 +10,24 @@ source: https://github.com/tldr-pages/tldr.git - Send mail (the content should be typed after the command, and ended with ``): -`mailx -s "{{subject}}" {{to_addr}}` +`mailx {{[-s|--subject]}} "{{subject}}" {{to_addr}}` - Send mail with content passed from another command: -`echo "{{content}}" | mailx -s "{{subject}}" {{to_addr}}` +`echo "{{content}}" | mailx {{[-s|--subject]}} "{{subject}}" {{to_addr}}` - Send mail with content read from a file: -`mailx -s "{{subject}}" {{to_addr}} < {{content.txt}}` +`mailx {{[-s|--subject]}} "{{subject}}" {{to_addr}} < {{content.txt}}` - Send mail to a recipient and CC to another address: -`mailx -s "{{subject}}" -c {{cc_addr}} {{to_addr}}` +`mailx {{[-s|--subject]}} "{{subject}}" {{[-c|--cc]}} {{cc_addr}} {{to_addr}}` - Send mail specifying the sender address: -`mailx -s "{{subject}}" -r {{from_addr}} {{to_addr}}` +`mailx {{[-s|--subject]}} "{{subject}}" {{[-r|--from-address]}} {{from_addr}} {{to_addr}}` - Send mail with an attachment: -`mailx -a {{path/to/file}} -s "{{subject}}" {{to_addr}}` +`mailx {{[-a|--attach]}} {{path/to/file}} {{[-s|--subject]}} "{{subject}}" {{to_addr}}` diff --git a/tldr/mc b/tldr/mc index b0c3af4c..2917e777 100644 --- a/tldr/mc +++ b/tldr/mc @@ -16,4 +16,4 @@ source: https://github.com/tldr-pages/tldr.git - Start Midnight Commander in black and white: -`mc -b` +`mc {{[-b|--nocolor]}}` diff --git a/tldr/minifab b/tldr/minifab index 75a23d57..a07ea684 100644 --- a/tldr/minifab +++ b/tldr/minifab @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Bring up the default Hyperledger Fabric network: -`minifab up -i {{minifab_version}}` +`minifab up {{[-i|--fabric-release]}} {{minifab_version}}` - Bring down the Hyperledger Fabric network: @@ -18,11 +18,11 @@ source: https://github.com/tldr-pages/tldr.git - Install chaincode onto a specified channel: -`minifab install -n {{chaincode_name}}` +`minifab install {{[-n|--chaincode-name]}} {{chaincode_name}}` - Install a specific chaincode version onto a channel: -`minifab install -n {{chaincode_name}} -v {{chaincode_version}}` +`minifab install {{[-n|--chaincode-name]}} {{chaincode_name}} {{[-v|--chaincode-version]}} {{chaincode_version}}` - Initialize the chaincode after installation/upgrade: @@ -30,7 +30,7 @@ source: https://github.com/tldr-pages/tldr.git - Invoke a chaincode method with the specified arguments: -`minifab invoke -n {{chaincode_name}} -p '"{{method_name}}", "{{argument1}}", "{{argument2}}", ...'` +`minifab invoke {{[-n|--chaincode-name]}} {{chaincode_name}} {{[-p|--chaincode-parameters]}} '"{{method_name}}", "{{argument1}}", "{{argument2}}", ...'` - Make a query on the ledger: @@ -38,4 +38,4 @@ source: https://github.com/tldr-pages/tldr.git - Quickly run an application: -`minifab apprun -l {{app_programming_language}}` +`minifab apprun {{[-l|--chaincode-language]}} {{app_programming_language}}` diff --git a/tldr/mitmdump b/tldr/mitmdump index 0e316dbd..f7a3de2e 100644 --- a/tldr/mitmdump +++ b/tldr/mitmdump @@ -11,12 +11,12 @@ source: https://github.com/tldr-pages/tldr.git - Start a proxy and save all output to a file: -`mitmdump -w {{path/to/file}}` +`mitmdump {{[-w|--wfile]}} {{path/to/file}}` - Filter a saved traffic file to just POST requests: -`mitmdump -nr {{input_filename}} -w {{output_filename}} "{{~m post}}"` +`mitmdump {{[-nr|--no-server --read-flows]}} {{input_filename}} {{[-w|--wfile]}} {{output_filename}} "{{~m post}}"` - Replay a saved traffic file: -`mitmdump -nc {{path/to/file}}` +`mitmdump {{[-nc|--no-server --client-replay]}} {{path/to/file}}` diff --git a/tldr/mktorrent b/tldr/mktorrent index 8b2695f1..49179f2a 100644 --- a/tldr/mktorrent +++ b/tldr/mktorrent @@ -10,20 +10,20 @@ source: https://github.com/tldr-pages/tldr.git - Create a torrent with 2^21 KB as the piece size: -`mktorrent -a {{tracker_announce_url}} -l {{21}} -o {{path/to/example.torrent}} {{path/to/file_or_directory}}` +`mktorrent {{[-a|--announce]}} {{tracker_announce_url}} {{[-l|--piece-length]}} {{21}} {{[-o|--output]}} {{path/to/example.torrent}} {{path/to/file_or_directory}}` - Create a private torrent with a 2^21 KB piece size: -`mktorrent -p -a {{tracker_announce_url}} -l {{21}} -o {{path/to/example.torrent}} {{path/to/file_or_directory}}` +`mktorrent {{[-p|--private]}} {{[-a|--announce]}} {{tracker_announce_url}} {{[-l|--piece-length]}} {{21}} {{[-o|--output]}} {{path/to/example.torrent}} {{path/to/file_or_directory}}` - Create a torrent with a comment: -`mktorrent -c "{{comment}}" -a {{tracker_announce_url}} -l {{21}} -o {{path/to/example.torrent}} {{path/to/file_or_directory}}` +`mktorrent {{[-c|--comment]}} "{{comment}}" {{[-a|--announce]}} {{tracker_announce_url}} {{[-l|--piece-length]}} {{21}} {{[-o|--output]}} {{path/to/example.torrent}} {{path/to/file_or_directory}}` - Create a torrent with multiple trackers: -`mktorrent -a {{tracker_announce_url,tracker_announce_url_2}} -l {{21}} -o {{path/to/example.torrent}} {{path/to/file_or_directory}}` +`mktorrent {{[-a|--announce]}} {{tracker_announce_url,tracker_announce_url_2}} {{[-l|--piece-length]}} {{21}} {{[-o|--output]}} {{path/to/example.torrent}} {{path/to/file_or_directory}}` - Create a torrent with web seed URLs: -`mktorrent -a {{tracker_announce_url}} -w {{web_seed_url}} -l {{21}} -o {{path/to/example.torrent}} {{path/to/file_or_directory}}` +`mktorrent {{[-a|--announce]}} {{tracker_announce_url}} -w {{web_seed_url}} {{[-l|--piece-length]}} {{21}} {{[-o|--output]}} {{path/to/example.torrent}} {{path/to/file_or_directory}}` diff --git a/tldr/mlr b/tldr/mlr index 4184eafd..11105d62 100644 --- a/tldr/mlr +++ b/tldr/mlr @@ -32,6 +32,6 @@ source: https://github.com/tldr-pages/tldr.git `echo '{"hello":"world", "foo":"bar"}' | mlr --ijson --ojson --jvstack cat` -- Filter lines of a compressed CSV file treating numbers as strings: +- Filter lines of a compressed CSV file treating numbers as [S]trings: -`mlr --prepipe 'gunzip' --csv filter -S '${{fieldName}} =~ "{{regular_expression}}"' {{example.csv.gz}}` +`mlr --prepipe 'gunzip' {{[-c|--csv]}} filter {{[-S|--infer-none]}} '${{fieldName}} =~ "{{regular_expression}}"' {{example.csv.gz}}` diff --git a/tldr/mmv b/tldr/mmv index 7da68945..8bfc9a7c 100644 --- a/tldr/mmv +++ b/tldr/mmv @@ -14,11 +14,11 @@ source: https://github.com/tldr-pages/tldr.git - Copy `report6part4.txt` to `./french/rapport6partie4.txt` along with all similarly named files: -`mmv -c "{{report*part*.txt}}" "{{./french/rapport#1partie#2.txt}}"` +`mmv {{[-c|--copy]}} "{{report*part*.txt}}" "{{./french/rapport#1partie#2.txt}}"` - Append all `.txt` files into one file: -`mmv -a "{{*.txt}}" "{{all.txt}}"` +`mmv {{[-a|--append]}} "{{*.txt}}" "{{all.txt}}"` - Convert dates in filenames from "M-D-Y" format to "D-M-Y" format: diff --git a/tldr/monop b/tldr/monop index 53eb5d56..175a2c2d 100644 --- a/tldr/monop +++ b/tldr/monop @@ -22,15 +22,15 @@ source: https://github.com/tldr-pages/tldr.git - Only show members defined in the specified Type: -`monop -r:{{path/to/assembly.dll}} --only-declared {{Namespace.Path.To.Type}}` +`monop -r:{{path/to/assembly.dll}} {{[-d|--declared-only]}} {{Namespace.Path.To.Type}}` - Show private members: -`monop -r:{{path/to/assembly.dll}} --private {{Namespace.Path.To.Type}}` +`monop -r:{{path/to/assembly.dll}} {{[-p|--private]}} {{Namespace.Path.To.Type}}` - Hide obsolete members: -`monop -r:{{path/to/assembly.dll}} --filter-obsolete {{Namespace.Path.To.Type}}` +`monop -r:{{path/to/assembly.dll}} {{[-f|--filter-obsolete]}} {{Namespace.Path.To.Type}}` - List the other assemblies that a specified assembly references: diff --git a/tldr/mosquitto_pub b/tldr/mosquitto_pub index 7855fd07..74e6dfe1 100644 --- a/tldr/mosquitto_pub +++ b/tldr/mosquitto_pub @@ -10,24 +10,24 @@ source: https://github.com/tldr-pages/tldr.git - Publish a temperature value of 32 on the topic `sensors/temperature` to 192.168.1.1 (defaults to `localhost`) with Quality of Service (`QoS`) set to 1: -`mosquitto_pub -h {{192.168.1.1}} -t {{sensors/temperature}} -m {{32}} -q {{1}}` +`mosquitto_pub {{[-h|--host]}} {{192.168.1.1}} {{[-t|--topic]}} {{sensors/temperature}} {{[-m|--message]}} {{32}} {{[-q|--qos]}} {{1}}` - Publish timestamp and temperature data on the topic `sensors/temperature` to a remote host on a non-standard port: -`mosquitto_pub -h {{192.168.1.1}} -p {{1885}} -t {{sensors/temperature}} -m "{{1266193804 32}}"` +`mosquitto_pub {{[-h|--host]}} {{192.168.1.1}} {{[-p|--port]}} {{1885}} {{[-t|--topic]}} {{sensors/temperature}} {{[-m|--message]}} "{{1266193804 32}}"` - Publish light switch status and retain the message on the topic `switches/kitchen_lights/status` to a remote host because there may be a long period of time between light switch events: -`mosquitto_pub -r -h "{{iot.eclipse.org}}" -t {{switches/kitchen_lights/status}} -m "{{on}}"` +`mosquitto_pub {{[-r|--retain]}} {{[-h|--host]}} "{{iot.eclipse.org}}" {{[-t|--topic]}} {{switches/kitchen_lights/status}} {{[-m|--message]}} "{{on}}"` - Send the contents of a file (`data.txt`) as a message and publish it to `sensors/temperature` topic: -`mosquitto_pub -t {{sensors/temperature}} -f {{data.txt}}` +`mosquitto_pub {{[-t|--topic]}} {{sensors/temperature}} {{[-f|--file]}} {{data.txt}}` - Send the contents of a file (`data.txt`), by reading from `stdin` and send the entire input as a message and publish it to `sensors/temperature` topic: -`mosquitto_pub -t {{sensors/temperature}} -s < {{data.txt}}` +`mosquitto_pub {{[-t|--topic]}} {{sensors/temperature}} {{[-s|--stdin-file]}} < {{data.txt}}` - Read newline delimited data from `stdin` as a message and publish it to `sensors/temperature` topic: -`{{echo data.txt}} | mosquitto_pub -t {{sensors/temperature}} -l` +`{{echo data.txt}} | mosquitto_pub {{[-t|--topic]}} {{sensors/temperature}} {{[-l|--stdin-line]}}` diff --git a/tldr/mosquitto_sub b/tldr/mosquitto_sub index c52174c6..394081b3 100644 --- a/tldr/mosquitto_sub +++ b/tldr/mosquitto_sub @@ -10,12 +10,12 @@ source: https://github.com/tldr-pages/tldr.git - Subscribe to the topic `sensors/temperature` information with Quality of Service (`QoS`) set to 1. (The default hostname is `localhost` and port 1883): -`mosquitto_sub -t {{sensors/temperature}} -q {{1}}` +`mosquitto_sub {{[-t|--topic]}} {{sensors/temperature}} {{[-q|--qos]}} {{1}}` - Subscribe to all broker status messages publishing on `iot.eclipse.org` port 1885 and print published messages verbosely: -`mosquitto_sub -v -h "iot.eclipse.org" -p 1885 -t {{\$SYS/#}}` +`mosquitto_sub {{[-v|--verbose]}} {{[-h|--host]}} "iot.eclipse.org" {{[-p|--port]}} 1885 {{[-t|--topic]}} {{\$SYS/#}}` - Subscribe to multiple topics matching a given pattern. (+ takes any metric name): -`mosquitto_sub -t {{sensors/machines/+/temperature/+}}` +`mosquitto_sub {{[-t|--topic]}} {{sensors/machines/+/temperature/+}}` diff --git a/tldr/mpg321 b/tldr/mpg321 index b515c38c..52f7365d 100644 --- a/tldr/mpg321 +++ b/tldr/mpg321 @@ -7,11 +7,11 @@ source: https://github.com/tldr-pages/tldr.git > High Performance MPEG 1.0/2.0/2.5 Audio Player for Layer 1, 2, and 3. > Mpg321 was written (sometime in 1999) to be a drop-in replacement for the (previously) non-free mpg123 player. -> More information: . +> More information: . - Play an audio source exactly `n` times (0 means forever): -`mpg321 -l {{n}} {{path/to/file_a|URL}} {{path/to/file_b|URL}} {{...}}` +`mpg321 {{[-l|--loop]}} {{n}} {{path/to/file_a|URL}} {{path/to/file_b|URL}} {{...}}` - Play a directory recursively: @@ -23,12 +23,12 @@ source: https://github.com/tldr-pages/tldr.git - Play files randomly until interrupted: -`mpg321 -Z {{path/to/file_a|URL}} {{path/to/file_b|URL}} {{...}}` +`mpg321 {{[-Z|--random]}} {{path/to/file_a|URL}} {{path/to/file_b|URL}} {{...}}` - Shuffle the files before playing them once: -`mpg321 -z {{path/to/file_a|URL}} {{path/to/file_b|URL}} {{...}}` +`mpg321 {{[-z|--shuffle]}} {{path/to/file_a|URL}} {{path/to/file_b|URL}} {{...}}` - Play all files in the current directory and subdirectories, randomly (until interrupted), with Basic Keys enabled: -`mpg321 -B -Z -K .` +`mpg321 -B {{[-Z|--random]}} -K .` diff --git a/tldr/mr b/tldr/mr index cc5816b0..c3d0997c 100644 --- a/tldr/mr +++ b/tldr/mr @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Update repositories in 5 concurrent jobs: -`mr -j{{5}} update` +`mr {{[-j|--jobs]}} {{5}} update` - Print the status of all repositories: diff --git a/tldr/msedge b/tldr/msedge index 845b7481..240b1787 100644 --- a/tldr/msedge +++ b/tldr/msedge @@ -10,8 +10,8 @@ source: https://github.com/tldr-pages/tldr.git - View the documentation for Microsoft Edge for Windows: -`tldr -p windows msedge` +`tldr {{[-p|--platform]}} windows msedge` - View the documentation for Microsoft Edge for other platforms: -`tldr -p common microsoft-edge` +`tldr {{[-p|--platform]}} common microsoft-edge` diff --git a/tldr/msfvenom b/tldr/msfvenom index fa1b98f7..6509d49e 100644 --- a/tldr/msfvenom +++ b/tldr/msfvenom @@ -6,28 +6,28 @@ source: https://github.com/tldr-pages/tldr.git # msfvenom > Manually generate payloads for metasploit. -> More information: . +> More information: . - List payloads: -`msfvenom -l payloads` +`msfvenom {{[-l|--list]}} payloads` - List formats: -`msfvenom -l formats` +`msfvenom {{[-l|--list]}} formats` - Show payload options: -`msfvenom -p {{payload}} --list-options` +`msfvenom {{[-p|--payload]}} {{payload}} --list-options` - Create an ELF binary with a reverse TCP handler: -`msfvenom -p linux/x64/meterpreter/reverse_tcp LHOST={{local_ip}} LPORT={{local_port}} -f elf -o {{path/to/binary}}` +`msfvenom {{[-p|--payload]}} linux/x64/meterpreter/reverse_tcp LHOST={{local_ip}} LPORT={{local_port}} {{[-f|--format]}} elf {{[-o|--out]}} {{path/to/binary}}` - Create an EXE binary with a reverse TCP handler: -`msfvenom -p windows/x64/meterpreter/reverse_tcp LHOST={{local_ip}} LPORT={{local_port}} -f exe -o {{path/to/binary.exe}}` +`msfvenom {{[-p|--payload]}} windows/x64/meterpreter/reverse_tcp LHOST={{local_ip}} LPORT={{local_port}} {{[-f|--format]}} exe {{[-o|--out]}} {{path/to/binary.exe}}` - Create a raw Bash with a reverse TCP handler: -`msfvenom -p cmd/unix/reverse_bash LHOST={{local_ip}} LPORT={{local_port}} -f raw` +`msfvenom {{[-p|--payload]}} cmd/unix/reverse_bash LHOST={{local_ip}} LPORT={{local_port}} {{[-f|--format]}} raw` diff --git a/tldr/multipass b/tldr/multipass index 8e6cc5df..cdace6cb 100644 --- a/tldr/multipass +++ b/tldr/multipass @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Launch a new instance, set its name and use a cloud-init configuration file: -`multipass launch -n {{instance_name}} --cloud-init {{configuration_file}}` +`multipass launch {{[-n|--name]}} {{instance_name}} --cloud-init {{configuration_file}}` - List all the created instances and some of their properties: diff --git a/tldr/mysql b/tldr/mysql index c30f4a87..af86df4c 100644 --- a/tldr/mysql +++ b/tldr/mysql @@ -14,24 +14,24 @@ source: https://github.com/tldr-pages/tldr.git - Connect to a database, user will be prompted for a password: -`mysql -u {{user}} --password {{database_name}}` +`mysql {{[-u|--user]}} {{user}} {{[-p|--password]}} {{database_name}}` - Connect to a database on another host: -`mysql -h {{database_host}} {{database_name}}` +`mysql {{[-h|--host]}} {{database_host}} {{database_name}}` - Connect to a database through a Unix socket: -`mysql --socket {{path/to/socket.sock}}` +`mysql {{[-S|--socket]}} {{path/to/socket.sock}}` - Execute SQL statements in a script file (batch file): -`mysql -e "source {{filename.sql}}" {{database_name}}` +`mysql {{[-e|--execute]}} "source {{filename.sql}}" {{database_name}}` - Restore a database from a backup created with `mysqldump` (user will be prompted for a password): -`mysql --user {{user}} --password {{database_name}} < {{path/to/backup.sql}}` +`mysql {{[-u|--user]}} {{user}} {{[-p|--password]}} {{database_name}} < {{path/to/backup.sql}}` - Restore all databases from a backup (user will be prompted for a password): -`mysql --user {{user}} --password < {{path/to/backup.sql}}` +`mysql {{[-u|--user]}} {{user}} {{[-p|--password]}} < {{path/to/backup.sql}}` diff --git a/tldr/mysqlbinlog b/tldr/mysqlbinlog index cf231495..ac6b182c 100644 --- a/tldr/mysqlbinlog +++ b/tldr/mysqlbinlog @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # mysqlbinlog > Utility for processing MySQL binary log files. -> More information: . +> More information: . - Show events from a specific binary log file: diff --git a/tldr/mysqlcheck b/tldr/mysqlcheck index 29ac8a61..a451315f 100644 --- a/tldr/mysqlcheck +++ b/tldr/mysqlcheck @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # mysqlcheck > Check and repair MySQL tables. -> More information: . +> More information: . - Check a table: diff --git a/tldr/mysqlsh b/tldr/mysqlsh index da6fa7fb..7b26f2c5 100644 --- a/tldr/mysqlsh +++ b/tldr/mysqlsh @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Advanced command-line client for MySQL, supporting SQL, JavaScript, and Python. > It offers features for managing InnoDB clusters and document store collections. -> More information: . +> More information: . - Start MySQL Shell in interactive mode: diff --git a/tldr/mytop b/tldr/mytop index adff42e9..7b2d0609 100644 --- a/tldr/mytop +++ b/tldr/mytop @@ -14,12 +14,12 @@ source: https://github.com/tldr-pages/tldr.git - Connect with a specified username and password: -`mytop -u {{user}} -p {{password}}` +`mytop {{[-u|-user]}} {{user}} {{[-p|-password]}} {{password}}` - Connect with a specified username (the user will be prompted for a password): -`mytop -u {{user}} --prompt` +`mytop {{[-u|-user]}} {{user}} -prompt` - Do not show any idle (sleeping) threads: -`mytop -u {{user}} -p {{password}} --noidle` +`mytop {{[-u|-user]}} {{user}} {{[-p|-password]}} {{password}} --noidle` diff --git a/tldr/naabu b/tldr/naabu index c400e4eb..2ca89645 100644 --- a/tldr/naabu +++ b/tldr/naabu @@ -15,24 +15,24 @@ source: https://github.com/tldr-pages/tldr.git - Display available network interfaces and public IP address of the local host: -`naabu -interface-list` +`naabu {{[-il|-interface-list]}}` - Scan all ports of the remote host (CONNECT scan without `sudo`): -`naabu -p - -host {{host}}` +`naabu {{[-p|-port]}} - -host {{host}}` - Scan the top 1000 ports of the remote host: -`naabu -top-ports 1000 -host {{host}}` +`naabu {{[-tp|-top-ports]}} 1000 -host {{host}}` - Scan TCP ports 80, 443 and UDP port 53 of the remote host: -`naabu -p 80,443,u:53 -host {{host}}` +`naabu {{[-p|-port]}} 80,443,u:53 -host {{host}}` - Show CDN type the remote host is using, if any: -`naabu -p 80,443 -cdn -host {{host}}` +`naabu {{[-p|-port]}} 80,443 -cdn -host {{host}}` - Run `nmap` from `naabu` for additional functionalities (`nmap` must be installed): -`sudo naabu -v -host {{host}} -nmap-cli 'nmap {{-v -T5 -sC}}'` +`sudo naabu {{[-v|-verbose]}} -host {{host}} -nmap-cli 'nmap {{-v -T5 -sC}}'` diff --git a/tldr/newsboat b/tldr/newsboat index f81ae551..458e861f 100644 --- a/tldr/newsboat +++ b/tldr/newsboat @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - First import feed URLs from an OPML file: -`newsboat -i {{my-feeds.xml}}` +`newsboat {{[-i|--import-from-opml]}} {{my-feeds.xml}}` - Alternatively, add feeds manually: @@ -18,11 +18,11 @@ source: https://github.com/tldr-pages/tldr.git - Start Newsboat and refresh all feeds on startup: -`newsboat -r` +`newsboat {{[-r|--refresh-on-start]}}` - Execute one or more commands in non-interactive mode: -`newsboat -x {{reload print-unread ...}}` +`newsboat {{[-x|--execute]}} {{reload print-unread ...}}` - See keyboard shortcuts (the most relevant are visible in the status line): diff --git a/tldr/nikto b/tldr/nikto index 1f0a236f..a912dac6 100644 --- a/tldr/nikto +++ b/tldr/nikto @@ -10,20 +10,20 @@ source: https://github.com/tldr-pages/tldr.git - Perform a basic Nikto scan against a target host: -`perl nikto.pl -h {{192.168.0.1}}` +`perl nikto.pl {{[-h|-host]}} {{192.168.0.1}}` - Specify the port number when performing a basic scan: -`perl nikto.pl -h {{192.168.0.1}} -p {{443}}` +`perl nikto.pl {{[-h|-host]}} {{192.168.0.1}} {{[-p|-port]}} {{443}}` - Scan ports and protocols with full URL syntax: -`perl nikto.pl -h {{https://192.168.0.1:443/}}` +`perl nikto.pl {{[-h|-host]}} {{https://192.168.0.1:443/}}` - Scan multiple ports in the same scanning session: -`perl nikto.pl -h {{192.168.0.1}} -p {{80,88,443}}` +`perl nikto.pl {{[-h|-host]}} {{192.168.0.1}} {{[-p|-port]}} {{80,88,443}}` - Update to the latest plugins and databases: -`perl nikto.pl -update` +`perl nikto.pl {{[-u|-update]}}` diff --git a/tldr/nim b/tldr/nim index 2399491d..b2e01a54 100644 --- a/tldr/nim +++ b/tldr/nim @@ -11,19 +11,19 @@ source: https://github.com/tldr-pages/tldr.git - Compile a source file: -`nim compile {{path/to/file.nim}}` +`nim {{[c|compile]}} {{path/to/file.nim}}` - Compile and run a source file: -`nim compile -r {{path/to/file.nim}}` +`nim {{[c|compile]}} {{[-r|--run]}} {{path/to/file.nim}}` - Compile a source file with release optimizations enabled: -`nim compile -d:release {{path/to/file.nim}}` +`nim {{[c|compile]}} {{[-d|--define]}}:release {{path/to/file.nim}}` - Build a release binary optimized for low file size: -`nim compile -d:release --opt:size {{path/to/file.nim}}` +`nim {{[c|compile]}} {{[-d|--define]}}:release --opt:size {{path/to/file.nim}}` - Generate HTML documentation for a module (output will be placed in the current directory): diff --git a/tldr/nimble b/tldr/nimble index d1609acd..b4ec7a16 100644 --- a/tldr/nimble +++ b/tldr/nimble @@ -19,7 +19,7 @@ source: https://github.com/tldr-pages/tldr.git - List installed packages: -`nimble list -i` +`nimble list {{[-i|--installed]}}` - Create a new Nimble package in the current directory: diff --git a/tldr/nix b/tldr/nix index df4b73da..f6e15fa1 100644 --- a/tldr/nix +++ b/tldr/nix @@ -12,7 +12,7 @@ source: https://github.com/tldr-pages/tldr.git - Enable the `nix` command: -`mkdir -p ~/.config/nix; echo 'experimental-features = nix-command flakes' > ~/.config/nix/nix.conf` +`mkdir {{[-p|--parents]}} ~/.config/nix; echo 'experimental-features = nix-command flakes' > ~/.config/nix/nix.conf` - Search for a package in nixpkgs via its name or description: diff --git a/tldr/nix-classic b/tldr/nix-classic index 79d5a49a..5ce1c497 100644 --- a/tldr/nix-classic +++ b/tldr/nix-classic @@ -11,19 +11,19 @@ source: https://github.com/tldr-pages/tldr.git - Search for a package in nixpkgs via its name: -`nix-env -qaP {{search_term_regexp}}` +`nix-env {{[-qaP|--query --available --attr-path]}} {{search_term_regexp}}` - Start a shell with the specified packages available: -`nix-shell -p {{pkg1 pkg2 pkg3...}}` +`nix-shell {{[-p|--packages]}} {{pkg1 pkg2 pkg3...}}` - Install some packages permanently: -`nix-env -iA {{nixpkgs.pkg1 nixpkgs.pkg2...}}` +`nix-env {{[-iA|--install --attr]}} {{nixpkgs.pkg1 nixpkgs.pkg2...}}` - Show all dependencies of a store path (package), in a tree format: -`nix-store --query --tree {{/nix/store/...}}` +`nix-store {{[-q|--query]}} --tree {{/nix/store/...}}` - Update the channels (repositories): diff --git a/tldr/nix-env b/tldr/nix-env index 512cb8a4..5d36fed7 100644 --- a/tldr/nix-env +++ b/tldr/nix-env @@ -10,32 +10,32 @@ source: https://github.com/tldr-pages/tldr.git - List all installed packages: -`nix-env -q` +`nix-env {{[-q|--query]}}` - Query installed packages: -`nix-env -q {{search_term}}` +`nix-env {{[-q|--query]}} {{search_term}}` - Query available packages: -`nix-env -qa {{search_term}}` +`nix-env {{[-qa|--query --available]}} {{search_term}}` - Install package: -`nix-env -iA nixpkgs.{{pkg_name}}` +`nix-env {{[-iA|--install --attr]}} nixpkgs.{{pkg_name}}` - Install a package from a URL: -`nix-env -i {{pkg_name}} --file {{example.com}}` +`nix-env {{[-i|--install]}} {{pkg_name}} {{[-f|--file]}} {{example.com}}` - Uninstall package: -`nix-env -e {{pkg_name}}` +`nix-env {{[-e|--uninstall]}} {{pkg_name}}` - Upgrade one package: -`nix-env -u {{pkg_name}}` +`nix-env {{[-u|--upgrade]}} {{pkg_name}}` - Upgrade all packages: -`nix-env -u` +`nix-env {{[-u|--upgrade]}}` diff --git a/tldr/nix-shell b/tldr/nix-shell index ff57ff99..1f8f8dab 100644 --- a/tldr/nix-shell +++ b/tldr/nix-shell @@ -23,12 +23,12 @@ source: https://github.com/tldr-pages/tldr.git - Start with packages loaded from nixpkgs: -`nix-shell --packages {{package1 package2 ...}}` +`nix-shell {{[-p|--packages]}} {{package1 package2 ...}}` - Start with packages loaded from specific nixpkgs revision: -`nix-shell --packages {{package1 package2 ...}} -I nixpkgs={{https://github.com/NixOS/nixpkgs/archive/nixpkgs_revision.tar.gz}}` +`nix-shell {{[-p|--packages]}} {{package1 package2 ...}} {{[-I|--include]}} nixpkgs={{https://github.com/NixOS/nixpkgs/archive/nixpkgs_revision.tar.gz}}` - Evaluate rest of file in specific interpreter, for use in `#!-scripts` (see ): -`nix-shell -i {{interpreter}} --packages {{package1 package2 ...}}` +`nix-shell -i {{interpreter}} {{[-p|--packages]}} {{package1 package2 ...}}` diff --git a/tldr/nix-store b/tldr/nix-store index f642c7c0..67cecd91 100644 --- a/tldr/nix-store +++ b/tldr/nix-store @@ -23,12 +23,12 @@ source: https://github.com/tldr-pages/tldr.git - Show all dependencies of a store path (package), in a tree format: -`nix-store --query --tree {{/nix/store/...}}` +`nix-store {{[-q|--query]}} --tree {{/nix/store/...}}` - Calculate the total size of a certain store path with all the dependencies: -`du -cLsh $(nix-store --query --references {{/nix/store/...}})` +`du {{[-cLsh|--total --dereference --summarize --human-readable]}} $(nix-store {{[-q|--query]}} --references {{/nix/store/...}})` - Show all dependents of a particular store path: -`nix-store --query --referrers {{/nix/store/...}}` +`nix-store {{[-q|--query]}} --referrers {{/nix/store/...}}` diff --git a/tldr/node b/tldr/node index eed9d32d..5f6a8ffc 100644 --- a/tldr/node +++ b/tldr/node @@ -22,11 +22,11 @@ source: https://github.com/tldr-pages/tldr.git - Evaluate JavaScript code by passing it as an argument: -`node -e "{{code}}"` +`node {{[-e|--eval]}} "{{code}}"` - Evaluate and print the result, useful to print node's dependencies versions: -`node -p "process.versions"` +`node {{[-p|--print]}} "process.versions"` - Activate inspector, pausing execution until a debugger is connected once source code is fully parsed: diff --git a/tldr/noti b/tldr/noti index bb126f3d..d49680e7 100644 --- a/tldr/noti +++ b/tldr/noti @@ -18,4 +18,4 @@ source: https://github.com/tldr-pages/tldr.git - Monitor a process by PID and trigger a notification when the PID disappears: -`noti -w {{process_id}}` +`noti {{[-w|--pwatch]}} {{process_id}}` diff --git a/tldr/npm-access b/tldr/npm-access index d7c15354..c40449aa 100644 --- a/tldr/npm-access +++ b/tldr/npm-access @@ -22,7 +22,7 @@ source: https://github.com/tldr-pages/tldr.git - Set package status (public or private): -`npm access set status={{public|private}} {{package_name}}` +`npm access set status {{public|private}} {{package_name}}` - Grant access to a package: @@ -34,4 +34,4 @@ source: https://github.com/tldr-pages/tldr.git - Configure two-factor authentication requirement: -`npm access set mfa={{none|publish|automation}} {{package_name}}` +`npm access set mfa {{none|publish|automation}} {{package_name}}` diff --git a/tldr/npm-adduser b/tldr/npm-adduser index c6f0b7fb..3e692a8c 100644 --- a/tldr/npm-adduser +++ b/tldr/npm-adduser @@ -10,16 +10,16 @@ source: https://github.com/tldr-pages/tldr.git - Create a new user in the specified registry and save credentials to `.npmrc`: -`npm adduser --registry={{registry_url}}` +`npm adduser --registry {{registry_url}}` - Log in to a private registry with a specific scope: -`npm login --scope={{@mycorp}} --registry={{https://registry.mycorp.com}}` +`npm login --scope {{@mycorp}} --registry {{https://registry.mycorp.com}}` - Log out from a specific scope and remove the auth token: -`npm logout --scope={{@mycorp}}` +`npm logout --scope {{@mycorp}}` - Create a scoped package during initialization: -`npm init --scope={{@foo}} {{--yes}}` +`npm init --scope {{@foo}} {{[-y|--yes]}}` diff --git a/tldr/npm-audit b/tldr/npm-audit index ac693a97..bc5c9d7f 100644 --- a/tldr/npm-audit +++ b/tldr/npm-audit @@ -35,4 +35,4 @@ source: https://github.com/tldr-pages/tldr.git - Configure the audit to only fail on vulnerabilities above a specified severity: -`npm audit --audit-level={{info|low|moderate|high|critical}}` +`npm audit --audit-level {{info|low|moderate|high|critical}}` diff --git a/tldr/npm-check b/tldr/npm-check index 06bc1019..3a00df4c 100644 --- a/tldr/npm-check +++ b/tldr/npm-check @@ -14,12 +14,12 @@ source: https://github.com/tldr-pages/tldr.git - Interactively update out-of-date packages: -`npm-check --update` +`npm-check {{[-u|--update]}}` - Update everything without prompting: -`npm-check --update-all` +`npm-check {{[-y|--update-all]}}` - Don't check for unused packages: -`npm-check --skip-unused` +`npm-check {{[-s|--skip-unused]}}` diff --git a/tldr/npm-ci b/tldr/npm-ci index ea24f65d..55177639 100644 --- a/tldr/npm-ci +++ b/tldr/npm-ci @@ -15,7 +15,7 @@ source: https://github.com/tldr-pages/tldr.git - Install project dependencies but skip the specified dependency type: -`npm ci --omit={{dev|optional|peer}}` +`npm ci --omit {{dev|optional|peer}}` - Install project dependencies without running any pre-/post-scripts defined in `package.json`: diff --git a/tldr/npm-dedupe b/tldr/npm-dedupe index cda7a4bc..98c050e2 100644 --- a/tldr/npm-dedupe +++ b/tldr/npm-dedupe @@ -22,11 +22,11 @@ source: https://github.com/tldr-pages/tldr.git - Skip optional/peer dependencies during deduplication: -`npm dedupe --omit={{optional|peer}}` +`npm dedupe --omit {{optional|peer}}` - Enable detailed logging for troubleshooting: -`npm dedupe --loglevel=verbose` +`npm dedupe --loglevel verbose` - Limit deduplication to a specific package: diff --git a/tldr/npm-find-dupes b/tldr/npm-find-dupes index f9dd1388..e9828704 100644 --- a/tldr/npm-find-dupes +++ b/tldr/npm-find-dupes @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Include `devDependencies` in duplicate detection: -`npm find-dupes --include=dev` +`npm find-dupes --include dev` - List all duplicate instances of a specific package in `node-modules`: @@ -22,11 +22,11 @@ source: https://github.com/tldr-pages/tldr.git - Exclude optional dependencies from duplicate detection: -`npm find-dupes --omit=optional` +`npm find-dupes --omit optional` - Set the logging level for output: -`npm find-dupes --loglevel={{silent|error|warn|info|verbose}}` +`npm find-dupes --loglevel {{silent|error|warn|info|verbose}}` - Output duplicate information in JSON format: @@ -34,8 +34,8 @@ source: https://github.com/tldr-pages/tldr.git - Limit duplicate search to specific scopes: -`npm find-dupes --scope={{@scope1,@scope2}}` +`npm find-dupes --scope {{@scope1,@scope2}}` - Exclude specific scopes from duplicate detection: -`npm find-dupes --omit-scope={{@scope1,@scope2}}` +`npm find-dupes --omit-scope {{@scope1,@scope2}}` diff --git a/tldr/npm-fund b/tldr/npm-fund index a897f9bf..bec286ab 100644 --- a/tldr/npm-fund +++ b/tldr/npm-fund @@ -16,6 +16,6 @@ source: https://github.com/tldr-pages/tldr.git `npm fund {{package}}` -- List dependencies with a funding URL for a specific [w]orkspace for the project in the current directory: +- List dependencies with a funding URL for a specific workspace for the project in the current directory: -`npm fund -w {{workspace}}` +`npm fund {{[-w|--workspace]}} {{workspace}}` diff --git a/tldr/npm-home b/tldr/npm-home index b8e3f12a..6ad1d4a2 100644 --- a/tldr/npm-home +++ b/tldr/npm-home @@ -3,7 +3,7 @@ syntax: markdown tags: [tldr, common] source: https://github.com/tldr-pages/tldr.git --- -# npm home +# npm-home > Open the npm page, Yarn page, or GitHub repository of a package in the web browser. > More information: . @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - Open the GitHub repository of a specific package in the web browser: -`npm-home -g {{package}}` +`npm-home {{[-g|--github]}} {{package}}` - Open the Yarn page of a specific package in the web browser: -`npm-home -y {{package}}` +`npm-home {{[-y|--yarn]}} {{package}}` diff --git a/tldr/npm-init b/tldr/npm-init index ba954fcc..3a6ba250 100644 --- a/tldr/npm-init +++ b/tldr/npm-init @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Initialize a new package with default values: -`npm init -y` +`npm init {{[-y|--yes]}}` - Initialize a new package using a specific initializer: diff --git a/tldr/npm-login b/tldr/npm-login index 086fb022..cc2c4764 100644 --- a/tldr/npm-login +++ b/tldr/npm-login @@ -15,8 +15,8 @@ source: https://github.com/tldr-pages/tldr.git - Log in using a custom registry: -`npm login --registry={{registry_url}}` +`npm login --registry {{registry_url}}` - Log in using a specific authentication strategy: -`npm login --auth-type={{legacy|web}}` +`npm login --auth-type {{legacy|web}}` diff --git a/tldr/npm-logout b/tldr/npm-logout index 3e62d845..3b76560a 100644 --- a/tldr/npm-logout +++ b/tldr/npm-logout @@ -15,4 +15,4 @@ source: https://github.com/tldr-pages/tldr.git - Log out using a custom registry: -`npm logout --registry={{registry_url}}` +`npm logout --registry {{registry_url}}` diff --git a/tldr/npm-ls b/tldr/npm-ls index e657df79..d0ee4844 100644 --- a/tldr/npm-ls +++ b/tldr/npm-ls @@ -14,15 +14,15 @@ source: https://github.com/tldr-pages/tldr.git - Print all installed packages including peer dependencies: -`npm ls --all` +`npm ls {{[-a|--all]}}` - Print dependencies with extended information: -`npm ls --long` +`npm ls {{[-l|--long]}}` - Print dependencies in parseable format: -`npm ls --parseable` +`npm ls {{[-p|--parseable]}}` - Print dependencies in JSON format: diff --git a/tldr/npm-outdated b/tldr/npm-outdated index 1ecb3d53..a1cafc49 100644 --- a/tldr/npm-outdated +++ b/tldr/npm-outdated @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Find packages that are outdated regardless of the current project: -`npm outdated --all` +`npm outdated {{[-a|--all]}}` diff --git a/tldr/npm-query b/tldr/npm-query index 8b013dc9..a09f08e6 100644 --- a/tldr/npm-query +++ b/tldr/npm-query @@ -31,8 +31,8 @@ source: https://github.com/tldr-pages/tldr.git - Find all dependencies with postinstall scripts and uninstall them: `npm query ":attr(scripts, [postinstall])" | jq 'map(.name) | join(" -")' -r | xargs -I {} npm uninstall {}` +")' {{[-r|--raw-output]}} | xargs -I _ npm uninstall _` - Find all Git dependencies and print which application requires them: -`npm query ":type(git)" | jq 'map(.name)' | xargs -I {} npm why {}` +`npm query ":type(git)" | jq 'map(.name)' | xargs -I _ npm why _` diff --git a/tldr/npm-root b/tldr/npm-root index ce4d2af4..1952dbf1 100644 --- a/tldr/npm-root +++ b/tldr/npm-root @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Display path to the global `node_modules` directory: -`npm root --global` +`npm root {{[-g|--global]}}` diff --git a/tldr/npm-uninstall b/tldr/npm-uninstall index 8970c4ad..2210b3cb 100644 --- a/tldr/npm-uninstall +++ b/tldr/npm-uninstall @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Remove a package globally: -`npm uninstall -g {{package_name}}` +`npm uninstall {{[-g|--global]}} {{package_name}}` - Remove multiple packages at once: diff --git a/tldr/npm-unpublish b/tldr/npm-unpublish index 75903146..4e015f09 100644 --- a/tldr/npm-unpublish +++ b/tldr/npm-unpublish @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Unpublish the entire package: -`npm unpublish {{package_name}} --force` +`npm unpublish {{package_name}} {{[-f|--force]}}` - Unpublish a package that is scoped: diff --git a/tldr/npm-update b/tldr/npm-update index 4e0a031a..dcae66ab 100644 --- a/tldr/npm-update +++ b/tldr/npm-update @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Update a package globally: -`npm update -g {{package}}` +`npm update {{[-g|--global]}} {{package}}` - Update multiple packages at once: diff --git a/tldr/npm-version b/tldr/npm-version index 9200e867..15d9a5c9 100644 --- a/tldr/npm-version +++ b/tldr/npm-version @@ -26,4 +26,4 @@ source: https://github.com/tldr-pages/tldr.git - Bump the major version with a custom commit message: -`npm version major -m "{{Upgrade to %s for reasons}}"` +`npm version major {{[-m|--message]}} "{{Upgrade to %s for reasons}}"` diff --git a/tldr/nth b/tldr/nth index 7154de51..43e22c09 100644 --- a/tldr/nth +++ b/tldr/nth @@ -10,16 +10,16 @@ source: https://github.com/tldr-pages/tldr.git - Name a hash: -`nth -t {{5f4dcc3b5aa765d61d8327deb882cf99}}` +`nth {{[-t|--text]}} {{5f4dcc3b5aa765d61d8327deb882cf99}}` - Name hashes in a file: -`nth -f {{path/to/hashes}}` +`nth {{[-f|--file]}} {{path/to/hashes}}` - Print in JSON format: -`nth -t {{5f4dcc3b5aa765d61d8327deb882cf99}} -g` +`nth {{[-t|--text]}} {{5f4dcc3b5aa765d61d8327deb882cf99}} {{[-g|--greppable]}}` - Decode hash in Base64 before naming it: -`nth -t {{NWY0ZGNjM2I1YWE3NjVkNjFkODMyN2RlYjg4MmNmOTkK}} -b64` +`nth {{[-t|--text]}} {{NWY0ZGNjM2I1YWE3NjVkNjFkODMyN2RlYjg4MmNmOTkK}} {{[-b64|--base64]}}` diff --git a/tldr/nxc b/tldr/nxc index 792012f2..394b12a2 100644 --- a/tldr/nxc +++ b/tldr/nxc @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Network service enumeration and exploitation tool. > Some subcommands such as `smb` have their own usage documentation. -> More information: . +> More information: . - [L]ist available modules for the specified protocol: diff --git a/tldr/objdump b/tldr/objdump index d355fd58..b5d954be 100644 --- a/tldr/objdump +++ b/tldr/objdump @@ -10,20 +10,20 @@ source: https://github.com/tldr-pages/tldr.git - Display the file header information: -`objdump -f {{path/to/binary}}` +`objdump {{[-f|--file-headers]}} {{path/to/binary}}` - Display all header information: -`objdump -x {{path/to/binary}}` +`objdump {{[-x|--all-headers]}} {{path/to/binary}}` - Display the disassembled output of executable sections: -`objdump -d {{path/to/binary}}` +`objdump {{[-d|--disassemble]}} {{path/to/binary}}` - Display the disassembled executable sections in Intel syntax: -`objdump -M intel -d {{path/to/binary}}` +`objdump {{[-M|--disassembler-options]}} intel {{[-d|--disassemble]}} {{path/to/binary}}` - Display a complete binary hex dump of all sections: -`objdump -s {{path/to/binary}}` +`objdump {{[-s|--full-contents]}} {{path/to/binary}}` diff --git a/tldr/olevba b/tldr/olevba index d065db9b..0003c8f5 100644 --- a/tldr/olevba +++ b/tldr/olevba @@ -19,15 +19,15 @@ source: https://github.com/tldr-pages/tldr.git - Provide a password for encrypted Microsoft Office files (may be repeated): -`olevba --password {{password}} {{path/to/encrypted_file}}` +`olevba {{[-p|--password]}} {{password}} {{path/to/encrypted_file}}` - Display only analysis results, without showing macro source code: -`olevba -a {{path/to/file}}` +`olevba {{[-a|--analysis]}} {{path/to/file}}` - Display only macro source code: -`olevba -c {{path/to/file}}` +`olevba {{[-c|--code]}} {{path/to/file}}` - Show obfuscated strings and their decoded content: diff --git a/tldr/onionsearch b/tldr/onionsearch index c16fbf67..8e093e47 100644 --- a/tldr/onionsearch +++ b/tldr/onionsearch @@ -27,4 +27,4 @@ source: https://github.com/tldr-pages/tldr.git - List all supported search engines: -`onionsearch --help | grep -A1 -i "supported engines"` +`onionsearch --help | grep {{[-A|--after-context]}} 1 {{[-i|--ignore-case]}} "supported engines"` diff --git a/tldr/open b/tldr/open index a3e2723c..ad8e4b5d 100644 --- a/tldr/open +++ b/tldr/open @@ -9,7 +9,7 @@ source: https://github.com/tldr-pages/tldr.git - View documentation for the command available in macOS: -`tldr open -p osx` +`tldr open {{[-p|--platform]}} osx` - View documentation for the command available through fish: diff --git a/tldr/openscad b/tldr/openscad index 7e443895..e86ef05f 100644 --- a/tldr/openscad +++ b/tldr/openscad @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # openscad > Software for creating solid 3D CAD objects. -> More information: . +> More information: . - Open a file: diff --git a/tldr/openttd b/tldr/openttd index b22c56b0..74ab253e 100644 --- a/tldr/openttd +++ b/tldr/openttd @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # openttd > Open source clone of the Microprose game "Transport Tycoon Deluxe". -> More information: . +> More information: . - Start a new game: diff --git a/tldr/optipng b/tldr/optipng index 900b3fcb..7fe76793 100644 --- a/tldr/optipng +++ b/tldr/optipng @@ -14,11 +14,11 @@ source: https://github.com/tldr-pages/tldr.git - Compress a PNG with the best compression: -`optipng -o{{7}} {{path/to/file.png}}` +`optipng -o {{7}} {{path/to/file.png}}` - Compress a PNG with the fastest compression: -`optipng -o{{0}} {{path/to/file.png}}` +`optipng -o {{0}} {{path/to/file.png}}` - Compress a PNG and add interlacing: diff --git a/tldr/p7zip b/tldr/p7zip index 7c2640e9..7f90d39f 100644 --- a/tldr/p7zip +++ b/tldr/p7zip @@ -15,16 +15,16 @@ source: https://github.com/tldr-pages/tldr.git - Archive a file keeping the input file: -`p7zip -k {{path/to/file}}` +`p7zip {{[-k|--heep]}} {{path/to/file}}` - Decompress a file, replacing it with the original uncompressed version: -`p7zip -d {{compressed.ext}}.7z` +`p7zip {{[-d|--decompress]}} {{compressed.ext}}.7z` - Decompress a file keeping the input file: -`p7zip -d -k {{compressed.ext}}.7z` +`p7zip {{[-d|--decompress]}} {{[-k|--heep]}} {{compressed.ext}}.7z` - Skip some checks and force compression or decompression: -`p7zip -f {{path/to/file}}` +`p7zip {{[-f|--force]}} {{path/to/file}}` diff --git a/tldr/parallel b/tldr/parallel index 264ef4b5..c2fdeb4d 100644 --- a/tldr/parallel +++ b/tldr/parallel @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Read arguments from `stdin`, run 4 jobs at once: -`ls *.txt | parallel -j4 gzip` +`ls *.txt | parallel {{[-j|--jobs]}} 4 gzip` - Convert JPEG images to PNG using replacement strings: @@ -30,11 +30,11 @@ source: https://github.com/tldr-pages/tldr.git - Run on multiple machines via SSH: -`parallel -S {{machine1}},{{machine2}} {{command}} ::: {{arg1}} {{arg2}}` +`parallel {{[-S|--sshlogin]}} {{machine1}},{{machine2}} {{command}} ::: {{arg1}} {{arg2}}` - Download 4 files simultaneously from a text file containing links showing progress: -`parallel -j4 --bar --eta wget {{[-q|--quote]}} {} :::: {{path/to/links.txt}}` +`parallel {{[-j|--jobs]}} 4 --bar --eta wget {{[-q|--quote]}} {} :::: {{path/to/links.txt}}` - Print the jobs which `parallel` is running in `stderr`: diff --git a/tldr/pass b/tldr/pass index 1d374982..52dc3d45 100644 --- a/tldr/pass +++ b/tldr/pass @@ -15,7 +15,7 @@ source: https://github.com/tldr-pages/tldr.git - Save a new password and additional information (press `` on a new line to complete): -`pass insert --multiline {{path/to/data}}` +`pass insert {{[-m|--multiline]}} {{path/to/data}}` - Edit an entry: @@ -23,7 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - Copy a password (first line of the data file) to the clipboard: -`pass -c {{path/to/data}}` +`pass {{[-c|--clip]}} {{path/to/data}}` - List the whole store tree: @@ -31,7 +31,7 @@ source: https://github.com/tldr-pages/tldr.git - Generate a new random password with a given length, and copy it to the clipboard: -`pass generate -c {{path/to/data}} {{num}}` +`pass generate {{[-c|--clip]}} {{path/to/data}} {{num}}` - Initialize a new Git repository (any changes done by pass will be committed automatically): diff --git a/tldr/patch b/tldr/patch index ca1cb0c8..8631c0c2 100644 --- a/tldr/patch +++ b/tldr/patch @@ -19,12 +19,12 @@ source: https://github.com/tldr-pages/tldr.git - Patch a file writing the result to a different file: -`patch {{path/to/input_file}} -o {{path/to/output_file}} < {{patch.diff}}` +`patch {{path/to/input_file}} {{[-o|--output]}} {{path/to/output_file}} < {{patch.diff}}` - Apply a patch to the current directory: -`patch -p1 < {{patch.diff}}` +`patch {{[-p|--strip]}} 1 < {{patch.diff}}` - Apply the reverse of a patch: -`patch -R < {{patch.diff}}` +`patch {{[-R|--reverse]}} < {{patch.diff}}` diff --git a/tldr/pathchk b/tldr/pathchk index e776d949..e72ba181 100644 --- a/tldr/pathchk +++ b/tldr/pathchk @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Check pathnames for validity on all POSIX compliant systems: -`pathchk --portability {{path1 path2 …}}` +`pathchk {{[-p -P|--portability]}} {{path1 path2 …}}` - Only check for empty pathnames or leading dashes (-): diff --git a/tldr/peerindex b/tldr/peerindex index 45c2838b..fcb799cd 100644 --- a/tldr/peerindex +++ b/tldr/peerindex @@ -15,4 +15,4 @@ source: https://github.com/tldr-pages/tldr.git - Display all peers that have provided routing information: -`peerindex -r {{master6.mrt}}` +`peerindex {{[-r|--only-refs]}} {{master6.mrt}}` diff --git a/tldr/pg_ctl b/tldr/pg_ctl index 9142582e..ea3279a6 100644 --- a/tldr/pg_ctl +++ b/tldr/pg_ctl @@ -10,20 +10,20 @@ source: https://github.com/tldr-pages/tldr.git - Initialize a new PostgreSQL database cluster: -`pg_ctl -D {{data_directory}} init` +`pg_ctl {{[-D|--pgdata]}} {{data_directory}} init` - Start a PostgreSQL server: -`pg_ctl -D {{data_directory}} start` +`pg_ctl {{[-D|--pgdata]}} {{data_directory}} start` - Stop a PostgreSQL server: -`pg_ctl -D {{data_directory}} stop` +`pg_ctl {{[-D|--pgdata]}} {{data_directory}} stop` - Restart a PostgreSQL server: -`pg_ctl -D {{data_directory}} restart` +`pg_ctl {{[-D|--pgdata]}} {{data_directory}} restart` - Reload the PostgreSQL server configuration: -`pg_ctl -D {{data_directory}} reload` +`pg_ctl {{[-D|--pgdata]}} {{data_directory}} reload` diff --git a/tldr/pg_dump b/tldr/pg_dump index dc289f8c..b5f97fff 100644 --- a/tldr/pg_dump +++ b/tldr/pg_dump @@ -14,20 +14,20 @@ source: https://github.com/tldr-pages/tldr.git - Same as above, customize username: -`pg_dump -U {{username}} {{db_name}} > {{output_file.sql}}` +`pg_dump {{[-U|--username]}} {{username}} {{db_name}} > {{output_file.sql}}` - Same as above, customize host and port: -`pg_dump -h {{host}} -p {{port}} {{db_name}} > {{output_file.sql}}` +`pg_dump {{[-h|--host]}} {{host}} {{[-p|--port]}} {{port}} {{db_name}} > {{output_file.sql}}` - Dump a database into a custom-format archive file: -`pg_dump -Fc {{db_name}} > {{output_file.dump}}` +`pg_dump {{[-F|--format]}} {{[c|custom]}} {{db_name}} > {{output_file.dump}}` - Dump only database data into an SQL-script file: -`pg_dump -a {{db_name}} > {{path/to/output_file.sql}}` +`pg_dump {{[-a|--data-only]}} {{db_name}} > {{path/to/output_file.sql}}` - Dump only schema (data definitions) into an SQL-script file: -`pg_dump -s {{db_name}} > {{path/to/output_file.sql}}` +`pg_dump {{[-s|--schema-only]}} {{db_name}} > {{path/to/output_file.sql}}` diff --git a/tldr/pg_isready b/tldr/pg_isready index 5c0a6471..29b63a90 100644 --- a/tldr/pg_isready +++ b/tldr/pg_isready @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - Check connection with a specific hostname and port: -`pg_isready --host={{hostname}} --port={{port}}` +`pg_isready {{[-h|--host]}} {{hostname}} {{[-p|--port]}} {{port}}` - Check connection displaying a message only when the connection fails: -`pg_isready --quiet` +`pg_isready {{[-q|--quiet]}}` diff --git a/tldr/pg_restore b/tldr/pg_restore index 898b2895..a96ba074 100644 --- a/tldr/pg_restore +++ b/tldr/pg_restore @@ -10,24 +10,24 @@ source: https://github.com/tldr-pages/tldr.git - Restore an archive into an existing database: -`pg_restore -d {{db_name}} {{archive_file.dump}}` +`pg_restore {{[-d|--dbname]}} {{db_name}} {{archive_file.dump}}` - Same as above, customize username: -`pg_restore -U {{username}} -d {{db_name}} {{archive_file.dump}}` +`pg_restore {{[-U|--username]}} {{username}} {{[-d|--dbname]}} {{db_name}} {{archive_file.dump}}` - Same as above, customize host and port: -`pg_restore -h {{host}} -p {{port}} -d {{db_name}} {{archive_file.dump}}` +`pg_restore {{[-h|--host]}} {{host}} {{[-p|--port]}} {{port}} {{[-d|--dbname]}} {{db_name}} {{archive_file.dump}}` - List database objects included in the archive: -`pg_restore --list {{archive_file.dump}}` +`pg_restore {{[-l|--list]}} {{archive_file.dump}}` - Clean database objects before creating them: -`pg_restore --clean -d {{db_name}} {{archive_file.dump}}` +`pg_restore {{[-c|--clean]}} {{[-d|--dbname]}} {{db_name}} {{archive_file.dump}}` - Use multiple jobs to do the restoring: -`pg_restore -j {{2}} -d {{db_name}} {{archive_file.dump}}` +`pg_restore {{[-j|--jobs]}} {{2}} {{[-d|--dbname]}} {{db_name}} {{archive_file.dump}}` diff --git a/tldr/phing b/tldr/phing index 3eaa585a..c4d59e71 100644 --- a/tldr/phing +++ b/tldr/phing @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # phing > A PHP build tool based on Apache Ant. -> More information: . +> More information: . - Perform the default task in the `build.xml` file: @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Initialize a new build file: -`phing -i {{path/to/build.xml}}` +`phing {{[-i|--init]}} {{path/to/build.xml}}` - Perform a specific task: @@ -22,7 +22,7 @@ source: https://github.com/tldr-pages/tldr.git - Use the given build file path: -`phing -f {{path/to/build.xml}} {{task_name}}` +`phing {{[-f|-buildfile]}} {{path/to/build.xml}} {{task_name}}` - Log to the given file: diff --git a/tldr/phpspec b/tldr/phpspec index 35cde844..98fbb725 100644 --- a/tldr/phpspec +++ b/tldr/phpspec @@ -22,11 +22,11 @@ source: https://github.com/tldr-pages/tldr.git - Run specifications using a specific configuration file: -`phpspec run -c {{path/to/configuration_file}}` +`phpspec run {{[-c|--config]}} {{path/to/configuration_file}}` - Run specifications using a specific bootstrap file: -`phpspec run -b {{path/to/bootstrap_file}}` +`phpspec run {{[-b|--bootstrap]}} {{path/to/bootstrap_file}}` - Disable code generation prompts: diff --git a/tldr/pigz b/tldr/pigz index d812db7a..33b33218 100644 --- a/tldr/pigz +++ b/tldr/pigz @@ -14,11 +14,11 @@ source: https://github.com/tldr-pages/tldr.git - Compress a file using the best compression method: -`pigz -9 {{path/to/file}}` +`pigz {{[-9|--best]}} {{path/to/file}}` - Compress a file using no compression and 4 processors: -`pigz -0 -p{{4}} {{path/to/file}}` +`pigz -0 {{[-p|--processes]}} {{4}} {{path/to/file}}` - Compress a directory using tar: @@ -26,8 +26,8 @@ source: https://github.com/tldr-pages/tldr.git - Decompress a file: -`pigz -d {{archive.gz}}` +`pigz {{[-d|--decompress]}} {{archive.gz}}` - List the contents of an archive: -`pigz -l {{archive.tar.gz}}` +`pigz {{[-l|--list]}} {{archive.tar.gz}}` diff --git a/tldr/ping.py b/tldr/ping.py new file mode 100644 index 00000000..59e4c21c --- /dev/null +++ b/tldr/ping.py @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ping.py + +> Simple ICMP ping using Impacket to check if an IPv4 host is reachable. +> Sends ICMP echo requests and listens for echo replies. Requires root privileges for raw socket access (e.g., run with `sudo`). +> More information: . + +- Ping a host from a specified source IPv4 address: + +`ping.py {{source_ipv4}} {{destination_ipv4}}` + +- Ping 192.168.1.100 from 192.168.1.10: + +`ping.py 192.168.1.10 192.168.1.100` diff --git a/tldr/ping6.py b/tldr/ping6.py new file mode 100644 index 00000000..c4a11995 --- /dev/null +++ b/tldr/ping6.py @@ -0,0 +1,18 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ping6.py + +> Simple ICMPv6 ping using Impacket to check if an IPv6 host is reachable. +> Sends ICMPv6 echo requests and listens for echo replies. Requires root privileges for raw socket access (e.g., run with `sudo`). +> More information: . + +- Ping an IPv6 host from a specified source IPv6 address: + +`ping6.py {{source_ipv6}} {{destination_ipv6}}` + +- Ping 2001:db8::2 from 2001:db8::1: + +`ping6.py 2001:db8::1 2001:db8::2` diff --git a/tldr/pip b/tldr/pip index bb563e3a..c37d05f4 100644 --- a/tldr/pip +++ b/tldr/pip @@ -19,7 +19,7 @@ source: https://github.com/tldr-pages/tldr.git - Upgrade a package: -`pip install --upgrade {{package}}` +`pip install {{[-U|--upgrade]}} {{package}}` - Uninstall a package: @@ -35,4 +35,4 @@ source: https://github.com/tldr-pages/tldr.git - Install packages from a file: -`pip install --requirement {{requirements.txt}}` +`pip install {{[-r|--requirement]}} {{requirements.txt}}` diff --git a/tldr/pip-freeze b/tldr/pip-freeze index d561b61e..ec2c1dea 100644 --- a/tldr/pip-freeze +++ b/tldr/pip-freeze @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - List installed packages in a virtual environment, excluding globally installed packages: -`pip freeze --local > requirements.txt` +`pip freeze {{[-l|--local]}} > requirements.txt` - List installed packages in the user-site: diff --git a/tldr/pip-install b/tldr/pip-install index bf924e45..e1b92e3b 100644 --- a/tldr/pip-install +++ b/tldr/pip-install @@ -18,12 +18,12 @@ source: https://github.com/tldr-pages/tldr.git - Install packages listed in a file: -`pip install -r {{path/to/requirements.txt}}` +`pip install {{[-r|--requirement]}} {{path/to/requirements.txt}}` - Install packages from an URL or local file archive (.tar.gz | .whl): -`pip install --find-links {{url|path/to/file}}` +`pip install {{[-f|--find-links]}} {{url|path/to/file}}` - Install the local package in the current directory in develop (editable) mode: -`pip install --editable {{.}}` +`pip install {{[-e|--editable]}} {{.}}` diff --git a/tldr/pip-uninstall b/tldr/pip-uninstall index 848d8b78..c65ff34a 100644 --- a/tldr/pip-uninstall +++ b/tldr/pip-uninstall @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - Uninstall packages listed in a specific file: -`pip uninstall --requirement {{path/to/requirements.txt}}` +`pip uninstall {{[-r|--requirement]}} {{path/to/requirements.txt}}` - Uninstall package without asking for confirmation: -`pip uninstall --yes {{package}}` +`pip uninstall {{[-y|--yes]}} {{package}}` diff --git a/tldr/pip3 b/tldr/pip3 index bf392c01..5cf3081b 100644 --- a/tldr/pip3 +++ b/tldr/pip3 @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Upgrade a package: -`pip3 install --upgrade {{package}}` +`pip3 install {{[-U|--upgrade]}} {{package}}` - Uninstall a package: @@ -30,7 +30,7 @@ source: https://github.com/tldr-pages/tldr.git - Install packages from a file: -`pip3 install --requirement {{requirements.txt}}` +`pip3 install {{[-r|--requirement]}} {{requirements.txt}}` - Show installed package info: diff --git a/tldr/pnmtofiasco b/tldr/pnmtofiasco index 912f8856..e58f879d 100644 --- a/tldr/pnmtofiasco +++ b/tldr/pnmtofiasco @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Specify the compression quality: -`pnmtofiasco {{[-qua|--quality]}} {{quality_level}} {{path/to/file.pnm}} > {{path/to/file.fiasco}}` +`pnmtofiasco {{[-q|--quality]}} {{quality_level}} {{path/to/file.pnm}} > {{path/to/file.fiasco}}` - Load the options to be used from the specified configuration file: diff --git a/tldr/podman-compose b/tldr/podman-compose index ed7b4184..e9637ed2 100644 --- a/tldr/podman-compose +++ b/tldr/podman-compose @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Create and start all containers in the background using a local `docker-compose.yml`: -`podman-compose up -d` +`podman-compose up {{[-d|--detach]}}` - Start all containers, building if needed: @@ -30,11 +30,11 @@ source: https://github.com/tldr-pages/tldr.git - Remove all containers, networks, and volumes: -`podman-compose down --volumes` +`podman-compose down {{[-v|--volumes]}}` - Follow logs for a container (omit all container names): -`podman-compose logs --follow {{container_name}}` +`podman-compose logs {{[-f|--follow]}} {{container_name}}` - Run a one-time command in a service with no ports mapped: diff --git a/tldr/popeye b/tldr/popeye index a7572312..dc01fbe7 100644 --- a/tldr/popeye +++ b/tldr/popeye @@ -14,12 +14,12 @@ source: https://github.com/tldr-pages/tldr.git - Scan a specific namespace: -`popeye -n {{namespace}}` +`popeye {{[-n|--namespace]}} {{namespace}}` - Scan specific Kubernetes context: -`popeye --context={{context}}` +`popeye --context {{context}}` - Use a spinach configuration file for scanning: -`popeye -f {{spinach.yaml}}` +`popeye {{[-f|--file]}} {{spinach.yaml}}` diff --git a/tldr/powershell b/tldr/powershell index 55faa24b..e2f970ce 100644 --- a/tldr/powershell +++ b/tldr/powershell @@ -15,4 +15,4 @@ source: https://github.com/tldr-pages/tldr.git - View the documentation for the command referring to the legacy Windows PowerShell (version 5.1 and below): -`tldr powershell -p windows` +`tldr powershell {{[-p|--platform]}} windows` diff --git a/tldr/progress b/tldr/progress index 544206e4..cbc1373c 100644 --- a/tldr/progress +++ b/tldr/progress @@ -14,12 +14,12 @@ source: https://github.com/tldr-pages/tldr.git - Show the progress of running coreutils in quiet mode: -`progress -q` +`progress {{[-q|--quiet]}}` - Launch and monitor a single long-running command: -`{{command}} & progress --monitor --pid $!` +`{{command}} & progress {{[-m|--monitor]}} {{[-p|--pid]}} $!` - Include an estimate of time remaining for completion: -`progress --wait --command {{firefox}}` +`progress {{[-w|--wait]}} {{[-c|--command]}} {{firefox}}` diff --git a/tldr/proxify b/tldr/proxify index 215e39d2..dd3a732e 100644 --- a/tldr/proxify +++ b/tldr/proxify @@ -15,11 +15,11 @@ source: https://github.com/tldr-pages/tldr.git - Start a HTTP proxy on a custom network interface and port (may require `sudo` for a port number lower than `1024`): -`proxify -http-addr "{{ip_address}}:{{port_number}}"` +`proxify {{[-ha|-http-addr]}} "{{ip_address}}:{{port_number}}"` - Specify output format and output file: -`proxify -output-format {{jsonl|yaml}} -output {{path/to/file}}` +`proxify {{[-of|-output-format]}} {{jsonl|yaml}} {{[-o|-output]}} {{path/to/file}}` - Display help: diff --git a/tldr/psql b/tldr/psql index 121737d7..d21f897d 100644 --- a/tldr/psql +++ b/tldr/psql @@ -14,16 +14,16 @@ source: https://github.com/tldr-pages/tldr.git - Connect to the database on given server host running on given port with given username, without a password prompt: -`psql -h {{host}} -p {{port}} -U {{username}} {{database}}` +`psql {{[-h|--host]}} {{host}} {{[-p|--port]}} {{port}} {{[-U|--username]}} {{username}} {{database}}` - Connect to the database; user will be prompted for password: -`psql -h {{host}} -p {{port}} -U {{username}} -W {{database}}` +`psql {{[-h|--host]}} {{host}} {{[-p|--port]}} {{port}} {{[-U|--username]}} {{username}} {{[-W|--password]}} {{database}}` - Execute a single SQL query or PostgreSQL command on the given database (useful in shell scripts): -`psql -c '{{query}}' {{database}}` +`psql {{[-c|--command]}} '{{query}}' {{database}}` - Execute commands from a file on the given database: -`psql {{database}} -f {{file.sql}}` +`psql {{database}} {{[-f|--file]}} {{file.sql}}` diff --git a/tldr/pssh b/tldr/pssh index 6d8efa6b..1ebac8a9 100644 --- a/tldr/pssh +++ b/tldr/pssh @@ -10,24 +10,24 @@ source: https://github.com/tldr-pages/tldr.git - Run a command on two hosts, and print its output on each server inline: -`pssh -i -H "{{host1}} {{host2}}" {{hostname -i}}` +`pssh {{[-i|--inline]}} {{[-H|--host]}} "{{host1}} {{host2}}" {{hostname --ip-addresses}}` - Run a command and save the output to separate files: -`pssh -H {{host1}} -H {{host2}} -o {{path/to/output_dir}} {{hostname -i}}` +`pssh {{[-H|--host]}} {{host1}} {{[-H|--host]}} {{host2}} {{[-o|--outdir]}} {{path/to/output_dir}} {{hostname --ip-addresses}}` - Run a command on multiple hosts, specified in a new-line separated file: -`pssh -i -h {{path/to/hosts_file}} {{hostname -i}}` +`pssh {{[-i|--inline]}} {{[-h|--hosts]}} {{path/to/hosts_file}} {{hostname --ip-addresses}}` - Run a command as root (this asks for the root password): -`pssh -i -h {{path/to/hosts_file}} -A -l {{root_username}} {{hostname -i}}` +`pssh {{[-i|--inline]}} {{[-h|--hosts]}} {{path/to/hosts_file}} {{[-A|--askpass]}} {{[-l|--user]}} {{root_username}} {{hostname --ip-addresses}}` - Run a command with extra SSH arguments: -`pssh -i -h {{path/to/hosts_file}} -x "{{-O VisualHostKey=yes}}" {{hostname -i}}` +`pssh {{[-i|--inline]}} {{[-h|--hosts]}} {{path/to/hosts_file}} {{[-x|--extra-arg]}} "{{-O VisualHostKey=yes}}" {{hostname --ip-addresses}}` - Run a command limiting the number of parallel connections to 10: -`pssh -i -h {{path/to/hosts_file}} -p {{10}} '{{cd dir; ./script.sh; exit}}'` +`pssh {{[-i|--inline]}} {{[-h|--hosts]}} {{path/to/hosts_file}} {{[-p|-par]}} {{10}} '{{cd dir; ./script.sh; exit}}'` diff --git a/tldr/pt b/tldr/pt index d6a1fd53..7f48cbc7 100644 --- a/tldr/pt +++ b/tldr/pt @@ -15,15 +15,15 @@ source: https://github.com/tldr-pages/tldr.git - Find files containing "foo" and display count of matches in each file: -`pt -c {{foo}}` +`pt {{[-c|--count]}} {{foo}}` - Find files containing "foo" as a whole word and ignore its case: -`pt -wi {{foo}}` +`pt {{[-wi|--word-regexp --ignore-case]}} {{foo}}` - Find "foo" in files with a given extension using a regular expression: -`pt -G='{{\.bar$}}' {{foo}}` +`pt {{[-G|--file-search-regexp]}}='{{\.bar$}}' {{foo}}` - Find files whose contents match the regular expression, up to 2 directories deep: diff --git a/tldr/ptpython b/tldr/ptpython index 6151eed7..f7fd679b 100644 --- a/tldr/ptpython +++ b/tldr/ptpython @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Execute a specific Python file and start a REPL: -`ptpython -i {{path/to/file.py}}` +`ptpython {{[-i|--interactive]}} {{path/to/file.py}}` - Open the menu: diff --git a/tldr/pueue b/tldr/pueue index f14385a5..20b5cf7e 100644 --- a/tldr/pueue +++ b/tldr/pueue @@ -11,7 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - Show general help and available subcommands: -`pueue --help` +`pueue {{[-h|--help]}}` - Execute a pueue subcommand: @@ -19,4 +19,4 @@ source: https://github.com/tldr-pages/tldr.git - Check the version of pueue: -`pueue --version` +`pueue {{[-V|--version]}}` diff --git a/tldr/pueue-add b/tldr/pueue-add index b9b1ff72..d7947a34 100644 --- a/tldr/pueue-add +++ b/tldr/pueue-add @@ -18,16 +18,16 @@ source: https://github.com/tldr-pages/tldr.git - Add a command but do not start it if it's the first in a queue: -`pueue add --stashed -- {{rsync --archive --compress /local/directory /remote/directory}}` +`pueue add {{[-s|--stashed]}} -- {{rsync {{[-a|--archive]}} {{[-z|--compress]}} /local/directory /remote/directory}}` - Add a command to a group and start it immediately, see `pueue group` to manage groups: -`pueue add --immediate --group "{{CPU_intensive}}" -- {{ffmpeg -i input.mp4 frame_%d.png}}` +`pueue add {{[-i|--immediate]}} {{[-g|--group]}} "{{CPU_intensive}}" -- {{ffmpeg -i input.mp4 frame_%d.png}}` - Add a command and start it after commands 9 and 12 finish successfully: -`pueue add --after {{9}} {{12}} --group "{{torrents}}" -- {{transmission-cli torrent_file.torrent}}` +`pueue add {{[-a|--after]}} {{9}} {{12}} {{[-g|--group]}} "{{torrents}}" -- {{transmission-cli torrent_file.torrent}}` - Add a command with a label after some delay has passed, see `pueue enqueue` for valid datetime formats: -`pueue add --label "{{compressing large file}}" --delay "{{wednesday 10:30pm}}" -- "{{7z a compressed_file.7z large_file.xml}}"` +`pueue add {{[-l|--label]}} "{{compressing large file}}" {{[-d|--delay]}} "{{wednesday 10:30pm}}" -- "{{7z a compressed_file.7z large_file.xml}}"` diff --git a/tldr/pueue-clean b/tldr/pueue-clean index 93541d14..129cfc85 100644 --- a/tldr/pueue-clean +++ b/tldr/pueue-clean @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Only clean commands that finished successfully: -`pueue clean --successful-only` +`pueue clean {{[-s|--successful-only]}}` diff --git a/tldr/pueue-enqueue b/tldr/pueue-enqueue index 84d9e6aa..f0e95024 100644 --- a/tldr/pueue-enqueue +++ b/tldr/pueue-enqueue @@ -15,20 +15,20 @@ source: https://github.com/tldr-pages/tldr.git - Enqueue a stashed task after 60 seconds: -`pueue enqueue --delay {{60}} {{task_id}}` +`pueue enqueue {{[-d|--delay]}} {{60}} {{task_id}}` - Enqueue a stashed task next Wednesday: -`pueue enqueue --delay {{wednesday}} {{task_id}}` +`pueue enqueue {{[-d|--delay]}} {{wednesday}} {{task_id}}` - Enqueue a stashed task after four months: -`pueue enqueue --delay "4 months" {{task_id}}` +`pueue enqueue {{[-d|--delay]}} "4 months" {{task_id}}` - Enqueue a stashed task on 2021-02-19: -`pueue enqueue --delay {{2021-02-19}} {{task_id}}` +`pueue enqueue {{[-d|--delay]}} {{2021-02-19}} {{task_id}}` - List all available date/time formats: -`pueue enqueue --help` +`pueue enqueue {{[-h|--help]}}` diff --git a/tldr/pueue-group b/tldr/pueue-group index d89767fa..5cc8f7e5 100644 --- a/tldr/pueue-group +++ b/tldr/pueue-group @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - Add a custom group: -`pueue group --add "{{group_name}}"` +`pueue group add "{{group_name}}"` - Remove a group and move its tasks to the default group: -`pueue group --remove "{{group_name}}"` +`pueue group remove "{{group_name}}"` diff --git a/tldr/pueue-kill b/tldr/pueue-kill index 3b109864..78c88cd9 100644 --- a/tldr/pueue-kill +++ b/tldr/pueue-kill @@ -22,8 +22,8 @@ source: https://github.com/tldr-pages/tldr.git - Kill all tasks in a group and pause the group: -`pueue kill --group {{group_name}}` +`pueue kill {{[-g|--group]}} {{group_name}}` - Kill all tasks across all groups and pause all groups: -`pueue kill --all` +`pueue kill {{[-a|--all]}}` diff --git a/tldr/pueue-log b/tldr/pueue-log index 44986787..c8261f8f 100644 --- a/tldr/pueue-log +++ b/tldr/pueue-log @@ -23,4 +23,4 @@ source: https://github.com/tldr-pages/tldr.git - Print a specific number of lines from the tail of output: -`pueue log --lines {{number_of_lines}} {{task_id}}` +`pueue log {{[-l|--lines]}} {{number_of_lines}} {{task_id}}` diff --git a/tldr/pueue-parallel b/tldr/pueue-parallel index 1aca7ab8..fb94544e 100644 --- a/tldr/pueue-parallel +++ b/tldr/pueue-parallel @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Set the maximum number of tasks allowed to run in parallel, in a specific group: -`pueue parallel --group {{group_name}} {{maximum_number_of_parallel_tasks}}` +`pueue parallel {{[-g|--group]}} {{group_name}} {{maximum_number_of_parallel_tasks}}` diff --git a/tldr/pueue-pause b/tldr/pueue-pause index 6cc47bd8..63a13a22 100644 --- a/tldr/pueue-pause +++ b/tldr/pueue-pause @@ -23,8 +23,8 @@ source: https://github.com/tldr-pages/tldr.git - Pause all tasks in a group and prevent it from starting new tasks: -`pueue pause --group {{group_name}}` +`pueue pause {{[-g|--group]}} {{group_name}}` - Pause all tasks and prevent all groups from starting new tasks: -`pueue pause --all` +`pueue pause {{[-a|--all]}}` diff --git a/tldr/pueue-reset b/tldr/pueue-reset index f5e43c42..1adaaa52 100644 --- a/tldr/pueue-reset +++ b/tldr/pueue-reset @@ -18,4 +18,4 @@ source: https://github.com/tldr-pages/tldr.git - Reset without asking for confirmation: -`pueue reset --force` +`pueue reset {{[-f|--force]}}` diff --git a/tldr/pueue-restart b/tldr/pueue-restart index 93fcbbef..fe7eea40 100644 --- a/tldr/pueue-restart +++ b/tldr/pueue-restart @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Restart multiple tasks at once, and start them immediately (do not enqueue): -`pueue restart --start-immediately {{task_id}} {{task_id}}` +`pueue restart {{[-k|--immediately]}} {{task_id}} {{task_id}}` - Restart a specific task from a different path: @@ -22,12 +22,12 @@ source: https://github.com/tldr-pages/tldr.git - Edit a command before restarting: -`pueue restart --edit {{task_id}}` +`pueue restart {{[-e|--edit]}} {{task_id}}` - Restart a task in-place (without enqueuing as a separate task): -`pueue restart --in-place {{task_id}}` +`pueue restart {{[-i|--in-place]}} {{task_id}}` - Restart all failed tasks and stash them: -`pueue restart --all-failed --stashed` +`pueue restart {{[-a|--all-failed]}} --stashed` diff --git a/tldr/pueue-start b/tldr/pueue-start index 73f969f7..9456f823 100644 --- a/tldr/pueue-start +++ b/tldr/pueue-start @@ -23,7 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - Resume all tasks and start their children: -`pueue start --all --children` +`pueue start {{[-a|--all]}} --children` - Resume all tasks in a specific group: diff --git a/tldr/pueue-status b/tldr/pueue-status index 96fb9ce1..50bb356a 100644 --- a/tldr/pueue-status +++ b/tldr/pueue-status @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Show the status of a specific group: -`pueue status --group {{group_name}}` +`pueue status {{[-g|--group]}} {{group_name}}` diff --git a/tldr/pushd b/tldr/pushd index 721dd3c0..e859c72b 100644 --- a/tldr/pushd +++ b/tldr/pushd @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Place a directory on a stack so it can be accessed later. > See also `popd` to switch back to original directory and `dirs` to display directory stack contents. -> More information: . +> More information: . - Switch to directory and push it on the stack: diff --git a/tldr/pv b/tldr/pv index 37500633..18488c01 100644 --- a/tldr/pv +++ b/tldr/pv @@ -14,20 +14,20 @@ source: https://github.com/tldr-pages/tldr.git - Measure the speed and amount of data flow between pipes (`--size` is optional): -`command1 | pv --size {{expected_amount_of_data_for_eta}} | command2` +`command1 | pv {{[-s|--size]}} {{expected_amount_of_data_for_eta}} | command2` - Filter a file, see both progress and amount of output data: -`pv -cN in {{big_text_file}} | grep {{pattern}} | pv -cN out > {{filtered_file}}` +`pv {{[-cN|--cursor --name]}} in {{big_text_file}} | grep {{pattern}} | pv {{[-cN|--cursor --name]}} out > {{filtered_file}}` - Attach to an already running process and see its file reading progress: -`pv -d {{PID}}` +`pv {{[-d|--watchfd]}} {{PID}}` - Read an erroneous file, skip errors as `dd conv=sync,noerror` would: -`pv -EE {{path/to/faulty_media}} > image.img` +`pv {{[-EE|--skip-errors --skip-errors]}} {{path/to/faulty_media}} > image.img` - Stop reading after reading specified amount of data, rate limit to 1K/s: -`pv -L 1K --stop-at --size {{maximum_file_size_to_be_read}}` +`pv {{[-L|--rate-limit]}} 1K {{[-S|--stop-at-size]}} {{maximum_file_size_to_be_read}}` diff --git a/tldr/py-spy b/tldr/py-spy index 994f5ef6..367189e4 100644 --- a/tldr/py-spy +++ b/tldr/py-spy @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Show a live view of the functions that take the most execution time of a running process: -`py-spy top --pid {{pid}}` +`py-spy top {{[-p|--pid]}} {{pid}}` - Start a program and show a live view of the functions that take the most execution time: @@ -18,8 +18,8 @@ source: https://github.com/tldr-pages/tldr.git - Produce an SVG flame graph of the function call execution time: -`py-spy record -o {{path/to/profile.svg}} --pid {{pid}}` +`py-spy record {{[-o|--output]}} {{path/to/profile.svg}} {{[-p|--pid]}} {{pid}}` - Dump the call stack of a running process: -`py-spy dump --pid {{pid}}` +`py-spy dump {{[-p|--pid]}} {{pid}}` diff --git a/tldr/q b/tldr/q index ce9d67b2..1ea38397 100644 --- a/tldr/q +++ b/tldr/q @@ -10,15 +10,15 @@ source: https://github.com/tldr-pages/tldr.git - Query a CSV file by specifying the delimiter as ',': -`q -d',' "SELECT * from {{path/to/file}}"` +`q {{[-d|--delimiter]}} ',' "SELECT * from {{path/to/file}}"` - Query a TSV file: -`q -t "SELECT * from {{path/to/file}}"` +`q {{[-t|--tab-delimited]}} "SELECT * from {{path/to/file}}"` - Query file with header row: -`q -d{{delimiter}} -H "SELECT * from {{path/to/file}}"` +`q {{[-d|--delimiter]}} {{delimiter}} {{[-H|--skip-header]}} "SELECT * from {{path/to/file}}"` - Read data from `stdin`; '-' in the query represents the data from `stdin`: @@ -30,4 +30,4 @@ source: https://github.com/tldr-pages/tldr.git - Format output using an output delimiter with an output header line (Note: command will output column names based on the input file header or the column aliases overridden in the query): -`q -D{{delimiter}} -O "SELECT {{column}} as {{alias}} from {{path/to/file}}"` +`q {{[-D|--output-delimiter]}} {{delimiter}} {{[-O|--output-header]}} "SELECT {{column}} as {{alias}} from {{path/to/file}}"` diff --git a/tldr/qrencode b/tldr/qrencode index 4e28fbe9..bc13092e 100644 --- a/tldr/qrencode +++ b/tldr/qrencode @@ -6,20 +6,20 @@ source: https://github.com/tldr-pages/tldr.git # qrencode > QR Code generator. Supports PNG and EPS. -> More information: . +> More information: . - Convert a string to a QR code and save to an output file: -`qrencode -o {{path/to/output_file.png}} {{string}}` +`qrencode {{[-o|--output]}} {{path/to/output_file.png}} {{string}}` - Convert an input file to a QR code and save to an output file: -`qrencode -o {{path/to/output_file.png}} -r {{path/to/input_file}}` +`qrencode {{[-o|--output]}} {{path/to/output_file.png}} {{[-r|--read-from]}} {{path/to/input_file}}` - Convert a string to a QR code and print it in terminal: -`qrencode -t ansiutf8 {{string}}` +`qrencode {{[-t|--type]}} ansiutf8 {{string}}` - Convert input from pipe to a QR code and print it in terminal: -`echo {{string}} | qrencode -t ansiutf8` +`echo {{string}} | qrencode {{[-t|--type]}} ansiutf8` diff --git a/tldr/quilt b/tldr/quilt index e36fd5f1..60531e55 100644 --- a/tldr/quilt +++ b/tldr/quilt @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # quilt > Manage a series of patches. -> More information: . +> More information: . - Import an existing patch from a file: diff --git a/tldr/quota b/tldr/quota index 9ad22fd5..d243869d 100644 --- a/tldr/quota +++ b/tldr/quota @@ -10,20 +10,20 @@ source: https://github.com/tldr-pages/tldr.git - Show disk quotas in human-readable units for the current user: -`quota -s` +`quota {{[-s|--human-readable]}}` - Verbose output (also display quotas on filesystems where no storage is allocated): -`quota -v` +`quota {{[-v|--verbose]}}` - Quiet output (only display quotas on filesystems where usage is over quota): -`quota -q` +`quota {{[-q|--quiet]}}` - Print quotas for the groups of which the current user is a member: -`quota -g` +`quota {{[-g|--group]}}` - Show disk quotas for another user: -`sudo quota -u {{username}}` +`sudo quota {{[-u|--user]}} {{username}}` diff --git a/tldr/r b/tldr/r index d71da1d7..80ba1ec5 100644 --- a/tldr/r +++ b/tldr/r @@ -14,11 +14,11 @@ source: https://github.com/tldr-pages/tldr.git - Start R in vanilla mode (i.e. a blank session that doesn't save the workspace at the end): -`R --vanilla` +`R {{[-v|--vanilla]}}` - Execute a file: -`R -f {{path/to/file.R}}` +`R {{[-f|--file]}} {{path/to/file.R}}` - Execute an R expression and then exit: @@ -26,7 +26,7 @@ source: https://github.com/tldr-pages/tldr.git - Run R with a debugger: -`R -d {{debugger}}` +`R {{[-d|--debugger]}} {{debugger}}` - Check R packages from package sources: diff --git a/tldr/rails b/tldr/rails index 880f6c95..2abb5f77 100644 --- a/tldr/rails +++ b/tldr/rails @@ -31,7 +31,7 @@ source: https://github.com/tldr-pages/tldr.git - Start local server for current project on a specified port: -`rails server -p "{{port}}"` +`rails server {{[-p|--port]}} "{{port}}"` - Open console to interact with application from command-line: @@ -39,4 +39,4 @@ source: https://github.com/tldr-pages/tldr.git - Check current version of rails: -`rails --version` +`rails {{[-v|--version]}}` diff --git a/tldr/rails-console b/tldr/rails-console index f745c0ac..b565030e 100644 --- a/tldr/rails-console +++ b/tldr/rails-console @@ -14,12 +14,12 @@ source: https://github.com/tldr-pages/tldr.git - Start the Rails console and roll back all data modifications on exit: -`rails console --sandbox` +`rails console {{[-s|--sandbox]}}` - Start the Rails console on a specified environment: -`rails console --environment {{dev|test|production|...}}` +`rails console {{[-e|--environment]}} {{dev|test|production|...}}` - Display help: -`rails console --help` +`rails console {{[-h|--help]}}` diff --git a/tldr/rails-new b/tldr/rails-new index 5a8d38ee..4450a73a 100644 --- a/tldr/rails-new +++ b/tldr/rails-new @@ -18,12 +18,12 @@ source: https://github.com/tldr-pages/tldr.git - Create a Rails app with `postgresql` as the database: -`rails new {{app_name}} --database postgresql` +`rails new {{app_name}} {{[-d|--database]}} postgresql` - Create a Rails app without generating JavaScript files: -`rails new {{app_name}} --skip-javascript` +`rails new {{app_name}} {{[-J|--skip-javascript]}}` - Display help: -`rails new --help` +`rails new {{[-h|--help]}}` diff --git a/tldr/rails-routes b/tldr/rails-routes index 18077056..389fd23c 100644 --- a/tldr/rails-routes +++ b/tldr/rails-routes @@ -18,8 +18,8 @@ source: https://github.com/tldr-pages/tldr.git - List routes partially matching URL helper method name, HTTP verb, or URL path: -`rails routes -g {{posts_path|GET|/posts}}` +`rails routes {{[-g|--grep]}} {{posts_path|GET|/posts}}` - List routes that map to a specified controller: -`rails routes -c {{posts|Posts|Blogs::PostsController}}` +`rails routes {{[-c|--controller]}} {{posts|Posts|Blogs::PostsController}}` diff --git a/tldr/rails-server b/tldr/rails-server index 8139bea5..af93d4df 100644 --- a/tldr/rails-server +++ b/tldr/rails-server @@ -14,16 +14,16 @@ source: https://github.com/tldr-pages/tldr.git - Run the web server on a specified port: -`rails server --port {{port_number}}` +`rails server {{[-p|--port]}} {{port_number}}` - Run the web server on a specified IP address: -`rails server --binding {{ip_address}}` +`rails server {{[-b|--binding]}} {{ip_address}}` - Run the web server on a specified environment: -`rails server --environment {{environment}}` +`rails server {{[-e|--environment]}} {{environment}}` - Display help: -`rails server --help` +`rails server {{[-h|--help]}}` diff --git a/tldr/rapper b/tldr/rapper index fdfc247d..4b5064ca 100644 --- a/tldr/rapper +++ b/tldr/rapper @@ -11,8 +11,8 @@ source: https://github.com/tldr-pages/tldr.git - Convert an RDF/XML document to Turtle: -`rapper -i rdfxml -o turtle {{path/to/file}}` +`rapper {{[-i|--input]}} rdfxml {{[-o|--output]}} turtle {{path/to/file}}` - Count the number of triples in a Turtle file: -`rapper -i turtle -c {{path/to/file}}` +`rapper {{[-i|--input]}} turtle {{[-c|--count]}} {{path/to/file}}` diff --git a/tldr/rbac-lookup b/tldr/rbac-lookup index ed378ba4..6ac97e1a 100644 --- a/tldr/rbac-lookup +++ b/tldr/rbac-lookup @@ -18,11 +18,11 @@ source: https://github.com/tldr-pages/tldr.git - View all RBAC bindings along with the source role binding: -`rbac-lookup -o wide` +`rbac-lookup {{[-o|--output]}} wide` - View all RBAC bindings filtered by subject: -`rbac-lookup -k {{user|group|serviceaccount}}` +`rbac-lookup {{[-k|--kind]}} {{user|group|serviceaccount}}` - View all RBAC bindings along with IAM roles (if you are using GKE): diff --git a/tldr/rclone b/tldr/rclone index 9b54f0e9..45a061f7 100644 --- a/tldr/rclone +++ b/tldr/rclone @@ -22,7 +22,7 @@ source: https://github.com/tldr-pages/tldr.git - Copy files changed within the past 24 hours to a remote from the local machine, asking the user to confirm each file: -`rclone copy --interactive --max-age 24h {{remote_name}}:{{path/to/directory}} {{path/to/local_directory}}` +`rclone copy {{[-i|--interactive]}} --max-age 24h {{remote_name}}:{{path/to/directory}} {{path/to/local_directory}}` - Mirror a specific file or directory (Note: Unlike copy, sync removes files from the remote if it does not exist locally): @@ -30,7 +30,7 @@ source: https://github.com/tldr-pages/tldr.git - Delete a remote file or directory (Note: `--dry-run` means test, remove it from the command to actually delete): -`rclone --dry-run delete {{remote_name}}:{{path/to/file_or_directory}}` +`rclone {{[-n|--dry-run]}} delete {{remote_name}}:{{path/to/file_or_directory}}` - Mount rclone remote (experimental): @@ -38,4 +38,4 @@ source: https://github.com/tldr-pages/tldr.git - Unmount rclone remote if `` fails (experimental): -`fusermount -u {{path/to/mount_point}}` +`fusermount {{[-u|--update]}} {{path/to/mount_point}}` diff --git a/tldr/route b/tldr/route index 70e4e5e6..f86e64cb 100644 --- a/tldr/route +++ b/tldr/route @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # route -> Use route cmd to set the route table. +> Show and manipulate the route table. > More information: . - Display the information of route table: diff --git a/tldr/rss2email b/tldr/rss2email index 054a3de4..7b2bc1fe 100644 --- a/tldr/rss2email +++ b/tldr/rss2email @@ -30,4 +30,4 @@ source: https://github.com/tldr-pages/tldr.git - Display help: -`r2e -h` +`r2e {{[-h|--help]}}` diff --git a/tldr/rsstail b/tldr/rsstail index e16b5395..7701d89b 100644 --- a/tldr/rsstail +++ b/tldr/rsstail @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # rsstail > `tail` for RSS feeds. -> More information: . +> More information: . - Show the feed of a given URL and wait for new entries appearing at the bottom: diff --git a/tldr/rtmpdump b/tldr/rtmpdump index 9cdf8839..6a60f74d 100644 --- a/tldr/rtmpdump +++ b/tldr/rtmpdump @@ -10,16 +10,16 @@ source: https://github.com/tldr-pages/tldr.git - Download a file: -`rtmpdump --rtmp {{rtmp://example.com/path/to/video}} -o {{file.ext}}` +`rtmpdump {{[-r|--rtmp]}} {{rtmp://example.com/path/to/video}} {{[-o|--flv]}} {{file.ext}}` - Download a file from a Flash player: -`rtmpdump --rtmp {{rtmp://example.com/path/to/video}} --swfVfy {{http://example.com/player}} --flashVer "{{LNX 10,0,32,18}}" -o {{file.ext}}` +`rtmpdump {{[-r|--rtmp]}} {{rtmp://example.com/path/to/video}} {{[-W|--swfVfy]}} {{http://example.com/player}} {{[-f|--flashVer]}} "{{LNX 10,0,32,18}}" {{[-o|--flv]}} {{file.ext}}` - Specify connection parameters if they are not detected correctly: -`rtmpdump --rtmp {{rtmp://example.com/path/to/video}} --app {{app_name}} --playpath {{path/to/video}} -o {{file.ext}}` +`rtmpdump {{[-r|--rtmp]}} {{rtmp://example.com/path/to/video}} {{[-a|--app]}} {{app_name}} {{[-y|--playpath]}} {{path/to/video}} {{[-o|--flv]}} {{file.ext}}` - Download a file from a server that requires a referrer: -`rtmpdump --rtmp {{rtmp://example.com/path/to/video}} --pageUrl {{http://example.com/webpage}} -o {{file.ext}}` +`rtmpdump {{[-r|--rtmp]}} {{rtmp://example.com/path/to/video}} {{[-p|--pageUrl]}} {{http://example.com/webpage}} {{[-o|--flv]}} {{file.ext}}` diff --git a/tldr/rustc b/tldr/rustc index f597e274..ba99c3c4 100644 --- a/tldr/rustc +++ b/tldr/rustc @@ -15,7 +15,7 @@ source: https://github.com/tldr-pages/tldr.git - Compile with optimizations (`s` means optimize for binary size; `z` is the same with even more optimizations): -`rustc -C lto -C opt-level={{0|1|2|3|s|z}} {{path/to/main.rs}}` +`rustc {{[-C|--codegen]}} lto {{[-C|--codegen]}} opt-level={{0|1|2|3|s|z}} {{path/to/main.rs}}` - Compile with debugging information: @@ -27,7 +27,7 @@ source: https://github.com/tldr-pages/tldr.git - Compile with architecture-specific optimizations for the current CPU: -`rustc -C target-cpu={{native}} {{path/to/main.rs}}` +`rustc {{[-C|--codegen]}} target-cpu={{native}} {{path/to/main.rs}}` - Display the target list (Note: you have to add a target using `rustup` first to be able to compile for it): diff --git a/tldr/salt-call b/tldr/salt-call index c56259ed..9cd9148e 100644 --- a/tldr/salt-call +++ b/tldr/salt-call @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Perform a highstate with verbose debugging output: -`salt-call -l debug state.highstate` +`salt-call {{[-l|--log-level]}} debug state.highstate` - List this minion's grains: diff --git a/tldr/salt-key b/tldr/salt-key index 1a248734..40462d15 100644 --- a/tldr/salt-key +++ b/tldr/salt-key @@ -11,16 +11,16 @@ source: https://github.com/tldr-pages/tldr.git - List all accepted, unaccepted and rejected minion keys: -`salt-key -L` +`salt-key {{[-L|--list-all]}}` - Accept a minion key by name: -`salt-key -a {{MINION_ID}}` +`salt-key {{[-a|--accept-all]}} {{MINION_ID}}` - Reject a minion key by name: -`salt-key -r {{MINION_ID}}` +`salt-key {{[-r|--reject]}} {{MINION_ID}}` - Print fingerprints of all public keys: -`salt-key -F` +`salt-key {{[-F|--finger-all]}}` diff --git a/tldr/samtools b/tldr/samtools index 172c12dd..75f9a046 100644 --- a/tldr/samtools +++ b/tldr/samtools @@ -11,15 +11,15 @@ source: https://github.com/tldr-pages/tldr.git - Convert a SAM input file to BAM stream and save to file: -`samtools view -S -b {{input.sam}} > {{output.bam}}` +`samtools view -S {{[-b|--bam]}} {{input.sam}} > {{output.bam}}` - Take input from `stdin` (-) and print the SAM header and any reads overlapping a specific region to `stdout`: -`{{other_command}} | samtools view -h - chromosome:start-end` +`{{other_command}} | samtools view {{[-h|--with-header]}} - chromosome:start-end` - Sort file and save to BAM (the output format is automatically determined from the output file's extension): -`samtools sort {{input}} -o {{output.bam}}` +`samtools sort {{input}} {{[-o|--output]}} {{output.bam}}` - Index a sorted BAM file (creates `sorted_input.bam.bai`): diff --git a/tldr/scc b/tldr/scc index 5a6843a9..6639ef1a 100644 --- a/tldr/scc +++ b/tldr/scc @@ -22,11 +22,11 @@ source: https://github.com/tldr-pages/tldr.git - Display output using a specific output format (defaults to `tabular`): -`scc --format {{tabular|wide|json|csv|cloc-yaml|html|html-table}}` +`scc {{[-f|--format]}} {{tabular|wide|json|csv|cloc-yaml|html|html-table}}` - Only count files with specific file extensions: -`scc --include-ext {{go,java,js}}` +`scc {{[-i|--include-ext]}} {{go,java,js}}` - Exclude directories from being counted: @@ -34,8 +34,8 @@ source: https://github.com/tldr-pages/tldr.git - Display output and sort by column (defaults to by files): -`scc --sort {{files|name|lines|blanks|code|comments|complexity}}` +`scc {{[-s|--sort]}} {{files|name|lines|blanks|code|comments|complexity}}` - Display help: -`scc -h` +`scc {{[-h|--help]}}` diff --git a/tldr/sd b/tldr/sd index 71a4fb3e..fcff4da7 100644 --- a/tldr/sd +++ b/tldr/sd @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Find and replace in a specific file (output stream: `stdout`): -`sd -p {{'window.fetch'}} {{'fetch'}} {{path/to/file.js}}` +`sd {{[-p|--preview]}} {{'window.fetch'}} {{'fetch'}} {{path/to/file.js}}` - Find and replace in all files in the current project (output stream: `stdout`): diff --git a/tldr/sdiff b/tldr/sdiff index ea707b09..7621a37e 100644 --- a/tldr/sdiff +++ b/tldr/sdiff @@ -14,16 +14,16 @@ source: https://github.com/tldr-pages/tldr.git - Compare 2 files, ignoring all tabs and whitespace: -`sdiff -W {{path/to/file1}} {{path/to/file2}}` +`sdiff {{[-W|--ignore-all-space]}} {{path/to/file1}} {{path/to/file2}}` - Compare 2 files, ignoring whitespace at the end of lines: -`sdiff -Z {{path/to/file1}} {{path/to/file2}}` +`sdiff {{[-Z|--ignore-trailing-space]}} {{path/to/file1}} {{path/to/file2}}` - Compare 2 files in a case-insensitive manner: -`sdiff -i {{path/to/file1}} {{path/to/file2}}` +`sdiff {{[-i|--ignore-case]}} {{path/to/file1}} {{path/to/file2}}` - Compare and then merge, writing the output to a new file: -`sdiff -o {{path/to/merged_file}} {{path/to/file1}} {{path/to/file2}}` +`sdiff {{[-o|--output]}} {{path/to/merged_file}} {{path/to/file1}} {{path/to/file2}}` diff --git a/tldr/serverless b/tldr/serverless index 9377850e..d62816db 100644 --- a/tldr/serverless +++ b/tldr/serverless @@ -31,4 +31,4 @@ source: https://github.com/tldr-pages/tldr.git - Follow the logs for a project: -`serverless logs -t` +`serverless logs {{[-t|--tail]}}` diff --git a/tldr/shred b/tldr/shred index 11e60729..d1f1b523 100644 --- a/tldr/shred +++ b/tldr/shred @@ -30,4 +30,4 @@ source: https://github.com/tldr-pages/tldr.git - 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|--verbose --zero -u --iterations]}} 100 {{path/to/file}}` +`shred {{[-vzun|--verbose --zero --remove --iterations]}} 100 {{path/to/file}}` diff --git a/tldr/skaffold b/tldr/skaffold index b04fe711..62110c59 100644 --- a/tldr/skaffold +++ b/tldr/skaffold @@ -10,20 +10,20 @@ source: https://github.com/tldr-pages/tldr.git - Build the artifacts: -`skaffold build -f {{skaffold.yaml}}` +`skaffold build {{[-f|--filename]}} {{skaffold.yaml}}` - Build and deploy your app every time your code changes: -`skaffold dev -f {{skaffold.yaml}}` +`skaffold dev {{[-f|--filename]}} {{skaffold.yaml}}` - Run a pipeline file: -`skaffold run -f {{skaffold.yaml}}` +`skaffold run {{[-f|--filename]}} {{skaffold.yaml}}` - Run a diagnostic on Skaffold: -`skaffold diagnose -f {{skaffold.yaml}}` +`skaffold diagnose {{[-f|--filename]}} {{skaffold.yaml}}` - Deploy the artifacts: -`skaffold deploy -f {{skaffold.yaml}}` +`skaffold deploy {{[-f|--filename]}} {{skaffold.yaml}}` diff --git a/tldr/sonar-scanner b/tldr/sonar-scanner index 9493f44b..caa4236d 100644 --- a/tldr/sonar-scanner +++ b/tldr/sonar-scanner @@ -14,12 +14,12 @@ source: https://github.com/tldr-pages/tldr.git - Scan a project using configuration file other than `sonar-project.properties`: -`sonar-scanner -D{{project.settings=myproject.properties}}` +`sonar-scanner {{[-D|--define]}} {{project.settings=myproject.properties}}` - Print debugging information: -`sonar-scanner -X` +`sonar-scanner {{[-X|--debug]}}` - Display help: -`sonar-scanner -h` +`sonar-scanner {{[-h|--help]}}` diff --git a/tldr/sort b/tldr/sort index fcf000d3..da9c995c 100644 --- a/tldr/sort +++ b/tldr/sort @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Sort a file in case-insensitive way: -`sort {{-f|--ignore-case}} {{path/to/file}}` +`sort {{[-f|--ignore-case]}} {{path/to/file}}` - Sort a file using numeric rather than alphabetic order: diff --git a/tldr/sox b/tldr/sox index 29a497c8..b420f5ec 100644 --- a/tldr/sox +++ b/tldr/sox @@ -7,11 +7,11 @@ source: https://github.com/tldr-pages/tldr.git > Sound eXchange: play, record and convert audio files. > Audio formats are identified by the extension. -> More information: . +> More information: . - Merge two audio files into one: -`sox -m {{path/to/input_audio1}} {{path/to/input_audio2}} {{path/to/output_audio}}` +`sox {{[-m|--combine mix]}} {{path/to/input_audio1}} {{path/to/input_audio2}} {{path/to/output_audio}}` - Trim an audio file to the specified times: @@ -27,8 +27,8 @@ source: https://github.com/tldr-pages/tldr.git - Print statistical data of an audio file: -`sox {{path/to/input_audio}} -n stat` +`sox {{path/to/input_audio}} {{[-n|--null]}} stat` - Increase the volume of an audio file by 2x: -`sox -v 2.0 {{path/to/input_audio}} {{path/to/output_audio}}` +`sox {{[-v|--volume]}} 2.0 {{path/to/input_audio}} {{path/to/output_audio}}` diff --git a/tldr/sphinx-build b/tldr/sphinx-build index c639bed2..e55f9b54 100644 --- a/tldr/sphinx-build +++ b/tldr/sphinx-build @@ -10,8 +10,8 @@ source: https://github.com/tldr-pages/tldr.git - Build documentation: -`sphinx-build -b {{html|epub|text|latex|man|...}} {{path/to/source_dir}} {{path/to/build_dir}}` +`sphinx-build {{[-b|--builder]}} {{html|epub|text|latex|man|...}} {{path/to/source_dir}} {{path/to/build_dir}}` - Build documentations intended for readthedocs.io (requires the sphinx-rtd-theme pip package): -`sphinx-build -b {{html}} {{path/to/docs_dir}} {{path/to/build_dir}}` +`sphinx-build {{[-b|--builder]}} {{html}} {{path/to/docs_dir}} {{path/to/build_dir}}` diff --git a/tldr/sponge b/tldr/sponge index a29e4f4d..314ef511 100644 --- a/tldr/sponge +++ b/tldr/sponge @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Remove all lines starting with # in a file: -`grep -v '^{{#}}' {{path/to/file}} | sponge {{path/to/file}}` +`grep {{[-v|--invert-match]}} '^{{#}}' {{path/to/file}} | sponge {{path/to/file}}` diff --git a/tldr/sqlite-utils b/tldr/sqlite-utils index 0f948625..68c50d8a 100644 --- a/tldr/sqlite-utils +++ b/tldr/sqlite-utils @@ -38,4 +38,4 @@ source: https://github.com/tldr-pages/tldr.git - Display help: -`sqlite-utils -h` +`sqlite-utils {{[-h|--help]}}` diff --git a/tldr/sqlmap b/tldr/sqlmap index 9da818e3..a6c07de6 100644 --- a/tldr/sqlmap +++ b/tldr/sqlmap @@ -10,20 +10,20 @@ source: https://github.com/tldr-pages/tldr.git - Run sqlmap against a single target URL: -`python sqlmap.py -u "{{http://www.target.com/vuln.php?id=1}}"` +`python sqlmap.py {{[-u|--url]}} "{{http://www.target.com/vuln.php?id=1}}"` - Send data in a POST request (`--data` implies POST request): -`python sqlmap.py -u "{{http://www.target.com/vuln.php}}" --data="{{id=1}}"` +`python sqlmap.py {{[-u|--url]}} "{{http://www.target.com/vuln.php}}" --data="{{id=1}}"` - Change the parameter delimiter (& is the default): -`python sqlmap.py -u "{{http://www.target.com/vuln.php}}" --data="{{query=foobar;id=1}}" --param-del="{{;}}"` +`python sqlmap.py {{[-u|--url]}} "{{http://www.target.com/vuln.php}}" --data="{{query=foobar;id=1}}" --param-del="{{;}}"` - Select a random `User-Agent` from `./txt/user-agents.txt` and use it: -`python sqlmap.py -u "{{http://www.target.com/vuln.php}}" --random-agent` +`python sqlmap.py {{[-u|--url]}} "{{http://www.target.com/vuln.php}}" --random-agent` - Provide user credentials for HTTP protocol authentication: -`python sqlmap.py -u "{{http://www.target.com/vuln.php}}" --auth-type {{Basic}} --auth-cred "{{testuser:testpass}}"` +`python sqlmap.py {{[-u|--url]}} "{{http://www.target.com/vuln.php}}" --auth-type {{Basic}} --auth-cred "{{testuser:testpass}}"` diff --git a/tldr/srm b/tldr/srm index ce661ff6..76210e65 100644 --- a/tldr/srm +++ b/tldr/srm @@ -11,7 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - Remove a file after a single-pass overwriting with random data: -`srm -s {{path/to/file}}` +`srm {{[-s|--simple]}} {{path/to/file}}` - Remove a file after seven passes of overwriting with random data: @@ -19,8 +19,8 @@ source: https://github.com/tldr-pages/tldr.git - Recursively remove a directory and its contents overwriting each file with a single-pass of random data: -`srm -r -s {{path/to/directory}}` +`srm {{[-r|--recursive]}} {{[-s|--simple]}} {{path/to/directory}}` - Prompt before every removal: -`srm -i {{\*}}` +`srm {{[-i|--interactive]}} {{\*}}` diff --git a/tldr/st-util b/tldr/st-util index 4234d777..d633d1da 100644 --- a/tldr/st-util +++ b/tldr/st-util @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Run GDB server on port 4500: -`st-util -p {{4500}}` +`st-util {{[-p|--listen_port]}} {{4500}}` - Connect to GDB server: diff --git a/tldr/strings b/tldr/strings index c88fb559..2361a591 100644 --- a/tldr/strings +++ b/tldr/strings @@ -14,12 +14,12 @@ source: https://github.com/tldr-pages/tldr.git - Limit results to strings at least n characters long: -`strings -n {{n}} {{path/to/file}}` +`strings {{[-n|--bytes]}} {{n}} {{path/to/file}}` - Prefix each result with its offset within the file: -`strings -t d {{path/to/file}}` +`strings {{[-t|--radix]}} d {{path/to/file}}` - Prefix each result with its offset within the file in hexadecimal: -`strings -t x {{path/to/file}}` +`strings {{[-t|--radix]}} x {{path/to/file}}` diff --git a/tldr/subliminal b/tldr/subliminal index 51e29085..ce34f180 100644 --- a/tldr/subliminal +++ b/tldr/subliminal @@ -10,4 +10,4 @@ source: https://github.com/tldr-pages/tldr.git - Download English subtitles for a video: -`subliminal download -l {{en}} {{video.ext}}` +`subliminal download {{[-l|--language]}} {{en}} {{video.ext}}` diff --git a/tldr/supervisord b/tldr/supervisord index 250ee847..77644264 100644 --- a/tldr/supervisord +++ b/tldr/supervisord @@ -11,8 +11,8 @@ source: https://github.com/tldr-pages/tldr.git - Start `supervisord` with specified configuration file: -`supervisord -c {{path/to/file}}` +`supervisord {{[-c|--configuration]}} {{path/to/file}}` - Run supervisord in the foreground: -`supervisord -n` +`supervisord {{[-n|--nodaemon]}}` diff --git a/tldr/svgo b/tldr/svgo index c983ac4e..84ea0b19 100644 --- a/tldr/svgo +++ b/tldr/svgo @@ -15,23 +15,23 @@ source: https://github.com/tldr-pages/tldr.git - Optimize a file and save the result to another file: -`svgo {{test.svg}} -o {{test.min.svg}}` +`svgo {{test.svg}} {{[-o|--output]}} {{test.min.svg}}` - Optimize all SVG files within a directory (overwrites the original files): -`svgo -f {{path/to/directory/with/svg/files}}` +`svgo {{[-f|--folder]}} {{path/to/directory/with/svg/files}}` - Optimize all SVG files within a directory and save the resulting files to another directory: -`svgo -f {{path/to/input/directory}} -o {{path/to/output/directory}}` +`svgo {{[-f|--folder]}} {{path/to/input/directory}} {{[-o|--output]}} {{path/to/output/directory}}` - Optimize SVG content passed from another command, and save the result to a file: -`{{cat test.svg}} | svgo -i - -o {{test.min.svg}}` +`{{cat test.svg}} | svgo {{[-i|--input]}} - {{[-o|--output]}} {{test.min.svg}}` - Optimize a file and print out the result: -`svgo {{test.svg}} -o -` +`svgo {{test.svg}} {{[-o|--output]}} -` - Show available plugins: diff --git a/tldr/swagger-codegen b/tldr/swagger-codegen index 78f81ec1..5864c635 100644 --- a/tldr/swagger-codegen +++ b/tldr/swagger-codegen @@ -10,11 +10,11 @@ source: https://github.com/tldr-pages/tldr.git - Generate documentation and code from an OpenAPI/swagger file: -`swagger-codegen generate -i {{swagger_file}} -l {{language}}` +`swagger-codegen generate {{[-i|--input-spec]}} {{swagger_file}} {{[-l|--lang]}} {{language}}` - Generate Java code using the library retrofit2 and the option useRxJava2: -`swagger-codegen generate -i {{http://petstore.swagger.io/v2/swagger.json}} -l {{java}} --library {{retrofit2}} -D{{useRxJava2}}={{true}}` +`swagger-codegen generate {{[-i|--input-spec]}} {{http://petstore.swagger.io/v2/swagger.json}} {{[-l|--lang]}} {{java}} --library {{retrofit2}} -D{{useRxJava2}}={{true}}` - List available languages: diff --git a/tldr/tcpreplay b/tldr/tcpreplay index 48100d60..45b475c1 100644 --- a/tldr/tcpreplay +++ b/tldr/tcpreplay @@ -14,20 +14,20 @@ source: https://github.com/tldr-pages/tldr.git - Replay traffic to interface: -`tcpreplay -i {{eth0}} {{traffic.pcap}}` +`tcpreplay {{[-i|--intf1]}} {{eth0}} {{traffic.pcap}}` - Replay traffic to interface and `stdout`: -`tcpreplay -i {{eth0}} --verbose {{traffic.pcap}}` +`tcpreplay {{[-i|--intf1]}} {{eth0}} {{[-v|--verbose]}} {{traffic.pcap}}` - Replay traffic to interface as fast as possible: -`tcpreplay -i {{eth0}} --topspeed {{traffic.pcap}}` +`tcpreplay {{[-i|--intf1]}} {{eth0}} {{[-t|--topspeed]}} {{traffic.pcap}}` - Replay traffic to interface at given Mbps: -`tcpreplay -i {{eth0}} -M {{10}} {{traffic.pcap}}` +`tcpreplay {{[-i|--intf1]}} {{eth0}} {{[-M|--mbps]}} {{10}} {{traffic.pcap}}` - Replay traffic to interface several times: -`tcpreplay -i {{eth0}} --loop={{num_times}} {{traffic.pcap}}` +`tcpreplay {{[-i|--intf1]}} {{eth0}} {{[-l|--loop]}} {{num_times}} {{traffic.pcap}}` diff --git a/tldr/tee b/tldr/tee index 8c66845f..6cd175a3 100644 --- a/tldr/tee +++ b/tldr/tee @@ -22,4 +22,4 @@ source: https://github.com/tldr-pages/tldr.git - Create a directory called "example", count the number of characters in "example" and write "example" to the terminal: -`echo "example" | tee >(xargs mkdir) >(wc -c)` +`echo "example" | tee >(xargs mkdir) >(wc {{[-c|--bytes]}})` diff --git a/tldr/telnet b/tldr/telnet index 4d98004a..2338123f 100644 --- a/tldr/telnet +++ b/tldr/telnet @@ -26,7 +26,7 @@ source: https://github.com/tldr-pages/tldr.git - Start `telnet` with "x" as the session termination character: -`telnet -e {{x}} {{ip_address}} {{port}}` +`telnet {{[-e|--escape]}} {{x}} {{ip_address}} {{port}}` - Telnet to Star Wars animation: diff --git a/tldr/tokei b/tldr/tokei index 341062cd..9b3839b9 100644 --- a/tldr/tokei +++ b/tldr/tokei @@ -14,12 +14,12 @@ source: https://github.com/tldr-pages/tldr.git - Display a report for a directory excluding `.min.js` files: -`tokei {{path/to/directory}} -e {{*.min.js}}` +`tokei {{path/to/directory}} {{[-e|--exclude]}} {{*.min.js}}` - Display statistics for individual files in a directory: -`tokei {{path/to/directory}} --files` +`tokei {{path/to/directory}} {{[-f|--files]}}` - Display a report for all files of type Rust and Markdown: -`tokei {{path/to/directory}} -t={{Rust}},{{Markdown}}` +`tokei {{path/to/directory}} {{[-t|--type]}} {{Rust}},{{Markdown}}` diff --git a/tldr/topgrade b/tldr/topgrade index 67b60405..6347bfe0 100644 --- a/tldr/topgrade +++ b/tldr/topgrade @@ -14,11 +14,11 @@ source: https://github.com/tldr-pages/tldr.git - Say yes to all updates: -`topgrade -y` +`topgrade {{[-y|--yes]}}` - Cleanup temporary/old files: -`topgrade -c` +`topgrade {{[-c|--cleanup]}}` - Disable a certain update operation: diff --git a/tldr/tox b/tldr/tox index c7f393e4..5e75c051 100644 --- a/tldr/tox +++ b/tldr/tox @@ -19,7 +19,7 @@ source: https://github.com/tldr-pages/tldr.git - List the available environments: -`tox --listenvs-all` +`tox {{[-a|--listenvs-all]}}` - Run tests on a specific environment (e.g. Python 3.6): @@ -27,4 +27,4 @@ source: https://github.com/tldr-pages/tldr.git - Force the virtual environment to be recreated: -`tox --recreate -e {{py27}}` +`tox {{[-r|--recreate]}} -e {{py27}}` diff --git a/tldr/tqdm b/tldr/tqdm index f52403e2..d0965030 100644 --- a/tldr/tqdm +++ b/tldr/tqdm @@ -18,8 +18,8 @@ source: https://github.com/tldr-pages/tldr.git - Create an archive out of a directory and use the file count of that directory to create a progress bar: -`zip -r {{path/to/archive.zip}} {{path/to/directory}} | tqdm --total $(find {{path/to/directory}} | wc -l) --unit files --null` +`zip {{[-r|--recurse-paths]}} {{path/to/archive.zip}} {{path/to/directory}} | tqdm --total $(find {{path/to/directory}} | wc {{[-l|--lines]}}) --unit files --null` - Create an archive with tar and create a progress bar (system agnostic, GNU tar uses `stdout` while BSD tar uses `stderr`): -`tar vzcf {{path/to/archive.tar.gz}} {{path/to/directory}} 2>&1 | tqdm --total $(find {{path/to/directory}} | wc -l) --unit files --null` +`tar vzcf {{path/to/archive.tar.gz}} {{path/to/directory}} 2>&1 | tqdm --total $(find {{path/to/directory}} | wc {{[-l|--lines]}}) --unit files --null` diff --git a/tldr/traceroute b/tldr/traceroute index f97f45e5..4a5c4a0d 100644 --- a/tldr/traceroute +++ b/tldr/traceroute @@ -18,11 +18,11 @@ source: https://github.com/tldr-pages/tldr.git - Specify wait time in seconds for response: -`traceroute --wait={{0.5}} {{example.com}}` +`traceroute {{[-w|--wait]}} {{0.5}} {{example.com}}` - Specify number of queries per hop: -`traceroute --queries={{5}} {{example.com}}` +`traceroute {{[-q|--queries]}} {{5}} {{example.com}}` - Specify size in bytes of probing packet: @@ -34,4 +34,4 @@ source: https://github.com/tldr-pages/tldr.git - Use ICMP instead of UDP for tracerouting: -`traceroute --icmp {{example.com}}` +`traceroute {{[-I|--icmp]}} {{example.com}}` diff --git a/tldr/trans b/tldr/trans index c781a454..0b0821af 100644 --- a/tldr/trans +++ b/tldr/trans @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Get a brief translation: -`trans --brief "{{word_or_sentence_to_translate}}"` +`trans {{[-b|-brief]}} "{{word_or_sentence_to_translate}}"` - Translate a word into french: @@ -26,4 +26,4 @@ source: https://github.com/tldr-pages/tldr.git - Behave like a dictionary to get the meaning of a word: -`trans -d {{word}}` +`trans {{[-d|-dictionary]}} {{word}}` diff --git a/tldr/transmission-cli b/tldr/transmission-cli index 7c6d47e7..58d9f93c 100644 --- a/tldr/transmission-cli +++ b/tldr/transmission-cli @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > A lightweight, command-line BitTorrent client. > This tool has been deprecated, please see `transmission-remote`. -> More information: . +> More information: . - Download a specific torrent: @@ -15,7 +15,7 @@ source: https://github.com/tldr-pages/tldr.git - Download a torrent to a specific directory: -`transmission-cli --download-dir {{path/to/download_directory}} {{url|magnet|path/to/file}}` +`transmission-cli {{[-w|--download-dir]}} {{path/to/download_directory}} {{url|magnet|path/to/file}}` - Create a torrent file from a specific file or directory: @@ -23,20 +23,20 @@ source: https://github.com/tldr-pages/tldr.git - Specify the download speed limit (in KB/s): -`transmission-cli --downlimit {{50}} {{url|magnet|path/to/file}}` +`transmission-cli {{[-d|--downlimit]}} {{50}} {{url|magnet|path/to/file}}` - Specify the upload speed limit (in KB/s): -`transmission-cli --uplimit {{50}} {{url|magnet|path/to/file}}` +`transmission-cli {{[-u|--uplimit]}} {{50}} {{url|magnet|path/to/file}}` - Use a specific port for connections: -`transmission-cli --port {{port_number}} {{url|magnet|path/to/file}}` +`transmission-cli {{[-p|--port]}} {{port_number}} {{url|magnet|path/to/file}}` - Force encryption for peer connections: -`transmission-cli --encryption-required {{url|magnet|path/to/file}}` +`transmission-cli {{[-er|--encryption-required]}} {{url|magnet|path/to/file}}` - Use a Bluetack-formatted peer blocklist: -`transmission-cli --blocklist {{blocklist_url|path/to/blocklist}} {{url|magnet|path/to/file}}` +`transmission-cli {{[-b|--blocklist]}} {{blocklist_url|path/to/blocklist}} {{url|magnet|path/to/file}}` diff --git a/tldr/transmission-create b/tldr/transmission-create index 48970a03..3f5cf61c 100644 --- a/tldr/transmission-create +++ b/tldr/transmission-create @@ -9,22 +9,22 @@ source: https://github.com/tldr-pages/tldr.git > See also: `transmission`. > More information: . -- Create a torrent with 2048 KB as the piece size: +- Create a torrent with a specific piece size (in KB): -`transmission-create -o {{path/to/example.torrent}} --tracker {{tracker_announce_url}} --piecesize {{2048}} {{path/to/file_or_directory}}` +`transmission-create {{[-o|--outfile]}} {{path/to/example.torrent}} {{[-t|--tracker]}} {{tracker_announce_url}} {{[-s|--piecesize]}} {{2048}} {{path/to/file_or_directory}}` -- Create a private torrent with a 2048 KB piece size: +- Create a private torrent with a specific piece size (in KB): -`transmission-create -p -o {{path/to/example.torrent}} --tracker {{tracker_announce_url}} --piecesize {{2048}} {{path/to/file_or_directory}}` +`transmission-create {{[-p|--private]}} {{[-o|--outfile]}} {{path/to/example.torrent}} {{[-t|--tracker]}} {{tracker_announce_url}} {{[-s|--piecesize]}} {{2048}} {{path/to/file_or_directory}}` - Create a torrent with a comment: -`transmission-create -o {{path/to/example.torrent}} --tracker {{tracker_url1}} -c {{comment}} {{path/to/file_or_directory}}` +`transmission-create {{[-o|--outfile]}} {{path/to/example.torrent}} {{[-t|--tracker]}} {{tracker_url1}} {{[-c|--comment]}} {{comment}} {{path/to/file_or_directory}}` - Create a torrent with multiple trackers: -`transmission-create -o {{path/to/example.torrent}} --tracker {{tracker_url1}} --tracker {{tracker_url2}} {{path/to/file_or_directory}}` +`transmission-create {{[-o|--outfile]}} {{path/to/example.torrent}} {{[-t|--tracker]}} {{tracker_url1}} {{[-t|--tracker]}} {{tracker_url2}} {{path/to/file_or_directory}}` - Display help page: -`transmission-create --help` +`transmission-create {{[-h|--help]}}` diff --git a/tldr/transmission-daemon b/tldr/transmission-daemon index f1adfccb..d4dde8a1 100644 --- a/tldr/transmission-daemon +++ b/tldr/transmission-daemon @@ -15,12 +15,12 @@ source: https://github.com/tldr-pages/tldr.git - Start and watch a specific directory for new torrents: -`transmission-daemon --watch-dir {{path/to/directory}}` +`transmission-daemon {{[-c|--watch-dir]}} {{path/to/directory}}` - Dump daemon settings in JSON format: -`transmission-daemon --dump-settings > {{path/to/file.json}}` +`transmission-daemon {{[-d|--dump-settings]}} > {{path/to/file.json}}` - Start with specific settings for the web interface: -`transmission-daemon --auth --username {{username}} --password {{password}} --port {{9091}} --allowed {{127.0.0.1}}` +`transmission-daemon {{[-t|--auth]}} {{[-u|--username]}} {{username}} {{[-v|--password]}} {{password}} {{[-p|--port]}} {{9091}} {{[-a|--allowed]}} {{127.0.0.1}}` diff --git a/tldr/transmission-edit b/tldr/transmission-edit index d8233f53..c5e955f6 100644 --- a/tldr/transmission-edit +++ b/tldr/transmission-edit @@ -9,10 +9,14 @@ source: https://github.com/tldr-pages/tldr.git > See also: `transmission`. > More information: . -- Add or remove a URL from a torrent's announce list: +- Add a URL to a torrent's announce list: -`transmission-edit --{{add|delete}} {{http://example.com}} {{path/to/file.torrent}}` +`transmission-edit {{[-a|--add]}} {{http://example.com}} {{path/to/file.torrent}}` + +- Remove a URL from a torrent's announce list: + +`transmission-edit {{[-d|--delete]}} {{http://example.com}} {{path/to/file.torrent}}` - Update a tracker's passcode in a torrent file: -`transmission-edit --replace {{old-passcode}} {{new-passcode}} {{path/to/file.torrent}}` +`transmission-edit {{[-r|--replace]}} {{old-passcode}} {{new-passcode}} {{path/to/file.torrent}}` diff --git a/tldr/transmission-remote b/tldr/transmission-remote index fa0e3b0a..dbd53444 100644 --- a/tldr/transmission-remote +++ b/tldr/transmission-remote @@ -6,32 +6,32 @@ source: https://github.com/tldr-pages/tldr.git # transmission-remote > Remote control utility for `transmission-daemon` and `transmission`. -> More information: . +> More information: . - Add a torrent file or magnet link to Transmission and download to a specified directory: -`transmission-remote {{hostname}} -a {{torrent|url}} -w {{/path/to/download_directory}}` +`transmission-remote {{hostname}} {{[-a|--all]}} {{torrent|url}} {{[-w|--download-dir]}} {{/path/to/download_directory}}` - Change the default download directory: -`transmission-remote {{hostname}} -w {{/path/to/download_directory}}` +`transmission-remote {{hostname}} {{[-w|--download-dir]}} {{/path/to/download_directory}}` - List all torrents: -`transmission-remote {{hostname}} --list` +`transmission-remote {{hostname}} {{[-l|--list]}}` - Start torrent 1 and 2, stop torrent 3: -`transmission-remote {{hostname}} -t "{{1,2}}" --start -t {{3}} --stop` +`transmission-remote {{hostname}} {{[-t|--torrent]}} "1,2" {{[-s|--start]}} {{[-t|--torrent]}} 3 {{[-S|--stop]}}` - Remove torrent 1 and 2, and also delete local data for torrent 2: -`transmission-remote {{hostname}} -t {{1}} --remove -t {{2}} --remove-and-delete` +`transmission-remote {{hostname}} {{[-t|--torrent]}} 1 {{[-r|--remove]}} {{[-t|--torrent]}} 2 {{[-rad|--remove-and-delete]}}` - Stop all torrents: -`transmission-remote {{hostname}} -t {{all}} --stop` +`transmission-remote {{hostname}} {{[-t|--torrent]}} {{all}} {{[-S|--stop]}}` - Move torrents 1-10 and 15-20 to a new directory (which will be created if it does not exist): -`transmission-remote {{hostname}} -t "{{1-10,15-20}}" --move {{/path/to/new_directory}}` +`transmission-remote {{hostname}} {{[-t|--torrent]}} "1-10,15-20" --move {{/path/to/new_directory}}` diff --git a/tldr/transmission-show b/tldr/transmission-show index 2a5f785c..e9307155 100644 --- a/tldr/transmission-show +++ b/tldr/transmission-show @@ -15,8 +15,8 @@ source: https://github.com/tldr-pages/tldr.git - Generate a magnet link for a specific torrent: -`transmission-show --magnet {{path/to/file.torrent}}` +`transmission-show {{[-m|--magnet]}} {{path/to/file.torrent}}` - Query a torrent's trackers and print the current number of peers: -`transmission-show --scrape {{path/to/file.torrent}}` +`transmission-show {{[-s|--scrape]}} {{path/to/file.torrent}}` diff --git a/tldr/trivy b/tldr/trivy index c0e024c2..6c8364ba 100644 --- a/tldr/trivy +++ b/tldr/trivy @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Scan a Docker image filtering the output by severity: -`trivy image --severity {{HIGH,CRITICAL}} {{alpine:3.15}}` +`trivy image {{[-s|--severity]}} {{HIGH,CRITICAL}} {{alpine:3.15}}` - Scan a Docker image ignoring any unfixed/unpatched vulnerabilities: @@ -38,4 +38,4 @@ source: https://github.com/tldr-pages/tldr.git - Generate output with a SARIF template: -`trivy image --format {{template}} --template "{{@sarif.tpl}}" -o {{path/to/report.sarif}} {{image:tag}}` +`trivy image {{[-f|--format]}} {{template}} {{[-t|--template]}} "{{@sarif.tpl}}" {{[-o|--output]}} {{path/to/report.sarif}} {{image:tag}}` diff --git a/tldr/tspin b/tldr/tspin index 0ac15f0e..0d72cb05 100644 --- a/tldr/tspin +++ b/tldr/tspin @@ -14,11 +14,11 @@ source: https://github.com/tldr-pages/tldr.git - Read from another command and print to stdout: -`journalctl -b --follow | tspin` +`journalctl {{[-b|--boot]}} {{[-f|--follow]}} | tspin` - Read from file and print to `stdout`: -`tspin {{path/to/application.log}} --print` +`tspin {{path/to/application.log}} {{[-p|--print]}}` - Read from `stdin` and print to `stdout`: diff --git a/tldr/tuc b/tldr/tuc index 9c8b9889..59b0f9e2 100644 --- a/tldr/tuc +++ b/tldr/tuc @@ -11,20 +11,20 @@ source: https://github.com/tldr-pages/tldr.git - Cut and rearrange fields: -`echo "foo bar baz" | tuc -d '{{ }}' -f {{3,2,1}}` +`echo "foo bar baz" | tuc {{[-d|--delimiter]}} '{{ }}' {{[-f|--fields]}} {{3,2,1}}` - Replace the delimiter `space` with an arrow: -`echo "foo bar baz" | tuc -d ' ' -r ' ➡ '` +`echo "foo bar baz" | tuc {{[-d|--delimiter]}} ' ' {{[-r|--replace-delimiter]}} ' ➡ '` - Keep a range of fields: -`echo "foo bar baz" | tuc -d ' ' -f {{2:}}` +`echo "foo bar baz" | tuc {{[-d|--delimiter]}} ' ' {{[-f|--fields]}} {{2:}}` - Cut using regular expressions: -`echo "a,b, c" | tuc -e '{{[, ]+}}' -f {{1,3}}` +`echo "a,b, c" | tuc {{[-e|--regex]}} '{{[, ]+}}' {{[-f|--fields]}} {{1,3}}` - Emit JSON output: -`echo "foo bar baz" | tuc -d '{{ }}' --json` +`echo "foo bar baz" | tuc {{[-d|--delimiter]}} '{{ }}' --json` diff --git a/tldr/twm b/tldr/twm index 7f08ceaa..ec1077cd 100644 --- a/tldr/twm +++ b/tldr/twm @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # twm > A window manager for the X Window system. -> More information: . +> More information: . - Connect to the default X server: @@ -14,16 +14,16 @@ source: https://github.com/tldr-pages/tldr.git - Connect to a specific X server: -`twm -display {{display}}` +`twm {{[-d|-display]}} {{display}}` - Only manage the default screen: -`twm -s` +`twm {{[-s|-single]}}` - Use a specific startup file: -`twm -f {{path/to/file}}` +`twm {{[-f|-file]}} {{path/to/file}}` - Enable verbose mode and print unexpected errors in X: -`twm -v` +`twm {{[-v|-verbose]}}` diff --git a/tldr/twurl b/tldr/twurl index d1e15dd8..f6cf8fa9 100644 --- a/tldr/twurl +++ b/tldr/twurl @@ -10,23 +10,23 @@ source: https://github.com/tldr-pages/tldr.git - Authorize `twurl` to access a Twitter account: -`twurl authorize --consumer-key {{twitter_api_key}} --consumer-secret {{twitter_api_secret}}` +`twurl authorize {{[-c|--consumer-key]}} {{twitter_api_key}} {{[-s|--consumer-secret]}} {{twitter_api_secret}}` - Make a GET request to an API endpoint: -`twurl -X GET {{twitter_api_endpoint}}` +`twurl {{[-X|--request-method]}} GET {{twitter_api_endpoint}}` - Make a POST request to an API endpoint: -`twurl -X POST -d '{{endpoint_params}}' {{twitter_api_endpoint}}` +`twurl {{[-X|--request-method]}} POST {{[-d|--data]}} '{{endpoint_params}}' {{twitter_api_endpoint}}` - Upload media to Twitter: -`twurl -H "{{twitter_upload_url}}" -X POST "{{twitter_upload_endpoint}}" --file "{{path/to/media.jpg}}" --file-field "media"` +`twurl {{[-H|--host]}} "{{twitter_upload_url}}" {{[-X|--request-method]}} POST "{{twitter_upload_endpoint}}" {{[-f|--file]}} "{{path/to/media.jpg}}" {{[-F|--file-field]}} "media"` - Access a different Twitter API host: -`twurl -H {{twitter_api_url}} -X GET {{twitter_api_endpoint}}` +`twurl {{[-H|--host]}} {{twitter_api_url}} {{[-X|--request-method]}} GET {{twitter_api_endpoint}}` - Create an alias for a requested resource: diff --git a/tldr/ulimit b/tldr/ulimit index 94c43867..d3b2f70c 100644 --- a/tldr/ulimit +++ b/tldr/ulimit @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # ulimit > Get and set resource limits for user processes. -> More information: . +> More information: . - Get the properties of all the user limits: diff --git a/tldr/unar b/tldr/unar index f16cf70b..b0552826 100644 --- a/tldr/unar +++ b/tldr/unar @@ -14,16 +14,16 @@ source: https://github.com/tldr-pages/tldr.git - Extract an archive to the specified directory: -`unar -o {{path/to/directory}} {{path/to/archive}}` +`unar {{[-o|-output-directory]}} {{path/to/directory}} {{path/to/archive}}` - Force overwrite if files to be unpacked already exist: -`unar -f {{path/to/archive}}` +`unar {{[-f|-force-overwrite]}} {{path/to/archive}}` - Force rename if files to be unpacked already exist: -`unar -r {{path/to/archive}}` +`unar {{[-r|-force-rename]}} {{path/to/archive}}` - Force skip if files to be unpacked already exist: -`unar -s {{path/to/archive}}` +`unar {{[-s|-force-skip]}} {{path/to/archive}}` diff --git a/tldr/uuencode b/tldr/uuencode index 4099fe12..557bc097 100644 --- a/tldr/uuencode +++ b/tldr/uuencode @@ -18,4 +18,4 @@ source: https://github.com/tldr-pages/tldr.git - Encode a file using Base64 instead of the default uuencode encoding and write the result to a file: -`uuencode -m -o {{path/to/output_file}} {{path/to/input_file}} {{output_file_name_after_decoding}}` +`uuencode {{[-m|--base64]}} -o {{path/to/output_file}} {{path/to/input_file}} {{output_file_name_after_decoding}}` diff --git a/tldr/vinmap b/tldr/vinmap index 239fd5fc..99a044ba 100644 --- a/tldr/vinmap +++ b/tldr/vinmap @@ -10,20 +10,20 @@ source: https://github.com/tldr-pages/tldr.git - Perform a basic scan of a subnet: -`vinmap -ip {{192.168.1.0/24}}` +`vinmap {{[-ip|--ip_range]}} {{192.168.1.0/24}}` - Scan a domain with version and OS detection, saving results to a specific file: -`vinmap -ip {{example.com}} -s "-sV -O" -o {{path/to/scan_results.xml}}` +`vinmap {{[-ip|--ip_range]}} {{example.com}} {{[-s|--scan_type]}} "-sV -O" -o {{path/to/scan_results.xml}}` - Scan an IP range using 10 chunks and 20 concurrent threads, uses half of the system's CPU cores if not specified: -`vinmap -ip {{10.0.0.1-10.0.0.255}} -n 10 -t 20` +`vinmap {{[-ip|--ip_range]}} {{10.0.0.1-10.0.0.255}} {{[-n|--num_chunks]}} 10 {{[-t|--threads]}} 20` - Output scan results in JSON format: -`vinmap -ip {{192.168.1.1-192.168.1.100}} -f json` +`vinmap {{[-ip|--ip_range]}} {{192.168.1.1-192.168.1.100}} {{[-f|--format]}} json` - Scan multiple IPs with default settings and save merged XML output: -`vinmap -ip {{192.168.1.1,192.168.1.2,...}}` +`vinmap {{[-ip|--ip_range]}} {{192.168.1.1,192.168.1.2,...}}` diff --git a/tldr/visudo b/tldr/visudo index bebdaf9e..e290ffd8 100644 --- a/tldr/visudo +++ b/tldr/visudo @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Check the sudoers file for errors: -`sudo visudo -c` +`sudo visudo {{[-c|--check]}}` - Edit the sudoers file using a specific editor: @@ -22,4 +22,4 @@ source: https://github.com/tldr-pages/tldr.git - Display version information: -`visudo --version` +`visudo {{[-V|--version]}}` diff --git a/tldr/viu b/tldr/viu index c3d39d41..5813ef39 100644 --- a/tldr/viu +++ b/tldr/viu @@ -14,16 +14,16 @@ source: https://github.com/tldr-pages/tldr.git - Render an image or GIF from the internet using `curl`: -`curl -s {{https://example.com/image.png}} | viu -` +`curl {{[-s|--silent]}} {{https://example.com/image.png}} | viu -` - Render an image with a transparent background: -`viu -t {{path/to/file}}` +`viu {{[-t|--transparent]}} {{path/to/file}}` - Render an image with a specific width and height in pixels: -`viu -w {{width}} -h {{height}} {{path/to/file}}` +`viu {{[-w|--width]}} {{width}} {{[-h|--height]}} {{height}} {{path/to/file}}` - Render an image or GIF and display its file name: -`viu -n {{path/to/file}}` +`viu {{[-n|--name]}} {{path/to/file}}` diff --git a/tldr/wafw00f b/tldr/wafw00f index fa150524..ba159b65 100644 --- a/tldr/wafw00f +++ b/tldr/wafw00f @@ -20,7 +20,7 @@ source: https://github.com/tldr-pages/tldr.git `wafw00f {{[-p|--proxy]}} {{http://localhost:8080}} {{https://www.example.com}}` -- Test for a specific WAF product (run `wafw00f -l` to get list of all supported WAFs): +- Test for a specific WAF product (run `wafw00f --list` to get list of all supported WAFs): `wafw00f {{[-t|--test]}} {{Cloudflare|Cloudfront|Fastly|ZScaler|...}} {{https://www.example.com}}` diff --git a/tldr/wakeonlan b/tldr/wakeonlan index e17b6afe..80738fa1 100644 --- a/tldr/wakeonlan +++ b/tldr/wakeonlan @@ -14,12 +14,12 @@ source: https://github.com/tldr-pages/tldr.git - Send packet to a specific device via IP address: -`wakeonlan {{01:02:03:04:05:06}} -i {{192.168.178.2}}` +`wakeonlan {{01:02:03:04:05:06}} {{[-i|--ip]}} {{192.168.178.2}}` - Print the commands, but don't execute them (dry-run): -`wakeonlan -n {{01:02:03:04:05:06}}` +`wakeonlan {{[-n|--dry-run]}} {{01:02:03:04:05:06}}` - Run in quiet mode: -`wakeonlan -q {{01:02:03:04:05:06}}` +`wakeonlan {{[-q|--quiet]}} {{01:02:03:04:05:06}}` diff --git a/tldr/wasm-objdump b/tldr/wasm-objdump index 95e43904..941b5e7a 100644 --- a/tldr/wasm-objdump +++ b/tldr/wasm-objdump @@ -10,16 +10,16 @@ source: https://github.com/tldr-pages/tldr.git - Display the section headers of a given binary: -`wasm-objdump -h {{file.wasm}}` +`wasm-objdump {{[-h|--headers]}} {{file.wasm}}` - Display the entire disassembled output of a given binary: -`wasm-objdump -d {{file.wasm}}` +`wasm-objdump {{[-d|--disassemble]}} {{file.wasm}}` - Display the details of each section: -`wasm-objdump --details {{file.wasm}}` +`wasm-objdump {{[-x|--details]}} {{file.wasm}}` - Display the details of a given section: -`wasm-objdump --section '{{import}}' --details {{file.wasm}}` +`wasm-objdump {{[-j|--section]}} '{{import}}' {{[-x|--details]}} {{file.wasm}}` diff --git a/tldr/wasm-opt b/tldr/wasm-opt index 6a47d069..43e7d0ce 100644 --- a/tldr/wasm-opt +++ b/tldr/wasm-opt @@ -10,15 +10,15 @@ source: https://github.com/tldr-pages/tldr.git - Apply default optimizations and write to a given file: -`wasm-opt -O {{input.wasm}} -o {{output.wasm}}` +`wasm-opt -O {{input.wasm}} {{[-o|--output]}} {{output.wasm}}` - Apply all optimizations and write to a given file (takes more time, but generates optimal code): -`wasm-opt -O4 {{input.wasm}} -o {{output.wasm}}` +`wasm-opt -O4 {{input.wasm}} {{[-o|--output]}} {{output.wasm}}` - Optimize a file for size: -`wasm-opt -Oz {{input.wasm}} -o {{output.wasm}}` +`wasm-opt -Oz {{input.wasm}} {{[-o|--output]}} {{output.wasm}}` - Print the textual representation of the binary to console: diff --git a/tldr/wasm2c b/tldr/wasm2c index 10c0b290..ad282aeb 100644 --- a/tldr/wasm2c +++ b/tldr/wasm2c @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Write the output to a given file (`file.h` gets additionally generated): -`wasm2c {{file.wasm}} -o {{file.c}}` +`wasm2c {{file.wasm}} {{[-o|--output]}} {{file.c}}` diff --git a/tldr/wasm2wat b/tldr/wasm2wat index 7b4854c1..6be7df91 100644 --- a/tldr/wasm2wat +++ b/tldr/wasm2wat @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Write the output to a given file: -`wasm2wat {{file.wasm}} -o {{file.wat}}` +`wasm2wat {{file.wasm}} {{[-o|--output]}} {{file.wat}}` diff --git a/tldr/wat2wasm b/tldr/wat2wasm index 1f8829f1..567d684b 100644 --- a/tldr/wat2wasm +++ b/tldr/wat2wasm @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - Write the output binary to a given file: -`wat2wasm {{file.wat}} -o {{file.wasm}}` +`wat2wasm {{file.wat}} {{[-o|--output]}} {{file.wasm}}` - Display simplified representation of every byte: -`wat2wasm -v {{file.wat}}` +`wat2wasm {{[-v|--verbose]}} {{file.wat}}` diff --git a/tldr/watchexec b/tldr/watchexec index d180dc43..13a81ef5 100644 --- a/tldr/watchexec +++ b/tldr/watchexec @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # watchexec > Run arbitrary commands when files change. -> More information: . +> More information: . - Call `ls -la` when any file in the current directory changes: @@ -14,12 +14,12 @@ source: https://github.com/tldr-pages/tldr.git - Run `make` when any JavaScript, CSS and HTML file in the current directory changes: -`watchexec --exts {{js,css,html}} make` +`watchexec {{[-e|--exts]}} {{js,css,html}} make` - Run `make` when any file in the `lib` or `src` directory changes: -`watchexec --watch {{lib}} --watch {{src}} {{make}}` +`watchexec {{[-w|--watch]}} {{lib}} {{[-w|--watch]}} {{src}} {{make}}` - Call/restart `my_server` when any file in the current directory changes, sending `SIGKILL` to stop the child process: -`watchexec --restart --stop-signal {{SIGKILL}} {{my_server}}` +`watchexec {{[-r|--restart]}} --stop-signal {{SIGKILL}} {{my_server}}` diff --git a/tldr/waymore b/tldr/waymore index e9e83d0c..ffb673c5 100644 --- a/tldr/waymore +++ b/tldr/waymore @@ -11,16 +11,16 @@ source: https://github.com/tldr-pages/tldr.git - Search for URLs of a domain (output will typically be in `~/.config/waymore/results/`): -`waymore -i {{example.com}}` +`waymore {{[-i|--input]}} {{example.com}}` - Limit search results to only include a list of URLs for a domain and store outputs to the specified file: -`waymore -mode U -oU {{path/to/example.com-urls.txt}} -i {{example.com}}` +`waymore -mode U {{[-oU|--output-urls]}} {{path/to/example.com-urls.txt}} {{[-i|--input]}} {{example.com}}` - Only output the content bodies of URLs and store outputs to the specified directory: -`waymore -mode R -oR {{path/to/example.com-url-responses}} -i {{example.com}}` +`waymore -mode R {{[-oR|--output-responses]}} {{path/to/example.com-url-responses}} {{[-i|--input]}} {{example.com}}` - Filter the results by specifying date ranges: -`waymore -from {{YYYYMMDD|YYYYMM|YYYY}} -to {{YYYYMMDD|YYYYMM|YYYY}} -i {{example.com}}` +`waymore -from {{YYYYMMDD|YYYYMM|YYYY}} {{[-to|--to-date]}} {{YYYYMMDD|YYYYMM|YYYY}} {{[-i|--input]}} {{example.com}}` diff --git a/tldr/webstorm b/tldr/webstorm index 45fe8a50..4ed74600 100644 --- a/tldr/webstorm +++ b/tldr/webstorm @@ -16,7 +16,7 @@ source: https://github.com/tldr-pages/tldr.git `webstorm {{path/to/directory}}` -- Open specific files in the LightEdit mode: +- Open specific files in the LightEdit mode: `webstorm -e {{path/to/file1 path/to/file2 ...}}` diff --git a/tldr/whatweb b/tldr/whatweb index 5d705687..cb7ed07b 100644 --- a/tldr/whatweb +++ b/tldr/whatweb @@ -14,15 +14,15 @@ source: https://github.com/tldr-pages/tldr.git - Read targets/websites from a file: -`whatweb -i {{targets_file}}` +`whatweb {{[-i|--input-file]}} {{targets_file}}` - Scan a website/target in verbose mode: -`whatweb -v {{example.com}}` +`whatweb {{[-v|--verbose]}} {{example.com}}` - Run an aggressive scan on a website: -`whatweb -a 3 {{example.com}}` +`whatweb {{[-a|--aggression]}} 3 {{example.com}}` - Scan a network and suppress errors: @@ -30,8 +30,8 @@ source: https://github.com/tldr-pages/tldr.git - List plugins: -`whatweb -l` +`whatweb {{[-l|--list-plugins]}}` - List plugin details: -`whatweb -I {{plugin_name}}` +`whatweb {{[-I|--info-plugins]}} {{plugin_name}}` diff --git a/tldr/which b/tldr/which index 0a27a4e5..2bb74026 100644 --- a/tldr/which +++ b/tldr/which @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - If there are multiple executables which match, display all: -`which -a {{executable}}` +`which {{[-a|--all]}} {{executable}}` diff --git a/tldr/wondershaper b/tldr/wondershaper index d494865f..f12b64c5 100644 --- a/tldr/wondershaper +++ b/tldr/wondershaper @@ -8,10 +8,6 @@ source: https://github.com/tldr-pages/tldr.git > Allows the user to limit the bandwidth of network adapters. > More information: . -- Display [h]elp: - -`wondershaper -h` - - Show the current [s]tatus of a specific [a]dapter: `wondershaper -s -a {{adapter_name}}` @@ -31,3 +27,7 @@ source: https://github.com/tldr-pages/tldr.git - Set a specific maximum [d]ownload rate and [u]pload rate (in Kpbs): `wondershaper -a {{adapter_name}} -d {{1024}} -u {{512}}` + +- Display [h]elp: + +`wondershaper -h` diff --git a/tldr/wrk b/tldr/wrk index fddbd8e0..a0b6b3d5 100644 --- a/tldr/wrk +++ b/tldr/wrk @@ -10,12 +10,12 @@ source: https://github.com/tldr-pages/tldr.git - Run a benchmark for `30` seconds, using `12` threads, and keeping `400` HTTP connections open: -`wrk -t{{12}} -c{{400}} -d{{30s}} "{{http://127.0.0.1:8080/index.html}}"` +`wrk {{[-t|--threads]}} {{12}} {{[-c|--connections]}} {{400}} {{[-d|--duration]}} {{30s}} "{{http://127.0.0.1:8080/index.html}}"` - Run a benchmark with a custom header: -`wrk -t{{2}} -c{{5}} -d{{5s}} -H "{{Host: example.com}}" "{{http://example.com/index.html}}"` +`wrk {{[-t|--threads]}} {{2}} {{[-c|--connections]}} {{5}} {{[-d|--duration]}} {{5s}} {{[-H|--header]}} "{{Host: example.com}}" "{{http://example.com/index.html}}"` - Run a benchmark with a request timeout of `2` seconds: -`wrk -t{{2}} -c{{5}} -d{{5s}} --timeout {{2s}} "{{http://example.com/index.html}}"` +`wrk {{[-t|--threads]}} {{2}} {{[-c|--connections]}} {{5}} {{[-d|--duration]}} {{5s}} --timeout {{2s}} "{{http://example.com/index.html}}"` diff --git a/tldr/x_x b/tldr/x_x index 9ff9ca27..0e20d182 100644 --- a/tldr/x_x +++ b/tldr/x_x @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - View an XLSX or CSV file, using the first row as table headers: -`x_x -h {{0}} {{file.xlsx|file.csv}}` +`x_x {{[-h|--heading]}} {{0}} {{file.xlsx|file.csv}}` - View a CSV file with unconventional delimiters: -`x_x --delimiter={{';'}} --quotechar={{'|'}} {{file.csv}}` +`x_x {{[-d|--delimiter]}} {{';'}} {{[-q|--quotechar]}} {{'|'}} {{file.csv}}` diff --git a/tldr/xkcdpass b/tldr/xkcdpass index a4482139..ff3ce768 100644 --- a/tldr/xkcdpass +++ b/tldr/xkcdpass @@ -15,8 +15,8 @@ source: https://github.com/tldr-pages/tldr.git - Generate one passphrase whose first letters of each word match the provided argument: -`xkcdpass -a {{acrostic}}` +`xkcdpass {{[-a|--acrostic]}} {{acrostic}}` - Generate passwords interactively: -`xkcdpass -i` +`xkcdpass {{[-i|--interactive]}}` diff --git a/tldr/xmake b/tldr/xmake index c4eacba1..a409f261 100644 --- a/tldr/xmake +++ b/tldr/xmake @@ -10,20 +10,20 @@ source: https://github.com/tldr-pages/tldr.git - Create an Xmake C project, consisting of a hello world and `xmake.lua`: -`xmake create --language c -P {{project_name}}` +`xmake create {{[-l|--language]}} {{[c|clean]}} {{[-P|--project]}} {{project_name}}` - Build and run an Xmake project: -`xmake build run` +`xmake {{[b|build]}} {{[r|run]}}` - Run a compiled Xmake target directly: -`xmake run {{target_name}}` +`xmake {{[r|run]}} {{target_name}}` - Configure a project's build targets: -`xmake config --plat={{macosx|linux|iphoneos|...}} --arch={{x86_64|i386|arm64|...}} --mode={{debug|release}}` +`xmake {{[f|config]}} {{[-p |--plat=]}}{{macosx|linux|iphoneos|...}} {{[-a |--arch=]}}{{x86_64|i386|arm64|...}} {{[-m |--mode=]}}{{debug|release}}` - Install the compiled target to a directory: -`xmake install -o {{path/to/directory}}` +`xmake {{[i|install]}} {{[-o |--installdir=]}}{{path/to/directory}}` diff --git a/tldr/xxd b/tldr/xxd index 5058b963..86d3acc5 100644 --- a/tldr/xxd +++ b/tldr/xxd @@ -18,20 +18,20 @@ source: https://github.com/tldr-pages/tldr.git - Display a more compact output, replacing consecutive zeros (if any) with a star: -`xxd -a {{input_file}}` +`xxd {{[-a|-autoskip]}} {{input_file}}` - Display the output with 10 columns of one octet (byte) each: -`xxd -c {{10}} {{input_file}}` +`xxd {{[-c|-cols]}} {{10}} {{input_file}}` - Display output only up to a length of 32 bytes: -`xxd -l {{32}} {{input_file}}` +`xxd {{[-l|-len]}} {{32}} {{input_file}}` - Display the output in plain mode, without any gaps between the columns: -`xxd -p {{input_file}}` +`xxd {{[-p|-postscript]}} {{input_file}}` - Revert a plaintext hexdump back into binary, and save it as a binary file: -`xxd -r -p {{input_file}} {{output_file}}` +`xxd {{[-r|-revert]}} {{[-p|-postscript]}} {{input_file}} {{output_file}}` diff --git a/tldr/ya b/tldr/ya index 08f080d8..55bfba14 100644 --- a/tldr/ya +++ b/tldr/ya @@ -10,11 +10,11 @@ source: https://github.com/tldr-pages/tldr.git - Add a package: -`ya pack -a {{package}}` +`ya pack {{[-a|--all]}} {{package}}` - Upgrade all packages: -`ya pack -u` +`ya pack {{[-u|--upgrade]}}` - Subscribe to messages from all remote instances: diff --git a/tldr/youtube-dl b/tldr/youtube-dl index 918f54e9..b32eb565 100644 --- a/tldr/youtube-dl +++ b/tldr/youtube-dl @@ -15,23 +15,23 @@ source: https://github.com/tldr-pages/tldr.git - List all formats that a video or playlist is available in: -`youtube-dl --list-formats '{{https://www.youtube.com/watch?v=Mwa0_nE9H7A}}'` +`youtube-dl {{[-F|--list-formats]}} '{{https://www.youtube.com/watch?v=Mwa0_nE9H7A}}'` - Download a video or playlist at a specific quality: -`youtube-dl --format "{{best[height<=480]}}" '{{https://www.youtube.com/watch?v=oHg5SJYRHA0}}'` +`youtube-dl {{[-f|--format]}} "{{best[height<=480]}}" '{{https://www.youtube.com/watch?v=oHg5SJYRHA0}}'` - Download the audio from a video and convert it to an MP3: -`youtube-dl -x --audio-format {{mp3}} '{{url}}'` +`youtube-dl {{[-x|--extract-audio]}} --audio-format {{mp3}} '{{url}}'` - Download the best quality audio and video and merge them: -`youtube-dl -f bestvideo+bestaudio '{{url}}'` +`youtube-dl {{[-f|--format]}} bestvideo+bestaudio '{{url}}'` - Download video(s) as MP4 files with custom filenames: -`youtube-dl --format {{mp4}} -o "{{%(playlist_index)s-%(title)s by %(uploader)s on %(upload_date)s in %(playlist)s.%(ext)s}}" '{{url}}'` +`youtube-dl {{[-f|--format]}} {{mp4}} {{[-o|--output]}} "{{%(playlist_index)s-%(title)s by %(uploader)s on %(upload_date)s in %(playlist)s.%(ext)s}}" '{{url}}'` - Download a particular language's subtitles along with the video: @@ -39,4 +39,4 @@ source: https://github.com/tldr-pages/tldr.git - Download a playlist and extract MP3s from it: -`youtube-dl -f "bestaudio" --continue --no-overwrites --ignore-errors --extract-audio --audio-format mp3 -o "%(title)s.%(ext)s" '{{url_to_playlist}}'` +`youtube-dl {{[-f|--format]}} "bestaudio" {{[-c|--continue]}} {{[-w|--no-overwrites]}} {{[-i|--ignore-errors]}} {{[-x|--extract-audio]}} --audio-format mp3 {{[-o|--output]}} "%(title)s.%(ext)s" '{{url_to_playlist}}'` diff --git a/tldr/yt-dlp b/tldr/yt-dlp index 74978c39..394ce6b1 100644 --- a/tldr/yt-dlp +++ b/tldr/yt-dlp @@ -16,28 +16,28 @@ source: https://github.com/tldr-pages/tldr.git - List the available downloadable formats for a video: -`yt-dlp --list-formats "{{https://www.youtube.com/watch?v=oHg5SJYRHA0}}"` +`yt-dlp {{[-F|--list-formats]}} "{{https://www.youtube.com/watch?v=oHg5SJYRHA0}}"` - Download a video or playlist using the best MP4 video available (default is "bv\*+ba/b"): -`yt-dlp --format "{{bv*[ext=mp4]+ba[ext=m4a]/b[ext=mp4]}}" "{{https://www.youtube.com/watch?v=oHg5SJYRHA0}}"` +`yt-dlp {{[-f|--format]}} "{{bv*[ext=mp4]+ba[ext=m4a]/b[ext=mp4]}}" "{{https://www.youtube.com/watch?v=oHg5SJYRHA0}}"` - Extract audio from a video (requires ffmpeg or ffprobe): -`yt-dlp --extract-audio "{{https://www.youtube.com/watch?v=oHg5SJYRHA0}}"` +`yt-dlp {{[-x|--extract-audio]}} "{{https://www.youtube.com/watch?v=oHg5SJYRHA0}}"` - Specify audio format and audio quality of extracted audio (between 0 (best) and 10 (worst), default = 5): -`yt-dlp --extract-audio --audio-format {{mp3}} --audio-quality {{0}} "{{https://www.youtube.com/watch?v=oHg5SJYRHA0}}"` +`yt-dlp {{[-x|--extract-audio]}} --audio-format {{mp3}} --audio-quality {{0}} "{{https://www.youtube.com/watch?v=oHg5SJYRHA0}}"` - Download only the second, fourth, fifth, sixth, and last items in a playlist (the first item is 1, not 0): -`yt-dlp --playlist-items 2,4:6,-1 "{{https://youtube.com/playlist?list=PLbzoR-pLrL6pTJfLQ3UwtB-3V4fimdqnA}}"` +`yt-dlp {{[-I|--playlist-items]}} 2,4:6,-1 "{{https://youtube.com/playlist?list=PLbzoR-pLrL6pTJfLQ3UwtB-3V4fimdqnA}}"` - Download all playlists of a YouTube channel/user keeping each playlist in a separate directory: -`yt-dlp -o "{{%(uploader)s/%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s}}" "{{https://www.youtube.com/user/TheLinuxFoundation/playlists}}"` +`yt-dlp {{[-o|--output]}} "{{%(uploader)s/%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s}}" "{{https://www.youtube.com/user/TheLinuxFoundation/playlists}}"` - Download a Udemy course keeping each chapter in a separate directory: -`yt-dlp -u {{user}} -p {{password}} -P "{{path/to/directory}}" -o "{{%(playlist)s/%(chapter_number)s - %(chapter)s/%(title)s.%(ext)s}}" "{{https://www.udemy.com/java-tutorial}}"` +`yt-dlp {{[-u|--username]}} {{user}} {{[-p|--password]}} {{password}} {{[-P|--paths]}} "{{path/to/directory}}" {{[-o|--output]}} "{{%(playlist)s/%(chapter_number)s - %(chapter)s/%(title)s.%(ext)s}}" "{{https://www.udemy.com/java-tutorial}}"` diff --git a/tldr/zipgrep b/tldr/zipgrep index 56201e76..e7b45f42 100644 --- a/tldr/zipgrep +++ b/tldr/zipgrep @@ -14,11 +14,11 @@ source: https://github.com/tldr-pages/tldr.git - Print file name and line number for each match: -`zipgrep -H -n "{{search_pattern}}" {{path/to/file.zip}}` +`zipgrep {{[-H|--with-filename]}} {{[-n|--line-number]}} "{{search_pattern}}" {{path/to/file.zip}}` - Search for lines that do not match a pattern: -`zipgrep -v "{{search_pattern}}" {{path/to/file.zip}}` +`zipgrep {{[-v|--invert-match]}} "{{search_pattern}}" {{path/to/file.zip}}` - Specify files inside a Zip archive from search: @@ -26,4 +26,4 @@ source: https://github.com/tldr-pages/tldr.git - Exclude files inside a Zip archive from search: -`zipgrep "{{search_pattern}}" {{path/to/file.zip}} -x {{file/to/exclude1}} {{file/to/exclude2}}` +`zipgrep "{{search_pattern}}" {{path/to/file.zip}} {{[-x|--line-regexp]}} {{file/to/exclude1}} {{file/to/exclude2}}` diff --git a/tldr/zmap b/tldr/zmap index 61c66390..15d4ad24 100644 --- a/tldr/zmap +++ b/tldr/zmap @@ -6,15 +6,15 @@ source: https://github.com/tldr-pages/tldr.git # zmap > Fast, open-source network scanner for Internet-wide surveys. -> More information: . +> More information: . - Scan a subnet or full IPv4 space for a specific TCP port (default: 80): -`zmap {{SUBNETS}} -p {{port}}` +`zmap {{SUBNETS}} {{[-p|--target-ports]}} {{port}}` - Scan specific ports or port ranges across a subnet: -`zmap {{--target-ports}} {{port1,port2-port3,...}} {{SUBNETS}}` +`zmap {{[-p|--target-ports]}} {{port1,port2-port3,...}} {{SUBNETS}}` - Output results to a CSV file with custom fields: