A TLDR Client

tldr is a TLDR client written in TCL

An example

tldr is invoked as follows:

tldr tar

fossil clone https://chisselapp.com/arthurb/tldr-kit tldr-kit.fossil
mkdir tldr-kit
cd tldr-kit
fossil open ../tldr-kit.fossil
make
sudo make install

NOTE:

This will build Linux and Windows binaries called tldr and tldr.exe respectively.

By default, tldr clones the TLDR pages into its VFS as part of the build process.

Alternatively, you will need to clone the TLDR-pages repository to $XDG_DATA/tldr.

If your $XDG_DATA environment variable is not defined, use the first entry in $XDG_DATA_DIRS if that exists, or $HOME/.local/share otherwise:

cd $XDG_DATA
git clone https://github.com/tldr-pages/tldr

And then run as: tldr -pages-root $XDG_DATA/tldr/pages

tldr [options] man-page

-platform Operating System in which to look for page.
-color Whether to render TLDR pages in color or plain. (Default always)
-pages-root Location of TLDR pages (see Local Copy of TLDR Pages above). (Default $XDG_DATA/tldr/pages/)
-config Path to tldr.conf (Default $XDG_CONFIG/tldr/tldr.conf)
-help This information.

MIT.