diff options
| author | Ben Gamari <ben@smart-cactus.org> | 2016-03-28 17:02:14 +0200 |
|---|---|---|
| committer | Ben Gamari <ben@smart-cactus.org> | 2016-04-10 23:47:27 +0200 |
| commit | 7699b27c5766473709bc84bc69269a409dfad9a2 (patch) | |
| tree | bbed25b1926f371c9097a49f6f04de8fdf81a81f /doc/invoking.rst | |
| parent | ea63a59882c6d1ecd5e4147d3500d664c9431dd8 (diff) | |
doc: Fix option references
(cherry picked from commit f915fb3c74328fb994235bbbd42092a691539197)
Diffstat (limited to 'doc/invoking.rst')
| -rw-r--r-- | doc/invoking.rst | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/doc/invoking.rst b/doc/invoking.rst index c69c9031..13cb9f1e 100644 --- a/doc/invoking.rst +++ b/doc/invoking.rst @@ -27,8 +27,8 @@ considered a bug in the new versions. If you ever get failed parsing message, please report it. You must also specify an option for the output format. Currently only -the :option:`-h` option for HTML and the :option:`--hoogle` option for outputting -Hoogle data are functional. +the :option:`--html` option for HTML and the :option:`--hoogle` option for +outputting Hoogle data are functional. The packaging tool `Cabal <http://www.haskell.org/ghc/docs/latest/html/Cabal/index.html>`__ @@ -37,8 +37,6 @@ directly. The following options are available: -.. program:: haddock - .. option:: -B <dir> Tell GHC that that its lib directory is dir. Can be used to override @@ -94,8 +92,7 @@ The following options are available: Haddock interface files are not the same as Haskell interface files, I just couldn't think of a better name. -.. option:: -h - --html +.. option:: --html, -h Generate documentation in HTML format. Several files will be generated into the current directory (or the specified directory if @@ -157,6 +154,11 @@ The following options are available: is given, then ``haddock.sty`` is not generated, and the command is instead ``\usepackage{style}``. +.. option:: --hoogle + + Generate an index file for the + `Hoogle <http://hackage.haskell.org/package/hoogle>`_ search engine. + .. option:: --hyperlinked-source Generate hyperlinked source code (as HTML web page). All rendered @@ -455,4 +457,3 @@ Since Haddock uses GHC internally, both plain and literate Haskell sources are accepted without the need for the user to do anything. To use the C pre-processor, however, the user must pass the the :option:`-cpp` option to GHC using :option:`--optghc`. - |