From 47db9e503e21de49ebcc5872f6ba8fca89ae5331 Mon Sep 17 00:00:00 2001 From: ivuorinen Date: Sat, 26 Apr 2025 00:18:47 +0000 Subject: [PATCH] Update cheatsheets --- tldr/ack | 2 +- tldr/ag | 12 ++++++------ tldr/ani-cli | 2 +- tldr/asciinema | 6 +----- tldr/autojump | 2 +- tldr/bashmarks | 4 ++++ tldr/buku | 12 ++++++------ tldr/cronic | 2 +- tldr/csvtool | 10 +++++----- tldr/darkhttpd | 2 +- tldr/deluge-console | 2 +- tldr/dhcpwn | 4 ++-- tldr/dirsearch | 14 +++++++------- tldr/dokku | 2 +- tldr/dvc | 6 +++--- tldr/dvc-commit | 2 +- tldr/dvc-config | 4 ++-- tldr/dvc-destroy | 2 +- tldr/dvc-fetch | 6 +++--- tldr/dvc-gc | 8 ++++---- tldr/env | 2 +- tldr/flow | 2 +- tldr/forever | 2 +- tldr/fossa | 2 +- tldr/git-fetch | 4 ++-- tldr/git-replace | 2 +- tldr/git-show-ref | 2 +- tldr/git-sizer | 8 ++++---- tldr/gocryptfs | 2 +- tldr/gunicorn | 6 +++--- tldr/hg-add | 8 ++++---- tldr/hg-commit | 8 ++++---- tldr/hg-log | 14 +++++++------- tldr/hg-pull | 10 +++++----- tldr/hg-push | 6 +++--- tldr/hg-remove | 8 ++++---- tldr/hg-serve | 6 +++--- tldr/hg-status | 12 ++++++------ tldr/hg-update | 6 +++--- tldr/hn | 6 +++--- tldr/hostapd | 2 +- tldr/jdupes | 4 ++-- tldr/jpegoptim | 10 +++++----- tldr/jupyter | 4 ++-- tldr/kahlan | 2 +- tldr/keybase | 10 +++++----- tldr/kubectx | 2 +- tldr/kubens | 2 +- tldr/linux/certbot | 12 ++++++------ tldr/linux/cewl | 8 ++++---- tldr/linux/compsize | 6 +++--- tldr/linux/dex | 12 ++++++------ tldr/linux/dkms | 2 +- tldr/linux/dstat | 2 +- tldr/linux/exif | 12 ++++++------ tldr/linux/fail2ban-client | 2 +- tldr/linux/findfs | 2 +- tldr/linux/maim | 8 ++++---- tldr/linux/netselect | 8 ++++---- tldr/linux/ntpq | 12 ++++++------ tldr/linux/openfortivpn | 8 ++++---- tldr/linux/photorec | 2 +- tldr/linux/pmount | 6 +++--- tldr/linux/resolveip | 4 ++-- tldr/linux/rpcclient | 8 ++++---- tldr/linux/sam | 4 ++-- tldr/linux/scanimage | 4 ++-- tldr/linux/smbget | 4 ++-- tldr/linux/srun | 4 ++-- tldr/linux/tcptraceroute | 2 +- tldr/linux/tic | 2 +- tldr/linux/timeshift | 2 +- tldr/linux/tlp | 2 +- tldr/linux/unshadow | 2 +- tldr/linux/veracrypt | 10 +++++----- tldr/linux/wg-quick | 2 +- tldr/linux/xbacklight | 2 +- tldr/linux/xclip | 8 ++++---- tldr/linux/xvfb-run | 6 +++--- tldr/lt | 10 +++++----- tldr/lua | 2 +- tldr/luac | 2 +- tldr/makebuildserver | 2 +- tldr/matlab | 2 +- tldr/mdp | 8 ++++---- tldr/middleman | 2 +- tldr/mmdc | 6 +++--- tldr/nasm | 2 +- tldr/netbsd/chpass | 2 +- tldr/ngrep | 2 +- tldr/npm-home | 2 +- tldr/nvidia-smi | 2 +- tldr/ocaml | 2 +- tldr/ocamlc | 2 +- tldr/ocamlfind | 2 +- tldr/ocamlopt | 2 +- tldr/openbsd/chpass | 8 ++++---- tldr/pamixer | 8 ++++---- tldr/pass-otp | 8 ++++---- tldr/pdftk | 2 +- tldr/peerflix | 8 ++++---- tldr/phive | 6 +++--- tldr/phpstorm | 2 +- tldr/picard | 4 ++-- tldr/pickle | 2 +- tldr/qmv | 2 +- tldr/qr | 2 +- tldr/r2e | 2 +- tldr/rar | 2 +- tldr/rdfind | 2 +- tldr/reflac | 6 +++--- tldr/sequelize | 2 +- tldr/skicka | 2 +- tldr/slackcat | 10 +++++----- tldr/spike | 2 +- tldr/sqlite3 | 2 +- tldr/sqlmap | 10 +++++----- tldr/st-flash | 2 +- tldr/symfony | 2 +- tldr/terraform | 2 +- tldr/thunderbird | 2 +- tldr/tmpmail | 10 +++++----- tldr/velero | 2 +- tldr/virtualenv | 6 +++--- tldr/xmlto | 6 +++--- tldr/yarn | 2 +- tldr/zopflipng | 2 +- 127 files changed, 302 insertions(+), 302 deletions(-) diff --git a/tldr/ack b/tldr/ack index df2eccc1..51ed9f53 100644 --- a/tldr/ack +++ b/tldr/ack @@ -17,7 +17,7 @@ source: https://github.com/tldr-pages/tldr.git `ack {{[-i|--ignore-case]}} "{{search_pattern}}"` -- Search for lines matching a pattern, printing [o]nly the matched text and not the rest of the line: +- Search for lines matching a pattern, printing only the matched text and not the rest of the line: `ack {{[-o|--output='$&']}} "{{search_pattern}}"` diff --git a/tldr/ag b/tldr/ag index d0364967..9f7f00a5 100644 --- a/tldr/ag +++ b/tldr/ag @@ -10,23 +10,23 @@ source: https://github.com/tldr-pages/tldr.git - Find files containing "foo", and print the line matches in context: -`ag {{foo}}` +`ag foo` - Find files containing "foo" in a specific directory: -`ag {{foo}} {{path/to/directory}}` +`ag foo {{path/to/directory}}` - Find files containing "foo", but only list the filenames: -`ag {{[-l|--files-with-matches]}} {{foo}}` +`ag {{[-l|--files-with-matches]}} foo` - Find files containing "FOO" case-insensitively, and print only the match, rather than the whole line: -`ag {{[-i|--ignore-case]}} {{[-o|--only-matching]}} {{FOO}}` +`ag {{[-i|--ignore-case]}} {{[-o|--only-matching]}} FOO` - Find "foo" in files with a name matching "bar": -`ag {{foo}} {{[-G|--file-search-regex]}} {{bar}}` +`ag foo {{[-G|--file-search-regex]}} bar` - Find files whose contents match a regular expression: @@ -34,4 +34,4 @@ source: https://github.com/tldr-pages/tldr.git - Find files with a name matching "foo": -`ag {{[-g|--filename-pattern]}} {{foo}}` +`ag {{[-g|--filename-pattern]}} foo` diff --git a/tldr/ani-cli b/tldr/ani-cli index 49adef9b..b9e6bf07 100644 --- a/tldr/ani-cli +++ b/tldr/ani-cli @@ -12,7 +12,7 @@ source: https://github.com/tldr-pages/tldr.git `ani-cli "{{anime_name}}"` -- Download episode: +- Download an episode: `ani-cli {{[-d|--download]}} "{{anime_name}}"` diff --git a/tldr/asciinema b/tldr/asciinema index 869566e4..83468673 100644 --- a/tldr/asciinema +++ b/tldr/asciinema @@ -13,11 +13,7 @@ source: https://github.com/tldr-pages/tldr.git `asciinema auth` -- Make a new recording (finish it with `` or type `exit`): - -`asciinema rec {{path/to/file.cast}}` - -- Make a new recording and save it to a local file: +- Make a new recording and save it to a local file (finish it with `` or type `exit`): `asciinema rec {{path/to/recording.cast}}` diff --git a/tldr/autojump b/tldr/autojump index f8be090d..e0a94781 100644 --- a/tldr/autojump +++ b/tldr/autojump @@ -27,4 +27,4 @@ source: https://github.com/tldr-pages/tldr.git - Show the entries in the autojump database: -`j -s` +`j {{[-s|--stat]}}` diff --git a/tldr/bashmarks b/tldr/bashmarks index 726e12f6..fe787abe 100644 --- a/tldr/bashmarks +++ b/tldr/bashmarks @@ -8,6 +8,10 @@ source: https://github.com/tldr-pages/tldr.git > Save and jump to commonly used directories using 1 character commands. > More information: . +- Add the bashmark aliases to your shell: + +`source /usr/share/bashmarks/bashmarks.sh` + - List available bookmarks: `l` diff --git a/tldr/buku b/tldr/buku index 61ffa487..e933752d 100644 --- a/tldr/buku +++ b/tldr/buku @@ -6,24 +6,24 @@ source: https://github.com/tldr-pages/tldr.git # buku > Command-line browser-independent bookmark manager. -> More information: . +> More information: . - Display all bookmarks matching "keyword" and with "privacy" tag: -`buku {{keyword}} --stag {{privacy}}` +`buku {{keyword}} {{[-t|--stag]}} {{privacy}}` - Add bookmark with tags "search engine" and "privacy": -`buku --add {{https://example.com}} {{search engine}}, {{privacy}}` +`buku {{[-a|--add]}} {{https://example.com}} {{search engine}}, {{privacy}}` - Delete a bookmark: -`buku --delete {{bookmark_id}}` +`buku {{[-d|--delete]}} {{bookmark_id}}` - Open editor to edit a bookmark: -`buku --write {{bookmark_id}}` +`buku {{[-w|--write]}} {{bookmark_id}}` - Remove "search engine" tag from a bookmark: -`buku --update {{bookmark_id}} --tag {{-}} {{search engine}}` +`buku {{[-u|--update]}} {{bookmark_id}} --tag - {{search engine}}` diff --git a/tldr/cronic b/tldr/cronic index 0d898c80..1e9753e4 100644 --- a/tldr/cronic +++ b/tldr/cronic @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # cronic > Bash script for wrapping cron jobs to prevent excess email sending. -> More information: . +> More information: . - Call a command and display its output if it returns a non-zero exit code: diff --git a/tldr/csvtool b/tldr/csvtool index f56510c0..2cc758ca 100644 --- a/tldr/csvtool +++ b/tldr/csvtool @@ -10,20 +10,20 @@ source: https://github.com/tldr-pages/tldr.git - Extract the second column from a CSV file: -`csvtool --column {{2}} {{path/to/file.csv}}` +`csvtool {{[-c|--column]}} {{2}} {{path/to/file.csv}}` - Extract the second and fourth columns from a CSV file: -`csvtool --column {{2,4}} {{path/to/file.csv}}` +`csvtool {{[-c|--column]}} {{2,4}} {{path/to/file.csv}}` - Extract lines from a CSV file where the second column exactly matches 'Foo': -`csvtool --column {{2}} --search '{{^Foo$}}' {{path/to/file.csv}}` +`csvtool {{[-c|--column]}} {{2}} {{[-s|--search]}} '{{^Foo$}}' {{path/to/file.csv}}` - Extract lines from a CSV file where the second column starts with 'Bar': -`csvtool --column {{2}} --search '{{^Bar}}' {{path/to/file.csv}}` +`csvtool {{[-c|--column]}} {{2}} {{[-s|--search]}} '{{^Bar}}' {{path/to/file.csv}}` - Find lines in a CSV file where the second column ends with 'Baz' and then extract the third and sixth columns: -`csvtool --column {{2}} --search '{{Baz$}}' {{path/to/file.csv}} | csvtool --no-header --column {{3,6}}` +`csvtool {{[-c|--column]}} {{2}} {{[-s|--search]}} '{{Baz$}}' {{path/to/file.csv}} | csvtool {{[-e|--no-header]}} {{[-c|--column]}} {{3,6}}` diff --git a/tldr/darkhttpd b/tldr/darkhttpd index 06ffbb88..4a9bafbe 100644 --- a/tldr/darkhttpd +++ b/tldr/darkhttpd @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # darkhttpd > Darkhttpd web server. -> More information: . +> More information: . - Start server serving the specified document root: diff --git a/tldr/deluge-console b/tldr/deluge-console index 7c72e393..c58f8980 100644 --- a/tldr/deluge-console +++ b/tldr/deluge-console @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # deluge-console > An interactive interface for the Deluge BitTorrent client. -> More information: . +> More information: . - Start the interactive console interface: diff --git a/tldr/dhcpwn b/tldr/dhcpwn index 9a8f9f36..e50b5bb1 100644 --- a/tldr/dhcpwn +++ b/tldr/dhcpwn @@ -10,8 +10,8 @@ source: https://github.com/tldr-pages/tldr.git - Flood the network with IP requests: -`dhcpwn --interface {{network_interface}} flood --count {{number_of_requests}}` +`dhcpwn {{[-i|--interface]}} {{network_interface}} flood {{[-c|--count]}} {{number_of_requests}}` - Sniff local DHCP traffic: -`dhcpwn --interface {{network_interface}} sniff` +`dhcpwn {{[-i|--interface]}} {{network_interface}} sniff` diff --git a/tldr/dirsearch b/tldr/dirsearch index 47b5a139..9facd175 100644 --- a/tldr/dirsearch +++ b/tldr/dirsearch @@ -10,24 +10,24 @@ source: https://github.com/tldr-pages/tldr.git - Scan a web server for common paths with common extensions: -`dirsearch --url {{url}} --extensions-list` +`dirsearch {{[-u|--url]}} {{url}} --extensions-list` -- Scan a list of web servers for common paths with the `.php` extension: +- Scan a list of web servers for common paths with given file extensions: -`dirsearch --url-list {{path/to/url-list.txt}} --extensions {{php}}` +`dirsearch {{[-l|--url-list]}} {{path/to/url-list.txt}} {{[-e|--extensions]}} {{php,jsp,aspx,...}}` - Scan a web server for user-defined paths with common extensions: -`dirsearch --url {{url}} --extensions-list --wordlist {{path/to/url-paths.txt}}` +`dirsearch {{[-u|--url]}} {{url}} --extensions-list {{[-w|--wordlists]}} {{path/to/url-paths.txt,path/to/url-paths.txt,...}}` - Scan a web server using a cookie: -`dirsearch --url {{url}} --extensions {{php}} --cookie {{cookie}}` +`dirsearch {{[-u|--url]}} {{url}} {{[-e|--extensions]}} {{php}} --cookie {{cookie}}` - Scan a web server using the `HEAD` HTTP method: -`dirsearch --url {{url}} --extensions {{php}} --http-method {{HEAD}}` +`dirsearch {{[-u|--url]}} {{url}} {{[-e|--extensions]}} {{php}} {{[-m|--http-method]}} {{HEAD}}` - Scan a web server, saving the results to a `.json` file: -`dirsearch --url {{url}} --extensions {{php}} --json-report {{path/to/report.json}}` +`dirsearch {{[-u|--url]}} {{url}} {{[-e|--extensions]}} {{php}} --json-report {{path/to/report.json}}` diff --git a/tldr/dokku b/tldr/dokku index 6a9c6190..069a64c7 100644 --- a/tldr/dokku +++ b/tldr/dokku @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Docker powered mini-Heroku (PaaS). > Easily deploy multiple apps to your server in different languages using a single `git-push` command. -> More information: . +> More information: . - List running apps: diff --git a/tldr/dvc b/tldr/dvc index e1a14cd8..b0c98c42 100644 --- a/tldr/dvc +++ b/tldr/dvc @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Data Version Control: like `git` for data. > Some subcommands such as `commit` have their own usage documentation. -> More information: . +> More information: . - Execute a DVC subcommand: @@ -15,11 +15,11 @@ source: https://github.com/tldr-pages/tldr.git - Display general help: -`dvc --help` +`dvc {{[-h|--help]}}` - Display help about a specific subcommand: -`dvc {{subcommand}} --help` +`dvc {{subcommand}} {{[-h|--help]}}` - Display version: diff --git a/tldr/dvc-commit b/tldr/dvc-commit index 6dd1fbc7..d1b364d1 100644 --- a/tldr/dvc-commit +++ b/tldr/dvc-commit @@ -18,4 +18,4 @@ source: https://github.com/tldr-pages/tldr.git - Recursively commit all DVC-tracked files in a directory: -`dvc commit --recursive {{path/to/directory}}` +`dvc commit {{[-R|--recursive]}} {{path/to/directory}}` diff --git a/tldr/dvc-config b/tldr/dvc-config index 75eddac7..262bc89e 100644 --- a/tldr/dvc-config +++ b/tldr/dvc-config @@ -19,7 +19,7 @@ source: https://github.com/tldr-pages/tldr.git - Unset the project's default remote: -`dvc config --unset core.remote` +`dvc config {{[-u|--unset]}} core.remote` - Get the configuration value for a specified key for the current project: @@ -31,7 +31,7 @@ source: https://github.com/tldr-pages/tldr.git - Unset a project level configuration value for a given key: -`dvc config --unset {{key}}` +`dvc config {{[-u|--unset]}} {{key}}` - Set a local, global, or system level configuration value: diff --git a/tldr/dvc-destroy b/tldr/dvc-destroy index 4473e1e9..a1de6c49 100644 --- a/tldr/dvc-destroy +++ b/tldr/dvc-destroy @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Force destroy the current project: -`dvc destroy --force` +`dvc destroy {{[-f|--force]}}` diff --git a/tldr/dvc-fetch b/tldr/dvc-fetch index 125ee4ee..aec20a27 100644 --- a/tldr/dvc-fetch +++ b/tldr/dvc-fetch @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Fetch changes from a specific remote upstream repository: -`dvc fetch --remote {{remote_name}}` +`dvc fetch {{[-r|--remote]}} {{remote_name}}` - Fetch the latest changes for a specific target/s: @@ -22,8 +22,8 @@ source: https://github.com/tldr-pages/tldr.git - Fetch changes for all branch and tags: -`dvc fetch --all-branches --all-tags` +`dvc fetch {{[-a|--all-branches]}} {{[-T|--all-tags]}}` - Fetch changes for all commits: -`dvc fetch --all-commits` +`dvc fetch {{[-A|--all-commits]}}` diff --git a/tldr/dvc-gc b/tldr/dvc-gc index 13fd6e42..b3e21600 100644 --- a/tldr/dvc-gc +++ b/tldr/dvc-gc @@ -10,16 +10,16 @@ source: https://github.com/tldr-pages/tldr.git - Garbage collect from the cache, keeping only versions referenced by the current workspace: -`dvc gc --workspace` +`dvc gc {{[-w|--workspace]}}` - Garbage collect from the cache, keeping only versions referenced by branch, tags, and commits: -`dvc gc --all-branches --all-tags --all-commits` +`dvc gc {{[-a|--all-branches]}} {{[-T|--all-tags]}} {{[-a|--all-commits]}}` - Garbage collect from the cache, including the default cloud remote storage (if set): -`dvc gc --all-commits --cloud` +`dvc gc {{[-a|--all-commits]}} {{[-c|--cloud]}}` - Garbage collect from the cache, including a specific cloud remote storage: -`dvc gc --all-commits --cloud --remote {{remote_name}}` +`dvc gc {{[-a|--all-commits]}} {{[-c|--cloud]}} {{[-r|--remote]}} {{remote_name}}` diff --git a/tldr/env b/tldr/env index 4ac1e687..0ededaf5 100644 --- a/tldr/env +++ b/tldr/env @@ -30,4 +30,4 @@ source: https://github.com/tldr-pages/tldr.git - Set one or more variables and run a program: -`env {{variable1}}={{value}} {{variable2}}={{value}} {{variable3}}={{value}} {{program}}` +`env {{variable1=value variable2=value variable3=value ...}} {{program}}` diff --git a/tldr/flow b/tldr/flow index 143a5611..032fdc13 100644 --- a/tldr/flow +++ b/tldr/flow @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # flow > A static type checker for JavaScript. -> More information: . +> More information: . - Run a flow check: diff --git a/tldr/forever b/tldr/forever index edbfb956..50b95168 100644 --- a/tldr/forever +++ b/tldr/forever @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # forever > Server-side JavaScript application that makes sure Node.js applications run indefinitely (restarts after exit). -> More information: . +> More information: . - Start running a file forever (as a daemon): diff --git a/tldr/fossa b/tldr/fossa index 028deb1b..2307759b 100644 --- a/tldr/fossa +++ b/tldr/fossa @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # fossa > CLI for the Fossa service - Generate realtime license audits, vulnerability scans and reports about dependencies licenses. -> More information: . +> More information: . - Initialize a `.fossa.yml` configuration file: diff --git a/tldr/git-fetch b/tldr/git-fetch index a2949115..9c4813e8 100644 --- a/tldr/git-fetch +++ b/tldr/git-fetch @@ -22,8 +22,8 @@ source: https://github.com/tldr-pages/tldr.git - Also fetch tags from the remote upstream repository: -`git fetch --tags` +`git fetch {{[-t|--tags]}}` - Delete local references to remote branches that have been deleted upstream: -`git fetch --prune` +`git fetch {{[-p|--prune]}}` diff --git a/tldr/git-replace b/tldr/git-replace index af5d2d8c..e082637a 100644 --- a/tldr/git-replace +++ b/tldr/git-replace @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Delete existing replace refs for the given objects: -`git replace --delete {{object}}` +`git replace {{[-d|--delete]}} {{object}}` - Edit an object’s content interactively: diff --git a/tldr/git-show-ref b/tldr/git-show-ref index a9f7b488..f8414417 100644 --- a/tldr/git-show-ref +++ b/tldr/git-show-ref @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Show only heads references: -`git show-ref --heads` +`git show-ref --branches` - Show only tags references: diff --git a/tldr/git-sizer b/tldr/git-sizer index 144c6f1c..525f6703 100644 --- a/tldr/git-sizer +++ b/tldr/git-sizer @@ -3,19 +3,19 @@ syntax: markdown tags: [tldr, common] source: https://github.com/tldr-pages/tldr.git --- -# git sizer +# git-sizer > Computes various Git repository size metrics and alerts you to any that might cause problems or inconvenience. > More information: . - Report only statistics that have a level of concern greater than 0: -`git sizer` +`git-sizer` - Report all statistics: -`git sizer -v` +`git-sizer -v` - See additional options: -`git sizer -h` +`git-sizer -h` diff --git a/tldr/gocryptfs b/tldr/gocryptfs index 6d40a447..7d743ad8 100644 --- a/tldr/gocryptfs +++ b/tldr/gocryptfs @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # gocryptfs > Encrypted overlay filesystem written in Go. -> More information: . +> More information: . - Initialize an encrypted filesystem: diff --git a/tldr/gunicorn b/tldr/gunicorn index 994bd4a2..2f06a701 100644 --- a/tldr/gunicorn +++ b/tldr/gunicorn @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # gunicorn > Python WSGI HTTP Server. -> More information: . +> More information: . - Run Python web app: @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Listen on port 8080 on localhost: -`gunicorn --bind {{localhost}}:{{8080}} {{import.path:app_object}}` +`gunicorn {{[-b|--bind]}} {{localhost}}:{{8080}} {{import.path:app_object}}` - Turn on live reload: @@ -22,7 +22,7 @@ source: https://github.com/tldr-pages/tldr.git - Use 4 worker processes for handling requests: -`gunicorn --workers {{4}} {{import.path:app_object}}` +`gunicorn {{[-w|--workers]}} {{4}} {{import.path:app_object}}` - Use 4 worker threads for handling requests: diff --git a/tldr/hg-add b/tldr/hg-add index 2e48592f..347dd290 100644 --- a/tldr/hg-add +++ b/tldr/hg-add @@ -14,16 +14,16 @@ source: https://github.com/tldr-pages/tldr.git - Add all unstaged files matching a specified pattern: -`hg add --include {{pattern}}` +`hg add {{[-I|--include]}} {{pattern}}` - Add all unstaged files, excluding those that match a specified pattern: -`hg add --exclude {{pattern}}` +`hg add {{[-X|--exclude]}} {{pattern}}` - Recursively add sub-repositories: -`hg add --subrepos` +`hg add {{[-S|--subrepos]}}` - Perform a test-run without performing any actions: -`hg add --dry-run` +`hg add {{[-n|--dry-run]}}` diff --git a/tldr/hg-commit b/tldr/hg-commit index 1fe17c59..24c4a407 100644 --- a/tldr/hg-commit +++ b/tldr/hg-commit @@ -18,16 +18,16 @@ source: https://github.com/tldr-pages/tldr.git - Commit with a specific message: -`hg commit --message {{message}}` +`hg commit {{[-m|--message]}} {{message}}` - Commit all files matching a specified pattern: -`hg commit --include {{pattern}}` +`hg commit {{[-I|--include]}} {{pattern}}` - Commit all files, excluding those that match a specified pattern: -`hg commit --exclude {{pattern}}` +`hg commit {{[-X|--exclude]}} {{pattern}}` - Commit using the interactive mode: -`hg commit --interactive` +`hg commit {{[-i|--interactive]}}` diff --git a/tldr/hg-log b/tldr/hg-log index a329a0d7..27d57307 100644 --- a/tldr/hg-log +++ b/tldr/hg-log @@ -14,28 +14,28 @@ source: https://github.com/tldr-pages/tldr.git - Display the revision history with an ASCII graph: -`hg log --graph` +`hg log {{[-G|--graph]}}` - Display the revision history with file names matching a specified pattern: -`hg log --include {{pattern}}` +`hg log {{[-I|--include]}} {{pattern}}` - Display the revision history, excluding file names that match a specified pattern: -`hg log --exclude {{pattern}}` +`hg log {{[-X|--exclude]}} {{pattern}}` - Display the log information for a specific revision: -`hg log --rev {{revision}}` +`hg log {{[-r|--rev]}} {{revision}}` - Display the revision history for a specific branch: -`hg log --branch {{branch}}` +`hg log {{[-b|--branch]}} {{branch}}` - Display the revision history for a specific date: -`hg log --date {{date}}` +`hg log {{[-d|--date]}} {{date}}` - Display revisions committed by a specific user: -`hg log --user {{user}}` +`hg log {{[-u|--user]}} {{user}}` diff --git a/tldr/hg-pull b/tldr/hg-pull index bffbe4c1..4f186703 100644 --- a/tldr/hg-pull +++ b/tldr/hg-pull @@ -18,20 +18,20 @@ source: https://github.com/tldr-pages/tldr.git - Update the local repository to the head of the remote: -`hg pull --update` +`hg pull {{[-u|--update]}}` - Pull changes even when the remote repository is unrelated: -`hg pull --force` +`hg pull {{[-f|--force]}}` - Specify a specific revision changeset to pull up to: -`hg pull --rev {{revision}}` +`hg pull {{[-r|--rev]}} {{revision}}` - Specify a specific branch to pull: -`hg pull --branch {{branch}}` +`hg pull {{[-b|--branch]}} {{branch}}` - Specify a specific bookmark to pull: -`hg pull --bookmark {{bookmark}}` +`hg pull {{[-B|--bookmark]}} {{bookmark}}` diff --git a/tldr/hg-push b/tldr/hg-push index 8876d1db..0a34d907 100644 --- a/tldr/hg-push +++ b/tldr/hg-push @@ -22,12 +22,12 @@ source: https://github.com/tldr-pages/tldr.git - Specify a specific revision changeset to push: -`hg push --rev {{revision}}` +`hg push {{[-r|--rev]}} {{revision}}` - Specify a specific branch to push: -`hg push --branch {{branch}}` +`hg push {{[-b|--branch]}} {{branch}}` - Specify a specific bookmark to push: -`hg push --bookmark {{bookmark}}` +`hg push {{[-B|--bookmark]}} {{bookmark}}` diff --git a/tldr/hg-remove b/tldr/hg-remove index 81ffe73f..df45aeef 100644 --- a/tldr/hg-remove +++ b/tldr/hg-remove @@ -14,16 +14,16 @@ source: https://github.com/tldr-pages/tldr.git - Remove all staged files matching a specified pattern: -`hg remove --include {{pattern}}` +`hg remove {{[-I|--include]}} {{pattern}}` - Remove all staged files, excluding those that match a specified pattern: -`hg remove --exclude {{pattern}}` +`hg remove {{[-X|--exclude]}} {{pattern}}` - Recursively remove sub-repositories: -`hg remove --subrepos` +`hg remove {{[-S|--subrepos]}}` - Remove files from the repository that have been physically removed: -`hg remove --after` +`hg remove {{[-A|--after]}}` diff --git a/tldr/hg-serve b/tldr/hg-serve index 36d39987..fdee272e 100644 --- a/tldr/hg-serve +++ b/tldr/hg-serve @@ -14,15 +14,15 @@ source: https://github.com/tldr-pages/tldr.git - Start a web server instance on the specified port: -`hg serve --port {{port}}` +`hg serve {{[-p|--port]}} {{port}}` - Start a web server instance on the specified listening address: -`hg serve --address {{address}}` +`hg serve {{[-a|--address]}} {{address}}` - Start a web server instance with a specific identifier: -`hg serve --name {{name}}` +`hg serve {{[-n|--name]}} {{name}}` - Start a web server instance using the specified theme (see the templates directory): diff --git a/tldr/hg-status b/tldr/hg-status index 925f5b57..66fde3a9 100644 --- a/tldr/hg-status +++ b/tldr/hg-status @@ -14,19 +14,19 @@ source: https://github.com/tldr-pages/tldr.git - Display only modified files: -`hg status --modified` +`hg status {{[-m|--modified]}}` - Display only added files: -`hg status --added` +`hg status {{[-a|--added]}}` - Display only removed files: -`hg status --removed` +`hg status {{[-r|--removed]}}` - Display only deleted (but tracked) files: -`hg status --deleted` +`hg status {{[-d|--deleted]}}` - Display changes in the working directory compared to a specified changeset: @@ -34,8 +34,8 @@ source: https://github.com/tldr-pages/tldr.git - Display only files matching a specified glob pattern: -`hg status --include {{pattern}}` +`hg status {{[-I|--include]}} {{pattern}}` - Display files, excluding those that match a specified glob pattern: -`hg status --exclude {{pattern}}` +`hg status {{[-X|--exclude]}} {{pattern}}` diff --git a/tldr/hg-update b/tldr/hg-update index d6c55f5c..0d79f6e8 100644 --- a/tldr/hg-update +++ b/tldr/hg-update @@ -14,12 +14,12 @@ source: https://github.com/tldr-pages/tldr.git - Update to the specified revision: -`hg update --rev {{revision}}` +`hg update {{[-r|--rev]}} {{revision}}` - Update and discard uncommitted changes: -`hg update --clean` +`hg update {{[-C|--clean]}}` - Update to the last commit matching a specified date: -`hg update --date {{dd-mm-yyyy}}` +`hg update {{[-d|--date]}} {{dd-mm-yyyy}}` diff --git a/tldr/hn b/tldr/hn index e4c4c8c4..bdd97a1c 100644 --- a/tldr/hn +++ b/tldr/hn @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # hn > Command-line interface for Hacker News. -> More information: . +> More information: . - View stories on Hacker News: @@ -14,11 +14,11 @@ source: https://github.com/tldr-pages/tldr.git - View _number_ of stories on Hacker News: -`hn --limit {{number}}` +`hn {{[-l|--limit]}} {{number}}` - View stories on Hacker News, and keep the list open after selecting a link: -`hn --keep-open` +`hn {{[-k|--keep-open]}}` - View stories on Hacker News sorted by submission date: diff --git a/tldr/hostapd b/tldr/hostapd index 23fde5e9..ed7223a6 100644 --- a/tldr/hostapd +++ b/tldr/hostapd @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # hostapd > Start an access point using a wireless interface. -> More information: . +> More information: . - Start an access point: diff --git a/tldr/jdupes b/tldr/jdupes index 0427bfac..613aa0df 100644 --- a/tldr/jdupes +++ b/tldr/jdupes @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # jdupes > A powerful duplicate file finder and an enhanced fork of fdupes. -> More information: . +> More information: . - Search a single directory: @@ -30,4 +30,4 @@ source: https://github.com/tldr-pages/tldr.git - Search multiple directories and keep the directory order in result: -`jdupes -O {{directory1}} {{directory2}} {{directory3}}` +`jdupes -O {{directory1 directory2 directory3 ...}}` diff --git a/tldr/jpegoptim b/tldr/jpegoptim index d9400f55..8eab53b8 100644 --- a/tldr/jpegoptim +++ b/tldr/jpegoptim @@ -6,20 +6,20 @@ source: https://github.com/tldr-pages/tldr.git # jpegoptim > Optimise JPEG images. -> More information: . +> More information: . - Optimise a set of JPEG images, retaining all associated data: -`jpegoptim {{image1.jpeg}} {{image2.jpeg}} {{imageN.jpeg}}` +`jpegoptim {{image1.jpeg image2.jpeg image3.jpeg ...}}` - Optimise JPEG images, stripping all non-essential data: -`jpegoptim --strip-all {{image1.jpeg}} {{image2.jpeg}} {{imageN.jpeg}}` +`jpegoptim {{[-s|--strip-all]}} {{image1.jpeg image2.jpeg image3.jpeg ...}}` - Force the output images to be progressive: -`jpegoptim --all-progressive {{image1.jpeg}} {{image2.jpeg}} {{imageN.jpeg}}` +`jpegoptim --all-progressive {{image1.jpeg image2.jpeg image3.jpeg ...}}` - Force the output images to have a fixed maximum filesize: -`jpegoptim --size={{250k}} {{image1.jpeg}} {{image2.jpeg}} {{imageN.jpeg}}` +`jpegoptim {{[-S|--size]}} {{250k}} {{image1.jpeg image2.jpeg image3.jpeg ...}}` diff --git a/tldr/jupyter b/tldr/jupyter index ba6bb113..8abe2b17 100644 --- a/tldr/jupyter +++ b/tldr/jupyter @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Web application to create and share documents that contain code, visualizations and notes. > Primarily used for data analysis, scientific computing and machine learning. -> More information: . +> More information: . - Start a Jupyter notebook server in the current directory: @@ -23,7 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - Start a server on a specific port: -`jupyter notebook --port={{port}}` +`jupyter notebook --port {{port}}` - List currently running notebook servers: diff --git a/tldr/kahlan b/tldr/kahlan index b1252d15..9d92307f 100644 --- a/tldr/kahlan +++ b/tldr/kahlan @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # kahlan > A unit and Behaviour Driven Development test framework for PHP. -> More information: . +> More information: . - Run all specifications in the "spec" directory: diff --git a/tldr/keybase b/tldr/keybase index 8d22f540..35cdbc9d 100644 --- a/tldr/keybase +++ b/tldr/keybase @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # keybase > Key directory that maps social media identities to encryption keys in a publicly auditable manner. -> More information: . +> More information: . - Follow another user: @@ -18,19 +18,19 @@ source: https://github.com/tldr-pages/tldr.git - Sign a file: -`keybase sign --infile {{input_file}} --outfile {{output_file}}` +`keybase sign {{[-i|--infile]}} {{input_file}} {{[-o|--outfile]}} {{output_file}}` - Verify a signed file: -`keybase verify --infile {{input_file}} --outfile {{output_file}}` +`keybase verify {{[-i|--infile]}} {{input_file}} {{[-o|--outfile]}} {{output_file}}` - Encrypt a file: -`keybase encrypt --infile {{input_file}} --outfile {{output_file}} {{receiver}}` +`keybase encrypt {{[-i|--infile]}} {{input_file}} {{[-o|--outfile]}} {{output_file}} {{receiver}}` - Decrypt a file: -`keybase decrypt --infile {{input_file}} --outfile {{output_file}}` +`keybase decrypt {{[-i|--infile]}} {{input_file}} {{[-o|--outfile]}} {{output_file}}` - Revoke current device, log out, and delete local data: diff --git a/tldr/kubectx b/tldr/kubectx index c617ec01..29f9ca44 100644 --- a/tldr/kubectx +++ b/tldr/kubectx @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # kubectx > Utility to manage and switch between `kubectl` contexts. -> More information: . +> More information: . - List the contexts: diff --git a/tldr/kubens b/tldr/kubens index ed68c8b1..f53b426e 100644 --- a/tldr/kubens +++ b/tldr/kubens @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # kubens > Utility to switch between Kubernetes namespaces. -> More information: . +> More information: . - List the namespaces: diff --git a/tldr/linux/certbot b/tldr/linux/certbot index 353da6c9..12e07bbf 100644 --- a/tldr/linux/certbot +++ b/tldr/linux/certbot @@ -7,19 +7,19 @@ source: https://github.com/tldr-pages/tldr.git > The Let's Encrypt Agent for automatically obtaining and renewing TLS certificates. > Successor to `letsencrypt`. -> More information: . +> More information: . - Obtain a new certificate via webroot authorization, but do not install it automatically: -`sudo certbot certonly --webroot --webroot-path {{path/to/webroot}} --domain {{subdomain.example.com}}` +`sudo certbot certonly --webroot {{[-w|--webroot-path]}} {{path/to/webroot}} {{[-d|--domain]}} {{subdomain.example.com}}` - Obtain a new certificate via nginx authorization, installing the new certificate automatically: -`sudo certbot --nginx --domain {{subdomain.example.com}}` +`sudo certbot --nginx {{[-d|--domain]}} {{subdomain.example.com}}` - Obtain a new certificate via apache authorization, installing the new certificate automatically: -`sudo certbot --apache --domain {{subdomain.example.com}}` +`sudo certbot --apache {{[-d|--domain]}} {{subdomain.example.com}}` - Renew all Let's Encrypt certificates that expire in 30 days or less (don't forget to restart any servers that use them afterwards): @@ -27,8 +27,8 @@ source: https://github.com/tldr-pages/tldr.git - Simulate the obtaining of a new certificate, but don't actually save any new certificates to disk: -`sudo certbot --webroot --webroot-path {{path/to/webroot}} --domain {{subdomain.example.com}} --dry-run` +`sudo certbot --webroot {{[-w|--webroot-path]}} {{path/to/webroot}} {{[-d|--domain]}} {{subdomain.example.com}} --dry-run` - Obtain an untrusted test certificate instead: -`sudo certbot --webroot --webroot-path {{path/to/webroot}} --domain {{subdomain.example.com}} --test-cert` +`sudo certbot --webroot {{[-w|--webroot-path]}} {{path/to/webroot}} {{[-d|--domain]}} {{subdomain.example.com}} --test-cert` diff --git a/tldr/linux/cewl b/tldr/linux/cewl index decbdd8c..f67f75b3 100644 --- a/tldr/linux/cewl +++ b/tldr/linux/cewl @@ -6,19 +6,19 @@ source: https://github.com/tldr-pages/tldr.git # cewl > URL spidering tool for making a cracking wordlist from web content. -> More information: . +> More information: . - Create a wordlist file from the given URL up to 2 links depth: -`cewl --depth {{2}} --write {{path/to/wordlist.txt}} {{url}}` +`cewl {{[-d|--depth]}} 2 {{[-w|--write]}} {{path/to/wordlist.txt}} {{url}}` - Output an alphanumeric wordlist from the given URL with words of minimum 5 characters: -`cewl --with-numbers --min_word_length {{5}} {{url}}` +`cewl --with-numbers {{[-m|--min_word_length]}} 5 {{url}}` - Output a wordlist from the given URL in debug mode including email addresses: -`cewl --debug --email {{url}}` +`cewl --debug {{[-e|--email]}} {{url}}` - Output a wordlist from the given URL using HTTP Basic or Digest authentication: diff --git a/tldr/linux/compsize b/tldr/linux/compsize index f2d5daa0..80f60f0c 100644 --- a/tldr/linux/compsize +++ b/tldr/linux/compsize @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Calculate the compression ratio of a set of files on a btrfs filesystem. > See also `btrfs filesystem` for recompressing a file by defragmenting it. -> More information: . +> More information: . - Calculate the current compression ratio for a file or directory: @@ -15,8 +15,8 @@ source: https://github.com/tldr-pages/tldr.git - Don't traverse filesystem boundaries: -`sudo compsize --one-file-system {{path/to/file_or_directory}}` +`sudo compsize {{[-x|--one-file-system]}} {{path/to/file_or_directory}}` - Show raw byte counts instead of human-readable sizes: -`sudo compsize --bytes {{path/to/file_or_directory}}` +`sudo compsize {{[-b|--bytes]}} {{path/to/file_or_directory}}` diff --git a/tldr/linux/dex b/tldr/linux/dex index 55bcfdb2..25deb827 100644 --- a/tldr/linux/dex +++ b/tldr/linux/dex @@ -10,27 +10,27 @@ source: https://github.com/tldr-pages/tldr.git - Execute all programs in the autostart folders: -`dex --autostart` +`dex {{[-a|--autostart]}}` - Execute all programs in the specified folders: -`dex --autostart --search-paths {{path/to/directory1}}:{{path/to/directory2}}:{{path/to/directory3}}:` +`dex {{[-a|--autostart]} {{[-s|--search-paths]}} {{path/to/directory1}}:{{path/to/directory2}}:{{path/to/directory3}}:` - Preview the programs would be executed in a GNOME specific autostart: -`dex --autostart --environment {{GNOME}}` +`dex {{[-a|--autostart]} {{[-e|--environment]}} {{GNOME}}` - Preview the programs would be executed in a regular autostart: -`dex --autostart --dry-run` +`dex {{[-a|--autostart]} {{[-d|--dry-run]}}` - Preview the value of the DesktopEntry property `Name`: -`dex --property {{Name}} {{path/to/file.desktop}}` +`dex {{[-p|--property]}} {{Name}} {{path/to/file.desktop}}` - Create a DesktopEntry for a program in the current directory: -`dex --create {{path/to/file.desktop}}` +`dex {{[-c|--create]}} {{path/to/file.desktop}}` - Execute a single program (with `Terminal=true` in the desktop file) in the given terminal: diff --git a/tldr/linux/dkms b/tldr/linux/dkms index 75fd4788..6bf93e8d 100644 --- a/tldr/linux/dkms +++ b/tldr/linux/dkms @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # dkms > A framework that allows for dynamic building of kernel modules. -> More information: . +> More information: . - List currently installed modules: diff --git a/tldr/linux/dstat b/tldr/linux/dstat index 40bb94b0..9cc5a278 100644 --- a/tldr/linux/dstat +++ b/tldr/linux/dstat @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Display CPU and memory statistics only: -`dstat --cpu --mem` +`dstat {{[-c|--cpu]}} {{[-m|--mem]}}` - List all available dstat plugins: diff --git a/tldr/linux/exif b/tldr/linux/exif index 06853894..09b3460f 100644 --- a/tldr/linux/exif +++ b/tldr/linux/exif @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # exif > Show and change EXIF information in JPEG files. -> More information: . +> More information: . - Show all recognized EXIF information in an image: @@ -14,16 +14,16 @@ source: https://github.com/tldr-pages/tldr.git - Show a table listing known EXIF tags and whether each one exists in an image: -`exif --list-tags --no-fixup {{image.jpg}}` +`exif {{[-l|--list-tags]}} --no-fixup {{path/to/image.jpg}}` -- Extract the image thumbnail into the file `thumbnail.jpg`: +- Extract the image thumbnail into a separate file: -`exif --extract-thumbnail --output={{thumbnail.jpg}} {{image.jpg}}` +`exif {{[-e|--extract-thumbnail]}} {{[-o|--output]}} {{path/to/thumbnail.jpg}} {{path/to/image.jpg}}` - Show the raw contents of the "Model" tag in the given image: -`exif --ifd={{0}} --tag={{Model}} --machine-readable {{image.jpg}}` +`exif --ifd {{0}} {{[-t|--tag]}} "Model" {{[-m|--machine-readable]}} {{path/to/image.jpg}}` - Change the value of the "Artist" tag to John Smith and save to `new.jpg`: -`exif --output={{new.jpg}} --ifd={{0}} --tag="{{Artist}}" --set-value="{{John Smith}}" --no-fixup {{image.jpg}}` +`exif {{[-o|--output]}} {{path/to/new.jpg}} --ifd {{0}} {{[-t|--tag]}} "Artist" --set-value "John Smith" --no-fixup {{path/to/image.jpg}}` diff --git a/tldr/linux/fail2ban-client b/tldr/linux/fail2ban-client index 434b6f05..09f0f449 100644 --- a/tldr/linux/fail2ban-client +++ b/tldr/linux/fail2ban-client @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # fail2ban-client > Configure and control fail2ban server. -> More information: . +> More information: . - Retrieve current status of the jail service: diff --git a/tldr/linux/findfs b/tldr/linux/findfs index c1b18127..992c27bb 100644 --- a/tldr/linux/findfs +++ b/tldr/linux/findfs @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # findfs > Finds a filesystem by label or UUID. -> More information: . +> More information: . - Search block devices by filesystem label: diff --git a/tldr/linux/maim b/tldr/linux/maim index 17ad0366..c59a708e 100644 --- a/tldr/linux/maim +++ b/tldr/linux/maim @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # maim > Screenshot utility. -> More information: . +> More information: . - Capture a screenshot and save it to the given path: @@ -14,12 +14,12 @@ source: https://github.com/tldr-pages/tldr.git - Capture a screenshot of the selected region: -`maim --select {{path/to/screenshot.png}}` +`maim {{[-s|--select]}} {{path/to/screenshot.png}}` - Capture a screenshot of the selected region and save it in the clipboard (requires `xclip`): -`maim --select | xclip -selection clipboard -target image/png` +`maim {{[-s|--select]}} | xclip {{[-se|-selection]}} {{[c|clipboard]}} {{[-t|-target]}} image/png` - Capture a screenshot of the current active window (requires `xdotool`): -`maim --window $(xdotool getactivewindow) {{path/to/screenshot.png}}` +`maim {{[-i|--window]}} $(xdotool getactivewindow) {{path/to/screenshot.png}}` diff --git a/tldr/linux/netselect b/tldr/linux/netselect index 22d631b3..6545899d 100644 --- a/tldr/linux/netselect +++ b/tldr/linux/netselect @@ -10,19 +10,19 @@ source: https://github.com/tldr-pages/tldr.git - Choose the server with the lowest latency: -`sudo netselect {{host_1}} {{host_2}}` +`sudo netselect {{host_1 host_2 ...}}` - Display nameserver resolution and statistics: -`sudo netselect -vv {{host_1}} {{host_2}}` +`sudo netselect -vv {{host_1 host_2 ...}}` - Define maximum TTL (time to live): -`sudo netselect -m {{10}} {{host_1}} {{host_2}}` +`sudo netselect -m {{10}} {{host_1 host_2 ...}}` - Print `n` fastest servers among the hosts: -`sudo netselect -s {{n}} {{host_1}} {{host_2}} {{host_3}}` +`sudo netselect -s {{n}} {{host_1 host_2 host_3 ...}}` - Display help: diff --git a/tldr/linux/ntpq b/tldr/linux/ntpq index 61559c84..84693afe 100644 --- a/tldr/linux/ntpq +++ b/tldr/linux/ntpq @@ -6,24 +6,24 @@ source: https://github.com/tldr-pages/tldr.git # ntpq > Query the Network Time Protocol (NTP) daemon. -> More information: . +> More information: . - Start `ntpq` in interactive mode: -`ntpq --interactive` +`ntpq` - Print a list of NTP peers: -`ntpq --peers` +`ntpq {{[-p|--peers]}}` - Print a list of NTP peers without resolving hostnames from IP addresses: -`ntpq --numeric --peers` +`ntpq {{[-n|--numeric]}} {{[-p|--peers]}}` - Use `ntpq` in debugging mode: -`ntpq --debug-level` +`ntpq {{[-d|--debug-level]}}` - Print NTP system variables values: -`ntpq --command={{rv}}` +`ntpq {{[-c|--command]}} {{rv}}` diff --git a/tldr/linux/openfortivpn b/tldr/linux/openfortivpn index 75a5f745..276bde2f 100644 --- a/tldr/linux/openfortivpn +++ b/tldr/linux/openfortivpn @@ -6,15 +6,15 @@ source: https://github.com/tldr-pages/tldr.git # openfortivpn > A VPN client, for Fortinet's proprietary PPP+SSL VPN solution. -> More information: . +> More information: . - Connect to a VPN with a username and password: -`openfortivpn --username={{username}} --password={{password}}` +`openfortivpn {{[-u|--username]}} {{username}} {{[-p|--password]}} {{password}}` - Connect to a VPN using a specific configuration file (defaults to `/etc/openfortivpn/config`): -`sudo openfortivpn --config={{path/to/config}}` +`sudo openfortivpn {{[-c|--config]}} {{path/to/config}}` - Connect to a VPN by specifying the host and port: @@ -22,4 +22,4 @@ source: https://github.com/tldr-pages/tldr.git - Trust a given gateway by passing in its certificate's sha256 sum: -`openfortivpn --trusted-cert={{sha256_sum}}` +`openfortivpn --trusted-cert {{sha256_sum}}` diff --git a/tldr/linux/photorec b/tldr/linux/photorec index 70d5dade..829f4707 100644 --- a/tldr/linux/photorec +++ b/tldr/linux/photorec @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Deleted file recovery tool. > It is recommended to write recovered files to a disk separate to the one being recovered from. -> More information: . +> More information: . - Run PhotoRec on a specific device: diff --git a/tldr/linux/pmount b/tldr/linux/pmount index 6d8299bd..156b789a 100644 --- a/tldr/linux/pmount +++ b/tldr/linux/pmount @@ -14,15 +14,15 @@ source: https://github.com/tldr-pages/tldr.git - Mount a device with a specific filesystem type to `/media/label`: -`pmount --type {{filesystem}} {{/dev/to/block/device}} {{label}}` +`pmount {{[-t|--type]}} {{filesystem}} {{/dev/to/block/device}} {{label}}` - Mount a CD-ROM (filesystem type ISO9660) in read-only mode: -`pmount --type {{iso9660}} --read-only {{/dev/cdrom}}` +`pmount {{[-t|--type]}} iso9660 {{[-r|--read-only]}} {{/dev/cdrom}}` - Mount an NTFS-formatted disk, forcing read-write access: -`pmount --type {{ntfs}} --read-write {{/dev/sdX}}` +`pmount {{[-t|--type]}} ntfs {{[-w|--read-write]}} {{/dev/sdX}}` - Display all mounted removable devices: diff --git a/tldr/linux/resolveip b/tldr/linux/resolveip index b6c55e81..09f76b0f 100644 --- a/tldr/linux/resolveip +++ b/tldr/linux/resolveip @@ -16,6 +16,6 @@ source: https://github.com/tldr-pages/tldr.git `resolveip {{1.1.1.1}}` -- Silent mode. Produces less output: +- Resolve a hostname to an IP address with less output: -`resolveip --silent {{example.org}}` +`resolveip {{[-s|--silent]}} {{example.org}}` diff --git a/tldr/linux/rpcclient b/tldr/linux/rpcclient index fe669688..7b71a5ba 100644 --- a/tldr/linux/rpcclient +++ b/tldr/linux/rpcclient @@ -10,19 +10,19 @@ source: https://github.com/tldr-pages/tldr.git - Connect to a remote host: -`rpcclient --user {{domain}}\{{username}}%{{password}} {{ip}}` +`rpcclient {{[-U|--user]}} {{domain}}\{{username}}%{{password}} {{ip}}` - Connect to a remote host on a domain without a password: -`rpcclient --user {{username}} --workgroup {{domain}} --no-pass {{ip}}` +`rpcclient {{[-U|--user]}} {{username}} {{[-W|--workgroup]}} {{domain}} {{[-N|--no-pass]}} {{ip}}` - Connect to a remote host, passing the password hash: -`rpcclient --user {{domain}}\{{username}} --pw-nt-hash {{ip}}` +`rpcclient {{[-U|--user]}} {{domain}}\{{username}} --pw-nt-hash {{ip}}` - Execute shell commands on a remote host: -`rpcclient --user {{domain}}\{{username}}%{{password}} --command {{semicolon_separated_commands}} {{ip}}` +`rpcclient {{[-U|--user]}} {{domain}}\{{username}}%{{password}} {{[-c|--command]}} {{semicolon_separated_commands}} {{ip}}` - Display domain users: diff --git a/tldr/linux/sam b/tldr/linux/sam index 15a5a1f3..b3cce8cd 100644 --- a/tldr/linux/sam +++ b/tldr/linux/sam @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # sam > AWS Serverless Application Model (SAM) CLI. -> More information: . +> More information: . - Initialize a serverless application: @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Initialize a serverless application with a specific runtime: -`sam init --runtime {{python3.7}}` +`sam init {{[-r|--runtime]}} {{python3.7}}` - Package a SAM application: diff --git a/tldr/linux/scanimage b/tldr/linux/scanimage index 2ca999b8..08263afb 100644 --- a/tldr/linux/scanimage +++ b/tldr/linux/scanimage @@ -10,8 +10,8 @@ source: https://github.com/tldr-pages/tldr.git - List available scanners to ensure the target device is connected and recognized: -`scanimage -L` +`scanimage {{[-L|--list-devices]}}` - Scan an image and save it to a file: -`scanimage --format={{pnm|tiff|png|jpeg}} > {{path/to/new_image}}` +`scanimage --format {{pnm|tiff|png|jpeg}} > {{path/to/new_image}}` diff --git a/tldr/linux/smbget b/tldr/linux/smbget index 0a7a1424..bd1feae4 100644 --- a/tldr/linux/smbget +++ b/tldr/linux/smbget @@ -18,8 +18,8 @@ source: https://github.com/tldr-pages/tldr.git - Connect with a username and password: -`smbget {{smb://server/share/file}} --user {{username%password}}` +`smbget {{smb://server/share/file}} {{[-U|--user]}} {{username%password}}` - Require encrypted transfers: -`smbget {{smb://server/share/file}} --encrypt` +`smbget {{smb://server/share/file}} {{[-e|--encrypt]}}` diff --git a/tldr/linux/srun b/tldr/linux/srun index 513c4541..80af8b42 100644 --- a/tldr/linux/srun +++ b/tldr/linux/srun @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - Submit an interactive job with different attributes: -`srun --ntasks-per-node={{num_cores}} --mem-per-cpu={{memory_MB}} --pty /bin/bash` +`srun --ntasks-per-node {{num_cores}} --mem-per-cpu {{memory_MB}} --pty /bin/bash` - Connect to a worker node with a job running: -`srun --jobid={{job_id}} --pty /bin/bash` +`srun --jobid {{job_id}} --pty /bin/bash` diff --git a/tldr/linux/tcptraceroute b/tldr/linux/tcptraceroute index 4918c8d3..e154c0b2 100644 --- a/tldr/linux/tcptraceroute +++ b/tldr/linux/tcptraceroute @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # tcptraceroute > A traceroute implementation using TCP packets. -> More information: . +> More information: . - Trace the route to a host: diff --git a/tldr/linux/tic b/tldr/linux/tic index 58aa4301..63e917b9 100644 --- a/tldr/linux/tic +++ b/tldr/linux/tic @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # tic > Compile terminfo and install for ncurses. -> More information: . +> More information: . - Compile and install terminfo for a terminal: diff --git a/tldr/linux/timeshift b/tldr/linux/timeshift index 27de2deb..f7351707 100644 --- a/tldr/linux/timeshift +++ b/tldr/linux/timeshift @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # timeshift > System restore utility. -> More information: . +> More information: . - List snapshots: diff --git a/tldr/linux/tlp b/tldr/linux/tlp index 7096d58e..19720853 100644 --- a/tldr/linux/tlp +++ b/tldr/linux/tlp @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Advanced power management for Linux. > See also `tlp-stat`. -> More information: . +> More information: . - Apply settings (according to the actual power source): diff --git a/tldr/linux/unshadow b/tldr/linux/unshadow index 694fd36c..25d07ae2 100644 --- a/tldr/linux/unshadow +++ b/tldr/linux/unshadow @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # unshadow > Utility provided by the John the Ripper project to obtain the traditional Unix password file if the system uses shadow passwords. -> More information: . +> More information: . - Combine the `/etc/shadow` and `/etc/passwd` of the current system: diff --git a/tldr/linux/veracrypt b/tldr/linux/veracrypt index 588df1d3..c6eb064a 100644 --- a/tldr/linux/veracrypt +++ b/tldr/linux/veracrypt @@ -6,20 +6,20 @@ source: https://github.com/tldr-pages/tldr.git # veracrypt > Free and open source disk encryption software. -> More information: . +> More information: . - Create a new volume through a text user interface and use `/dev/urandom` as a source of random data: -`veracrypt --text --create --random-source={{/dev/urandom}}` +`veracrypt {{[-t|--text]}} {{[-c|--create]}} --random-source={{/dev/urandom}}` - Decrypt a volume interactively through a text user interface and mount it to a directory: -`veracrypt --text {{path/to/volume}} {{path/to/mount_point}}` +`veracrypt {{[-t|--text]}} {{path/to/volume}} {{path/to/mount_point}}` - Decrypt a partition using a keyfile and mount it to a directory: -`veracrypt --keyfiles={{path/to/keyfile}} {{/dev/sdXN}} {{path/to/mount_point}}` +`veracrypt {{[-k|--keyfiles]}} {{path/to/keyfile}} {{/dev/sdXN}} {{path/to/mount_point}}` - Dismount a volume on the directory it is mounted to: -`veracrypt --dismount {{path/to/mounted_point}}` +`veracrypt {{[-d|--dismount]}} {{path/to/mounted_point}}` diff --git a/tldr/linux/wg-quick b/tldr/linux/wg-quick index e3ca8496..5989b583 100644 --- a/tldr/linux/wg-quick +++ b/tldr/linux/wg-quick @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # wg-quick > Quickly set up WireGuard tunnels based on config files. -> More information: . +> More information: . - Set up a VPN tunnel: diff --git a/tldr/linux/xbacklight b/tldr/linux/xbacklight index 4843a78f..fc2c6b92 100644 --- a/tldr/linux/xbacklight +++ b/tldr/linux/xbacklight @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # xbacklight > Utility to adjust backlight brightness using the RandR extension. -> More information: . +> More information: . - Get the current screen brightness as a percentage: diff --git a/tldr/linux/xclip b/tldr/linux/xclip index baf49950..a9d526d8 100644 --- a/tldr/linux/xclip +++ b/tldr/linux/xclip @@ -20,15 +20,15 @@ source: https://github.com/tldr-pages/tldr.git - Copy the output from a command to the system clipboard, using short notation: -`echo 123 | xclip {{[-se|-selection]}} clip` +`echo 123 | xclip {{[-se|-selection]}} {{[c|clipboard]}}` - Copy the contents of a file into the system clipboard: -`xclip {{[-se|-selection]}} clip {{input_file.txt}}` +`xclip {{[-se|-selection]}} {{[c|clipboard]}} {{input_file.txt}}` - Copy the contents of a PNG into the system clipboard (can be pasted in other programs correctly): -`xclip {{[-se|-selection]}} clip {{[-t|-target]}} image/png {{input_file.png}}` +`xclip {{[-se|-selection]}} {{[c|clipboard]}} {{[-t|-target]}} image/png {{input_file.png}}` - Copy the user input in the console into the system clipboard: @@ -40,4 +40,4 @@ source: https://github.com/tldr-pages/tldr.git - Paste the contents of the system clipboard to the console: -`xclip {{[-o|-out]}} {{[-se|-selection]}} clip` +`xclip {{[-o|-out]}} {{[-se|-selection]}} {{[c|clipboard]}}` diff --git a/tldr/linux/xvfb-run b/tldr/linux/xvfb-run index 2736843a..cf3538c9 100644 --- a/tldr/linux/xvfb-run +++ b/tldr/linux/xvfb-run @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # xvfb-run > Run a command in a virtual X server environment. -> More information: . +> More information: . - Run the specified command in a virtual X server: @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - Try to get a free server number, if the default (99) is not available: -`xvfb-run --auto-servernum {{command}}` +`xvfb-run {{[-a|--auto-servernum]}} {{command}}` - Pass arguments to the Xvfb server: -`xvfb-run --server-args "{{-screen 0 1024x768x24}}" {{command}}` +`xvfb-run {{[-s|--server-args]}} "{{-screen 0 1024x768x24}}" {{command}}` diff --git a/tldr/lt b/tldr/lt index 5309e1f0..b36ccc31 100644 --- a/tldr/lt +++ b/tldr/lt @@ -10,20 +10,20 @@ source: https://github.com/tldr-pages/tldr.git - Start tunnel from a specific port: -`lt --port {{8000}}` +`lt {{[-p|--port]}} {{8000}}` - Specify the upstream server doing the forwarding: -`lt --port {{8000}} --host {{host}}` +`lt {{[-p|--port]}} {{8000}} {{[-h|--host]}} {{host}}` - Request a specific subdomain: -`lt --port {{8000}} --subdomain {{subdomain}}` +`lt {{[-p|--port]}} {{8000}} {{[-s|--subdomain]}} {{subdomain}}` - Print basic request info: -`lt --port {{8000}} --print-requests` +`lt {{[-p|--port]}} {{8000}} --print-requests` - Open the tunnel URL in the default web browser: -`lt --port {{8000}} --open` +`lt {{[-p|--port]}} {{8000}} {{[-o|--open]}}` diff --git a/tldr/lua b/tldr/lua index 2e404ebd..6986db40 100644 --- a/tldr/lua +++ b/tldr/lua @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # lua > A powerful, light-weight embeddable programming language. -> More information: . +> More information: . - Start an interactive Lua shell: diff --git a/tldr/luac b/tldr/luac index 9800834b..9703c4f8 100644 --- a/tldr/luac +++ b/tldr/luac @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # luac > Lua bytecode compiler. -> More information: . +> More information: . - Compile a Lua source file to Lua bytecode: diff --git a/tldr/makebuildserver b/tldr/makebuildserver index 933b6ae4..677e2621 100644 --- a/tldr/makebuildserver +++ b/tldr/makebuildserver @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Force creating a fresh virtual machine: -`makebuildserver --clean` +`makebuildserver {{[-c|--clean]}}` diff --git a/tldr/matlab b/tldr/matlab index 4f6fe986..e8e504be 100644 --- a/tldr/matlab +++ b/tldr/matlab @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # matlab > Numerical computation environment by MathWorks. -> More information: . +> More information: . - Run without splash screen during startup: diff --git a/tldr/mdp b/tldr/mdp index 1a336f05..1b101dfc 100644 --- a/tldr/mdp +++ b/tldr/mdp @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # mdp > A command-line based tool to make presentations from Markdown files. -> More information: . +> More information: . - Launch a presentation in the terminal from a Markdown file: @@ -14,12 +14,12 @@ source: https://github.com/tldr-pages/tldr.git - Disable fading transitions: -`mdp --nofade {{presentation.md}}` +`mdp {{[-f|--nofade]}} {{presentation.md}}` - Invert font colors to use in terminals with light background: -`mdp --invert {{presentation.md}}` +`mdp {{[-i|--invert]}} {{presentation.md}}` - Disable transparency in transparent terminals: -`mdp --notrans {{presentation.md}}` +`mdp {{[-t|--notrans]}} {{presentation.md}}` diff --git a/tldr/middleman b/tldr/middleman index 99489942..b2fa6817 100644 --- a/tldr/middleman +++ b/tldr/middleman @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # middleman > Static site generator written in Ruby. -> More information: . +> More information: . - Create a new Middleman project: diff --git a/tldr/mmdc b/tldr/mmdc index 75bcc471..44a4c913 100644 --- a/tldr/mmdc +++ b/tldr/mmdc @@ -11,12 +11,12 @@ source: https://github.com/tldr-pages/tldr.git - Convert a file to the specified format (automatically determined from the file extension): -`mmdc --input {{input.mmd}} --output {{output.svg}}` +`mmdc {{[-i|--input]}} {{input.mmd}} {{[-o|--output]}} {{output.svg}}` - Specify the theme of the chart: -`mmdc --input {{input.mmd}} --output {{output.svg}} --theme {{forest|dark|neutral|default}}` +`mmdc {{[-i|--input]}} {{input.mmd}} {{[-o|--output]}} {{output.svg}} {{[-t|--theme]}} {{forest|dark|neutral|default}}` - Specify the background color of the chart (e.g. `lime`, `"#D8064F"`, or `transparent`): -`mmdc --input {{input.mmd}} --output {{output.svg}} --backgroundColor {{color}}` +`mmdc {{[-i|--input]}} {{input.mmd}} {{[-o|--output]}} {{output.svg}} {{[-b|--backgroundColor]}} {{color}}` diff --git a/tldr/nasm b/tldr/nasm index 7953990e..8084f287 100644 --- a/tldr/nasm +++ b/tldr/nasm @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # nasm > The Netwide Assembler, a portable 80x86 assembler. -> More information: . +> More information: . - Assemble `source.asm` into a binary file `source`, in the (default) raw binary format: diff --git a/tldr/netbsd/chpass b/tldr/netbsd/chpass index 64c6bf79..c422366c 100644 --- a/tldr/netbsd/chpass +++ b/tldr/netbsd/chpass @@ -19,7 +19,7 @@ source: https://github.com/tldr-pages/tldr.git - Set a login [s]hell for a specific user: -`chpass chsh -s {{path/to/shell}} {{username}}` +`chpass -s {{path/to/shell}} {{username}}` - Specify a user database entry in the `passwd` file format: diff --git a/tldr/ngrep b/tldr/ngrep index 841096d4..1dd91354 100644 --- a/tldr/ngrep +++ b/tldr/ngrep @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # ngrep > Filter network traffic packets using regular expressions. -> More information: . +> More information: . - Capture traffic of all interfaces: diff --git a/tldr/npm-home b/tldr/npm-home index 6ad1d4a2..abb8eefc 100644 --- a/tldr/npm-home +++ b/tldr/npm-home @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # npm-home -> Open the npm page, Yarn page, or GitHub repository of a package in the web browser. +> Open the `npm` page, Yarn page, or GitHub repository of a package in the web browser. > More information: . - Open the `npm` page of a specific package in the web browser: diff --git a/tldr/nvidia-smi b/tldr/nvidia-smi index f6c39917..e4ce5d7b 100644 --- a/tldr/nvidia-smi +++ b/tldr/nvidia-smi @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Display more detailed GPU information: -`nvidia-smi --query` +`nvidia-smi {{[-q|--query]}}` - Monitor overall GPU usage with 1-second update interval: diff --git a/tldr/ocaml b/tldr/ocaml index 96177d19..5bdc6661 100644 --- a/tldr/ocaml +++ b/tldr/ocaml @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > The OCaml repl (read-evaluate-print-loop). > Interprets Ocaml commands. -> More information: . +> More information: . - Read OCaml commands from the user and execute them: diff --git a/tldr/ocamlc b/tldr/ocamlc index 7824d477..2fd95b02 100644 --- a/tldr/ocamlc +++ b/tldr/ocamlc @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > The OCaml bytecode compiler. > Produces executables runnable by the OCaml interpreter. -> More information: . +> More information: . - Create a binary from a source file: diff --git a/tldr/ocamlfind b/tldr/ocamlfind index e338681c..93718de9 100644 --- a/tldr/ocamlfind +++ b/tldr/ocamlfind @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > The findlib package manager for OCaml. > Simplifies linking executables with external libraries. -> More information: . +> More information: . - Compile a source file to a native binary and link with packages: diff --git a/tldr/ocamlopt b/tldr/ocamlopt index 25b7c8cc..449c6cee 100644 --- a/tldr/ocamlopt +++ b/tldr/ocamlopt @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > The OCaml native code compiler. > Produces native executables, e.g. ELF on Linux. -> More information: . +> More information: . - Compile a source file: diff --git a/tldr/openbsd/chpass b/tldr/openbsd/chpass index 19498e83..1780ec2b 100644 --- a/tldr/openbsd/chpass +++ b/tldr/openbsd/chpass @@ -11,16 +11,16 @@ source: https://github.com/tldr-pages/tldr.git - Set a specific login shell for the current user interactively: -`doas chsh` +`doas chpass` - Set a specific login [s]hell for the current user: -`doas chsh -s {{path/to/shell}}` +`doas chpass -s {{path/to/shell}}` - Set a login [s]hell for a specific user: -`doas chsh -s {{path/to/shell}} {{username}}` +`doas chpass -s {{path/to/shell}} {{username}}` - Specify a user database entry in the `passwd` file format: -`doas chsh -a {{username:encrypted_password:uid:gid:...}}` +`doas chpass -a {{username:encrypted_password:uid:gid:...}}` diff --git a/tldr/pamixer b/tldr/pamixer index d1e28db8..431fdd7d 100644 --- a/tldr/pamixer +++ b/tldr/pamixer @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # pamixer > A simple command-line mixer for PulseAudio. -> More information: . +> More information: . - List all sinks and sources with their corresponding IDs: @@ -22,11 +22,11 @@ source: https://github.com/tldr-pages/tldr.git - Increase the volume on default sink by 5%: -`pamixer --increase {{5}}` +`pamixer {{[-i|--increase]}} {{5}}` - Decrease the volume on a source by 5%: -`pamixer --decrease {{5}} --source {{ID}}` +`pamixer {{[-d|--decrease]}} {{5}} --source {{ID}}` - Use the allow boost option to increase, decrease, or set the volume above 100%: @@ -34,4 +34,4 @@ source: https://github.com/tldr-pages/tldr.git - Mute the default sink (use `--unmute` instead to unmute): -`pamixer --mute` +`pamixer {{[-m|--mute]}}` diff --git a/tldr/pass-otp b/tldr/pass-otp index 24e2cdb4..3460287e 100644 --- a/tldr/pass-otp +++ b/tldr/pass-otp @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # pass otp > A pass extension for managing one-time-password (OTP) tokens. -> More information: . +> More information: . - Prompt for an otpauth URI token and create a new pass file: @@ -22,12 +22,12 @@ source: https://github.com/tldr-pages/tldr.git - Copy and don't print a 2FA code using the OTP token in a pass file: -`pass otp --clip {{path/to/pass}}` +`pass otp {{[-c|--clip]}} {{path/to/pass}}` - Display a QR code using the OTP token stored in a pass file: -`pass otp uri --qrcode {{path/to/pass}}` +`pass otp uri {{[-q|--qrcode]}} {{path/to/pass}}` - Prompt for an OTP secret value specifying issuer and account (at least one must be specified) and append to existing pass file: -`pass otp append --secret --issuer {{issuer_name}} --account {{account_name}} {{path/to/pass}}` +`pass otp append {{[-s|--secret]}} {{[-i|--issuer]}} {{issuer_name}} {{[-a|--account]}} {{account_name}} {{path/to/pass}}` diff --git a/tldr/pdftk b/tldr/pdftk index 4fbcbd7e..b0c39a36 100644 --- a/tldr/pdftk +++ b/tldr/pdftk @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # pdftk > PDF toolkit. -> More information: . +> More information: . - Extract pages 1-3, 5 and 6-10 from a PDF file and save them as another one: diff --git a/tldr/peerflix b/tldr/peerflix index d9cc9a7b..53549ae0 100644 --- a/tldr/peerflix +++ b/tldr/peerflix @@ -14,16 +14,16 @@ source: https://github.com/tldr-pages/tldr.git - List all streamable files contained in a torrent (given as a magnet link): -`peerflix "{{magnet:?xt=urn:btih:0123456789abcdef0123456789abcdef01234567}}" --list` +`peerflix "{{magnet:?xt=urn:btih:0123456789abcdef0123456789abcdef01234567}}" {{[-l|--list]}}` - Stream the largest file in a torrent, given as a torrent URL, to VLC: -`peerflix "{{http://example.net/music.torrent}}" --vlc` +`peerflix "{{http://example.net/music.torrent}}" {{[-v|--vlc]}}` - Stream the largest file in a torrent to MPlayer, with subtitles: -`peerflix "{{torrent_url|magnet_link}}" --mplayer --subtitles {{subtitle-file.srt}}` +`peerflix "{{torrent_url|magnet_link}}" {{[-m|--mplayer]}} {{[-t|--subtitles]}} {{subtitle-file.srt}}` - Stream all files from a torrent to Airplay: -`peerflix "{{torrent_url|magnet_link}}" --all --airplay` +`peerflix "{{torrent_url|magnet_link}}" {{[-a|--all]}} {{[-s|--airplay]}}` diff --git a/tldr/phive b/tldr/phive index 27b7ed98..26f36cf9 100644 --- a/tldr/phive +++ b/tldr/phive @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # phive > The Phar Installation and Verification Environment for secure PHP application deployment. -> More information: . +> More information: . - Display a list of available aliased Phars: @@ -18,11 +18,11 @@ source: https://github.com/tldr-pages/tldr.git - Install a specified Phar globally: -`phive install {{alias|url}} --global` +`phive install {{alias|url}} {{[-g|--global]}}` - Install a specified Phar to a target directory: -`phive install {{alias|url}} --target {{path/to/directory}}` +`phive install {{alias|url}} {{[-t|--target]}} {{path/to/directory}}` - Update all Phar files to the latest version: diff --git a/tldr/phpstorm b/tldr/phpstorm index a105a580..0ed9411f 100644 --- a/tldr/phpstorm +++ b/tldr/phpstorm @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # phpstorm > A cross-platform IDE for PHP based on the JetBrains IntelliJ platform. -> More information: . +> More information: . - Open a specific directory: diff --git a/tldr/picard b/tldr/picard index 969b16f7..bb9517bb 100644 --- a/tldr/picard +++ b/tldr/picard @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # picard > Next generation MusicBrainz tagging application. -> More information: . +> More information: . - Start Picard: @@ -18,4 +18,4 @@ source: https://github.com/tldr-pages/tldr.git - Display the version of Picard installed: -`picard --long-version` +`picard {{[-V|--long-version]}}` diff --git a/tldr/pickle b/tldr/pickle index 434215b6..8ccf7ade 100644 --- a/tldr/pickle +++ b/tldr/pickle @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # pickle > A PHP extension installer based on Composer. -> More information: . +> More information: . - Install a specific PHP extension: diff --git a/tldr/qmv b/tldr/qmv index 787ac1f1..3ea6de15 100644 --- a/tldr/qmv +++ b/tldr/qmv @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Move multiple directories: -`qmv {{[-d|--directory]}} {{path/to/directory1}} {{path/to/directory2}} {{path/to/directory3}}` +`qmv {{[-d|--directory]}} {{path/to/directory1 path/to/directory2 path/to/directory3 ...}}` - Move all files and directories inside a directory: diff --git a/tldr/qr b/tldr/qr index e186de3b..dbd47dfa 100644 --- a/tldr/qr +++ b/tldr/qr @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # qr > Generate QR codes in the terminal with ANSI VT-100 escape codes. -> More information: . +> More information: . - Generate a QR code: diff --git a/tldr/r2e b/tldr/r2e index 38b5dfac..fc241074 100644 --- a/tldr/r2e +++ b/tldr/r2e @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Forwards RSS feeds to an email address. > Requires a configured `sendmail` or smtp setup. -> More information: . +> More information: . - Create a new feed database that sends email to an email address: diff --git a/tldr/rar b/tldr/rar index f141d8b5..25d2396d 100644 --- a/tldr/rar +++ b/tldr/rar @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Archive 1 or more files: -`rar a {{path/to/archive_name.rar}} {{path/to/file1}} {{path/to/file2}} {{path/to/file3}}` +`rar a {{path/to/archive_name.rar}} {{path/to/file1 path/to/file2 path/to/file3 ...}}` - Archive a directory: diff --git a/tldr/rdfind b/tldr/rdfind index 192c4089..38c886a8 100644 --- a/tldr/rdfind +++ b/tldr/rdfind @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # rdfind > Find files with duplicate content and get rid of them. -> More information: . +> More information: . - Identify all duplicates in a given directory and output a summary: diff --git a/tldr/reflac b/tldr/reflac index 7b3ad55e..cc5b7eea 100644 --- a/tldr/reflac +++ b/tldr/reflac @@ -14,15 +14,15 @@ source: https://github.com/tldr-pages/tldr.git - Enable maximum compression (very slow): -`reflac --best {{path/to/directory}}` +`reflac {{[-8|--best]}} {{path/to/directory}}` - Display filenames as they are processed: -`reflac --verbose {{path/to/directory}}` +`reflac {{[-v|--verbose]}} {{path/to/directory}}` - Recurse into subdirectories: -`reflac --recursive {{path/to/directory}}` +`reflac {{[-r|--recursive]}} {{path/to/directory}}` - Preserve file modification times: diff --git a/tldr/sequelize b/tldr/sequelize index 77e87db2..a928f8d2 100644 --- a/tldr/sequelize +++ b/tldr/sequelize @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # sequelize > Promise-based Node.js ORM for Postgres, MySQL, MariaDB, SQLite and Microsoft SQL Server. -> More information: . +> More information: . - Create a model with 3 fields and a migration file: diff --git a/tldr/skicka b/tldr/skicka index 27ad2e69..c0754710 100644 --- a/tldr/skicka +++ b/tldr/skicka @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # skicka > Manage your Google Drive. -> More information: . +> More information: . - Upload a file/folder to Google Drive: diff --git a/tldr/slackcat b/tldr/slackcat index 9439b53d..bbd99632 100644 --- a/tldr/slackcat +++ b/tldr/slackcat @@ -6,20 +6,20 @@ source: https://github.com/tldr-pages/tldr.git # slackcat > Utility for passing files and command output to Slack. -> More information: . +> More information: . - Post a file to Slack: -`slackcat --channel {{channel_name}} {{path/to/file}}` +`slackcat {{[-c|--channel]}} {{channel_name}} {{path/to/file}}` - Post a file to Slack with a custom filename: -`slackcat --channel {{channel_name}} --filename={{filename}} {{path/to/file}}` +`slackcat {{[-c|--channel]}} {{channel_name}} {{[-n|--filename]}} {{filename}} {{path/to/file}}` - Pipe command output to Slack as a text snippet: -`{{command}} | slackcat --channel {{channel_name}} --filename={{snippet_name}}` +`{{command}} | slackcat {{[-c|--channel]}} {{channel_name}} {{[-n|--filename]}} {{snippet_name}}` - Stream command output to Slack continuously: -`{{command}} | slackcat --channel {{channel_name}} --stream` +`{{command}} | slackcat {{[-c|--channel]}} {{channel_name}} {{[-s|--stream]}}` diff --git a/tldr/spike b/tldr/spike index 62dfc51d..2d3c442f 100644 --- a/tldr/spike +++ b/tldr/spike @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # spike > A fully featured static website generator written in JavaScript. -> More information: . +> More information: . - Create a new project using the default template: diff --git a/tldr/sqlite3 b/tldr/sqlite3 index 212890d9..a9a89e29 100644 --- a/tldr/sqlite3 +++ b/tldr/sqlite3 @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # sqlite3 > The command-line interface to SQLite 3, which is a self-contained file-based embedded SQL engine. -> More information: . +> More information: . - Start an interactive shell with a new database: diff --git a/tldr/sqlmap b/tldr/sqlmap index a6c07de6..345adeff 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|--url]}} "{{http://www.target.com/vuln.php?id=1}}"` +`python sqlmap.py {{[-u|--url]}} "{{http://www.example.com/vuln.php?id=1}}"` - Send data in a POST request (`--data` implies POST request): -`python sqlmap.py {{[-u|--url]}} "{{http://www.target.com/vuln.php}}" --data="{{id=1}}"` +`python sqlmap.py {{[-u|--url]}} "{{http://www.example.com/vuln.php}}" --data="{{id=1}}"` - Change the parameter delimiter (& is the default): -`python sqlmap.py {{[-u|--url]}} "{{http://www.target.com/vuln.php}}" --data="{{query=foobar;id=1}}" --param-del="{{;}}"` +`python sqlmap.py {{[-u|--url]}} "{{http://www.example.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|--url]}} "{{http://www.target.com/vuln.php}}" --random-agent` +`python sqlmap.py {{[-u|--url]}} "{{http://www.example.com/vuln.php}}" --random-agent` - Provide user credentials for HTTP protocol authentication: -`python sqlmap.py {{[-u|--url]}} "{{http://www.target.com/vuln.php}}" --auth-type {{Basic}} --auth-cred "{{testuser:testpass}}"` +`python sqlmap.py {{[-u|--url]}} "{{http://www.example.com/vuln.php}}" --auth-type {{Basic}} --auth-cred "{{testuser:testpass}}"` diff --git a/tldr/st-flash b/tldr/st-flash index 9c9f4371..f89ca1e8 100644 --- a/tldr/st-flash +++ b/tldr/st-flash @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # st-flash > Flash binary files to STM32 ARM Cortex microcontrollers. -> More information: . +> More information: . - Read 4096 bytes from the device starting from 0x8000000: diff --git a/tldr/symfony b/tldr/symfony index 8a51a347..d3e4e55a 100644 --- a/tldr/symfony +++ b/tldr/symfony @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # symfony > The console component for the Symfony framework. -> More information: . +> More information: . - Create a new Symfony project: diff --git a/tldr/terraform b/tldr/terraform index a985c96b..0ca1c84a 100644 --- a/tldr/terraform +++ b/tldr/terraform @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # terraform > Create and deploy infrastructure as code to cloud providers. -> More information: . +> More information: . - Initialize a new or existing Terraform configuration: diff --git a/tldr/thunderbird b/tldr/thunderbird index ce821071..8621f2eb 100644 --- a/tldr/thunderbird +++ b/tldr/thunderbird @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # thunderbird > Email client and RSS reader. -> More information: . +> More information: . - Open thunderbird: diff --git a/tldr/tmpmail b/tldr/tmpmail index f34d2df2..75e9e6ea 100644 --- a/tldr/tmpmail +++ b/tldr/tmpmail @@ -6,11 +6,11 @@ source: https://github.com/tldr-pages/tldr.git # tmpmail > A temporary email right from your terminal written in POSIX sh. -> More information: . +> More information: . - Create a temporary inbox: -`tmpmail --generate` +`tmpmail {{[-g|--generate]}}` - List messages and their numeric ID: @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Display the most recent received email: -`tmpmail --recent` +`tmpmail {{[-r|--recent]}}` - Open a specific message: @@ -26,8 +26,8 @@ source: https://github.com/tldr-pages/tldr.git - View email as raw text without HTML tags: -`tmpmail --text` +`tmpmail {{[-t|--text]}}` - Open email with a specific browser (default is w3m): -`tmpmail --browser {{browser}}` +`tmpmail {{[-b|--browser]}} {{browser}}` diff --git a/tldr/velero b/tldr/velero index 8274b7e7..eba25331 100644 --- a/tldr/velero +++ b/tldr/velero @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # velero > Backup and migrate Kubernetes applications and their persistent volumes. -> More information: . +> More information: . - Create a backup containing all resources: diff --git a/tldr/virtualenv b/tldr/virtualenv index 33ef2ffc..43632b17 100644 --- a/tldr/virtualenv +++ b/tldr/virtualenv @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # virtualenv > Create virtual isolated Python environments. -> More information: . +> More information: . - Create a new environment: @@ -14,11 +14,11 @@ source: https://github.com/tldr-pages/tldr.git - Customize the prompt prefix: -`virtualenv --prompt={{prompt_prefix}} {{path/to/venv}}` +`virtualenv --prompt {{prompt_prefix}} {{path/to/venv}}` - Use a different version of Python with virtualenv: -`virtualenv --python={{path/to/pythonbin}} {{path/to/venv}}` +`virtualenv {{[-p|--python]}} {{path/to/pythonbin}} {{path/to/venv}}` - Start (select) the environment: diff --git a/tldr/xmlto b/tldr/xmlto index c44a2140..223f6009 100644 --- a/tldr/xmlto +++ b/tldr/xmlto @@ -6,15 +6,15 @@ source: https://github.com/tldr-pages/tldr.git # xmlto > Apply an XSL stylesheet to an XML document. -> More information: . +> More information: . - Convert a DocBook XML document to PDF format: -`xmlto {{pdf}} {{document.xml}}` +`xmlto pdf {{document.xml}}` - Convert a DocBook XML document to HTML format and store the resulting files in a separate directory: -`xmlto -o {{path/to/html_files}} {{html}} {{document.xml}}` +`xmlto -o {{path/to/html_files}} html {{document.xml}}` - Convert a DocBook XML document to a single HTML file: diff --git a/tldr/yarn b/tldr/yarn index 480d6f91..25e2e133 100644 --- a/tldr/yarn +++ b/tldr/yarn @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # yarn > JavaScript and Node.js package manager alternative. -> More information: . +> More information: . - Install a module globally: diff --git a/tldr/zopflipng b/tldr/zopflipng index 8fb8b648..2ee31c6e 100644 --- a/tldr/zopflipng +++ b/tldr/zopflipng @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Optimize several PNGs and save with given prefix: -`zopflipng --prefix={{prefix}} {{image1.png}} {{image2.png}} {{image3.png}}` +`zopflipng --prefix={{prefix}} {{image1.png image2.png image3.png ...}}`