Usage: haddock-ghc-9.14.1 [OPTION...] file...
-B DIR path to a GHC lib dir, to override the default path
-o DIR --odir=DIR directory in which to put the output files
-l DIR --lib=DIR location of Haddock's auxiliary files
-i FILE --read-interface=FILE read an interface from FILE
-D FILE --dump-interface=FILE write the resulting interface to FILE
--show-interface=FILE print the interface in a human readable form
--no-compilation never compile the code, just read the .hi files
--incremental=MODULE generate documentation for a single module only, given its module name
-h --html output in HTML (XHTML 1.0)
--latex use experimental LaTeX rendering
--latex-style=FILE provide your own LaTeX style in FILE
--mathjax=URL URL FOR mathjax
-U --use-unicode use Unicode in HTML output
--hoogle output for Hoogle; you may want --package-name and --package-version too
--quickjump generate an index for interactive documentation navigation
--hyperlinked-source generate highlighted and hyperlinked source code (for use with --html)
--source-css=FILE use custom CSS file instead of default one in hyperlinked source
--source-base=URL URL for a source code link on the contents
and index pages
-s URL --source-module=URL URL for a source code link for each module
(using the %{FILE} or %{MODULE} vars)
--source-entity=URL URL for a source code link for each entity
(using the %{FILE}, %{MODULE}, %{NAME},
%{KIND} or %{LINE} vars)
--source-entity-line=URL URL for a source code link for each entity.
Used if name links are unavailable, eg. for TH splices.
--comments-base=URL URL for a comments link on the contents
and index pages
--base-url=URL Base URL for static assets (eg. css, javascript, json files etc.).
When given statis assets will not be copied.
--comments-module=URL URL for a comments link for each module
(using the %{MODULE} var)
--comments-entity=URL URL for a comments link for each entity
(using the %{FILE}, %{MODULE}, %{NAME},
%{KIND} or %{LINE} vars)
-c PATH --css=PATH, --theme=PATH the CSS file or theme directory to use for HTML output
--built-in-themes include all the built-in haddock themes
-p FILE --prologue=FILE file containing prologue text
-t TITLE --title=TITLE page heading
-q QUAL --qual=QUAL qualification of names, one of
'none' (default), 'full', 'local'
'relative' or 'aliased'
-? --help display this help and exit
-V --version output version information and exit
--compatible-interface-versions output compatible interface file versions and exit
--interface-version output interface file version and exit
--bypass-interface-version-check bypass the interface file version check (dangerous)
-v VERBOSITY --verbosity=VERBOSITY set verbosity level
--use-contents=URL use a separately-generated HTML contents page
--gen-contents generate an HTML contents from specified
interfaces
--use-index=URL use a separately-generated HTML index
--gen-index generate an HTML index from specified
interfaces
--ignore-all-exports behave as if all modules have the
ignore-exports attribute
--hide=MODULE behave as if MODULE has the hide attribute
--show=MODULE behave as if MODULE does not have the hide attribute
--show-all behave as if not modules have the hide attribute
--show-extensions=MODULE behave as if MODULE has the show-extensions attribute
--optghc=OPTION option to be forwarded to GHC
--ghc-version output GHC version in numeric format
--print-ghc-path output path to GHC binary
--print-ghc-libdir output GHC lib dir
-w --no-warnings turn off all warnings
--no-tmp-comp-dir do not re-direct compilation output to a temporary directory
--pretty-html generate html with newlines and indenting (for use with --html)
--no-print-missing-docs don't print information about any undocumented entities
--reexport=MOD reexport the module MOD, adding it to the index
--package-name=NAME name of the package being documented
--package-version=VERSION version of the package being documented in usual x.y.z.w format
--since-qual=QUAL package qualification of @since, one of
'always' (default) or 'only-external'
--ignore-link-symbol=SYMBOL name of a symbol which does not trigger a warning in case of link issue
-j[n] load modules in parallel
--trace-args print the arguments provided for this invocation to stdout
Options (60)
| Option | Description | Source |
|---|---|---|
-B DIR | path to a GHC lib dir, to override the default path | help |
-o DIR | --odir=DIR directory in which to put the output files | help |
-l DIR | --lib=DIR location of Haddock's auxiliary files | help |
-i FILE | --read-interface=FILE read an interface from FILE | help |
-D FILE | --dump-interface=FILE write the resulting interface to FILE | help |
--show-interface FILE | print the interface in a human readable form | help |
--no-compilation | never compile the code, just read the .hi files | help |
--incremental MODULE | generate documentation for a single module only, given its module name | help |
-h | --html output in HTML (XHTML 1.0) | help |
--latex | use experimental LaTeX rendering | help |
--latex-style FILE | provide your own LaTeX style in FILE | help |
--mathjax URL | URL FOR mathjax | help |
-U | --use-unicode use Unicode in HTML output | help |
--hoogle | output for Hoogle; | help |
--quickjump | generate an index for interactive documentation navigation | help |
--hyperlinked-source | generate highlighted and hyperlinked source code (for use with --html) | help |
--source-css FILE | use custom CSS file instead of default one in hyperlinked source | help |
--source-base URL | URL for a source code link on the contents and index pages | help |
-s URL | --source-module=URL URL for a source code link for each module (using the %{FILE} or %{MODULE} vars) | help |
--source-entity URL | URL for a source code link for each entity (using the %{FILE}, %{MODULE}, %{NAME}, %{KIND} or %{LINE} vars) | help |
--source-entity-line URL | URL for a source code link for each entity. | help |
--comments-base URL | URL for a comments link on the contents and index pages | help |
--base-url URL | Base URL for static assets (eg. | help |
--comments-module URL | URL for a comments link for each module (using the %{MODULE} var) | help |
--comments-entity URL | URL for a comments link for each entity (using the %{FILE}, %{MODULE}, %{NAME}, %{KIND} or %{LINE} vars) | help |
-c PATH | --css=PATH, --theme=PATH the CSS file or theme directory to use for HTML output | help |
--built-in-themes | include all the built-in haddock themes | help |
-p FILE | --prologue=FILE file containing prologue text | help |
-t TITLE | --title=TITLE page heading | help |
-q QUAL | --qual=QUAL qualification of names, one of 'none' (default), 'full', 'local' 'relative' or 'aliased' | help |
-? | --help display this help and exit | help |
-V | --version output version information and exit | help |
--compatible-interface-versions | output compatible interface file versions and exit | help |
--interface-version | output interface file version and exit | help |
--bypass-interface-version-check | bypass the interface file version check (dangerous) | help |
-v VERBOSITY | --verbosity=VERBOSITY set verbosity level | help |
--use-contents URL | use a separately-generated HTML contents page | help |
--gen-contents | generate an HTML contents from specified interfaces | help |
--use-index URL | use a separately-generated HTML index | help |
--gen-index | generate an HTML index from specified interfaces | help |
--ignore-all-exports | behave as if all modules have the ignore-exports attribute | help |
--hide MODULE | behave as if MODULE has the hide attribute | help |
--show MODULE | behave as if MODULE does not have the hide attribute | help |
--show-all | behave as if not modules have the hide attribute | help |
--show-extensions MODULE | behave as if MODULE has the show-extensions attribute | help |
--optghc OPTION | option to be forwarded to GHC | help |
--ghc-version | output GHC version in numeric format | help |
--print-ghc-path | output path to GHC binary | help |
--print-ghc-libdir | output GHC lib dir | help |
-w | --no-warnings turn off all warnings | help |
--no-tmp-comp-dir | do not re-direct compilation output to a temporary directory | help |
--pretty-html | generate html with newlines and indenting (for use with --html) | help |
--no-print-missing-docs | don't print information about any undocumented entities | help |
--reexport MOD | reexport the module MOD, adding it to the index | help |
--package-name NAME | name of the package being documented | help |
--package-version VERSION | version of the package being documented in usual x.y.z.w format | help |
--since-qual QUAL | package qualification of @since, one of 'always' (default) or 'only-external' | help |
--ignore-link-symbol SYMBOL | name of a symbol which does not trigger a warning in case of link issue | help |
-j n | load modules in parallel | help |
--trace-args | print the arguments provided for this invocation to stdout | help |