BSD-3-Clause licensed by Sibi Prabakaran
Maintained by [email protected]
This version can be pinned in stack with:tldr-0.9.2@sha256:d9f6f7b0ee25c14afd40be7a1f883b6684a97a269701d7087c9ba7e733e571ed,2223

Module documentation for 0.9.2

tldr

Build Status

Hackage Stackage Nightly Stackage LTS

Haskell client for tldr

Table of Contents

Installation

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

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

Or

  1. Install stack
  2. 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

Changes

0.9.2

0.9.1

  • When the NO_COLOR environment variable is set, the client will not color the output.
  • Added --[no-]color options which enable/disable output coloring (overrides NO_COLOR).

0.9.0

  • When pages are updated, the client now shows the download location.
  • Add optional auto-update functionality (--auto-update-interval)

0.8.0

0.7.1

  • Client gives non zero exit status for non-existent pages.

0.7.0

  • Make it obey –language (-L) option.

0.6.4

  • Fix cabal file

0.6.3

  • Drop -optl-static for linux builds

0.6.2

  • package.yaml support for configuring package
  • CI releases binary now

0.6.1

  • Implement –about option

0.6.0

  • Make it obey –platform option
  • Add -u as an alias for –update
  • Make parsing more robust

0.5.1

  • Proper options handling

0.5.0

  • Obey XdgData for storing the files.
  • Also search pages from sunos directory now.
  • Support subcommands ie. tldr git submodule will now work.

0.4.0.2

  • Fix double initialization bug. Credits to @Kove-W-O-Salter

0.4.0

  • Add proper coloring back
  • Update gitignore rule
  • Update travis and appveyor configuration

0.3.1

  • Add golden testing using tasty
  • Fix grep render #11
  • Fixes #2

0.3.0

  • Add default completion support from optparse-applicative
  • Add windows support. Credits to @ShrykeWindgrace.

0.2.5

  • Fix eager cloning

0.2.4

  • Don’t do cloning unnecessarily #7
  • Fix Paths_tldr warning from cabal

0.2.3

  • Fix coloring bug under bash during some circumstances #6

0.2.2

  • Fix --version option

0.2.1

  • Fix background color bug

0.2.0

  • Compliance with the tldr spec
  • Fix --update flag bug
  • Backported till GHC 7.8.3 and lts-2.22