mirror of https://github.com/CrimsonTome/tldr.git
pages/*: reword descriptions to comply with the style guide (#11507)
* pages/*: reword descriptions to comply with the style guide --------- Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>pull/23/head
Lena
GitHub
parent
6aa178a6a2
commit
0fddee2272
|
|
@ -1,6 +1,6 @@
|
|||
# Accelerate
|
||||
|
||||
> Accelerate is a library that enables the same PyTorch code to be run across any distributed configuration.
|
||||
> A library that enables the same PyTorch code to be run across any distributed configuration.
|
||||
> More information: <https://huggingface.co/docs/accelerate/index>.
|
||||
|
||||
- Print environment information:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# aws codecommit
|
||||
|
||||
> AWS CodeCommit is a managed source control service that hosts private Git repositories.
|
||||
> A managed source control service that hosts private Git repositories.
|
||||
> More information: <https://docs.aws.amazon.com/cli/latest/reference/codecommit/>.
|
||||
|
||||
- Display help for a specific command:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# bq
|
||||
|
||||
> The bq command-line tool is a Python-based command-line tool for BigQuery.
|
||||
> A Python-based tool for BigQuery.
|
||||
> More information: <https://cloud.google.com/bigquery/docs/reference/bq-cli-reference>.
|
||||
|
||||
- Run query against a BigQuery table using standard SQL, add `--dry_run` flag to estimate the number of bytes read by the query:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# cbonsai
|
||||
|
||||
> Cbonsai is a beautifully random bonsai tree CLI generator.
|
||||
> A beautifully random bonsai tree generator.
|
||||
> More information: <https://gitlab.com/jallbrit/cbonsai>.
|
||||
|
||||
- Generate a bonsai in live mode:
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# colordiff
|
||||
|
||||
> A tool to colorize diff output.
|
||||
> The Perl script colordiff is a wrapper for `diff` and produces the same output but with pretty syntax highlighting. Color schemes can be customized.
|
||||
> A wrapper around `diff` that produces the same output but with pretty syntax highlighting.
|
||||
> Color schemes can be customized.
|
||||
> More information: <https://github.com/kimmel/colordiff>.
|
||||
|
||||
- Compare files:
|
||||
|
|
@ -20,6 +20,6 @@
|
|||
|
||||
`colordiff -s {{file1}} {{file2}}`
|
||||
|
||||
- Ignore white spaces:
|
||||
- Ignore whitespace:
|
||||
|
||||
`colordiff -w {{file1}} {{file2}}`
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
# cron
|
||||
|
||||
> `cron` is a system scheduler for running jobs or tasks unattended.
|
||||
> A system scheduler for running jobs or tasks unattended.
|
||||
> The command to submit, edit or delete entries to `cron` is called `crontab`.
|
||||
|
||||
- View documentation for the original command:
|
||||
- View documentation for managing `cron` entries:
|
||||
|
||||
`tldr crontab`
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# daps
|
||||
|
||||
> DAPS is an open source program for transforming DocBook XML into output formats such as HTML or PDF.
|
||||
> An open source program for transforming DocBook XML into output formats such as HTML or PDF.
|
||||
> More information: <https://opensuse.github.io/daps/doc/index.html>.
|
||||
|
||||
- Check if a DocBook XML file is valid:
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
# dolt
|
||||
|
||||
> Dolt is an SQL database that you can fork, clone, branch, merge, push and pull just like a Git repository.
|
||||
> Some subcommands such as `dolt commit` have their own usage documentation.
|
||||
> An SQL database that you can fork, clone, branch, merge, push and pull just like a Git repository.
|
||||
> Some subcommands such as `commit` have their own usage documentation.
|
||||
> More information: <https://github.com/dolthub/dolt>.
|
||||
|
||||
- Execute a dolt subcommand:
|
||||
- Execute a `dolt` subcommand:
|
||||
|
||||
`dolt {{subcommand}}`
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# git check-ref-format
|
||||
|
||||
> Checks if a given refname is acceptable, and exits with a non-zero status if it is not.
|
||||
> Check if a given refname is acceptable, and exit with a non-zero status if it is not.
|
||||
> More information: <https://git-scm.com/docs/git-check-ref-format>.
|
||||
|
||||
- Check the format of the specified refname:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# gradle
|
||||
|
||||
> Gradle is an open source build automation system.
|
||||
> An open source build automation system.
|
||||
> More information: <https://gradle.org>.
|
||||
|
||||
- Compile a package:
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# helm
|
||||
|
||||
> Helm is a package manager for Kubernetes.
|
||||
> Some subcommands such as `helm install` have their own usage documentation.
|
||||
> A package manager for Kubernetes.
|
||||
> Some subcommands such as `install` have their own usage documentation.
|
||||
> More information: <https://helm.sh/>.
|
||||
|
||||
- Create a helm chart:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# holehe
|
||||
|
||||
> Holehe checks if an email is attached to an account on sites like Twitter, Instagram, Imgur and over 120 others.
|
||||
> Check if an email is attached to an account on sites like Twitter, Instagram, Imgur and over 120 others.
|
||||
> More information: <https://github.com/megadose/holehe#-cli-example>.
|
||||
|
||||
- Show status across all supported websites for the specified email address:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# keytool
|
||||
|
||||
> Keytool is a certificate management utility included with Java.
|
||||
> A certificate management utility included with Java.
|
||||
> More information: <https://docs.oracle.com/en/java/javase/20/docs/specs/man/keytool.html>.
|
||||
|
||||
- Create a keystore:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# kiwi-ng
|
||||
|
||||
> KIWI NG is an OS image and appliance builder.
|
||||
> An OS image and appliance builder.
|
||||
> More information: <https://osinside.github.io/kiwi/>.
|
||||
|
||||
- Build an appliance:
|
||||
|
|
|
|||
|
|
@ -1,13 +1,13 @@
|
|||
# kustomize
|
||||
|
||||
> Kustomize is a tool to easily deploy resources for Kubernetes.
|
||||
> Easily deploy resources for Kubernetes.
|
||||
> More information: <https://github.com/kubernetes-sigs/kustomize>.
|
||||
|
||||
- Create kustomization file with resources and namespace:
|
||||
- Create a kustomization file with resources and namespace:
|
||||
|
||||
`kustomize create --resources {{deployment.yaml,service.yaml}} --namespace {{staging}}`
|
||||
|
||||
- Build kustomization file and deploy it with `kubectl`:
|
||||
- Build a kustomization file and deploy it with `kubectl`:
|
||||
|
||||
`kustomize build . | kubectl apply -f -`
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# ledger
|
||||
|
||||
> Ledger is a powerful, double-entry accounting system that is accessed from the UNIX command-line.
|
||||
> A powerful, double-entry accounting system.
|
||||
> More information: <https://www.ledger-cli.org>.
|
||||
|
||||
- Print a balance report showing totals:
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# lzip
|
||||
|
||||
> Lzip is a lossless data compressor with a user interface similar to `gzip` or `bzip2`.
|
||||
> Lzip uses a simplified form of the "Lempel-Ziv-Markovchain-Algorithm"z (LZMA) stream format and provides a 3 factor integrity checking to maximize interoperability and optimize safety.
|
||||
> A lossless data compressor with a user interface similar to `gzip` or `bzip2`.
|
||||
> Lzip uses a simplified form of the "Lempel-Ziv-Markovchain-Algorithm" (LZMA) stream format and provides 3-factor integrity checking to maximize interoperability and optimize safety.
|
||||
> More information: <https://www.nongnu.org/lzip>.
|
||||
|
||||
- Archive a file, replacing it with with a compressed version:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# micro
|
||||
|
||||
> Micro is a modern and intuitive terminal-based text editor.
|
||||
> A modern and intuitive terminal-based text editor.
|
||||
> You can use your keyboard, but also your mouse to navigate and/or select text.
|
||||
> More information: <https://micro-editor.github.io>.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# mix
|
||||
|
||||
> Mix is a build tool that provides tasks for creating, compiling, and testing Elixir projects, managing its dependencies, and more.
|
||||
> Build tool that provides tasks for creating, compiling, and testing Elixir projects, managing its dependencies, and more.
|
||||
> More information: <https://hexdocs.pm/mix>.
|
||||
|
||||
- Execute a particular file:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# mupdf
|
||||
|
||||
> MuPDF is a lightweight PDF, XPS, and E-book viewer.
|
||||
> A lightweight PDF, XPS, and E-book viewer.
|
||||
> More information: <https://www.mupdf.com>.
|
||||
|
||||
- Open a PDF on the first page:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# nc
|
||||
|
||||
> Netcat is a versatile utility for redirecting IO into a network stream.
|
||||
> A versatile utility for redirecting IO into a network stream.
|
||||
> More information: <https://manned.org/man/nc.1>.
|
||||
|
||||
- Start a listener on the specified TCP port and send a file into it:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# nyxt
|
||||
|
||||
> Nyxt is a keyboard-driven web browser for power users.
|
||||
> A keyboard-driven web browser for power users.
|
||||
> More information: <https://nyxt.atlas.engineer>.
|
||||
|
||||
- List all profiles:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# octave
|
||||
|
||||
> GNU Octave is a programming language for scientific computing.
|
||||
> A programming language for scientific computing.
|
||||
> More information: <https://docs.octave.org/latest/Invoking-Octave-from-the-Command-Line.html>.
|
||||
|
||||
- Start an interactive session:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# passwd
|
||||
|
||||
> Passwd is a tool used to change a user's password.
|
||||
> Change a user's password.
|
||||
> More information: <https://manned.org/passwd>.
|
||||
|
||||
- Change the password of the current user interactively:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# pinta
|
||||
|
||||
> Pinta is a free, open source program for drawing and image editing.
|
||||
> A free, open source program for drawing and image editing.
|
||||
> More information: <https://www.pinta-project.com/>.
|
||||
|
||||
- Start Pinta:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# postcss
|
||||
|
||||
> PostCSS is a tool for transforming styles with JS plugins.
|
||||
> A tool for transforming styles with JS plugins.
|
||||
> More information: <https://postcss.org>.
|
||||
|
||||
- Parse and transform a CSS file:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# sails
|
||||
|
||||
> Sails.js is a realtime enterprise level MVC framework built on top of Node.js.
|
||||
> A realtime enterprise level MVC framework built on top of Node.js.
|
||||
> More information: <https://sailsjs.com>.
|
||||
|
||||
- Start Sails:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# sf
|
||||
|
||||
> Salesforce CLI is a powerful command line interface that simplifies development and build automation when working with your Salesforce org.
|
||||
> A powerful command line interface that simplifies development and build automation when working with your Salesforce org.
|
||||
> More information: <https://developer.salesforce.com/tools/salesforcecli>.
|
||||
|
||||
- Authorize a Salesforce Organization:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# sonar-scanner
|
||||
|
||||
> SonarScanner is a generic scanner for SonarQube projects that do not use build tools such as Maven, Gradle, or Ant.
|
||||
> A generic scanner for SonarQube projects that do not use build tools such as Maven, Gradle, or Ant.
|
||||
> More information: <https://docs.sonarqube.org/latest/analysis/scan/sonarscanner/>.
|
||||
|
||||
- Scan a project with configuration file in your project's root directory named `sonar-project.properties`:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# soupault
|
||||
|
||||
> Soupault is a static website generator based on HTML element tree rewriting.
|
||||
> A static website generator based on HTML element tree rewriting.
|
||||
> It can also be used as an HTML post-processor or metadata extractor.
|
||||
> More information: <https://soupault.app>.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# timidity
|
||||
|
||||
> TiMidity++ is a MIDI file player and converter.
|
||||
> A MIDI file player and converter.
|
||||
> More information: <http://timidity.sourceforge.net>.
|
||||
|
||||
- Play a MIDI file:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# transmission
|
||||
|
||||
> Transmission is a simple torrent client.
|
||||
> A simple torrent client.
|
||||
> Transmission isn't a command, but a set of commands. See the pages below.
|
||||
> More information: <https://transmissionbt.com/>.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# vifm
|
||||
|
||||
> Vifm (VI File Manager) is a command-line file manager.
|
||||
> VI File Manager is a command-line file manager.
|
||||
> More information: <https://github.com/vifm/vifm>.
|
||||
|
||||
- Open the current directory:
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# addpart
|
||||
|
||||
> Tells the Linux kernel about the existence of the specified partition.
|
||||
> The command is a simple wrapper around the `add partition` ioctl.
|
||||
> Tell the Linux kernel about the existence of the specified partition.
|
||||
> A simple wrapper around the `add partition` ioctl.
|
||||
> More information: <https://manned.org/addpart>.
|
||||
|
||||
- Tell the kernel about the existence of the specified partition:
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
# cpupower
|
||||
|
||||
> Tools regarding CPU power and tuning options.
|
||||
> This command is available as part of the `cpupower` package, or as part of `kernel-tools` on Fedora.
|
||||
> More information: <https://manned.org/cpupower>.
|
||||
|
||||
- List CPUs:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# curlie
|
||||
|
||||
> Curlie is a frontend to curl that adds the ease of use of httpie.
|
||||
> A frontend to `curl` that adds the ease of use of `httpie`.
|
||||
> More information: <https://github.com/rs/curlie>.
|
||||
|
||||
- Send a GET request:
|
||||
|
|
|
|||
|
|
@ -1,17 +1,18 @@
|
|||
# duc
|
||||
|
||||
> Duc is a collection of tools for indexing, inspecting and visualizing disk usage. Duc maintains a database of accumulated sizes of directories of the file system, allowing queries this database, or create fancy graphs to show where data is.
|
||||
> A collection of tools for indexing, inspecting and visualizing disk usage.
|
||||
> Duc maintains a database of accumulated sizes of directories in the file system, allowing to query this database, or creating fancy graphs to show where data is.
|
||||
> More information: <https://duc.zevv.nl/>.
|
||||
|
||||
- Index the /usr directory, writing to the default database location ~/.duc.db:
|
||||
- Index the `/usr` directory, writing to the default database location `~/.duc.db`:
|
||||
|
||||
`duc index {{/usr}}`
|
||||
|
||||
- List all files and directories under /usr/local, showing relative file sizes in a [g]raph:
|
||||
- List all files and directories under `/usr/local`, showing relative file sizes in a [g]raph:
|
||||
|
||||
`duc ls --classify --graph {{/usr/local}}`
|
||||
|
||||
- List all files and directories under /usr/local using treeview recursively:
|
||||
- List all files and directories under `/usr/local` using treeview recursively:
|
||||
|
||||
`duc ls --classify --graph --recursive {{/usr/local}}`
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# dunstify
|
||||
|
||||
> A notification tool that is an extension of notify-send, but has more features based around dunst.
|
||||
> Works with all options that work for notify-send.
|
||||
> A notification tool that is an extension of `notify-send`, but has more features based around `dunst`.
|
||||
> Accepts all options of `notify-send`.
|
||||
> More information: <https://github.com/dunst-project/dunst/wiki/Guides>.
|
||||
|
||||
- Show a notification with a given title and message:
|
||||
|
|
@ -16,6 +16,6 @@
|
|||
|
||||
`dunstify "{{Title}}" "{{Message}}" -r {{123}}`
|
||||
|
||||
- To see other possible options:
|
||||
- Display help:
|
||||
|
||||
`notify-send --help`
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# libtool
|
||||
|
||||
> Libtool is a generic library support script that hides the complexity of using shared libraries behind a consistent, portable interface.
|
||||
> A generic library support script that hides the complexity of using shared libraries behind a consistent, portable interface.
|
||||
> More information: <https://www.gnu.org/software/libtool/manual/libtool.html#Invoking-libtool>.
|
||||
|
||||
- Compile a source file into a `libtool` object:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# lvcreate
|
||||
|
||||
> Creates a logical volume in an existing volume group. A volume group is a collection of logical and physical volumes.
|
||||
> Create a logical volume in an existing volume group. A volume group is a collection of logical and physical volumes.
|
||||
> See also: `lvm`.
|
||||
> More information: <https://man7.org/linux/man-pages/man8/lvcreate.8.html>.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# retroarch
|
||||
|
||||
> RetroArch is a frontend for emulators, game engines and media players.
|
||||
> It is the reference implementation of libretro API.
|
||||
> A frontend for emulators, game engines and media players.
|
||||
> The reference implementation of the libretro API.
|
||||
> More information: <https://github.com/libretro/RetroArch>.
|
||||
|
||||
- Start in the menu mode:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# startx
|
||||
|
||||
> The startx script is a front end to xinit that provides a nice user interface for running a single session of the X Window System.
|
||||
> A front-end to `xinit` that provides a nice user interface for running a single session of the X Window System.
|
||||
> More information: <https://x.org/releases/X11R7.5/doc/man/man1/startx.1.html>.
|
||||
|
||||
- Start an X session:
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# systemd-confext
|
||||
|
||||
> This command is an alias of `systemd-sysext`.
|
||||
> It follows the same principle as the `systemd-sysext`, but instead of working on `/usr` and `/opt`, `confext` will extend only `/etc`.
|
||||
> It follows the same principle as `systemd-sysext`, but instead of working on `/usr` and `/opt`, `confext` will extend only `/etc`.
|
||||
> More information: <https://www.freedesktop.org/software/systemd/man/latest/systemd-sysext.html>.
|
||||
|
||||
- View documentation for the original command:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# talk
|
||||
|
||||
> GNU/Talk is a visual communication program which copies lines from your terminal to that of another user.
|
||||
> A visual communication program which copies lines from your terminal to that of another user.
|
||||
> More information: <https://www.gnu.org/software/inetutils/manual/html_node/talk-invocation.html>.
|
||||
|
||||
- Start a talk session with a user on the same machine:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# vmware-checkvm
|
||||
|
||||
> Checks to see if the current host is a VMware VM or not.
|
||||
> Check if the current host is a VMware VM or not.
|
||||
> More information: <https://manned.org/vmware-checkvm>.
|
||||
|
||||
- Return the current VMware software version (exit status determines whether the system is a VM or not):
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# zile
|
||||
|
||||
> Zile is a lightweight clone of the Emacs text editor.
|
||||
> A lightweight clone of the Emacs text editor.
|
||||
> More information: <https://www.gnu.org/software/zile/>.
|
||||
|
||||
- Start a buffer for temporary notes, which won't be saved:
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# photoanalysisd
|
||||
|
||||
> This analyzes photo libraries for Memories, People, and scene or object based search.
|
||||
> It should not be invoked manually.
|
||||
> Analyze photo libraries for Memories, People, and scene or object based search.
|
||||
> `photoanalysisd` should not be invoked manually.
|
||||
> More information: <https://www.manpagez.com/man/8/photoanalysisd/>.
|
||||
|
||||
- Start the daemon:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Test-Json
|
||||
|
||||
> Tests whether a string is a valid JSON document.
|
||||
> Test whether a string is a valid JSON document.
|
||||
> This command can only be used through PowerShell.
|
||||
> More information: <https://learn.microsoft.com/powershell/module/microsoft.powershell.utility/test-json>.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue