X-Git-Url: https://git.distorted.org.uk/~mdw/sgt/halibut/blobdiff_plain/c38da2b7883d7b2c6ce92f13538f7511b0b50f5d..9145a34e01bad868390e446f35ea8d7807795426:/doc/manpage.but diff --git a/doc/manpage.but b/doc/manpage.but index 522d745..c39543e 100644 --- a/doc/manpage.but +++ b/doc/manpage.but @@ -1,3 +1,5 @@ +\versionid $Id$ + \cfg{man-identity}{halibut}{1}{2004-04-08}{Halibut}{Simon Tatham} \cfg{man-mindepth}{1} @@ -5,14 +7,14 @@ \H{manpage-name} NAME -\cw{halibut} - multi-format documentation formatting tool +\cw{halibut} \u2013{\u2212{-}} multi-format documentation formatting tool \H{manpage-synopsis} SYNOPSIS \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 +23,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 +69,38 @@ 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{--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{--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{-C}\e{word}\cw{:}\e{word}[\cw{:}\e{word}...] \dd Adds a configuration directive to the input processed by @@ -74,6 +108,15 @@ Halibut. Using this directive is exactly equivalent to appending an extra input file to the command line which contains the directive \cw{\\cfg\{}\e{word}\cw{\}\{}\e{word}\cw{\}\{}\e{word}...\cw{\}}. +\dt \cw{--input-charset}\cw{=}\e{charset} + +\dd Changes the assumed character set for input files from the +default of ASCII. + +\dt \cw{--list-charsets} + +\dd Makes Halibut list character sets known to it. + \dt \cw{--precise} \dd Makes Halibut report the column number as well as the line @@ -92,7 +135,7 @@ options. \dd Makes Halibut display its licence (MIT). -\S{putty-manpage-more-information} MORE INFORMATION +\H{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 +143,6 @@ 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{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.