diff --git a/tldr/autojump b/tldr/autojump index 75d3c73b..72a596e1 100644 --- a/tldr/autojump +++ b/tldr/autojump @@ -6,11 +6,11 @@ source: https://github.com/tldr-pages/tldr.git # autojump > Quickly jump among the directories you visit the most. -> Aliases like j or jc are provided for even less typing. +> Aliases like `j` or `jc` are provided for even less typing. > See also: `bashmarks`. > More information: . -- Add the autojump aliases to your shell: +- Add the `autojump` aliases to your shell: `source /usr/share/autojump/autojump.{{bash|fish|zsh}}` @@ -26,10 +26,10 @@ source: https://github.com/tldr-pages/tldr.git `jo {{pattern}}` -- Remove non-existing directories from the autojump database: +- Remove non-existing directories from the `autojump` database: `j --purge` -- Show the entries in the autojump database: +- Show the entries in the `autojump` database: `j {{[-s|--stat]}}` diff --git a/tldr/awslogs b/tldr/awslogs index c384c1f3..467b82cd 100644 --- a/tldr/awslogs +++ b/tldr/awslogs @@ -18,11 +18,11 @@ source: https://github.com/tldr-pages/tldr.git - Get logs for any streams in the specified group between 1 and 2 hours ago: -`awslogs get {{/var/log/syslog}} --start='{{2h ago}}' --end='{{1h ago}}'` +`awslogs get {{/var/log/syslog}} {{[-s|--start]}} '{{2h ago}}' {{[-e|--end]}} '{{1h ago}}'` - Get logs that match a specific CloudWatch Logs Filter pattern: -`awslogs get {{/aws/lambda/my_lambda_group}} --filter-pattern='{{ERROR}}'` +`awslogs get {{/aws/lambda/my_lambda_group}} --filter-pattern '{{ERROR}}'` - Watch logs for any streams in the specified group: diff --git a/tldr/bandwhich b/tldr/bandwhich index 298d7310..16a4d756 100644 --- a/tldr/bandwhich +++ b/tldr/bandwhich @@ -6,24 +6,24 @@ source: https://github.com/tldr-pages/tldr.git # bandwhich > Display the current network utilization by process, connection or remote IP/hostname. -> More information: . +> More information: . - Show the remote addresses table only: -`bandwhich --addresses` +`bandwhich {{[-a|--addresses]}}` - Show DNS queries: -`bandwhich --show-dns` +`bandwhich {{[-s|--show-dns]}}` - Show total (cumulative) usage: -`bandwhich --total-utilization` +`bandwhich {{[-t|--total-utilization]}}` - Show the network utilization for a specific network interface: -`bandwhich --interface {{eth0}}` +`bandwhich {{[-i|--interface]}} {{eth0}}` - Show DNS queries with a given DNS server: -`bandwhich --show-dns --dns-server {{dns_server_ip}}` +`bandwhich {{[-s|--show-dns]}} {{[-d|--dns-server]}} {{dns_server_ip}}` diff --git a/tldr/buku b/tldr/buku index e933752d..2d341acd 100644 --- a/tldr/buku +++ b/tldr/buku @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # buku > Command-line browser-independent bookmark manager. -> More information: . +> More information: . - Display all bookmarks matching "keyword" and with "privacy" tag: diff --git a/tldr/chronic b/tldr/chronic index 54e242ac..d77ecf28 100644 --- a/tldr/chronic +++ b/tldr/chronic @@ -10,12 +10,12 @@ source: https://github.com/tldr-pages/tldr.git - Display `stdout` and `stderr` of the specified command if and only if it produces a non-zero exit code or crashes: -`chronic {{command options ...}}` +`chronic {{command}} {{option1 option2 ...}}` - Display `stdout` and `stderr` of the specified command if and only if it produces a non-empty `stderr`: -`chronic -e {{command options ...}}` +`chronic -e {{command}} {{option1 option2 ...}}` - Enable [v]erbose mode: -`chronic -v {{command options ...}}` +`chronic -v {{command}} {{option1 option2 ...}}` diff --git a/tldr/dillo b/tldr/dillo index 1d92a83b..9cb7f1b7 100644 --- a/tldr/dillo +++ b/tldr/dillo @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Launch Dillo with a specific window size and screen location: -`dillo --geometry {{width}}x{{height}}+{{x_position}}+{{y_position}}` +`dillo {{[-g|--geometry]}} {{width}}x{{height}}+{{x_position}}+{{y_position}}` - Launch Dillo and open a specific URL: @@ -26,12 +26,12 @@ source: https://github.com/tldr-pages/tldr.git - Launch Dillo in full-screen mode: -`dillo --fullwindow` +`dillo {{[-f|--fullwindow]}}` - Display version: -`dillo --version` +`dillo {{[-v|--version]}}` - Display help: -`dillo --help` +`dillo {{[-h|--help]}}` diff --git a/tldr/dirsearch b/tldr/dirsearch index 9facd175..18d6dc6f 100644 --- a/tldr/dirsearch +++ b/tldr/dirsearch @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Scan a web server for user-defined paths with common extensions: -`dirsearch {{[-u|--url]}} {{url}} --extensions-list {{[-w|--wordlists]}} {{path/to/url-paths.txt,path/to/url-paths.txt,...}}` +`dirsearch {{[-u|--url]}} {{url}} --extensions-list {{[-w|--wordlists]}} {{path/to/url-paths1.txt,path/to/url-paths2.txt,...}}` - Scan a web server using a cookie: diff --git a/tldr/dnsx b/tldr/dnsx index 0c322b83..efac7def 100644 --- a/tldr/dnsx +++ b/tldr/dnsx @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > A fast and multi-purpose DNS toolkit to run multiple DNS queries. > Note: input to `dnsx` needs to be passed through `stdin` (pipe `|`) in some cases. > See also: `dig`, `dog`, `dnstracer`. -> More information: . +> More information: . - Query the A record of a (sub)domain and show [re]sponse received: diff --git a/tldr/docker-start b/tldr/docker-start index 70688d17..c00597ed 100644 --- a/tldr/docker-start +++ b/tldr/docker-start @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Display help: -`docker start` +`docker start --help` - Start a Docker container: diff --git a/tldr/fakedata b/tldr/fakedata index a7683199..dad063fe 100644 --- a/tldr/fakedata +++ b/tldr/fakedata @@ -18,11 +18,11 @@ source: https://github.com/tldr-pages/tldr.git - Generate data with a specific output format: -`fakedata --format {{csv|tab|sql}} {{generator}}` +`fakedata {{[-f|--format]}} {{csv|tab|sql}} {{generator}}` - Generate a given number of data items (defaults to 10): -`fakedata --limit {{n}} {{generator}}` +`fakedata {{[-l|--limit]}} {{n}} {{generator}}` - Generate data using a custom output template (the first letter of generator names must be capitalized): diff --git a/tldr/fdroid b/tldr/fdroid index 0bcd1792..17dcd487 100644 --- a/tldr/fdroid +++ b/tldr/fdroid @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > F-Droid build tool. > F-Droid is an installable catalog of FOSS (Free and Open Source Software) applications for the Android platform. -> More information: . +> More information: . - Build a specific app: diff --git a/tldr/freebsd/ipmitool b/tldr/freebsd/ipmitool index 71b509b8..f182cd5c 100644 --- a/tldr/freebsd/ipmitool +++ b/tldr/freebsd/ipmitool @@ -12,7 +12,7 @@ source: https://github.com/tldr-pages/tldr.git `kldload ipmi.ko` -- Open IPMI shell on the local hardware : +- Open IPMI shell on the local hardware: `ipmitool shell` diff --git a/tldr/geth b/tldr/geth index 5374e1f1..1399137c 100644 --- a/tldr/geth +++ b/tldr/geth @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # geth > The go-ethereum command-line interface. -> More information: . +> More information: . - Connect to the main Ethereum network and automatically download the full node: diff --git a/tldr/gh b/tldr/gh index 2c68e097..6e6470ef 100644 --- a/tldr/gh +++ b/tldr/gh @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Work seamlessly with GitHub. > Some subcommands such as `config` have their own usage documentation. -> More information: . +> More information: . - Clone a GitHub repository locally: @@ -23,7 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - View an issue in the default web browser: -`gh issue view --web {{issue_number}}` +`gh issue view {{[-w|--web]}} {{issue_number}}` - Create a pull request: @@ -31,7 +31,7 @@ source: https://github.com/tldr-pages/tldr.git - View a pull request in the default web browser: -`gh pr view --web {{pr_number}}` +`gh pr view {{[-w|--web]}} {{pr_number}}` - Check out a specific pull request locally: diff --git a/tldr/gh-alias b/tldr/gh-alias index a0d30f65..c02b53f4 100644 --- a/tldr/gh-alias +++ b/tldr/gh-alias @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Set a shell command as a `gh` subcommand: -`gh alias set --shell {{alias_name}} {{command}}` +`gh alias set {{[-s|--shell]}} {{alias_name}} {{command}}` - Delete a command shortcut: diff --git a/tldr/gh-api b/tldr/gh-api index e384b344..2c5971ff 100644 --- a/tldr/gh-api +++ b/tldr/gh-api @@ -14,19 +14,19 @@ source: https://github.com/tldr-pages/tldr.git - Create a reaction for a specific issue: -`gh api --header {{Accept:application/vnd.github.squirrel-girl-preview+json}} --raw-field '{{content=+1}}' {{repos/:owner/:repo/issues/123/reactions}}` +`gh api {{[-H|--header]}} {{Accept:application/vnd.github.squirrel-girl-preview+json}} {{[-f|--raw-field]}} '{{content=+1}}' {{repos/:owner/:repo/issues/123/reactions}}` - Display the result of a GraphQL query in JSON format: -`gh api graphql --field {{name=':repo'}} --raw-field '{{query}}'` +`gh api graphql {{[-f|--field]}} {{name=':repo'}} {{[-f|--raw-field]}} '{{query}}'` - Send a request using a custom HTTP method: -`gh api --method {{POST}} {{endpoint}}` +`gh api {{[-X|--method]}} {{POST}} {{endpoint}}` - Include the HTTP response headers in the output: -`gh api --include {{endpoint}}` +`gh api {{[--include]}} {{endpoint}}` - Do not print the response body: diff --git a/tldr/gh-auth b/tldr/gh-auth index ca097f5a..0854f74a 100644 --- a/tldr/gh-auth +++ b/tldr/gh-auth @@ -26,7 +26,7 @@ source: https://github.com/tldr-pages/tldr.git - Log in with a specific GitHub Enterprise Server: -`gh auth login --hostname {{github.example.com}}` +`gh auth login {{[-h|--hostname]}} {{github.example.com}}` - Refresh the session to ensure authentication credentials have the correct minimum scopes (removes additional scopes requested previously): @@ -34,4 +34,4 @@ source: https://github.com/tldr-pages/tldr.git - Expand the permission scopes: -`gh auth refresh --scopes {{repo,admin:repo_hook,admin:org,admin:public_key,admin:org_hook,...}}` +`gh auth refresh {{[-s|--scopes]}} {{repo,admin:repo_hook,admin:org,admin:public_key,admin:org_hook,...}}` diff --git a/tldr/gh-browse b/tldr/gh-browse index 22e8a78d..10bab0ae 100644 --- a/tldr/gh-browse +++ b/tldr/gh-browse @@ -18,11 +18,11 @@ source: https://github.com/tldr-pages/tldr.git - Open the settings page of the current repository in the default web browser: -`gh browse --settings` +`gh browse {{[-s|--settings]}}` - Open the wiki of the current repository in the default web browser: -`gh browse --wiki` +`gh browse {{[-w|--wiki]}}` - Open a specific issue or pull request in the web browser: @@ -30,7 +30,7 @@ source: https://github.com/tldr-pages/tldr.git - Open a specific branch in the web browser: -`gh browse --branch {{branch_name}}` +`gh browse {{[-b|--branch]}} {{branch_name}}` - Open a specific file or directory of the current repository in the web browser: @@ -38,4 +38,4 @@ source: https://github.com/tldr-pages/tldr.git - Print the destination URL without open the web browser: -`gh browse --no-browser` +`gh browse {{[-n|--no-browser]}}` diff --git a/tldr/gh-completion b/tldr/gh-completion index 6e975365..5a1a280b 100644 --- a/tldr/gh-completion +++ b/tldr/gh-completion @@ -10,15 +10,15 @@ source: https://github.com/tldr-pages/tldr.git - Print a completion script: -`gh completion --shell {{bash|zsh|fish|powershell}}` +`gh completion {{[-s|--shell]}} {{bash|zsh|fish|powershell}}` - Append the `gh` completion script to `~/.bashrc`: -`gh completion --shell {{bash}} >> {{~/.bashrc}}` +`gh completion {{[-s|--shell]}} {{bash}} >> {{~/.bashrc}}` - Append the `gh` completion script to `~/.zshrc`: -`gh completion --shell {{zsh}} >> {{~/.zshrc}}` +`gh completion {{[-s|--shell]}} {{zsh}} >> {{~/.zshrc}}` - Display the subcommand help: diff --git a/tldr/gh-gist b/tldr/gh-gist index a4bed42a..09099cfd 100644 --- a/tldr/gh-gist +++ b/tldr/gh-gist @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Create a new Gist with a specific [desc]ription: -`gh gist create {{path/to/file1 path/to/file2 ...}} --desc "{{description}}"` +`gh gist create {{path/to/file1 path/to/file2 ...}} {{[-d|--desc]}} "{{description}}"` - Edit a Gist: @@ -22,8 +22,8 @@ source: https://github.com/tldr-pages/tldr.git - List up to 42 Gists owned by the currently logged in user: -`gh gist list --limit {{42}}` +`gh gist list {{[-L|--limit]}} {{42}}` - View a Gist in the default browser without rendering Markdown: -`gh gist view {{id|url}} --web --raw` +`gh gist view {{id|url}} {{[-w|--web]}} {{[-r|--raw]}}` diff --git a/tldr/gh-issue b/tldr/gh-issue index d8d97a33..3cbff1b0 100644 --- a/tldr/gh-issue +++ b/tldr/gh-issue @@ -14,23 +14,23 @@ source: https://github.com/tldr-pages/tldr.git - Display a specific issue in the default web browser: -`gh issue view {{issue_number}} --web` +`gh issue view {{issue_number}} {{[-w|--web]}}` - Create a new issue in the default web browser: -`gh issue create --web` +`gh issue create {{[-w|--web]}}` - List the last 10 issues with the `bug` label: -`gh issue list --limit {{10}} --label "{{bug}}"` +`gh issue list {{[-L|--limit]}} {{10}} {{[-l|--label]}} "{{bug}}"` - List closed issues made by a specific user: -`gh issue list --state closed --author {{username}}` +`gh issue list {{[-s|--state]}} closed {{[-A|--author]}} {{username}}` - Display the status of issues relevant to the user, in a specific repository: -`gh issue status --repo {{owner}}/{{repository}}` +`gh issue status {{[-R|--repo]}} {{owner}}/{{repository}}` - Reopen a specific issue: diff --git a/tldr/gh-issue-create b/tldr/gh-issue-create index c77c9b84..4a1a2b5c 100644 --- a/tldr/gh-issue-create +++ b/tldr/gh-issue-create @@ -14,23 +14,23 @@ source: https://github.com/tldr-pages/tldr.git - Create a new issue with the `bug` label interactively: -`gh issue create --label "{{bug}}"` +`gh issue create {{[-l|--label]}} "{{bug}}"` - Create a new issue interactively and assign it to the specified users: -`gh issue create --assignee {{user1,user2,...}}` +`gh issue create {{[-a|--assignee]}} {{user1,user2,...}}` - Create a new issue with a title, body and assign it to the current user: -`gh issue create --title "{{title}}" --body "{{body}}" --assignee "{{@me}}"` +`gh issue create {{[-t|--title]}} "{{title}}" {{[-b|--body]}} "{{body}}" {{[-a|--assignee]}} "{{@me}}"` - Create a new issue interactively, reading the body text from a file: -`gh issue create --body-file {{path/to/file}}` +`gh issue create {{[-F|--body-file]}} {{path/to/file}}` - Create a new issue in the default web browser: -`gh issue create --web` +`gh issue create {{[-w|--web]}}` - Display the help: diff --git a/tldr/gh-label b/tldr/gh-label index ecd508b7..205f5b4f 100644 --- a/tldr/gh-label +++ b/tldr/gh-label @@ -14,11 +14,11 @@ source: https://github.com/tldr-pages/tldr.git - View labels for the repository in the current directory in the default web browser: -`gh label list --web` +`gh label list {{[-w|--web]}}` - Create a label with a specific name, description and color in hexadecimal format for the repository in the current directory: -`gh label create {{name}} --description "{{description}}" --color {{color_hex}}` +`gh label create {{name}} {{[-d|--description]}} "{{description}}" {{[-c|--color]}} {{color_hex}}` - Delete a label for the repository in the current directory, prompting for confirmation: @@ -26,7 +26,7 @@ source: https://github.com/tldr-pages/tldr.git - Update the name and description for a specific label for the repository in the current directory: -`gh label edit {{name}} --name {{new_name}} --description "{{description}}"` +`gh label edit {{name}} {{[-n|--name]}} {{new_name}} {{[-d|--description]}} "{{description}}"` - Clone labels from a specific repository into the repository in the current directory: diff --git a/tldr/gh-pr b/tldr/gh-pr index 1616f8b4..7919be48 100644 --- a/tldr/gh-pr +++ b/tldr/gh-pr @@ -23,7 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - Approve the pull request for the current branch: -`gh pr review --approve` +`gh pr review {{[-a|--approve]}}` - Merge the pull request associated with the current branch interactively: @@ -35,7 +35,7 @@ source: https://github.com/tldr-pages/tldr.git - Edit the base branch of a pull request: -`gh pr edit --base {{branch_name}}` +`gh pr edit {{[-B|--base]}} {{branch_name}}` - Check the status of the current repository's pull requests: diff --git a/tldr/gh-pr-create b/tldr/gh-pr-create index 4fdba227..0ecf669f 100644 --- a/tldr/gh-pr-create +++ b/tldr/gh-pr-create @@ -14,16 +14,16 @@ source: https://github.com/tldr-pages/tldr.git - Create a pull request, determining the title and description from the commit messages of the current branch: -`gh pr create --fill` +`gh pr create {{[-f|--fill]}}` - Create a draft pull request: -`gh pr create --draft` +`gh pr create {{[-d|--draft]}}` - Create a pull request specifying the base branch, title, and description: -`gh pr create --base {{base_branch}} --title "{{title}}" --body "{{body}}"` +`gh pr create {{[-B|--base]}} {{base_branch}} {{[-t|--title]}} "{{title}}" {{[-b|--body]}} "{{body}}"` - Start opening a pull request in the default web browser: -`gh pr create --web` +`gh pr create {{[-w|--web]}}` diff --git a/tldr/gh-pr-merge b/tldr/gh-pr-merge index 559634ad..bf18a46a 100644 --- a/tldr/gh-pr-merge +++ b/tldr/gh-pr-merge @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Merge the pull request, removing the branch on both the local and the remote: -`gh pr merge --delete-branch` +`gh pr merge {{[-d|--delete-branch]}}` - Merge the current pull request with the specified merge strategy: @@ -26,11 +26,11 @@ source: https://github.com/tldr-pages/tldr.git - Merge the current pull request with the specified merge strategy and commit message: -`gh pr merge --{{merge|squash|rebase}} --subject {{commit_message}}` +`gh pr merge --{{merge|squash|rebase}} {{[-t|--subject]}} {{commit_message}}` - Squash the current pull request into one commit with the message body and merge: -`gh pr merge --squash --body="{{commit_message_body}}"` +`gh pr merge {{[-s|--squash]}} {{[-b|--body]}} "{{commit_message_body}}"` - Display help: diff --git a/tldr/gh-repo b/tldr/gh-repo index 6a2cff93..3011474c 100644 --- a/tldr/gh-repo +++ b/tldr/gh-repo @@ -22,7 +22,7 @@ source: https://github.com/tldr-pages/tldr.git - View a repository in the default web browser: -`gh repo view {{repository}} --web` +`gh repo view {{repository}} {{[-w|--web]}}` - List repositories owned by a specific user or organization (if the owner is not set, the default owner will be the currently logged in user): @@ -30,8 +30,8 @@ source: https://github.com/tldr-pages/tldr.git - List only non-forks repositories and limit the number of repositories to list (default: 30): -`gh repo list {{owner}} --source -L {{limit}}` +`gh repo list {{owner}} --source {{[-L|--limit]}} {{limit}}` - List repositories with a specific primary coding language: -`gh repo list {{owner}} --language {{language_name}}` +`gh repo list {{owner}} {{[-l|--language]}} {{language_name}}` diff --git a/tldr/gh-run b/tldr/gh-run index da95b5cb..740ffff4 100644 --- a/tldr/gh-run +++ b/tldr/gh-run @@ -18,11 +18,11 @@ source: https://github.com/tldr-pages/tldr.git - Display information about the steps of a job: -`gh run view --job={{job_number}}` +`gh run view {{[-j|--job]}} {{job_number}}` - Display the log of a job: -`gh run view --job={{job_number}} --log` +`gh run view {{[-j|--job]}} {{job_number}} --log` - Check a specific workflow and exit with a non-zero status if the run failed: diff --git a/tldr/gh-screensaver b/tldr/gh-screensaver index 07a0b206..fee12241 100644 --- a/tldr/gh-screensaver +++ b/tldr/gh-screensaver @@ -15,16 +15,16 @@ source: https://github.com/tldr-pages/tldr.git - Run a specific screensaver: -`gh screensaver --saver {{fireworks|life|marquee|pipes|pollock|starfield}}` +`gh screensaver {{[-s|--saver]}} {{fireworks|life|marquee|pipes|pollock|starfield}}` - Run the "marquee" screensaver with a specific text and font: -`gh screensaver --saver {{marquee}} -- --message="{{message}}" --font={{font_name}}` +`gh screensaver {{[-s|--saver]}} {{marquee}} -- --message="{{message}}" --font={{font_name}}` - Run the "starfield" screensaver with a specific density and speed: -`gh screensaver --saver {{starfield}} -- --density {{500}} --speed {{10}}` +`gh screensaver {{[-s|--saver]}} {{starfield}} -- --density {{500}} --speed {{10}}` - List available screensavers: -`gh screensaver --list` +`gh screensaver {{[-l|--list]}}` diff --git a/tldr/gh-secret b/tldr/gh-secret index 986afb88..39984bd7 100644 --- a/tldr/gh-secret +++ b/tldr/gh-secret @@ -14,11 +14,11 @@ source: https://github.com/tldr-pages/tldr.git - List secret keys for a specific organization: -`gh secret list --org {{organization}}` +`gh secret list {{[-o|--org]}} {{organization}}` - List secret keys for a specific repository: -`gh secret list --repo {{owner}}/{{repository}}` +`gh secret list {{[-R|--repo]}} {{owner}}/{{repository}}` - Set a secret for the current repository (user will be prompted for the value): @@ -30,7 +30,7 @@ source: https://github.com/tldr-pages/tldr.git - Set an organization secret for specific repositories: -`gh secret set {{name}} --org {{organization}} --repos {{repository1,repository2}}` +`gh secret set {{name}} {{[-o|--org]}} {{organization}} {{[-r|--repos]}} {{repository1,repository2}}` - Remove a secret for the current repository: @@ -38,4 +38,4 @@ source: https://github.com/tldr-pages/tldr.git - Remove a secret for a specific organization: -`gh secret remove {{name}} --org {{organization}}` +`gh secret remove {{name}} {{[-o|--org]}} {{organization}}` diff --git a/tldr/gh-secret-set b/tldr/gh-secret-set index 0efb16ad..265c211c 100644 --- a/tldr/gh-secret-set +++ b/tldr/gh-secret-set @@ -18,12 +18,12 @@ source: https://github.com/tldr-pages/tldr.git - Set a secret for a specific repository: -`gh secret set {{name}} --body {{value}} --repo {{owner}}/{{repository}}` +`gh secret set {{name}} {{[-b|--body]}} {{value}} {{[-R|--repo]}} {{owner}}/{{repository}}` - Set an organization secret for specific repositories: -`gh secret set {{name}} --org {{organization}} --repos "{{repository1,repository2,...}}"` +`gh secret set {{name}} {{[-o|--org]}} {{organization}} {{[-r|--repos]}} "{{repository1,repository2,...}}"` - Set an organization secret with a specific visibility: -`gh secret set {{name}} --org {{organization}} --visibility {{all|private|selected}}` +`gh secret set {{name}} {{[-o|--org]}} {{organization}} {{[-v|--visibility]}} {{all|private|selected}}` diff --git a/tldr/gh-ssh-key b/tldr/gh-ssh-key index 326bb860..ad58ce70 100644 --- a/tldr/gh-ssh-key +++ b/tldr/gh-ssh-key @@ -22,4 +22,4 @@ source: https://github.com/tldr-pages/tldr.git - Add an SSH key to the currently authenticated user's account with a specific title: -`gh ssh-key add --title {{title}} {{path/to/key.pub}}` +`gh ssh-key add {{[-t|--title]}} {{title}} {{path/to/key.pub}}` diff --git a/tldr/gh-workflow b/tldr/gh-workflow index 2e4ca70f..894bd41b 100644 --- a/tldr/gh-workflow +++ b/tldr/gh-workflow @@ -14,15 +14,15 @@ source: https://github.com/tldr-pages/tldr.git - View a specific workflow in the default browser: -`gh workflow view {{id|workflow_name|filename.yml}} --web` +`gh workflow view {{id|workflow_name|filename.yml}} {{[-w|--web]}}` - Display the YAML definition of a specific workflow: -`gh workflow view {{id|workflow_name|filename.yml}} --yaml` +`gh workflow view {{id|workflow_name|filename.yml}} {{[-y|--yaml]}}` - Display the YAML definition for a specific Git branch or tag: -`gh workflow view {{id|workflow_name|filename.yml}} --ref {{branch|tag_name}} --yaml` +`gh workflow view {{id|workflow_name|filename.yml}} {{[-r|--ref]}} {{branch|tag_name}} {{[-y|--yaml]}}` - List workflow files (use `--all` to include disabled workflows): @@ -34,7 +34,7 @@ source: https://github.com/tldr-pages/tldr.git - Run a manual workflow using a specific branch or tag with JSON parameters from `stdin`: -`echo '{{{"param1": "value1", "param2": "value2", ...}}}' | gh workflow run {{id|workflow_name|filename.yml}} --ref {{branch|tag_name}}` +`echo '{{{"param1": "value1", "param2": "value2", ...}}}' | gh workflow run {{id|workflow_name|filename.yml}} {{[-r|--ref]}} {{branch|tag_name}}` - Enable or disable a specific workflow: diff --git a/tldr/git-fame b/tldr/git-fame index e8c2e813..f6855beb 100644 --- a/tldr/git-fame +++ b/tldr/git-fame @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # git fame > Pretty-print Git repository contributions. -> More information: . +> More information: . - Calculate contributions for the current Git repository: @@ -26,11 +26,11 @@ source: https://github.com/tldr-pages/tldr.git - Display contributions per file extension: -`git fame --bytype` +`git fame {{[-t|--bytype]}}` - Ignore whitespace changes: -`git fame --ignore-whitespace` +`git fame {{[-w|--ignore-whitespace]}}` - Detect inter-file line moves and copies: diff --git a/tldr/git-ignore b/tldr/git-ignore index f1119eb6..22a55227 100644 --- a/tldr/git-ignore +++ b/tldr/git-ignore @@ -15,7 +15,7 @@ source: https://github.com/tldr-pages/tldr.git - Ignore file(s) privately, updating `.git/info/exclude` file: -`git ignore {{file_pattern}} --private` +`git ignore {{file_pattern}} {{[-p|--private]}}` - Ignore file(s) locally, updating local `.gitignore` file: @@ -23,4 +23,4 @@ source: https://github.com/tldr-pages/tldr.git - Ignore file(s) globally, updating global `.gitignore` file: -`git ignore {{file_pattern}} --global` +`git ignore {{file_pattern}} {{[-g|--global]}}` diff --git a/tldr/git-ignore-io b/tldr/git-ignore-io index bc452f7f..d11f0526 100644 --- a/tldr/git-ignore-io +++ b/tldr/git-ignore-io @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Generate a .gitignore template: -`git ignore-io {{item_a,item_b,item_n}}` +`git ignore-io {{item_a,item_b,...}}` diff --git a/tldr/git-ls-remote b/tldr/git-ls-remote index 32f181d8..982b7531 100644 --- a/tldr/git-ls-remote +++ b/tldr/git-ls-remote @@ -19,7 +19,7 @@ source: https://github.com/tldr-pages/tldr.git - Show only tags references in the default remote repository: -`git ls-remote --tags` +`git ls-remote {{[-t|--tags]}}` - Show all references from a remote repository based on name or URL: diff --git a/tldr/git-root b/tldr/git-root index fdec95ce..8a86ff21 100644 --- a/tldr/git-root +++ b/tldr/git-root @@ -15,4 +15,4 @@ source: https://github.com/tldr-pages/tldr.git - Print the current working directory relative to the root of the current Git repository: -`git root --relative` +`git root {{[-r|--relative]}}` diff --git a/tldr/httpx b/tldr/httpx index e94743ab..68921e44 100644 --- a/tldr/httpx +++ b/tldr/httpx @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > A fast and multi-purpose HTTP toolkit written in Go to run multiple probes at once. > Note: not to be confused with the unrelated Python's HTTPX which has the same command name. -> More information: . +> More information: . - Run a probe against a [u]RL, host, IP Address or subnet (CIDR notation) showing probe status: diff --git a/tldr/impacket-ntfs-read b/tldr/impacket-ntfs-read new file mode 100644 index 00000000..d0683f07 --- /dev/null +++ b/tldr/impacket-ntfs-read @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# impacket-ntfs-read + +> This command is an alias of `ntfs-read.py`. + +- View documentation for the original command: + +`tldr ntfs-read.py` diff --git a/tldr/ipmitool b/tldr/ipmitool index e8f881b5..4abf1408 100644 --- a/tldr/ipmitool +++ b/tldr/ipmitool @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Interface with the Intelligent Platform Management Interface (IPMI). > More information: . -- Open IPMI shell on the local hardware : +- Open IPMI shell on the local hardware: `sudo ipmitool shell` diff --git a/tldr/jhipster b/tldr/jhipster index 49143f15..988b73d9 100644 --- a/tldr/jhipster +++ b/tldr/jhipster @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # jhipster > Web application generator using either monolithic or microservices architecture. -> More information: . +> More information: . - Generate a simple full-stack project (monolithic or microservices): @@ -30,7 +30,7 @@ source: https://github.com/tldr-pages/tldr.git - Import a JDL file to configure your application (see: ): -`jhipster import-jdl {{first_file.jh second_file.jh ... n_file.jh}}` +`jhipster import-jdl {{file1.jh file2.jh ...}}` - Generate a CI/CD pipeline for your application: diff --git a/tldr/josm b/tldr/josm index 934d2686..582d3b9d 100644 --- a/tldr/josm +++ b/tldr/josm @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # josm > Extensible OpenStreetMap editor for Java 8+. -> More information: . +> More information: . - Launch JOSM: diff --git a/tldr/katana b/tldr/katana index 91b122c0..c1db7ce6 100644 --- a/tldr/katana +++ b/tldr/katana @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > A fast crawler focused on execution in automation pipelines offering both headless and non-headless crawling. > See also: `gau`, `scrapy`, `waymore`. -> More information: . +> More information: . - Crawl a list of URLs: @@ -17,10 +17,6 @@ source: https://github.com/tldr-pages/tldr.git `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 {{[-dL|-list]}} {{path/to/domains.txt}} | katana -passive` - - Pass requests through a proxy (http/socks5) and use custom headers from a file: `katana -proxy {{http://127.0.0.1:8080}} {{[-H|-headers]}} {{path/to/headers.txt}} -u {{https://example.com}}` diff --git a/tldr/linux/distrobox-export b/tldr/linux/distrobox-export index ec0fb431..5a1cfc80 100644 --- a/tldr/linux/distrobox-export +++ b/tldr/linux/distrobox-export @@ -16,7 +16,7 @@ source: https://github.com/tldr-pages/tldr.git `distrobox-export {{[-b|--bin]}} {{path/to/binary}} {{[-ep|--export-path]}} {{path/to/binary_on_host}}` -- Export a binary from the container to the host (i.e.`$HOME/.local/bin`) : +- Export a binary from the container to the host (i.e.`$HOME/.local/bin`): `distrobox-export {{[-b|--bin]}} {{path/to/binary}} {{[-ep|--export-path]}} {{path/to/export}}` diff --git a/tldr/linux/ipmitool b/tldr/linux/ipmitool index 58c5e5b1..9ad258e7 100644 --- a/tldr/linux/ipmitool +++ b/tldr/linux/ipmitool @@ -12,7 +12,7 @@ source: https://github.com/tldr-pages/tldr.git `systemctl start ipmidrv` -- Open IPMI shell on the local hardware : +- Open IPMI shell on the local hardware: `sudo ipmitool shell` diff --git a/tldr/linux/mcookie b/tldr/linux/mcookie index 7e5a13a9..eb8f67bd 100644 --- a/tldr/linux/mcookie +++ b/tldr/linux/mcookie @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # mcookie -> Generates random 128-bit hexadecimal numbers. +> Generate random 128-bit hexadecimal numbers. > More information: . - Generate a random number: diff --git a/tldr/linux/pkexec b/tldr/linux/pkexec new file mode 100644 index 00000000..2f5b5c22 --- /dev/null +++ b/tldr/linux/pkexec @@ -0,0 +1,22 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# pkexec + +> Execute commands as another user. +> Asks for password in a GUI if available. +> More information: . + +- Run command as root: + +`pkexec {{command}}` + +- Switch user to root: + +`pkexec` + +- Run command as a specific user: + +`pkexec --user {{username}} {{command}}` diff --git a/tldr/linux/setfont b/tldr/linux/setfont new file mode 100644 index 00000000..b11f3e26 --- /dev/null +++ b/tldr/linux/setfont @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# setfont + +> Set the terminal font for TTYs. +> More information: . + +- Change the terminal font: + +`setfont {{font}}.gz` + +- Change the terminal font by specifying a path: + +`setfont /usr/share/kbd/{{mapping}}/{{font.ext}}` + +- Double font size: + +`setfont {{[-d|--double]}}` + +- Reset to the default font: + +`setfont` diff --git a/tldr/linux/systemd-analyze b/tldr/linux/systemd-analyze index d33e8c42..8750ef78 100644 --- a/tldr/linux/systemd-analyze +++ b/tldr/linux/systemd-analyze @@ -32,3 +32,7 @@ source: https://github.com/tldr-pages/tldr.git - Show security scores of running units: `systemd-analyze security` + +- View all udev rules together: + +`systemd-analyze cat-config udev/rules.d` diff --git a/tldr/linux/udisksctl b/tldr/linux/udisksctl index dea7c648..753824dc 100644 --- a/tldr/linux/udisksctl +++ b/tldr/linux/udisksctl @@ -14,19 +14,23 @@ source: https://github.com/tldr-pages/tldr.git - Show detailed information about a device: -`udisksctl info --block-device {{/dev/sdX}}` +`udisksctl info {{[-b|--block-device]}} {{/dev/sdX}}` - Show detailed information about a device partition: -`udisksctl info --block-device {{/dev/sdXN}}` +`udisksctl info {{[-b|--block-device]}} {{/dev/sdXN}}` - Mount a device partition and prints the mount point: -`udisksctl mount --block-device {{/dev/sdXN}}` +`udisksctl mount {{[-b|--block-device]}} {{/dev/sdXN}}` - Unmount a device partition: -`udisksctl unmount --block-device {{/dev/sdXN}}` +`udisksctl unmount {{[-b|--block-device]}} {{/dev/sdXN}}` + +- Power off a device to safely remove it: + +`udisksctl power-off {{[-b|--block-device]}} {{/dev/sdX}}` - Monitor the daemon for events: diff --git a/tldr/minifab b/tldr/minifab index a07ea684..7e8a151a 100644 --- a/tldr/minifab +++ b/tldr/minifab @@ -30,7 +30,7 @@ source: https://github.com/tldr-pages/tldr.git - Invoke a chaincode method with the specified arguments: -`minifab invoke {{[-n|--chaincode-name]}} {{chaincode_name}} {{[-p|--chaincode-parameters]}} '"{{method_name}}", "{{argument1}}", "{{argument2}}", ...'` +`minifab invoke {{[-n|--chaincode-name]}} {{chaincode_name}} {{[-p|--chaincode-parameters]}} '"{{method_name}}", {{"argument1", "argument2", ...}}'` - Make a query on the ledger: diff --git a/tldr/mongoimport b/tldr/mongoimport index 217a3c39..4d75dd18 100644 --- a/tldr/mongoimport +++ b/tldr/mongoimport @@ -10,23 +10,23 @@ source: https://github.com/tldr-pages/tldr.git - Import a JSON file into a specific collection: -`mongoimport --file={{path/to/file.json}} --uri={{mongodb_uri}} --collection={{collection_name}}` +`mongoimport --file {{path/to/file.json}} --uri {{mongodb_uri}} {{[-c|--collection]}} {{collection_name}}` - Import a CSV file, using the first line of the file to determine field names: -`mongoimport --type={{csv}} --file={{path/to/file.csv}} --db={{database_name}} --collection={{collection_name}}` +`mongoimport --type {{csv}} --file {{path/to/file.csv}} {{[-d|--db]}} {{database_name}} {{[-c|--collection]}} {{collection_name}}` - Import a JSON array, using each element as a separate document: -`mongoimport --jsonArray --file={{path/to/file.json}}` +`mongoimport --jsonArray --file {{path/to/file.json}}` - Import a JSON file using a specific mode and a query to match existing documents: -`mongoimport --file={{path/to/file.json}} --mode={{delete|merge|upsert}} --upsertFields="{{field1,field2,...}}"` +`mongoimport --file {{path/to/file.json}} --mode {{delete|merge|upsert}} --upsertFields "{{field1,field2,...}}"` - Import a CSV file, reading field names from a separate CSV file and ignoring fields with empty values: -`mongoimport --type={{csv}} --file={{path/to/file.csv}} --fieldFile={{path/to/field_file.csv}} --ignoreBlanks` +`mongoimport --type {{csv}} --file {{path/to/file.csv}} --fieldFile {{path/to/field_file.csv}} --ignoreBlanks` - Display help: diff --git a/tldr/mpg321 b/tldr/mpg321 index 52f7365d..64cc1268 100644 --- a/tldr/mpg321 +++ b/tldr/mpg321 @@ -11,7 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - Play an audio source exactly `n` times (0 means forever): -`mpg321 {{[-l|--loop]}} {{n}} {{path/to/file_a|URL}} {{path/to/file_b|URL}} {{...}}` +`mpg321 {{[-l|--loop]}} {{n}} {{path/to/file_a|URL path/to/file_b|URL ...}}` - Play a directory recursively: @@ -19,15 +19,15 @@ source: https://github.com/tldr-pages/tldr.git - Enable Basic Keys ( `*` or `/` - Increase or decrease volume, `n` - Skip song, `m` - Mute/unmute.) while playing: -`mpg321 -K {{path/to/file_a|URL}} {{path/to/file_b|URL}} {{...}}` +`mpg321 -K {{path/to/file_a|URL path/to/file_b|URL ...}}` - Play files randomly until interrupted: -`mpg321 {{[-Z|--random]}} {{path/to/file_a|URL}} {{path/to/file_b|URL}} {{...}}` +`mpg321 {{[-Z|--random]}} {{path/to/file_a|URL path/to/file_b|URL ...}}` - Shuffle the files before playing them once: -`mpg321 {{[-z|--shuffle]}} {{path/to/file_a|URL}} {{path/to/file_b|URL}} {{...}}` +`mpg321 {{[-z|--shuffle]}} {{path/to/file_a|URL path/to/file_b|URL ...}}` - Play all files in the current directory and subdirectories, randomly (until interrupted), with Basic Keys enabled: diff --git a/tldr/naabu b/tldr/naabu index 2ca89645..bdee2013 100644 --- a/tldr/naabu +++ b/tldr/naabu @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > A fast port scanner written in Go with a focus on reliability and simplicity. > Note: Some features are only activated when `naabu` is run with root privileges such as SYN scan. -> More information: . +> More information: . - Run a SYN scan against default (top 100) ports of remote host: diff --git a/tldr/netstat b/tldr/netstat index ecb5b69b..618e1017 100644 --- a/tldr/netstat +++ b/tldr/netstat @@ -11,28 +11,28 @@ source: https://github.com/tldr-pages/tldr.git - List all ports: -`netstat --all` +`netstat {{[-a|--all]}}` - List all listening ports: -`netstat --listening` +`netstat {{-l|--listening]}}` - List listening TCP ports: -`netstat --tcp` +`netstat {{-t|--tcp]}}` - Display PID and program names: -`netstat --program` +`netstat {{[-p|--program]}}` - List information continuously: -`netstat --continuous` +`netstat {{[-c|--continuous]}}` - List routes and do not resolve IP addresses to hostnames: -`netstat --route --numeric` +`netstat {{[-rn|--route --numeric]}}` - List listening TCP and UDP ports (+ user and process if you're root): -`netstat --listening --program --numeric --tcp --udp --extend` +`netstat {{[-tulpne|--tcp --udp --listening --program --numeric --extend]}}` diff --git a/tldr/nix-classic b/tldr/nix-classic index 5ce1c497..258c8470 100644 --- a/tldr/nix-classic +++ b/tldr/nix-classic @@ -15,11 +15,11 @@ source: https://github.com/tldr-pages/tldr.git - Start a shell with the specified packages available: -`nix-shell {{[-p|--packages]}} {{pkg1 pkg2 pkg3...}}` +`nix-shell {{[-p|--packages]}} {{pkg1 pkg2 pkg3 ...}}` - Install some packages permanently: -`nix-env {{[-iA|--install --attr]}} {{nixpkgs.pkg1 nixpkgs.pkg2...}}` +`nix-env {{[-iA|--install --attr]}} {{nixpkgs.pkg1 nixpkgs.pkg2 ...}}` - Show all dependencies of a store path (package), in a tree format: diff --git a/tldr/nix3-search b/tldr/nix3-search index 0c493911..83519098 100644 --- a/tldr/nix3-search +++ b/tldr/nix3-search @@ -11,7 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - Search `nixpkgs` for a package based on its name or description: -`nix search {{nixpkgs}} {{search_term...}}` +`nix search {{nixpkgs}} {{search_term}}` - Show description of a package from nixpkgs: diff --git a/tldr/ntfs-read.py b/tldr/ntfs-read.py new file mode 100644 index 00000000..0b1c6a1c --- /dev/null +++ b/tldr/ntfs-read.py @@ -0,0 +1,16 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ntfs-read.py + +> A read-only NTFS explorer for accessing and extracting files from NTFS volumes. +> Part of the Impacket suite. +> More information: . + +- Open an NTFS volume for exploration (e.g., `C:\.\` or `/dev/disk1s1`): + +`ntfs-read.py {{volume}}` + +- Extract a specific file from an NTFS volume (e.g., `\windows\system32 \ No newline at end of file diff --git a/tldr/nuclei b/tldr/nuclei index c8129af3..797c96ba 100644 --- a/tldr/nuclei +++ b/tldr/nuclei @@ -6,36 +6,36 @@ source: https://github.com/tldr-pages/tldr.git # nuclei > Fast and customizable vulnerability scanner based on a simple YAML based DSL. -> More information: . +> More information: . - [u]pdate `nuclei` [t]emplates to the latest released version (will be downloaded to `~/nuclei-templates`): -`nuclei -ut` +`nuclei {{[-ut|-update-templates]}}` - [l]ist all [t]emplates with a specific [p]rotocol [t]ype: -`nuclei -tl -pt {{dns|file|http|headless|tcp|workflow|ssl|websocket|whois|code|javascript}}` +`nuclei -tl {{[-pt|-type]}} {{dns|file|http|headless|tcp|workflow|ssl|websocket|whois|code|javascript}}` - Run an [a]utomatic web [s]can using wappalyzer technology detection specifying a target [u]RL/host to scan: -`nuclei -as -u {{scanme.nmap.org}}` +`nuclei {{[-as|-automatic-scan]}} {{[-u|-target]}} {{scanme.nmap.org}}` - Run HTTP [p]rotocol [t]ype templates of high and critical severity, [e]xporting results to [m]arkdown files inside a specific directory: -`nuclei -severity high,critical -pt http -u {{http://scanme.sh}} -me {{markdown_directory}}` +`nuclei {{[-s|-severity]}} high,critical {{[-pt|-type]}} http {{[-u|-target]}} {{http://scanme.sh}} {{[-me|-markdown-export]}} {{markdown_directory}}` - Run all templates using a different [r]ate [l]imit and maximum [b]ulk [s]ize with silent output (only showing the findings): -`nuclei -rl {{150}} -bs {{25}} -c {{25}} -silent -u {{http://scanme.sh}}` +`nuclei {{[-rl|-rate-limit]}} {{150}} {{[-bs|-bulk-size]}} {{25}} {{[-c|-concurrency]}} {{25}} -silent {{[-u|-target]}} {{http://scanme.sh}}` - Run the WordPress [w]orkflow against a WordPress site: -`nuclei -w {{path/to/nuclei-templates/workflows/wordpress-workflow.yaml}} -u {{https://sample.wordpress.site}}` +`nuclei {{[-w|-workflows]}} {{path/to/nuclei-templates/workflows/wordpress-workflow.yaml}} {{[-u|-target]}} {{https://sample.wordpress.site}}` - Run one or more specific [t]emplates or directory with [t]emplates with [v]erbose output in `stderr` and [o]utput detected issues/vulnerabilities to a file: -`nuclei -t {{path/to/nuclei-templates/http}} -u {{http://scanme.sh}} -v -o {{results}}` +`nuclei {{[-t|-templates]}} {{path/to/nuclei-templates/http}} {{[-u|-target]}} {{http://scanme.sh}} {{[-v|-verbose]}} {{[-o|-output]}} {{results}}` - Run scan based on one or more [t]emplate [c]onditions: -`nuclei -tc "{{contains(tags, 'xss') && contains(tags, 'cve')}}" -u {{https://vulnerable.website}}` +`nuclei {{[-tc|-template-condition]}} "{{contains(tags, 'xss') && contains(tags, 'cve')}}" {{[-u|-target]}} {{https://vulnerable.website}}` diff --git a/tldr/peludna-prognoza b/tldr/peludna-prognoza index fd8af8ed..46e92464 100644 --- a/tldr/peludna-prognoza +++ b/tldr/peludna-prognoza @@ -22,4 +22,4 @@ source: https://github.com/tldr-pages/tldr.git - Display the pollen measurement page for a city at in the default web browser: -`peludna-prognoza "{{city}}" --web` +`peludna-prognoza "{{city}}" {{[-w|--web]}}` diff --git a/tldr/podman-rmi b/tldr/podman-rmi index 18e9b75b..205e0810 100644 --- a/tldr/podman-rmi +++ b/tldr/podman-rmi @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Remove one or more images given their names: -`podman rmi {{image:tag}} {{image2:tag}} {{...}}` +`podman rmi {{image:tag image2:tag ...}}` - Force remove an image: diff --git a/tldr/pueue-completions b/tldr/pueue-completions index 52c609e5..43f49941 100644 --- a/tldr/pueue-completions +++ b/tldr/pueue-completions @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # pueue completions -> Generates shell completion files for Bash, Elvish, Fish, PowerShell, and Zsh. +> Generate shell completion files for Bash, Elvish, Fish, PowerShell, and Zsh. > More information: . - Generate completions for Bash: diff --git a/tldr/raco b/tldr/raco index 70e40fda..6985e0b1 100644 --- a/tldr/raco +++ b/tldr/raco @@ -26,7 +26,7 @@ source: https://github.com/tldr-pages/tldr.git - Search local documentation: -`raco docs {{search_terms ...}}` +`raco docs {{search_terms}}` - Display help: diff --git a/tldr/react-native-start b/tldr/react-native-start index 29405569..79c48234 100644 --- a/tldr/react-native-start +++ b/tldr/react-native-start @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # react-native start > Command-line tools to start the React Native server. -> More information: . +> More information: . - Start the server that communicates with connected devices: diff --git a/tldr/rg b/tldr/rg index 1ec63f15..af73412a 100644 --- a/tldr/rg +++ b/tldr/rg @@ -7,36 +7,36 @@ source: https://github.com/tldr-pages/tldr.git > Ripgrep, a recursive line-oriented search tool. > Aims to be a faster alternative to `grep`. -> More information: . +> More information: . -- Recursively search the current directory for a regular expression: +- Recursively search current directory for a pattern (regular expression): -`rg {{regular_expression}}` +`rg {{pattern}}` -- Search for regular expressions recursively in the current directory, including hidden files and files listed in `.gitignore`: +- Recursively search for a pattern in a file or directory: -`rg --no-ignore --hidden {{regular_expression}}` +`rg {{pattern}} {{path/to/file_or_directory}}` -- Search for a regular expression only in a subset of directories: +- Include hidden files and entries listed in `.gitignore`: -`rg {{regular_expression}} {{set_of_subdirs}}` +`rg {{[-.|--hidden]}} --no-ignore {{pattern}}` -- Search for a regular expression in files matching a glob (e.g. `README.*`): +- Only search the files whose names match the glob pattern(s) (e.g. `README.*`): -`rg {{regular_expression}} --glob {{glob}}` +`rg {{pattern}} {{[-g|--glob]}} {{filename_glob_pattern}}` -- Search for filenames that match a regular expression: +- Recursively list filenames in the current directory that match a pattern: -`rg --files | rg {{regular_expression}}` +`rg --files | rg {{pattern}}` - Only list matched files (useful when piping to other commands): -`rg --files-with-matches {{regular_expression}}` +`rg {{[-l|--files-with-matches]}} {{pattern}}` -- Show lines that do not match the given regular expression: +- Show lines that do not match the pattern: -`rg --invert-match {{regular_expression}}` +`rg {{[-v|--invert-match]}} {{pattern}}` -- Search a literal string pattern: +- Search for a literal string pattern: -`rg --fixed-strings -- {{string}}` +`rg {{[-F|--fixed-strings]}} -- {{string}}` diff --git a/tldr/rsactftool.py b/tldr/rsactftool.py index 0cb55d84..be91b77c 100644 --- a/tldr/rsactftool.py +++ b/tldr/rsactftool.py @@ -3,7 +3,7 @@ syntax: markdown tags: [tldr, common] source: https://github.com/tldr-pages/tldr.git --- -# RsaCtfTool +# RsaCtfTool.py > RSA attack tool for CTF challenges - recover private keys from weak public keys and/or decrypt data. > More information: . diff --git a/tldr/rustscan b/tldr/rustscan index d530134c..39506780 100644 --- a/tldr/rustscan +++ b/tldr/rustscan @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Scan a specific list of ports: -`rustscan {{[-p|--ports]}} {{port1,port2,...,portN}} {{[-a|--addresses]}} {{address_or_addresses}}` +`rustscan {{[-p|--ports]}} {{port1,port2,...}} {{[-a|--addresses]}} {{address_or_addresses}}` - Scan a specific range of ports: diff --git a/tldr/scalafmt b/tldr/scalafmt index a7f75bf6..1a2277c7 100644 --- a/tldr/scalafmt +++ b/tldr/scalafmt @@ -15,7 +15,7 @@ source: https://github.com/tldr-pages/tldr.git - Reformat specific files or directories with a custom formatting configuration: -`scalafmt --config {{path/to/.scalafmt.conf}} {{path/to/file_or_directory}} {{path/to/file_or_directory}} {{...}}` +`scalafmt --config {{path/to/.scalafmt.conf}} {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` - Check if files are correctly formatted, returning `0` if all files respect the formatting style: @@ -23,7 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - Exclude files or directories: -`scalafmt --exclude {{path/to/file_or_directory}} {{...}}` +`scalafmt --exclude {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` - Format only files that were edited against the current Git branch: diff --git a/tldr/sfdk-compiledb b/tldr/sfdk-compiledb index 9a2acca0..4a3b2089 100644 --- a/tldr/sfdk-compiledb +++ b/tldr/sfdk-compiledb @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # sfdk compiledb -> Generates compilation database. +> Generate compilation database. > More information: . - Generate compilation database: diff --git a/tldr/sfdk-qmltypes b/tldr/sfdk-qmltypes index 2fc48e7a..6136cd39 100644 --- a/tldr/sfdk-qmltypes +++ b/tldr/sfdk-qmltypes @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # sfdk qmltypes -> Generates qmltypes files. +> Generate qmltypes files. > More information: . - Generate qmltypes files: diff --git a/tldr/siege b/tldr/siege index 6604f07e..a39769db 100644 --- a/tldr/siege +++ b/tldr/siege @@ -14,20 +14,20 @@ source: https://github.com/tldr-pages/tldr.git - Test a list of URLs: -`siege --file {{path/to/url_list.txt}}` +`siege {{[-f|--file]}} {{path/to/url_list.txt}}` - Test list of URLs in a random order (Simulates internet traffic): -`siege --internet --file {{path/to/url_list.txt}}` +`siege {{[-i|--internet]}} {{[-f|--file]}} {{path/to/url_list.txt}}` - Benchmark a list of URLs (without waiting between requests): -`siege --benchmark --file {{path/to/url_list.txt}}` +`siege {{[-b|--benchmark]}} {{[-f|--file]}} {{path/to/url_list.txt}}` - Set the amount of concurrent connections: -`siege --concurrent={{50}} --file {{path/to/url_list.txt}}` +`siege {{[-c|--concurrent]}} {{50}} {{[-f|--file]}} {{path/to/url_list.txt}}` - Set how long for the siege to run for: -`siege --time={{30s}} --file {{path/to/url_list.txt}}` +`siege {{[-t|--time]}} {{30s}} {{[-f|--file]}} {{path/to/url_list.txt}}` diff --git a/tldr/spotdl b/tldr/spotdl index 33b7450b..205cf144 100644 --- a/tldr/spotdl +++ b/tldr/spotdl @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Download songs from the provided URLs and embed metadata: -`spotdl {{open.spotify.com/playlist/playlistId open.spotify.com/track/trackId ...}}` +`spotdl {{open.spotify.com/playlist/playlistId1 open.spotify.com/track/trackId2 ...}}` - Start a web interface to download individual songs: @@ -18,4 +18,4 @@ source: https://github.com/tldr-pages/tldr.git - Save only the metadata without downloading anything: -`spotdl save {{open.spotify.com/playlist/playlistId ...}} --save-file {{path/to/save_file.spotdl}}` +`spotdl save {{open.spotify.com/playlist/playlistId1 open.spotify.com/track/trackId2 ...}} --save-file {{path/to/save_file.spotdl}}` diff --git a/tldr/subfinder b/tldr/subfinder index 1c95e455..9c75de93 100644 --- a/tldr/subfinder +++ b/tldr/subfinder @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Discover valid subdomains for websites. > Designed as a passive framework to be useful for bug bounties and safe for penetration testing. -> More information: . +> More information: . - Find subdomains for a specific domain: diff --git a/tldr/tlmgr-info b/tldr/tlmgr-info index 3592e81d..77c1f76e 100644 --- a/tldr/tlmgr-info +++ b/tldr/tlmgr-info @@ -34,7 +34,7 @@ source: https://github.com/tldr-pages/tldr.git - Show only specific information about a package: -`tlmgr info {{package}} --data "{{name}},{{category}},{{installed}},{{size}},{{depends}},..."` +`tlmgr info {{package}} --data "{{name}},{{category}},{{installed}},{{size}},{{depends}},{{...}}"` - Print all available packages as JSON encoded array: diff --git a/tldr/tmux b/tldr/tmux index d47d227d..2ffa53ce 100644 --- a/tldr/tmux +++ b/tldr/tmux @@ -14,17 +14,17 @@ source: https://github.com/tldr-pages/tldr.git `tmux` -- Start a new named session: +- Start a new named [s]ession: -`tmux new -s {{name}}` +`tmux {{[new|new-session]}} -s {{name}}` - List existing sessions: -`tmux ls` +`tmux {{[ls|list-sessions]}}` - Attach to the most recently used session: -`tmux attach` +`tmux {{[a|attach]}}` - Detach from the current session (inside a tmux session): @@ -38,6 +38,6 @@ source: https://github.com/tldr-pages/tldr.git `` -- Kill a session by name: +- Kill a session by [t]arget name: `tmux kill-session -t {{name}}` diff --git a/tldr/vboxmanage-cloud b/tldr/vboxmanage-cloud index bf561a7d..3878052d 100644 --- a/tldr/vboxmanage-cloud +++ b/tldr/vboxmanage-cloud @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Create a new instance: -`VBoxManage cloud --provider={{provider_name}} --profile={{profile_name}} instance create --domain-name={{domain_name}} --image-id={{image_id}} | {{--options...}}` +`VBoxManage cloud --provider={{provider_name}} --profile={{profile_name}} instance create --domain-name={{domain_name}} --image-id={{image_id}}` - Gather information about a particular instance: diff --git a/tldr/virsh-undefine b/tldr/virsh-undefine index 66b2d4a2..e5e00f42 100644 --- a/tldr/virsh-undefine +++ b/tldr/virsh-undefine @@ -3,7 +3,7 @@ syntax: markdown tags: [tldr, common] source: https://github.com/tldr-pages/tldr.git --- -# virsh-undefine +# virsh undefine > Delete a virtual machine. > More information: . diff --git a/tldr/virt-clone b/tldr/virt-clone index 2596368c..4c5e28f6 100644 --- a/tldr/virt-clone +++ b/tldr/virt-clone @@ -10,8 +10,8 @@ source: https://github.com/tldr-pages/tldr.git - Clone a virtual machine and automatically generate a new name, storage path, and MAC address: -`virt-clone --original {{vm_name}} --auto-clone` +`virt-clone {{[-o|--original]}} {{vm_name}} --auto-clone` - Clone a virtual machine and specify the new name, storage path, and MAC address: -`virt-clone --original {{vm_name}} --name {{new_vm_name}} --file {{path/to/new_storage}} --mac {{ff:ff:ff:ff:ff:ff|RANDOM}}` +`virt-clone {{[-o|--original]}} {{vm_name}} {{[-n|--name]}} {{new_vm_name}} {{[-f|--file]}} {{path/to/new_storage}} {{[-m|--mac]}} {{ff:ff:ff:ff:ff:ff|RANDOM}}` diff --git a/tldr/virt-install b/tldr/virt-install index a91dd5db..469e21f6 100644 --- a/tldr/virt-install +++ b/tldr/virt-install @@ -6,24 +6,24 @@ source: https://github.com/tldr-pages/tldr.git # virt-install > Create virtual machines with libvirt and begin OS installation. -> More information: . +> More information: . - Create a virtual machine with 1 GB RAM and 12 GB storage and start a Debian installation: -`virt-install --name {{vm_name}} --memory {{1024}} --disk path={{path/to/image.qcow2}},size={{12}} --cdrom {{path/to/debian.iso}}` +`virt-install {{[-n|--name]}} {{vm_name}} --memory {{1024}} --disk path={{path/to/image.qcow2}},size={{12}} {{[-c|--cdrom]}} {{path/to/debian.iso}}` - Create a x86-64, KVM-accelerated, UEFI-based virtual machine with the Q35 chipset, 4 GiB RAM, 16 GiB RAW storage, and start a Fedora installation: -`virt-install --name {{vm_name}} --arch {{x86_64}} --virt-type {{kvm}} --machine {{q35}} --boot {{uefi}} --memory {{4096}} --disk path={{path/to/image.raw}},size={{16}} --cdrom {{path/to/fedora.iso}}` +`virt-install {{[-n|--name]}} {{vm_name}} --arch {{x86_64}} --virt-type {{kvm}} --machine {{q35}} --boot {{uefi}} --memory {{4096}} --disk path={{path/to/image.raw}},size={{16}} {{[-c|--cdrom]}} {{path/to/fedora.iso}}` - Create a diskless live virtual machine without an emulated sound device or a USB controller. Don't start an installation and don't autoconnect to console but attach a cdrom to it (might be useful for when using a live CD like tails): -`virt-install --name {{vm_name}} --memory {{512}} --disk {{none}} --controller {{type=usb,model=none}} --sound {{none}} --autoconsole {{none}} --install {{no_install=yes}} --cdrom {{path/to/tails.iso}}` +`virt-install {{[-n|--name]}} {{vm_name}} --memory {{512}} --disk {{none}} --controller {{type=usb,model=none}} --sound {{none}} --autoconsole {{none}} --install {{no_install=yes}} {{[-c|--cdrom]}} {{path/to/tails.iso}}` - Create a virtual machine with 16 GiB RAM, 250 GiB storage, 8 cores with hyperthreading, a specific CPU topology, and a CPU model that shares most features with the host CPU: -`virt-install --name {{vm_name}} --cpu {{host-model}},topology.sockets={{1}},topology.cores={{4}},topology.threads={{2}} --memory {{16384}} --disk path={{path/to/image.qcow2}},size={{250}} --cdrom {{path/to/debian.iso}}` +`virt-install {{[-n|--name]}} {{vm_name}} --cpu {{host-model}},topology.sockets={{1}},topology.cores={{4}},topology.threads={{2}} --memory {{16384}} --disk path={{path/to/image.qcow2}},size={{250}} {{[-c|--cdrom]}} {{path/to/debian.iso}}` - Create a virtual machine and kickstart an automated deployment based on Fedora 35 using only remote resources (no ISO required): -`virt-install --name {{vm_name}} --memory {{2048}} --disk path={{path/to/image.qcow2}},size={{20}} --location={{https://download.fedoraproject.org/pub/fedora/linux/releases/35/Everything/x86_64/os/}} --extra-args="{{inst.ks=https://path/to/valid/kickstart.org}}"` +`virt-install {{[-n|--name]}} {{vm_name}} --memory {{2048}} --disk path={{path/to/image.qcow2}},size={{20}} {{[-l|--location]}} {{https://download.fedoraproject.org/pub/fedora/linux/releases/35/Everything/x86_64/os/}} {{[-x|--extra-args]}} "{{inst.ks=https://path/to/valid/kickstart.org}}"` diff --git a/tldr/virt-qemu-run b/tldr/virt-qemu-run index ff225679..97f7573d 100644 --- a/tldr/virt-qemu-run +++ b/tldr/virt-qemu-run @@ -14,12 +14,12 @@ source: https://github.com/tldr-pages/tldr.git - Run a QEMU virtual machine and store the state in a specific directory: -`virt-qemu-run --root={{path/to/directory}} {{path/to/guest.xml}}` +`virt-qemu-run {{[-r|--root]}} {{path/to/directory}} {{path/to/guest.xml}}` - Run a QEMU virtual machine and display verbose information about the startup: -`virt-qemu-run --verbose {{path/to/guest.xml}}` +`virt-qemu-run {{[-v|--verbose]}} {{path/to/guest.xml}}` - Display help: -`virt-qemu-run --help` +`virt-qemu-run {{[-h|--help]}}` diff --git a/tldr/virt-sparsify b/tldr/virt-sparsify index bf96fd6a..92c11450 100644 --- a/tldr/virt-sparsify +++ b/tldr/virt-sparsify @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Make virtual machine drive images thin-provisioned. > Note: Use only for offline machines to avoid data corruption. -> More information: . +> More information: . - Create a sparsified compressed image without snapshots from an unsparsified one: diff --git a/tldr/whois b/tldr/whois index 102322d1..544c0d57 100644 --- a/tldr/whois +++ b/tldr/whois @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # whois > Command-line client for the WHOIS (RFC 3912) protocol. -> More information: . +> More information: . - Get information about a domain name: diff --git a/tldr/wrangler b/tldr/wrangler index 87a08727..8bf0ef7e 100644 --- a/tldr/wrangler +++ b/tldr/wrangler @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # wrangler > Cloudflare Workers command-line tool. -> More information: . +> More information: . - Initialize a project with a skeleton configuration: diff --git a/tldr/x11docker b/tldr/x11docker index 638fdf12..bdfec6e9 100644 --- a/tldr/x11docker +++ b/tldr/x11docker @@ -7,23 +7,23 @@ source: https://github.com/tldr-pages/tldr.git > Securely run GUI applications and desktop UIs in Docker containers. > See also `xephyr`. -> More information: . +> More information: . - Launch VLC in a container: -`x11docker --pulseaudio --share={{$HOME/Videos}} {{jess/vlc}}` +`x11docker {{[-p|--pulseaudio]}} --share {{$HOME/Videos}} {{jess/vlc}}` - Launch Xfce in a window: -`x11docker --desktop {{x11docker/xfce}}` +`x11docker {{[-d|--desktop]}} {{x11docker/xfce}}` - Launch GNOME in a window: -`x11docker --desktop --gpu --init={{systemd}} {{x11docker/gnome}}` +`x11docker {{[-d|--desktop]}} {{[-g|--gpu]}} --init={{systemd}} {{x11docker/gnome}}` - Launch KDE Plasma in a window: -`x11docker --desktop --gpu --init={{systemd}} {{x11docker/kde-plasma}}` +`x11docker {{[-d|--desktop]}} {{[-g|--gpu]}} --init={{systemd}} {{x11docker/kde-plasma}}` - Display help: diff --git a/tldr/xml-validate b/tldr/xml-validate index 7c75f1cf..981181a7 100644 --- a/tldr/xml-validate +++ b/tldr/xml-validate @@ -10,19 +10,19 @@ source: https://github.com/tldr-pages/tldr.git - Validate one or more XML documents for well-formedness only: -`xml validate {{path/to/input1.xml|URI}} {{input2.xml ...}}` +`xml validate {{path/to/input1.xml|URI1 path/to/input2.xml|URI2 ...}}` - Validate one or more XML documents against a Document Type Definition (DTD): -`xml validate --dtd {{path/to/schema.dtd}} {{path/to/input1.xml|URI}} {{input2.xml ...}}` +`xml validate --dtd {{path/to/schema.dtd}} {{path/to/input1.xml|URI1 path/to/input2.xml|URI2 ...}}` - Validate one or more XML documents against an XML Schema Definition (XSD): -`xml validate --xsd {{path/to/schema.xsd}} {{path/to/input1.xml|URI}} {{input2.xml ...}}` +`xml validate --xsd {{path/to/schema.xsd}} {{path/to/input1.xml|URI1 path/to/input2.xml|URI2 ...}}` - Validate one or more XML documents against a Relax NG schema (RNG): -`xml validate --relaxng {{path/to/schema.rng}} {{path/to/input1.xml|URI}} {{input2.xml ...}}` +`xml validate --relaxng {{path/to/schema.rng}} {{path/to/input1.xml|URI1 path/to/input2.xml|URI2 ...}}` - Display help: