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

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

Go to file

pepa65 bdbfe4b27e Update version as well to 0.32		2017-05-30 22:52:14 +07:00
LICENSE	First release after having gone overboard in modifications and enhancements,	2017-02-06 00:00:42 +07:00
package.json	Change install method for bpkg, enhanced package.json	2017-03-13 11:06:05 +07:00
README.md	Update version as well to 0.32	2017-05-30 22:52:14 +07:00
tldr	Update version as well to 0.32	2017-05-30 22:52:14 +07:00
tldr-customize.jpg	Correct readme, image of customizations	2017-03-13 02:40:50 +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-new.jpg	Added rendering of the new markdown as well,	2017-02-07 02:16:54 +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.gif	Better gif	2017-02-26 11:52:00 +07:00
tldr-page.jpg	Renamed repo, adapted readme and customize screenshot	2017-02-06 10:48:48 +07:00
tldr-usage.jpg	Properly handle zip-file redirects	2017-05-29 08:54:24 +07:00

README.md

tldr-bash-client

version 0.32
https://github.com/pepa65/tldr-bash-client

Bash client for tldr: community driven man-by-example

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

This client can render both the old and the new tldr markup format.

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-bash-client/master/tldr
sudo chmod +x $location

If the location is not in $PATH, you need to specify the path to run it. Alternately, you can do sudo bpkg-install pepa65/tldr if you have bpkg installed.

Prerequisites

coreutils, less, grep, unzip, curl / wget

Customisation

The 5 elements in TLDR markup that can be styled with these colors and backgrounds (last one specified will be used) and modes (more can apply):

Colors: Black, Red, Green, Yellow, Blue, Magenta, Cyan, White
BG: BlackBG, RedBG, GreenBG, YellowBG, BlueBG, MagentaBG, CyanBG, WhiteBG
Modes: Bold, Underline, Italic, Inverse

Newline can be added to the style list to add a newline before the element and Space to add a space at the start of the line (style items are separated by space, lower/uppercase mixed allowed)

TLDR_TITLE_STYLE (defaults to: Newline Space Bold Yellow)
TLDR_DESCRIPTION_STYLE (defaults to: Space Yellow)
TLDR_EXAMPLE_STYLE (defaults to: Newline Space Bold Green)
TLDR_CODE_STYLE (defaults to: Space Bold Blue)
TLDR_VALUE_ISTYLE (defaults to: Space Bold Cyan)

The Value style (above) is an Inline style: doesn't take Newline or Space

Inline styles for help text: default, URL, option, platform, command, header