diff --git a/CLIENT-SPECIFICATION.md b/CLIENT-SPECIFICATION.md index 95f6ab09f..3c944d99d 100644 --- a/CLIENT-SPECIFICATION.md +++ b/CLIENT-SPECIFICATION.md @@ -35,14 +35,15 @@ 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 | 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. +`-t, `--translation` | Specifies the translation that should be used for resolving page names. If specified, the named language-tag MUST be checked first instead of the host language as described below. +`-u`, `--update` | 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`, `--translation`). 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.). diff --git a/pages/common/tldr.md b/pages/common/tldr.md index 2c7b1e100..da9b9531b 100644 --- a/pages/common/tldr.md +++ b/pages/common/tldr.md @@ -5,3 +5,15 @@ - Get typical usages of a command (hint: this is how you got here!): `tldr {{command}}` + +- List available pages: + +`tldr --list` + +- Show the tar tldr page for linux: + +`tldr --platform linux tar` + +- Get help for a command in Chinese: + +`tldr -t zh {{command}}`