BSD-3-Clause licensed by Sibi
Maintained by sibi@psibi.in

Module documentation for 0.6.0

This version can be pinned in stack with:tldr-0.6.0@sha256:c844080bcfb3fcf4156706aae3b0b12bddf5a6d4ad263d352d57aa4bdbc99cf3,1811

tldr

Build Status

Hackage Stackage Nightly Stackage LTS

Haskell client for tldr

Installation

  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] COMMAND)
  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 specfic platform while searching. Valid
                           values include linux, osx, windows, sunos
  COMMAND                  name of the command

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}}

Snapshot

tldr

Changes

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
comments powered byDisqus