mirror of https://github.com/CrimsonTome/tldr.git
client-spec: Add "required?" column to args table
parent
80211827a0
commit
bdf5a592ef
|
@ -28,12 +28,12 @@ This section describes the standardised command-line interface (CLI) for clients
|
||||||
### Arguments
|
### Arguments
|
||||||
A number of arguments MUST be supported (unless otherwise specified) if a CLI is implemented:
|
A number of arguments MUST be supported (unless otherwise specified) if a CLI is implemented:
|
||||||
|
|
||||||
Argument | Meaning
|
Argument | Required? | Meaning
|
||||||
---------------------|--------------------
|
--------------------|--------------------
|
||||||
`-v`, `--version` | Shows the current version of the client, and the version of this specification that it implements.
|
`-v`, `--version` | Yes | 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.
|
`-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` | 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.
|
`-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` | Updates the offline cache of pages. MUST be implemented if cache is supported.
|
`-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`).
|
Clients MAY NOT implement the long form of an argument (`--update`, `--version`, `--list`, `--platform`).
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue