OS Manuals

/usr/bin/tldr

A very fast implementation of tldr in Rust.

From tealdeer 1.9.1-r0 (os), captured 2026-11-05 by running tldr --help (exit 0). permalink

tealdeer 1.9.1: A fast TLDR client
Danilo Bargen <mail@dbrgn.ch>, Niklas Mohrin <dev@niklasmohrin.de>

Usage: tldr [OPTIONS] [COMMAND]...

Arguments:
  [COMMAND]...  The command to show (e.g. `tar` or `git log`)

Options:
  -l, --list                        List all commands in the cache
      --edit-page                   Edit custom page with `EDITOR`
      --edit-patch                  Edit custom patch with `EDITOR`
  -f, --render <FILE>               Render a specific markdown file
  -p, --platform <PLATFORM>         Override the operating system, can be specified multiple times
                                    in order of preference [possible values: linux, macos, sunos,
                                    windows, android, freebsd, netbsd, openbsd, common]
  -L, --language <LANGUAGE>         Override the language
  -u, --update                      Update the local cache
      --no-auto-update              If auto update is configured, disable it for this run
  -c, --clear-cache                 Clear the local cache
      --config-path <FILE>          Override config file location
      --override-config <OVERRIDE>  Override config values after reading config file (example:
                                    `updates.auto_update = true`)
      --pager                       Use a pager to page output
  -r, --raw                         Display the raw markdown instead of rendering it
  -q, --quiet                       Suppress informational messages
      --show-paths                  Show file and directory paths used by tealdeer
      --seed-config                 Create a basic config
      --color <WHEN>                Control whether to use color [possible values: always, auto,
                                    never]
      --short-options               Display the short variants of placeholders
      --long-options                Display the long variants of placeholders
  -v, --version                     Print the version
  -h, --help                        Print help

To view the user documentation, please visit https://docs.tealdeer.org.

To view usage examples, run tldr tldr or tldr tealdeer.
Options (21)
OptionDescriptionSource
-l, --listList all commands in the cachehelp
--edit-pageEdit custom page with `EDITOR`help
--edit-patchEdit custom patch with `EDITOR`help
-f, --render FILERender a specific markdown filehelp
-p, --platform PLATFORMOverride the operating system, can be specified multiple times in order of preference [possible values: linux, macos, sunos, windows, android, freebsd, netbsd, openbsd, common]help
-L, --language LANGUAGEOverride the languagehelp
-u, --updateUpdate the local cachehelp
--no-auto-updateIf auto update is configured, disable it for this runhelp
-c, --clear-cacheClear the local cachehelp
--config-path FILEOverride config file locationhelp
--override-config OVERRIDEOverride config values after reading config file (example: `updates.auto_update = true`)help
--pagerUse a pager to page outputhelp
-r, --rawDisplay the raw markdown instead of rendering ithelp
-q, --quietSuppress informational messageshelp
--show-pathsShow file and directory paths used by tealdeerhelp
--seed-configCreate a basic confighelp
--color WHENControl whether to use color [possible values: always, auto, never]help
--short-optionsDisplay the short variants of placeholdershelp
--long-optionsDisplay the long variants of placeholdershelp
-v, --versionPrint the versionhelp
-h, --helpPrint helphelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.