From d8df0d5e117ca79ff9f70e4ee23e61a0396a107c Mon Sep 17 00:00:00 2001 From: Starbeamrainbowlabs Date: Fri, 18 Jan 2019 14:47:27 +0000 Subject: [PATCH] client spec: Revise --list, add --pretty --- CLIENT_SPECIFICATION.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/CLIENT_SPECIFICATION.md b/CLIENT_SPECIFICATION.md index 45ea4469d1..d90ca85164 100644 --- a/CLIENT_SPECIFICATION.md +++ b/CLIENT_SPECIFICATION.md @@ -37,7 +37,10 @@ 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-all`, `-a` | Lists all the pages in the current platform to the standard output. 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 be formatted with 1 page name per line (to enable easy manipulation using standard tools). +`--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. + +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.). Clients MAY support additional custom arguments and syntax not documented here.