Previous | Contents | Index | Next
man
page
halibut
– multi-format documentation formatting tool
halibut [options] file1.but [file2.but ...]
halibut
reads the given set of input files, assembles them into a document, and outputs that document in one or more formats.
The available command-line options can configure what formats Halibut should output in, and can also configure other things about the way Halibut works.
The command-line options supported by halibut
are:
--text
[=
filename]
output.txt
if none is specified at all.
--html
[=
filename]
Contents.html
if none is specified at all.
--winhelp
[=
filename]
output.hlp
if none is specified at all.
The output help file must have a name ending in .hlp
; if it does not, .hlp
will be added. A secondary contents file will be created alongside the main help file, with the same name except that it will end in .cnt
(for example output.cnt
, if the main file is output.hlp
).
--man
[=
filename]
man
page format. If the optional filename parameter is supplied, the output man
page will be given that name. Otherwise, the name of the output man
page will be as specified in the input files, or output.1
if none is specified at all.
--info
[=
filename]
info
file. If the optional filename parameter is supplied, the output info
file will be given that name. Otherwise, the name of the output info
file will be as specified in the input files, or output.info
if none is specified at all.
By default, unless configured otherwise using the \cfg{info-max-file-size}{0}
directive, the info
output will be split into multiple files. The main file will have the name you specify; the subsidiary files will have suffixes -1
, -2
etc.
--pdf
[=
filename]
output.pdf
if none is specified at all.
--ps
[=
filename]
output.ps
if none is specified at all.
-C
word:
word[:
word...]
\cfg{
word}{
word}{
word...}
.
--input-charset=
charset
--list-charsets
--list-fonts
--precise
--help
--version
--licence
For more information on Halibut, including full details of the input file format, look in the full manual. If this is not installed locally on your system, you can also find it at the Halibut web site:
http://www.chiark.greenend.org.uk/~sgtatham/halibut/
This man page isn't terribly complete.