ctome
/
tldr
mirror of https://github.com/CrimsonTome/tldr.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

tldr: update page (#11540)

pull/23/head
Lena 2023-11-19 05:58:50 +01:00 committed by GitHub
parent 923e924e06
commit f035f1bc78
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
pages/common/tldr.md
View File

@ -1,7 +1,8 @@
# tldr
> Display simple help pages for command-line tools from the tldr-pages project.
> More information: <https://tldr.sh>.
> 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>.
- 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`