Download Halibut User Manual

Appendix B: Halibut man page
B.1 NAME
halibut – multi-format documentation formatting tool
B.2 SYNOPSIS
halibut [options] file1.but [file2.but ...]
B.3 DESCRIPTION
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.
B.4 OPTIONS
The command-line options supported by halibut are:
--text[=filename]
Makes Halibut generate an output file in plain text format. If the optional filename
parameter is supplied, the output text file will be given that name. Otherwise, the name
of the output text file will be as specified in the input files, or output.txt if none is
specified at all.
--html[=filename]
Makes Halibut generate one or more output files in HTML format. If the optional filename
parameter is supplied, there will be precisely one HTML output file with that name,
containing the whole document. Otherwise, there may be one or more than one HTML file
produced as output; this, and the file names, will be as specified in the input files, or given
a set of default names starting with Contents.html if none is specified at all.
--winhelp[=filename]
Makes Halibut generate an output file in Windows Help format. If the optional filename
parameter is supplied, the output help file will be given that name. Otherwise, the name
of the output help file will be as specified in the input files, or 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
62