A TLDR Client

tldr is a TLDR client written in Jim TCL.

An example

tldr is invoked as follows:

tldr tar

tldr requires:

Jim 0.79 or newer (with SQLite extension)
dbohdan's jimlib (https://gitlab.com/dbohdan/jimlib.git) (tldr bundles jimlib version 0.5.0)

Once you have the dependencies installed on *nix, run

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

tldr expects to find a copy of the TLDR pages on your local file system. 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

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-dir Location of tldr.conf (SQLite DB) (Default $XDG_CONFIG/tldr/)

MIT.