diff --git a/tldr/astyle b/tldr/astyle index 7a8289b1..a8d228ea 100644 --- a/tldr/astyle +++ b/tldr/astyle @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # astyle -> Source code indenter, formatter, and beautifier for the C, C++, C# and Java programming languages. +> Source code indenter, formatter, and beautifier for the C, C++, C#, and Java programming languages. > Upon running, a copy of the original file is created with an ".orig" appended to the original file name. > More information: . diff --git a/tldr/bzgrep b/tldr/bzgrep index 4b3d7c4c..fca05a43 100644 --- a/tldr/bzgrep +++ b/tldr/bzgrep @@ -12,7 +12,7 @@ source: https://github.com/tldr-pages/tldr.git `bzgrep "{{search_pattern}}" {{path/to/file}}` -- Use extended `regex` (supports `?`, `+`, `{}`, `()` and `|`), in case-insensitive mode: +- Use extended `regex` (supports `?`, `+`, `{}`, `()`, and `|`), in case-insensitive mode: `bzgrep {{[-E|--extended-regexp]}} {{[-i|--ignore-case]}} "{{search_pattern}}" {{path/to/file}}` diff --git a/tldr/c++ b/tldr/c++ index 8aee43cc..527720df 100644 --- a/tldr/c++ +++ b/tldr/c++ @@ -7,6 +7,6 @@ source: https://github.com/tldr-pages/tldr.git > This command is an alias of `g++`. -- View documentation for original command: +- View documentation for the original command: `tldr g++` diff --git a/tldr/colima b/tldr/colima index 175ebed9..19759eb1 100644 --- a/tldr/colima +++ b/tldr/colima @@ -24,7 +24,7 @@ source: https://github.com/tldr-pages/tldr.git `colima start --kubernetes` -- Customize CPU count, RAM memory and disk space (in GiB): +- Customize CPU count, RAM memory, and disk space (in GiB): `colima start --cpu {{number}} --memory {{memory}} --disk {{storage_space}}` diff --git a/tldr/comm b/tldr/comm index 338c8bdf..678faa68 100644 --- a/tldr/comm +++ b/tldr/comm @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Select or reject lines common to two files. Both files must be sorted. > More information: . -- Produce three tab-separated columns: lines only in first file, lines only in second file and common lines: +- Produce three tab-separated columns: lines only in first file, lines only in second file, and common lines: `comm {{file1}} {{file2}}` diff --git a/tldr/coproc b/tldr/coproc index 6d128964..ace5f3df 100644 --- a/tldr/coproc +++ b/tldr/coproc @@ -34,4 +34,4 @@ source: https://github.com/tldr-pages/tldr.git - Create and use a coprocess running `bc`: -`coproc BC { bc --mathlib; }; echo "1/3" >&"${BC[1]}"; read <&"${BC[0]}" output; echo "$output"` +`coproc BC { bc {{[-l|--mathlib]}}; }; echo "1/3" >&"${BC[1]}"; read <&"${BC[0]}" output; echo "$output"` diff --git a/tldr/cron b/tldr/cron index c55090d3..15e2ef4e 100644 --- a/tldr/cron +++ b/tldr/cron @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # cron > A system scheduler for running jobs or tasks unattended. -> The command to submit, edit or delete entries to `cron` is called `crontab`. +> The command to submit, edit, or delete entries to `cron` is called `crontab`. - View documentation for managing `cron` entries: diff --git a/tldr/ebook-convert b/tldr/ebook-convert index e54dc6f7..332487e0 100644 --- a/tldr/ebook-convert +++ b/tldr/ebook-convert @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # ebook-convert -> Can be used to convert e-books between common formats, e.g. PDF, EPUB and MOBI. +> Can be used to convert e-books between common formats, e.g. PDF, EPUB, and MOBI. > Part of the Calibre e-book library tool. > More information: . @@ -13,6 +13,6 @@ source: https://github.com/tldr-pages/tldr.git `ebook-convert {{path/to/input_file}} {{output_file}}` -- Convert Markdown or HTML to e-book with TOC, title and author: +- Convert Markdown or HTML to e-book with TOC, title, and author: `ebook-convert {{path/to/input_file}} {{output_file}} --level1-toc="//h:h1" --level2-toc="//h:h2" --level3-toc="//h:h3" --title={{title}} --authors={{author}}` diff --git a/tldr/expo b/tldr/expo index ee73852f..585eae9f 100644 --- a/tldr/expo +++ b/tldr/expo @@ -22,7 +22,7 @@ source: https://github.com/tldr-pages/tldr.git - Install a dependency: -`expo install ` +`expo install {{package_name}}` - Prebuild native Android/iOS projects: diff --git a/tldr/fselect b/tldr/fselect index 6ebbca17..e719a038 100644 --- a/tldr/fselect +++ b/tldr/fselect @@ -24,6 +24,6 @@ source: https://github.com/tldr-pages/tldr.git `fselect size, path from {{path/to/directory}} limit {{5}} into json` -- Use SQL aggregate functions to calculate minimum, maximum and average size of files in a directory: +- Use SQL aggregate functions to calculate minimum, maximum, and average size of files in a directory: `fselect "{{MIN(size), MAX(size), AVG(size), SUM(size), COUNT(*)}} from {{path/to/directory}}"` diff --git a/tldr/gdown b/tldr/gdown index 6ed74f5b..6cceb539 100644 --- a/tldr/gdown +++ b/tldr/gdown @@ -24,6 +24,6 @@ source: https://github.com/tldr-pages/tldr.git `gdown {{folder_id|url}} {{[-O|--output]}} {{path/to/output_directory}} --folder` -- Download a tar archive, write it to `stdout` and extract it: +- Download a tar archive, write it to `stdout`, and extract it: `gdown {{tar_url}} {{[-O|--output]}} - {{[-q|--quiet]}} | tar xvf -` diff --git a/tldr/gnmic b/tldr/gnmic index b8a425d0..b8d3ca73 100644 --- a/tldr/gnmic +++ b/tldr/gnmic @@ -27,4 +27,4 @@ source: https://github.com/tldr-pages/tldr.git - Subscribe to target state updates under the subtree at a specific path: -`gnmic {{[-a|--address]}} {{ip:port}} subscribe --path {{path}}` +`gnmic {{[-a|--address]}} {{ip:port}} {{[sub|subscribe]}} --path {{path}}` diff --git a/tldr/gnmic-get b/tldr/gnmic-get index a1143940..47e1dd44 100644 --- a/tldr/gnmic-get +++ b/tldr/gnmic-get @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # gnmic get > Get a snapshot of a gnmi network device operation data. -> More information: . +> More information: . - Get a snapshot of the device state at a specific path: diff --git a/tldr/gnmic-set b/tldr/gnmic-set index 03f2080b..5edf1979 100644 --- a/tldr/gnmic-set +++ b/tldr/gnmic-set @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # gnmic set > Modify gnmi network device configuration. -> More information: . +> More information: . - Update the value of a path: diff --git a/tldr/gnmic-subscribe b/tldr/gnmic-subscribe index cc9db8e8..eb892952 100644 --- a/tldr/gnmic-subscribe +++ b/tldr/gnmic-subscribe @@ -6,24 +6,24 @@ source: https://github.com/tldr-pages/tldr.git # gnmic subscribe > Subscribe to a gnmic network device state updates. -> More information: . +> More information: . - Subscribe to target state updates under the subtree of a specific path: -`gnmic {{[-a|--address]}} {{ip:port}} subscribe --path {{path}}` +`gnmic {{[-a|--address]}} {{ip:port}} {{[sub|subscribe]}} --path {{path}}` - Subscribe to a target with a sample interval of 30s (default is 10s): -`gnmic {{[-a|--address]}} {{ip:port}} subscribe --path {{path}} --sample-interval 30s` +`gnmic {{[-a|--address]}} {{ip:port}} {{[sub|subscribe]}} --path {{path}} --sample-interval 30s` - Subscribe to a target with sample interval and updates only on change: -`gnmic {{[-a|--address]}} {{ip:port}} subscribe --path {{path}} --stream-mode on-change --heartbeat-interval {{1m}}` +`gnmic {{[-a|--address]}} {{ip:port}} {{[sub|subscribe]}} --path {{path}} --stream-mode on-change --heartbeat-interval {{1m}}` - Subscribe to a target for only one update: -`gnmic {{[-a|--address]}} {{ip:port}} subscribe --path {{path}} --mode once` +`gnmic {{[-a|--address]}} {{ip:port}} {{[sub|subscribe]}} --path {{path}} --mode once` - Subscribe to a target and specify response encoding (json_ietf): -`gnmic {{[-a|--address]}} {{ip:port}} subscribe --path {{path}} {{[-e|--encoding]}} json_ietf` +`gnmic {{[-a|--address]}} {{ip:port}} {{[sub|subscribe]}} --path {{path}} {{[-e|--encoding]}} json_ietf` diff --git a/tldr/gource b/tldr/gource index 35fa8e13..bd5b250a 100644 --- a/tldr/gource +++ b/tldr/gource @@ -5,8 +5,8 @@ source: https://github.com/tldr-pages/tldr.git --- # gource -> Renders an animated tree diagram of Git, SVN, Mercurial and Bazaar repositories. -> It shows files and directories being created, modified or removed over time. +> Renders an animated tree diagram of Git, SVN, Mercurial, and Bazaar repositories. +> It shows files and directories being created, modified, or removed over time. > More information: . - Run gource in a directory (if it isn't the repository's root directory, the root is sought up from there): diff --git a/tldr/kaggle-config b/tldr/kaggle-config new file mode 100644 index 00000000..d1ef1201 --- /dev/null +++ b/tldr/kaggle-config @@ -0,0 +1,21 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# kaggle config + +> Manage Kaggle configuration. +> More information: . + +- View current configuration values: + +`kaggle config view` + +- Set a configuration value: + +`kaggle config set {{[-n|--name]}} {{configuration_parameter}} {{[-v|--value]}} {{parameter_value}}` + +- Clear a configuration value: + +`kaggle config unset {{[-n|--name]}} {{configuration_parameter}}` diff --git a/tldr/less-than b/tldr/less-than index 5ea716a8..ab309417 100644 --- a/tldr/less-than +++ b/tldr/less-than @@ -32,7 +32,7 @@ source: https://github.com/tldr-pages/tldr.git `cat <<- {{EOF}} > {{path/to/file.txt}} {{multiline_data}} {{EOF}}` -- Pass command output to a program as a file descriptor: +- Pass command output to a program as a file descriptor (Note: unlike the rest of these, this replaces the argument in-place with a file path like `/dev/fd/63`): `diff <({{command1}}) <({{command2}})` diff --git a/tldr/linux/ark-survival-ascended b/tldr/linux/ark-survival-ascended index 5172b3d9..131a8c66 100644 --- a/tldr/linux/ark-survival-ascended +++ b/tldr/linux/ark-survival-ascended @@ -34,7 +34,7 @@ source: https://github.com/tldr-pages/tldr.git - Enable specific mods by their ID (comma-separated): -`{{path/to/ArkAscendedServer}} {{TheIsland_WP}} -mods={{mod_id1, mod_id2, ...}}` +`{{path/to/ArkAscendedServer}} {{TheIsland_WP}} -mods={{mod_id1,mod_id2,...}}` - Allow connections from specific platforms: diff --git a/tldr/linux/semanage-fcontext b/tldr/linux/semanage-fcontext index 1db6f4c5..7383c717 100644 --- a/tldr/linux/semanage-fcontext +++ b/tldr/linux/semanage-fcontext @@ -21,6 +21,10 @@ source: https://github.com/tldr-pages/tldr.git `sudo semanage fcontext {{[-a|--add]}} {{[-t|--type]}} {{samba_share_t}} '{{/mnt/share(/.*)?}}'` +- Add a user-defined rule that creates a labeling equivalence between two subpaths: + +`sudo semanage fcontext {{[-a|--add]}} {{[-e|--equal]}} /{{path/to/ref}} /{{path/to/target}}` + - Delete a user-defined rule using its PCRE `regex`: `sudo semanage fcontext {{[-d|--delete]}} '{{/mnt/share(/.*)?}}'` diff --git a/tldr/linux/tftp b/tldr/linux/tftp index 97372823..c60c51af 100644 --- a/tldr/linux/tftp +++ b/tldr/linux/tftp @@ -20,7 +20,7 @@ source: https://github.com/tldr-pages/tldr.git `tftp {{server_ip}} -6 -R {{port}}:{{port}}` -- Set the transfer mode to binary or ASCIi through the tftp client: +- Set the transfer mode to binary or ASCII through the tftp client: `mode {{binary|ascii}}` diff --git a/tldr/liquidctl b/tldr/liquidctl index 1c0a6354..528b78a0 100644 --- a/tldr/liquidctl +++ b/tldr/liquidctl @@ -20,6 +20,6 @@ source: https://github.com/tldr-pages/tldr.git `liquidctl status` -- Match a string in product name to pick a device and set its fan speed to 0% at 20°C, 50% at 50°C and 100% at 70°C: +- Match a string in product name to pick a device and set its fan speed to 0% at 20°C, 50% at 50°C, and 100% at 70°C: `liquidctl {{[-m|--match]}} {{string}} set fan speed {{20 0 50 50 70 100}}` diff --git a/tldr/minikube b/tldr/minikube index 70ebb0e9..79cfc834 100644 --- a/tldr/minikube +++ b/tldr/minikube @@ -16,7 +16,7 @@ source: https://github.com/tldr-pages/tldr.git `minikube ip` -- Access a service named my_service exposed via a node port and get the URL: +- Access a service named `my_service` exposed via a node port and get the URL: `minikube service {{my_service}} --url` diff --git a/tldr/ncc b/tldr/ncc index 73db40bd..0ff283cb 100644 --- a/tldr/ncc +++ b/tldr/ncc @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # ncc > Compile a Node.js application into a single file. -> Supports TypeScript, binary addons and dynamic requires. +> Supports TypeScript, binary addons, and dynamic requires. > More information: . - Bundle a Node.js application: diff --git a/tldr/npm-explain b/tldr/npm-explain index 7367ce95..057c72b5 100644 --- a/tldr/npm-explain +++ b/tldr/npm-explain @@ -10,16 +10,16 @@ source: https://github.com/tldr-pages/tldr.git - Explain why a specific package is installed: -`npm explain {{package_name}}` +`npm {{[why|explain]}} {{package_name}}` - Show explanation in JSON format: -`npm explain {{package_name}} --json` +`npm {{[why|explain]}} {{package_name}} --json` - Include peer dependencies in the explanation: -`npm explain {{package_name}} --include peer` +`npm {{[why|explain]}} {{package_name}} --include peer` - Limit explanation depth to 2 levels deep: -`npm explain {{package_name}} --depth 2` +`npm {{[why|explain]}} {{package_name}} --depth 2` diff --git a/tldr/npm-install-test b/tldr/npm-install-test index 6b6ed422..57be1f12 100644 --- a/tldr/npm-install-test +++ b/tldr/npm-install-test @@ -11,16 +11,16 @@ source: https://github.com/tldr-pages/tldr.git - Install all dependencies and then run tests: -`npm install-test` +`npm {{[it|install-test]}}` - Install a specific package and then run tests: -`npm install-test {{package_name}}` +`npm {{[it|install-test]}} {{package_name}}` - Install a package and save it as a dependency before running tests: -`npm install-test {{package_name}} {{[-S|--save]}}` +`npm {{[it|install-test]}} {{package_name}} {{[-S|--save]}}` - Install dependencies globally and then run tests: -`npm install-test {{[-g|--global]}}` +`npm {{[it|install-test]}} {{[-g|--global]}}` diff --git a/tldr/npm-link b/tldr/npm-link index d2537f71..7fcb5ed3 100644 --- a/tldr/npm-link +++ b/tldr/npm-link @@ -10,12 +10,12 @@ source: https://github.com/tldr-pages/tldr.git - Symlink the current package globally: -`npm link` +`npm {{[ln|link]}}` - Link a globally linked package into another project's `node_modules`: -`npm link {{package_name}}` +`npm {{[ln|link]}} {{package_name}}` - Unlink a package from the current project: -`npm unlink {{package_name}}` +`npm {{[r|unlink]}} {{package_name}}` diff --git a/tldr/packwiz b/tldr/packwiz index 4637b145..90575bc3 100644 --- a/tldr/packwiz +++ b/tldr/packwiz @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # packwiz -> Create, edit and manage Minecraft modpacks. +> Create, edit, and manage Minecraft modpacks. > More information: . - Interactively create a new modpack in the current directory: diff --git a/tldr/pamvalidate b/tldr/pamvalidate index 75bf15c2..c9faa6d4 100644 --- a/tldr/pamvalidate +++ b/tldr/pamvalidate @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # pamvalidate -> Validate PAM, PGM, PBM and PPM files. +> Validate PAM, PGM, PBM, and PPM files. > See also: `pamfile`, `pamfix`. > More information: . diff --git a/tldr/parquet-tools b/tldr/parquet-tools index 2024f6da..b4c56810 100644 --- a/tldr/parquet-tools +++ b/tldr/parquet-tools @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # parquet-tools -> Show, inspect and manipulate Parquet file. +> Show, inspect, and manipulate Parquet file. > More information: . - Display the content of a Parquet file: diff --git a/tldr/pdftotext b/tldr/pdftotext index 3e3aee84..cf05cd7b 100644 --- a/tldr/pdftotext +++ b/tldr/pdftotext @@ -24,6 +24,6 @@ source: https://github.com/tldr-pages/tldr.git `pdftotext {{input.pdf}} {{output.txt}}` -- Convert pages 2, 3 and 4 of `input.pdf` to plain text and save them as `output.txt`: +- Convert pages 2, 3, and 4 of `input.pdf` to plain text and save them as `output.txt`: `pdftotext -f {{2}} -l {{4}} {{input.pdf}} {{output.txt}}` diff --git a/tldr/php-yii b/tldr/php-yii index c7c47716..1d207992 100644 --- a/tldr/php-yii +++ b/tldr/php-yii @@ -12,7 +12,7 @@ source: https://github.com/tldr-pages/tldr.git `php yii {{serve}}` -- Generate a controller, views and related files for the CRUD actions on the specified model class: +- Generate a controller, views, and related files for the CRUD actions on the specified model class: `php yii {{gii/crud}} --modelClass={{ModelName}} --controllerClass={{ControllerName}}` diff --git a/tldr/pio-org b/tldr/pio-org index a334ea5a..03515251 100644 --- a/tldr/pio-org +++ b/tldr/pio-org @@ -28,6 +28,6 @@ source: https://github.com/tldr-pages/tldr.git `pio org list` -- Update the name, email or display name of an organization: +- Update the name, email, or display name of an organization: `pio org update --orgname {{new_organization_name}} --email {{new_email}} --displayname {{new_display_name}} {{organization_name}}` diff --git a/tldr/pio-settings b/tldr/pio-settings index 360c295d..b314bb19 100644 --- a/tldr/pio-settings +++ b/tldr/pio-settings @@ -8,11 +8,11 @@ source: https://github.com/tldr-pages/tldr.git > View and modify PlatformIO settings. > More information: . -- Display the names, values and descriptions of all PlatformIO settings: +- Display the names, values, and descriptions of all PlatformIO settings: `pio settings get` -- Display the name, value and description of a specific PlatformIO setting: +- Display the name, value, and description of a specific PlatformIO setting: `pio settings get {{setting}}` diff --git a/tldr/pio-system b/tldr/pio-system index 4bd4b781..987e027d 100644 --- a/tldr/pio-system +++ b/tldr/pio-system @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Miscellaneous system commands for PlatformIO. > More information: . -- Install shell completion for the current shell (supports Bash, fish, Zsh and PowerShell): +- Install shell completion for the current shell (supports Bash, fish, Zsh, and PowerShell): `pio system completion install` diff --git a/tldr/pio-update b/tldr/pio-update index 1986a1ca..97dcec17 100644 --- a/tldr/pio-update +++ b/tldr/pio-update @@ -5,11 +5,11 @@ source: https://github.com/tldr-pages/tldr.git --- # pio update -> Update installed PlatformIO Core packages, development platforms and global libraries. +> Update installed PlatformIO Core packages, development platforms, and global libraries. > See also: `pio platform update`, `pio lib update`. > More information: . -- Perform a full update of all packages, development platforms and global libraries: +- Perform a full update of all packages, development platforms, and global libraries: `pio update` @@ -17,6 +17,6 @@ source: https://github.com/tldr-pages/tldr.git `pio update --core-packages` -- Check for new versions of packages, platforms and libraries but do not actually update them: +- Check for new versions of packages, platforms, and libraries but do not actually update them: `pio update --dry-run` diff --git a/tldr/ppmdither b/tldr/ppmdither index 23a50007..bf3a8076 100644 --- a/tldr/ppmdither +++ b/tldr/ppmdither @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Reduce the number of colors in an image by applying dithering. > More information: . -- Read a PPM image, apply dithering and save it to a file: +- Read a PPM image, apply dithering, and save it to a file: `ppmdither {{path/to/image.ppm}} > {{path/to/file.ppm}}` diff --git a/tldr/ppmlabel b/tldr/ppmlabel index ab5f9c28..2a2a229e 100644 --- a/tldr/ppmlabel +++ b/tldr/ppmlabel @@ -16,6 +16,6 @@ source: https://github.com/tldr-pages/tldr.git `ppmlabel -x {{pos_x1}} -y {{pos_y1}} {{[-t|-text]}} {{text1}} -x {{pos_x2}} -y {{pos_y2}} {{[-t|-text]}} {{text2}} {{path/to/input_file.ppm}} > {{path/to/output_file.ppm}}` -- Specify the line color, the background color, the tilt and the size of the added text: +- Specify the line color, the background color, the tilt, and the size of the added text: `ppmlabel -x {{pos_x}} -y {{pos_y}} {{[-c|-color]}} {{line_color}} {{[-b|-background]}} {{background_color}} {{[-a|-angle]}} {{tilt}} {{[-s|-size]}} {{size}} {{[-t|-text]}} {{text}} {{path/to/input_file.ppm}} > {{path/to/output_file.ppm}}` diff --git a/tldr/ppmtoeyuv b/tldr/ppmtoeyuv index ba5189be..cc6a6b45 100644 --- a/tldr/ppmtoeyuv +++ b/tldr/ppmtoeyuv @@ -8,6 +8,6 @@ source: https://github.com/tldr-pages/tldr.git > Convert a PPM image to an Berkeley YUV file. > More information: . -- Read a PPM image from the input file, convert it to a Berkeley YUV image and store it in the specified output file: +- Read a PPM image from the input file, convert it to a Berkeley YUV image, and store it in the specified output file: `ppmtoeyuv {{path/to/input_file.ppm}} > {{path/to/output_file.eyuv}}` diff --git a/tldr/ppmtoppm b/tldr/ppmtoppm index f435f788..33b160ab 100644 --- a/tldr/ppmtoppm +++ b/tldr/ppmtoppm @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Copy a PPM image. > More information: . -- Copy a PPM image (i.e. a PBM, PGM or PPM image) from `stdin` to `stdout`: +- Copy a PPM image (i.e. a PBM, PGM, or PPM image) from `stdin` to `stdout`: `ppmtoppm < {{path/to/image.ppm}} > {{path/to/output.ppm}}` diff --git a/tldr/ppmtoyuv b/tldr/ppmtoyuv index 68403912..81e04f5d 100644 --- a/tldr/ppmtoyuv +++ b/tldr/ppmtoyuv @@ -8,6 +8,6 @@ source: https://github.com/tldr-pages/tldr.git > Convert a PPM image to an Abekas YUV file. > More information: . -- Read a PPM image from the input file, convert it to an Abekas YUV image and store it in the specified output file: +- Read a PPM image from the input file, convert it to an Abekas YUV image, and store it in the specified output file: `ppmtoyuv {{path/to/input_file.ppm}} > {{path/to/output_file.yuv}}` diff --git a/tldr/quarto b/tldr/quarto index ee9b9c31..199e500f 100644 --- a/tldr/quarto +++ b/tldr/quarto @@ -24,6 +24,6 @@ source: https://github.com/tldr-pages/tldr.git `quarto preview {{path/to/destination_directory|path/to/file}}` -- Publish a document or project to Quarto Pub, Github Pages, RStudio Connect or Netlify: +- Publish a document or project to Quarto Pub, Github Pages, RStudio Connect, or Netlify: `quarto publish {{quarto-pub|gh-pages|connect|netlify}}` diff --git a/tldr/rage b/tldr/rage index cde262e2..3fcfdff8 100644 --- a/tldr/rage +++ b/tldr/rage @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # rage -> A simple, secure and modern file encryption tool (and Rust library) with small explicit keys, no configuration options, and UNIX-style composability. +> A simple, secure, and modern file encryption tool (and Rust library) with small explicit keys, no configuration options, and UNIX-style composability. > Rust implementation of `age`. > More information: . diff --git a/tldr/rails-generate b/tldr/rails-generate index fc1ce432..09fd0d4d 100644 --- a/tldr/rails-generate +++ b/tldr/rails-generate @@ -16,7 +16,7 @@ source: https://github.com/tldr-pages/tldr.git `rails generate model {{Post}} {{title:string}} {{body:text}}` -- Generate a new controller named Posts with actions index, show, new and create: +- Generate a new controller named Posts with actions index, show, new, and create: `rails generate controller {{Posts}} {{index}} {{show}} {{new}} {{create}}` diff --git a/tldr/rbash b/tldr/rbash index 3b5bdd08..d56452ab 100644 --- a/tldr/rbash +++ b/tldr/rbash @@ -7,7 +7,6 @@ source: https://github.com/tldr-pages/tldr.git > Restricted Bash shell, equivalent to `bash --restricted`. > Does not permit changing the working directory, redirecting command output, or modifying environment variables, among other things. -> See also: `histexpand` for history expansion. > More information: . - Start an interactive shell session: diff --git a/tldr/rclone b/tldr/rclone index e53f43ea..b4194a39 100644 --- a/tldr/rclone +++ b/tldr/rclone @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # rclone -> Copy, synchronize or move files and directories to and from many cloud services. +> Copy, synchronize, or move files and directories to and from many cloud services. > More information: . - Launch an interactive menu to setup rclone: diff --git a/tldr/rgrep b/tldr/rgrep index 9a2a16f5..333019cd 100644 --- a/tldr/rgrep +++ b/tldr/rgrep @@ -17,7 +17,7 @@ source: https://github.com/tldr-pages/tldr.git `rgrep {{[-i|--ignore-case]}} "{{search_pattern}}"` -- Recursively search for an extended `regex` pattern (supports `?`, `+`, `{}`, `()` and `|`) in the current working directory: +- Recursively search for an extended `regex` pattern (supports `?`, `+`, `{}`, `()`, and `|`) in the current working directory: `rgrep {{[-E|--extended-regexp]}} "{{search_pattern}}"` diff --git a/tldr/rlwrap b/tldr/rlwrap index d5fbb6e5..6bcc2d83 100644 --- a/tldr/rlwrap +++ b/tldr/rlwrap @@ -5,10 +5,10 @@ source: https://github.com/tldr-pages/tldr.git --- # rlwrap -> Add line editing, persistent history and prompt completion to a REPL command. +> Add line editing, persistent history, and prompt completion to a REPL command. > More information: . -- Run a REPL command with line editing, persistent history and prompt completion: +- Run a REPL command with line editing, persistent history, and prompt completion: `rlwrap {{command}}` @@ -24,6 +24,6 @@ source: https://github.com/tldr-pages/tldr.git `rlwrap {{[-c|--complete-filenames]}} {{command}}` -- Add coloured prompts, use colour name, or an ASCI-conformant colour specification. Use an uppercase colour name for bold styling: +- Add coloured prompts, use colour name or an ANSI-conformant colour specification. Use an uppercase colour name for bold styling: `rlwrap {{[-p|--prompt-colour=]}}{{black|red|green|yellow|blue|cyan|purple|white|colour_spec}} {{command}}` diff --git a/tldr/roll b/tldr/roll index c13b6559..ff9f71c2 100644 --- a/tldr/roll +++ b/tldr/roll @@ -12,11 +12,11 @@ source: https://github.com/tldr-pages/tldr.git `roll {{3d}}` -- Roll 1 8-sided die, add 3 and sum the results: +- Roll 1 8-sided die, add 3, and sum the results: `roll {{d8 + 3}}` -- Roll 4 6-sided dice, keep the 3 highest results and sum the results: +- Roll 4 6-sided dice, keep the 3 highest results, and sum the results: `roll {{4d6h3}}` diff --git a/tldr/rsync b/tldr/rsync index 9db23ddc..e484a720 100644 --- a/tldr/rsync +++ b/tldr/rsync @@ -13,7 +13,7 @@ source: https://github.com/tldr-pages/tldr.git `rsync {{path/to/source}} {{path/to/destination}}` -- Use archive mode (recursively copy directories, copy symlinks without resolving, and preserve permissions, ownership and modification times): +- Use archive mode (recursively copy directories, copy symlinks without resolving, and preserve permissions, ownership, and modification times): `rsync {{[-a|--archive]}} {{path/to/source}} {{path/to/destination}}` diff --git a/tldr/rustup-set b/tldr/rustup-set index 1eb3d479..971514a0 100644 --- a/tldr/rustup-set +++ b/tldr/rustup-set @@ -12,7 +12,7 @@ source: https://github.com/tldr-pages/tldr.git `rustup set default-host {{host_triple}}` -- Set the default profile (`minimal` includes only `rustc`, `rust-std` and `cargo`, whereas `default` adds `rust-docs`, `rustfmt` and `clippy`): +- Set the default profile (`minimal` includes only `rustc`, `rust-std`, and `cargo`, whereas `default` adds `rust-docs`, `rustfmt`, and `clippy`): `rustup set profile {{minimal|default}}` diff --git a/tldr/sfdk-config b/tldr/sfdk-config index b8c7668a..8852c3f9 100644 --- a/tldr/sfdk-config +++ b/tldr/sfdk-config @@ -28,6 +28,6 @@ source: https://github.com/tldr-pages/tldr.git `sfdk --drop {{name}}` -- Run subcommand in specified scope (`global`, `session` or `command`): +- Run subcommand in specified scope (`global`, `session`, or `command`): `sfdk config --{{scope}} {{subcommand}}` diff --git a/tldr/sfdk-deploy b/tldr/sfdk-deploy index 0318f3f2..dfc505f4 100644 --- a/tldr/sfdk-deploy +++ b/tldr/sfdk-deploy @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Deploy build results to a device. > More information: . -- Deploy using a specified method (`pkcon`, `rsync`, `sdk`, `zypper`, `zypper-dup` or `manual`): +- Deploy using a specified method (`pkcon`, `rsync`, `sdk`, `zypper`, `zypper-dup`, or `manual`): `sfdk deploy --{{method}}` @@ -24,6 +24,6 @@ source: https://github.com/tldr-pages/tldr.git `sfdk deploy --{{method}} "-ignore*"` -- Undeploy using a specified method (`pkcon`, `rpm`, `rsync`, `sdk` or `zypper`): +- Undeploy using a specified method (`pkcon`, `rpm`, `rsync`, `sdk`, or `zypper`): `sfdk undeploy --{{method}}` diff --git a/tldr/sfdk-undeploy b/tldr/sfdk-undeploy index 2731f981..8109c201 100644 --- a/tldr/sfdk-undeploy +++ b/tldr/sfdk-undeploy @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Undeploy build results from a device. > More information: . -- Undeploy using a specified method (`pkcon`, `rpm`, `rsync`, `sdk` or `zypper`): +- Undeploy using a specified method (`pkcon`, `rpm`, `rsync`, `sdk`, or `zypper`): `sfdk undeploy --{{method}}` diff --git a/tldr/sox b/tldr/sox index b420f5ec..18a88175 100644 --- a/tldr/sox +++ b/tldr/sox @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # sox -> Sound eXchange: play, record and convert audio files. +> Sound eXchange: play, record, and convert audio files. > Audio formats are identified by the extension. > More information: . diff --git a/tldr/sui-client-ptb b/tldr/sui-client-ptb index 62ba6985..93f7b075 100644 --- a/tldr/sui-client-ptb +++ b/tldr/sui-client-ptb @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # sui client ptb -> Create, sign and execute programmable transaction blocks. +> Create, sign, and execute programmable transaction blocks. > More information: . - Call a Move function from a package and module: @@ -24,6 +24,6 @@ source: https://github.com/tldr-pages/tldr.git `sui client ptb --transfer-objects "[{{object_id}}]" @{{address}}` -- Publish a Move package, and transfer the upgrade capability to sender: +- Publish a Move package and transfer the upgrade capability to sender: `sui client ptb --move-call sui::tx_context::sender --assign sender --publish "." --assign upgrade_cap --transfer-objects "[upgrade_cap]" sender` diff --git a/tldr/swift b/tldr/swift index 80b3881a..f1d539ea 100644 --- a/tldr/swift +++ b/tldr/swift @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # swift -> Create, run and build Swift projects. +> Create, run, and build Swift projects. > More information: . - Start a REPL (interactive shell): diff --git a/tldr/ugrep b/tldr/ugrep index a281ec89..5be138c6 100644 --- a/tldr/ugrep +++ b/tldr/ugrep @@ -24,7 +24,7 @@ source: https://github.com/tldr-pages/tldr.git `ugrep {{[-l|--files-with-matches]}} "{{search_pattern}}"` -- Fuzzy search files with up to 3 extra, missing or mismatching characters in the pattern: +- Fuzzy search files with up to 3 extra, missing, or mismatching characters in the pattern: `ugrep {{[-Z|--fuzzy=]}}{{3}} "{{search_pattern}}"` diff --git a/tldr/uname b/tldr/uname index 092d11b6..8d8a8f4f 100644 --- a/tldr/uname +++ b/tldr/uname @@ -21,7 +21,7 @@ source: https://github.com/tldr-pages/tldr.git `uname {{[-mp|--machine --processor]}}` -- Print kernel name, kernel release and kernel version: +- Print kernel name, kernel release, and kernel version: `uname {{[-srv|--kernel-name --kernel-release --kernel-version]}}` diff --git a/tldr/verilator b/tldr/verilator index 2a56739e..85448d23 100644 --- a/tldr/verilator +++ b/tldr/verilator @@ -20,6 +20,6 @@ source: https://github.com/tldr-pages/tldr.git `verilator --lint-only -Wall` -- Create XML output about the design (files, modules, instance hierarchy, logic and data types) to feed into other tools: +- Create XML output about the design (files, modules, instance hierarchy, logic, and data types) to feed into other tools: `verilator --xml-output -Wall {{path/to/output.xml}}` diff --git a/tldr/virsh b/tldr/virsh index 127e2187..e182802d 100644 --- a/tldr/virsh +++ b/tldr/virsh @@ -5,7 +5,8 @@ source: https://github.com/tldr-pages/tldr.git --- # virsh -> Manage `virsh` guest domains. (Note: `guest_id` can be the ID, name or UUID of the guest). +> Manage `virsh` guest domains. +> Note: `guest_id` can be the ID, name, or UUID of the guest. > Some subcommands such as `list` have their own usage documentation. > More information: . diff --git a/tldr/windows/ren b/tldr/windows/ren index 005abfae..5b2b6489 100644 --- a/tldr/windows/ren +++ b/tldr/windows/ren @@ -7,6 +7,6 @@ source: https://github.com/tldr-pages/tldr.git > This command is an alias of `Rename-Item`. -- View documentation for original command: +- View documentation for the original command: `tldr Rename-Item` diff --git a/tldr/windows/rni b/tldr/windows/rni index 0817fc25..17e055b8 100644 --- a/tldr/windows/rni +++ b/tldr/windows/rni @@ -7,6 +7,6 @@ source: https://github.com/tldr-pages/tldr.git > This command is an alias of `Rename-Item`. -- View documentation for original command: +- View documentation for the original command: `tldr Rename-Item` diff --git a/tldr/xargs b/tldr/xargs index 6c714bd2..a7e972ff 100644 --- a/tldr/xargs +++ b/tldr/xargs @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # xargs > Execute a command with piped arguments coming from another command, a file, etc. -> The input is treated as a single block of text and split into separate pieces on spaces, tabs, newlines and end-of-file. +> The input is treated as a single block of text and split into separate pieces on spaces, tabs, newlines, and end-of-file. > More information: . - Run a command using the input data as arguments: @@ -17,7 +17,7 @@ source: https://github.com/tldr-pages/tldr.git `{{arguments_source}} | xargs sh -c "{{command1}} && {{command2}} | {{command3}}"` -- Gzip all files with `.log` extension taking advantage of multiple threads (`-print0` uses a null character to split file names, and `-0` uses it as delimiter): +- Gzip all files with `.log` extension taking advantage of multiple threads (`-print0` uses a null character to split file names and `--null` uses it as delimiter): `find . -name '*.log' -print0 | xargs {{[-0|--null]}} {{[-P|--max-procs]}} {{4}} {{[-n|--max-args]}} 1 gzip` diff --git a/tldr/xml b/tldr/xml index 9f007020..9cac3b6b 100644 --- a/tldr/xml +++ b/tldr/xml @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # xml -> XMLStarlet Toolkit: query, edit, check, convert and transform XML documents. +> XMLStarlet Toolkit: query, edit, check, convert, and transform XML documents. > Some subcommands such as `xml validate` have their own usage documentation. > More information: . diff --git a/tldr/xzgrep b/tldr/xzgrep index b7c2d30b..16be448f 100644 --- a/tldr/xzgrep +++ b/tldr/xzgrep @@ -21,7 +21,7 @@ source: https://github.com/tldr-pages/tldr.git `xzgrep {{[-n|--line-number]}} "{{search_pattern}}" {{path/to/file}}` -- Use extended `regex` (supports `?`, `+`, `{}`, `()` and `|`), in case-insensitive mode: +- Use extended `regex` (supports `?`, `+`, `{}`, `()`, and `|`), in case-insensitive mode: `xzgrep {{[-E|--extended-regexp]}} {{[-i|--ignore-case]}} "{{search_pattern}}" {{path/to/file}}` diff --git a/tldr/yolo b/tldr/yolo index bf7824fb..b0f871e3 100644 --- a/tldr/yolo +++ b/tldr/yolo @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # yolo -> Train, validate or infer models on various tasks and versions. +> Train, validate, or infer models on various tasks and versions. > More information: . - Create a copy of the default configuration in your current working directory: diff --git a/tldr/zipgrep b/tldr/zipgrep index 2568f853..a5bd6821 100644 --- a/tldr/zipgrep +++ b/tldr/zipgrep @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # zipgrep -> Find patterns in files in a Zip archive using extended `regex` (supports `?`, `+`, `{}`, `()` and `|`). +> Find patterns in files in a Zip archive using extended `regex` (supports `?`, `+`, `{}`, `()`, and `|`). > More information: . - Search for a pattern within a Zip archive: diff --git a/tldr/zstd b/tldr/zstd index 4eebf95a..981fd15d 100644 --- a/tldr/zstd +++ b/tldr/zstd @@ -31,3 +31,7 @@ source: https://github.com/tldr-pages/tldr.git - Unlock higher compression levels (up to 22) using more memory (both for compression and decompression): `zstd --ultra -{{level}} {{path/to/file}}` + +- Set the number of working threads to the number of physical CPU cores: + +`zstd {{[-T|--threads]}} 0` diff --git a/tldr/zstdcat b/tldr/zstdcat index 2eb98f44..3bb30ce1 100644 --- a/tldr/zstdcat +++ b/tldr/zstdcat @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # zstdcat -> This command is an alias of `zstd --decompress --stdout`. +> This command is an alias of `zstd --decompress --stdout --force`. - View documentation for the original command: diff --git a/tldr/zstdmt b/tldr/zstdmt index 8dcd646e..312c7cf4 100644 --- a/tldr/zstdmt +++ b/tldr/zstdmt @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # zstdmt -> This command is an alias of `zstd --threads 0` (which sets the number of working threads to the number of physical CPU cores). +> This command is an alias of `zstd --threads 0`. - View documentation for the original command: