diff --git a/tldr/argos-translate b/tldr/argos-translate index 4f0ea22c..f5c3aabf 100644 --- a/tldr/argos-translate +++ b/tldr/argos-translate @@ -12,7 +12,7 @@ source: https://github.com/tldr-pages/tldr.git `argospm install translate-es_en` -- Translate some text from Spanish (`es`) to English (`en`) (Note: only two letter language codes are supported): +- Translate some text from Spanish (`es`) to English (`en`) (Note: Only two letter language codes are supported): `argos-translate --from-lang es --to-lang en {{un texto corto}}` @@ -32,6 +32,6 @@ source: https://github.com/tldr-pages/tldr.git `argospm update` -- Translate from `ar` to `ru` (Note: this requires the translation pairs `translate-ar_en` and `translate-en_ru` to be installed): +- Translate from `ar` to `ru` (Note: This requires the translation pairs `translate-ar_en` and `translate-en_ru` to be installed): `argos-translate --from-lang ar --to-lang ru {{صورة تساوي أكثر من ألف كلمة}}` diff --git a/tldr/bfg b/tldr/bfg index 1623e39e..a4977345 100644 --- a/tldr/bfg +++ b/tldr/bfg @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # bfg > Remove large files or passwords from Git history like git-filter-branch. -> Note: if your repository is connected to a remote, you will need to force push to it. +> Note: If your repository is connected to a remote, you will need to force push to it. > More information: . - Remove a file with sensitive data but leave the latest commit untouched: diff --git a/tldr/calibre-server b/tldr/calibre-server index 361009c2..27230d9c 100644 --- a/tldr/calibre-server +++ b/tldr/calibre-server @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # calibre-server > A server application to distribute e-books over a network. -> Note: e-books must already be imported into the library using the GUI or the `calibredb` CLI. +> Note: E-books must already be imported into the library using the GUI or the `calibredb` CLI. > Part of the Calibre e-book library. > More information: . diff --git a/tldr/cargo-metadata b/tldr/cargo-metadata index 3b93f338..27e9023e 100644 --- a/tldr/cargo-metadata +++ b/tldr/cargo-metadata @@ -21,6 +21,6 @@ source: https://github.com/tldr-pages/tldr.git `cargo metadata --format-version {{version}}` -- Print metadata with the `resolve` field including dependencies only for the given target triple (Note: the `packages` array will still include the dependencies for all targets): +- Print metadata with the `resolve` field including dependencies only for the given target triple (Note: The `packages` array will still include the dependencies for all targets): `cargo metadata --filter-platform {{target_triple}}` diff --git a/tldr/cargo-publish b/tldr/cargo-publish index cbf88811..c201d315 100644 --- a/tldr/cargo-publish +++ b/tldr/cargo-publish @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # cargo publish > Upload a package to a registry. -> Note: you have to add an authentication token using `cargo login` before publishing a package. +> Note: You have to add an authentication token using `cargo login` before publishing a package. > More information: . - Perform checks, create a `.crate` file and upload it to the registry: diff --git a/tldr/cargo-run b/tldr/cargo-run index 00443ccb..3c32fac2 100644 --- a/tldr/cargo-run +++ b/tldr/cargo-run @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # cargo run > Run the current Cargo package. -> Note: the working directory of the executed binary will be set to the current working directory. +> Note: The working directory of the executed binary will be set to the current working directory. > More information: . - Run the default binary target: diff --git a/tldr/cargo-tree b/tldr/cargo-tree index 1dde10a3..f193c741 100644 --- a/tldr/cargo-tree +++ b/tldr/cargo-tree @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # cargo tree > Display a tree visualization of a dependency graph. -> Note: in the tree, dependencies of packages marked with `(*)` have already been shown elsewhere in the graph, and so are not repeated. +> Note: In the tree, dependencies of packages marked with `(*)` have already been shown elsewhere in the graph, and so are not repeated. > More information: . - Show a dependency tree of the current project: diff --git a/tldr/cargo-yank b/tldr/cargo-yank index bb40f5c4..76ea6575 100644 --- a/tldr/cargo-yank +++ b/tldr/cargo-yank @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # cargo yank > Remove a pushed crate from the index. This should only be used when you accidentally release a significantly broken crate. -> Note: this does not remove any data. The crate is still present after a yank - this just prevents new projects from using it. +> Note: This does not remove any data. The crate is still present after a yank - this just prevents new projects from using it. > More information: . - Yank the specified version of a crate: diff --git a/tldr/ccache b/tldr/ccache index 4d3e4fe7..600db3cd 100644 --- a/tldr/ccache +++ b/tldr/ccache @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # ccache > C/C++ compiler cache. -> Note: packages usually provide symlinks for compilers in `/usr/lib/ccache/bin`. Prepend this directory to `$PATH` to automatically use `ccache` for them. +> 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 statistics: diff --git a/tldr/cksum b/tldr/cksum index c3e5c036..ab2f73e4 100644 --- a/tldr/cksum +++ b/tldr/cksum @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # cksum > Calculate CRC checksums and byte counts of a file. -> Note: on old UNIX systems the CRC implementation may differ. +> Note: On old UNIX systems the CRC implementation may differ. > More information: . - Display a 32-bit checksum, size in bytes and filename: diff --git a/tldr/convert b/tldr/convert index 1d165da1..23ccca41 100644 --- a/tldr/convert +++ b/tldr/convert @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # convert > This command is an alias of `magick convert`. -> Note: this alias is deprecated since ImageMagick 7. It has been replaced by `magick`. +> Note: This alias is deprecated since ImageMagick 7. It has been replaced by `magick`. > Use `magick convert` if you need to use the old tool in versions 7+. - View documentation for the original command: diff --git a/tldr/cupsaccept b/tldr/cupsaccept index 147bc224..61d27f23 100644 --- a/tldr/cupsaccept +++ b/tldr/cupsaccept @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # cupsaccept > Accept jobs sent to destinations. -> Note: destination is referred as a printer or a class of printers. +> Note: Destination is referred as a printer or a class of printers. > See also: `cupsreject`, `cupsenable`, `cupsdisable`, `lpstat`. > More information: . diff --git a/tldr/cupsdisable b/tldr/cupsdisable index d279b257..8a3d7b41 100644 --- a/tldr/cupsdisable +++ b/tldr/cupsdisable @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # cupsdisable > Stop printers and classes. -> Note: destination is referred as a printer or a class of printers. +> Note: Destination is referred as a printer or a class of printers. > See also: `cupsenable`, `cupsaccept`, `cupsreject`, `lpstat`. > More information: . diff --git a/tldr/cupsenable b/tldr/cupsenable index 794a943c..c0565313 100644 --- a/tldr/cupsenable +++ b/tldr/cupsenable @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # cupsenable > Start printers and classes. -> Note: destination is referred as a printer or a class of printers. +> Note: Destination is referred as a printer or a class of printers. > See also: `cupsdisable`, `cupsaccept`, `cupsreject`, `lpstat`. > More information: . diff --git a/tldr/cupsreject b/tldr/cupsreject index d737df8c..3cbd5ec0 100644 --- a/tldr/cupsreject +++ b/tldr/cupsreject @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # cupsreject > Reject jobs sent to printers. -> Note: destination is referred as a printer or a class of printers. +> Note: Destination is referred as a printer or a class of printers. > See also: `cupsaccept`, `cupsenable`, `cupsdisable`, `lpstat`. > More information: . diff --git a/tldr/cupstestppd b/tldr/cupstestppd index 8a8641b7..ae3ffaef 100644 --- a/tldr/cupstestppd +++ b/tldr/cupstestppd @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Test conformance of PPD files to the version 4.3 of the specification. > Error codes (1, 2, 3 and 4, respectively): bad CLI arguments, unable to open file, unskippable format errors and non-conformance with PPD specification. -> Note: this command is deprecated. +> Note: This command is deprecated. > See also: `lpadmin`. > More information: . diff --git a/tldr/d2 b/tldr/d2 index 851bd6a6..5680721b 100644 --- a/tldr/d2 +++ b/tldr/d2 @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # d2 > A modern diagram scripting language that turns text to diagrams. -> Note: the output file supports SVG and PNG file formats. +> Note: The output file supports SVG and PNG file formats. > More information: . - Compile and render a D2 source file into an output file: diff --git a/tldr/dbx b/tldr/dbx index fd31cae4..0fd37a7f 100644 --- a/tldr/dbx +++ b/tldr/dbx @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # dbx > Interact with the Databricks platform. -> Note: this tool has been retired and it is recommended to use Databricks Asset Bundles instead. +> Note: This tool has been retired and it is recommended to use Databricks Asset Bundles instead. > More information: . - Create a new `dbx` project in the current working directory: diff --git a/tldr/dnsx b/tldr/dnsx index efac7def..4cf8d1d0 100644 --- a/tldr/dnsx +++ b/tldr/dnsx @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # dnsx > 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. +> Note: Input to `dnsx` needs to be passed through `stdin` (pipe `|`) in some cases. > See also: `dig`, `dog`, `dnstracer`. > More information: . diff --git a/tldr/echo b/tldr/echo index a3d0b361..e3a7fb02 100644 --- a/tldr/echo +++ b/tldr/echo @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Print given arguments. > More information: . -- Print a text message. Note: quotes are optional: +- Print a text message. Note: Quotes are optional: `echo "{{Hello World}}"` diff --git a/tldr/filecheck b/tldr/filecheck index ae745f80..c0aab389 100644 --- a/tldr/filecheck +++ b/tldr/filecheck @@ -17,7 +17,7 @@ source: https://github.com/tldr-pages/tldr.git `echo "{{some_text}}" | FileCheck {{path/to/check_file}}` -- Match with the specified custom check `prefix` (Note: the default prefix is `CHECK`): +- Match with the specified custom check `prefix` (Note: The default prefix is `CHECK`): `echo "{{some_text}}" | FileCheck --check-prefix={{prefix}} {{path/to/check_file}}` diff --git a/tldr/ghostty b/tldr/ghostty index 22916db5..297ad245 100644 --- a/tldr/ghostty +++ b/tldr/ghostty @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # ghostty > A fast, feature-rich, and cross-platform terminal emulator that uses platform-native UI and GPU acceleration. -> Note: all options from the configuration file can also be used on the command-line (using `--option=argument`). +> Note: All options from the configuration file can also be used on the command-line (using `--option=argument`). > More information: . - Open a new Ghostty window (not supported on macOS): diff --git a/tldr/git b/tldr/git index 2e1ebc28..a6ea43a1 100644 --- a/tldr/git +++ b/tldr/git @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Distributed version control system. > Some subcommands such as `commit`, `add`, `branch`, `checkout`, `push`, etc. have their own usage documentation. -> More information: . +> More information: . - Execute a Git subcommand: diff --git a/tldr/git-apply b/tldr/git-apply index 8683193f..bf57a97b 100644 --- a/tldr/git-apply +++ b/tldr/git-apply @@ -11,7 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - Print messages about the patched files: -`git apply --verbose {{path/to/file}}` +`git apply {{[-v|--verbose]}} {{path/to/file}}` - Apply and add the patched files to the index: @@ -19,7 +19,7 @@ source: https://github.com/tldr-pages/tldr.git - Apply a remote patch file: -`curl -L {{https://example.com/file.patch}} | git apply` +`curl {{[-L|--location]}} {{https://example.com/file.patch}} | git apply` - Output diffstat for the input and apply the patch: @@ -27,7 +27,7 @@ source: https://github.com/tldr-pages/tldr.git - Apply the patch in reverse: -`git apply --reverse {{path/to/file}}` +`git apply {{[-R|--reverse]}} {{path/to/file}}` - Store the patch result in the index without modifying the working tree: diff --git a/tldr/git-for-each-repo b/tldr/git-for-each-repo index 403d96a4..09bc1e26 100644 --- a/tldr/git-for-each-repo +++ b/tldr/git-for-each-repo @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # git for-each-repo > Run a Git command on a list of repositories. -> Note: this command is experimental and may change. +> Note: This command is experimental and may change. > More information: . - Run maintenance on each of a list of repositories stored in the `maintenance.repo` user configuration variable: diff --git a/tldr/golangci-lint b/tldr/golangci-lint index 1854403f..9d2415e6 100644 --- a/tldr/golangci-lint +++ b/tldr/golangci-lint @@ -12,7 +12,7 @@ source: https://github.com/tldr-pages/tldr.git `golangci-lint run` -- List enabled and disabled linters (Note: disabled linters are shown last, do not mistake them for enabled ones): +- List enabled and disabled linters (Note: Disabled linters are shown last, do not mistake them for enabled ones): `golangci-lint linters` diff --git a/tldr/hledger b/tldr/hledger index 8dd6eb2b..f36ff830 100644 --- a/tldr/hledger +++ b/tldr/hledger @@ -31,7 +31,7 @@ source: https://github.com/tldr-pages/tldr.git - Show monthly incomes/expenses/totals, largest first, summarised to 2 levels: -`hledger {{[is|incomestatement]}} {{[-M|--monthly]}} {{[-T|--row-total]}} {{[-A|--average]}} --sort --depth 2` +`hledger {{[is|incomestatement]}} {{[-M|--monthly]}} {{[-T|--row-total]}} {{[-A|--average]}} --sort {{[-2|--depth 2]}}` - Show the `assets:bank:checking` account's transactions and running balance: diff --git a/tldr/hledger-accounts b/tldr/hledger-accounts index 5fb9f451..1d2ebcfe 100644 --- a/tldr/hledger-accounts +++ b/tldr/hledger-accounts @@ -34,8 +34,4 @@ source: https://github.com/tldr-pages/tldr.git - Show the first two levels of the accounts hierarchy: -`hledger {{[acc|accounts]}} {{[-t|--tree]}} --depth 2` - -- Short form of the above: - -`hledger acc -t -2` +`hledger {{[acc|accounts]}} {{[-t|--tree]}} {{[-2|--depth 2]}}` diff --git a/tldr/hledger-balance b/tldr/hledger-balance index bc9d5d06..694916b4 100644 --- a/tldr/hledger-balance +++ b/tldr/hledger-balance @@ -15,28 +15,28 @@ source: https://github.com/tldr-pages/tldr.git - Show the balance change in accounts named `*expenses*`, as a tree, summarising the top two levels only: -`hledger {{[bal|balance]}} {{expenses}} {{[-t|--tree]}} --depth {{2}}` +`hledger {{[bal|balance]}} {{expenses}} {{[-t|--tree]}} {{[-2|--depth 2]}}` - Show expenses each month, and their totals and averages, sorted by total; and their monthly budget goals: `hledger {{[bal|balance]}} {{expenses}} {{[-M|--monthly]}} {{[-T|--row-total]}} {{[-A|--average]}} {{[-S|--sort-amount]}} --budget` -- Similar to the above, shorter form, matching accounts by `Expense` type, as a two level tree without squashing boring accounts: +- Similar to the above, matching accounts by `Expense` type, as a two level tree without squashing boring accounts: -`hledger bal type:{{X}} -MTAS --budget -t -{{2}} --no-elide` +`hledger {{[bal|balance]}} type:{{X}} {{[-MTAS|--monthly --row-total --average --sort-amount]}} --budget {{[-t|--tree]}} {{[-2|--depth 2]}} --no-elide` - Show end balances (including from postings before the start date), quarterly in 2024, in accounts named `*assets*` or `*liabilities*`: `hledger {{[bal|balance]}} {{[-H|--historical]}} {{[-p|--period]}} '{{quarterly in 2024}}' {{assets}} {{liabilities}}` -- Similar to the above, shorter form; also show zero balances, sort by total and summarise to three levels: +- Similar to the above, also show zero balances, sort by total and summarise to three levels: -`hledger bal -HQ date:{{2024}} type:{{AL}} -ES -{{3}}` +`hledger {{[bal|balance]}} {{[-HQ|--historical --quarterly]}} date:{{2024}} type:{{AL}} {{[-ES|--empty --sort-amount]}} {{[-3|--depth 3]}}` -- Show investment assets' market value in base currency at the end of each quarter: +- Show investment assets' market [V]alue in base currency at the end of each quarter: -`hledger bal -HVQ {{assets:investments}}` +`hledger {{[bal|balance]}} {{[-HVQ|--historical --market --quarterly]}} {{assets:investments}}` - Show unrealised capital gains/losses from market price changes in each quarter, for non-cryptocurrency investment assets: -`hledger bal --gain -Q {{assets:investments}} not:{{cryptocurrency}}` +`hledger {{[bal|balance]}} --gain {{[-Q|--quarterly]}} {{assets:investments}} not:{{cryptocurrency}}` diff --git a/tldr/hledger-balancesheet b/tldr/hledger-balancesheet index f627a14f..4fb4ce99 100644 --- a/tldr/hledger-balancesheet +++ b/tldr/hledger-balancesheet @@ -33,6 +33,6 @@ source: https://github.com/tldr-pages/tldr.git `hledger {{[bs|balancesheet]}} {{[-Qt|--quarterly --tree]}} {{[-2|--depth 2]}}` -- Short form of the above, and generate HTML output in `bs.html`: +- Same as above above, and generate HTML output in `bs.html`: -`hledger bs -Qt -2 -o bs.html` +`hledger {{[bs|balancesheet]}} {{[-Qt|--quarterly --tree]}} {{[-2|--depth 2]}} {{[-o|--output-file]}} bs.html` diff --git a/tldr/hledger-incomestatement b/tldr/hledger-incomestatement index 24d492e4..226fb455 100644 --- a/tldr/hledger-incomestatement +++ b/tldr/hledger-incomestatement @@ -21,6 +21,6 @@ source: https://github.com/tldr-pages/tldr.git `hledger {{[is|incomestatement]}} {{[-MTAS|--monthly --row-total --average --sort-amount]}} {{[-2|--depth 2]}}` -- Short form of the above, and generate HTML output in `is.html`: +- Same as above, and generate HTML output in `is.html`: -`hledger is -MTAS -2 -o is.html` +`hledger {{[is|incomestatement]}} {{[-MTAS|--monthly --row-total --average --sort-amount]}} {{[-2|--depth 2]}} {{[-o|--output-file]}} is.html` diff --git a/tldr/hledger-ui b/tldr/hledger-ui index ded3d81d..27848a2e 100644 --- a/tldr/hledger-ui +++ b/tldr/hledger-ui @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Start in the balance sheet accounts screen, showing hierarchy down to level 3: -`hledger-ui --bs {{[-t|--tree]}} --depth 3` +`hledger-ui --bs {{[-t|--tree]}} {{[-3|--depth 3]}}` - Start in this account's screen, showing cleared transactions, and reload on change: diff --git a/tldr/httpx b/tldr/httpx index 68921e44..c367ef4c 100644 --- a/tldr/httpx +++ b/tldr/httpx @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # httpx > 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. +> Note: Not to be confused with the unrelated Python's HTTPX which has the same command name. > More information: . - Run a probe against a [u]RL, host, IP Address or subnet (CIDR notation) showing probe status: diff --git a/tldr/hugo b/tldr/hugo index 015ffa11..f3367dbe 100644 --- a/tldr/hugo +++ b/tldr/hugo @@ -31,7 +31,7 @@ source: https://github.com/tldr-pages/tldr.git - Build a site on your local IP: -`hugo server --bind {{local-ip}} --baseURL {{http://local-ip}}` +`hugo server --bind {{local_ip}} --baseURL {{http://local_ip}}` - Build a site to a given directory: diff --git a/tldr/hydra b/tldr/hydra index 17321c1b..da2e0560 100644 --- a/tldr/hydra +++ b/tldr/hydra @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Online password guessing tool. > Protocols supported include FTP, HTTP(S), SMTP, SNMP, XMPP, SSH, and more. -> More information: . +> More information: . - Start Hydra's wizard: diff --git a/tldr/iex b/tldr/iex index f53ba85b..77b4af8c 100644 --- a/tldr/iex +++ b/tldr/iex @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # iex > IEx is the interactive shell for Elixir. -> More information: . +> More information: . - Start an interactive session: diff --git a/tldr/initdb b/tldr/initdb index c497b33d..00223bb2 100644 --- a/tldr/initdb +++ b/tldr/initdb @@ -10,4 +10,4 @@ source: https://github.com/tldr-pages/tldr.git - Create a database at `/usr/local/var/postgres`: -`initdb -D /usr/local/var/postgres` +`initdb {{[-D|--pgdata]}} /usr/local/var/postgres` diff --git a/tldr/ippeveps b/tldr/ippeveps index 5ab4ae88..08453907 100644 --- a/tldr/ippeveps +++ b/tldr/ippeveps @@ -16,4 +16,4 @@ source: https://github.com/tldr-pages/tldr.git - Print a file from `stdin` to `stdout`: -`{{wget -O - https://examplewebsite.com/file}} | ippeveps` +`{{wget {{[-O|--output-document]}} - https://examplewebsite.com/file}} | ippeveps` diff --git a/tldr/jdupes b/tldr/jdupes index 613aa0df..2922a55d 100644 --- a/tldr/jdupes +++ b/tldr/jdupes @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # jdupes -> A powerful duplicate file finder and an enhanced fork of fdupes. +> A powerful duplicate file finder and an enhanced fork of `fdupes`. > More information: . - Search a single directory: @@ -18,16 +18,16 @@ source: https://github.com/tldr-pages/tldr.git - Search all directories recursively: -`jdupes --recurse {{path/to/directory}}` +`jdupes {{[-r|--recurse]}} {{path/to/directory}}` - Search directory recursively and let user choose files to preserve: -`jdupes --delete --recurse {{path/to/directory}}` +`jdupes {{[-d|--delete]}} {{[-r|--recurse]}} {{path/to/directory}}` - Search multiple directories and follow subdirectores under directory2, not directory1: -`jdupes {{directory1}} --recurse: {{directory2}}` +`jdupes {{directory1}} {{[-R|--recurse:]}} {{directory2}}` - Search multiple directories and keep the directory order in result: -`jdupes -O {{directory1 directory2 directory3 ...}}` +`jdupes {{[-O|--param-order]}} {{directory1 directory2 directory3 ...}}` diff --git a/tldr/lex b/tldr/lex index daf51506..32360fdf 100644 --- a/tldr/lex +++ b/tldr/lex @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Lexical analyzer generator. > Given the specification for a lexical analyzer, generates C code implementing it. -> Note: on most major OSes, this command is an alias for `flex`. +> Note: On most major OSes, this command is an alias for `flex`. > More information: . - Generate an analyzer from a Lex file, storing it to the file `lex.yy.c`: diff --git a/tldr/limactl b/tldr/limactl index f62a014e..bc60f73a 100644 --- a/tldr/limactl +++ b/tldr/limactl @@ -15,7 +15,7 @@ source: https://github.com/tldr-pages/tldr.git - Create a VM using the default settings and optionally provide a name and/or a template (see `limactl create --list-templates` for available templates): -`limactl create --name {{vm_name}} template://{{debian|fedora|ubuntu|…}}` +`limactl create --name {{vm_name}} template://{{debian|fedora|ubuntu|...}}` - Start a VM (this might install some dependencies in it and take a few minutes): diff --git a/tldr/linode-cli-volumes b/tldr/linode-cli-volumes index 1ec13632..de90b8bf 100644 --- a/tldr/linode-cli-volumes +++ b/tldr/linode-cli-volumes @@ -25,7 +25,7 @@ source: https://github.com/tldr-pages/tldr.git `linode-cli volumes detach {{volume_id}}` -- Resize a Volume (Note: size can only be increased): +- Resize a Volume (Note: Size can only be increased): `linode-cli volumes resize {{volume_id}} --size {{new_size_in_GB}}` diff --git a/tldr/linux/abroot b/tldr/linux/abroot index 7d99e930..23b7e727 100644 --- a/tldr/linux/abroot +++ b/tldr/linux/abroot @@ -9,11 +9,11 @@ source: https://github.com/tldr-pages/tldr.git > Updates are performed using OCI images, to ensure that the system is always in a consistent state. > More information: . -- Add packages to the local image (Note: after executing this command, you need to apply these changes.): +- Add packages to the local image (Note: After executing this command, you need to apply these changes.): `sudo abroot pkg add {{package}}` -- Remove packages from the local image (Note: after executing this command, you need to apply these changes.): +- Remove packages from the local image (Note: After executing this command, you need to apply these changes.): `sudo abroot pkg remove {{package}}` @@ -21,7 +21,7 @@ source: https://github.com/tldr-pages/tldr.git `sudo abroot pkg list` -- Apply changes in the local image (Note: you need to reboot your system for these changes to be applied): +- Apply changes in the local image (Note: You need to reboot your system for these changes to be applied): `sudo abroot pkg apply` diff --git a/tldr/linux/abrt-cli b/tldr/linux/abrt-cli index e5e2f9ce..10fbdcd3 100644 --- a/tldr/linux/abrt-cli +++ b/tldr/linux/abrt-cli @@ -31,4 +31,4 @@ source: https://github.com/tldr-pages/tldr.git - Generate a report for debugging manually: -`abrt-cli report --analyze {{problem_id}}` +`abrt-cli report {{[-a|--analyze]}} {{problem_id}}` diff --git a/tldr/linux/agetty b/tldr/linux/agetty index de0dbd71..3a3834dd 100644 --- a/tldr/linux/agetty +++ b/tldr/linux/agetty @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Alternative `getty`: Open a `tty` port, prompt for a login name, and invoke the `/bin/login` command. > It is normally invoked by `init`. -> Note: the baud rate is the speed of data transfer between a terminal and a device over a serial connection. +> Note: The baud rate is the speed of data transfer between a terminal and a device over a serial connection. > More information: . - Connect `stdin` to a port (relative to `/dev`) and optionally specify a baud rate (defaults to 9600): diff --git a/tldr/linux/apx-pkgmanagers b/tldr/linux/apx-pkgmanagers index 1bd4e464..cd06e241 100644 --- a/tldr/linux/apx-pkgmanagers +++ b/tldr/linux/apx-pkgmanagers @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # apx pkgmanagers > Manage package managers in `apx`. -> Note: user-created package manager configurations are stored in `~/.local/share/apx/pkgmanagers`. +> Note: User-created package manager configurations are stored in `~/.local/share/apx/pkgmanagers`. > More information: . - Interactively create a new package manager configuration: diff --git a/tldr/linux/apx-stacks b/tldr/linux/apx-stacks index 33b82859..5c4332be 100644 --- a/tldr/linux/apx-stacks +++ b/tldr/linux/apx-stacks @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # apx stacks > Manage stacks in `apx`. -> Note: user-created stack configurations are stored in `~/.local/share/apx/stacks`. +> Note: User-created stack configurations are stored in `~/.local/share/apx/stacks`. > More information: . - Interactively create a new stack configuration: @@ -29,6 +29,6 @@ source: https://github.com/tldr-pages/tldr.git `apx stacks import --input {{path/to/stack.yml}}` -- Export the stack configuration (Note: the output flag is optional, it is exported to the current working directory by default): +- Export the stack configuration (Note: The output flag is optional, it is exported to the current working directory by default): `apx stacks export --name {{string}} --output {{path/to/output_file}}` diff --git a/tldr/linux/btrfs-scrub b/tldr/linux/btrfs-scrub index dcac2350..329f11ec 100644 --- a/tldr/linux/btrfs-scrub +++ b/tldr/linux/btrfs-scrub @@ -25,7 +25,7 @@ source: https://github.com/tldr-pages/tldr.git `sudo btrfs scrub resume {{path/to/btrfs_mount}}` -- Start a scrub, but wait until the scrub finishes before exiting: +- Start a scrub, but do not put the program in the [B]ackground: `sudo btrfs scrub start -B {{path/to/btrfs_mount}}` diff --git a/tldr/linux/collectd b/tldr/linux/collectd index 663d331a..10be20c6 100644 --- a/tldr/linux/collectd +++ b/tldr/linux/collectd @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # collectd > System statistics collection daemon. -> More information: . +> More information: . - Test the configuration file and then exit: diff --git a/tldr/linux/cryptsetup-luksformat b/tldr/linux/cryptsetup-luksformat index a46ade75..bdb217f0 100644 --- a/tldr/linux/cryptsetup-luksformat +++ b/tldr/linux/cryptsetup-luksformat @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # cryptsetup luksFormat > Initialize a LUKS partition and the initial key slot (0) with a passphrase or keyfile. -> Note: this operation overwrites all data on the partition. +> Note: This operation overwrites all data on the partition. > More information: . - Initialize a LUKS volume with a passphrase: diff --git a/tldr/linux/cryptsetup-open b/tldr/linux/cryptsetup-open index 6d437db9..8c6d9d72 100644 --- a/tldr/linux/cryptsetup-open +++ b/tldr/linux/cryptsetup-open @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # cryptsetup open > Create a decrypted mapping of an encrypted volume. -> Note: with TRIM enabled, minimal data leakage in form of freed block information, perhaps sufficient to determine the filesystem in use may occur. +> Note: With TRIM enabled, minimal data leakage in form of freed block information, perhaps sufficient to determine the filesystem in use may occur. > However, you still most likely want to enable it, because the data inside is still safe and SSDs without TRIM will wear out faster. > More information: . diff --git a/tldr/linux/diffimg b/tldr/linux/diffimg index fddfe6d3..dad99467 100644 --- a/tldr/linux/diffimg +++ b/tldr/linux/diffimg @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # diffimg > Calculate intersection between two images. -> Note: the supported extensions are `.png`, `.gif`, `.jpg`, `.ps`. +> Note: The supported extensions are `.png`, `.gif`, `.jpg`, `.ps`. > More information: . - Calculate the intersection between images and output an image where each pixel is the difference between corresponding pixels in input images: diff --git a/tldr/linux/dnf5 b/tldr/linux/dnf5 index a56dfd80..0a703b1b 100644 --- a/tldr/linux/dnf5 +++ b/tldr/linux/dnf5 @@ -22,7 +22,7 @@ source: https://github.com/tldr-pages/tldr.git `dnf5 info {{package}}` -- Install new packages (Note: use `-y` to confirm all prompts automatically): +- Install new packages (Note: Use `-y` to confirm all prompts automatically): `sudo dnf5 install {{package1 package2 ...}}` diff --git a/tldr/linux/dnf5-group b/tldr/linux/dnf5-group index af8393c6..fc55227d 100644 --- a/tldr/linux/dnf5-group +++ b/tldr/linux/dnf5-group @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # dnf5 group > This command is an alias of `dnf group`. -> Note: from Fedora 37 to 40 (inclusive), `dnf` runs DNF v4 while `dnf5` runs DNF v5. +> Note: From Fedora 37 to 40 (inclusive), `dnf` runs DNF v4 while `dnf5` runs DNF v5. - View documentation for the original command: diff --git a/tldr/linux/extundelete b/tldr/linux/extundelete index 84105ff3..d86b8b76 100644 --- a/tldr/linux/extundelete +++ b/tldr/linux/extundelete @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Recover deleted files from ext3 or ext4 partitions by parsing the journal. > See also `date` for Unix time information and `umount` for unmounting partitions. -> More information: . +> More information: . - Restore all deleted files inside partition N on device X: diff --git a/tldr/linux/file-rename b/tldr/linux/file-rename index 8c96f91b..070bfe29 100644 --- a/tldr/linux/file-rename +++ b/tldr/linux/file-rename @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # rename > Rename multiple files. -> Note: this page refers to the command from the `rename` Debian package. +> Note: This page refers to the command from the `rename` Debian package. > More information: . - Rename files using a Perl Common Regular Expression (substitute 'foo' with 'bar' wherever found): diff --git a/tldr/linux/fpsync b/tldr/linux/fpsync index ad0ea6d7..8a1f2ad1 100644 --- a/tldr/linux/fpsync +++ b/tldr/linux/fpsync @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # fpsync > Execute several synchronization processes locally or on several remote workers through SSH. -> More information: . +> More information: . - Recursively synchronize a directory to another location: @@ -28,6 +28,6 @@ source: https://github.com/tldr-pages/tldr.git `fpsync -v -n 4 -f 1000 -s $((100 * 1024 * 1024)) {{/path/to/source/}} {{/path/to/destination/}}` -- Recursively synchronize any directories but exclude specific `.snapshot*` files (Note: options and values must be separated by a pipe character): +- Recursively synchronize any directories but exclude specific `.snapshot*` files (Note: Options and values must be separated by a pipe character): `fpsync -v -O "-x|.snapshot*" {{/path/to/source/}} {{/path/to/destination/}}` diff --git a/tldr/linux/lbu b/tldr/linux/lbu index 06a4d31c..594314cd 100644 --- a/tldr/linux/lbu +++ b/tldr/linux/lbu @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # lbu > Manage `apk` overlay files on a diskless Alpine Linux system. -> Note: subcommands like `include` write to `/etc`, which is stored in RAM. You need to run `lbu commit` to save the changes. +> Note: Subcommands like `include` write to `/etc`, which is stored in RAM. You need to run `lbu commit` to save the changes. > More information: . - Commit changes to persistent storage (only files in `/etc` by default): diff --git a/tldr/linux/lftp b/tldr/linux/lftp index 2affe00a..76b4d84b 100644 --- a/tldr/linux/lftp +++ b/tldr/linux/lftp @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Connect to an FTP server: -`lftp --user {{username}} {{ftp.example.com}}` +`lftp {{[-u|--user]}} {{username}} {{ftp.example.com}}` - Download multiple files (glob expression): @@ -34,4 +34,4 @@ source: https://github.com/tldr-pages/tldr.git - Upload or update an entire directory: -`mirror -R {{path/to/local_dir}} {{path/to/remote_output_dir}}` +`mirror {{[-R|--reverse]}} {{path/to/local_dir}} {{path/to/remote_output_dir}}` diff --git a/tldr/linux/locate b/tldr/linux/locate index 4a780276..1ba8325e 100644 --- a/tldr/linux/locate +++ b/tldr/linux/locate @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Find filenames quickly. > More information: . -- Look for pattern in the database. Note: the database is recomputed periodically (usually weekly or daily): +- Look for pattern in the database. Note: The database is recomputed periodically (usually weekly or daily): `locate {{pattern}}` diff --git a/tldr/linux/look b/tldr/linux/look index da02a9f2..83ec420f 100644 --- a/tldr/linux/look +++ b/tldr/linux/look @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # look > Display lines beginning with a prefix in a file. -> Note: the lines in the file must be sorted. +> Note: The lines in the file must be sorted. > See also: `grep`, `sort`. > More information: . diff --git a/tldr/linux/lvm b/tldr/linux/lvm index 28309b7c..ff9781b7 100644 --- a/tldr/linux/lvm +++ b/tldr/linux/lvm @@ -30,7 +30,7 @@ source: https://github.com/tldr-pages/tldr.git - Create a logical volume with size 10G from volume group vg1: -`sudo lvm lvcreate -L {{10G}} {{vg1}}` +`sudo lvm lvcreate {{[-L|--size]}} {{10G}} {{vg1}}` - Display information about logical volumes: diff --git a/tldr/linux/mkfs.erofs b/tldr/linux/mkfs.erofs index c4cc4dfd..a9b93e27 100644 --- a/tldr/linux/mkfs.erofs +++ b/tldr/linux/mkfs.erofs @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # mkfs.erofs > Create an EROFS filesystem in an image. -> More information: . +> More information: . - Create an EROFS filesystem based on the root directory: diff --git a/tldr/linux/modinfo b/tldr/linux/modinfo index a0156d26..020a17dd 100644 --- a/tldr/linux/modinfo +++ b/tldr/linux/modinfo @@ -15,4 +15,4 @@ source: https://github.com/tldr-pages/tldr.git - List the specified attribute only: -`modinfo -F {{author|description|license|parm|filename}} {{kernel_module}}` +`modinfo {{[-F|--field]}} {{author|description|license|parm|filename}} {{kernel_module}}` diff --git a/tldr/linux/mount.cifs b/tldr/linux/mount.cifs index 83a94a13..594eef51 100644 --- a/tldr/linux/mount.cifs +++ b/tldr/linux/mount.cifs @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # mount.cifs > Mount SMB (Server Message Block) or CIFS (Common Internet File System) shares. -> Note: you can also do the same thing by passing the `-t cifs` option to `mount`. +> Note: You can also do the same thing by passing the `-t cifs` option to `mount`. > More information: . - Connect using the specified username or `$USER` by default (you will be prompted for a password): diff --git a/tldr/linux/mount.smb3 b/tldr/linux/mount.smb3 index 52c5581a..4b6788fe 100644 --- a/tldr/linux/mount.smb3 +++ b/tldr/linux/mount.smb3 @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # mount.smb3 > This command is an alias of `mount.cifs`. -> Note: for SMB versions before 3 you have to use `mount.cifs` instead. +> Note: For SMB versions before 3 you have to use `mount.cifs` instead. - View documentation for the original command: diff --git a/tldr/linux/perl-rename b/tldr/linux/perl-rename index 7008ef84..871a120c 100644 --- a/tldr/linux/perl-rename +++ b/tldr/linux/perl-rename @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # rename > Rename multiple files. -> Note: this page refers to the command from the `perl-rename` Arch Linux package. +> Note: This page refers to the command from the `perl-rename` Arch Linux package. > More information: . - Rename files using a Perl Common Regular Expression (substitute 'foo' with 'bar' wherever found): diff --git a/tldr/linux/prename b/tldr/linux/prename index 463ecff4..3b3598d8 100644 --- a/tldr/linux/prename +++ b/tldr/linux/prename @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # rename > Rename multiple files. -> Note: this page refers to the command from the `prename` Fedora package. +> Note: This page refers to the command from the `prename` Fedora package. > More information: . - Rename files using a Perl Common Regular Expression (substitute 'foo' with 'bar' wherever found): diff --git a/tldr/linux/quickget b/tldr/linux/quickget index e407ee62..5c0176c3 100644 --- a/tldr/linux/quickget +++ b/tldr/linux/quickget @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # quickget > Download and prepare materials for building a Quickemu virtual machine. -> Note: the parameter "edition" is always optional. +> Note: The parameter "edition" is always optional. > See also: `quickemu`. > More information: . diff --git a/tldr/linux/rename b/tldr/linux/rename index ba3f96e2..d566e7a5 100644 --- a/tldr/linux/rename +++ b/tldr/linux/rename @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # rename > Rename multiple files. -> Note: this page refers to the command from the `util-linux` package. +> Note: This page refers to the command from the `util-linux` package. > For the Perl version, see `file-rename` or `perl-rename`. > Warning: This command has no safeguards and will overwrite files without prompting. > More information: . diff --git a/tldr/linux/restorecon b/tldr/linux/restorecon index 7420895d..6d7cd768 100644 --- a/tldr/linux/restorecon +++ b/tldr/linux/restorecon @@ -11,7 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - View the current security context of a file or directory: -`ls -dlZ {{path/to/file_or_directory}}` +`ls {{[-dlZ|--directory -l --context]}} {{path/to/file_or_directory}}` - Restore the security context of a file or directory: diff --git a/tldr/linux/sbctl b/tldr/linux/sbctl index 803ca587..0bb44a1d 100644 --- a/tldr/linux/sbctl +++ b/tldr/linux/sbctl @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # sbctl > A user-friendly secure boot key manager. -> Note: not enrolling Microsoft's certificates can brick your system. See . +> Note: Not enrolling Microsoft's certificates can brick your system. See . > More information: . - Show the current secure boot status: diff --git a/tldr/linux/st b/tldr/linux/st index a4e9aa0a..238abbf9 100644 --- a/tldr/linux/st +++ b/tldr/linux/st @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # st > A simple terminal emulator for the X Window System. -> More information: . +> More information: . - Open a terminal: diff --git a/tldr/linux/switch_root b/tldr/linux/switch_root index 450a8380..d22b4278 100644 --- a/tldr/linux/switch_root +++ b/tldr/linux/switch_root @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # switch_root > Use a different filesystem as the root of the mount tree. -> Note: switch_root will fail to function if the new root is not the root of a mount. Use bind-mounting as a workaround. +> Note: `switch_root` will fail to function if the new root is not the root of a mount. Use bind-mounting as a workaround. > See also: `chroot`, `mount`. > More information: . diff --git a/tldr/linux/sxiv b/tldr/linux/sxiv index 85467b13..b78a0d99 100644 --- a/tldr/linux/sxiv +++ b/tldr/linux/sxiv @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # sxiv > Simple X Image Viewer. -> More information: . +> More information: . - Open an image: diff --git a/tldr/linux/systemd-cgtop b/tldr/linux/systemd-cgtop index 2f5ddea6..c188ca60 100644 --- a/tldr/linux/systemd-cgtop +++ b/tldr/linux/systemd-cgtop @@ -23,7 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - Change the update interval in seconds (or one of these time units: `ms`, `us`, `min`): -`systemd-cgtop --delay={{interval}}` +`systemd-cgtop {{[-d|--delay]}} {{interval}}` - Only count userspace processes (without kernel threads): diff --git a/tldr/linux/systemd-delta b/tldr/linux/systemd-delta index 147c86ba..552ec472 100644 --- a/tldr/linux/systemd-delta +++ b/tldr/linux/systemd-delta @@ -16,7 +16,7 @@ source: https://github.com/tldr-pages/tldr.git `systemd-delta --type {{masked|equivalent|redirected|overridden|extended|unchanged}}` -- Show only files whose path starts with the specified prefix (Note: a prefix is a directory containing subdirectories with systemd configuration files): +- Show only files whose path starts with the specified prefix (Note: A prefix is a directory containing subdirectories with systemd configuration files): `systemd-delta {{/etc|/run|/usr/lib|...}}` diff --git a/tldr/linux/systemd-resolve b/tldr/linux/systemd-resolve index 9b527a53..c6dd4653 100644 --- a/tldr/linux/systemd-resolve +++ b/tldr/linux/systemd-resolve @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # systemd-resolve > Resolve domain names, IPV4 and IPv6 addresses, DNS resource records, and services. -> Note: this tool has been renamed to `resolvectl` in new versions of `systemd`. +> Note: This tool has been renamed to `resolvectl` in new versions of `systemd`. > More information: . - View documentation for `resolvectl`: diff --git a/tldr/linux/systool b/tldr/linux/systool index c0b285dd..4a675bb0 100644 --- a/tldr/linux/systool +++ b/tldr/linux/systool @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > View system device information by bus, and classes. > This command is part of the `sysfs` package. -> More information: . +> More information: . - List all attributes of devices of a bus (eg. `pci`, `usb`). View all buses using `ls /sys/bus`: diff --git a/tldr/linux/trizen b/tldr/linux/trizen index 1ab93dc7..73106a76 100644 --- a/tldr/linux/trizen +++ b/tldr/linux/trizen @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # trizen > Arch Linux utility for building packages from the Arch User Repository (AUR). -> More information: . +> More information: . - Synchronize and update all AUR packages: diff --git a/tldr/linux/tshark b/tldr/linux/tshark index 105a2846..a322c5c2 100644 --- a/tldr/linux/tshark +++ b/tldr/linux/tshark @@ -26,7 +26,7 @@ source: https://github.com/tldr-pages/tldr.git - Specify the format of captured output: -`tshark -T {{json|text|ps|…}}` +`tshark -T {{json|text|ps|...}}` - Select specific fields to output: diff --git a/tldr/linux/tzselect b/tldr/linux/tzselect index 6fa0522d..2cd0c4ef 100644 --- a/tldr/linux/tzselect +++ b/tldr/linux/tzselect @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # tzselect > Interactively select timezone. -> Note: this program doesn't actually set the timezone. +> Note: This program doesn't actually set the timezone. > More information: . - Open the interactive menu for timezone selection and print the selected timezone to `stdout`: diff --git a/tldr/linux/urpme b/tldr/linux/urpme index a6815424..07ebcb4d 100644 --- a/tldr/linux/urpme +++ b/tldr/linux/urpme @@ -13,7 +13,7 @@ source: https://github.com/tldr-pages/tldr.git `sudo urpme {{package}}` -- Uninstall orphan packages (Note: use it with caution as it might unintentionally remove important packages): +- Uninstall orphan packages (Note: Use it with caution as it might unintentionally remove important packages): `sudo urpme --auto-orphans` diff --git a/tldr/linux/wami b/tldr/linux/wami index 36afdfe9..5ccb1930 100644 --- a/tldr/linux/wami +++ b/tldr/linux/wami @@ -8,18 +8,18 @@ source: https://github.com/tldr-pages/tldr.git > An open-source and easy-to-use tool that recommends suitable programs for tasks. > More information: . -- Find expanded results in all categories from the lake and [S]ort them in the specified order: +- Find expanded results in all categories from the lake and sort them in the specified order: -`wami --show-all -S {{asc|desc}} --search-all {{search_string}}` +`wami {{[-a|--show-all]}} {{[-S|--sort]}} {{asc|desc}} {{[-s|--search-all]}} {{search_string}}` -- Search GitHub to find expanded results, [S]orted in descending order: +- Search GitHub to find expanded results, sorted in descending order: -`wami --show-all -S desc --github {{search_string}}` +`wami {{[-a|--show-all]}} {{[-S|--sort]}} desc --github {{search_string}}` - Search GitHub for topics that match the search string: `wami --list-topics {{search_string}}` -- Search the lake for a tool used in pentests to query for default credentials and [S]ort the results in descending order: +- Search the lake for a tool used in pentests to query for default credentials and sort the results in descending order: -`wami -S desc --search-all pentest credential default` +`wami {{[-S|--sort]}} desc {{[-s|--search-all]}} pentest credential default` diff --git a/tldr/linux/wpctl b/tldr/linux/wpctl index 6fb744d7..10e7e66e 100644 --- a/tldr/linux/wpctl +++ b/tldr/linux/wpctl @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # wpctl > Manage WirePlumber, a session and policy manager for PipeWire. -> Note: you can use the special name `@DEFAULT_SINK@` in place of `id` to operate on the default sink. +> Note: You can use the special name `@DEFAULT_SINK@` in place of `id` to operate on the default sink. > More information: . - List all objects managed by WirePlumber: diff --git a/tldr/linux/wtype b/tldr/linux/wtype index 736dfbe7..06643ca8 100644 --- a/tldr/linux/wtype +++ b/tldr/linux/wtype @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Simulate keyboard input on Wayland, similar to `xdotool type` for X11. > See also: `ydotool`. -> More information: . +> More information: . - Simulate typing text: diff --git a/tldr/linux/xxhsum b/tldr/linux/xxhsum index 5f4bcd2c..32533a5e 100644 --- a/tldr/linux/xxhsum +++ b/tldr/linux/xxhsum @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # xxhsum > Print or verify checksums using fast non-cryptographic algorithm xxHash. -> More information: . +> More information: . - Calculate the checksum for a file using a specific algorithm: diff --git a/tldr/linux/zforce b/tldr/linux/zforce index 77226054..5a22c766 100644 --- a/tldr/linux/zforce +++ b/tldr/linux/zforce @@ -8,6 +8,6 @@ source: https://github.com/tldr-pages/tldr.git > Add a `.gz` extension to files compressed using `gzip`. > More information: . -- Add a `.gz` extension to the supplied Gzip files (Note: other files are ignored): +- Add a `.gz` extension to the supplied Gzip files (Note: Other files are ignored): `zforce {{path/to/file1 path/to/file2 ...}}` diff --git a/tldr/look b/tldr/look index 553dc8ff..c1ac25a3 100644 --- a/tldr/look +++ b/tldr/look @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # look > Display lines beginning with a prefix in a sorted file. -> Note: the lines in the file must be sorted. +> Note: The lines in the file must be sorted. > See also: `grep`, `sort`. > More information: . diff --git a/tldr/magick-convert b/tldr/magick-convert index d74febaa..b5d90a51 100644 --- a/tldr/magick-convert +++ b/tldr/magick-convert @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # magick convert > Convert between image formats, scale, join, and create images, and much more. -> Note: this tool (previously `convert`) has been replaced by `magick` in ImageMagick 7+. +> Note: This tool (previously `convert`) has been replaced by `magick` in ImageMagick 7+. > More information: . - Convert an image from JPEG to PNG: diff --git a/tldr/medusa b/tldr/medusa index 2c227252..08ace4c2 100644 --- a/tldr/medusa +++ b/tldr/medusa @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # medusa > A modular and parallel login brute-forcer for a variety of protocols. -> More information: . +> More information: . - List all installed modules: diff --git a/tldr/meson b/tldr/meson index d9a436e7..c9dcd35d 100644 --- a/tldr/meson +++ b/tldr/meson @@ -6,11 +6,11 @@ source: https://github.com/tldr-pages/tldr.git # meson > SCons-like build system that uses Python as a front-end language and Ninja as a building backend. -> More information: . +> More information: . - Generate a C project with a given name and version: -`meson init --language={{c}} --name={{myproject}} --version={{0.1}}` +`meson init {{[-l|--language]}} c {{[-n|--name]}} {{myproject}} --version {{0.1}}` - Configure the `builddir` with default values: @@ -26,8 +26,8 @@ source: https://github.com/tldr-pages/tldr.git - Show the help: -`meson --help` +`meson {{[-h|--help]}}` - Display version: -`meson --version` +`meson {{[-v|--version]}}` diff --git a/tldr/mg b/tldr/mg index 52d3c01e..22cb906e 100644 --- a/tldr/mg +++ b/tldr/mg @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # mg > A small, fast, and portable text editor based on `emacs`. -> More information: . +> More information: . - Open a file for editing: diff --git a/tldr/mongo b/tldr/mongo index 604f67a1..294c6f3d 100644 --- a/tldr/mongo +++ b/tldr/mongo @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # mongo > The legacy MongoDB shell. See `mongosh` for the new shell. -> Note: all connection options can be replaced with one string: `mongodb://user@host:port/db_name?authSource=authdb_name`. +> Note: All connection options can be replaced with one string: `mongodb://user@host:port/db_name?authSource=authdb_name`. > More information: . - Connect to a local database on the default port (`mongodb://localhost:27017`): diff --git a/tldr/mongosh b/tldr/mongosh index 0fef5d31..97ca509e 100644 --- a/tldr/mongosh +++ b/tldr/mongosh @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # mongosh > A new shell for MongoDB, replacement for `mongo`. -> Note: all connection options can be replaced with one string: `mongodb://user@host:port/db_name?authSource=authdb_name`. +> Note: All connection options can be replaced with one string: `mongodb://user@host:port/db_name?authSource=authdb_name`. > More information: . - Connect to a local database on the default port (`mongodb://localhost:27017`): diff --git a/tldr/moreutils b/tldr/moreutils index fb2384bd..4901b8de 100644 --- a/tldr/moreutils +++ b/tldr/moreutils @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # moreutils > A collection of UNIX tools. -> Note: moreutils isn't a command, but a set of commands. +> Note: `moreutils` isn't a command, but a set of commands. > More information: . - View documentation for pages related to standard streams: diff --git a/tldr/mp3info b/tldr/mp3info index 24244a2c..d8c1bb9c 100644 --- a/tldr/mp3info +++ b/tldr/mp3info @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # mp3info > Viewer/editor for ID3v1 (but not ID3v2) tags of MP3 files. -> More information: . +> More information: . - Show all ID3v1 tags of a specific MP3 file: diff --git a/tldr/mqtt_check.py b/tldr/mqtt_check.py index a578a2b7..fb538aa3 100644 --- a/tldr/mqtt_check.py +++ b/tldr/mqtt_check.py @@ -29,6 +29,6 @@ source: https://github.com/tldr-pages/tldr.git `mqtt_check.py -debug {{domain}}/{{username}}:{{password}}@{{targetName}}` -- Display help message: +- Display help: `mqtt_check.py --help` diff --git a/tldr/msfconsole b/tldr/msfconsole index 9507295c..99352496 100644 --- a/tldr/msfconsole +++ b/tldr/msfconsole @@ -20,7 +20,7 @@ source: https://github.com/tldr-pages/tldr.git `msfconsole {{[-n|--no-database]}}` -- Execute console commands (Note: use `;` for passing multiple commands): +- Execute console commands (Note: Use `;` for passing multiple commands): `msfconsole {{[-x|--execute-command]}} "{{use auxiliary/server/capture/ftp; set SRVHOST 0.0.0.0; set SRVPORT 21; run}}"` diff --git a/tldr/mullvad b/tldr/mullvad index 4c7e9f59..93baf490 100644 --- a/tldr/mullvad +++ b/tldr/mullvad @@ -24,3 +24,7 @@ source: https://github.com/tldr-pages/tldr.git - Check status of VPN tunnel: `mullvad status` + +- Check the account expiration date and obtain the device name: + +`mullvad account get` diff --git a/tldr/mupdf b/tldr/mupdf index b8e742b4..dff87e52 100644 --- a/tldr/mupdf +++ b/tldr/mupdf @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # mupdf > A lightweight PDF, XPS, and E-book viewer. -> More information: . +> More information: . - Open a PDF on the first page: diff --git a/tldr/mutool b/tldr/mutool index 79e5e171..bff32a43 100644 --- a/tldr/mutool +++ b/tldr/mutool @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # mutool > Convert, query information and extract data from PDF files. -> More information: . +> More information: . - Convert a range of pages to PNGs (Note: `%nd` in the output placeholder must be replaced with a print modifier like `%d` or `%2d`): diff --git a/tldr/mutt b/tldr/mutt index d19ba42f..c5bedf4d 100644 --- a/tldr/mutt +++ b/tldr/mutt @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # mutt > Command-line email client. -> More information: . +> More information: . - Open the specified mailbox: diff --git a/tldr/mvn b/tldr/mvn index fa70c381..9280c313 100644 --- a/tldr/mvn +++ b/tldr/mvn @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # mvn > Apache Maven: build and manage Java-based projects. -> More information: . +> More information: . - Compile a project: @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Compile and package, skipping unit tests: -`mvn package -DskipTests` +`mvn package {{[-D|--define]}} skipTests` - Install the built package in local maven repository. (This will invoke the compile and package commands too): @@ -34,8 +34,8 @@ source: https://github.com/tldr-pages/tldr.git - Clean and then package the code with a given build profile: -`mvn clean -P {{profile}} package` +`mvn clean {{[-P|--activate-profiles]}} {{profile}} package` - Run a class with a main method: -`mvn exec:java -Dexec.mainClass="{{com.example.Main}}" -Dexec.args="{{argument1 argument2 ...}}"` +`mvn exec:java {{[-D|--define]}} exec.mainClass="{{com.example.Main}}" {{[-D|--define]}} exec.args="{{argument1 argument2 ...}}"` diff --git a/tldr/neomutt b/tldr/neomutt index 8334d295..7eef54eb 100644 --- a/tldr/neomutt +++ b/tldr/neomutt @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # neomutt > NeoMutt command-line email client. -> More information: . +> More information: . - Open the specified mailbox: diff --git a/tldr/netbsd/sockstat b/tldr/netbsd/sockstat index f9b38246..afe81f5c 100644 --- a/tldr/netbsd/sockstat +++ b/tldr/netbsd/sockstat @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # sockstat > List open Internet or UNIX domain sockets. -> Note: this program is a rewrite for NetBSD 3.0 from FreeBSD's `sockstat`. +> Note: This program is a rewrite for NetBSD 3.0 from FreeBSD's `sockstat`. > See also: `netstat`. > More information: . diff --git a/tldr/nmblookup b/tldr/nmblookup index 8becf995..df802b38 100644 --- a/tldr/nmblookup +++ b/tldr/nmblookup @@ -10,8 +10,8 @@ source: https://github.com/tldr-pages/tldr.git - Find hosts in the local network with SMB shares: -`nmblookup -S '*'` +`nmblookup {{[-S|--status]}} '*'` - Find hosts in the local network with SMB shares run by SAMBA: -`nmblookup --status __SAMBA__` +`nmblookup {{[-S|--status]}} __SAMBA__` diff --git a/tldr/nokogiri b/tldr/nokogiri index 87d80f3b..16e149b0 100644 --- a/tldr/nokogiri +++ b/tldr/nokogiri @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # nokogiri > An HTML, XML, SAX and Reader parser. -> More information: . +> More information: . - Parse the contents of a URL or file: @@ -22,7 +22,7 @@ source: https://github.com/tldr-pages/tldr.git - Parse using a specific encoding: -`nokogiri {{url|path/to/file}} --encoding {{encoding}}` +`nokogiri {{url|path/to/file}} {{[-E|--encoding]}} {{encoding}}` - Validate using a RELAX NG file: diff --git a/tldr/nxc b/tldr/nxc index 394b12a2..2de216a3 100644 --- a/tldr/nxc +++ b/tldr/nxc @@ -9,18 +9,18 @@ source: https://github.com/tldr-pages/tldr.git > Some subcommands such as `smb` have their own usage documentation. > More information: . -- [L]ist available modules for the specified protocol: +- List available modules for the specified protocol: -`nxc {{smb|ssh|ldap|ftp|wmi|winrm|rdp|vnc|mssql}} -L` +`nxc {{smb|ssh|ldap|ftp|wmi|winrm|rdp|vnc|mssql}} {{[-L|--list-modules]}}` - List the options available for the specified module: -`nxc {{smb|ssh|ldap|ftp|wmi|winrm|rdp|vnc|mssql}} -M {{module_name}} --options` +`nxc {{smb|ssh|ldap|ftp|wmi|winrm|rdp|vnc|mssql}} {{[-M|--module]}} {{module_name}} --options` -- Specify an option for a module: +- Specify an [o]ption for a module: -`nxc {{smb|ssh|ldap|ftp|wmi|winrm|rdp|vnc|mssql}} -M {{module_name}} -o {{OPTION_NAME}}={{option_value}}` +`nxc {{smb|ssh|ldap|ftp|wmi|winrm|rdp|vnc|mssql}} {{[-M|--module]}} {{module_name}} -o {{OPTION_NAME}}={{option_value}}` - View the options available for the specified protocol: -`nxc {{smb|ssh|ldap|ftp|wmi|winrm|rdp|vnc|mssql}} --help` +`nxc {{smb|ssh|ldap|ftp|wmi|winrm|rdp|vnc|mssql}} {{[-h|--help]}}` diff --git a/tldr/nxc-ftp b/tldr/nxc-ftp index be5a75ef..b1bea480 100644 --- a/tldr/nxc-ftp +++ b/tldr/nxc-ftp @@ -8,22 +8,22 @@ source: https://github.com/tldr-pages/tldr.git > Pentest and exploit FTP servers. > More information: . -- Search for valid credentials by trying out every combination in the specified lists of [u]sernames and [p]asswords: +- Search for valid credentials by trying out every combination in the specified lists of usernames and passwords: -`nxc ftp {{192.168.178.2}} -u {{path/to/usernames.txt}} -p {{path/to/passwords.txt}}` +`nxc ftp {{192.168.178.2}} {{[-u|--username]}} {{path/to/usernames.txt}} {{[-p|--password]}} {{path/to/passwords.txt}}` - Continue searching for valid credentials even after valid credentials have been found: -`nxc ftp {{192.168.178.2}} -u {{path/to/usernames.txt}} -p {{path/to/passwords.txt}} --continue-on-success` +`nxc ftp {{192.168.178.2}} {{[-u|--username]}} {{path/to/usernames.txt}} {{[-p|--password]}} {{path/to/passwords.txt}} --continue-on-success` - Perform directory listings on each FTP server the supplied credentials are valid on: -`nxc ftp {{192.168.178.0/24}} -u {{username}} -p {{password}} --ls` +`nxc ftp {{192.168.178.0/24}} {{[-u|--username]}} {{username}} {{[-p|--password]}} {{password}} --ls` - Download the specified file from the target server: -`nxc ftp {{192.168.178.2}} -u {{username}} -p {{password}} --get {{path/to/file}}` +`nxc ftp {{192.168.178.2}} {{[-u|--username]}} {{username}} {{[-p|--password]}} {{password}} --get {{path/to/file}}` - Upload the specified file to the target server at the specified location: -`nxc ftp {{192.168.178.2}} -u {{username}} -p {{password}} --put {{path/to/local_file}} {{path/to/remote_location}}` +`nxc ftp {{192.168.178.2}} {{[-u|--username]}} {{username}} {{[-p|--password]}} {{password}} --put {{path/to/local_file}} {{path/to/remote_location}}` diff --git a/tldr/nxc-ldap b/tldr/nxc-ldap index 960b201c..bf647451 100644 --- a/tldr/nxc-ldap +++ b/tldr/nxc-ldap @@ -8,22 +8,22 @@ source: https://github.com/tldr-pages/tldr.git > Pentest and exploit Windows Active Directory Domains via LDAP. > More information: . -- Search for valid domain credentials by trying out every combination in the specified lists of [u]sernames and [p]asswords: +- Search for valid domain credentials by trying out every combination in the specified lists of usernames and passwords: -`nxc ldap {{192.168.178.2}} -u {{path/to/usernames.txt}} -p {{path/to/passwords.txt}}` +`nxc ldap {{192.168.178.2}} {{[-u|--username]}} {{path/to/usernames.txt}} {{[-p|--password]}} {{path/to/passwords.txt}}` - Enumerate active domain users: -`nxc ldap {{192.168.178.2}} -u {{username}} -p {{password}} --active-users` +`nxc ldap {{192.168.178.2}} {{[-u|--username]}} {{username}} {{[-p|--password]}} {{password}} --active-users` - Collect data about the targeted domain and automatically import these data into BloodHound: -`nxc ldap {{192.168.178.2}} -u {{username}} -p {{password}} --bloodhound --collection {{All}}` +`nxc ldap {{192.168.178.2}} {{[-u|--username]}} {{username}} {{[-p|--password]}} {{password}} --bloodhound {{[-c|--collection]}} {{All}}` - Attempt to collect AS_REP messages for the specified user in order to perform an ASREPRoasting attack: -`nxc ldap {{192.168.178.2}} -u {{username}} -p '' --asreproast {{path/to/output.txt}}` +`nxc ldap {{192.168.178.2}} {{[-u|--username]}} {{username}} {{[-p|--password]}} '' --asreproast {{path/to/output.txt}}` - Attempt to extract the passwords of group managed service accounts on the domain: -`nxc ldap {{192.168.178.2}} -u {{username}} -p {{password}} --gmsa` +`nxc ldap {{192.168.178.2}} {{[-u|--username]}} {{username}} {{[-p|--password]}} {{password}} --gmsa` diff --git a/tldr/nxc-mssql b/tldr/nxc-mssql index 643a9903..13498c79 100644 --- a/tldr/nxc-mssql +++ b/tldr/nxc-mssql @@ -8,26 +8,26 @@ source: https://github.com/tldr-pages/tldr.git > Pentest and exploit Microsoft SQL servers. > More information: . -- Search for valid credentials by trying out every combination in the specified lists of [u]sernames and [p]asswords: +- Search for valid credentials by trying out every combination in the specified lists of usernames and passwords: -`nxc mssql {{192.168.178.2}} -u {{path/to/usernames.txt}} -p {{path/to/passwords.txt}}` +`nxc mssql {{192.168.178.2}} {{[-u|--username]}} {{path/to/usernames.txt}} {{[-p|--password]}} {{path/to/passwords.txt}}` -- Execute the specified SQL [q]uery on the target server: +- Execute the specified SQL query on the target server: -`nxc mssql {{192.168.178.2}} -u {{username}} -p {{password}} --query '{{SELECT * FROM sys.databases;}}'` +`nxc mssql {{192.168.178.2}} {{[-u|--username]}} {{username}} {{[-p|--password]}} {{password}} {{[-q|--query]}} '{{SELECT * FROM sys.databases;}}'` - Execute the specified shell command on the target server through MSSQL: -`nxc mssql {{192.168.178.2}} -u {{username}} -p {{password}} -x {{whoami}}` +`nxc mssql {{192.168.178.2}} {{[-u|--username]}} {{username}} {{[-p|--password]}} {{password}} -x {{whoami}}` - Execute the specified PowerShell command on the target server through MSSQL without retrieving output: -`nxc mssql {{192.168.178.2}} -u {{username}} -p {{password}} -X {{whoami}} --no-output` +`nxc mssql {{192.168.178.2}} {{[-u|--username]}} {{username}} {{[-p|--password]}} {{password}} -X {{whoami}} --no-output` - Download a remote file from the target server and store it in the specified location: -`nxc mssql {{192.168.178.2}} -u {{username}} -p {{password}} --get-file {{C:\path o emote_file}} {{path/to/local_file}}` +`nxc mssql {{192.168.178.2}} {{[-u|--username]}} {{username}} {{[-p|--password]}} {{password}} --get-file {{C:\path o emote_file}} {{path/to/local_file}}` - Upload a local file to the specified location on the target server: -`nxc mssql {{192.168.178.2}} -u {{username}} -p {{password}} --put-file {{path/to/local_file}} {{C:\path o emote_file}}` +`nxc mssql {{192.168.178.2}} {{[-u|--username]}} {{username}} {{[-p|--password]}} {{password}} --put-file {{path/to/local_file}} {{C:\path o emote_file}}` diff --git a/tldr/nxc-rdp b/tldr/nxc-rdp index 443f153c..107d151b 100644 --- a/tldr/nxc-rdp +++ b/tldr/nxc-rdp @@ -8,18 +8,18 @@ source: https://github.com/tldr-pages/tldr.git > Pentest and exploit RDP servers. > More information: . -- Search for valid credentials by trying out every combination in the specified lists of [u]sernames and [p]asswords: +- Search for valid credentials by trying out every combination in the specified lists of usernames and passwords: -`nxc rdp {{192.168.178.2}} -u {{path/to/usernames.txt}} -p {{path/to/passwords.txt}}` +`nxc rdp {{192.168.178.2}} {{[-u|--username]}} {{path/to/usernames.txt}} {{[-p|--password]}} {{path/to/passwords.txt}}` - Take a screenshot after waiting the for specified number of seconds: -`nxc rdp {{192.168.178.2}} -u {{username}} -p {{password}} --screenshot --screentime {{10}}` +`nxc rdp {{192.168.178.2}} {{[-u|--username]}} {{username}} {{[-p|--password]}} {{password}} --screenshot --screentime {{10}}` - Take a screenshot in the specified resolution: -`nxc rdp {{192.168.178.2}} -u {{username}} -p {{password}} --screenshot --res {{1024x768}}` +`nxc rdp {{192.168.178.2}} {{[-u|--username]}} {{username}} {{[-p|--password]}} {{password}} --screenshot --res {{1024x768}}` - Take a screenshot of the RDP login prompt if Network Level Authentication is disabled: -`nxc rdp {{192.168.178.2}} -u {{username}} -p {{password}} --nla-screenshot` +`nxc rdp {{192.168.178.2}} {{[-u|--username]}} {{username}} {{[-p|--password]}} {{password}} --nla-screenshot` diff --git a/tldr/nxc-smb b/tldr/nxc-smb index f2bb9d43..912a69f6 100644 --- a/tldr/nxc-smb +++ b/tldr/nxc-smb @@ -8,26 +8,26 @@ source: https://github.com/tldr-pages/tldr.git > Pentest and exploit SMB servers. > More information: . -- Search for valid domain credentials by trying out every combination in the specified lists of [u]sernames and [p]asswords: +- Search for valid domain credentials by trying out every combination in the specified lists of usernames and passwords: -`nxc smb {{192.168.178.2}} -u {{path/to/usernames.txt}} -p {{path/to/passwords.txt}}` +`nxc smb {{192.168.178.2}} {{[-u|--username]}} {{path/to/usernames.txt}} {{[-p|--password]}} {{path/to/passwords.txt}}` - Search for valid credentials for local accounts instead of domain accounts: -`nxc smb {{192.168.178.2}} -u {{path/to/usernames.txt}} -p {{path/to/passwords.txt}} --local-auth` +`nxc smb {{192.168.178.2}} {{[-u|--username]}} {{path/to/usernames.txt}} {{[-p|--password]}} {{path/to/passwords.txt}} --local-auth` - Enumerate SMB shares and the specified users' access rights to them on the target hosts: -`nxc smb {{192.168.178.0/24}} -u {{username}} -p {{password}} --shares` +`nxc smb {{192.168.178.0/24}} {{[-u|--username]}} {{username}} {{[-p|--password]}} {{password}} --shares` - Enumerate network interfaces on the target hosts, performing authentication via pass-the-hash: -`nxc smb {{192.168.178.30-45}} -u {{username}} -H {{NTLM_hash}} --interfaces` +`nxc smb {{192.168.178.30-45}} {{[-u|--username]}} {{username}} {{[-H|--hash]}} {{NTLM_hash}} --interfaces` - Scan the target hosts for common vulnerabilities: -`nxc smb {{path/to/target_list.txt}} -u '' -p '' -M zerologon -M petitpotam` +`nxc smb {{path/to/target_list.txt}} {{[-u|--username]}} '' {{[-p|--password]}} '' {{[-M|--module]}} zerologon {{[-M|--module]}} petitpotam` - Attempt to execute a command on the target hosts: -`nxc smb {{192.168.178.2}} -u {{username}} -p {{password}} -x {{command}}` +`nxc smb {{192.168.178.2}} {{[-u|--username]}} {{username}} {{[-p|--password]}} {{password}} -x {{command}}` diff --git a/tldr/nxc-ssh b/tldr/nxc-ssh index 9cb28c24..ea654c11 100644 --- a/tldr/nxc-ssh +++ b/tldr/nxc-ssh @@ -9,22 +9,22 @@ source: https://github.com/tldr-pages/tldr.git > See also: `hydra`. > More information: . -- Spray the specified [p]assword against a list of [u]sernames on the specified target: +- Spray the specified password against a list of usernames on the specified target: -`nxc ssh {{192.168.178.2}} -u {{path/to/usernames.txt}} -p {{password}}` +`nxc ssh {{192.168.178.2}} {{[-u|--username]}} {{path/to/usernames.txt}} {{[-p|--password]}} {{password}}` -- Search for valid credentials by trying out every combination in the specified lists of [u]sernames and [p]asswords: +- Search for valid credentials by trying out every combination in the specified lists of usernames and passwords: -`nxc ssh {{192.168.178.2}} -u {{path/to/usernames.txt}} -p {{path/to/passwords.txt}}` +`nxc ssh {{192.168.178.2}} {{[-u|--username]}} {{path/to/usernames.txt}} {{[-p|--password]}} {{path/to/passwords.txt}}` -- Use the specified private key for authentication, using the supplied [p]assword as the key's passphrase: +- Use the specified private key for authentication, using the supplied password as the key's passphrase: -`nxc ssh {{192.186.178.2}} -u {{path/to/usernames.txt}} -p {{password}} --key-file {{path/to/id_rsa}}` +`nxc ssh {{192.186.178.2}} {{[-u|--username]}} {{path/to/usernames.txt}} {{[-p|--password]}} {{password}} --key-file {{path/to/id_rsa}}` -- Try a combination of [u]sername and [p]assword on a number of targets: +- Try a combination of username and password on a number of targets: -`nxc ssh {{192.168.178.0/24}} -u {{username}} -p {{password}}` +`nxc ssh {{192.168.178.0/24}} {{[-u|--username]}} {{username}} {{[-p|--password]}} {{password}}` - Check for `sudo` privileges on a successful login: -`nxc ssh {{192.168.178.2}} -u {{username}} -p {{path/to/passwords.txt}} --sudo-check` +`nxc ssh {{192.168.178.2}} {{[-u|--username]}} {{username}} {{[-p|--password]}} {{path/to/passwords.txt}} --sudo-check` diff --git a/tldr/nxc-vnc b/tldr/nxc-vnc index ffc1bc3b..c95ac2f6 100644 --- a/tldr/nxc-vnc +++ b/tldr/nxc-vnc @@ -8,14 +8,14 @@ source: https://github.com/tldr-pages/tldr.git > Pentest and exploit VNC servers. > More information: . -- Search for valid credentials by trying out every combination in the specified lists of [u]sernames and [p]asswords: +- Search for valid credentials by trying out every combination in the specified lists of usernames and passwords: -`nxc vnc {{192.168.178.2}} -u {{path/to/usernames.txt}} -p {{path/to/passwords.txt}}` +`nxc vnc {{192.168.178.2}} {{[-u|--username]}} {{path/to/usernames.txt}} {{[-p|--password]}} {{path/to/passwords.txt}}` - Avoid rate limiting through VNC-sleep: -`nxc vnc {{192.168.178.2}} -u {{path/to/usernames.txt}} -p {{path/to/passwords.txt}} --vnc-sleep {{10}}` +`nxc vnc {{192.168.178.2}} {{[-u|--username]}} {{path/to/usernames.txt}} {{[-p|--password]}} {{path/to/passwords.txt}} --vnc-sleep {{10}}` - Take a screenshot on the remote system after waiting the specified amount of time: -`nxc vnc {{192.168.178.2}} -u {{username}} -p {{password}} --screenshot --screentime {{10}}` +`nxc vnc {{192.168.178.2}} {{[-u|--username]}} {{username}} {{[-p|--password]}} {{password}} --screenshot --screentime {{10}}` diff --git a/tldr/nxc-winrm b/tldr/nxc-winrm index dee229ef..4bcafba9 100644 --- a/tldr/nxc-winrm +++ b/tldr/nxc-winrm @@ -8,18 +8,18 @@ source: https://github.com/tldr-pages/tldr.git > Pentest and exploit Windows Remote Management (winrm). > More information: . -- Search for valid credentials by trying out every combination in the specified lists of [u]sernames and [p]asswords: +- Search for valid credentials by trying out every combination in the specified lists of usernames and passwords: -`nxc winrm {{192.168.178.2}} -u {{path/to/usernames.txt}} -p {{path/to/passwords.txt}}` +`nxc winrm {{192.168.178.2}} {{[-u|--username]}} {{path/to/usernames.txt}} {{[-p|--password]}} {{path/to/passwords.txt}}` - Specify the domain to authenticate to (avoids an initial SMB connection): -`nxc winrm {{192.168.178.2}} -u {{username}} -p {{password}} -d {{domain_name}}` +`nxc winrm {{192.168.178.2}} {{[-u|--username]}} {{username}} {{[-p|--password]}} {{password}} -d {{domain_name}}` - Execute the specified command on the host: -`nxc winrm {{192.168.178.2}} -u {{username}} -p {{password}} -x {{whoami}}` +`nxc winrm {{192.168.178.2}} {{[-u|--username]}} {{username}} {{[-p|--password]}} {{password}} -x {{whoami}}` - Execute the specified PowerShell command on the host as administrator using LAPS: -`nxc winrm {{192.168.178.2}} -u {{username}} -p {{password}} --laps -X {{whoami}}` +`nxc winrm {{192.168.178.2}} {{[-u|--username]}} {{username}} {{[-p|--password]}} {{password}} --laps -X {{whoami}}` diff --git a/tldr/nxc-wmi b/tldr/nxc-wmi index c6c27289..a318a789 100644 --- a/tldr/nxc-wmi +++ b/tldr/nxc-wmi @@ -8,18 +8,18 @@ source: https://github.com/tldr-pages/tldr.git > Pentest and exploit the Windows Management Instrumentation (WMI). > More information: . -- Search for valid credentials by trying out every combination in the specified lists of [u]sernames and [p]asswords: +- Search for valid credentials by trying out every combination in the specified lists of usernames and passwords: -`nxc wmi {{192.168.178.2}} -u {{path/to/usernames.txt}} -p {{path/to/passwords.txt}}` +`nxc wmi {{192.168.178.2}} {{[-u|--username]}} {{path/to/usernames.txt}} {{[-p|--password]}} {{path/to/passwords.txt}}` - Authenticate via local authentication (as opposed to authenticating to the domain): -`nxc wmi {{192.168.178.2}} -u {{username}} -p {{password}} --local-auth` +`nxc wmi {{192.168.178.2}} {{[-u|--username]}} {{username}} {{[-p|--password]}} {{password}} --local-auth` - Issue the specified WMI query: -`nxc wmi {{192.168.178.2}} -u {{username}} -p {{password}} --wmi {{wmi_query}}` +`nxc wmi {{192.168.178.2}} {{[-u|--username]}} {{username}} {{[-p|--password]}} {{password}} --wmi {{wmi_query}}` - Execute the specified command on the targeted host: -`nxc wmi {{192.168.178.2}} -u {{username}} -p {{password}} --x {{command}}` +`nxc wmi {{192.168.178.2}} {{[-u|--username]}} {{username}} {{[-p|--password]}} {{password}} -x {{command}}` diff --git a/tldr/osx/chpass b/tldr/osx/chpass index 817a3d2d..ca83de2f 100644 --- a/tldr/osx/chpass +++ b/tldr/osx/chpass @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # chpass > Add or change user database information, including login shell and password. -> Note: it's not possible to change the user's password on Open Directory systems, use `passwd` instead. +> Note: It's not possible to change the user's password on Open Directory systems, use `passwd` instead. > See also: `passwd`. > More information: . diff --git a/tldr/osx/launchctl b/tldr/osx/launchctl index 64973e50..bb037842 100644 --- a/tldr/osx/launchctl +++ b/tldr/osx/launchctl @@ -25,11 +25,11 @@ source: https://github.com/tldr-pages/tldr.git `launchctl list` -- Unload a currently loaded agent, e.g. to make changes (Note: the plist file is automatically loaded into `launchd` after a reboot and/or logging in): +- Unload a currently loaded agent, e.g. to make changes (Note: The plist file is automatically loaded into `launchd` after a reboot and/or logging in): `launchctl unload ~/Library/LaunchAgents/{{my_script}}.plist` -- Manually run a known (loaded) agent/daemon, even if it is not the right time (Note: this command uses the agent's label, rather than the filename): +- Manually run a known (loaded) agent/daemon, even if it is not the right time (Note: This command uses the agent's label, rather than the filename): `launchctl start {{script_file}}` diff --git a/tldr/osx/locate b/tldr/osx/locate index cc26b12b..62e8abd0 100644 --- a/tldr/osx/locate +++ b/tldr/osx/locate @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Find filenames quickly. > More information: . -- Look for pattern in the database. Note: the database is recomputed periodically (usually weekly or daily): +- Look for pattern in the database. Note: The database is recomputed periodically (usually weekly or daily): `locate "{{pattern}}"` diff --git a/tldr/osx/shortcuts b/tldr/osx/shortcuts index 2b8cc8c4..fe1364c4 100644 --- a/tldr/osx/shortcuts +++ b/tldr/osx/shortcuts @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # shortcuts > Manage shortcuts. -> Note: you can also use the `Shortcuts` app. +> Note: You can also use the `Shortcuts` app. > More information: . - Run the specified shortcut (`Count holidays`): diff --git a/tldr/osx/uname b/tldr/osx/uname index 9fbfd567..c89ecc28 100644 --- a/tldr/osx/uname +++ b/tldr/osx/uname @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # uname > Print details about the current machine and the operating system running on it. -> Note: for additional information about the operating system, try the `sw_vers` command. +> Note: For additional information about the operating system, try the `sw_vers` command. > More information: . - Print kernel name: diff --git a/tldr/pathchk b/tldr/pathchk index e72ba181..049d9022 100644 --- a/tldr/pathchk +++ b/tldr/pathchk @@ -10,16 +10,16 @@ source: https://github.com/tldr-pages/tldr.git - Check pathnames for validity in the current system: -`pathchk {{path1 path2 …}}` +`pathchk {{path1 path2 ...}}` - Check pathnames for validity on a wider range of POSIX compliant systems: -`pathchk -p {{path1 path2 …}}` +`pathchk -p {{path1 path2 ...}}` - Check pathnames for validity on all POSIX compliant systems: -`pathchk {{[-p -P|--portability]}} {{path1 path2 …}}` +`pathchk {{[-p -P|--portability]}} {{path1 path2 ...}}` - Only check for empty pathnames or leading dashes (-): -`pathchk -P {{path1 path2 …}}` +`pathchk -P {{path1 path2 ...}}` diff --git a/tldr/pcapfix b/tldr/pcapfix index 4da280b2..ac0b7e37 100644 --- a/tldr/pcapfix +++ b/tldr/pcapfix @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Repair damaged or corrupted PCAP and PcapNG files. > More information: . -- Repair a PCAP/PCapNG file (Note: for PCAP files, only the first 262144 bytes of each packet are scanned): +- Repair a PCAP/PCapNG file (Note: For PCAP files, only the first 262144 bytes of each packet are scanned): `pcapfix {{path/to/file.pcapng}}` diff --git a/tldr/pnmmontage b/tldr/pnmmontage index fc2a9e8f..9c44eacb 100644 --- a/tldr/pnmmontage +++ b/tldr/pnmmontage @@ -12,7 +12,7 @@ source: https://github.com/tldr-pages/tldr.git `pnmmontage {{path/to/image1.pnm path/to/image2.pnm ...}} > {{path/to/output.pnm}}` -- Specify the quality of the packing (Note: larger values produce smaller packings but take longer to compute.): +- Specify the quality of the packing (Note: Larger values produce smaller packings but take longer to compute.): `pnmmontage -{{0..9}} {{path/to/image1.pnm path/to/image2.pnm ...}} > {{path/to/output.pnm}}` diff --git a/tldr/podman-login b/tldr/podman-login index a97d6103..be8998b2 100644 --- a/tldr/podman-login +++ b/tldr/podman-login @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # podman login > Log in to a container registry. -> Note: the default authfile path on Linux is `$XDG_RUNTIME_DIR/containers/auth.json`, which is usually stored in a `tmpfs` (in RAM). +> Note: The default authfile path on Linux is `$XDG_RUNTIME_DIR/containers/auth.json`, which is usually stored in a `tmpfs` (in RAM). > More information: . - Log in to a registry (non-persistent on Linux; persistent on Windows/macOS): diff --git a/tldr/prosodyctl b/tldr/prosodyctl index 40903c83..88a83420 100644 --- a/tldr/prosodyctl +++ b/tldr/prosodyctl @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # prosodyctl > The control tool for the Prosody XMPP server. -> Note: process management through `prosodyctl` is discouraged. Instead, use the tools provided by your system (e.g. `systemctl`). +> Note: Process management through `prosodyctl` is discouraged. Instead, use the tools provided by your system (e.g. `systemctl`). > More information: . - Show the status of the Prosody server: diff --git a/tldr/q b/tldr/q index 1ea38397..3a864f3e 100644 --- a/tldr/q +++ b/tldr/q @@ -28,6 +28,6 @@ source: https://github.com/tldr-pages/tldr.git `q "SELECT * FROM {{path/to/file}} f1 JOIN {{path/to/other_file}} f2 ON (f1.c1 = f2.c1)"` -- Format output using an output delimiter with an output header line (Note: command will output column names based on the input file header or the column aliases overridden in the query): +- Format output using an output delimiter with an output header line (Note: Command will output column names based on the input file header or the column aliases overridden in the query): `q {{[-D|--output-delimiter]}} {{delimiter}} {{[-O|--output-header]}} "SELECT {{column}} as {{alias}} from {{path/to/file}}"` diff --git a/tldr/racket b/tldr/racket index 8232bef8..8d68ddf3 100644 --- a/tldr/racket +++ b/tldr/racket @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # racket > Racket language interpreter. -> More information: . +> More information: . - Start a REPL (interactive shell): @@ -18,11 +18,11 @@ source: https://github.com/tldr-pages/tldr.git - Execute a Racket expression: -`racket --eval "{{expression}}"` +`racket {{[-e|--eval]}} "{{expression}}"` - Run module as a script (terminates option list): -`racket --lib {{module_name}} --main {{arguments}}` +`racket {{[-l|--lib]}} {{module_name}} {{[-m|--main]}} {{arguments}}` - Start a REPL (interactive shell) for the `typed/racket` hashlang: diff --git a/tldr/ruby b/tldr/ruby index 59293195..8901273f 100644 --- a/tldr/ruby +++ b/tldr/ruby @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Ruby programming language interpreter. > See also: `gem`, `bundler`, `rake`, `irb`. -> More information: . +> More information: . - Execute a Ruby script: diff --git a/tldr/rustc b/tldr/rustc index ba99c3c4..d2ab8a44 100644 --- a/tldr/rustc +++ b/tldr/rustc @@ -29,7 +29,7 @@ source: https://github.com/tldr-pages/tldr.git `rustc {{[-C|--codegen]}} target-cpu={{native}} {{path/to/main.rs}}` -- Display the target list (Note: you have to add a target using `rustup` first to be able to compile for it): +- Display the target list (Note: You have to add a target using `rustup` first to be able to compile for it): `rustc --print target-list` diff --git a/tldr/rustup-run b/tldr/rustup-run index 4514c4f2..6b8df7f9 100644 --- a/tldr/rustup-run +++ b/tldr/rustup-run @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # rustup run > Run a command with an environment configured for a Rust toolchain. -> Note: all commands managed by `rustup` have a shorthand for this: for example, `cargo +nightly build` is equivalent to `rustup run nightly cargo build`. +> Note: All commands managed by `rustup` have a shorthand for this: for example, `cargo +nightly build` is equivalent to `rustup run nightly cargo build`. > More information: . - Run a command using a given Rust toolchain (see `rustup help toolchain` for more information): diff --git a/tldr/rustup-toolchain b/tldr/rustup-toolchain index 74707aa1..bcc9cc7c 100644 --- a/tldr/rustup-toolchain +++ b/tldr/rustup-toolchain @@ -11,16 +11,16 @@ source: https://github.com/tldr-pages/tldr.git - Install or update a given toolchain: -`rustup install {{toolchain}}` +`rustup toolchain install {{toolchain}}` - Uninstall a toolchain: -`rustup uninstall {{toolchain}}` +`rustup toolchain uninstall {{toolchain}}` - List installed toolchains: -`rustup list` +`rustup toolchain list` - Create a custom toolchain by symlinking to a directory: -`rustup link {{custom_toolchain_name}} {{path/to/directory}}` +`rustup toolchain link {{custom_toolchain_name}} {{path/to/directory}}` diff --git a/tldr/samtools b/tldr/samtools index 75f9a046..aa6ea698 100644 --- a/tldr/samtools +++ b/tldr/samtools @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Tools for handling high-throughput sequencing (genomics) data. > Used for reading/writing/editing/indexing/viewing of data in SAM/BAM/CRAM format. -> More information: . +> More information: . - Convert a SAM input file to BAM stream and save to file: diff --git a/tldr/sngrep b/tldr/sngrep index 2286ef7c..94c9fdc1 100644 --- a/tldr/sngrep +++ b/tldr/sngrep @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # sngrep > Display SIP calls message flows from terminal. -> More information: . +> More information: . - Visualize SIP packets from a PCAP file: diff --git a/tldr/speedtest b/tldr/speedtest index 06039532..d2f7547c 100644 --- a/tldr/speedtest +++ b/tldr/speedtest @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # speedtest > Official command-line interface for testing internet bandwidth using . -> Note: some platforms link `speedtest` to `speedtest-cli` or other tools like `librespeed`, which can also be installed as `speedtest` on certain Linux distributions. +> Note: Some platforms link `speedtest` to `speedtest-cli` or other tools like `librespeed`, which can also be installed as `speedtest` on certain Linux distributions. > These command examples apply only to the official client. > More information: . diff --git a/tldr/swayidle b/tldr/swayidle index 027d3ef6..3c4d9bc9 100644 --- a/tldr/swayidle +++ b/tldr/swayidle @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # swayidle > Idle management daemon for Wayland. -> Note: the configuration options are documented in its man page. +> Note: The configuration options are documented in its man page. > More information: . - Listen for idle activity using the configuration in `$XDG_CONFIG_HOME/swayidle/config` or `$HOME/swayidle/config`: diff --git a/tldr/tailscale-up b/tldr/tailscale-up index d6d17e6c..f4ec8967 100644 --- a/tldr/tailscale-up +++ b/tldr/tailscale-up @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # tailscale up > Connect the client to the Tailscale network. -> Note: run `sudo tailscale set --operator $USER` to allow the current user to run these commands. +> Note: Run `sudo tailscale set --operator $USER` to allow the current user to run these commands. > All options described here can be changed later using `tailscale set --option argument`. Use `--option=false` to disable options that don't require arguments. > More information: . diff --git a/tldr/tarsnap b/tldr/tarsnap index 1ca5278d..99c27b3e 100644 --- a/tldr/tarsnap +++ b/tldr/tarsnap @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # tarsnap > Manipulate remote Tarsnap encrypted backups. -> Note: you don't need to specify the key file and the cache directory if you configure them in `/usr/local/etc/tarsnap.conf` or `~/.tarsnaprc`. +> Note: You don't need to specify the key file and the cache directory if you configure them in `/usr/local/etc/tarsnap.conf` or `~/.tarsnaprc`. > See also: `tarsnap-keygen`. > More information: . diff --git a/tldr/texcount b/tldr/texcount index 6a64817a..e5007885 100644 --- a/tldr/texcount +++ b/tldr/texcount @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # texcount > Count words in TeX documents omitting macros. -> Note: if the TeX document uses `\include` or `\input` and you want to count the included files, `texcount` must be run in the directory of the root TeX file. +> Note: If the TeX document uses `\include` or `\input` and you want to count the included files, `texcount` must be run in the directory of the root TeX file. > More information: . - Count words in a TeX file: diff --git a/tldr/tldr b/tldr/tldr index 2660565f..59d15fb9 100644 --- a/tldr/tldr +++ b/tldr/tldr @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # tldr > Display simple help pages for command-line tools from the tldr-pages project. -> Note: the `--language` and `--list` options are not required by the client specification, but most clients implement them. +> Note: The `--language` and `--list` options are not required by the client specification, but most clients implement them. > More information: . - Print the tldr page for a specific command (hint: this is how you got here!): diff --git a/tldr/type b/tldr/type index a761129a..f41f8c99 100644 --- a/tldr/type +++ b/tldr/type @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # type > Display the type of command the shell will execute. -> Note: all examples are not POSIX compliant. +> Note: All examples are not POSIX compliant. > More information: . - Display the type of a command: diff --git a/tldr/vboxmanage-extpack b/tldr/vboxmanage-extpack index 52cf7c65..6631af2b 100644 --- a/tldr/vboxmanage-extpack +++ b/tldr/vboxmanage-extpack @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Manage extension packs for Oracle VirtualBox. > More information: . -- Install extension packs to VirtualBox (Note: you need to remove the existing version of the extension pack before installing a new version.): +- Install extension packs to VirtualBox (Note: You need to remove the existing version of the extension pack before installing a new version.): `VBoxManage extpack install {{path/to/file.vbox-extpack}}` diff --git a/tldr/vcpkg b/tldr/vcpkg index fa073387..c1c5726c 100644 --- a/tldr/vcpkg +++ b/tldr/vcpkg @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # vcpkg > Package manager for C/C++ libraries. -> Note: packages are not installed in the system. To use them, you need to tell your build system (e.g. CMake) to use `vckg`. +> Note: Packages are not installed in the system. To use them, you need to tell your build system (e.g. CMake) to use `vckg`. > More information: . - Build and add package `libcurl` to the `vcpkg` environment: diff --git a/tldr/w3m b/tldr/w3m index e82faf7e..2bf97d97 100644 --- a/tldr/w3m +++ b/tldr/w3m @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > A text-based web browser. > Supports SSL and mouse input, even over SSH. -> More information: . +> More information: . - Open a URL: diff --git a/tldr/wal b/tldr/wal index 6f521f11..04320ff6 100644 --- a/tldr/wal +++ b/tldr/wal @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # wal > Create color schemes based on the dominant colors of a wallpaper. -> More information: . +> More information: . - Preview color scheme: diff --git a/tldr/windows/ospp.vbs b/tldr/windows/ospp.vbs index bcefb1e6..6b7ad497 100644 --- a/tldr/windows/ospp.vbs +++ b/tldr/windows/ospp.vbs @@ -6,10 +6,10 @@ source: https://github.com/tldr-pages/tldr.git # ospp.vbs > Install, activate, and manage volume licensed versions of Microsoft Office products. -> Note: this command may override, deactivate, and/or remove your current volume of licensed Office product versions, so please proceed cautiously. +> Note: This command may override, deactivate, and/or remove your current volume of licensed Office product versions, so please proceed cautiously. > More information: . -- Install a product key (Note: it replaces the existing key): +- Install a product key (Note: It replaces the existing key): `cscript ospp.vbs /inpkey:{{product_key}}` diff --git a/tldr/windows/reg-load b/tldr/windows/reg-load index c72ec0b3..b3cdb642 100644 --- a/tldr/windows/reg-load +++ b/tldr/windows/reg-load @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # reg load > Load saved subkeys into a different subkey in the registry. -> Note: this is intended for troubleshooting and temporary keys. +> Note: This is intended for troubleshooting and temporary keys. > More information: . - Load a backup file into the specified key: diff --git a/tldr/windows/wget b/tldr/windows/wget index fa9548b7..33c01600 100644 --- a/tldr/windows/wget +++ b/tldr/windows/wget @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # wget > In PowerShell, this command may be an alias of `Invoke-WebRequest` when the original `wget` program () is not properly installed. -> Note: if version command returns an error, PowerShell may have substituted this command with `Invoke-WebRequest`. +> Note: If version command returns an error, PowerShell may have substituted this command with `Invoke-WebRequest`. > More information: . - View documentation for the original `wget` command: diff --git a/tldr/xe b/tldr/xe index 7920372b..a843d647 100644 --- a/tldr/xe +++ b/tldr/xe @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # xe > Execute a command once for each line piped from another command or file. -> More information: . +> More information: . - Run a command once for each line of input data as arguments: diff --git a/tldr/xxh b/tldr/xxh index bf90bda0..b47fde58 100644 --- a/tldr/xxh +++ b/tldr/xxh @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # xxh > Bring your shell with all of your customizations through SSH sessions. -> Note: xxh does not install anything into system directories on the target machine; removing `~/.xxh` will clear all traces of xxh on the target machine. +> Note: `xxh` does not install anything into system directories on the target machine; removing `~/.xxh` will clear all traces of xxh on the target machine. > More information: . - Connect to a host and run the current shell: diff --git a/tldr/ykman-config b/tldr/ykman-config index 807271e0..4760fdbc 100644 --- a/tldr/ykman-config +++ b/tldr/ykman-config @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # ykman config > Enable or disable YubiKey applications. -> Note: you can use `ykman info` to see currently enabled applications. +> Note: You can use `ykman info` to see currently enabled applications. > More information: . - Enable an application over USB or NFC (`--enable` can be used multiple times to specify more applications): diff --git a/tldr/ykman-openpgp b/tldr/ykman-openpgp index fde3fe95..13711975 100644 --- a/tldr/ykman-openpgp +++ b/tldr/ykman-openpgp @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # ykman openpgp > Manage the OpenPGP YubiKey application. -> Note: you need to use `gpg --card-edit` for some settings. +> Note: You need to use `gpg --card-edit` for some settings. > More information: . - Display general information about the OpenPGP application: diff --git a/tldr/zfgrep b/tldr/zfgrep index a86eadc3..72f1e8e5 100644 --- a/tldr/zfgrep +++ b/tldr/zfgrep @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # zfgrep > Matches fixed strings in possibly compressed files. -> Equivalent to `grep -F` with input decompressed first if necessary. +> Equivalent to `grep --fixed-strings` with input decompressed first if necessary. > More information: . - Search for an exact string in a file: @@ -15,16 +15,16 @@ source: https://github.com/tldr-pages/tldr.git - Count the number of lines that match the given string in a file: -`zfgrep --count {{search_string}} {{path/to/file}}` +`zfgrep {{[-c|--count]}} {{search_string}} {{path/to/file}}` - Show the line number in the file along with the matching lines: -`zfgrep --line-number {{search_string}} {{path/to/file}}` +`zfgrep {{[-n|--line-number]}} {{search_string}} {{path/to/file}}` - Display all lines except those that contain the search string: -`zfgrep --invert-match {{search_string}} {{path/to/file}}` +`zfgrep {{[-v|--invert-match]}} {{search_string}} {{path/to/file}}` - List only filenames whose content matches the search string at least once: -`zfgrep --files-with-matches {{search_string}} {{path/to/file1 path/to/file2 ...}}` +`zfgrep {{[-l|--files-with-matches]}} {{search_string}} {{path/to/file1 path/to/file2 ...}}` diff --git a/tldr/zgrep b/tldr/zgrep index ea012556..1a4b7611 100644 --- a/tldr/zgrep +++ b/tldr/zgrep @@ -34,4 +34,4 @@ source: https://github.com/tldr-pages/tldr.git - Print 3 lines of [C]ontext around, [B]efore, or [A]fter each match: -`zgrep --{{context|before-context|after-context}} {{3}} {{pattern}} {{path/to/compressed/file}}` +`zgrep --{{context|before-context|after-context}} 3 {{pattern}} {{path/to/compressed/file}}`