package tldr
An ocaml tldr client
Install
Dune Dependency
Authors
Maintainers
Sources
v0.3.0.tar.gz
md5=4bdb2a3847b23e226a3fe6213fffa4fe
sha512=865d2528d814587d2a8ab8326fe1547905a6256a60f817ac448138c177a8460292ec704e81a2639d85f4f0c326721f97e168f08b0b3d5652e8bdef6923c26024
Description
Published: 26 May 2020
README
tldr-ocaml
A client for tldr written in ocaml
.
Installation
Install from opam with:
opam install tldr
Or from source with dune:
git clone https://github.com/RosalesJ/tldr-ocaml.git
cd tldr-ocaml
dune build @install
dune install
Configuration
You can configure tldr by setting environment variables.
Colors
You can customize the colors and style of the display using the following variables
TLDR_COLOR_TITLE
TLDR_COLOR_DESCRIPTION
TLDR_COLOR_EXAMPLE
TLDR_COLOR_COMMAND
TLDR_COLOR_ARGUMENT
And these options
Colors: black | white | red | green | yellow | blue | magenta | cyan
Styles: bold | underlined | blink
To denote a foreground color use <color>
and a background color use on_<color>
. List the colors and styles in a string delimited by semicolons. Here is a sample style configuration. Don't use it though, it's really obnoxious.
export TLDR_COLOR_TITLE="red;on_white;blink"
export TLDR_COLOR_DESCRIPTION="yellow"
export TLDR_COLOR_EXAMPLE="cyan;on_magenta;underlined"
export TLDR_COLOR_ARGUMENT="green"
export TLDR_COLOR_COMMAND="blue"
Cache
If caching is enabled then tldr will attempt to load from the cache before fetching from the internet. The cache is located in one of the following locations in decreasing order of precedence.
$XDG_CACHE_HOME/tldr
$HOME/.cache/tldr
~/.cache/tldr
Here's a sample configuration
export TLDR_CACHE_ENABLED=0 # Caching is disabled (default is enabled)
export TLDR_MAX_CACHE_AGE=168 # Cached pages last 168 hours (default is 24)
Dependencies (7)
- cmdliner
-
stdio
< "v0.17"
-
angstrom
>= "0.14.0"
- ANSITerminal
- lwt_ssl
- cohttp-lwt-unix
-
dune
>= "1.2"
Dev Dependencies
None
Used by
None
Conflicts (1)
-
ssl
= "0.5.6"
sectionYPositions = computeSectionYPositions($el), 10)"
x-init="setTimeout(() => sectionYPositions = computeSectionYPositions($el), 10)"
>
On This Page