1halibut(1) Simon Tatham halibut(1)
2
6 halibut - multi-format documentation formatting tool
7
9 halibut [options] file1.but [file2.but ...]
10
12 halibut reads the given set of input files, assembles them into a docu‐
13 ment, and outputs that document in one or more formats.
14 The available command-line options can configure what formats Halibut
16 should output in, and can also configure other things about the way
17 Halibut works.
18
20 The command-line options supported by halibut are:
21 --text[=filename]
23 Makes Halibut generate an output file in plain text format. If
24 the optional filename parameter is supplied, the output text
25 file will be given that name. Otherwise, the name of the output
26 text file will be as specified in the input files, or output.txt
27 if none is specified at all.
28 --html[=filename]
30 Makes Halibut generate one or more output files in HTML format.
31 If the optional filename parameter is supplied, there will be
32 precisely one HTML output file with that name, containing the
33 whole document. Otherwise, there may be one or more than one
34 HTML file produced as output; this, and the file names, will be
35 as specified in the input files, or given a set of default names
36 starting with Contents.html if none is specified at all.
37 --chm[=filename]
39 Makes Halibut generate an output file in Windows HTML Help for‐
40 mat. If the optional filename parameter is supplied, the output
41 help file will be given that name. Otherwise, the name of the
42 output help file will be as specified in the input files, or
43 output.chm if none is specified at all.
44 --winhelp[=filename]
46 Makes Halibut generate an output file in old-style Windows Help
47 format. If the optional filename parameter is supplied, the out‐
48 put help file will be given that name. Otherwise, the name of
49 the output help file will be as specified in the input files, or
50 output.hlp if none is specified at all.
51 The output help file must have a name ending in .hlp; if it does
53 not, .hlp will be added. A secondary contents file will be cre‐
54 ated alongside the main help file, with the same name except
55 that it will end in .cnt (for example output.cnt, if the main
56 file is output.hlp).
57 --man[=filename]
59 Makes Halibut generate an output file in Unix man page format.
60 If the optional filename parameter is supplied, the output man
61 page will be given that name. Otherwise, the name of the output
62 man page will be as specified in the input files, or output.1 if
63 none is specified at all.
64 --info[=filename]
66 Makes Halibut generate an info file. If the optional filename
67 parameter is supplied, the output info file will be given that
68 name. Otherwise, the name of the output info file will be as
69 specified in the input files, or output.info if none is speci‐
70 fied at all.
71 By default, unless configured otherwise using the \cfg{info-max-
73 file-size}{0} directive, the info output will be split into mul‐
74 tiple files. The main file will have the name you specify; the
75 subsidiary files will have suffixes -1, -2 etc.
76 --pdf[=filename]
78 Makes Halibut generate an output file in PDF format. If the op‐
79 tional filename parameter is supplied, the PDF output file will
80 be given that name. Otherwise, the name of the output PDF file
81 will be as specified in the input files, or output.pdf if none
82 is specified at all.
83 --ps[=filename]
85 Makes Halibut generate an output file in PostScript format. If
86 the optional filename parameter is supplied, the PostScript out‐
87 put file will be given that name. Otherwise, the name of the
88 output PostScript file will be as specified in the input files,
89 or output.ps if none is specified at all.
90 -Cword:word[:word...]
92 Adds a configuration directive to the input processed by Hal‐
93 ibut. Using this directive is exactly equivalent to appending an
94 extra input file to the command line which contains the direc‐
95 tive \cfg{word}{word}{word...}.
96 --input-charset=charset
98 Changes the assumed character set for input files from the de‐
99 fault of ASCII.
100 --list-charsets
102 Makes Halibut list character sets known to it.
103 --list-fonts
105 Makes Halibut list fonts known to it, either intrinsically or by
106 being passed as input files.
107 --precise
109 Makes Halibut report the column number as well as the line num‐
110 ber when it encounters an error in an input file.
111 --help Makes Halibut display a brief summary of its command-line op‐
113 tions.
114 --version
116 Makes Halibut report its version number.
117 --licence
119 Makes Halibut display its licence (MIT).
120
122 For more information on Halibut, including full details of the input
123 file format, look in the full manual. If this is not installed locally
124 on your system, you can also find it at the Halibut web site:
125 https://www.chiark.greenend.org.uk/~sgtatham/halibut/
127
129 This man page isn't terribly complete.
130Halibut 2004‐04‐08 halibut(1)