The haskell-docs package

[Tags:bsd3, library, program]

Given a module name and a name, or just a name, it will find and display the documentation of that name.


 $ haskell-docs hSetBuffering
 Package: base
 Module: GHC.IO.Handle
 hSetBuffering :: Handle -> BufferMode -> IO ()
 Computation hSetBuffering `hdl mode` sets the mode of buffering for
  handle `hdl` on subsequent reads and writes.


You should ensure that you have

 documentation: True

in your .cabal/config so that the necessary .haddock files are generated.

Haddock is very sensitive to the GHC version. This program tries not to be. If you cannot install this package due to a version problem, open a Github issue. If the versions match up but the build fails, open a Github issue. Neither case should arise.


 > :def doc \input -> return (":!haskell-docs " ++ input)
 > :doc getContents
 The getContents operation returns all user input as a single string,
  which is read lazily as it is needed
  (same as hGetContents stdin).

Add the above :def to your user .ghci to have it on start-up.


Issues/ideas/contributions please make a Github issue:


Versions,,, 3.0.0, 3.0.2, 3.0.3, 4.0.0, 4.1.0, 4.1.1, 4.1.2, 4.1.3, 4.1.4, 4.1.5, 4.2.0, 4.2.1, 4.2.2, 4.2.3, 4.2.4, 4.2.5, 4.2.6
Dependencies aeson, base (>4 && <5), base16-bytestring, bytestring, Cabal, containers, cryptohash, directory, filepath, ghc (>=7.2 && <7.11), ghc-paths, haddock, haddock-api, haddock-library, haskell-docs, monad-loops, process, text, unordered-containers [details]
License BSD3
Copyright 2012 Chris Done
Author Chris Done
Stability Unknown
Category Development
Home page
Bug tracker
Source repository head: git clone git://
Uploaded Sat Nov 14 08:19:45 UTC 2015 by ChrisDone
Distributions NixOS:4.2.6
Downloads 7269 total (49 in the last 30 days)
0 []
Status Docs not available [build log]
All reported builds failed as of 2015-11-14 [all 2 reports]


  • Haskell
    • Haskell.Docs
      • Haskell.Docs.Cabal
      • Haskell.Docs.Formatting
      • Haskell.Docs.Ghc
      • Haskell.Docs.Haddock
      • Haskell.Docs.HaddockDoc
      • Haskell.Docs.Index
      • Haskell.Docs.Types


Maintainer's Corner

For package maintainers and hackage trustees