From e657726555e1e7a494c5a759547b1d102d54c236 Mon Sep 17 00:00:00 2001 From: panne Date: Wed, 27 Aug 2003 07:50:03 +0000 Subject: [haddock @ 2003-08-27 07:50:02 by panne] * Made -D a short option for --dump-interface. * Made -m a short option for --ms-help. * Made -n a short option for --no-implicit-prelude. * Made -c a short option for --css. * Removed DocBook options from executable (they didn't do anything), but mark them as reserved in the docs. Note that the short option for DocBook output is now -S (from SGML) instead of -d. The latter is now a short option for --debug. * The order of the Options in the documentation now matches the order printed by Haddock itself. Note: Although changing the names of options is often a bad idea, I'd really like to make the options for the programs in fptools more consistent and compatible to the ones used in common GNU programs. --- doc/haddock.sgml | 167 ++++++++++++++++++++++++++++++++----------------------- 1 file changed, 97 insertions(+), 70 deletions(-) (limited to 'doc') diff --git a/doc/haddock.sgml b/doc/haddock.sgml index ce1112bc..a74e91fc 100644 --- a/doc/haddock.sgml +++ b/doc/haddock.sgml @@ -225,19 +225,49 @@ - - - - + dir + =dir + + + + Generate files into dir + instead of the current directory. + + + + + path,file + =path,file + + - Output documentation in SGML DocBook format. NOTE: at - time of writing this is only partially implemented and - doesn't work. + Read the interface file in + file, which must have been + produced by running Haddock with the + option. The interface + describes a set of modules whose HTML documentation is + located in path (which may be a + relative pathname). The path is + optional, and defaults to .. + + This option allows Haddock to produce separate sets of + documentation with hyperlinks between them. The + path is used to direct hyperlinks + to point to the right files; so make sure you don't move the + HTML files later or these links will break. Using a + relative path means that a + documentation subtree can still be moved around without + breaking links. + + Multiple options may + be given. + file =file + @@ -254,6 +284,28 @@ + + dir + =dir + + + + + Use auxiliary files in dir. + + + + + + + + + + Reserved for future use (output documentation in SGML DocBook + format). + + + @@ -304,36 +356,9 @@ - path,file - =path,file - - - - Read the interface file in - file, which must have been - produced by running Haddock with the - option. The interface - describes a set of modules whose HTML documentation is - located in path (which may be a - relative pathname). The path is - optional, and defaults to .. - - This option allows Haddock to produce separate sets of - documentation with hyperlinks between them. The - path is used to direct hyperlinks - to point to the right files; so make sure you don't move the - HTML files later or these links will break. Using a - relative path means that a - documentation subtree can still be moved around without - breaking links. - - Multiple options may - be given. - - - - + + @@ -359,24 +384,25 @@ - - - + URL + =URL + + - Don't automatically import Prelude - in every module. Used when producing documentation for the - Prelude itself. + Include links to the source files in the generated + documentation, where URL is the + base URL where the source files can be found. - dir - =dir - - + file + =file + - Generate files into dir - instead of the current directory. + Specify a stylesheet to use instead of the default one + that comes with Haddock. It should specify certain classes: + see the default stylesheet for details. @@ -394,18 +420,6 @@ - - URL - =URL - - - - Include links to the source files in the generated - documentation, where URL is the - base URL where the source files can be found. - - - title =title @@ -421,6 +435,29 @@ + + + + + + + + Don't automatically import Prelude + in every module. Used when producing documentation for the + Prelude itself. + + + + + + + + + + Produce extra debugging output. + + + @@ -440,16 +477,6 @@ Output version information and exit. - - - =filename - - - Specify a stylesheet to use instead of the default one - that comes with Haddock. It should specify certain classes: - see the default stylesheet for details. - - -- cgit v1.2.3