diff --git a/tldr/cmake b/tldr/cmake index be9f3cbd..a26312ed 100644 --- a/tldr/cmake +++ b/tldr/cmake @@ -34,8 +34,8 @@ source: https://github.com/tldr-pages/tldr.git - Run a custom build target: -`cmake --build {{path/to/build_directory}} --target {{target_name}}` +`cmake --build {{path/to/build_directory}} {{[-t|--target]}} {{target_name}}` - Display help, obtain a list of generators: -`cmake --help` +`cmake {{[-h|--help]}}` diff --git a/tldr/cppcheck b/tldr/cppcheck index 12dccde7..e1c830d8 100644 --- a/tldr/cppcheck +++ b/tldr/cppcheck @@ -15,7 +15,7 @@ source: https://github.com/tldr-pages/tldr.git - Recursively check a given directory, and don't print progress messages: -`cppcheck --quiet {{path/to/directory}}` +`cppcheck {{[-q|--quiet]}} {{path/to/directory}}` - Check a given file, specifying which tests to perform (by default only errors are shown): diff --git a/tldr/dalfox b/tldr/dalfox index 54ca3779..38412234 100644 --- a/tldr/dalfox +++ b/tldr/dalfox @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Scan a URL using a header for authentication: -`dalfox url {{http://example.com}} -H {{'X-My-Header: 123'}}` +`dalfox url {{http://example.com}} {{[-H|--header]}} {{'X-My-Header: 123'}}` - Scan a list of URLs from a file: diff --git a/tldr/gdown b/tldr/gdown index 5d798925..52d9263a 100644 --- a/tldr/gdown +++ b/tldr/gdown @@ -22,8 +22,8 @@ source: https://github.com/tldr-pages/tldr.git - Download a folder using its ID or the full URL: -`gdown {{folder_id|url}} -O {{path/to/output_directory}} --folder` +`gdown {{folder_id|url}} {{[-O|--output]}} {{path/to/output_directory}} --folder` - Download a tar archive, write it to `stdout` and extract it: -`gdown {{tar_url}} -O - --quiet | tar xvf -` +`gdown {{tar_url}} {{[-O|--output]}} - {{[-q|--quiet]}} | tar xvf -` diff --git a/tldr/gfortran b/tldr/gfortran index 760a51b7..1d886d8a 100644 --- a/tldr/gfortran +++ b/tldr/gfortran @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # gfortran > Preprocess and compile Fortran source files, then assemble and link them together. -> More information: . +> More information: . - Compile multiple source files into an executable: diff --git a/tldr/ghc b/tldr/ghc index f7242a5b..f1204620 100644 --- a/tldr/ghc +++ b/tldr/ghc @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > The Glasgow Haskell Compiler. > Compiles and links Haskell source files. -> More information: . +> More information: . - Find and compile all modules in the current directory: diff --git a/tldr/git-authors b/tldr/git-authors index a5ab506c..525aa0c1 100644 --- a/tldr/git-authors +++ b/tldr/git-authors @@ -7,11 +7,11 @@ source: https://github.com/tldr-pages/tldr.git > Generate a list of committers of a Git repository. > Part of `git-extras`. -> More information: . +> More information: . - Print a full list of committers to `stdout` instead of to the `AUTHORS` file: -`git authors --list` +`git authors {{[-l|--list]}}` - Append the list of committers to the `AUTHORS` file and open it in the default editor: diff --git a/tldr/git-changelog b/tldr/git-changelog index 5f4215e0..9033742b 100644 --- a/tldr/git-changelog +++ b/tldr/git-changelog @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Generate a changelog report from repository commits and tags. > Part of `git-extras`. -> More information: . +> More information: . - Update existing file or create a new `History.md` file with the commit messages since the latest Git tag: @@ -15,19 +15,19 @@ source: https://github.com/tldr-pages/tldr.git - List commits from the current version: -`git changelog --list` +`git changelog {{[-l|--list]}}` - List a range of commits from the tag named `2.1.0` to now: -`git changelog --list --start-tag {{2.1.0}}` +`git changelog {{[-l|--list]}} {{[-s|--start-tag]}} {{2.1.0}}` - List pretty formatted range of commits between the tag `0.5.0` and the tag `1.0.0`: -`git changelog --start-tag {{0.5.0}} --final-tag {{1.0.0}}` +`git changelog {{[-s|--start-tag]}} {{0.5.0}} {{[-f|--final-tag]}} {{1.0.0}}` - List pretty formatted range of commits between the commit `0b97430` and the tag `1.0.0`: -`git changelog --start-commit {{0b97430}} --final-tag {{1.0.0}}` +`git changelog --start-commit {{0b97430}} {{[-f|--final-tag]}} {{1.0.0}}` - Specify `CHANGELOG.md` as the output file: @@ -35,4 +35,4 @@ source: https://github.com/tldr-pages/tldr.git - Replace contents of current changelog file entirely: -`git changelog --prune-old` +`git changelog {{[-p|--prune-old]}}` diff --git a/tldr/git-check-attr b/tldr/git-check-attr index 56d3cddc..df81442c 100644 --- a/tldr/git-check-attr +++ b/tldr/git-check-attr @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Check the values of all attributes on a file: -`git check-attr --all {{path/to/file}}` +`git check-attr {{[-a|--all]}} {{path/to/file}}` - Check the value of a specific attribute on a file: @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Check the values of all attributes on specific files: -`git check-attr --all {{path/to/file1 path/to/file2 ...}}` +`git check-attr {{[-a|--all]}} {{path/to/file1 path/to/file2 ...}}` - Check the value of a specific attribute on one or more files: diff --git a/tldr/git-check-ignore b/tldr/git-check-ignore index ae691953..4c24f3b6 100644 --- a/tldr/git-check-ignore +++ b/tldr/git-check-ignore @@ -26,4 +26,4 @@ source: https://github.com/tldr-pages/tldr.git - Include details about the matching pattern for each path: -`git check-ignore --verbose {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` +`git check-ignore {{[-v|--verbose]}} {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}` diff --git a/tldr/git-cherry-pick b/tldr/git-cherry-pick index 8b25c1a1..287ddc7e 100644 --- a/tldr/git-cherry-pick +++ b/tldr/git-cherry-pick @@ -23,4 +23,4 @@ source: https://github.com/tldr-pages/tldr.git - Add the changes of a commit to the working directory, without creating a commit: -`git cherry-pick --no-commit {{commit}}` +`git cherry-pick {{[-n|--no-commit]}} {{commit}}` diff --git a/tldr/git-cola b/tldr/git-cola index 538a411f..e619f429 100644 --- a/tldr/git-cola +++ b/tldr/git-cola @@ -22,8 +22,8 @@ source: https://github.com/tldr-pages/tldr.git - Open the Git repository at mentioned path: -`git cola --repo {{path/to/git-repository}}` +`git cola {{[-r|--repo]}} {{path/to/git-repository}}` - Apply the path filter to the status widget: -`git cola --status-filter {{filter}}` +`git cola {{[-s|--status-filter]}} {{filter}}` diff --git a/tldr/git-commit-tree b/tldr/git-commit-tree index 72bc3979..aa09c8e8 100644 --- a/tldr/git-commit-tree +++ b/tldr/git-commit-tree @@ -19,7 +19,7 @@ source: https://github.com/tldr-pages/tldr.git - Create a GPG-signed commit object: -`git commit-tree {{tree}} -m "{{message}}" --gpg-sign` +`git commit-tree {{tree}} -m "{{message}}" {{[-S|--gpg-sign]}}` - Create a commit object with the specified parent commit object: diff --git a/tldr/git-config b/tldr/git-config index 2f4d61dd..041292d4 100644 --- a/tldr/git-config +++ b/tldr/git-config @@ -15,7 +15,7 @@ source: https://github.com/tldr-pages/tldr.git - List local, global or system configuration entries and show their file location: -`git config --list --{{local|global|system}} --show-origin` +`git config {{[-l|--list]}} --{{local|global|system}} --show-origin` - Set the global value of a given configuration entry (in this case an alias): @@ -35,8 +35,8 @@ source: https://github.com/tldr-pages/tldr.git - Edit the local Git configuration (`.git/config`) in the default editor: -`git config --edit` +`git config {{[-e|--edit]}}` - Edit the global Git configuration (`~/.gitconfig` by default or `$XDG_CONFIG_HOME/git/config` if such a file exists) in the default editor: -`git config --global --edit` +`git config --global {{[-e|--edit]}}` diff --git a/tldr/git-count-objects b/tldr/git-count-objects index ef468f35..6ee19047 100644 --- a/tldr/git-count-objects +++ b/tldr/git-count-objects @@ -14,12 +14,12 @@ source: https://github.com/tldr-pages/tldr.git - Display a count of all objects and their total disk usage, displaying sizes in human-readable units: -`git count-objects --human-readable` +`git count-objects {{[-H|--human-readable]}}` - Display more verbose information: -`git count-objects --verbose` +`git count-objects {{[-v|--verbose]}}` - Display more verbose information, displaying sizes in human-readable units: -`git count-objects --human-readable --verbose` +`git count-objects {{[-H|--human-readable]}} {{[-v|--verbose]}}` diff --git a/tldr/git-extras b/tldr/git-extras index b5957f72..8185e705 100644 --- a/tldr/git-extras +++ b/tldr/git-extras @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # git extras > Git extension pack. -> More information: . +> More information: . - Install or upgrade `git-extras` commands: @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - Display help: -`git extras --help` +`git extras {{[-h|--help]}}` - Display version: -`git extras --version` +`git extras {{[-v|--version]}}` diff --git a/tldr/git-feature b/tldr/git-feature index 6a30fa97..cd30a030 100644 --- a/tldr/git-feature +++ b/tldr/git-feature @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Create or merge feature branches. > Feature branches obey the format feature/name. -> More information: . +> More information: . - Create and switch to a new feature branch: @@ -23,4 +23,4 @@ source: https://github.com/tldr-pages/tldr.git - Send changes from a specific feature branch to its remote counterpart: -`git feature {{feature_branch}} --remote {{remote_name}}` +`git feature {{feature_branch}} {{[-r|--remote]}} {{remote_name}}` diff --git a/tldr/git-for-each-repo b/tldr/git-for-each-repo index 09bc1e26..6416cdc8 100644 --- a/tldr/git-for-each-repo +++ b/tldr/git-for-each-repo @@ -11,8 +11,8 @@ source: https://github.com/tldr-pages/tldr.git - Run maintenance on each of a list of repositories stored in the `maintenance.repo` user configuration variable: -`git for-each-repo --config={{maintenance.repo}} {{maintenance run}}` +`git for-each-repo --config maintenance.repo {{maintenance run}}` - Run `git pull` on each repository listed in a global configuration variable: -`git for-each-repo --config={{global_configuration_variable}} {{pull}}` +`git for-each-repo --config {{global_configuration_variable}} {{pull}}` diff --git a/tldr/git-format-patch b/tldr/git-format-patch index 2ec9caee..1a6c41fc 100644 --- a/tldr/git-format-patch +++ b/tldr/git-format-patch @@ -17,6 +17,6 @@ source: https://github.com/tldr-pages/tldr.git `git format-patch {{revision_1}}..{{revision_2}}` -- Write a `.patch` file for the 3 latest commits: +- Write a `.patch` file for the `n` latest commits: -`git format-patch -{{3}}` +`git format-patch -{{n}}` diff --git a/tldr/git-guilt b/tldr/git-guilt index fa4302d2..ff2ff41d 100644 --- a/tldr/git-guilt +++ b/tldr/git-guilt @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Show total blame count for files with unstaged changes or calculate the change in blame between two revisions. > Part of `git-extras`. -> More information: . +> More information: . - Show total blame count: @@ -27,7 +27,7 @@ source: https://github.com/tldr-pages/tldr.git - Find blame delta over the last three weeks: -`git guilt 'git log --until="3 weeks ago" --format="%H" {{[-n|--max-count]}} 1'` +`git guilt 'git log --until "3 weeks ago" --format "%H" {{[-n|--max-count]}} 1'` - Find blame delta over the last three weeks (git 1.8.5+): diff --git a/tldr/git-info b/tldr/git-info index d5d95a0e..b7913c61 100644 --- a/tldr/git-info +++ b/tldr/git-info @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Display Git repository information. > Part of `git-extras`. -> More information: . +> More information: . - Display remote locations, remote and local branches, most recent commit data and `.git/config` settings: diff --git a/tldr/git-instaweb b/tldr/git-instaweb index ceda36dd..9ebd5802 100644 --- a/tldr/git-instaweb +++ b/tldr/git-instaweb @@ -14,19 +14,19 @@ source: https://github.com/tldr-pages/tldr.git - Listen only on localhost: -`git instaweb --start --local` +`git instaweb --start {{[-l|--local]}}` - Listen on a specific port: -`git instaweb --start --port {{1234}}` +`git instaweb --start {{[-p|--port]}} {{1234}}` - Use a specified HTTP daemon: -`git instaweb --start --httpd {{lighttpd|apache2|mongoose|plackup|webrick}}` +`git instaweb --start {{[-d|--httpd]}} {{lighttpd|apache2|mongoose|plackup|webrick}}` - Also auto-launch a web browser: -`git instaweb --start --browser` +`git instaweb --start {{[-b|--browser]}}` - Stop the currently running GitWeb server: diff --git a/tldr/git-lfs b/tldr/git-lfs index c9b41070..74a0fc49 100644 --- a/tldr/git-lfs +++ b/tldr/git-lfs @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # git lfs > Work with large files in Git repositories. -> More information: . +> More information: . - Initialize Git LFS: diff --git a/tldr/git-ls-files b/tldr/git-ls-files index 66390a16..93cf5d1c 100644 --- a/tldr/git-ls-files +++ b/tldr/git-ls-files @@ -10,16 +10,16 @@ source: https://github.com/tldr-pages/tldr.git - Show deleted files: -`git ls-files --deleted` +`git ls-files {{[-d|--deleted]}}` - Show modified and deleted files: -`git ls-files --modified` +`git ls-files {{[-m|--modified]}}` - Show ignored and untracked files: -`git ls-files --others` +`git ls-files {{[-o|--others]}}` - Show untracked files, not ignored: -`git ls-files --others --exclude-standard` +`git ls-files {{[-o|--others]}} --exclude-standard` diff --git a/tldr/git-merge b/tldr/git-merge index de6ed1ac..9e530dce 100644 --- a/tldr/git-merge +++ b/tldr/git-merge @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Edit the merge message: -`git merge --edit {{branch_name}}` +`git merge {{[-e|--edit]}} {{branch_name}}` - Merge a branch and create a merge commit: @@ -26,4 +26,4 @@ source: https://github.com/tldr-pages/tldr.git - Merge using a specific strategy: -`git merge --strategy {{strategy}} --strategy-option {{strategy_option}} {{branch_name}}` +`git merge {{[-s|--strategy]}} {{strategy}} {{[-X|--strategy-option]}} {{strategy_option}} {{branch_name}}` diff --git a/tldr/git-merge-base b/tldr/git-merge-base index d1fbfcfc..1b676bc0 100644 --- a/tldr/git-merge-base +++ b/tldr/git-merge-base @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Print all best common ancestors of two commits: -`git merge-base --all {{commit_1}} {{commit_2}}` +`git merge-base {{[-a|--all]}} {{commit_1}} {{commit_2}}` - Check if a commit is an ancestor of a specific commit: diff --git a/tldr/git-mergetool b/tldr/git-mergetool index a728f197..356d7dd0 100644 --- a/tldr/git-mergetool +++ b/tldr/git-mergetool @@ -18,15 +18,15 @@ source: https://github.com/tldr-pages/tldr.git - Launch the merge tool identified by a name: -`git mergetool --tool {{tool_name}}` +`git mergetool {{[-t|--tool]}} {{tool_name}}` - Don't prompt before each invocation of the merge tool: -`git mergetool --no-prompt` +`git mergetool {{[-y|--no-prompt]}}` - Explicitly use the GUI merge tool (see the `merge.guitool` configuration variable): -`git mergetool --gui` +`git mergetool {{[-g|--gui]}}` - Explicitly use the regular merge tool (see the `merge.tool` configuration variable): diff --git a/tldr/git-mv b/tldr/git-mv index 16ae3df2..0bab72b9 100644 --- a/tldr/git-mv +++ b/tldr/git-mv @@ -18,4 +18,4 @@ source: https://github.com/tldr-pages/tldr.git - Overwrite the file or directory in the target path if it exists: -`git mv --force {{path/to/file_or_directory}} {{path/to/destination}}` +`git mv {{[-f|--force]}} {{path/to/file_or_directory}} {{path/to/destination}}` diff --git a/tldr/git-prune b/tldr/git-prune index b92a17d5..e9e27e3b 100644 --- a/tldr/git-prune +++ b/tldr/git-prune @@ -11,11 +11,11 @@ source: https://github.com/tldr-pages/tldr.git - Report what would be removed by Git prune without removing it: -`git prune --dry-run` +`git prune {{[-n|--dry-run]}}` - Prune unreachable objects and display what has been pruned to `stdout`: -`git prune --verbose` +`git prune {{[-v|--verbose]}}` - Prune unreachable objects while showing progress: diff --git a/tldr/git-psykorebase b/tldr/git-psykorebase index 77d52b03..82ad3788 100644 --- a/tldr/git-psykorebase +++ b/tldr/git-psykorebase @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Rebase a branch on top of another using a merge commit and only one conflict handling. > Part of `git-extras`. -> More information: . +> More information: . - Rebase the current branch on top of another using a merge commit and only one conflict handling: diff --git a/tldr/git-reauthor b/tldr/git-reauthor index 7e752a67..3062e1ed 100644 --- a/tldr/git-reauthor +++ b/tldr/git-reauthor @@ -11,12 +11,12 @@ source: https://github.com/tldr-pages/tldr.git - Change an author's email and name across the whole Git repository: -`git reauthor --old-email {{old@example.com}} --correct-email {{new@example.com}} --correct-name "{{name}}"` +`git reauthor {{[-o|--old-email]}} {{old@example.com}} {{[-e|--correct-email]}} {{new@example.com}} {{[-n|--correct-name]}} "{{name}}"` - Change the email and name to the ones defined in the Git config: -`git reauthor --old-email {{old@example.com}} --use-config` +`git reauthor {{[-o|--old-email]}} {{old@example.com}} {{[-c|--use-config]}}` - Change the email and name of all commits, regardless of their original author: -`git reauthor --all --correct-email {{name@example.com}} --correct-name {{name}}` +`git reauthor {{[-a|--all]}} {{[-e|--correct-email]}} {{name@example.com}} {{[-n|--correct-name]}} {{name}}` diff --git a/tldr/git-release b/tldr/git-release index fbbfac54..d90027d9 100644 --- a/tldr/git-release +++ b/tldr/git-release @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Create a Git tag for a release. > Part of `git-extras`. -> More information: . +> More information: . - Create and push a release: diff --git a/tldr/git-reset b/tldr/git-reset index 8c4c194e..21d3100f 100644 --- a/tldr/git-reset +++ b/tldr/git-reset @@ -19,7 +19,7 @@ source: https://github.com/tldr-pages/tldr.git - Interactively unstage portions of a file: -`git reset --patch {{path/to/file}}` +`git reset {{[-p|--patch]}} {{path/to/file}}` - Undo the last commit, keeping its changes (and any further uncommitted changes) in the filesystem: diff --git a/tldr/git-restore b/tldr/git-restore index 8114aaf6..0db61a9a 100644 --- a/tldr/git-restore +++ b/tldr/git-restore @@ -15,7 +15,7 @@ source: https://github.com/tldr-pages/tldr.git - Restore an unstaged file to the version of a specific commit: -`git restore --source {{commit}} {{path/to/file}}` +`git restore {{[-s|--source]}} {{commit}} {{path/to/file}}` - Discard all unstaged changes to tracked files: @@ -23,16 +23,16 @@ source: https://github.com/tldr-pages/tldr.git - Unstage a file: -`git restore --staged {{path/to/file}}` +`git restore {{[-S|--staged]}} {{path/to/file}}` - Unstage all files: -`git restore --staged :/` +`git restore {{[-S|--staged]}} :/` - Discard all changes to files, both staged and unstaged: -`git restore --worktree --staged :/` +`git restore {{[-W|--worktree]}} {{[-S|--staged]}} :/` - Interactively select sections of files to restore: -`git restore --patch` +`git restore {{[-p|--patch]}}` diff --git a/tldr/git-show-index b/tldr/git-show-index index 4646c70f..e3b1bed4 100644 --- a/tldr/git-show-index +++ b/tldr/git-show-index @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Specify the hash algorithm for the index file (experimental): -`git show-index --object-format={{sha1|sha256}} {{path/to/file}}` +`git show-index --object-format {{sha1|sha256}} {{path/to/file}}` diff --git a/tldr/git-squash b/tldr/git-squash index 0143a142..2d581c58 100644 --- a/tldr/git-squash +++ b/tldr/git-squash @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Squash multiple commits into a single commit. > Part of `git-extras`. -> More information: . +> More information: . - Merge all commits from a specific branch into the current branch as a single commit: diff --git a/tldr/git-stamp b/tldr/git-stamp index a7813430..edf8845a 100644 --- a/tldr/git-stamp +++ b/tldr/git-stamp @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Stamp the last commit message, with the possibility to reference the issues numbers from your bug tracker or link to its review page. > Part of `git-extras`. -> More information: . +> More information: . - Stamp the last commit message referencing it with the issue number from your bug tracker: @@ -19,4 +19,4 @@ source: https://github.com/tldr-pages/tldr.git - Stamp the last commit message replacing previous issues with a new one: -`git stamp --replace {{issue_number}}` +`git stamp {{[-r|--replace]}} {{issue_number}}` diff --git a/tldr/git-stripspace b/tldr/git-stripspace index 559e0b79..c33a5429 100644 --- a/tldr/git-stripspace +++ b/tldr/git-stripspace @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - Trim whitespace and Git comments from a file: -`cat {{path/to/file}} | git stripspace --strip-comments` +`cat {{path/to/file}} | git stripspace {{[-s|--strip-comments]}}` - Convert all lines in a file into Git comments: -`git stripspace --comment-lines < {{path/to/file}}` +`git stripspace {{[-c|--comment-lines]}} < {{path/to/file}}` diff --git a/tldr/git-summary b/tldr/git-summary index 9ebf3e63..df062fd6 100644 --- a/tldr/git-summary +++ b/tldr/git-summary @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Display information about a Git repository. > Part of `git-extras`. -> More information: . +> More information: . - Display data about a Git repository: diff --git a/tldr/git-verify-pack b/tldr/git-verify-pack index c7bfbc84..f349c265 100644 --- a/tldr/git-verify-pack +++ b/tldr/git-verify-pack @@ -14,8 +14,8 @@ source: https://github.com/tldr-pages/tldr.git - Verify a packed Git archive file and show verbose details: -`git verify-pack --verbose {{path/to/pack-file}}` +`git verify-pack {{[-v|--verbose]}} {{path/to/pack-file}}` - Verify a packed Git archive file and only display the statistics: -`git verify-pack --stat-only {{path/to/pack-file}}` +`git verify-pack {{[-s|--stat-only]}} {{path/to/pack-file}}` diff --git a/tldr/git-verify-tag b/tldr/git-verify-tag index a68a531a..2b7f6929 100644 --- a/tldr/git-verify-tag +++ b/tldr/git-verify-tag @@ -15,7 +15,7 @@ source: https://github.com/tldr-pages/tldr.git - Check tags for a GPG signature and show details for each tag: -`git verify-tag {{tag1 optional_tag2 ...}} --verbose` +`git verify-tag {{tag1 optional_tag2 ...}} {{[-v|--verbose]}}` - Check tags for a GPG signature and print the raw details: diff --git a/tldr/git-whatchanged b/tldr/git-whatchanged index b2d11a43..63b88c5c 100644 --- a/tldr/git-whatchanged +++ b/tldr/git-whatchanged @@ -15,7 +15,7 @@ source: https://github.com/tldr-pages/tldr.git - Display logs and changes for recent commits within the specified time frame: -`git whatchanged --since="{{2 hours ago}}"` +`git whatchanged --since "{{2 hours ago}}"` - Display logs and changes for recent commits for specific files or directories: diff --git a/tldr/linux/create-image b/tldr/linux/create-image new file mode 100644 index 00000000..b7286c66 --- /dev/null +++ b/tldr/linux/create-image @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# create-image + +> Create CPIO images. +> More information: . + +- Create a CPIO archive from the current directory: + +`create-image {{[-o|--output]}} {{path/to/output.cpio}}` + +- Display help: + +`create-image {{[-h|--help]}}` diff --git a/tldr/linux/lscpu b/tldr/linux/lscpu index 96c45d88..d8fa9eae 100644 --- a/tldr/linux/lscpu +++ b/tldr/linux/lscpu @@ -16,6 +16,18 @@ source: https://github.com/tldr-pages/tldr.git `lscpu {{[-e|--extended]}}` +- Display only information about online CPUs in a table: + +`lscpu {{[-e|--extended]}} {{[-b|--online]}}` + - Display only information about offline CPUs in a table: `lscpu {{[-e|--extended]}} {{[-c|--offline]}}` + +- Display details about CPU caches: + +`lscpu {{[-C|--caches]}}` + +- Display information in JSON format: + +`lscpu {{[-J|--json]}}` diff --git a/tldr/linux/lsusb b/tldr/linux/lsusb index 20f5cef2..89174437 100644 --- a/tldr/linux/lsusb +++ b/tldr/linux/lsusb @@ -18,11 +18,11 @@ source: https://github.com/tldr-pages/tldr.git - List verbose information about USB devices: -`lsusb {{[-V|--verbose]}}` +`lsusb {{[-v|--verbose]}}` - List detailed information about a USB device: -`lsusb {{[-V|--verbose]}} -s {{bus}}:{{device number}}` +`lsusb {{[-v|--verbose]}} -s {{bus}}:{{device number}}` - List devices with a specified vendor and product ID only: diff --git a/tldr/rustup-install b/tldr/rustup-install index 3fc09f63..8f66c545 100644 --- a/tldr/rustup-install +++ b/tldr/rustup-install @@ -5,10 +5,8 @@ source: https://github.com/tldr-pages/tldr.git --- # rustup install -> Install or update Rust toolchains. -> This command is an alias of `rustup update`, but can only install/update one toolchain at a time. -> More information: . +> This command is an alias of `rustup toolchain install`. -- Install or update a specific toolchain (see `rustup help toolchain` for more information): +- View documentation for the original command: -`rustup install {{toolchain}}` +`tldr rustup toolchain` diff --git a/tldr/rustup-uninstall b/tldr/rustup-uninstall new file mode 100644 index 00000000..e640481d --- /dev/null +++ b/tldr/rustup-uninstall @@ -0,0 +1,12 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# rustup uninstall + +> This command is an alias of `rustup toolchain uninstall`. + +- View documentation for the original command: + +`tldr rustup toolchain` diff --git a/tldr/ykman-config b/tldr/ykman-config index 4760fdbc..c473f179 100644 --- a/tldr/ykman-config +++ b/tldr/ykman-config @@ -11,12 +11,12 @@ source: https://github.com/tldr-pages/tldr.git - Enable an application over USB or NFC (`--enable` can be used multiple times to specify more applications): -`ykman config {{usb|nfc}} --enable {{otp|u2f|fido2|oath|piv|openpgp|hsmauth}}` +`ykman config {{usb|nfc}} {{[-e|--enable]}} {{otp|u2f|fido2|oath|piv|openpgp|hsmauth}}` - Disable an application over USB or NFC (`--disable` can be used multiple times to specify more applications): -`ykman config {{usb|nfc}} --disable {{otp|u2f|fido2|oath|piv|openpgp|hsmauth}}` +`ykman config {{usb|nfc}} {{[-d|--disable]}} {{otp|u2f|fido2|oath|piv|openpgp|hsmauth}}` - Disable all applications over NFC: -`ykman config nfc --disable-all` +`ykman config nfc {{[-D|--disable-all]}}` diff --git a/tldr/ykman-oath b/tldr/ykman-oath index f2da074f..1ff34eb8 100644 --- a/tldr/ykman-oath +++ b/tldr/ykman-oath @@ -17,9 +17,9 @@ source: https://github.com/tldr-pages/tldr.git `ykman oath access change` -- Add a new account (`--issuer` is optional): +- Add a new account (the issuer is optional): -`ykman oath accounts add --issuer {{issuer}} {{name}}` +`ykman oath accounts add {{[-i|--issuer]}} {{issuer}} {{name}}` - List all accounts (with their issuers):