diff --git a/pages/common/tldr.md b/pages/common/tldr.md index e7fc222eb..fe852ccec 100644 --- a/pages/common/tldr.md +++ b/pages/common/tldr.md @@ -1,7 +1,8 @@ # tldr > Display simple help pages for command-line tools from the tldr-pages project. -> More information: . +> Note: the `--language` and `--list` options are not required by the client specification, but most clients implement them. +> More information: . - Print the tldr page for a specific command (hint: this is how you got here!): @@ -9,12 +10,20 @@ - Print the tldr page for a specific subcommand: -`tldr {{command}}-{{subcommand}}` +`tldr {{command}} {{subcommand}}` -- Print the tldr page for a command for a specific [p]latform: +- Print the tldr page for a command in the given [L]anguage (if available, otherwise fall back to English): -`tldr -p {{android|linux|osx|sunos|windows}} {{command}}` +`tldr --language {{language_code}} {{command}}` + +- Print the tldr page for a command from a specific [p]latform: + +`tldr --platform {{android|common|freebsd|linux|osx|netbsd|openbsd|sunos|windows}} {{command}}` - [u]pdate the local cache of tldr pages: -`tldr -u` +`tldr --update` + +- List all pages for the current platform and `common`: + +`tldr --list`