lilith/tldr
1
0
Fork 0
mirror of https://github.com/tldr-pages/tldr.git synced 2025-03-28 21:16:20 +01:00
Code Activity

client-spec: Add "required?" column to args table

Browse source
This commit is contained in:
Starbeamrainbowlabs 2019-02-16 14:19:39 +00:00
parent 80211827a0
commit bdf5a592ef
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
CLIENT-SPECIFICATION.md
View file

@ -28,12 +28,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
---------------------|--------------------
`-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.
`-u`, `--update` | Updates the offline cache of pages. MUST be implemented if cache is supported.
Argument | Required? | Meaning
--------------------|--------------------
`-v`, `--version` | Yes | Shows the current version of the client, and the version of this specification that it implements.
`-l`, `--list` | No | 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` | Yes | 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` | Only if cache is implemented | Updates the offline cache of pages. MUST be implemented if cache is supported.
Clients MAY NOT implement the long form of an argument (`--update`, `--version`, `--list`, `--platform`).