tldr: Haskell tldr client

[ bsd3, cli, library, program, web ] [ Propose Tags ] [ Report a vulnerability ]

Haskell tldr client with support for viewing tldr pages. Has offline cache for accessing pages. Visit https://tldr.sh for more details.

[Skip to Readme]

Modules

[Index] [Quick Jump]

Tldr

Flags

Manual Flags

Name	Description	Default
static	Statically link executables.	Disabled

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

tldr-0.9.2.tar.gz [browse] (Cabal source package)
Package description (as included in the package)

Maintainer's Corner

Package maintainers

psibi

For package maintainers and hackage trustees

edit package information

Candidates

No Candidates

Versions [RSS]	0.1.0.0, 0.2.0, 0.2.1, 0.2.2, 0.2.3, 0.2.4, 0.2.5, 0.3.0, 0.3.1, 0.4.0, 0.4.0.1, 0.4.0.2, 0.5.0, 0.5.1, 0.6.0, 0.6.1, 0.6.2, 0.6.3, 0.6.4, 0.7.0, 0.7.1, 0.8.0, 0.9.0, 0.9.1, 0.9.2
Change log	CHANGELOG.md
Dependencies	ansi-terminal, attoparsec, base (>=4.7 && <5), bytestring, cmark, containers, directory, filepath, http-conduit, optparse-applicative, semigroups, text, time, tldr, zip-archive [details]
License	BSD-3-Clause
Copyright	2017 Sibi Prabakaran
Author	Sibi Prabakaran
Maintainer	sibi@psibi.in
Category	Web, CLI
Home page	https://github.com/psibi/tldr-hs#readme
Bug tracker	https://github.com/psibi/tldr-hs/issues
Source repo	head: git clone https://github.com/psibi/tldr-hs
Uploaded	by psibi at 2021-10-16T04:55:24Z
Distributions	Debian:0.6.4, LTSHaskell:0.9.2, NixOS:0.9.2, Stackage:0.9.2
Executables	tldr
Downloads	11319 total (56 in the last 30 days)
Rating	2.0 (votes: 1) [estimated by Bayesian average]
Your Rating	λ λ λ
Status	Docs available [build log] Last success reported on 2021-10-16 [all 1 reports]

Readme for tldr-0.9.2

[back to package description]

tldr

Haskell client for tldr

Table of Contents

tldr

Installation

See Github releases: https://github.com/psibi/tldr-hs/releases

Executables are available for all the three major platforms: Linux, Windows and MacOS.

Install stack
stack install tldr

Usage

$ tldr --help
tldr - Simplified and community-driven man pages

Usage: tldr [-v|--version] ((-u|--update) | [-p|--platform PLATFORM]
            [-L|--language LOCALE] COMMAND | (-a|--about))
  tldr Client program

Available options:
  -h,--help                Show this help text
  -v,--version             Show version
  -u,--update              Update offline cache of tldr pages
  -p,--platform PLATFORM   Prioritize a specific platform while searching. Valid
                           values include linux, osx, windows, sunos
  -L,--language LOCALE     Preferred language for the page returned
  COMMAND                  name of the command
  -a,--about               About this program
  --auto-update-interval DAYS
                           Perform an automatic update if the cache is older
                           than DAYS

Or a much better example of the usage:

$ tldr tldr
tldr
Simplified man pages. More information: https://tldr.sh.

 - Get typical usages of a command (hint: this is how you got here!):
   tldr {{command}}

 - Show the tar tldr page for linux:
   tldr -p {{linux}} {{tar}}

 - Get help for a git subcommand:
   tldr {{git checkout}}

Offline caching

On the first run, this program caches all available tldr pages. Since the number of available tldr pages rises quickly, it is recommended to regularly update the cache. Such an update can be run manually with:

$ tldr --update

Starting with version 0.9.0, users of this client can enable automatic updates by running it with the option --auto-update-interval DAYS specified. The client will then check whether the cached version of the tldr pages is older than DAYS days and perform an update in that case. To enable this functionality permanently, users can put the line alias tldr="tldr --auto-update-interval DAYS" in their shell configuration file (e.g. .bashrc, .zshrc) with the desired update interval specified.

Snapshot

tldr