mirror of https://github.com/pepa65/tldr-bash-client.git synced 2024-11-13 07:21:06 +01:00

Aide commande Bash https://github.com/pepa65/tldr-bash-client.git

Find a file

pepa65 04a45d1e46 Adapted readme to the only way to control image width		2017-02-06 10:26:01 +07:00
LICENSE	First release after having gone overboard in modifications and enhancements,	2017-02-06 00:00:42 +07:00
README.md	Adapted readme to the only way to control image width	2017-02-06 10:26:01 +07:00
tldr	Added render option, adapted readme and usage screenshot	2017-02-06 10:11:13 +07:00
tldr-customize.jpg	Change presentation of styles list, spaces instead of comma	2017-02-06 09:06:21 +07:00
tldr-list.jpg	Cut down screenshots, removed mention of ncurses (tput) as requirement	2017-02-06 00:19:38 +07:00
tldr-markdown.jpg	Cut down screenshots, removed mention of ncurses (tput) as requirement	2017-02-06 00:19:38 +07:00
tldr-page.jpg	Cut down screenshots, removed mention of ncurses (tput) as requirement	2017-02-06 00:19:38 +07:00
tldr-usage.jpg	Added render option, adapted readme and usage screenshot	2017-02-06 10:11:13 +07:00

README.md

tldr (bash)

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

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, less, grep, unzip, curl / wget

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 customize screenshot](tldr-customize.jpg?raw=true "tldr customize" {width:400px})

Contributing

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

License

Relicensed under GPL v3+