Go to file
pepa65 8394083faa First release after having gone overboard in modifications and enhancements,
particularly easy customization and option for downloading full pages archive.
2017-02-06 00:00:42 +07:00
LICENSE First release after having gone overboard in modifications and enhancements, 2017-02-06 00:00:42 +07:00
README.md First release after having gone overboard in modifications and enhancements, 2017-02-06 00:00:42 +07:00
tldr First release after having gone overboard in modifications and enhancements, 2017-02-06 00:00:42 +07:00
tldr-customize.png First release after having gone overboard in modifications and enhancements, 2017-02-06 00:00:42 +07:00
tldr-list.png First release after having gone overboard in modifications and enhancements, 2017-02-06 00:00:42 +07:00
tldr-markdown.png First release after having gone overboard in modifications and enhancements, 2017-02-06 00:00:42 +07:00
tldr-page.png First release after having gone overboard in modifications and enhancements, 2017-02-06 00:00:42 +07:00
tldr-usage.png First release after having gone overboard in modifications and enhancements, 2017-02-06 00:00:42 +07:00

README.md

tldr-bash

A fully-functional bash client for the tldr project, providing poignant examples of terminal commands.

tldr screenshot list

tldr screenshot page

Installation

Download the tldr bash script to the install location:

location=/usr/local/bin/tldr  # elevated privileges needed for some locations
sudo wget -qO $location https://raw.githubusercontent.com/pepa65/tldr/master/tldr
sudo chmod +x $location

If the location is not in $PATH, you need to specify the path to run it.

Prerequisites

coreutils, ncurses(tput), less, grep, unzip, curl / wget

tldr screenshot usage

Customisation

The colors and other styling of the 5 elements of tldr pages can be modified either by editing the first few lines of the scipt, or by setting the following environment variables:

  • TLDR_TITLE_STYLE (defaults to Newline,Space,Bold,Yellow)
  • TLDR_DESCRIPTION_STYLE (defaults to Space,Yellow)
  • TLDR_EXAMPLE_STYLE (defaults to Newline,Bold,Green)
  • TLDR_CODE_STYLE (defaults to Space,Bold,Blue)
  • TLDR_VALUE_STYLE (defaults to Bold,Cyan)

Also the error color and page expiry can easily be set:

  • TLDR_ERROR_COLOR (defaults to Red)
  • TLDR_EXPIRY (defaults to 60)

tldr screenshot customize

Contributing

Please file an issue for a question, a bug or a feature request. Or even better, send a pull request!

tldr screenshot markdown

License

Relicensed under GPL v3+