diff --git a/tldr/abduco b/tldr/abduco index 1b2b4220..c04d0b42 100644 --- a/tldr/abduco +++ b/tldr/abduco @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # abduco > Terminal session manager. -> More information: . +> More information: . - List sessions: diff --git a/tldr/ac b/tldr/ac index f11be924..c2011fa0 100644 --- a/tldr/ac +++ b/tldr/ac @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # ac > Print statistics on how long users have been connected. -> More information: . +> More information: . - Print how long the current user has been connected in hours: diff --git a/tldr/act b/tldr/act index 1ef4de62..a00b840a 100644 --- a/tldr/act +++ b/tldr/act @@ -6,11 +6,11 @@ source: https://github.com/tldr-pages/tldr.git # act > Execute GitHub Actions locally using Docker. -> More information: . +> More information: . -- [l]ist the available jobs: +- List the available jobs: -`act -l` +`act {{[-l|--list]}}` - Run the default event: @@ -20,18 +20,18 @@ source: https://github.com/tldr-pages/tldr.git `act {{event_type}}` -- Run a specific [j]ob: +- Run a specific job: -`act -j {{job_id}}` +`act {{[-j|--job]}} {{job_id}}` - Do [n]ot actually run the actions (i.e. a dry run): -`act -n` +`act {{[-n|--dryrun]}}` -- Show [v]erbose logs: +- Show verbose logs: -`act -v` +`act {{[-v|--verbose]}}` -- Run a specific [W]orkflow with the push event: +- Run a specific workflow with the push event: -`act push -W {{path/to/workflow}}` +`act push {{[-W|--workflows]}} {{path/to/workflow}}` diff --git a/tldr/ag b/tldr/ag index 7236d020..d0364967 100644 --- a/tldr/ag +++ b/tldr/ag @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # ag > The Silver Searcher. Like `ack`, but aims to be faster. -> More information: . +> More information: . - Find files containing "foo", and print the line matches in context: @@ -16,17 +16,17 @@ source: https://github.com/tldr-pages/tldr.git `ag {{foo}} {{path/to/directory}}` -- Find files containing "foo", but only [l]ist the filenames: +- Find files containing "foo", but only list the filenames: -`ag -l {{foo}}` +`ag {{[-l|--files-with-matches]}} {{foo}}` -- Find files containing "FOO" case-[i]nsensitively, and print [o]nly the match, rather than the whole line: +- Find files containing "FOO" case-insensitively, and print only the match, rather than the whole line: -`ag -i -o {{FOO}}` +`ag {{[-i|--ignore-case]}} {{[-o|--only-matching]}} {{FOO}}` - Find "foo" in files with a name matching "bar": -`ag {{foo}} -G {{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 {{foo}}` +`ag {{[-g|--filename-pattern]}} {{foo}}` diff --git a/tldr/age-keygen b/tldr/age-keygen index 9683108a..bc049e72 100644 --- a/tldr/age-keygen +++ b/tldr/age-keygen @@ -11,7 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - Generate a key pair, save it to an unencrypted file, and print the public key to `stdout`: -`age-keygen --output {{path/to/file}}` +`age-keygen {{[-o|--output]}} {{path/to/file}}` - Convert an identit[y] to a recipient and print the public key to `stdout`: diff --git a/tldr/alacritty b/tldr/alacritty index 7413da13..237e7122 100644 --- a/tldr/alacritty +++ b/tldr/alacritty @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # alacritty > Cross-platform, GPU-accelerated terminal emulator. -> More information: . +> More information: . - Start a new Alacritty process and create a window: @@ -26,7 +26,7 @@ source: https://github.com/tldr-pages/tldr.git - [e]xecute a command in a new Alacritty window (also works with `alacritty msg create-window`): -`alacritty -e {{command}}` +`alacritty {{[-e|--command]}} {{command}}` - Use an alternative configuration file (defaults to `$XDG_CONFIG_HOME/alacritty/alacritty.toml`): diff --git a/tldr/ani-cli b/tldr/ani-cli index e646e0d9..49adef9b 100644 --- a/tldr/ani-cli +++ b/tldr/ani-cli @@ -6,36 +6,36 @@ source: https://github.com/tldr-pages/tldr.git # ani-cli > A cli to browse and watch anime. -> More information: . +> More information: . - Search anime by name: `ani-cli "{{anime_name}}"` -- [d]ownload episode: +- Download episode: -`ani-cli -d "{{anime_name}}"` +`ani-cli {{[-d|--download]}} "{{anime_name}}"` -- [d]ownload a [r]ange of episodes: +- Download a range of episodes: -`ani-cli -d -r "{{1 6}}" "{{anime_name}}"` +`ani-cli {{[-d|--download]}} {{[-r|--range]}} "{{1 6}}" "{{anime_name}}"` -- [d]ownload the entire series (a range of all episodes): +- Download the entire series (a range of all episodes): -`ani-cli -d -r "1 -1" "{{anime_name}}"` +`ani-cli {{[-d|--download]}} {{[-r|--range]}} "1 -1" "{{anime_name}}"` -- Use [v]LC as the media player: +- Use VLC as the media player: -`ani-cli -v "{{anime_name}}"` +`ani-cli {{[-v|-vlc]}} "{{anime_name}}"` -- Watch a specific [e]pisode: +- Watch a specific episode: -`ani-cli -e {{episode_number}} "{{anime_name}}"` +`ani-cli {{[-e|--episode]}} {{episode_number}} "{{anime_name}}"` -- [c]ontinue watching anime from history: +- Continue watching anime from history: -`ani-cli -c` +`ani-cli {{[-c|--continue]}}` -- [U]pdate `ani-cli`: +- Update `ani-cli`: -`ani-cli -U` +`ani-cli {{[-U|--update]}}` diff --git a/tldr/ansible b/tldr/ansible index 98cea244..f1d48d0d 100644 --- a/tldr/ansible +++ b/tldr/ansible @@ -7,32 +7,32 @@ source: https://github.com/tldr-pages/tldr.git > Manage groups of computers remotely over SSH. (use the `/etc/ansible/hosts` file to add new groups/hosts). > Some subcommands such as `galaxy` have their own usage documentation. -> More information: . +> More information: . - List hosts belonging to a group: `ansible {{group}} --list-hosts` -- Ping a group of hosts by invoking the ping [m]odule: +- Ping a group of hosts by invoking the ping module: -`ansible {{group}} -m ping` +`ansible {{group}} {{[-m|--module-name]}} ping` - Display facts about a group of hosts by invoking the setup [m]odule: -`ansible {{group}} -m setup` +`ansible {{group}} {{[-m|--module-name]}} setup` - Execute a command on a group of hosts by invoking command module with arguments: -`ansible {{group}} -m command -a '{{my_command}}'` +`ansible {{group}} {{[-m|--module-name]}} command {{[-a|--args]}} '{{my_command}}'` - Execute a command with administrative privileges: -`ansible {{group}} --become --ask-become-pass -m command -a '{{my_command}}'` +`ansible {{group}} {{[-b|--become]}} --ask-become-pass {{[-m|--module-name]}} command {{[-a|--args]}} '{{my_command}}'` - Execute a command using a custom inventory file: -`ansible {{group}} -i {{inventory_file}} -m command -a '{{my_command}}'` +`ansible {{group}} {{[-i|--inventory]}} {{inventory_file}} {{[-m|--module-name]}} command {{[-a|--args]}} '{{my_command}}'` - List the groups in an inventory: -`ansible localhost -m debug -a '{{var=groups.keys()}}'` +`ansible localhost {{[-m|--module-name]}} debug {{[-a|--args]}} '{{var=groups.keys()}}'` diff --git a/tldr/ansible-playbook b/tldr/ansible-playbook index 730bd61a..661f0705 100644 --- a/tldr/ansible-playbook +++ b/tldr/ansible-playbook @@ -12,21 +12,21 @@ source: https://github.com/tldr-pages/tldr.git `ansible-playbook {{playbook}}` -- Run tasks in playbook with custom host [i]nventory: +- Run tasks in playbook with custom host inventory: -`ansible-playbook {{playbook}} -i {{inventory_file}}` +`ansible-playbook {{playbook}} {{[-i|--inventory]}} {{inventory_file}}` -- Run tasks in playbook with [e]xtra variables defined via the command-line: +- Run tasks in playbook with extra variables defined via the command-line: -`ansible-playbook {{playbook}} -e "{{variable1}}={{value1}} {{variable2}}={{value2}}"` +`ansible-playbook {{playbook}} {{[-e|--extra-vars]}} "{{variable1}}={{value1}} {{variable2}}={{value2}}"` -- Run tasks in playbook with [e]xtra variables defined in a JSON file: +- Run tasks in playbook with extra variables defined in a JSON file: -`ansible-playbook {{playbook}} -e "@{{variables.json}}"` +`ansible-playbook {{playbook}} {{[-e|--extra-vars]}} "@{{variables.json}}"` - Run tasks in playbook for the given tags: -`ansible-playbook {{playbook}} --tags {{tag1,tag2}}` +`ansible-playbook {{playbook}} {{[-t|--tags]}} {{tag1,tag2}}` - Run tasks in a playbook starting at a specific task: @@ -34,4 +34,4 @@ source: https://github.com/tldr-pages/tldr.git - Run tasks in a playbook without making any changes (dry-run): -`ansible-playbook {{playbook}} --check --diff` +`ansible-playbook {{playbook}} {{[-C|--check]}} {{[-D|--diff]}}` diff --git a/tldr/ant b/tldr/ant index 4d678665..79e80dcd 100644 --- a/tldr/ant +++ b/tldr/ant @@ -6,24 +6,24 @@ source: https://github.com/tldr-pages/tldr.git # ant > Apache Ant: build and manage Java-based projects. -> More information: . +> More information: . - Build a project with default build file `build.xml`: `ant` -- Build a project using build [f]ile other than `build.xml`: +- Build a project using build file other than `build.xml`: -`ant -f {{buildfile.xml}}` +`ant {{[-f|-buildfile]}} {{buildfile.xml}}` - Print information on possible targets for this project: -`ant -p` +`ant {{[-p|-projecthelp]}}` - Print debugging information: -`ant -d` +`ant {{[-d|-debug]}}` - Execute all targets that do not depend on fail target(s): -`ant -k` +`ant {{[-k|-keep-going]}}` diff --git a/tldr/apkleaks b/tldr/apkleaks index b8380ea8..d712552d 100644 --- a/tldr/apkleaks +++ b/tldr/apkleaks @@ -9,14 +9,14 @@ source: https://github.com/tldr-pages/tldr.git > Note: APKLeaks utilizes the `jadx` disassembler to decompile APK files. > More information: . -- Scan an APK [f]ile for URIs, endpoints, and secrets: +- Scan an APK file for URIs, endpoints, and secrets: -`apkleaks --file {{path/to/file.apk}}` +`apkleaks {{[-f|--file]}} {{path/to/file.apk}}` -- Scan and save the [o]utput to a specific file: +- Scan and save the output to a specific file: -`apkleaks --file {{path/to/file.apk}} --output {{path/to/output.txt}}` +`apkleaks {{[-f|--file]}} {{path/to/file.apk}} {{[-o|--output]}} {{path/to/output.txt}}` -- Pass `jadx` disassembler [a]rguments: +- Pass `jadx` disassembler arguments: -`apkleaks --file {{path/to/file.apk}} --args "{{--threads-count 5 --deobf}}"` +`apkleaks {{[-f|--file]}} {{path/to/file.apk}} {{[-a|--args]}} "{{--threads-count 5 --deobf}}"` diff --git a/tldr/apropos b/tldr/apropos index d5b07b8d..5725d003 100644 --- a/tldr/apropos +++ b/tldr/apropos @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - Search without restricting the output to the terminal width ([l]ong output): -`apropos -l {{regular_expression}}` +`apropos {{[-l|--long]}} {{regular_expression}}` -- Search for pages that match [a]ll the expressions given: +- Search for pages that match all the expressions given: -`apropos {{regular_expression_1}} -a {{regular_expression_2}} -a {{regular_expression_3}}` +`apropos {{regular_expression_1}} {{[-a|--and]}} {{regular_expression_2}} {{[-a|--and]}} {{regular_expression_3}}` diff --git a/tldr/arp b/tldr/arp index 25d4d642..e63676cc 100644 --- a/tldr/arp +++ b/tldr/arp @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # arp > Show and manipulate your system's ARP cache. -> More information: . +> More information: . - Show the current ARP table: diff --git a/tldr/arping b/tldr/arping index ca19a620..ecc72566 100644 --- a/tldr/arping +++ b/tldr/arping @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Discover and probe hosts in a network using the ARP protocol. > Useful for MAC address discovery. -> More information: . +> More information: . - Ping a host by ARP request packets: diff --git a/tldr/asciinema b/tldr/asciinema index 8d9b754d..869566e4 100644 --- a/tldr/asciinema +++ b/tldr/asciinema @@ -13,9 +13,9 @@ source: https://github.com/tldr-pages/tldr.git `asciinema auth` -- Make a new recording (finish it with `` or type `exit`, and then choose to upload it or save it locally): +- Make a new recording (finish it with `` or type `exit`): -`asciinema rec` +`asciinema rec {{path/to/file.cast}}` - Make a new recording and save it to a local file: diff --git a/tldr/atoum b/tldr/atoum index 27acf707..8a20fc7b 100644 --- a/tldr/atoum +++ b/tldr/atoum @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # atoum > A simple, modern and intuitive unit testing framework for PHP. -> More information: . +> More information: . - Initialize a configuration file: @@ -16,26 +16,26 @@ source: https://github.com/tldr-pages/tldr.git `atoum` -- Run tests using the specified [c]onfiguration file: +- Run tests using the specified configuration file: -`atoum -c {{path/to/file}}` +`atoum {{[-c|--configuration]}} {{path/to/file}}` -- Run a specific test [f]ile: +- Run a specific test file: -`atoum -f {{path/to/file}}` +`atoum {{[-f|--files]}} {{path/to/file}}` -- Run a specific [d]irectory of tests: +- Run a specific directory of tests: -`atoum -d {{path/to/directory}}` +`atoum {{[-d|--directories]}} {{path/to/directory}}` -- Run all tests under a specific name[s]pace: +- Run all tests under a specific namespace: -`atoum -ns {{namespace}}` +`atoum {{[-ns|--namespaces]}} {{namespace}}` -- Run all tests with a specific [t]ag: +- Run all tests with a specific tag: -`atoum -t {{tag}}` +`atoum {{[-t|--tags]}} {{tag}}` - Load a custom bootstrap file before running tests: -`atoum --bootstrap-file {{path/to/file}}` +`atoum {{[-bf|--bootstrap-file]}} {{path/to/file}}` diff --git a/tldr/autossh b/tldr/autossh index f7698000..babe1119 100644 --- a/tldr/autossh +++ b/tldr/autossh @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Run, monitor and restart SSH connections. > Auto-reconnects to keep port forwarding tunnels up. Accepts all SSH flags. -> More information: . +> More information: . - Start an SSH session, restarting when the [M]onitoring port fails to return data: diff --git a/tldr/avrdude b/tldr/avrdude index 1185c2d6..cc15b037 100644 --- a/tldr/avrdude +++ b/tldr/avrdude @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # avrdude > Driver program for Atmel AVR microcontrollers programming. -> More information: . +> More information: . - [r]ead the flash ROM of a AVR microcontroller with a specific [p]art ID: diff --git a/tldr/aws-google-auth b/tldr/aws-google-auth index aad656f7..7454fa7d 100644 --- a/tldr/aws-google-auth +++ b/tldr/aws-google-auth @@ -8,18 +8,18 @@ source: https://github.com/tldr-pages/tldr.git > Acquire AWS temporary (STS) credentials using Google Apps as a federated (Single Sign-On) provider. > More information: . -- Log in with Google SSO using the specified [u]sername [I]DP and [S]P identifiers and set the credentials [d]uration to one hour: +- Log in with Google SSO using the specified username IDP and SP identifiers and set the credentials duration to one hour: -`aws-google-auth -u {{example@example.com}} -I {{$GOOGLE_IDP_ID}} -S {{$GOOGLE_SP_ID}} -d {{3600}}` +`aws-google-auth {{[-u|--username]}} {{example@example.com}} {{[-I|--idp-id]}} {{$GOOGLE_IDP_ID}} {{[-S|--sp-id]}} {{$GOOGLE_SP_ID}} {{[-d|--duration]}} {{3600}}` -- Log in [a]sking which role to use (in case of several available SAML roles): +- Log in asking which role to use (in case of several available SAML roles): -`aws-google-auth -u {{example@example.com}} -I {{$GOOGLE_IDP_ID}} -S {{$GOOGLE_SP_ID}} -d {{3600}} -a` +`aws-google-auth {{[-u|--username]}} {{example@example.com}} {{[-I|--idp-id]}} {{$GOOGLE_IDP_ID}} {{[-S|--sp-id]}} {{$GOOGLE_SP_ID}} {{[-d|--duration]}} {{3600}} {{[-a|--ask-role]}}` - Resolve aliases for AWS accounts: -`aws-google-auth -u {{example@example.com}} -I {{$GOOGLE_IDP_ID}} -S {{$GOOGLE_SP_ID}} -d {{3600}} -a --resolve-aliases` +`aws-google-auth {{[-u|--username]}} {{example@example.com}} {{[-I|--idp-id]}} {{$GOOGLE_IDP_ID}} {{[-S|--sp-id]}} {{$GOOGLE_SP_ID}} {{[-d|--duration]}} {{3600}} {{[-a|--ask-role]}} --resolve-aliases` - Display help: -`aws-google-auth -h` +`aws-google-auth {{[-h|--help]}}` diff --git a/tldr/axel b/tldr/axel index 6315ec99..1f6728f5 100644 --- a/tldr/axel +++ b/tldr/axel @@ -7,24 +7,24 @@ source: https://github.com/tldr-pages/tldr.git > Download accelerator. > Supports HTTP, HTTPS, and FTP. -> More information: . +> More information: . - Download a URL to a file: `axel {{url}}` -- Download and specify an [o]utput file: +- Download and specify an output file: -`axel {{url}} -o {{path/to/file}}` +`axel {{url}} {{[-o|--output]}} {{path/to/file}}` -- Download with a specific [n]umber connections: +- Download with a specific number connections: -`axel -n {{connections_num}} {{url}}` +`axel {{[-n|--num-connections]}} {{connections_num}} {{url}}` -- [S]earch for mirrors: +- Search for mirrors: -`axel -S {{mirrors_num}} {{url}}` +`axel {{[-S|--search]}} {{mirrors_num}} {{url}}` -- Limit download [s]peed (bytes per second): +- Limit download speed (bytes per second): -`axel -s {{speed}} {{url}}` +`axel {{[-s|--max-speed]}} {{speed}} {{url}}` diff --git a/tldr/az-lock b/tldr/az-lock index 0c37d202..825e3a72 100644 --- a/tldr/az-lock +++ b/tldr/az-lock @@ -11,19 +11,19 @@ source: https://github.com/tldr-pages/tldr.git - Create a read-only subscription level lock: -`az lock create --name {{lock_name}} --lock-type ReadOnly` +`az lock create {{[-n|--name]}} {{lock_name}} {{[-t|--lock-type]}} ReadOnly` - Create a read-only resource group level lock: -`az lock create --name {{lock_name}} --resource-group {{group_name}} --lock-type ReadOnly` +`az lock create {{[-n|--name]}} {{lock_name}} {{[-g|--resource-group]}} {{group_name}} {{[-t|--lock-type]}} ReadOnly` - Delete a subscription level lock: -`az lock delete --name {{lock_name}}` +`az lock delete {{[-n|--name]}} {{lock_name}}` - Delete a resource group level lock: -`az lock delete --name {{lock_name}} --resource-group {{group_name}}` +`az lock delete {{[-n|--name]}} {{lock_name}} {{[-g|--resource-group]}} {{group_name}}` - List out all locks on the subscription level: @@ -31,4 +31,4 @@ source: https://github.com/tldr-pages/tldr.git - Show a subscription level lock with a specific [n]ame: -`az lock show -n {{lock_name}}` +`az lock show {{[-n|--name]}} {{lock_name}}` diff --git a/tldr/az-storage b/tldr/az-storage index 73994b5c..5aee7d76 100644 --- a/tldr/az-storage +++ b/tldr/az-storage @@ -9,22 +9,22 @@ source: https://github.com/tldr-pages/tldr.git > Part of `azure-cli` (also known as `az`). > More information: . -- Create a storage account specifying a [l]ocation: +- Create a storage account specifying a location: -`az storage account create --resource-group {{group_name}} --name {{account_name}} -l {{location}} --sku {{account_sku}}` +`az storage account create {{[-g|--resource-group]}} {{group_name}} {{[-n|--name]}} {{account_name}} {{[-l|--location]}} {{location}} --sku {{account_sku}}` - List all storage accounts in a resource group: -`az storage account list --resource-group {{group_name}}` +`az storage account list {{[-g|--resource-group]}} {{group_name}}` - List the access keys for a storage account: -`az storage account keys list --resource-group {{group_name}} --name {{account_name}}` +`az storage account keys list {{[-g|--resource-group]}} {{group_name}} {{[-n|--name]}} {{account_name}}` - Delete a storage account: -`az storage account delete --resource-group {{group_name}} --name {{account_name}}` +`az storage account delete {{[-g|--resource-group]}} {{group_name}} {{[-n|--name]}} {{account_name}}` - Update the minimum tls version setting for a storage account: -`az storage account update --min-tls-version {{TLS1_0|TLS1_1|TLS1_2}} --resource-group {{group_name}} --name {{account_name}}` +`az storage account update --min-tls-version {{TLS1_0|TLS1_1|TLS1_2}} {{[-g|--resource-group]}} {{group_name}} {{[-n|--name]}} {{account_name}}` diff --git a/tldr/az-storage-blob b/tldr/az-storage-blob index 0ec6978b..8e0874b2 100644 --- a/tldr/az-storage-blob +++ b/tldr/az-storage-blob @@ -9,22 +9,22 @@ source: https://github.com/tldr-pages/tldr.git > Part of `azure-cli` (also known as `az`). > More information: . -- Download a blob to a [f]ile path specifying a [s]ource container: +- Download a blob to a file path specifying a source container: -`az storage blob download --account-name {{storage_account_name}} --account-key {{storage_account_key}} -c {{container_name}} -n {{path/to/blob}} -f {{path/to/local_file}}` +`az storage blob download --account-name {{storage_account_name}} --account-key {{storage_account_key}} {{[-c|--container-name]}} {{container_name}} {{[-n|--name]}} {{path/to/blob}} {{[-f|--file]}} {{path/to/local_file}}` - [d]ownload blobs from a blob container recursively: -`az storage blob download-batch --account-name {{storage_account_name}} --account-key {{storage_account_key}} -s {{container_name}} -d {{path/to/remote}} --pattern {{filename_regex}} --destination {{path/to/destination}}` +`az storage blob download-batch --account-name {{storage_account_name}} --account-key {{storage_account_key}} {{[-s|--source]}} {{container_name}} {{[-d|--destination]}} {{path/to/remote}} --pattern {{filename_regex}} {{[-d|--destination]}} {{path/to/destination}}` - Upload a local file to blob storage: -`az storage blob upload --account-name {{storage_account_name}} --account-key {{storage_account_key}} -c {{container_name}} -n {{path/to/blob}} -f {{path/to/local_file}}` +`az storage blob upload --account-name {{storage_account_name}} --account-key {{storage_account_key}} {{[-c|--container-name]}} {{container_name}} {{[-n|--name]}} {{path/to/blob}} {{[-f|--file]}} {{path/to/local_file}}` - Delete a blob object: -`az storage blob delete --account-name {{storage_account_name}} --account-key {{storage_account_key}} -c {{container_name}} -n {{path/to/blob}}` +`az storage blob delete --account-name {{storage_account_name}} --account-key {{storage_account_key}} {{[-c|--container-name]}} {{container_name}} {{[-n|--name]}} {{path/to/blob}}` - Generate a shared access signature for a blob: -`az storage blob generate-sas --account-name {{storage_account_name}} --account-key {{storage_account_key}} -c {{container_name}} -n {{path/to/blob}} --permissions {{permission_set}} --expiry {{Y-m-d'T'H:M'Z'}} --https-only` +`az storage blob generate-sas --account-name {{storage_account_name}} --account-key {{storage_account_key}} {{[-c|--container-name]}} {{container_name}} {{[-n|--name]}} {{path/to/blob}} --permissions {{permission_set}} --expiry {{Y-m-d'T'H:M'Z'}} --https-only` diff --git a/tldr/banner b/tldr/banner index 4ffae173..8b351690 100644 --- a/tldr/banner +++ b/tldr/banner @@ -12,9 +12,9 @@ source: https://github.com/tldr-pages/tldr.git `banner "{{Hello World}}"` -- Use a banner [w]idth of 50 characters: +- Use a banner width of 50 characters: -`banner -w 50 "{{Hello World}}"` +`banner {{[-w|--width]}} 50 "{{Hello World}}"` - Read text from `stdin`: diff --git a/tldr/bash b/tldr/bash index a0692d7c..fe1c3033 100644 --- a/tldr/bash +++ b/tldr/bash @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Bourne-Again SHell, an `sh`-compatible command-line interpreter. > See also: `zsh`, `histexpand` (history expansion). -> More information: . +> More information: . - Start an interactive shell session: diff --git a/tldr/bats b/tldr/bats index c2bb9e60..02b7c607 100644 --- a/tldr/bats +++ b/tldr/bats @@ -8,26 +8,26 @@ source: https://github.com/tldr-pages/tldr.git > Bash Automated Testing System: a TAP () compliant testing framework for Bash. > More information: . -- Run a BATS test script and output results in the [t]AP (Test Anything Protocol) format: +- Run a BATS test script and output results in the TAP (Test Anything Protocol) format: -`bats --tap {{path/to/test.bats}}` +`bats {{[-t|--tap]}} {{path/to/test.bats}}` -- [c]ount test cases of a test script without running any tests: +- Count test cases of a test script without running any tests: -`bats --count {{path/to/test.bats}}` +`bats {{[-c|--count]}} {{path/to/test.bats}}` -- Run BATS test cases [r]ecursively (files with a `.bats` extension): +- Run BATS test cases recursively (files with a `.bats` extension): -`bats --recursive {{path/to/directory}}` +`bats {{[-r|--recursive]}} {{path/to/directory}}` -- Output results in a specific [F]ormat: +- Output results in a specific format: -`bats --formatter {{pretty|tap|tap13|junit}} {{path/to/test.bats}}` +`bats {{[-F|--formatter]}} {{pretty|tap|tap13|junit}} {{path/to/test.bats}}` -- Add [T]iming information to tests: +- Add timing information to tests: -`bats --timing {{path/to/test.bats}}` +`bats {{[-T|--timing]}} {{path/to/test.bats}}` -- Run specific number of [j]obs in parallel (requires GNU `parallel` to be installed): +- Run specific number of jobs in parallel (requires GNU `parallel` to be installed): -`bats --jobs {{number}} {{path/to/test.bats}}` +`bats {{[-j|--jobs]}} {{number}} {{path/to/test.bats}}` diff --git a/tldr/bb b/tldr/bb index bce4ab8b..a5ce3434 100644 --- a/tldr/bb +++ b/tldr/bb @@ -8,13 +8,13 @@ source: https://github.com/tldr-pages/tldr.git > Native Clojure interpreter for scripting. > More information: . -- [e]valuate an expression: +- Evaluate an expression: -`bb -e "(+ 1 2 3)"` +`bb {{[-e|--eval]}} "(+ 1 2 3)"` -- Evaluate a script [f]ile: +- Evaluate a script file: -`bb -f {{path/to/script.clj}}` +`bb {{[-f|--file]}} {{path/to/script.clj}}` - Bind [i]nput to a sequence of lines from `stdin`: diff --git a/tldr/bc b/tldr/bc index 0da27978..7f89b469 100644 --- a/tldr/bc +++ b/tldr/bc @@ -13,9 +13,9 @@ source: https://github.com/tldr-pages/tldr.git `bc` -- Start an [i]nteractive session with the standard math [l]ibrary enabled: +- Start an interactive session with the standard math library enabled: -`bc --interactive --mathlib` +`bc {{[-i|--interactive]}} {{[-l|--mathlib]}}` - Calculate an expression: @@ -31,7 +31,7 @@ source: https://github.com/tldr-pages/tldr.git - Calculate a sine/cosine/arctangent/natural logarithm/exponential function using `mathlib`: -`echo '{{s|c|a|l|e}}({{1}})' | bc --mathlib` +`echo '{{s|c|a|l|e}}({{1}})' | bc {{[-l|--mathlib]}}` - Execute an inline factorial script: diff --git a/tldr/bdfr b/tldr/bdfr index a944937d..88a02c8a 100644 --- a/tldr/bdfr +++ b/tldr/bdfr @@ -8,26 +8,26 @@ source: https://github.com/tldr-pages/tldr.git > Bulk downloader for Reddit. > More information: . -- Download videos/images from the specified [l]inks to URL or ID's of posts: +- Download videos/images from the specified links to URL or ID's of posts: -`bdfr download {{path/to/output_directory}} -l {{post_url}}` +`bdfr download {{path/to/output_directory}} {{[-l|--link]}} {{post_url}}` -- Download the maximum possible number (roughly 1000) of videos/images from a specified [u]ser: +- Download the maximum possible number (roughly 1000) of videos/images from a specified user: -`bdfr download {{path/to/output_directory}} -u {{reddit_user}} --submitted` +`bdfr download {{path/to/output_directory}} {{[-u|--user]}} {{reddit_user}} --submitted` -- Download submission data (text, upvotes, comments, etc.) [L]imited to 10 submissions for each [s]ubreddit (30 total): +- Download submission data (text, upvotes, comments, etc.) limited to 10 submissions for each subreddit (30 total): -`bdfr archive {{path/to/output_directory}} -s '{{Python, all, mindustry}}' -L 10` +`bdfr archive {{path/to/output_directory}} {{[-s|--subreddit]}} '{{Python, all, mindustry}}' {{[-L|--limit]}} 10` -- Download videos/images from the [s]ubreddit r/Python [S]orted by top (default is hot) using [t]ime filter all, [L]imited to 10 submissions: +- Download videos/images from the subreddit r/Python sorted by top (default is hot) using time filter all, limited to 10 submissions: -`bdfr download {{path/to/output_directory}} -s Python -S top -t all -L 10` +`bdfr download {{path/to/output_directory}} {{[-s|--subreddit]}} Python {{[-S|--sort]}} top {{[-t|--time]}} all {{[-L|--limit]}} 10` -- Download the maximum possible number of both submission data and videos/images from [s]ubreddit r/Python skipping over submissions with mp4 or gif file extensions and creating hard links for duplicate files: +- Download the maximum possible number of both submission data and videos/images from subreddit r/Python skipping over submissions with mp4 or gif file extensions and creating hard links for duplicate files: -`bdfr clone {{path/to/output_directory}} -s Python --skip mp4 --skip gif --make-hard-links` +`bdfr clone {{path/to/output_directory}} {{[-s|--subreddit]}} Python --skip mp4 --skip gif --make-hard-links` - Download saved posts of the authenticated user, naming each file according to a specified format. Avoid downloading duplicates and posts already present in the output directory: -`bdfr download {{path/to/output_directory}} --user me --saved --authenticate --file-scheme '{{ {POSTID}_{TITLE}_{UPVOTES} }}' --no-dupes --search-existing` +`bdfr download {{path/to/output_directory}} {{[-u|--user]}} me --saved --authenticate --file-scheme '{{ {POSTID}_{TITLE}_{UPVOTES} }}' --no-dupes --search-existing` diff --git a/tldr/beanstalkd b/tldr/beanstalkd index 7b1e8439..d4d7979b 100644 --- a/tldr/beanstalkd +++ b/tldr/beanstalkd @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # beanstalkd > A simple and generic work-queue server. -> More information: . +> More information: . - Start the server, listening on port 11300: diff --git a/tldr/bedtools b/tldr/bedtools index 2f502311..7fadb25b 100644 --- a/tldr/bedtools +++ b/tldr/bedtools @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > A swiss-army knife of tools for genomic-analysis tasks. > Used to intersect, group, convert and count data in BAM, BED, GFF/GTF, VCF format. -> More information: . +> More information: . - Intersect file [a] and file(s) [b] regarding the sequences' [s]trand and save the result to a specific file: diff --git a/tldr/black b/tldr/black index 41cdd99c..13a95ac1 100644 --- a/tldr/black +++ b/tldr/black @@ -12,9 +12,9 @@ source: https://github.com/tldr-pages/tldr.git `black {{path/to/file_or_directory}}` -- Format the [c]ode passed in as a string: +- Format the code passed in as a string: -`black -c "{{code}}"` +`black {{[-c|--code]}} "{{code}}"` - Show whether a file or a directory would have changes made to them if they were to be formatted: @@ -26,8 +26,8 @@ source: https://github.com/tldr-pages/tldr.git - Auto-format a file or directory, emitting exclusively error messages to `stderr`: -`black --quiet {{path/to/file_or_directory}}` +`black {{[-q|--quiet]}} {{path/to/file_or_directory}}` - Auto-format a file or directory without replacing single quotes with double quotes (adoption helper, avoid using this for new projects): -`black --skip-string-normalization {{path/to/file_or_directory}}` +`black {{[-S|--skip-string-normalization]}} {{path/to/file_or_directory}}` diff --git a/tldr/blender b/tldr/blender index 2d3d33f7..ee3b39c2 100644 --- a/tldr/blender +++ b/tldr/blender @@ -11,28 +11,28 @@ source: https://github.com/tldr-pages/tldr.git - Render all frames of an animation in the background, without loading the UI (output is saved to `/tmp`): -`blender --background {{path/to/file.blend}} --render-anim` +`blender {{[-b|--background]}} {{path/to/file.blend}} {{[-a|--render-anim]}}` - Render an animation using a specific image naming pattern, in a path relative (`//`) to the .blend file: -`blender --background {{path/to/file.blend}} --render-output //{{render/frame_###.png}} --render-anim` +`blender {{[-b|--background]}} {{path/to/file.blend}} {{[-o|--render-output]}} //{{render/frame_###.png}} {{[-a|--render-anim]}}` - Render the 10th frame of an animation as a single image, saved to an existing directory (absolute path): -`blender --background {{path/to/file.blend}} --render-output {{/path/to/output_directory}} --render-frame {{10}}` +`blender {{[-b|--background]}} {{path/to/file.blend}} {{[-o|--render-output]}} {{/path/to/output_directory}} {{[-f|--render-frame]}} {{10}}` - Render the second last frame in an animation as a JPEG image, saved to an existing directory (relative path): -`blender --background {{path/to/file.blend}} --render-output //{{output_directory}} --render-frame {{JPEG}} --render-frame {{-2}}` +`blender {{[-b|--background]}} {{path/to/file.blend}} {{[-o|--render-output]}} //{{output_directory}} {{[-f|--render-frame]}} {{JPEG}} {{[-f|--render-frame]}} {{-2}}` - Render the animation of a specific scene, starting at frame 10 and ending at frame 500: -`blender --background {{path/to/file.blend}} --scene {{scene_name}} --frame-start {{10}} --frame-end {{500}} --render-anim` +`blender {{[-b|--background]}} {{path/to/file.blend}} {{[-S|--scene]}} {{scene_name}} {{[-s|--frame-start]}} {{10}} {{[-e|--frame-end]}} {{500}} {{[-a|--render-anim]}}` - Render an animation at a specific resolution, by passing a Python expression: -`blender --background {{path/to/file.blend}} --python-expr '{{import bpy; bpy.data.scenes[0].render.resolution_percentage = 25}}' --render-anim` +`blender {{[-b|--background]}} {{path/to/file.blend}} --python-expr '{{import bpy; bpy.data.scenes[0].render.resolution_percentage = 25}}' {{[-a|--render-anim]}}` - Start an interactive Blender session in the terminal with a Python console (do `import bpy` after starting): -`blender --background --python-console` +`blender {{[-b|--background]}} --python-console` diff --git a/tldr/bmaptool b/tldr/bmaptool index 81b4bf75..b4f1cb87 100644 --- a/tldr/bmaptool +++ b/tldr/bmaptool @@ -6,11 +6,11 @@ source: https://github.com/tldr-pages/tldr.git # bmaptool > Create or copy block maps intelligently (designed to be faster than `cp` or `dd`). -> More information: . +> More information: . -- [o]utput a blockmap file from image file: +- Output a blockmap file from image file: -`bmaptool create -o {{blockmap.bmap}} {{source.img}}` +`bmaptool create {{[-o|--output]}} {{blockmap.bmap}} {{source.img}}` - Copy an image file into sdb: diff --git a/tldr/bosh b/tldr/bosh index 315c10f7..96732da5 100644 --- a/tldr/bosh +++ b/tldr/bosh @@ -8,9 +8,9 @@ source: https://github.com/tldr-pages/tldr.git > Deploy and manage the BOSH director. > More information: . -- Create local alias for director in a specific [e]nvironment: +- Create local alias for director in a specific environment: -`bosh alias-env {{environment_name}} -e {{ip_address|URL}} --ca-cert {{ca_certificate}}` +`bosh alias-env {{environment_name}} {{[-e|--environment]}} {{ip_address|URL}} --ca-cert {{ca_certificate}}` - List environments: @@ -18,24 +18,24 @@ source: https://github.com/tldr-pages/tldr.git - Log in to the director: -`bosh login -e {{environment}}` +`bosh login {{[-e|--environment]}} {{environment}}` - List deployments: -`bosh -e {{environment}} deployments` +`bosh {{[-e|--environment]}} {{environment}} deployments` -- List environment virtual machines in a [d]eployment: +- List environment virtual machines in a deployment: -`bosh -e {{environment}} vms -d {{deployment}}` +`bosh {{[-e|--environment]}} {{environment}} vms {{[-d|--deployment]}} {{deployment}}` - SSH into virtual machine: -`bosh -e {{environment}} ssh {{virtual_machine}} -d {{deployment}}` +`bosh {{[-e|--environment]}} {{environment}} ssh {{virtual_machine}} {{[-d|--deployment]}} {{deployment}}` - Upload stemcell: -`bosh -e {{environment}} upload-stemcell {{stemcell_file|url}}` +`bosh {{[-e|--environment]}} {{environment}} upload-stemcell {{stemcell_file|url}}` - Show current cloud config: -`bosh -e {{environment}} cloud-config` +`bosh {{[-e|--environment]}} {{environment}} cloud-config` diff --git a/tldr/boxes b/tldr/boxes index 6171ae57..64de72d4 100644 --- a/tldr/boxes +++ b/tldr/boxes @@ -12,26 +12,26 @@ source: https://github.com/tldr-pages/tldr.git `echo "{{string}}" | boxes` -- [r]emove a box from a string: +- Remove a box from a string: -`echo "{{string}}" | boxes -r` +`echo "{{string}}" | boxes {{[-r|--remove]}}` -- Specify the box [d]esign: +- Specify the box design: -`echo "{{string}}" | boxes -d {{parchment}}` +`echo "{{string}}" | boxes {{[-d|--design]}} {{parchment}}` -- Specify the box [s]ize (in columns by lines): +- Specify the box size (in columns by lines): -`echo "{{string}}" | boxes -s {{10}}x{{5}}` +`echo "{{string}}" | boxes {{[-s|--size]}} {{10}}x{{5}}` -- [a]lign the box text [h]orizonally (at [l]eft, [c]enter or [r]ight): +- Align the box text [h]orizonally (at [l]eft, [c]enter or [r]ight): -`echo "{{string}}" | boxes -a h{{l|c|r}}` +`echo "{{string}}" | boxes {{[-a|--align]}} h{{l|c|r}}` -- [a]lign the box text [v]ertically (at [t]op, [c]enter or [b]ottom): +- Align the box text [v]ertically (at [t]op, [c]enter or [b]ottom): -`echo "{{string}}" | boxes -a v{{t|c|b}}` +`echo "{{string}}" | boxes {{[-a|--align]}} v{{t|c|b}}` - [j]ustify the box text (at [l]eft, [c]enter or [r]ight): -`echo "{{string}}" | boxes -a j{{l|c|r}}{{vt}}` +`echo "{{string}}" | boxes {{[-a|--align]}} j{{l|c|r}}{{vt}}` diff --git a/tldr/bpython b/tldr/bpython index 71bcc306..3413ea4c 100644 --- a/tldr/bpython +++ b/tldr/bpython @@ -19,8 +19,8 @@ source: https://github.com/tldr-pages/tldr.git - Execute a specific Python file and start a REPL: -`bpython --interactive {{path/to/file.py}}` +`bpython {{[-i|--interactive]}} {{path/to/file.py}}` -- Use the specified [c]onfig file instead of the default config: +- Use the specified config file instead of the default config: `bpython --config {{path/to/file.conf}}` diff --git a/tldr/brotli b/tldr/brotli index 29a50fd0..4da0e50e 100644 --- a/tldr/brotli +++ b/tldr/brotli @@ -6,24 +6,24 @@ source: https://github.com/tldr-pages/tldr.git # brotli > Compress/uncompress files with Brotli compression. -> More information: . +> More information: . - Compress a file, creating a compressed version next to the file: `brotli {{path/to/file}}` -- [d]ecompress a file, creating an uncompressed version next to the file: +- Decompress a file, creating an uncompressed version next to the file: -`brotli -d {{path/to/file.br}}` +`brotli {{[-d|--decompress]}} {{path/to/file.br}}` -- Compress a file specifying the [o]utput filename: +- Compress a file specifying the output filename: -`brotli {{path/to/file}} -o {{path/to/compressed_output_file.br}}` +`brotli {{path/to/file}} {{[-o|--output]}} {{path/to/compressed_output_file.br}}` -- [d]ecompress a Brotli file specifying the [o]utput filename: +- Decompress a Brotli file specifying the output filename: -`brotli -d {{path/to/compressed_file.br}} -o {{path/to/output_file}}` +`brotli {{[-d|--decompress]}} {{path/to/compressed_file.br}} {{[-o|--output]}} {{path/to/output_file}}` - Specify the compression quality (1=fastest (worst), 11=slowest (best)): -`brotli -q {{11}} {{path/to/file}} -o {{path/to/compressed_output_file.br}}` +`brotli {{[-q|--quality]}} {{11}} {{path/to/file}} {{[-o|--output]}} {{path/to/compressed_output_file.br}}` diff --git a/tldr/bup b/tldr/bup index 20d3b6d3..bf427fd4 100644 --- a/tldr/bup +++ b/tldr/bup @@ -6,24 +6,24 @@ source: https://github.com/tldr-pages/tldr.git # bup > Backup system based on the Git packfile format, providing incremental saves and global deduplication. -> More information: . +> More information: . -- Initialize a backup repository in a given local [d]irectory: +- Initialize a backup repository in a given local directory: -`bup -d {{path/to/repository}} init` +`bup {{[-d|--bup-dir]}} {{path/to/repository}} init` -- Prepare a given [d]irectory before taking a backup: +- Prepare a given directory before taking a backup: -`bup -d {{path/to/repository}} index {{path/to/directory}}` +`bup {{[-d|--bup-dir]}} {{path/to/repository}} index {{path/to/directory}}` -- Backup a [d]irectory to the repository specifying its [n]ame: +- Backup a directory to the repository specifying its name: -`bup -d {{path/to/repository}} save -n {{backup_name}} {{path/to/directory}}` +`bup {{[-d|--bup-dir]}} {{path/to/repository}} save {{[-n|--name]}} {{backup_name}} {{path/to/directory}}` - Show the backup snapshots currently stored in the repository: -`bup -d {{path/to/repository}} ls` +`bup {{[-d|--bup-dir]}} {{path/to/repository}} ls` -- Restore a specific backup snapshot to a target dire[C]tory: +- Restore a specific backup snapshot to a target directory: -`bup -d {{path/to/repository}} restore -C {{path/to/target_directory}} {{backup_name}}` +`bup {{[-d|--bup-dir]}} {{path/to/repository}} restore {{[-C|--outdir]}} {{path/to/target_directory}} {{backup_name}}` diff --git a/tldr/bzip2 b/tldr/bzip2 index f95e4d95..25676617 100644 --- a/tldr/bzip2 +++ b/tldr/bzip2 @@ -12,26 +12,26 @@ source: https://github.com/tldr-pages/tldr.git `bzip2 {{path/to/file_to_compress}}` -- [d]ecompress a file: +- Decompress a file: -`bzip2 -d {{path/to/compressed_file.bz2}}` +`bzip2 {{[-d|--decompress]}} {{path/to/compressed_file.bz2}}` -- [d]ecompress a file to `stdout`: +- Decompress a file to `stdout`: -`bzip2 -dc {{path/to/compressed_file.bz2}}` +`bzip2 {{[-dc|--decompress --stdout]}} {{path/to/compressed_file.bz2}}` - Test the integrity of each file inside the archive file: -`bzip2 --test {{path/to/compressed_file.bz2}}` +`bzip2 {{[-t|--test]}} {{path/to/compressed_file.bz2}}` - Show the compression ratio for each file processed with detailed information: -`bzip2 --verbose {{path/to/compressed_files.bz2}}` +`bzip2 {{[-v|--verbose]}} {{path/to/compressed_files.bz2}}` - Decompress a file overwriting existing files: -`bzip2 --force {{path/to/compressed_file.bz2}}` +`bzip2 {{[-f|--force]}} {{path/to/compressed_file.bz2}}` - Display help: -`bzip2 -h` +`bzip2 {{[-h|--help]}}` diff --git a/tldr/bzip3 b/tldr/bzip3 index ed666d42..372eec18 100644 --- a/tldr/bzip3 +++ b/tldr/bzip3 @@ -6,32 +6,32 @@ source: https://github.com/tldr-pages/tldr.git # bzip3 > An efficient statistical file compressor. -> More information: . +> More information: . - Compress a file: `bzip3 {{path/to/file_to_compress}}` -- [d]ecompress a file: +- Decompress a file: -`bzip3 -d {{path/to/compressed_file.bz3}}` +`bzip3 {{[-d|--decode]}} {{path/to/compressed_file.bz3}}` - Decompress a file to `stdout` ([c]): -`bzip3 -dc {{path/to/compressed_file.bz3}}` +`bzip3 {{[-dc|--decode --stdout]}} {{path/to/compressed_file.bz3}}` - Test the integrity of each file inside the archive file: -`bzip3 --test {{path/to/compressed_file.bz3}}` +`bzip3 {{[-t|--test]}} {{path/to/compressed_file.bz3}}` - Show the compression ratio for each file processed with detailed information: -`bzip3 --verbose {{path/to/compressed_files.bz3}}` +`bzip3 {{[-v|--verbose]}} {{path/to/compressed_files.bz3}}` - Decompress a file overwriting existing files: -`bzip3 -d --force {{path/to/compressed_file.bz3}}` +`bzip3 {{[-d|--decode]}} {{[-f--force]}} {{path/to/compressed_file.bz3}}` - Display help: -`bzip3 -h` +`bzip3 {{[-h|--help]}}` diff --git a/tldr/calc b/tldr/calc index 6ed03815..a8e8a937 100644 --- a/tldr/calc +++ b/tldr/calc @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # calc > An interactive arbitrary-precision calculator in the terminal. -> More information: . +> More information: . - Start `calc` in interactive mode: diff --git a/tldr/carbon-now b/tldr/carbon-now index e27f5fd7..9e129a00 100644 --- a/tldr/carbon-now +++ b/tldr/carbon-now @@ -20,21 +20,21 @@ source: https://github.com/tldr-pages/tldr.git `{{input}} | carbon-now --to-clipboard` -- Create images [i]nteractively for custom settings and optionally save a preset: +- Create images interactively for custom settings and optionally save a preset: -`carbon-now -i {{path/to/file}}` +`carbon-now {{[-i|--interactive]}} {{path/to/file}}` -- Create images from a previously saved [p]reset: +- Create images from a previously saved preset: -`carbon-now -p {{preset}} {{path/to/file}}` +`carbon-now {{[-p|--preset]}} {{preset}} {{path/to/file}}` -- [s]tart at a specified line of text: +- Start at a specified line of text: -`carbon-now -s {{line}} {{path/to/file}}` +`carbon-now {{[-s|--start]}} {{line}} {{path/to/file}}` -- [e]nd at a specific line of text: +- End at a specific line of text: -`carbon-now -e {{line}} {{path/to/file}}` +`carbon-now {{[-e|--end]}} {{line}} {{path/to/file}}` - Open image in a browser instead of saving: diff --git a/tldr/cargo-rustc b/tldr/cargo-rustc index 30d997e4..4af699c5 100644 --- a/tldr/cargo-rustc +++ b/tldr/cargo-rustc @@ -15,11 +15,11 @@ source: https://github.com/tldr-pages/tldr.git - Build artifacts in release mode, with optimizations: -`cargo rustc --release` +`cargo rustc {{[-r|--release]}}` - Compile with architecture-specific optimizations for the current CPU: -`cargo rustc --release -- -C target-cpu=native` +`cargo rustc {{[-r|--release]}} -- -C target-cpu=native` - Compile with speed optimizations: @@ -35,7 +35,7 @@ source: https://github.com/tldr-pages/tldr.git - Build a specific package: -`cargo rustc --package {{package}}` +`cargo rustc {{[-p|--package]}} {{package}}` - Build only the specified binary: diff --git a/tldr/catimg b/tldr/catimg index 9775a4df..9f9ec62c 100644 --- a/tldr/catimg +++ b/tldr/catimg @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Image printing in the terminal. > See also: `pixterm`, `chafa`. -> More information: . +> More information: . - Print a JPEG, PNG, or GIF to the terminal: diff --git a/tldr/ccache b/tldr/ccache index d4144f46..4d3e4fe7 100644 --- a/tldr/ccache +++ b/tldr/ccache @@ -9,17 +9,17 @@ source: https://github.com/tldr-pages/tldr.git > Note: packages usually provide symlinks for compilers in `/usr/lib/ccache/bin`. Prepend this directory to `$PATH` to automatically use `ccache` for them. > More information: . -- Show current cache [s]tatistics: +- Show current cache statistics: -`ccache --show-stats` +`ccache {{[-s|--show-stats]}}` -- [C]lear all cache: +- Clear all cache: -`ccache --clear` +`ccache {{[-C|--clear]}}` -- Reset ([z]ero) statistics (but not cache itself): +- Reset statistics (but not cache itself): -`ccache --zero-stats` +`ccache {{[-z|--zero-stats]}}` - Compile C code and cache compiled output (to use `ccache` on all `gcc` invocations, see the note above): diff --git a/tldr/cdecl b/tldr/cdecl index cc5cfad3..fee327c9 100644 --- a/tldr/cdecl +++ b/tldr/cdecl @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # cdecl > Compose and decode C and C++ type declarations. -> More information: . +> More information: . - Compose English phrase into C declaration, and create [c]ompilable output (include `;` and `{}`): diff --git a/tldr/cdk b/tldr/cdk index 6b9233e0..0848dbe4 100644 --- a/tldr/cdk +++ b/tldr/cdk @@ -28,9 +28,9 @@ source: https://github.com/tldr-pages/tldr.git `cdk diff {{stack_name}}` -- Create a new CDK project in the current directory for a specified [l]anguage: +- Create a new CDK project in the current directory for a specified language: -`cdk init -l {{language}}` +`cdk init {{[-l|--language]}} {{language}}` - Open the CDK API reference in your browser: diff --git a/tldr/chafa b/tldr/chafa index 078cc45a..b0788ae8 100644 --- a/tldr/chafa +++ b/tldr/chafa @@ -13,13 +13,13 @@ source: https://github.com/tldr-pages/tldr.git `chafa {{path/to/file}}` -- Render an image with 24-bit [c]olor: +- Render an image with 24-bit color: -`chafa -c full {{path/to/file}}` +`chafa {{[-c|--colors]}} full {{path/to/file}}` - Improve image rendering with small color palettes using dithering: -`chafa -c 16 --dither ordered {{path/to/file}}` +`chafa {{[-c|--colors]}} 16 --dither ordered {{path/to/file}}` - Render an image, making it appear pixelated: @@ -27,4 +27,4 @@ source: https://github.com/tldr-pages/tldr.git - Render a monochrome image with only braille characters: -`chafa -c none --symbols braille {{path/to/file}}` +`chafa {{[-c|--colors]}} none --symbols braille {{path/to/file}}` diff --git a/tldr/chatgpt b/tldr/chatgpt index ccccf5e5..7b1db07a 100644 --- a/tldr/chatgpt +++ b/tldr/chatgpt @@ -12,17 +12,17 @@ source: https://github.com/tldr-pages/tldr.git `chatgpt` -- Give a [p]rompt to answer to: +- Give a prompt to answer to: -`chatgpt --prompt "{{What is the regex to match an email address?}}"` +`chatgpt {{[-p|--prompt]}} "{{What is the regex to match an email address?}}"` -- Start in chat mode using a specific [m]odel (default is `gpt-3.5-turbo`): +- Start in chat mode using a specific model (default is `gpt-3.5-turbo`): -`chatgpt --model {{gpt-4}}` +`chatgpt {{[-m|--model]}} {{gpt-4}}` -- Start in chat mode with an [i]nitial prompt: +- Start in chat mode with an initial prompt: -`chatgpt --init-prompt "{{You are Rick, from Rick and Morty. Respond to questions using his mannerism and include insulting jokes.}}"` +`chatgpt {{[-i|--init-prompt]}} "{{You are Rick, from Rick and Morty. Respond to questions using his mannerism and include insulting jokes.}}"` - Pipe the result of a command to `chatgpt` as a prompt: @@ -30,4 +30,4 @@ source: https://github.com/tldr-pages/tldr.git - Generate an image using DALL-E: -`chatgpt --prompt "{{image: A white cat}}"` +`chatgpt {{[-p|--prompt]}} "{{image: A white cat}}"` diff --git a/tldr/cheatshh b/tldr/cheatshh index dc04b43d..3fe1aadf 100644 --- a/tldr/cheatshh +++ b/tldr/cheatshh @@ -7,32 +7,32 @@ source: https://github.com/tldr-pages/tldr.git > CLI cheatsheet with customized descriptions, tldr and groups, to look into for your reference. > Press `` to a command to copy it to your clipboard and exit. -> More information: . +> More information: . -- [a]dd a new command to the cheatshheet: +- Add a new command to the cheatshheet: -`cheatshh --add` +`cheatshh {{[-a|--add]}}` -- Edit ([ec]) an existing command's description or group in the cheatshheet: +- Edit an existing command's description or group in the cheatshheet: -`cheatshh --edit-command` +`cheatshh {{[-ec|--edit-command]}}` -- Delete ([dc]) an existing command from the cheatshheet: +- Delete an existing command from the cheatshheet: -`cheatshh --delete-command` +`cheatshh {{[-dc|--delete-command]}}` -- Create a new [g]roup: +- Create a new group: -`cheatshh --group` +`cheatshh {{[-g|--group]}}` -- Edit ([eg]) an existing group's name or description in the cheatsheet: +- Edit an existing group's name or description in the cheatsheet: -`cheatshh --edit-group` +`cheatshh {{[-eg|--edit-group]}}` -- Delete ([dg]) an existing group and it's sub commands from commands.json file: +- Delete an existing group and it's sub commands from commands.json file: -`cheatshh --delete-group` +`cheatshh {{[-dg|--delete-group]}}` -- Display [m]an pages after tldr in the preview: +- Display man pages after tldr in the preview: -`cheatshh --man` +`cheatshh {{[-m|--man]}}` diff --git a/tldr/chronic b/tldr/chronic index a11538f5..54e242ac 100644 --- a/tldr/chronic +++ b/tldr/chronic @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # chronic > Display `stdout` and `stderr` of a command if and only if it fails. -> More information: . +> More information: . - Display `stdout` and `stderr` of the specified command if and only if it produces a non-zero exit code or crashes: diff --git a/tldr/d2 b/tldr/d2 index 9cf4d0cd..851bd6a6 100644 --- a/tldr/d2 +++ b/tldr/d2 @@ -13,9 +13,9 @@ source: https://github.com/tldr-pages/tldr.git `d2 {{path/to/input_file.d2}} {{path/to/output_file.ext}}` -- [w]atch live changes made to a D2 source file in the default web browser: +- Watch live changes made to a D2 source file in the default web browser: -`d2 --watch {{path/to/input_file.d2}} {{path/to/output_file.ext}}` +`d2 {{[-w|--watch]}} {{path/to/input_file.d2}} {{path/to/output_file.ext}}` - Format a D2 source file: @@ -25,10 +25,10 @@ source: https://github.com/tldr-pages/tldr.git `d2 themes` -- Use a different [t]heme for the output file (list available themes first to get the desired `theme_id`): +- Use a different theme for the output file (list available themes first to get the desired `theme_id`): -`d2 --theme {{theme_id}} {{path/to/input_file.d2}} {{path/to/output_file.ext}}` +`d2 {{[-t|--theme]}} {{theme_id}} {{path/to/input_file.d2}} {{path/to/output_file.ext}}` -- Make rendered diagrams look like hand [s]ketches: +- Make rendered diagrams look like hand sketches: -`d2 --sketch true {{path/to/input_file.d2}} {{path/to/output_file.ext}}` +`d2 {{[-s|--sketch]}} true {{path/to/input_file.d2}} {{path/to/output_file.ext}}` diff --git a/tldr/ddev b/tldr/ddev index edf69af1..7937825b 100644 --- a/tldr/ddev +++ b/tldr/ddev @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # ddev > Container based local development tool for PHP environments. -> More information: . +> More information: . - Start up a project: @@ -16,9 +16,9 @@ source: https://github.com/tldr-pages/tldr.git `ddev config` -- [f]ollow the log trail: +- Follow the log trail: -`ddev logs -f` +`ddev logs {{[-f|--follow]}}` - Run composer within the container: @@ -30,7 +30,7 @@ source: https://github.com/tldr-pages/tldr.git - Export a database: -`ddev export-db --file={{/tmp/db.sql.gz}}` +`ddev export-db {{[-f|--file]}} {{/tmp/db.sql.gz}}` - Run a specific command within a container: diff --git a/tldr/dnsx b/tldr/dnsx index d74c66da..0c322b83 100644 --- a/tldr/dnsx +++ b/tldr/dnsx @@ -12,32 +12,32 @@ source: https://github.com/tldr-pages/tldr.git - Query the A record of a (sub)domain and show [re]sponse received: -`echo {{example.com}} | dnsx -a -re` +`echo {{example.com}} | dnsx -a {{[-re|-resp]}}` - Query all the DNS records (A, AAAA, CNAME, NS, TXT, SRV, PTR, MX, SOA, AXFR, CAA): -`dnsx -recon -re <<< {{example.com}}` +`dnsx -recon {{[-re|-resp]}} <<< {{example.com}}` - Query a specific type of DNS record: -`echo {{example.com}} | dnsx -re -{{a|aaaa|cname|ns|txt|srv|ptr|mx|soa|any|axfr|caa}}` +`echo {{example.com}} | dnsx {{[-re|-resp]}} -{{a|aaaa|cname|ns|txt|srv|ptr|mx|soa|any|axfr|caa}}` -- Output [r]esponse [o]nly (do not show the queried domain or subdomain): +- Output response only (do not show the queried domain or subdomain): -`echo {{example.com}} | dnsx -ro` +`echo {{example.com}} | dnsx {{[-ro|-resp-only]}}` -- Display raw response of a query, specifying [r]esolvers to use and retry attempts for failures: +- Display raw response of a query, specifying resolvers to use and retry attempts for failures: -`echo {{example.com}} | dnsx -{{debug|raw}} -resolver {{1.1.1.1,8.8.8.8,...}} -retry {{number}}` +`echo {{example.com}} | dnsx -{{debug|raw}} {{[-r|-resolver]}} {{1.1.1.1,8.8.8.8,...}} -retry {{number}}` - Brute force DNS records using a placeholder: -`dnsx -domain {{FUZZ.example.com}} -wordlist {{path/to/wordlist.txt}} -re` +`dnsx {{[-d|-domain]}} {{FUZZ.example.com}} {{[-w|-wordlist]}} {{path/to/wordlist.txt}} {{[-re|-resp]}}` -- Brute force DNS records from a list of [d]omains and wordlists, appending [o]utput to a file with [n]o [c]olor codes: +- Brute force DNS records from a list of domains and wordlists, appending output to a file with no color codes: -`dnsx -domain {{path/to/domain.txt}} -wordlist {{path/to/wordlist.txt}} -re -output {{path/to/output.txt}} -no-color` +`dnsx {{[-d|-domain]}} {{path/to/domain.txt}} {{[-w|-wordlist]}} {{path/to/wordlist.txt}} {{[-re|-resp]}} {{[-o|-output]}} {{path/to/output.txt}} {{[-nc|-no-color]}}` -- Extract `CNAME` records for the given list of subdomains, with [r]ate [l]imiting DNS queries per second: +- Extract `CNAME` records for the given list of subdomains, with rate limiting DNS queries per second: -`subfinder -silent -d {{example.com}} | dnsx -cname -re -rl {{number}}` +`subfinder -silent {{[-d|-domain]}} {{example.com}} | dnsx -cname {{[-re|-resp]}} {{[-rl|-rate-limit]}} {{number}}` diff --git a/tldr/docker-update b/tldr/docker-update index c28ebe79..c6f16eb3 100644 --- a/tldr/docker-update +++ b/tldr/docker-update @@ -23,7 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - Update the memory limit in [M]egabytes for a specific container: -`docker update --memory {{limit}}M {{container_name}}` +`docker update {{[-m|--memory]}} {{limit}}M {{container_name}}` - Update the maximum number of process IDs allowed inside a specific container (use `-1` for unlimited): diff --git a/tldr/doggo b/tldr/doggo index 3023905a..2a42936d 100644 --- a/tldr/doggo +++ b/tldr/doggo @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > DNS client for Humans. > Written in Golang. -> More information: . +> More information: . - Perform a simple DNS lookup: @@ -23,8 +23,8 @@ source: https://github.com/tldr-pages/tldr.git - Output in the JSON format: -`doggo {{example.com}} --json | jq '{{.responses[0].answers[].address}}'` +`doggo {{example.com}} {{[-J|--json]}} | jq '{{.responses[0].answers[].address}}'` - Perform a reverse DNS lookup: -`doggo --reverse {{8.8.4.4}} --short` +`doggo {{[-x|--reverse]}} {{8.8.4.4}} --short` diff --git a/tldr/duplicity b/tldr/duplicity index 6d0a0a9d..0c99e6ef 100644 --- a/tldr/duplicity +++ b/tldr/duplicity @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Create incremental, compressed, encrypted and versioned backups. > Can also upload the backups to a variety of backend services. > It is worth mentioning that depending on the version, some options may not be available (e.g. `--gio` in 2.0.0). -> More information: . +> More information: . - Backup a directory via FTPS to a remote machine, encrypting it with a password: @@ -28,7 +28,7 @@ source: https://github.com/tldr-pages/tldr.git - List the files in a backup stored on a remote machine, via SSH: -`duplicity list-current-files --time {{YYYY-MM-DD}} scp://{{user@hostname}}/{{path/to/backup/dir}}` +`duplicity list-current-files {{[-t|--time]}} {{YYYY-MM-DD}} scp://{{user@hostname}}/{{path/to/backup/dir}}` - Restore a subdirectory from a GnuPG-encrypted local backup to a given location: diff --git a/tldr/elvish b/tldr/elvish index 23f2c35e..fa6646cd 100644 --- a/tldr/elvish +++ b/tldr/elvish @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Expressive programming language and a versatile interactive shell. > See also: `nu`. -> More information: . +> More information: . - Start an interactive shell session: diff --git a/tldr/gh-skyline b/tldr/gh-skyline index 88b82c84..409dcd54 100644 --- a/tldr/gh-skyline +++ b/tldr/gh-skyline @@ -13,30 +13,30 @@ source: https://github.com/tldr-pages/tldr.git `gh skyline` -- Generate a skyline for a specific [u]ser and [y]ear: +- Generate a skyline for a specific user and year: -`gh skyline --user {{username}} --year {{year}}` +`gh skyline {{[-u|--user]}} {{username}} {{[-y|--year]}} {{year}}` -- Generate a skyline for a range of [y]ears: +- Generate a skyline for a range of years: -`gh skyline --user {{username}} --year {{first_year}}-{{last_year}}` +`gh skyline {{[-u|--user]}} {{username}} {{[-y|--year]}} {{first_year}}-{{last_year}}` -- Generate a [f]ull skyline (from the user's join year to the current year): +- Generate a full skyline (from the user's join year to the current year): -`gh skyline --user {{username}} --full` +`gh skyline {{[-u|--user]}} {{username}} {{[-f|--full]}}` -- Enable [d]ebug logging: +- Enable debug logging: -`gh skyline --debug` +`gh skyline {{[-d|--debug]}}` -- Generate a skyline and specify the [o]utput file path: +- Generate a skyline and specify the output file path: -`gh skyline --output {{path/to/output_file.stl}}` +`gh skyline {{[-o|--output]}} {{path/to/output_file.stl}}` -- Open the GitHub profile for a specific [u]ser: +- Open the GitHub profile for a specific user: -`gh skyline --user {{username}} --web` +`gh skyline {{[-u|--user]}} {{username}} {{[-w|--web]}}` -- Display [h]elp: +- Display help: -`gh skyline --help` +`gh skyline {{[-h|--help]}}` diff --git a/tldr/gifsicle b/tldr/gifsicle index 99c29c92..adf9a427 100644 --- a/tldr/gifsicle +++ b/tldr/gifsicle @@ -10,11 +10,11 @@ source: https://github.com/tldr-pages/tldr.git - Optimize a GIF as a new file: -`gifsicle {{path/to/input.gif}} --optimize=3 -o {{path/to/output.gif}}` +`gifsicle {{path/to/input.gif}} {{[-O|--optimize=]}}3 {{[-o|--output]}} {{path/to/output.gif}}` -- Use [b]atch mode (modify each given file in place) and unoptimize a GIF: +- Use batch mode (modify each given file in place) and unoptimize a GIF: -`gifsicle -b {{path/to/input.gif}} --unoptimize` +`gifsicle {{[-b|--batch]}} {{path/to/input.gif}} {{[-U|--unoptimize]}}` - Extract a frame from a GIF: @@ -22,16 +22,16 @@ source: https://github.com/tldr-pages/tldr.git - Make a GIF animation from selected GIFs: -`gifsicle {{*.gif}} --delay={{10}} --loop > {{path/to/output.gif}}` +`gifsicle {{*.gif}} {{[-d|--delay]}} {{10}} {{[-l|--loop]}} > {{path/to/output.gif}}` - Reduce file size using lossy compression: -`gifsicle -b {{path/to/input.gif}} --optimize=3 --lossy={{100}} --colors={{16}} --dither` +`gifsicle {{[-b|--batch]}} {{path/to/input.gif}} {{[-O|--optimize=]}}3 --lossy={{100}} {{[-k|--colors]}} {{16}} {{[-f|--dither]}}` - Delete the first 10 frames and all frames after frame 20 from a GIF: -`gifsicle -b {{path/to/input.gif}} --delete '#{{0-9}}' '#{{20-}}'` +`gifsicle {{[-b|--batch]}} {{path/to/input.gif}} --delete '#{{0-9}}' '#{{20-}}'` - Modify all frames by cropping them to a rectangle, changing their scale, flipping them, and rotating them: -`gifsicle -b --crop {{starting_x}},{{starting_y}}+{{rect_width}}x{{rect_height}} --scale {{0.25}} --flip-horizontal --rotate-{{90|180|270}} {{path/to/input.gif}}` +`gifsicle {{[-b|--batch]}} --crop {{starting_x}},{{starting_y}}+{{rect_width}}x{{rect_height}} --scale {{0.25}} --flip-horizontal --rotate-{{90|180|270}} {{path/to/input.gif}}` diff --git a/tldr/git-magic b/tldr/git-magic index a771c087..320ec7e9 100644 --- a/tldr/git-magic +++ b/tldr/git-magic @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Automate add, commit, and push routines. > Part of `git-extras`. -> More information: . +> More information: . - Commit changes with a generated message: diff --git a/tldr/gnatmake b/tldr/gnatmake index 058de948..7343b0b1 100644 --- a/tldr/gnatmake +++ b/tldr/gnatmake @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # gnatmake > A low-level build tool for Ada programs (part of the GNAT toolchain). -> More information: . +> More information: . - Compile an executable: diff --git a/tldr/golangci-lint b/tldr/golangci-lint index fe5fd446..1854403f 100644 --- a/tldr/golangci-lint +++ b/tldr/golangci-lint @@ -16,6 +16,6 @@ source: https://github.com/tldr-pages/tldr.git `golangci-lint linters` -- [E]nable a specific linter for this run: +- Enable a specific linter for this run: -`golangci-lint run --enable {{linter}}` +`golangci-lint run {{[-E|--enable]}} {{linter}}` diff --git a/tldr/httpx b/tldr/httpx index 0ec52e26..e94743ab 100644 --- a/tldr/httpx +++ b/tldr/httpx @@ -11,32 +11,32 @@ source: https://github.com/tldr-pages/tldr.git - Run a probe against a [u]RL, host, IP Address or subnet (CIDR notation) showing probe status: -`httpx -probe -u {{url|host|ipaddress|subnet_with_cidr}}` +`httpx -probe {{[-u|-target]}} {{url|host|ipaddress|subnet_with_cidr}}` -- Run a probe against multiple hosts showing [s]tatus [c]ode with input from `subfinder`: +- Run a probe against multiple hosts showing status code with input from `subfinder`: -`subfinder -d {{example.com}} | httpx -sc` +`subfinder {{[-d|-domain]}} {{example.com}} | httpx {{[-sc|-status-code]}}` -- Run a [r]ate [l]imited probe against a [l]ist of hosts from a file showing [t]echnology [d]etected and [r]esponse [t]ime: +- Run a rate limited probe against a list of hosts from a file showing technology detected and response time: -`httpx -rl {{150}} -l {{path/to/newline_separated_hosts_list}} -td -rt` +`httpx {{[-rl|-rate-limit]}} {{150}} {{[-l|-list]}} {{path/to/newline_separated_hosts_list}} {{[-td|-tech-detect]}} {{[-rt|-response-time]}}` - Run a probe against a [u]RL showing its webpage title, CDN/WAF in use, and page content hash: -`httpx -u {{url}} -title -cdn -hash {{sha256}}` +`httpx {{[-u|-target]}} {{url}} -title -cdn -hash {{sha256}}` -- Run a probe against a list of hosts with custom defined [p]orts and timeout after certain seconds: +- Run a probe against a list of hosts with custom defined ports and timeout after certain seconds: -`httpx -probe -u {{host1,host2,...}} -p http:{{80,8000-8080}},https:{{443,8443}} -timeout {{10}}` +`httpx -probe {{[-u|-target]}} {{host1,host2,...}} {{[-p|-ports]}} http:{{80,8000-8080}},https:{{443,8443}} -timeout {{10}}` -- Run a probe against a list of hosts [f]iltering out [c]odes of certain responses: +- Run a probe against a list of hosts filtering out codes of certain responses: -`httpx -u {{host1,host2,...}} -fc {{400,401,404}}` +`httpx {{[-u|-target]}} {{host1,host2,...}} {{[-fc|-filter-code]}} {{400,401,404}}` -- Run a probe against a list of hosts [m]atching [c]odes of certain responses: +- Run a probe against a list of hosts matching codes of certain responses: -`httpx -u {{host1,host2,...}} -mc {{200,301,304}}` +`httpx {{[-u|-target]}} {{host1,host2,...}} {{[-mc|-match-code]}} {{200,301,304}}` -- Run a probe against a URL [s]aving [s]creenshots of certain paths, with [s]creenshot [t]imeouts (assets are saved in `./output`): +- Run a probe against a URL saving screenshots of certain paths, with screenshot timeouts (assets are saved in `./output`): -`httpx -u {{https://www.github.com}} -path {{/tldr-pages/tldr,/projectdiscovery/httpx}} -ss -st {{10}}` +`httpx {{[-u|-target]}} {{https://www.github.com}} -path {{/tldr-pages/tldr,/projectdiscovery/httpx}} {{[-ss|-screenshot]}} {{[-st|-screenshot-timeout]}} {{10}}` diff --git a/tldr/ifdata b/tldr/ifdata index 0da67839..d4028968 100644 --- a/tldr/ifdata +++ b/tldr/ifdata @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # ifdata > Display information about a network interface. -> More information: . +> More information: . - Display the whole configuration of the specified interface: diff --git a/tldr/katana b/tldr/katana index 414bdd7d..91b122c0 100644 --- a/tldr/katana +++ b/tldr/katana @@ -15,20 +15,20 @@ source: https://github.com/tldr-pages/tldr.git - Crawl a [u]RL using headless mode using Chromium: -`katana -u {{https://example.com}} -headless` +`katana -u {{https://example.com}} {{[-hl|-headless]}}` - Use `subfinder` to find subdomains, and then use [p]a[s]sive sources (Wayback Machine, Common Crawl, and AlienVault) for URL discovery: -`subfinder -list {{path/to/domains.txt}} | katana -passive` +`subfinder {{[-dL|-list]}} {{path/to/domains.txt}} | katana -passive` -- Pass requests through a proxy (http/socks5) and use custom [H]eaders from a file: +- Pass requests through a proxy (http/socks5) and use custom headers from a file: -`katana -proxy {{http://127.0.0.1:8080}} -headers {{path/to/headers.txt}} -u {{https://example.com}}` +`katana -proxy {{http://127.0.0.1:8080}} {{[-H|-headers]}} {{path/to/headers.txt}} -u {{https://example.com}}` -- Specify the crawling [s]trategy, [d]epth of subdirectories to crawl, and rate limiting (requests per second): +- Specify the crawling strategy, depth of subdirectories to crawl, and rate limiting (requests per second): -`katana -strategy {{depth-first|breadth-first}} -depth {{value}} -rate-limit {{value}} -u {{https://example.com}}` +`katana {{[-s|-strategy]}} {{depth-first|breadth-first}} {{[-d|-depth]}} {{value}} {{[-rl|-rate-limit]}} {{value}} -u {{https://example.com}}` -- Find subdomains using `subfinder`, crawl each for a maximum number of seconds, and write results to an [o]utput file: +- Find subdomains using `subfinder`, crawl each for a maximum number of seconds, and write results to an output file: -`subfinder -list {{path/to/domains.txt}} | katana -crawl-duration {{value}} -output {{path/to/output.txt}}` +`subfinder {{[-dL|-list]}} {{path/to/domains.txt}} | katana {{[-ct|-crawl-duration]}} {{value}} {{[-o|-output]}} {{path/to/output.txt}}` diff --git a/tldr/ksh b/tldr/ksh index 7f88ac49..4aaf4a3d 100644 --- a/tldr/ksh +++ b/tldr/ksh @@ -6,8 +6,8 @@ source: https://github.com/tldr-pages/tldr.git # ksh > Korn Shell, a Bash-compatible command-line interpreter. -> See also: `histexpand`. -> More information: . +> See also: `!`, `^`. +> More information: . - Start an interactive shell session: diff --git a/tldr/kubectl-describe b/tldr/kubectl-describe index ea81bbe4..d540642b 100644 --- a/tldr/kubectl-describe +++ b/tldr/kubectl-describe @@ -8,22 +8,22 @@ source: https://github.com/tldr-pages/tldr.git > Show details of Kubernetes objects and resources. > More information: . -- Show details of pods in a [n]amespace: +- Show details of pods in a namespace: -`kubectl describe pods --namespace {{namespace}}` +`kubectl describe pods {{[-n|--namespace]}} {{namespace}}` -- Show details of nodes in a [n]amespace: +- Show details of nodes in a namespace: -`kubectl describe nodes --namespace {{namespace}}` +`kubectl describe nodes {{[-n|--namespace]}} {{namespace}}` -- Show the details of a specific pod in a [n]amespace: +- Show the details of a specific pod in a namespace: -`kubectl describe pods {{pod_name}} --namespace {{namespace}}` +`kubectl describe pods {{pod_name}} {{[-n|--namespace]}} {{namespace}}` -- Show the details of a specific node in a [n]amespace: +- Show the details of a specific node in a namespace: -`kubectl describe nodes {{node_name}} --namespace {{namespace}}` +`kubectl describe nodes {{node_name}} {{[-n|--namespace]}} {{namespace}}` -- Show details of Kubernetes objects defined in a YAML manifest [f]ile: +- Show details of Kubernetes objects defined in a YAML manifest file: -`kubectl describe --file {{path/to/manifest.yaml}}` +`kubectl describe {{[-f|--file]}} {{path/to/manifest.yaml}}` diff --git a/tldr/kubectl-get b/tldr/kubectl-get index 9ed5765b..ec5aa09d 100644 --- a/tldr/kubectl-get +++ b/tldr/kubectl-get @@ -12,26 +12,26 @@ source: https://github.com/tldr-pages/tldr.git `kubectl get namespaces` -- Get nodes in a specified [n]amespace: +- Get nodes in a specified namespace: -`kubectl get nodes --namespace {{namespace}}` +`kubectl get nodes {{[-n|--namespace]}} {{namespace}}` -- Get pods in a specified [n]amespace: +- Get pods in a specified namespace: -`kubectl get pods --namespace {{namespace}}` +`kubectl get pods {{[-n|--namespace]}} {{namespace}}` -- Get deployments in a specified [n]amespace: +- Get deployments in a specified namespace: -`kubectl get deployments --namespace {{namespace}}` +`kubectl get deployments {{[-n|--namespace]}} {{namespace}}` -- Get services in a specified [n]amespace: +- Get services in a specified namespace: -`kubectl get services --namespace {{namespace}}` +`kubectl get services {{[-n|--namespace]}} {{namespace}}` -- Get all resources in a specified [n]amespace: +- Get all resources in a specified namespace: -`kubectl get all --namespace {{namespace}}` +`kubectl get all {{[-n|--namespace]}} {{namespace}}` -- Get Kubernetes objects defined in a YAML manifest [f]ile: +- Get Kubernetes objects defined in a YAML manifest file: -`kubectl get --file {{path/to/manifest.yaml}}` +`kubectl get {{[-f|--file]}} {{path/to/manifest.yaml}}` diff --git a/tldr/kubectl-wait b/tldr/kubectl-wait index 863f6529..5a68aa97 100644 --- a/tldr/kubectl-wait +++ b/tldr/kubectl-wait @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Wait for all pods with a certain [l]abel to be ready: -`kubectl wait --for=condition=ready pod -l {{label_key}}={{label_value}}` +`kubectl wait --for=condition=ready pod {{[-l|--selector]}} {{label_key}}={{label_value}}` - Wait for a pod to be deleted: diff --git a/tldr/kubeseal b/tldr/kubeseal new file mode 100644 index 00000000..440beef5 --- /dev/null +++ b/tldr/kubeseal @@ -0,0 +1,43 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kubeseal + +> Client-side utility for encrypting Kubernetes secrets using the Bitnami Sealed Secrets controller. +> Creates SealedSecret resources that can be safely stored in version control. +> Requires a controller running in the cluster (e.g., installed via `kubectl apply -f controller.yaml`). +> More information: . + +- Encrypt a Kubernetes secret from a YAML file into a SealedSecret (default JSON output): + +`kubeseal < {{secret.yaml}} > {{sealedsecret.json}}` + +- Encrypt a secret, outputting it in YAML or JSON format, using a bearer token for API authentication: + +`kubeseal {{[-o|--format]}} {{yaml|json}} --token {{my-bearer-token}} < {{secret.yaml}} > {{sealedsecret.yaml}}` + +- Seal a secret using a specific controller namespace of sealed-secrets controller and name: + +`kubeseal --controller-namespace {{controller-namespace}} --controller-name {{controller-name}} < {{secret.yaml}} > {{sealedsecret.yaml}}` + +- Encrypt a raw secret value from a file with a specified name and scope: + +`kubeseal --raw --from-file {{path/to/secret.txt}} --name {{my-secret}} --scope {{strict|namespace-wide|cluster-wide}} > {{sealedsecret.yaml}}` + +- Fetch the controller's public certificate for offline sealing with basic auth: + +`kubeseal --fetch-cert --username {{username}} --password {{password}} > {{cert.pem}}` + +- Seal a secret offline using a fetched certificate: + +`kubeseal --cert {{cert.pem}} < {{secret.yaml}} > {{sealedsecret.yaml}}` + +- Merge a secret into an existing SealedSecret file in-place: + +`kubeseal --merge-into {{sealedsecret.yaml}} < {{secret.yaml}}` + +- Validate a SealedSecret without applying it: + +`kubeseal --validate < {{sealedsecret.yaml}}` diff --git a/tldr/kubie b/tldr/kubie new file mode 100644 index 00000000..1dc548a1 --- /dev/null +++ b/tldr/kubie @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kubie + +> Utility to switch between `kubectl` contexts and namespaces. +> More information: . + +- Display a selectable menu of contexts: + +`kubie ctx` + +- Switch current shell to the given context: + +`kubie ctx {{context}}` + +- Switch current shell to the given namespace: + +`kubie ns {{namespace}}` + +- Switch current shell to the given context and namespace: + +`kubie ctx {{context}} -n {{namespace}}` + +- Execute a command in the given context and namespace, without spawning a shell: + +`kubie exec {{context}} {{namespace}} {{command}}` + +- Check the Kubernetes config files for issues: + +`kubie lint` diff --git a/tldr/latexpand b/tldr/latexpand index 17b26913..e74f1e02 100644 --- a/tldr/latexpand +++ b/tldr/latexpand @@ -8,22 +8,22 @@ source: https://github.com/tldr-pages/tldr.git > Simplify LaTeX source files by removing comments and resolving `\include`s, `\input`s, etc. > More information: . -- Simplify the specified source file and save the result to the specified [o]utput file: +- Simplify the specified source file and save the result to the specified output file: -`latexpand --output {{path/to/output.tex}} {{path/to/file.tex}}` +`latexpand {{[-o|--output]}} {{path/to/output.tex}} {{path/to/file.tex}}` - Do not remove comments: -`latexpand --keep-comments --output {{path/to/output.tex}} {{path/to/file.tex}}` +`latexpand --keep-comments {{[-o|--output]}} {{path/to/output.tex}} {{path/to/file.tex}}` - Do not expand `\include`s, `\input`s etc.: -`latexpand --keep-includes --output {{path/to/output.tex}} {{path/to/file.tex}}` +`latexpand --keep-includes {{[-o|--output]}} {{path/to/output.tex}} {{path/to/file.tex}}` - Expand `\usepackage`s as far as the corresponding STY files can be found: -`latexpand --expand-usepackage --output {{path/to/output.tex}} {{path/to/file.tex}}` +`latexpand --expand-usepackage {{[-o|--output]}} {{path/to/output.tex}} {{path/to/file.tex}}` - Inline the specified BBL file: -`latexpand --expand-bbl {{path/to/bibliography.bbl}} --output {{path/to/output.tex}} {{path/to/file.tex}}` +`latexpand --expand-bbl {{path/to/bibliography.bbl}} {{[-o|--output]}} {{path/to/output.tex}} {{path/to/file.tex}}` diff --git a/tldr/licensor b/tldr/licensor index e2486159..4b0877ab 100644 --- a/tldr/licensor +++ b/tldr/licensor @@ -12,9 +12,9 @@ source: https://github.com/tldr-pages/tldr.git `licensor {{MIT}} > {{LICENSE}}` -- Write the MIT license with a [p]laceholder copyright notice to a file named `LICENSE`: +- Write the MIT license with a placeholder copyright notice to a file named `LICENSE`: -`licensor -p {{MIT}} > {{LICENSE}}` +`licensor {{[-p|--keep-placeholder]}} {{MIT}} > {{LICENSE}}` - Specify a copyright holder named Bobby Tables: @@ -26,8 +26,8 @@ source: https://github.com/tldr-pages/tldr.git - List all available licenses: -`licensor --licenses` +`licensor {{[-l|--licenses]}}` - List all available exceptions: -`licensor --exceptions` +`licensor {{[-e|--exceptions]}}` diff --git a/tldr/linux/blkdiscard b/tldr/linux/blkdiscard index 05766c98..e7393812 100644 --- a/tldr/linux/blkdiscard +++ b/tldr/linux/blkdiscard @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - Securely discard all blocks on a device, removing all data: -`blkdiscard --secure {{/dev/device}}` +`blkdiscard {{[-s|--secure]}} {{/dev/device}}` - Discard the first 100 MB of a device: -`blkdiscard --length {{100MB}} {{/dev/device}}` +`blkdiscard {{[-l|--length]}} {{100MB}} {{/dev/device}}` diff --git a/tldr/linux/blkid b/tldr/linux/blkid index a7c4f35a..c5fe1dbb 100644 --- a/tldr/linux/blkid +++ b/tldr/linux/blkid @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - List all partitions in a table, including current mountpoints: -`sudo blkid -o list` +`sudo blkid {{[-o|--output]}} list` diff --git a/tldr/linux/cfdisk b/tldr/linux/cfdisk index c7784d9b..d0410268 100644 --- a/tldr/linux/cfdisk +++ b/tldr/linux/cfdisk @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Create a new partition table for a specific device and manage it: -`cfdisk --zero {{/dev/sdX}}` +`cfdisk {{[-z|--zero]}} {{/dev/sdX}}` diff --git a/tldr/linux/chcpu b/tldr/linux/chcpu index 71231dde..b581717d 100644 --- a/tldr/linux/chcpu +++ b/tldr/linux/chcpu @@ -10,8 +10,8 @@ source: https://github.com/tldr-pages/tldr.git - Disable one or more CPUs by their IDs: -`chcpu -d {{1,3}}` +`chcpu {{[-d|--disable]}} {{1,3}}` - Enable one or more ranges of CPUs by their IDs: -`chcpu -e {{1-3,5-7}}` +`chcpu {{[-e|--enable]}} {{1-3,5-7}}` diff --git a/tldr/linux/choom b/tldr/linux/choom index 2322d69f..997fa105 100644 --- a/tldr/linux/choom +++ b/tldr/linux/choom @@ -10,12 +10,12 @@ source: https://github.com/tldr-pages/tldr.git - Display the OOM-killer score of the process with a specific ID: -`choom -p {{pid}}` +`choom {{[-p|--pid]}} {{pid}}` - Change the adjust OOM-killer score of a specific process: -`choom -p {{pid}} -n {{-1000..+1000}}` +`choom {{[-p|--pid]}} {{pid}} {{[-n|--adjust]}} {{-1000..+1000}}` - Run a command with a specific adjust OOM-killer score: -`choom -n {{-1000..+1000}} {{command}} {{argument1 argument2 ...}}` +`choom {{[-n|--adjust]}} {{-1000..+1000}} {{command}} {{argument1 argument2 ...}}` diff --git a/tldr/linux/chrt b/tldr/linux/chrt index dbf5d6e4..7950e876 100644 --- a/tldr/linux/chrt +++ b/tldr/linux/chrt @@ -10,20 +10,20 @@ source: https://github.com/tldr-pages/tldr.git - Display attributes of a process: -`chrt --pid {{PID}}` +`chrt {{[-p|--pid]}} {{PID}}` - Display attributes of all threads of a process: -`chrt --all-tasks --pid {{PID}}` +`chrt {{[-a|--all-tasks]}} {{[-p|--pid]}} {{PID}}` - Display the min/max priority values that can be used with `chrt`: -`chrt --max` +`chrt {{[-m|--max]}}` - Set the scheduling priority of a process: -`chrt --pid {{priority}} {{PID}}` +`chrt {{[-p|--pid]}} {{priority}} {{PID}}` - Set the scheduling policy of a process: -`chrt --{{deadline|idle|batch|rr|fifo|other}} --pid {{priority}} {{PID}}` +`chrt --{{deadline|idle|batch|rr|fifo|other}} {{[-p|--pid]}} {{priority}} {{PID}}` diff --git a/tldr/linux/column b/tldr/linux/column new file mode 100644 index 00000000..99c4b833 --- /dev/null +++ b/tldr/linux/column @@ -0,0 +1,35 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# column + +> Format `stdin` or a file into multiple columns. +> Columns are filled before rows; the default separator is a whitespace. +> More information: . + +- Format the output of a command for a 30 characters wide display: + +`printf "header1 header2 +bar foo +" | column {{[-c|--output-width]}} {{30}}` + +- Split columns automatically and auto-align them in a tabular format: + +`printf "header1 header2 +bar foo +" | column {{[-t|--table]}}` + +- Specify the column delimiter character for the `--table` option (e.g. "," for CSV) (defaults to whitespace): + +`printf "header1,header2 +bar,foo +" | column {{[-t|--table]}} {{[-s|--separator]}} {{,}}` + +- Fill rows before filling columns: + +`printf "header1 +bar +foobar +" | column {{[-c|--output-width]}} {{30}} {{[-x|--fillrows]}}` diff --git a/tldr/linux/fallocate b/tldr/linux/fallocate index 34ab3a5f..f76e2873 100644 --- a/tldr/linux/fallocate +++ b/tldr/linux/fallocate @@ -11,12 +11,12 @@ source: https://github.com/tldr-pages/tldr.git - Reserve a file taking up 700 MiB of disk space: -`fallocate --length {{700M}} {{path/to/file}}` +`fallocate {{[-l|--length]}} {{700M}} {{path/to/file}}` - Shrink an already allocated file by 200 MiB: -`fallocate --collapse-range --length {{200M}} {{path/to/file}}` +`fallocate {{[-c|--collapse-range]}} {{[-l|--length]}} {{200M}} {{path/to/file}}` - Shrink 20 MB of space after 100 MiB in a file: -`fallocate --collapse-range --offset {{100M}} --length {{20M}} {{path/to/file}}` +`fallocate {{[-c|--collapse-range]}} {{[-o|--offset]}} {{100M}} {{[-l|--length]}} {{20M}} {{path/to/file}}` diff --git a/tldr/linux/findmnt b/tldr/linux/findmnt index a34c99e7..3f386d34 100644 --- a/tldr/linux/findmnt +++ b/tldr/linux/findmnt @@ -22,7 +22,7 @@ source: https://github.com/tldr-pages/tldr.git - Find filesystems in specific type: -`findmnt -t {{ext4}}` +`findmnt {{[-t|--types]}} {{ext4}}` - Find filesystems with specific label: @@ -30,4 +30,4 @@ source: https://github.com/tldr-pages/tldr.git - Check mount table content in detail and verify `/etc/fstab`: -`findmnt --verify --verbose` +`findmnt {{[-x|--verify]}} --verbose` diff --git a/tldr/linux/flock b/tldr/linux/flock new file mode 100644 index 00000000..15ad65c6 --- /dev/null +++ b/tldr/linux/flock @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# flock + +> Manage locks from shell scripts. +> It can be used to ensure that only one process of a command is running. +> More information: . + +- Run a command with a file lock as soon as the lock is not required by others: + +`flock {{path/to/lock.lock}} {{[-c|--command]}} "{{command}}"` + +- Run a command with a file lock, and exit if the lock doesn't exist: + +`flock {{path/to/lock.lock}} {{[-n|--nonblock]}} {{[-c|--command]}} "{{command}}"` + +- Run a command with a file lock, and exit with a specific error code if the lock doesn't exist: + +`flock {{path/to/lock.lock}} {{[-n|--nonblock]}} {{[-E|--conflict-exit-code]}} {{error_code}} {{[-c|--command]}} "{{command}}"` diff --git a/tldr/linux/fstrim b/tldr/linux/fstrim index 077ac269..8987d5c8 100644 --- a/tldr/linux/fstrim +++ b/tldr/linux/fstrim @@ -11,7 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - Trim unused blocks on all mounted partitions that support it: -`sudo fstrim --all` +`sudo fstrim {{[-a|--all]}}` - Trim unused blocks on a specified partition: @@ -19,4 +19,4 @@ source: https://github.com/tldr-pages/tldr.git - Display statistics after trimming: -`sudo fstrim --verbose {{/}}` +`sudo fstrim {{[-v|--verbose]}} {{/}}` diff --git a/tldr/linux/hexdump b/tldr/linux/hexdump new file mode 100644 index 00000000..7047e7a1 --- /dev/null +++ b/tldr/linux/hexdump @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# hexdump + +> An ASCII, decimal, hexadecimal, octal dump. +> More information: . + +- Print the hexadecimal representation of a file, replacing duplicate lines by '*': + +`hexdump {{path/to/file}}` + +- Display the input offset in hexadecimal and its ASCII representation in two columns: + +`hexdump {{[-C|--canonical]}} {{path/to/file}}` + +- Display the hexadecimal representation of a file, but interpret only n bytes of the input: + +`hexdump {{[-C|--canonical]}} {{[-n|--length]}} {{number_of_bytes}} {{path/to/file}}` + +- Don't replace duplicate lines with '*': + +`hexdump {{[-v|--no-squeezing]}} {{path/to/file}}` diff --git a/tldr/linux/hwclock b/tldr/linux/hwclock index b1edbff2..5ca4b9c2 100644 --- a/tldr/linux/hwclock +++ b/tldr/linux/hwclock @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - Write the current software clock time to the hardware clock (sometimes used during system setup): -`hwclock --systohc` +`hwclock {{[-w|--systohc]}}` - Write the current hardware clock time to the software clock: -`hwclock --hctosys` +`hwclock {{[-s|--hctosys]}}` diff --git a/tldr/linux/ipcrm b/tldr/linux/ipcrm index 8325e371..71d49557 100644 --- a/tldr/linux/ipcrm +++ b/tldr/linux/ipcrm @@ -10,28 +10,28 @@ source: https://github.com/tldr-pages/tldr.git - Delete a shared memory segment by ID: -`ipcrm --shmem-id {{shmem_id}}` +`ipcrm {{[-m|--shmem-id]}} {{shmem_id}}` - Delete a shared memory segment by key: -`ipcrm --shmem-key {{shmem_key}}` +`ipcrm {{[-M|--shmem-key]}} {{shmem_key}}` - Delete an IPC queue by ID: -`ipcrm --queue-id {{ipc_queue_id}}` +`ipcrm {{[-q|--queue-id]}} {{ipc_queue_id}}` - Delete an IPC queue by key: -`ipcrm --queue-key {{ipc_queue_key}}` +`ipcrm {{[-Q|--queue-key]}} {{ipc_queue_key}}` - Delete a semaphore by ID: -`ipcrm --semaphore-id {{semaphore_id}}` +`ipcrm {{[-s|--semaphore-id]}} {{semaphore_id}}` - Delete a semaphore by key: -`ipcrm --semaphore-key {{semaphore_key}}` +`ipcrm {{[-S|--semaphore-key]}} {{semaphore_key}}` - Delete all IPC resources: -`ipcrm --all` +`ipcrm {{[-a|--all]}}` diff --git a/tldr/linux/isosize b/tldr/linux/isosize index 74d1c35c..3d0dd5f2 100644 --- a/tldr/linux/isosize +++ b/tldr/linux/isosize @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - Display the block count and block size of an ISO file: -`isosize --sectors {{path/to/file.iso}}` +`isosize {{[-x|--sectors]}} {{path/to/file.iso}}` - Display the size of an ISO file divided by a given number (only usable when --sectors is not given): -`isosize --divisor={{number}} {{path/to/file.iso}}` +`isosize {{[-d|--divisor]}} {{number}} {{path/to/file.iso}}` diff --git a/tldr/linux/last b/tldr/linux/last index 4a2149f3..18c72812 100644 --- a/tldr/linux/last +++ b/tldr/linux/last @@ -5,11 +5,10 @@ source: https://github.com/tldr-pages/tldr.git --- # last -> List information of last user logins. -> See also: `lastb`, `login`. -> More information: . +> View the last logged in users. +> More information: . -- List login information (e.g., username, terminal, boot time, kernel) of all users: +- View last login infromation (e.g., username, terminal, boot time, kernel) of all users as read from `/var/log/wtmp`: `last` @@ -17,26 +16,26 @@ source: https://github.com/tldr-pages/tldr.git `last {{username}}` -- List information of a specific TTY: +- Specify how many of the last logins to show: -`last {{tty1}}` +`last {{[-n|--limit]}} {{login_count}}` -- List most recent information (by default, the newest are at the top): +- Print the full date and time for entries and then display the hostname column last to prevent truncation: -`last | tac` +`last {{[-F|--fulltimes]}} {{[-a|--hostlast]}}` -- List information of system boots: +- View all logins by a specific user and show the IP address instead of the hostname: -`last "{{system boot}}"` +`last {{username}} {{[-i|--ip]}}` -- List information with a specific [t]imestamp format: +- List information since a specific time and date: -`last --time-format {{notime|full|iso}}` +`last {{[-s|--since]}} {{-7days}}` -- List information [s]ince a specific time and date: +- View all recorded reboots (i.e., the last logins of the pseudo user "reboot"): -`last --since {{-7days}}` +`last reboot` -- List information (i.e., hostname and IP) of remote hosts: +- Display help: -`last --dns` +`last {{[-h|--help]}}` diff --git a/tldr/linux/lastb b/tldr/linux/lastb index 7ec400e7..b28cec1e 100644 --- a/tldr/linux/lastb +++ b/tldr/linux/lastb @@ -14,16 +14,16 @@ source: https://github.com/tldr-pages/tldr.git - List all last logged in users since a given time: -`sudo lastb --since {{YYYY-MM-DD}}` +`sudo lastb {{[-s|--since]}} {{YYYY-MM-DD}}` - List all last logged in users until a given time: -`sudo lastb --until {{YYYY-MM-DD}}` +`sudo lastb {{[-t|--until]}} {{YYYY-MM-DD}}` - List all logged in users at a specific time: -`sudo lastb --present {{hh:mm}}` +`sudo lastb {{[-p|--present]}} {{hh:mm}}` - List all last logged in users and translate the IP into a hostname: -`sudo lastb --dns` +`sudo lastb {{[-d|--dns]}}` diff --git a/tldr/linux/logger b/tldr/linux/logger new file mode 100644 index 00000000..59419aa0 --- /dev/null +++ b/tldr/linux/logger @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# logger + +> Add messages to syslog (/var/log/syslog). +> More information: . + +- Log a message to syslog: + +`logger {{message}}` + +- Take input from `stdin` and log to syslog: + +`echo {{log_entry}} | logger` + +- Send the output to a remote syslog server running at a given port. Default port is 514: + +`echo {{log_entry}} | logger {{[-n|--server]}} {{hostname}} {{[-P|--port]}} {{port}}` + +- Use a specific tag for every line logged. Default is the name of logged in user: + +`echo {{log_entry}} | logger {{[-t|--tag]}} {{tag}}` + +- Log messages with a given priority. Default is `user.notice`. See `man logger` for all priority options: + +`echo {{log_entry}} | logger {{[-p|--priority]}} {{user.warning}}` diff --git a/tldr/linux/losetup b/tldr/linux/losetup index d989cd64..296b7c08 100644 --- a/tldr/linux/losetup +++ b/tldr/linux/losetup @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - List loop devices with detailed info: -`losetup -a` +`losetup {{[-a|--all]}}` - Attach a file to a given loop device: @@ -18,16 +18,16 @@ source: https://github.com/tldr-pages/tldr.git - Attach a file to a new free loop device and scan the device for partitions: -`sudo losetup --show --partscan -f /{{path/to/file}}` +`sudo losetup --show {{[-P|--partscan]}} {{[-f|--find]}} /{{path/to/file}}` - Attach a file to a read-only loop device: -`sudo losetup --read-only {{/dev/loop}} /{{path/to/file}}` +`sudo losetup {{[-r|--read-only]}} {{/dev/loop}} /{{path/to/file}}` - Detach all loop devices: -`sudo losetup -D` +`sudo losetup {{[-D|--detach-all]}}` - Detach a given loop device: -`sudo losetup -d {{/dev/loop}}` +`sudo losetup {{[-d|--detach]}} {{/dev/loop}}` diff --git a/tldr/linux/lslocks b/tldr/linux/lslocks index 3a4e898c..9f350c16 100644 --- a/tldr/linux/lslocks +++ b/tldr/linux/lslocks @@ -14,16 +14,16 @@ source: https://github.com/tldr-pages/tldr.git - List locks with defined column headers: -`lslocks --output {{PID}},{{COMMAND}},{{PATH}}` +`lslocks {{[-o|--output]}} {{PID}},{{COMMAND}},{{PATH}}` - List locks producing a raw output (no columns), and without column headers: -`lslocks --raw --noheadings` +`lslocks {{[-r|--raw]}} {{[-n|--noheadings]}}` - List locks by PID input: -`lslocks --pid {{PID}}` +`lslocks {{[-p|--pid]}} {{PID}}` - List locks with JSON output to `stdout`: -`lslocks --json` +`lslocks {{[-J|--json]}}` diff --git a/tldr/linux/lsns b/tldr/linux/lsns index 6b520bec..f68c844b 100644 --- a/tldr/linux/lsns +++ b/tldr/linux/lsns @@ -14,16 +14,16 @@ source: https://github.com/tldr-pages/tldr.git - List namespaces in JSON format: -`lsns --json` +`lsns {{[-J|--json]}}` - List namespaces associated with the specified process: -`lsns --task {{pid}}` +`lsns {{[-p|--task]}} {{pid}}` - List the specified type of namespaces only: -`lsns --type {{mnt|net|ipc|user|pid|uts|cgroup|time}}` +`lsns {{[-t|--type]}} {{mnt|net|ipc|user|pid|uts|cgroup|time}}` - List namespaces, only showing the namespace ID, type, PID, and command: -`lsns --output {{NS,TYPE,PID,COMMAND}}` +`lsns {{[-o|--output]}} {{NS,TYPE,PID,COMMAND}}` diff --git a/tldr/linux/mcookie b/tldr/linux/mcookie index 1ba8f982..7e5a13a9 100644 --- a/tldr/linux/mcookie +++ b/tldr/linux/mcookie @@ -14,12 +14,12 @@ source: https://github.com/tldr-pages/tldr.git - Generate a random number, using the contents of a file as a seed for the randomness: -`mcookie --file {{path/to/file}}` +`mcookie {{[-f|--file]}} {{path/to/file}}` - Generate a random number, using a specific number of bytes from a file as a seed for the randomness: -`mcookie --file {{path/to/file}} --max-size {{number_of_bytes}}` +`mcookie {{[-f|--file]}} {{path/to/file}} {{[-m|--max-size]}} {{number_of_bytes}}` - Print the details of the randomness used, such as the origin and seed for each source: -`mcookie --verbose` +`mcookie {{[-v|--verbose]}}` diff --git a/tldr/linux/mkfs b/tldr/linux/mkfs index 8b33b260..036cfa93 100644 --- a/tldr/linux/mkfs +++ b/tldr/linux/mkfs @@ -15,8 +15,8 @@ source: https://github.com/tldr-pages/tldr.git - Build a filesystem of a specified type: -`mkfs -t {{ext4}} {{path/to/partition}}` +`mkfs {{[-t|--type]}} {{ext4}} {{path/to/partition}}` - Build a filesystem of a specified type and check for bad blocks: -`mkfs -c -t {{ntfs}} {{path/to/partition}}` +`mkfs -c {{[-t|--type]}} {{ntfs}} {{path/to/partition}}` diff --git a/tldr/linux/mkswap b/tldr/linux/mkswap index bfc3b2a8..dab5386f 100644 --- a/tldr/linux/mkswap +++ b/tldr/linux/mkswap @@ -15,8 +15,8 @@ source: https://github.com/tldr-pages/tldr.git - Check a partition for bad blocks before creating the swap area: -`sudo mkswap -c {{path/to/file}}` +`sudo mkswap {{[-c|--check]}} {{path/to/file}}` - Specify a label for the partition (to allow `swapon` to use the label): -`sudo mkswap -L {{label}} {{/dev/sda1}}` +`sudo mkswap {{[-L|--label]}} {{label}} {{/dev/sda1}}` diff --git a/tldr/linux/mount b/tldr/linux/mount new file mode 100644 index 00000000..755db963 --- /dev/null +++ b/tldr/linux/mount @@ -0,0 +1,41 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# mount + +> Get access to an entire filesystem in one directory. +> More information: . + +- Show all mounted filesystems: + +`mount` + +- Mount a device to a directory: + +`mount {{[-t|--types]}} {{filesystem_type}} {{path/to/device_file}} {{path/to/target_directory}}` + +- Create a specific directory if it does not exist and mount a device to it: + +`mount {{[-m|--mkdir]}} {{path/to/device_file}} {{path/to/target_directory}}` + +- Mount a device to a directory for a specific user: + +`mount {{[-o|--options]}} uid={{user_id}},gid={{group_id}} {{path/to/device_file}} {{path/to/target_directory}}` + +- Mount a CD-ROM device (with the filetype ISO9660) to `/cdrom` (readonly): + +`mount {{[-t|--types]}} {{iso9660}} {{[-o|--options]}} ro {{/dev/cdrom}} {{/cdrom}}` + +- Mount all the filesystem defined in `/etc/fstab`: + +`mount {{[-a|--all]}}` + +- Mount a specific filesystem described in `/etc/fstab` (e.g. `/dev/sda1 /my_drive ext2 defaults 0 2`): + +`mount {{/my_drive}}` + +- Mount a directory to another directory: + +`mount {{[-B|--bind]}} {{path/to/old_dir}} {{path/to/new_dir}}` diff --git a/tldr/linux/mountpoint b/tldr/linux/mountpoint index c25bc326..01b0b409 100644 --- a/tldr/linux/mountpoint +++ b/tldr/linux/mountpoint @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - Check if a directory is a mountpoint without showing any output: -`mountpoint -q {{path/to/directory}}` +`mountpoint {{[-q|--quiet]}} {{path/to/directory}}` - Show major/minor numbers of a mountpoint's filesystem: -`mountpoint --fs-devno {{path/to/directory}}` +`mountpoint {{[-d|--fs-devno]}} {{path/to/directory}}` diff --git a/tldr/linux/namei b/tldr/linux/namei index 9afb060b..b747022c 100644 --- a/tldr/linux/namei +++ b/tldr/linux/namei @@ -15,16 +15,16 @@ source: https://github.com/tldr-pages/tldr.git - Display the results in a long-listing format: -`namei --long {{path/to/a}} {{path/to/b}} {{path/to/c}}` +`namei {{[-l|--long]}} {{path/to/a}} {{path/to/b}} {{path/to/c}}` - Show the mode bits of each file type in the style of `ls`: -`namei --modes {{path/to/a}} {{path/to/b}} {{path/to/c}}` +`namei {{[-m|--modes]}} {{path/to/a}} {{path/to/b}} {{path/to/c}}` - Show owner and group name of each file: -`namei --owners {{path/to/a}} {{path/to/b}} {{path/to/c}}` +`namei {{[-o|--owners]}} {{path/to/a}} {{path/to/b}} {{path/to/c}}` - Don't follow symlinks while resolving: -`namei --nosymlinks {{path/to/a}} {{path/to/b}} {{path/to/c}}` +`namei {{[-n|--nosymlinks]}} {{path/to/a}} {{path/to/b}} {{path/to/c}}` diff --git a/tldr/linux/nologin b/tldr/linux/nologin index b5244b49..f72753b1 100644 --- a/tldr/linux/nologin +++ b/tldr/linux/nologin @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Set a user's login shell to `nologin` to prevent the user from logging in: -`chsh -s {{user}} nologin` +`chsh {{[-s|--shell]}} {{user}} nologin` - Customize message for users with the login shell of `nologin`: diff --git a/tldr/linux/nsenter b/tldr/linux/nsenter index b17ccdb1..ffee3cd8 100644 --- a/tldr/linux/nsenter +++ b/tldr/linux/nsenter @@ -11,16 +11,16 @@ source: https://github.com/tldr-pages/tldr.git - Run a specific command using the same namespaces as an existing process: -`nsenter --target {{pid}} --all {{command}} {{command_arguments}}` +`nsenter {{[-t|--target]}} {{pid}} {{[-a|--all]}} {{command}} {{command_arguments}}` - Run a specific command in an existing process's mount|UTS|IPC|network|PID|user|cgroup|time namespace: -`nsenter --target {{pid}} --{{mount|uts|ipc|net|pid|user|cgroup}} {{command}} {{command_arguments}}` +`nsenter {{[-t|--target]}} {{pid}} --{{mount|uts|ipc|net|pid|user|cgroup}} {{command}} {{command_arguments}}` - Run a specific command in an existing process's UTS, time, and IPC namespaces: -`nsenter --target {{pid}} --uts --time --ipc -- {{command}} {{command_arguments}}` +`nsenter {{[-t|--target]}} {{pid}} {{[-u|--uts]}} {{[-T|--time]}} {{[-i|--ipc]}} -- {{command}} {{command_arguments}}` - Run a specific command in an existing process's namespace by referencing procfs: -`nsenter --pid=/proc/{{pid}}/pid/net -- {{command}} {{command_arguments}}` +`nsenter {{[-p|--pid=]}}/proc/{{pid}}/pid/net -- {{command}} {{command_arguments}}` diff --git a/tldr/linux/partx b/tldr/linux/partx index 0c124928..cdcb5a75 100644 --- a/tldr/linux/partx +++ b/tldr/linux/partx @@ -10,12 +10,12 @@ source: https://github.com/tldr-pages/tldr.git - List the partitions on a block device or disk image: -`sudo partx --list {{path/to/device_or_disk_image}}` +`sudo partx {{[-l|--list]}} {{path/to/device_or_disk_image}}` - Add all the partitions found in a given block device to the kernel: -`sudo partx --add --verbose {{path/to/device_or_disk_image}}` +`sudo partx {{[-a|--add]}} {{[-v|--verbose]}} {{path/to/device_or_disk_image}}` - Delete all the partitions found from the kernel (does not alter partitions on disk): -`sudo partx --delete {{path/to/device_or_disk_image}}` +`sudo partx {{[-d|--delete]}} {{path/to/device_or_disk_image}}` diff --git a/tldr/linux/prlimit b/tldr/linux/prlimit index 66add5a8..3c46b9f6 100644 --- a/tldr/linux/prlimit +++ b/tldr/linux/prlimit @@ -15,8 +15,8 @@ source: https://github.com/tldr-pages/tldr.git - Display limit values for all current resources of a specified process: -`prlimit --pid {{pid_number}}` +`prlimit {{[-p|--pid]}} {{pid_number}}` - Run a command with a custom number of open files limit: -`prlimit --nofile={{10}} {{command}}` +`prlimit {{[-n|--nofile=]}}{{10}} {{command}}` diff --git a/tldr/linux/raw b/tldr/linux/raw index d9c227bb..1ecca574 100644 --- a/tldr/linux/raw +++ b/tldr/linux/raw @@ -18,4 +18,4 @@ source: https://github.com/tldr-pages/tldr.git - Query all bound raw devices: -`raw -qa` +`raw {{[-qa|--query --all]}}` diff --git a/tldr/linux/renice b/tldr/linux/renice index de63aa0a..b0d7ef9b 100644 --- a/tldr/linux/renice +++ b/tldr/linux/renice @@ -10,14 +10,18 @@ source: https://github.com/tldr-pages/tldr.git > See also: `nice`. > More information: . -- Set the absolute priority of a running [p]rocess: +- Set the absolute priority of a running process: -`renice {{+3}} -p {{pid}}` +`renice --priority {{3}} {{[-p|--pid]}} {{pid}}` -- Increase/decrease the priority of all processes owned by a [u]ser: +- Increase the priority of a running process: -`renice --relative {{-4}} -u {{uid|user}}` +`sudo renice --relative {{-4}} {{[-p|--pid]}} {{pid}}` -- Set the priority of all processes that belong to a process [g]roup: +- Decrease the priority of all processes owned by a user: -`renice --absolute {{5}} -g {{process_group}}` +`renice --relative {{4}} {{[-u|--user]}} {{uid|user}}` + +- Set the priority of all processes that belong to a process group: + +`sudo renice {{-5}} {{[-g|--pgrp]}} {{process_group}}` diff --git a/tldr/linux/rev b/tldr/linux/rev new file mode 100644 index 00000000..49f82ccb Binary files /dev/null and b/tldr/linux/rev differ diff --git a/tldr/linux/rfkill b/tldr/linux/rfkill index b0982d5d..9a8c82b9 100644 --- a/tldr/linux/rfkill +++ b/tldr/linux/rfkill @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Filter by columns: -`rfkill -o {{ID,TYPE,DEVICE}}` +`rfkill {{[-o|--output]}} {{ID,TYPE,DEVICE}}` - Block devices by type (e.g. bluetooth, wlan): @@ -26,4 +26,4 @@ source: https://github.com/tldr-pages/tldr.git - Output in JSON format: -`rfkill -J` +`rfkill {{[-J|--json]}}` diff --git a/tldr/linux/rtcwake b/tldr/linux/rtcwake index 26dfef63..6440eb77 100644 --- a/tldr/linux/rtcwake +++ b/tldr/linux/rtcwake @@ -10,24 +10,24 @@ source: https://github.com/tldr-pages/tldr.git - Show whether an alarm is set or not: -`sudo rtcwake -m show -v` +`sudo rtcwake {{[-m|--mode]}} show {{[-v|--verbose]}}` - Suspend to RAM and wakeup after 10 seconds: -`sudo rtcwake -m mem -s {{10}}` +`sudo rtcwake {{[-m|--mode]}} mem {{[-s|--seconds]}} {{10}}` - Suspend to disk (higher power saving) and wakeup 15 minutes later: -`sudo rtcwake -m disk --date +{{15}}min` +`sudo rtcwake {{[-m|--mode]}} disk --date +{{15}}min` - Freeze the system (more efficient than suspend-to-RAM but version 3.9 or newer of the Linux kernel is required) and wakeup at a given date and time: -`sudo rtcwake -m freeze --date {{YYYYMMDDhhmm}}` +`sudo rtcwake {{[-m|--mode]}} freeze --date {{YYYYMMDDhhmm}}` - Disable a previously set alarm: -`sudo rtcwake -m disable` +`sudo rtcwake {{[-m|--mode]}} disable` - Perform a dry run to wakeup the computer at a given time. (Press `` to abort): -`sudo rtcwake -m on --date {{hh:ss}}` +`sudo rtcwake {{[-m|--mode]}} on --date {{hh:ss}}` diff --git a/tldr/linux/runuser b/tldr/linux/runuser index 84d5f5b0..6b3e61c9 100644 --- a/tldr/linux/runuser +++ b/tldr/linux/runuser @@ -10,20 +10,20 @@ source: https://github.com/tldr-pages/tldr.git - Run command as a different user: -`runuser {{user}} -c '{{command}}'` +`runuser {{user}} {{[-c|--command]}} '{{command}}'` - Run command as a different user and group: -`runuser {{user}} -g {{group}} -c '{{command}}'` +`runuser {{user}} {{[-g|--group]}} {{group}} {{[-c|--command]}} '{{command}}'` - Start a login shell as a specific user: -`runuser {{user}} -l` +`runuser {{user}} {{[-l|--login]}}` - Specify a shell for running instead of the default shell (also works for login): -`runuser {{user}} -s {{/bin/sh}}` +`runuser {{user}} {{[-s|--shell]}} {{/bin/sh}}` - Preserve the entire environment of root (only if `--login` is not specified): -`runuser {{user}} --preserve-environment -c '{{command}}'` +`runuser {{user}} {{[-p|--preserve-environment]}} {{[-c|--command]}} '{{command}}'` diff --git a/tldr/linux/script b/tldr/linux/script index 5c06033d..d06465dd 100644 --- a/tldr/linux/script +++ b/tldr/linux/script @@ -5,25 +5,37 @@ source: https://github.com/tldr-pages/tldr.git --- # script -> Record all terminal output to file. +> Record all terminal output to a typescript file. > More information: . - Record a new session to a file named `typescript` in the current directory: `script` +- Stop recording: + +`exit` + - Record a new session to a custom filepath: `script {{path/to/session.out}}` -- Record a new session, appending to an existing file: +- Append to an existing file: -`script -a {{path/to/session.out}}` +`script {{[-a|--append]}} {{logfile.log}}` - Record timing information (data is outputted to `stderr`): -`script -t 2> {{path/to/timing_file}}` +`script {{[-t|--timing]}} 2> {{path/to/timing_file}}` - Write out data as soon as it happens: -`script -f {{path/to/file}}` +`script {{[-f|--flush]}} {{path/to/file}}` + +- Execute quietly without start and done messages: + +`script {{[-q|--quiet]}} {{logfile.log}}` + +- Display help: + +`script {{[-h|--help]}}` diff --git a/tldr/linux/setsid b/tldr/linux/setsid index af9c9aef..154a2a42 100644 --- a/tldr/linux/setsid +++ b/tldr/linux/setsid @@ -19,12 +19,12 @@ source: https://github.com/tldr-pages/tldr.git - Run a program creating a new process: -`setsid --fork {{program}}` +`setsid {{[-f|--fork]}} {{program}}` - Return the exit code of a program as the exit code of setsid when the program exits: -`setsid --wait {{program}}` +`setsid {{[-w|--wait]}} {{program}}` - Run a program in a new session setting the current terminal as the controlling terminal: -`setsid --ctty {{program}}` +`setsid {{[-c|--ctty]}} {{program}}` diff --git a/tldr/linux/su b/tldr/linux/su new file mode 100644 index 00000000..bf7d6b4a --- /dev/null +++ b/tldr/linux/su @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# su + +> Switch shell to another user. +> More information: . + +- Switch to superuser (requires the root password): + +`su` + +- Switch to a given user (requires the user's password): + +`su {{username}}` + +- Switch to a given user and simulate a full login shell: + +`su - {{username}}` + +- Execute a command as another user: + +`su - {{username}} {{[-c|--command]}} "{{command}}"` diff --git a/tldr/linux/swapoff b/tldr/linux/swapoff index 7bc1c871..f052214b 100644 --- a/tldr/linux/swapoff +++ b/tldr/linux/swapoff @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Disable devices and files for swapping. > Note: `path/to/file` can either point to a regular file or a swap partition. -> More information: . +> More information: . - Disable a given swap area: @@ -15,7 +15,7 @@ source: https://github.com/tldr-pages/tldr.git - Disable all swap areas in `/proc/swaps`: -`swapoff --all` +`swapoff {{[-a|--all]}}` - Disable a swap partition by its label: diff --git a/tldr/linux/swapon b/tldr/linux/swapon index 78f09a4f..7b416e1c 100644 --- a/tldr/linux/swapon +++ b/tldr/linux/swapon @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Enable devices and files for swapping. > Note: `path/to/file` can either point to a regular file or a swap partition. -> More information: . +> More information: . - Show swap information: @@ -19,7 +19,7 @@ source: https://github.com/tldr-pages/tldr.git - Enable all swap areas specified in `/etc/fstab` except those with the `noauto` option: -`swapon --all` +`swapon {{[-a|--all]}}` - Enable a swap partition by its label: diff --git a/tldr/linux/switch_root b/tldr/linux/switch_root index 2cd36dfd..450a8380 100644 --- a/tldr/linux/switch_root +++ b/tldr/linux/switch_root @@ -16,4 +16,4 @@ source: https://github.com/tldr-pages/tldr.git - Display help: -`switch_root -h` +`switch_root {{[-h|--help]}}` diff --git a/tldr/linux/taskset b/tldr/linux/taskset index 783808cd..0140039c 100644 --- a/tldr/linux/taskset +++ b/tldr/linux/taskset @@ -10,20 +10,20 @@ source: https://github.com/tldr-pages/tldr.git - Get a running process' CPU affinity by PID: -`taskset --pid --cpu-list {{pid}}` +`taskset {{[-p|--pid]}} {{[-c|--cpu-list]}} {{pid}}` - Set a running process' CPU affinity by PID: -`taskset --pid --cpu-list {{cpu_id}} {{pid}}` +`taskset {{[-p|--pid]}} {{[-c|--cpu-list]}} {{cpu_id}} {{pid}}` - Start a new process with affinity for a single CPU: -`taskset --cpu-list {{cpu_id}} {{command}}` +`taskset {{[-c|--cpu-list]}} {{cpu_id}} {{command}}` - Start a new process with affinity for multiple non-sequential CPUs: -`taskset --cpu-list {{cpu_id_1}},{{cpu_id_2}},{{cpu_id_3}}` +`taskset {{[-c|--cpu-list]}} {{cpu_id_1}},{{cpu_id_2}},{{cpu_id_3}}` - Start a new process with affinity for CPUs 1 through 4: -`taskset --cpu-list {{cpu_id_1}}-{{cpu_id_4}}` +`taskset {{[-c|--cpu-list]}} {{cpu_id_1}}-{{cpu_id_4}}` diff --git a/tldr/linux/ul b/tldr/linux/ul index dd587f48..3546b48f 100644 --- a/tldr/linux/ul +++ b/tldr/linux/ul @@ -15,4 +15,4 @@ source: https://github.com/tldr-pages/tldr.git - Display the contents of the file with underlines made of dashes `-`: -`ul -i {{file.txt}}` +`ul {{[-i|--indicated]}} {{file.txt}}` diff --git a/tldr/linux/unshare b/tldr/linux/unshare index 05342053..a8468bbb 100644 --- a/tldr/linux/unshare +++ b/tldr/linux/unshare @@ -6,12 +6,12 @@ source: https://github.com/tldr-pages/tldr.git # unshare > Execute a command in new user-defined namespaces. -> More information: . +> More information: . - Execute a command without sharing access to connected networks: -`unshare --net {{command}} {{command_arguments}}` +`unshare {{[-n|--net]}} {{command}} {{command_arguments}}` - Execute a command as a child process without sharing mounts, processes, or networks: -`unshare --mount --pid --net --fork {{command}} {{command_arguments}}` +`unshare {{[-m|--mount]}} {{[-i|--pid]}} {{[-n|--net]}} {{[-f|--fork]}} {{command}} {{command_arguments}}` diff --git a/tldr/linux/utmpdump b/tldr/linux/utmpdump index 99990f1d..9a4f13bd 100644 --- a/tldr/linux/utmpdump +++ b/tldr/linux/utmpdump @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Load a previously dumped file into `/var/log/wtmp`: -`utmpdump -r {{dumpfile}} > {{/var/log/wtmp}}` +`utmpdump {{[-r|--reverse]}} {{dumpfile}} > {{/var/log/wtmp}}` diff --git a/tldr/linux/uuidgen b/tldr/linux/uuidgen index 0bda4f25..907d2b70 100644 --- a/tldr/linux/uuidgen +++ b/tldr/linux/uuidgen @@ -11,12 +11,12 @@ source: https://github.com/tldr-pages/tldr.git - Create a random UUIDv4: -`uuidgen --random` +`uuidgen {{[-r|--random]}}` - Create a UUIDv1 based on the current time: -`uuidgen --time` +`uuidgen {{[-t|--time]}}` - Create a UUIDv5 of the name with a specified namespace prefix: -`uuidgen --sha1 --namespace {{@dns|@url|@oid|@x500}} --name {{object_name}}` +`uuidgen {{[-s|--sha1]}} {{[-n|--namespace]}} {{@dns|@url|@oid|@x500}} {{[-N|--name]}} {{object_name}}` diff --git a/tldr/linux/uuidparse b/tldr/linux/uuidparse index 3c5b41eb..efac997d 100644 --- a/tldr/linux/uuidparse +++ b/tldr/linux/uuidparse @@ -19,20 +19,20 @@ source: https://github.com/tldr-pages/tldr.git - Use the JSON output format: -`uuidparse --json {{uuid1 uuid2 ...}}` +`uuidparse {{[-J|--json]}} {{uuid1 uuid2 ...}}` - Do not print a header line: -`uuidparse --noheadings {{uuid1 uuid2 ...}}` +`uuidparse {{[-n|--noheadings]}} {{uuid1 uuid2 ...}}` - Use the raw output format: -`uuidparse --raw {{uuid1 uuid2 ...}}` +`uuidparse {{[-r|--raw]}} {{uuid1 uuid2 ...}}` - Specify which of the four output columns to print: -`uuidparse --output {{UUID,VARIANT,TYPE,TIME}}` +`uuidparse {{[-o|--output]}} {{UUID,VARIANT,TYPE,TIME}}` - Display help: -`uuidparse -h` +`uuidparse {{[-h|--help]}}` diff --git a/tldr/linux/vigr b/tldr/linux/vigr index 0dc60254..015d6aea 100644 --- a/tldr/linux/vigr +++ b/tldr/linux/vigr @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Display version: -`vigr --version` +`vigr {{[-V|--version]}}` diff --git a/tldr/linux/vipw b/tldr/linux/vipw index 9ed4d8d2..0e248161 100644 --- a/tldr/linux/vipw +++ b/tldr/linux/vipw @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Display version: -`vipw --version` +`vipw {{[-V|--version]}}` diff --git a/tldr/linux/waitpid b/tldr/linux/waitpid index 3011d07f..31a7892b 100644 --- a/tldr/linux/waitpid +++ b/tldr/linux/waitpid @@ -15,16 +15,16 @@ source: https://github.com/tldr-pages/tldr.git - Sleep for at most `n` seconds: -`waitpid --timeout {{n}} {{pid1 pid2 ...}}` +`waitpid {{[-t|--timeout]}} {{n}} {{pid1 pid2 ...}}` - Do not error if specified PIDs have already exited: -`waitpid --exited {{pid1 pid2 ...}}` +`waitpid {{[-e|--exited]}} {{pid1 pid2 ...}}` - Sleep until `n` of the specified processes have exited: -`waitpid --count {{n}} {{pid1 pid2 ...}}` +`waitpid {{[-c|--count]}} {{n}} {{pid1 pid2 ...}}` - Display help: -`waitpid -h` +`waitpid {{[-h|--help]}}` diff --git a/tldr/linux/wdctl b/tldr/linux/wdctl index f0d44801..e6acc191 100644 --- a/tldr/linux/wdctl +++ b/tldr/linux/wdctl @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - Display the watchdog status in a single line in key-value pairs: -`wdctl --oneline` +`wdctl {{[-O|--oneline]}}` - Display only specific watchdog flags (list is driver specific): -`wdctl --flags {{flag_list}}` +`wdctl {{[-f|--flags]}} {{flag_list}}` diff --git a/tldr/linux/whereis b/tldr/linux/whereis new file mode 100644 index 00000000..7436890a --- /dev/null +++ b/tldr/linux/whereis @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# whereis + +> Locate the binary, source, and manual page files for a command. +> More information: . + +- Locate binary, source and man pages for SSH: + +`whereis {{ssh}}` + +- Locate [b]inary and [m]an pages for ls: + +`whereis -bm {{ls}}` + +- Locate [s]ource of gcc and [m]an pages for Git: + +`whereis -s {{gcc}} -m {{git}}` + +- Locate [b]inaries for gcc in `/usr/bin/` only: + +`whereis -b -B {{/usr/bin/}} -f {{gcc}}` + +- Locate [u]nusual binaries (those that have more or less than one binary on the system): + +`whereis -u *` + +- Locate binaries that have [u]nusual [m]anual entries (binaries that have more or less than one manual installed): + +`whereis -u -m *` diff --git a/tldr/linux/wipefs b/tldr/linux/wipefs index 666c32cd..32d8c794 100644 --- a/tldr/linux/wipefs +++ b/tldr/linux/wipefs @@ -14,16 +14,16 @@ source: https://github.com/tldr-pages/tldr.git - Wipe all available signature types for a specific device with no recursion into partitions: -`sudo wipefs --all {{/dev/sdX}}` +`sudo wipefs {{[-a|--all]}} {{/dev/sdX}}` - Wipe all available signature types for the device and partitions using a glob pattern: -`sudo wipefs --all {{/dev/sdX}}*` +`sudo wipefs {{[-a|--all]}} {{/dev/sdX}}*` - Perform dry run: -`sudo wipefs --all --no-act {{/dev/sdX}}` +`sudo wipefs {{[-a|--all]}} {{[-n|--no-act]}} {{/dev/sdX}}` - Force wipe, even if the filesystem is mounted: -`sudo wipefs --all --force {{/dev/sdX}}` +`sudo wipefs {{[-a|--all]}} {{[-f|--force]}} {{/dev/sdX}}` diff --git a/tldr/linux/write b/tldr/linux/write new file mode 100644 index 00000000..b66facb7 --- /dev/null +++ b/tldr/linux/write @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# write + +> Write a message on the terminal of a specified logged in user (`` to stop writing messages). +> Use the `who` command to find out all terminal_ids of all active users active on the system. See also `mesg`. +> More information: . + +- Send a message to a given user on a given terminal ID: + +`write {{username}} {{terminal_id}}` + +- Send message to "testuser" on terminal `/dev/tty/5`: + +`write {{testuser}} {{tty/5}}` + +- Send message to "johndoe" on pseudo terminal `/dev/pts/5`: + +`write {{johndoe}} {{pts/5}}` diff --git a/tldr/linux/zramctl b/tldr/linux/zramctl index 09a4be4b..9d37ba08 100644 --- a/tldr/linux/zramctl +++ b/tldr/linux/zramctl @@ -11,7 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - Check if zram is enabled: -`lsmod | grep -i zram` +`lsmod | grep {{[-i|--ignore-case]}} zram` - Enable zram with a dynamic number of devices (use `zramctl` to configure devices further): @@ -23,7 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - Find and initialize the next free zram device to a 2 GB virtual drive using LZ4 compression: -`sudo zramctl --find --size {{2GB}} --algorithm {{lz4}}` +`sudo zramctl {{[-f|--find]}} {{[-s|--size]}} {{2GB}} {{[-a|--algorithm]}} {{lz4}}` - List currently initialized devices: diff --git a/tldr/llvd b/tldr/llvd index 38d3acc3..a29568b9 100644 --- a/tldr/llvd +++ b/tldr/llvd @@ -8,18 +8,18 @@ source: https://github.com/tldr-pages/tldr.git > Linkedin Learning Video Downloader. > More information: . -- Download a [c]ourse using cookie-based authentication: +- Download a course using cookie-based authentication: -`llvd -c {{course-slug}} --cookies` +`llvd {{[-c|--course]}} {{course-slug}} --cookies` -- Download a course at a specific [r]esolution: +- Download a course at a specific resolution: -`llvd -c {{course-slug}} -r 720` +`llvd {{[-c|--course]}} {{course-slug}} {{[-r|--resolution]}} 720` -- Download a course with [ca]ptions (subtitles): +- Download a course with captions (subtitles): -`llvd -c {{course-slug}} --caption` +`llvd {{[-c|--course]}} {{course-slug}} {{[-ca|--caption]}}` -- Download a course [p]ath with [t]hrottling between 10 to 30 seconds: +- Download a course path with throttling between 10 to 30 seconds: -`llvd -p {{path-slug}} -t {{10,30}} --cookies` +`llvd {{[-p|--path]}} {{path-slug}} {{[-t|--throttle]}} {{10,30}} --cookies` diff --git a/tldr/logger b/tldr/logger index c37ec935..fa4db05a 100644 --- a/tldr/logger +++ b/tldr/logger @@ -5,25 +5,9 @@ source: https://github.com/tldr-pages/tldr.git --- # logger -> Add messages to syslog (/var/log/syslog). -> More information: . +> Add messages to syslog. +> More information: . - Log a message to syslog: `logger {{message}}` - -- Take input from `stdin` and log to syslog: - -`echo {{log_entry}} | logger` - -- Send the output to a remote syslog server running at a given port. Default port is 514: - -`echo {{log_entry}} | logger --server {{hostname}} --port {{port}}` - -- Use a specific tag for every line logged. Default is the name of logged in user: - -`echo {{log_entry}} | logger --tag {{tag}}` - -- Log messages with a given priority. Default is `user.notice`. See `man logger` for all priority options: - -`echo {{log_entry}} | logger --priority {{user.warning}}` diff --git a/tldr/lsar b/tldr/lsar index ccf2de34..cf589a39 100644 --- a/tldr/lsar +++ b/tldr/lsar @@ -17,7 +17,7 @@ source: https://github.com/tldr-pages/tldr.git `lsar {{path/to/archive}} {{[-p|--password]}} {{password}}` -- Print al[L] available information about each file in the archive (it's very long): +- Print all available information about each file in the archive (it's very long): `lsar {{[-L|--verylong]}} {{path/to/archive}}` diff --git a/tldr/mamba b/tldr/mamba index c4b2b92d..229c966b 100644 --- a/tldr/mamba +++ b/tldr/mamba @@ -11,11 +11,11 @@ source: https://github.com/tldr-pages/tldr.git - Create a new environment, installing the specified packages into it: -`mamba create --name {{environment_name}} {{python=3.10 matplotlib}}` +`mamba create {{[-n|--name]}} {{environment_name}} {{python=3.10 matplotlib}}` -- Install packages into the current environment, specifying the package [c]hannel: +- Install packages into the current environment, specifying the package channel: -`mamba install -c {{conda-forge}} {{python=3.6 numpy}}` +`mamba install {{[-c|--channel]}} {{conda-forge}} {{python=3.6 numpy}}` - Update all packages in the current environment: diff --git a/tldr/masscan b/tldr/masscan index 34e076f4..c4f65ffe 100644 --- a/tldr/masscan +++ b/tldr/masscan @@ -7,11 +7,11 @@ source: https://github.com/tldr-pages/tldr.git > Network scanner for scanning as fast as possible. > Best run with elevated privileges. Nmap compatibility run `masscan --nmap` to find out more. -> More information: . +> More information: . -- Scan an IP or network subnet for [p]ort 80: +- Scan an IP or network subnet for port 80: -`masscan {{ip_address|network_prefix}} --ports {{80}}` +`masscan {{ip_address|network_prefix}} {{[-p|--ports]}} {{80}}` - Scan a class B subnet for the top 100 ports at 100,000 packets per second: @@ -23,15 +23,15 @@ source: https://github.com/tldr-pages/tldr.git - Scan the Internet for web servers running on port 80 and 443: -`masscan {{0.0.0.0/0}} --ports {{80,443}} --rate {{10000000}}` +`masscan {{0.0.0.0/0}} {{[-p|--ports]}} {{80,443}} --rate {{10000000}}` - Scan the Internet for DNS servers running on UDP port 53: -`masscan {{0.0.0.0/0}} --ports {{U:53}} --rate {{10000000}}` +`masscan {{0.0.0.0/0}} {{[-p|--ports]}} {{U:53}} --rate {{10000000}}` - Scan the Internet for a specific port range and export to a file: -`masscan {{0.0.0.0/0}} --ports {{0-65535}} --output-format {{binary|grepable|json|list|xml}} --output-filename {{path/to/file}}` +`masscan {{0.0.0.0/0}} {{[-p|--ports]}} {{0-65535}} --output-format {{binary|grepable|json|list|xml}} --output-filename {{path/to/file}}` - Read binary scan results from a file and output to `stdout`: diff --git a/tldr/msfconsole b/tldr/msfconsole index 7bf0a048..9507295c 100644 --- a/tldr/msfconsole +++ b/tldr/msfconsole @@ -12,18 +12,22 @@ source: https://github.com/tldr-pages/tldr.git `msfconsole` -- Launch the console [q]uietly without any banner: +- Launch the console quietly without any banner: -`msfconsole --quiet` +`msfconsole {{[-q|--quiet]}}` -- Do [n]ot enable database support: +- Do not enable database support: -`msfconsole --no-database` +`msfconsole {{[-n|--no-database]}}` -- E[x]ecute console commands (Note: use `;` for passing multiple commands): +- Execute console commands (Note: use `;` for passing multiple commands): -`msfconsole --execute-command "{{use auxiliary/server/capture/ftp; set SRVHOST 0.0.0.0; set SRVPORT 21; run}}"` +`msfconsole {{[-x|--execute-command]}} "{{use auxiliary/server/capture/ftp; set SRVHOST 0.0.0.0; set SRVPORT 21; run}}"` -- Display [v]ersion: +- Display help: -`msfconsole --version` +`msfconsole {{[-h|--help]}}` + +- Display version: + +`msfconsole {{[-v|--version]}}` diff --git a/tldr/mypy b/tldr/mypy index 3ea7e8e0..9db4c3ea 100644 --- a/tldr/mypy +++ b/tldr/mypy @@ -12,17 +12,17 @@ source: https://github.com/tldr-pages/tldr.git `mypy {{path/to/file.py}}` -- Type check a specific [m]odule: +- Type check a specific module: -`mypy -m {{module_name}}` +`mypy {{[-m|--module]}} {{module_name}}` -- Type check a specific [p]ackage: +- Type check a specific package: -`mypy -p {{package_name}}` +`mypy {{[-p|--package]}} {{package_name}}` - Type check a string of code: -`mypy -c "{{code}}"` +`mypy {{[-c|--command]}} "{{code}}"` - Ignore missing imports: @@ -30,12 +30,12 @@ source: https://github.com/tldr-pages/tldr.git - Show detailed error messages: -`mypy --show-traceback {{path/to/file_or_directory}}` +`mypy {{[--tb|--show-traceback]}} {{path/to/file_or_directory}}` - Specify a custom configuration file: `mypy --config-file {{path/to/config_file}}` -- Display [h]elp: +- Display help: -`mypy -h` +`mypy {{[-h|--help]}}` diff --git a/tldr/nextclade b/tldr/nextclade index 0903b7d4..6627a0cc 100644 --- a/tldr/nextclade +++ b/tldr/nextclade @@ -6,15 +6,15 @@ source: https://github.com/tldr-pages/tldr.git # nextclade > Bioinformatics tool for virus genome alignment, clade assignment and qc checks. -> More information: . +> More information: . -- Align sequences to user provided [r]eference, [o]utputting the alignment to a file: +- Align sequences to user provided reference, outputting the alignment to a file: -`nextclade run {{path/to/sequences.fa}} -r {{path/to/reference.fa}} -o {{path/to/alignment.fa}}` +`nextclade run {{path/to/sequences.fa}} {{[-r|--input-ref]}} {{path/to/reference.fa}} {{[-o|--output-fasta]}} {{path/to/alignment.fa}}` -- Create a [t]SV report, auto-downloading the latest [d]ataset: +- Create a TSV report, auto-downloading the latest dataset: -`nextclade run {{path/to/fasta}} -d {{dataset_name}} -t {{path/to/report.tsv}}` +`nextclade run {{path/to/fasta}} {{[-d|--dataset-name]}} {{dataset_name}} {{[-t|--output-tsv]}} {{path/to/report.tsv}}` - List all available datasets: @@ -22,16 +22,16 @@ source: https://github.com/tldr-pages/tldr.git - Download the latest SARS-CoV-2 dataset: -`nextclade dataset get --name sars-cov-2 --output-dir {{path/to/directory}}` +`nextclade dataset get {{[-n|--name]}} sars-cov-2 {{[-o|--output-dir]}} {{path/to/directory}}` -- Use a downloaded [D]ataset, producing all [O]utputs: +- Use a downloaded dataset, producing all outputs: -`nextclade run -D {{path/to/dataset_dir}} -O {{path/to/output_dir}} {{path/to/sequences.fasta}}` +`nextclade run {{[-D|--input-dataset]}} {{path/to/dataset_dir}} {{[-O|--output-all]}} {{path/to/output_dir}} {{path/to/sequences.fasta}}` - Run on multiple files: -`nextclade run -d {{dataset_name}} -t {{path/to/output_tsv}} -- {{path/to/input_fasta_1 path/to/input_fasta_2 ...}}` +`nextclade run {{[-d|--dataset-name]}} {{dataset_name}} {{[-t|--output-tsv]}} {{path/to/output_tsv}} -- {{path/to/input_fasta_1 path/to/input_fasta_2 ...}}` - Try reverse complement if sequence does not align: -`nextclade run --retry-reverse-complement -d {{dataset_name}} -t {{path/to/output_tsv}} {{path/to/input_fasta}}` +`nextclade run --retry-reverse-complement {{[-d|--dataset-name]}} {{dataset_name}} {{[-t|--output-tsv]}} {{path/to/output_tsv}} {{path/to/input_fasta}}` diff --git a/tldr/nnn b/tldr/nnn index 8703eb08..f616b6cb 100644 --- a/tldr/nnn +++ b/tldr/nnn @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # nnn > Interactive terminal file manager and disk usage analyzer. -> More information: . +> More information: . - Open the current directory (or specify one as the first argument): diff --git a/tldr/nvcc b/tldr/nvcc index 625a49c8..69c46214 100644 --- a/tldr/nvcc +++ b/tldr/nvcc @@ -10,16 +10,16 @@ source: https://github.com/tldr-pages/tldr.git - Compile a CUDA program: -`nvcc {{path/to/source.cu}} -o {{path/to/executable}}` +`nvcc {{path/to/source.cu}} {{[-o|--output-file]}} {{path/to/executable}}` -- Generate debu[g] information: +- Generate debug information: -`nvcc {{path/to/source.cu}} -o {{path/to/executable}} --debug --device-debug` +`nvcc {{path/to/source.cu}} {{[-o|--output-file]}} {{path/to/executable}} {{[-g|--debug]}} {{[-G|--device-debug]}}` - Include libraries from a different path: -`nvcc {{path/to/source.cu}} -o {{path/to/executable}} -I{{path/to/includes}} -L{{path/to/library}} -l{{library_name}}` +`nvcc {{path/to/source.cu}} {{[-o|--output-file]}} {{path/to/executable}} {{[-I|--include-path]}} {{path/to/includes}} {{[-L|--library-path]}} {{path/to/library}} {{[-l|--library]}} {{library_name}}` - Specify the compute capability for a specific GPU architecture: -`nvcc {{path/to/source.cu}} -o {{path/to/executable}} --generate-code arch={{arch_name}},code={{gpu_code_name}}` +`nvcc {{path/to/source.cu}} {{[-o|--output-file]}} {{path/to/executable}} {{[-gencode|--generate-code]}} arch={{arch_name}},code={{gpu_code_name}}` diff --git a/tldr/ollama b/tldr/ollama index 36675028..e66ea458 100644 --- a/tldr/ollama +++ b/tldr/ollama @@ -37,6 +37,6 @@ source: https://github.com/tldr-pages/tldr.git `ollama rm {{model}}` -- Create a model from a `Modelfile` ([f]): +- Create a model from a `Modelfile`: -`ollama create {{new_model_name}} -f {{path/to/Modelfile}}` +`ollama create {{new_model_name}} {{[-f|--file]}} {{path/to/Modelfile}}` diff --git a/tldr/osmium b/tldr/osmium index 214f7be3..161ab515 100644 --- a/tldr/osmium +++ b/tldr/osmium @@ -18,24 +18,24 @@ source: https://github.com/tldr-pages/tldr.git - Convert file format from PBF into XML: -`osmium cat {{path/to/input.osm.pbf}} -o {{path/to/output.osm}}` +`osmium cat {{path/to/input.osm.pbf}} {{[-o|--output]}} {{path/to/output.osm}}` - Extract a geographic region by the given [b]ounding box: -`osmium extract -b {{min_longitude}},{{min_latitude}},{{max_longitude}},{{max_latitude}} {{path/to/input.pbf}} -o {{path/to/output.pbf}}` +`osmium extract {{[-b|--bbox]}} {{min_longitude}},{{min_latitude}},{{max_longitude}},{{max_latitude}} {{path/to/input.pbf}} {{[-o|--output]}} {{path/to/output.pbf}}` - Extract a geographic region by a GeoJSON file: -`osmium extract -p {{path/to/polygon.geojson}} {{path/to/input.pbf}} -o {{path/to/output.pbf}}` +`osmium extract {{[-p|--polygon]}} {{path/to/polygon.geojson}} {{path/to/input.pbf}} {{[-o|--output]}} {{path/to/output.pbf}}` - Filter all objects tagged as "restaurant": -`osmium tags-filter {{path/to/input.pbf}} amenity=restaurant -o {{path/to/output.pbf}}` +`osmium tags-filter {{path/to/input.pbf}} amenity=restaurant {{[-o|--output]}} {{path/to/output.pbf}}` - Filter for "way" objects tagged as "highway": -`osmium tags-filter {{path/to/input.pbf}} w/highway -o {{path/to/output.pbf}}` +`osmium tags-filter {{path/to/input.pbf}} w/highway {{[-o|--output]}} {{path/to/output.pbf}}` - Filter "way" and "relation" objects tagged as "building": -`osmium tags-filter {{path/to/input.pbf}} wr/building -o {{path/to/output.pbf}}` +`osmium tags-filter {{path/to/input.pbf}} wr/building {{[-o|--output]}} {{path/to/output.pbf}}` diff --git a/tldr/patator b/tldr/patator new file mode 100644 index 00000000..0aba629a --- /dev/null +++ b/tldr/patator @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# patator + +> A multi-purpose brute-forcer, with a modular design and a flexible usage. +> More information: . + +- Brute force ssh login with rate limit and timeout options (successful login will show login banner or something similar): + +`patator ssh_login host={{ip_or_host}} user=FILE0 0={{path/to/users.txt}} password=FILE1 1={{path/to/passwords.txt}} --rate_limit={{seconds}} --timeout={{seconds}}` + +- Brute force encrypted zip file: + +`patator unzip_pass zipfile={{path/to/file.zip}} password=FILE0 0={{path/to/passwords.txt}} -x ignore:code!=0` + +- List all available modules: + +`patator --help` + +- Show help for a particular module: + +`patator {{module_name}} --help` diff --git a/tldr/pbzip2 b/tldr/pbzip2 index bed6e43e..15116f57 100644 --- a/tldr/pbzip2 +++ b/tldr/pbzip2 @@ -17,10 +17,10 @@ source: https://github.com/tldr-pages/tldr.git `pbzip2 -p{{4}} {{path/to/file}}` -- [d]ecompress a file: +- Decompress a file: -`pbzip2 --decompress {{path/to/compressed_file.bz2}}` +`pbzip2 {{[-d|--decompress]}} {{path/to/compressed_file.bz2}}` - Display help: -`pbzip2 -h` +`pbzip2 {{[-h|--help]}}` diff --git a/tldr/pcdovtoppm b/tldr/pcdovtoppm index 6c25b95c..7049eca3 100644 --- a/tldr/pcdovtoppm +++ b/tldr/pcdovtoppm @@ -12,14 +12,14 @@ source: https://github.com/tldr-pages/tldr.git `pcdovtoppm {{path/to/file.pcd}} > {{path/to/output.ppm}}` -- Specify the [m]aximum width of the output image and the maximum [s]ize of each of the images contained in the output: +- Specify the maximum width of the output image and the maximum size of each of the images contained in the output: -`pcdovtoppm -m {{width}} -s {{size}} {{path/to/file.pcd}} > {{path/to/output.ppm}}` +`pcdovtoppm {{[-m|-maxwidth]}} {{width}} {{[-s|-size]}} {{size}} {{path/to/file.pcd}} > {{path/to/output.ppm}}` -- Specify the maximum number of images [a]cross and the maximum number of [c]olours: +- Specify the maximum number of images across and the maximum number of colours: -`pcdovtoppm -a {{n_images}} -c {{n_colours}} {{path/to/file.pcd}} > {{path/to/output.ppm}}` +`pcdovtoppm {{[-a|-across]}} {{n_images}} {{[-c|-colors]}} {{n_colours}} {{path/to/file.pcd}} > {{path/to/output.ppm}}` -- Use the specified [f]ont for annotations and paint the background [w]hite: +- Use the specified font for annotations and paint the background white: -`pcdovtoppm -f {{font}} -w {{path/to/file.pcd}} > {{path/to/output.ppm}}` +`pcdovtoppm {{[-f|-font]}} {{font}} {{[-w|-white]}} {{path/to/file.pcd}} > {{path/to/output.ppm}}` diff --git a/tldr/pnmtofiasco b/tldr/pnmtofiasco index 03c7dca4..e58f879d 100644 --- a/tldr/pnmtofiasco +++ b/tldr/pnmtofiasco @@ -12,14 +12,14 @@ source: https://github.com/tldr-pages/tldr.git `pnmtofiasco {{path/to/file.pnm}} > {{path/to/file.fiasco}}` -- Specify the [i]nput files through a pattern: +- Specify the input files through a pattern: -`pnmtofiasco --image-name "{{img[01-09+1].pnm}}" > {{path/to/file.fiasco}}` +`pnmtofiasco {{[-i|--image-name]}} "{{img[01-09+1].pnm}}" > {{path/to/file.fiasco}}` - Specify the compression quality: -`pnmtofiasco --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: -`pnmtofiasco --config {{path/to/fiascorc}} {{path/to/file.pnm}} > {{path/to/file.fiasco}}` +`pnmtofiasco {{[-f|--config]}} {{path/to/fiascorc}} {{path/to/file.pnm}} > {{path/to/file.fiasco}}` diff --git a/tldr/pnpm b/tldr/pnpm index 3d3076d8..9f9086b6 100644 --- a/tldr/pnpm +++ b/tldr/pnpm @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Fast, disk space efficient package manager for Node.js. > Manage Node.js projects and their module dependencies. -> More information: . +> More information: . - Create a `package.json` file: @@ -21,13 +21,13 @@ source: https://github.com/tldr-pages/tldr.git `pnpm add {{module_name}}@{{version}}` -- Download a package and add it to the list of [D]ev dependencies in `package.json`: +- Download a package and add it to the list of dev dependencies in `package.json`: -`pnpm add -D {{module_name}}` +`pnpm add {{[-D|--save-dev]}} {{module_name}}` -- Download a package and install it [g]lobally: +- Download a package and install it globally: -`pnpm add -g {{module_name}}` +`pnpm add {{[-g|--global]}} {{module_name}}` - Uninstall a package and remove it from the list of dependencies in `package.json`: @@ -37,6 +37,6 @@ source: https://github.com/tldr-pages/tldr.git `pnpm list` -- List top-level [g]lobally installed modules: +- List top-level globally installed modules: -`pnpm list -g --depth={{0}}` +`pnpm list {{[-g|--global]}} --depth {{0}}` diff --git a/tldr/pnpm-audit b/tldr/pnpm-audit index 9df687be..659f6491 100644 --- a/tldr/pnpm-audit +++ b/tldr/pnpm-audit @@ -21,13 +21,13 @@ source: https://github.com/tldr-pages/tldr.git `pnpm audit --json > {{path/to/audit-report.json}}` -- Audit only [D]ev dependencies: +- Audit only dev dependencies: -`pnpm audit --dev` +`pnpm audit {{[-D|--dev]}}` -- Audit only [P]roduction dependencies: +- Audit only production dependencies: -`pnpm audit --prod` +`pnpm audit {{[-P|--prod]}}` - Exclude optional dependencies from the audit: diff --git a/tldr/pnpm-outdated b/tldr/pnpm-outdated index 5a07a674..30493ee7 100644 --- a/tldr/pnpm-outdated +++ b/tldr/pnpm-outdated @@ -15,15 +15,15 @@ source: https://github.com/tldr-pages/tldr.git - Check for outdated dependencies found in every workspace package: -`pnpm outdated -r` +`pnpm outdated {{[-r|--recursive]}}` - Filter outdated packages using a package selector: `pnpm outdated --filter {{package_selector}}` -- List outdated packages [g]lobally: +- List outdated packages globally: -`pnpm outdated --global` +`pnpm outdated {{[-g|--global]}}` - Print details of outdated packages: @@ -37,6 +37,6 @@ source: https://github.com/tldr-pages/tldr.git `pnpm outdated --compatible` -- Check only outdated [D]ev dependencies: +- Check only outdated dev dependencies: -`pnpm outdated --dev` +`pnpm outdated {{[-D|--dev]}}` diff --git a/tldr/pwgen b/tldr/pwgen index 14ae80db..074a3311 100644 --- a/tldr/pwgen +++ b/tldr/pwgen @@ -6,16 +6,16 @@ source: https://github.com/tldr-pages/tldr.git # pwgen > Generate pronounceable passwords. -> More information: . +> More information: . -- Generate random password with s[y]mbols: +- Generate random password with symbols: -`pwgen -y {{length}}` +`pwgen {{[-y|--symbols]}} {{length}}` - Generate secure, hard-to-memorize passwords: -`pwgen -s {{length}}` +`pwgen {{[-s|--secure]}} {{length}}` - Generate password with at least one capital letter in them: -`pwgen -c {{length}}` +`pwgen {{[-c|--capitalize]}} {{length}}` diff --git a/tldr/qalc b/tldr/qalc index 3437113f..2175ffe4 100644 --- a/tldr/qalc +++ b/tldr/qalc @@ -9,17 +9,17 @@ source: https://github.com/tldr-pages/tldr.git > See also: `bc`. > More information: . -- Launch in [i]nteractive mode: +- Launch in interactive mode: -`qalc {{--interactive}}` +`qalc {{[-i|--interactive]}}` -- Launch in [t]erse mode (print the results only): +- Launch in terse mode (print the results only): -`qalc --terse` +`qalc {{[-t|--terse]}}` -- Update currency [e]xchange rates: +- Update currency exchange rates: -`qalc --exrates` +`qalc {{[-e|--exrates]}}` - Perform calculations non-interactively: @@ -29,6 +29,6 @@ source: https://github.com/tldr-pages/tldr.git `qalc --{{list-functions|list-prefixes|list-units|list-variables}}` -- Execute commands from a [f]ile: +- Execute commands from a file: -`qalc --file {{path/to/file}}` +`qalc {{[-f|--file]}} {{path/to/file}}` diff --git a/tldr/qmmp b/tldr/qmmp index 67b6ed43..e130397b 100644 --- a/tldr/qmmp +++ b/tldr/qmmp @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > An audio player with an interface similar to Winamp or XMMS. > See also: `clementine`, `ncmpcpp`, `cmus`. -> More information: . +> More information: . - Launch the GUI: @@ -15,7 +15,7 @@ source: https://github.com/tldr-pages/tldr.git - Start or stop the currently playing audio: -`qmmp --play-pause` +`qmmp {{[-t|--play-pause]}}` - Seek [f]or[w]ar[d]s or [b]ack[w]ar[d]s a specific amount of time in seconds: diff --git a/tldr/redshift b/tldr/redshift index f3505833..fb6dbe8f 100644 --- a/tldr/redshift +++ b/tldr/redshift @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # redshift > Adjust the color temperature of your screen according to your surroundings. -> More information: . +> More information: . - Turn on Redshift with a specific [t]emperature during day (e.g., 5700K) and at night (e.g., 3600K): diff --git a/tldr/renice b/tldr/renice index ba9f937b..dafd1ed1 100644 --- a/tldr/renice +++ b/tldr/renice @@ -8,20 +8,16 @@ source: https://github.com/tldr-pages/tldr.git > Alter the scheduling priority/niceness of running processes. > Niceness values range from -20 (most favorable to the process) to 19 (least favorable to the process). > See also: `nice`. -> More information: . +> More information: . -- Set the absolute priority of a running process: +- Increase/decrease the priority of a running [p]rocess: -`renice --priority {{3}} {{[-p|--pid]}} {{pid}}` +`renice -n {{3}} -p {{pid}}` -- Increase the priority of a running process: +- Increase/decrease the priority of all processes owned by a [u]ser: -`sudo renice --relative {{-4}} {{[-p|--pid]}} {{pid}}` +`renice -n {{-4}} -u {{uid|user}}` -- Decrease the priority of all processes owned by a user: +- Increase/decrease the priority of all processes that belong to a process [g]roup: -`renice --relative {{4}} {{[-u|--user]}} {{uid|user}}` - -- Set the priority of all processes that belong to a process group: - -`sudo renice {{-5}} {{[-g|--pgrp]}} {{process_group}}` +`renice -n {{5}} -g {{process_group}}` diff --git a/tldr/rmlint b/tldr/rmlint index 63b0c0c4..8c7c7f40 100644 --- a/tldr/rmlint +++ b/tldr/rmlint @@ -14,11 +14,11 @@ source: https://github.com/tldr-pages/tldr.git - Check for duplicates bigger than a specific size, preferably keeping files in tagged directories (after the double slash): -`rmlint -s {{1MB}} {{path/to/directory}} // {{path/to/original_directory}}` +`rmlint {{[-s|--size]}} {{1MB}} {{path/to/directory}} // {{path/to/original_directory}}` - Check for space wasters, keeping everything in the untagged directories: -`rmlint --keep-all-untagged {{path/to/directory}} // {{path/to/original_directory}}` +`rmlint {{[-k|--keep-all-untagged]}} {{path/to/directory}} // {{path/to/original_directory}}` - Delete duplicate files found by an execution of `rmlint`: @@ -26,16 +26,16 @@ source: https://github.com/tldr-pages/tldr.git - Find duplicate directory trees based on data, ignoring names: -`rmlint --merge-directories {{path/to/directory}}` +`rmlint {{[-D|--merge-directories]}} {{path/to/directory}}` - Mark files at lower path [d]epth as originals, on tie choose shorter [l]ength: -`rmlint --rank-by={{dl}} {{path/to/directory}}` +`rmlint {{[-S|--rank-by]}} {{dl}} {{path/to/directory}}` - Find files with identical filename and contents, and link rather than delete the duplicates: -`rmlint -c sh:link --match-basename {{path/to/directory}}` +`rmlint {{[-c|--config]}} sh:link {{[-b|--match-basename]}} {{path/to/directory}}` - Use `data` as master directory. Find only duplicates in backup that are also in `data`. Do not delete any files in `data`: -`rmlint {{path/to/backup}} // {{path/to/data}} --keep-all-tagged --must-match-tagged` +`rmlint {{path/to/backup}} // {{path/to/data}} {{[-k|--keep-all-tagged]}} {{[-m|--must-match-tagged]}}` diff --git a/tldr/rustscan b/tldr/rustscan index d29f55f4..d530134c 100644 --- a/tldr/rustscan +++ b/tldr/rustscan @@ -8,34 +8,34 @@ source: https://github.com/tldr-pages/tldr.git > Fast Port Scanner written in Rust with `nmap` built in. > More information: . -- Scan all ports of one or more comma-delimited [a]ddresses using the default values: +- Scan all ports of one or more comma-delimited addresses using the default values: -`rustscan --addresses {{ip_or_hostname}}` +`rustscan {{[-a|--addresses]}} {{ip_or_hostname}}` -- Scan the [t]op 1000 ports with service and version detection: +- Scan the top 1000 ports with service and version detection: -`rustscan --top --addresses {{address_or_addresses}}` +`rustscan --top {{[-a|--addresses]}} {{address_or_addresses}}` -- Scan a specific list of [p]orts: +- Scan a specific list of ports: -`rustscan --ports {{port1,port2,...,portN}} --addresses {{address_or_addresses}}` +`rustscan {{[-p|--ports]}} {{port1,port2,...,portN}} {{[-a|--addresses]}} {{address_or_addresses}}` - Scan a specific range of ports: -`rustscan --range {{start-end}} --addresses {{address_or_addresses}}` +`rustscan {{[-r|--range]}} {{start-end}} {{[-a|--addresses]}} {{address_or_addresses}}` - Add script arguments to `nmap`: -`rustscan --addresses {{address_or_addresses}} -- -A -sC` +`rustscan {{[-a|--addresses]}} {{address_or_addresses}} -- -A -sC` -- Scan with custom [b]atch size (default: 4500) and [t]imeout (default: 1500ms): +- Scan with custom batch size (default: 4500) and timeout (default: 1500ms): -`rustscan --batch-size {{batch_size}} --timeout {{timeout}} --addresses {{address_or_addresses}}` +`rustscan {{[-b|--batch-size]}} {{batch_size}} {{[-t|--timeout]}} {{timeout}} {{[-a|--addresses]}} {{address_or_addresses}}` - Scan with specific port order: -`rustscan --scan-order {{serial|random}} --addresses {{address_or_addresses}}` +`rustscan --scan-order {{serial|random}} {{[-a|--addresses]}} {{address_or_addresses}}` - Scan in greppable mode (only output of the ports, no `nmap`): -`rustscan --greppable --addresses {{address_or_addresses}}` +`rustscan {{[-g|--greppable]}} {{[-a|--addresses]}} {{address_or_addresses}}` diff --git a/tldr/searchsploit b/tldr/searchsploit index 7d45521e..f0f59e99 100644 --- a/tldr/searchsploit +++ b/tldr/searchsploit @@ -19,19 +19,19 @@ source: https://github.com/tldr-pages/tldr.git - Show the exploit-db link to the found resources: -`searchsploit --www {{search_terms}}` +`searchsploit {{[-w|--www]}} {{search_terms}}` -- Copy ([m]irror) the resource to the current directory (requires the number of the exploit): +- Copy the resource to the current directory (requires the number of the exploit): -`searchsploit --mirror {{exploit_number}}` +`searchsploit {{[-m|--mirror]}} {{exploit_number}}` -- E[x]amine the resource, using the pager defined in the `$PAGER` environment variable: +- Examine the resource, using the pager defined in the `$PAGER` environment variable: -`searchsploit --examine {{exploit_number}}` +`searchsploit {{[-x|--examine]}} {{exploit_number}}` -- [u]pdate the local Exploit Database: +- Update the local Exploit Database: -`searchsploit --update` +`searchsploit {{[-u|--update]}}` - Search for the [c]ommon [v]ulnerabilities and [e]xposures (CVE) value: diff --git a/tldr/subfinder b/tldr/subfinder index f6c160ad..1c95e455 100644 --- a/tldr/subfinder +++ b/tldr/subfinder @@ -9,22 +9,22 @@ source: https://github.com/tldr-pages/tldr.git > Designed as a passive framework to be useful for bug bounties and safe for penetration testing. > More information: . -- Find subdomains for a specific [d]omain: +- Find subdomains for a specific domain: -`subfinder -d {{example.com}}` +`subfinder {{[-d|-domain]}} {{example.com}}` - Show only the subdomains found: -`subfinder -silent -d {{example.com}}` +`subfinder -silent {{[-d|-domain]}} {{example.com}}` - Show only active subdomains: -`subfinder -nW -d {{example.com}}` +`subfinder {{[-nW|-active]}} {{[-d|-domain]}} {{example.com}}` - Use all sources for enumeration: -`subfinder -all -d {{example.com}}` +`subfinder -all {{[-d|-domain]}} {{example.com}}` - Use a given comma-separated list of [r]esolvers: -`subfinder -r {{8.8.8.8,1.1.1.1,...}} -d {{example.com}}` +`subfinder -r {{8.8.8.8,1.1.1.1,...}} {{[-d|-domain]}} {{example.com}}` diff --git a/tldr/tgpt b/tldr/tgpt index e8877e3a..1be9d96f 100644 --- a/tldr/tgpt +++ b/tldr/tgpt @@ -13,25 +13,25 @@ source: https://github.com/tldr-pages/tldr.git `tgpt "{{prompt}}"` -- Start [m]ulti-line interactive mode: +- Start multi-line interactive mode: -`tgpt --multiline` +`tgpt {{[-m|--multiline]}}` -- Generate [i]mages and save them to the current directory: +- Generate images and save them to the current directory: -`tgpt --image "{{prompt}}"` +`tgpt {{[-img|--image]}} "{{prompt}}"` -- Generate [c]ode with the default provider (GPT-3.5-turbo): +- Generate code with the default provider (GPT-3.5-turbo): -`tgpt --code "{{prompt}}"` +`tgpt {{[-c|--code]}} "{{prompt}}"` -- Chat with a specific provider [q]uietly (without animations): +- Chat with a specific provider quietly (without animations): -`tgpt --provider {{openai|opengpts|koboldai|phind|llama2|blackboxai}} --quiet --whole "{{prompt}}"` +`tgpt --provider {{openai|opengpts|koboldai|phind|llama2|blackboxai}} {{[-q|--quiet]}} {{[-w|--whole]}} "{{prompt}}"` -- Generate and execute [s]hell commands using a specific provider (with a confirmation prompt): +- Generate and execute shell commands using a specific provider (with a confirmation prompt): -`tgpt --provider {{llama2}} --shell "{{prompt}}"` +`tgpt --provider {{llama2}} {{[-s|--shell]}} "{{prompt}}"` - Prompt with an API key, model, max response length, temperature, and `top_p` (required when using `openai` provider): diff --git a/tldr/tidy b/tldr/tidy index 6d2d6625..e7ef58de 100644 --- a/tldr/tidy +++ b/tldr/tidy @@ -13,10 +13,10 @@ source: https://github.com/tldr-pages/tldr.git `tidy {{path/to/file.html}}` -- Enable [i]ndentation, [w]rapping lines in 100, saving to `output.html`: +- Enable indentation, wrapping lines in 100, saving to `output.html`: -`tidy --indent y --wrap 100 -output {{path/to/output.html}} {{path/to/file.html}}` +`tidy {{[-i|--indent]}} y {{[-w|--wrap]}} 100 {{[-o|-output]}} {{path/to/output.html}} {{path/to/file.html}}` - Modify an HTML file in-place using a configuration file: -`tidy -config {{path/to/configuration}} -modify {{path/to/file.html}}` +`tidy -config {{path/to/configuration}} {{[-m|-modify]}} {{path/to/file.html}}` diff --git a/tldr/troff b/tldr/troff index 9cc0e80c..90a5978c 100644 --- a/tldr/troff +++ b/tldr/troff @@ -13,14 +13,14 @@ source: https://github.com/tldr-pages/tldr.git `troff {{path/to/input.roff}} | grops > {{path/to/output.ps}}` -- Format output for a PostScript printer using the [me] macro package, saving the output to a file: +- Format output for a PostScript printer using the me macro package, saving the output to a file: `troff -{{me}} {{path/to/input.roff}} | grops > {{path/to/output.ps}}` -- Format output as [a]SCII text using the [man] macro package: +- Format output as ASCII text using the man macro package: `troff -T {{ascii}} -{{man}} {{path/to/input.roff}} | grotty` -- Format output as a [pdf] file, saving the output to a file: +- Format output as a pdf file, saving the output to a file: `troff -T {{pdf}} {{path/to/input.roff}} | gropdf > {{path/to/output.pdf}}` diff --git a/tldr/ts b/tldr/ts index 326a1c88..8e93e271 100644 --- a/tldr/ts +++ b/tldr/ts @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # ts > Add timestamps to every line from `stdin`. -> More information: . +> More information: . - Add a timestamp to the beginning of each line: diff --git a/tldr/twine b/tldr/twine index fe5ed17b..896e86fc 100644 --- a/tldr/twine +++ b/tldr/twine @@ -12,13 +12,13 @@ source: https://github.com/tldr-pages/tldr.git `twine upload dist/*` -- Upload to the Test PyPI [r]epository to verify things look right: +- Upload to the Test PyPI repository to verify things look right: -`twine upload -r testpypi dist/*` +`twine upload {{[-r|--repository]}} testpypi dist/*` -- Upload to PyPI with a specified [u]sername and [p]assword: +- Upload to PyPI with a specified username and password: -`twine upload -u {{username}} -p {{password}} dist/*` +`twine upload {{[-u|--username]}} {{username}} {{[-p|--password]}} {{password}} dist/*` - Upload to an alternative repository URL: diff --git a/tldr/wafw00f b/tldr/wafw00f index 6c366f78..fa150524 100644 --- a/tldr/wafw00f +++ b/tldr/wafw00f @@ -6,32 +6,32 @@ source: https://github.com/tldr-pages/tldr.git # wafw00f > Identify and fingerprint Web Application Firewall (WAF) products protecting a website. -> More information: . +> More information: . - Check if a website is using any WAF: `wafw00f {{https://www.example.com}}` -- Test for [a]ll detectable WAFs without stopping at the first match: +- Test for all detectable WAFs without stopping at the first match: -`wafw00f --findall {{https://www.example.com}}` +`wafw00f {{[-a|--findall]}} {{https://www.example.com}}` -- Pass requests through a [p]roxy (such as BurpSuite): +- Pass requests through a proxy (such as BurpSuite): -`wafw00f --proxy {{http://localhost:8080}} {{https://www.example.com}}` +`wafw00f {{[-p|--proxy]}} {{http://localhost:8080}} {{https://www.example.com}}` -- [t]est for a specific WAF product (run `wafw00f -l` to get list of all supported WAFs): +- Test for a specific WAF product (run `wafw00f -l` to get list of all supported WAFs): -`wafw00f --test {{Cloudflare|Cloudfront|Fastly|ZScaler|...}} {{https://www.example.com}}` +`wafw00f {{[-t|--test]}} {{Cloudflare|Cloudfront|Fastly|ZScaler|...}} {{https://www.example.com}}` -- Pass custom [H]eaders from a file: +- Pass custom headers from a file: -`wafw00f --headers {{path/to/headers.txt}} {{https://www.example.com}}` +`wafw00f {{[-H|--headers]}} {{path/to/headers.txt}} {{https://www.example.com}}` -- Read target [i]nputs from a file and show verbose output (multiple `v` for more verbosity): +- Read target inputs from a file and show verbose output (multiple `v` for more verbosity): -`wafw00f --input {{path/to/urls.txt}} -v{{v}}` +`wafw00f {{[-i|--input]}} {{path/to/urls.txt}} -{{vv}}` -- [l]ist all WAFs that can be detected: +- List all WAFs that can be detected: -`wafw00f --list` +`wafw00f {{[-l|--list]}}` diff --git a/tldr/whatwaf b/tldr/whatwaf index fee2e1a2..7482f783 100644 --- a/tldr/whatwaf +++ b/tldr/whatwaf @@ -8,25 +8,25 @@ source: https://github.com/tldr-pages/tldr.git > Detect and bypass web application firewalls and protection systems. > More information: . -- Detect protection on a single [u]RL, optionally use verbose output: +- Detect protection on a single URL, optionally use verbose output: -`whatwaf --url {{https://example.com}} --verbose` +`whatwaf {{[-u|--url]}} {{https://example.com}} --verbose` -- Detect protection on a [l]ist of URLs in parallel from a file (one URL per line): +- Detect protection on a list of URLs in parallel from a file (one URL per line): -`whatwaf --threads {{number}} --list {{path/to/file}}` +`whatwaf {{[-t|--threads]}} {{number}} {{[-l|--list]}} {{path/to/file}}` - Send requests through a proxy and use custom payload list from a file (one payload per line): -`whatwaf --proxy {{http://127.0.0.1:8080}} --pl {{path/to/file}} -u {{https://example.com}}` +`whatwaf --proxy {{http://127.0.0.1:8080}} --pl {{path/to/file}} {{[-u|--url]}} {{https://example.com}}` -- Send requests through Tor (Tor must be installed) using custom [p]ayloads (comma-separated): +- Send requests through Tor (Tor must be installed) using custom payloads (comma-separated): -`whatwaf --tor --payloads '{{payload1,payload2,...}}' -u {{https://example.com}}` +`whatwaf --tor {{[-p|--payloads]}} '{{payload1,payload2,...}}' {{[-u|--url]}} {{https://example.com}}` -- Use a random user-agent, set throttling and timeout, send a [P]OST request, and force HTTPS connection: +- Use a random user-agent, set throttling and timeout, send a POST request, and force HTTPS connection: -`whatwaf --ra --throttle {{seconds}} --timeout {{seconds}} --post --force-ssl -u {{http://example.com}}` +`whatwaf --ra --throttle {{seconds}} --timeout {{seconds}} {{[-P|--post]}} --force-ssl {{[-u|--url]}} {{http://example.com}}` - List all WAFs that can be detected: diff --git a/tldr/wiggle b/tldr/wiggle index 795f1f5f..d024ba8d 100644 --- a/tldr/wiggle +++ b/tldr/wiggle @@ -13,22 +13,22 @@ source: https://github.com/tldr-pages/tldr.git `wiggle {{path/to/my_patch.patch}}` -- Apply changes to the [o]utput file: +- Apply changes to the output file: -`wiggle {{path/to/my_patch.patch}} -o {{path/to/output_file.txt}}` +`wiggle {{path/to/my_patch.patch}} {{[-o|--output]}} {{path/to/output_file.txt}}` - Take any changes in `file.rej` that could not have been applied and merge them into a file: -`wiggle --replace {{path/to/file}} {{path/to/file.rej}}` +`wiggle {{[-r|--replace]}} {{path/to/file}} {{path/to/file.rej}}` -- E[x]tract one branch of a patch or merge file: +- Extract one branch of a patch or merge file: -`wiggle -x {{path/to/my_patch.patch}}` +`wiggle {{[-x|--extract]}} {{path/to/my_patch.patch}}` -- Apply a patch and save the compared words to the [o]utput file: +- Apply a patch and save the compared words to the output file: -`wiggle --words {{path/to/my_word_patch.patch}} -o {{path/to/word_patched_code.c}}` +`wiggle {{[-w|--words]}} {{path/to/my_word_patch.patch}} {{[-o|--output]}} {{path/to/word_patched_code.c}}` - Display help about the merge function: -`wiggle --merge --help` +`wiggle {{[-m|--merge]}} {{[-h|--help]}}` diff --git a/tldr/wikit b/tldr/wikit index d998b432..9461b99b 100644 --- a/tldr/wikit +++ b/tldr/wikit @@ -12,9 +12,9 @@ source: https://github.com/tldr-pages/tldr.git `wikit {{topic}}` -- Specify a [l]anguage (ISO 639-1 language code): +- Specify a language (ISO 639-1 language code): -`wikit {{topic}} --lang {{language_code}}` +`wikit {{topic}} {{[-l|--lang]}} {{language_code}}` - Open the full Wikipedia article in the default browser: diff --git a/tldr/write b/tldr/write index 3e68a43f..5a50b4fb 100644 --- a/tldr/write +++ b/tldr/write @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Write a message on the terminal of a specified logged in user (`` to stop writing messages). > Use the `who` command to find out all terminal_ids of all active users active on the system. See also `mesg`. -> More information: . +> More information: . - Send a message to a given user on a given terminal ID: diff --git a/tldr/xteddy b/tldr/xteddy index c8f7770f..2757b7c9 100644 --- a/tldr/xteddy +++ b/tldr/xteddy @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # xteddy > A cuddly teddy bear for your X Windows desktop. -> More information: . +> More information: . - Display a cuddly teddy bear on your X desktop: diff --git a/tldr/yq b/tldr/yq index 83fcb3da..cee127cb 100644 --- a/tldr/yq +++ b/tldr/yq @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Output a YAML file, in pretty-print format (v3): -`yq read {{path/to/file.yaml}} --colors` +`yq read {{path/to/file.yaml}} {{[-C|--colors]}}` - Output the first element in a YAML file that contains only an array (v4+): @@ -26,11 +26,11 @@ source: https://github.com/tldr-pages/tldr.git - Set (or overwrite) a key to a value in a file (v4+): -`yq eval '.{{key}} = "{{value}}"' --inplace {{path/to/file.yaml}}` +`yq eval '.{{key}} = "{{value}}"' {{[-i|--inplace]}} {{path/to/file.yaml}}` - Set (or overwrite) a key to a value in a file (v3): -`yq write --inplace {{path/to/file.yaml}} '{{key}}' '{{value}}'` +`yq write {{[-i|--inplace]}} {{path/to/file.yaml}} '{{key}}' '{{value}}'` - Merge two files and print to `stdout` (v4+): @@ -38,4 +38,4 @@ source: https://github.com/tldr-pages/tldr.git - Merge two files and print to `stdout` (v3): -`yq merge {{path/to/file1.yaml}} {{path/to/file2.yaml}} --colors` +`yq merge {{path/to/file1.yaml}} {{path/to/file2.yaml}} {{[-C|--colors]}}` diff --git a/tldr/zipcloak b/tldr/zipcloak index 006814b4..e5f69680 100644 --- a/tldr/zipcloak +++ b/tldr/zipcloak @@ -12,10 +12,10 @@ source: https://github.com/tldr-pages/tldr.git `zipcloak {{path/to/archive.zip}}` -- [d]ecrypt the contents of a Zip archive: +- Decrypt the contents of a Zip archive: -`zipcloak -d {{path/to/archive.zip}}` +`zipcloak {{[-d|--decrypt]}} {{path/to/archive.zip}}` -- [O]utput the encrypted contents into a new Zip archive: +- Output the encrypted contents into a new Zip archive: -`zipcloak {{path/to/archive.zip}} -O {{path/to/encrypted.zip}}` +`zipcloak {{path/to/archive.zip}} {{[-O|--output-file]}} {{path/to/encrypted.zip}}` diff --git a/tldr/zpaq b/tldr/zpaq index dce81a37..de863ea5 100644 --- a/tldr/zpaq +++ b/tldr/zpaq @@ -6,28 +6,28 @@ source: https://github.com/tldr-pages/tldr.git # zpaq > Incremental journaling backup utility and archiver. -> More information: . +> More information: . -- [a]dd a file or directory to a new or existing archive: +- Add a file or directory to a new or existing archive: -`zpaq a {{path/to/archive.zpaq}} {{path/to/file_or_directory}}` +`zpaq {{[a|add]}} {{path/to/archive.zpaq}} {{path/to/file_or_directory}}` - Create or add to an encrypted archive: -`zpaq a -k{{password}} {{path/to/archive.zpaq}} {{path/to/file_or_directory}}` +`zpaq {{[a|add]}} -k{{password}} {{path/to/archive.zpaq}} {{path/to/file_or_directory}}` -- E[x]tract the most recent versions of files: +- Extract the most recent versions of files: -`zpaq x {{path/to/archive.zpaq}}` +`zpaq {{[x|extract]}} {{path/to/archive.zpaq}}` -- [l]ist the archive contents: +- List the archive contents: -`zpaq l {{path/to/archive.zpaq}}` +`zpaq {{[l|list]}} {{path/to/archive.zpaq}}` - Set the level of compression (higher means more compression but slower): -`zpaq a {{path/to/archive.zpaq}} -m{{1|2|3|4|5}} {{path/to/file_or_directory}}` +`zpaq {{[a|add]}} {{path/to/archive.zpaq}} -m{{1|2|3|4|5}} {{path/to/file_or_directory}}` -- E[x]tract the specified files from the archive that are not newer than the specified date: +- Extract the specified files from the archive that are not newer than the specified date: -`zpaq x {{path/to/archive.zpaq}} {{path/in/archive/to/extract}} -to {{path/to/output}} -until {{YYYY-MM-DD}}` +`zpaq {{[x|extract]}} {{path/to/archive.zpaq}} {{path/in/archive/to/extract}} -to {{path/to/output}} -until {{YYYY-MM-DD}}` diff --git a/tldr/zsh b/tldr/zsh index a2972c2f..095a4d87 100644 --- a/tldr/zsh +++ b/tldr/zsh @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Z SHell, a Bash-compatible command-line interpreter. > See also: `bash`, `histexpand`. -> More information: . +> More information: . - Start an interactive shell session: