tldr/pages/common/tldr.md

34 lines
1.0 KiB
Markdown
Raw Normal View History

2014-01-26 12:47:19 +00:00
# tldr
2022-09-14 14:19:41 +01:00
> Display simple help pages for command-line tools from the tldr-pages project.
2023-11-19 04:58:50 +00:00
> Note: the `--language` and `--list` options are not required by the client specification, but most clients implement them.
> More information: <https://github.com/tldr-pages/tldr/blob/main/CLIENT-SPECIFICATION.md#command-line-interface>.
2014-01-26 12:47:19 +00:00
2022-09-14 14:19:41 +01:00
- Print the tldr page for a specific command (hint: this is how you got here!):
2014-01-26 12:47:19 +00:00
`tldr {{command}}`
2019-01-23 16:43:48 +00:00
2022-09-14 14:19:41 +01:00
- Print the tldr page for a specific subcommand:
2019-01-23 16:43:48 +00:00
2023-11-19 04:58:50 +00:00
`tldr {{command}} {{subcommand}}`
2019-01-23 16:43:48 +00:00
2023-11-19 04:58:50 +00:00
- Print the tldr page for a command in the given [L]anguage (if available, otherwise fall back to English):
2019-01-23 16:48:48 +00:00
2023-11-19 04:58:50 +00:00
`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}}`
2020-09-14 15:05:12 +01:00
2022-09-14 14:19:41 +01:00
- [u]pdate the local cache of tldr pages:
2020-09-14 15:05:12 +01:00
2023-11-19 04:58:50 +00:00
`tldr --update`
- [l]ist all pages for the current platform and `common`:
2023-11-19 04:58:50 +00:00
`tldr --list`
- [l]ist all available subcommand pages for a command:
`tldr --list | grep {{command}} | column`