tlrc

A tldr client written in Rust.

Installation

From GitHub Releases

You can find prebuilt binaries here.

Usage

See man tldr or the online manpage. For a brief description, you can also run: tldr --help

Configuration

Tlrc can be customized with a TOML configuration file. To get the default path for your system, run: tldr --config-path To generate a default config file, run: bash tldr --gen-config > $(tldr --config-path) or copy the below example.

Configuration options

```toml [cache]

Override the cache directory.

dir = "/path/to/cache"

Automatically update the cache when it is if it is older than max_age hours.

autoupdate = true maxage = 336

Specify a list of desired page languages. If it is empty, all languages are downloaded.

English is implied and will always be downloaded.

You can see a list of language codes here: https://github.com/tldr-pages/tldr

Example: ["de", "pl"]

languages = []

[output]

Show the command name in the page.

show_title = true

Strip newlines from output.

compact = false

Print pages in raw markdown.

raw_markdown = false

Style for the title of the page (command name).

[style.title]

Fixed colors: "black", "red", "green", "yellow", "blue", "magenta", "cyan", "white", "default"

256color ANSI code: { color256 = 50 }

RGB: { rgb = [0, 255, 255] }

color = "magenta" bold = true underline = false italic = false

Style for the description of the page.

[style.description] color = "magenta" bold = false underline = false italic = false

Style for the description of examples.

[style.bullet] color = "green" bold = false underline = false italic = false

Style for command examples.

[style.example] color = "cyan" bold = false underline = false italic = false

Style for URLs inside the description.

[style.url] color = "red" bold = false underline = false italic = true

Style for text surrounded by backticks (`).

[style.inline_code] color = "yellow" bold = false underline = false italic = true

Style for placeholders inside command examples.

[style.placeholder] color = "red" bold = false underline = false italic = true ```