mirror of https://github.com/CrimsonTome/tldr.git
use spaces instead of tabs for tables
parent
f46447cbb7
commit
69d52c1c65
|
@ -35,13 +35,12 @@ This section describes the standardised command-line interface (CLI) for clients
|
|||
### Arguments
|
||||
A number of arguments MUST be supported (unless otherwise specified if a CLI is implemented:
|
||||
|
||||
Argument | Meaning
|
||||
------------------------|--------------------
|
||||
`--update` | Updates the offline cache of pages. MUST be implemented if cache is supported.
|
||||
`--version`, `-v` | Shows the current version of the client, and the version of this specification that it implements.
|
||||
`--list`, `-l` | Lists all the pages in the current platform to the standard output. If the special platform `all` is specified a list of all pages in all platforms MUST be displayed.
|
||||
`--pretty` | OPTIONAL. Forces the output to contain all additional decorations, even if the standard output is not a TTY.
|
||||
`--platform`, `-p` | Specifies the platform that should be used for resolving page names. If specified, the named platform MUST be checked first instead of the host platform as described below.
|
||||
Argument | Meaning
|
||||
-------------------|--------------------
|
||||
`--update` | Updates the offline cache of pages. MUST be implemented if cache is supported.
|
||||
`--version`, `-v` | Shows the current version of the client, and the version of this specification that it implements.
|
||||
`--list`, `-l` | Lists all the pages in the current platform to the standard output. If the special platform `all` is specified a list of all pages in all platforms MUST be displayed.
|
||||
`--platform`, `-p` | Specifies the platform that should be used for resolving page names. If specified, the named platform MUST be checked first instead of the host platform as described below.
|
||||
|
||||
Additional decoration MAY be printed if the standard output is a [TTY](http://www.linusakesson.net/programming/tty/index.php). If not, then the output MUST not contain any additional decorations. For example a page list MUST be formatted with 1 page name per line (to enable easy manipulation using standard CLI tools such as `grep` etc.).
|
||||
|
||||
|
@ -96,11 +95,11 @@ Additional platforms MAY be added in the future. Clients MAY NOT support new pla
|
|||
|
||||
The pages themselves sit inside the appropriate platform folder, with the extension `.md`. Here are some example mappings:
|
||||
|
||||
Command name | Mapped name | Filename
|
||||
----------------|-------------------|-------------------
|
||||
`7za` | `7za` | `7za.md`
|
||||
Command name | Mapped name | Filename
|
||||
----------------|-----------------|-------------------
|
||||
`7za` | `7za` | `7za.md`
|
||||
`git checkout` | `git-checkout` | `git-checkout.md`
|
||||
`tar` | `tar` | `tar.md`
|
||||
`tar` | `tar` | `tar.md`
|
||||
|
||||
|
||||
### Translations
|
||||
|
|
Loading…
Reference in New Issue