ctome
/
tldr
mirror of https://github.com/CrimsonTome/tldr.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Show short arguments first

italian
Jonathan Dahan 2019-01-23 11:33:03 -05:00 committed by Starbeamrainbowlabs
parent faa3a4af60
commit 8163642d04
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
CLIENT-SPECIFICATION.md
View File

@ -37,10 +37,10 @@ A number of arguments MUST be supported (unless otherwise specified if a CLI is
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.
`-u`, `--update` | Updates the offline cache of pages. MUST be implemented if cache is supported.
`-v`, `--version` | Shows the current version of the client, and the version of this specification that it implements.
`-l`, `--list` | 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.
`-p`, `--platform` | 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.).