1
0
Fork 0
mirror of https://github.com/tldr-pages/tldr.git synced 2025-04-29 23:24:55 +02:00
tldr/pages/common/tldr.md

38 lines
1.2 KiB
Markdown
Raw Normal View History

2014-01-26 23:47:19 +11:00
# tldr
2022-09-14 23:19:41 +10:00
> Display simple help pages for command-line tools from the tldr-pages project.
2023-11-19 05:58:50 +01: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 23:47:19 +11:00
2022-09-14 23:19:41 +10:00
- Print the tldr page for a specific command (hint: this is how you got here!):
2014-01-26 23:47:19 +11:00
`tldr {{command}}`
2019-01-23 11:43:48 -05:00
2022-09-14 23:19:41 +10:00
- Print the tldr page for a specific subcommand:
2019-01-23 11:43:48 -05:00
2023-11-19 05:58:50 +01:00
`tldr {{command}} {{subcommand}}`
2019-01-23 11:43:48 -05:00
2025-03-14 19:23:48 +02:00
- Print the tldr page for a command in the given language (if available, otherwise fall back to English):
2019-01-23 11:48:48 -05:00
2025-03-14 19:23:48 +02:00
`tldr {{[-L|--language]}} {{language_code}} {{command}}`
2023-11-19 05:58:50 +01:00
2025-03-14 19:23:48 +02:00
- Print the tldr page for a command from a specific platform:
2023-11-19 05:58:50 +01:00
2025-03-14 19:23:48 +02:00
`tldr {{[-p|--platform]}} {{android|common|freebsd|linux|osx|netbsd|openbsd|sunos|windows}} {{command}}`
2020-09-14 19:35:12 +05:30
2025-03-14 19:23:48 +02:00
- Update the local cache of tldr pages:
2020-09-14 19:35:12 +05:30
2025-03-14 19:23:48 +02:00
`tldr {{[-u|--update]}}`
2023-11-19 05:58:50 +01:00
2025-03-14 19:23:48 +02:00
- List all pages for the current platform and `common`:
2023-11-19 05:58:50 +01:00
2025-03-14 19:23:48 +02:00
`tldr {{[-l|--list]}}`
2025-03-14 19:23:48 +02:00
- List all available subcommand pages for a command:
2025-03-14 19:23:48 +02:00
`tldr {{[-l|--list]}} | grep {{command}} | column`
2025-01-02 08:19:27 +01:00
- Print the tldr page for a random command:
2025-03-14 19:23:48 +02:00
`tldr {{[-l|--list]}} | shuf {{[-n|--head-count]}} 1 | xargs tldr`