summaryrefslogtreecommitdiffstats
path: root/docs/src/usage.txt
blob: c08779ac25a71544577d17059d38e5f85950cde3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
tealdeer 1.2.3: 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
  -f, --render <FILE>         Render a specific markdown file
  -p, --platform <PLATFORMS>  Override the operating system [possible values: linux, macos, windows,
                              sunos, android]
  -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
      --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]
  -v, --version               Print the version
  -h, --help                  Print help

To view the user documentation, please visit https://dbrgn.github.io/tealdeer/.