TLDR(1)

NAME
tldr - simplified man pages

SYNOPSIS
tldr [-h] [-l] [-p platform] [-t] [-u] [-v] <page_name>...

DESCRIPTION
tldr displays simplified, community-maintained man pages for command-line tools. First run tldr -u to download the pages, then tldr <page_name> to view pages.

OPTIONS

-h, --help
    Display a short option summary.

-l, --list
    List all available pages, one per line.

-p, --platform platform
    Restrict page lookup to the given platform directory inside the page cache (e.g. "linux", "osx", "common"). When omitted, all platform directories are searched alphabetically, with the first match taking precedence.

-t, --target
    Print the absolute path to the page rather than the page itself.

-u, --update
    Download pages.

-v, --version
    Print the program version.

FILES

~/.local/share/tinytldr/pages/
    Default page cache directory. Populated by --update and read by every other operation.

The directory layout inside the cache is one subdirectory per platform, each containing page-name.md files.

config.h
    Project-level configuration: download URL, cache location, and ANSI styling. Edit and recompile to change the defaults.

EXAMPLES

Fetch (or refresh) the local copy of the tldr-pages archive:

    tldr -u

Display the page for tar:

    tldr tar

Display the macOS-specific page for tar:

    tldr -p osx tar

Display the page for git apply:

    tldr git apply

List every available page:

    tldr -l

Print the on-disk path of a page without rendering it:

    tldr -t git apply

CUSTOM PAGES
tldr reads any platform/page.md file placed under the page cache, so personal pages work without further configuration. Create a new subdirectory under the default cache and drop name.md files into it:

    TLDR_PAGES="$HOME/.local/share/tinytldr/pages"
    mkdir "$TLDR_PAGES/mypages"
    printf '# My custom page\n' > "$TLDR_PAGES/mypages/testpage.md"
    tldr testpage

AUTHORS
Ivan Kovmir with contributions from bilditup1.

SUPPORT
Report bugs at https://github.com/kovmir/tinytldr/issues.