... oh, except that minimal documentation might be helpful.
[sgt/halibut] / doc / manpage.but
index 522d745..371b15d 100644 (file)
@@ -12,7 +12,7 @@
 \c halibut [options] file1.but [file2.but ...]
 \e bbbbbbb  iiiiiii  iiiiiiiii  iiiiiiiii
 
-\S{manpage-description} DESCRIPTION
+\H{manpage-description} DESCRIPTION
 
 \c{halibut} reads the given set of input files, assembles them into
 a document, and outputs that document in one or more formats.
@@ -21,7 +21,7 @@ The available command-line options can configure what formats
 Halibut should output in, and can also configure other things about
 the way Halibut works.
 
-\S{manpage-options} OPTIONS
+\H{manpage-options} OPTIONS
 
 The command-line options supported by \c{halibut} are:
 
@@ -67,6 +67,46 @@ output \cw{man} page will be given that name. Otherwise, the name of
 the output \cw{man} page will be as specified in the input files, or
 \c{output.1} if none is specified at all.
 
+\dt \cw{--info}[\cw{=}\e{filename}]
+
+\dd Makes Halibut generate an \c{info} file. If the optional
+\e{filename} parameter is supplied, the output \c{info} file will be
+given that name. Otherwise, the name of the output \c{info} file
+will be as specified in the input files, or \c{output.info} if none
+is specified at all.
+
+\lcont{
+By default, unless configured otherwise using the
+\cw{\\cfg\{info-max-file-size\}\{0\}} directive, the \c{info} output
+will be split into multiple files. The main file will have the name
+you specify; the subsidiary files will have suffixes \c{-1}, \c{-2}
+etc.
+}
+
+\dt \cw{--ps}[\cw{=}\e{filename}]
+
+\dd Makes Halibut generate an output file in PostScript format. If
+the optional \e{filename} parameter is supplied, the PostScript
+output file will be given that name. Otherwise, the name of
+the output PostScript file will be as specified in the input files,
+or \c{output.ps} if none is specified at all.
+
+\dt \cw{--pdf}[\cw{=}\e{filename}]
+
+\dd Makes Halibut generate an output file in PDF format. If
+the optional \e{filename} parameter is supplied, the PDF
+output file will be given that name. Otherwise, the name of
+the output PDF file will be as specified in the input files,
+or \c{output.pdf} if none is specified at all.
+
+\dt \cw{--man}[\cw{=}\e{filename}]
+
+\dd Makes Halibut generate an output file in Unix \cw{man} page
+format. If the optional \e{filename} parameter is supplied, the
+output \cw{man} page will be given that name. Otherwise, the name of
+the output \cw{man} page will be as specified in the input files, or
+\c{output.1} if none is specified at all.
+
 \dt \cw{-C}\e{word}\cw{:}\e{word}[\cw{:}\e{word}...]
 
 \dd Adds a configuration directive to the input processed by
@@ -92,7 +132,7 @@ options.
 
 \dd Makes Halibut display its licence (MIT).
 
-\S{putty-manpage-more-information} MORE INFORMATION
+\H{putty-manpage-more-information} MORE INFORMATION
 
 For more information on Halibut, including full details of the input
 file format, look in the full manual. If this is not installed
@@ -100,12 +140,10 @@ locally on your system, you can also find it at the Halibut web site:
 
 \W{http://www.chiark.greenend.org.uk/~sgtatham/halibut/}\cw{http://www.chiark.greenend.org.uk/~sgtatham/halibut/}
 
-\S{putty-manpage-bugs} BUGS
+\H{putty-manpage-bugs} BUGS
 
 This man page isn't terribly complete.
 
 The HTML output isn't very good.
 
 Unicode handling is atrocious.
-
-Several more output formats (PostScript, PDF, \cw{info}) are missing.