c38da2b7 |
1 | \cfg{man-identity}{halibut}{1}{2004-04-08}{Halibut}{Simon Tatham} |
2 | \cfg{man-mindepth}{1} |
3 | |
4 | \A{manpage} Halibut \cw{man} page |
5 | |
6 | \H{manpage-name} NAME |
7 | |
8 | \cw{halibut} - multi-format documentation formatting tool |
9 | |
10 | \H{manpage-synopsis} SYNOPSIS |
11 | |
12 | \c halibut [options] file1.but [file2.but ...] |
13 | \e bbbbbbb iiiiiii iiiiiiiii iiiiiiiii |
14 | |
5ff1157f |
15 | \H{manpage-description} DESCRIPTION |
c38da2b7 |
16 | |
17 | \c{halibut} reads the given set of input files, assembles them into |
18 | a document, and outputs that document in one or more formats. |
19 | |
20 | The available command-line options can configure what formats |
21 | Halibut should output in, and can also configure other things about |
22 | the way Halibut works. |
23 | |
5ff1157f |
24 | \H{manpage-options} OPTIONS |
c38da2b7 |
25 | |
26 | The command-line options supported by \c{halibut} are: |
27 | |
28 | \dt \cw{--text}[\cw{=}\e{filename}] |
29 | |
30 | \dd Makes Halibut generate an output file in plain text format. If |
31 | the optional \e{filename} parameter is supplied, the output text |
32 | file will be given that name. Otherwise, the name of the output text |
33 | file will be as specified in the input files, or \c{output.txt} if |
34 | none is specified at all. |
35 | |
36 | \dt \cw{--html}[\cw{=}\e{filename}] |
37 | |
38 | \dd Makes Halibut generate one or more output files in HTML format. |
39 | If the optional \e{filename} parameter is supplied, there will be |
40 | precisely one HTML output file with that name, containing the whole |
41 | document. Otherwise, there may be one or more than one HTML file |
42 | produced as output; this, and the file names, will be as specified |
43 | in the input files, or given a set of default names starting with |
44 | \c{Contents.html} if none is specified at all. |
45 | |
46 | \dt \cw{--winhelp}[\cw{=}\e{filename}] |
47 | |
48 | \dd Makes Halibut generate an output file in Windows Help format. If |
49 | the optional \e{filename} parameter is supplied, the output help |
50 | file will be given that name. Otherwise, the name of the output help |
51 | file will be as specified in the input files, or \c{output.hlp} if |
52 | none is specified at all. |
53 | |
54 | \lcont{ |
55 | The output help file must have a name ending in \c{.hlp}; if it does |
56 | not, \c{.hlp} will be added. A secondary contents file will be created |
57 | alongside the main help file, with the same name except that it will |
58 | end in \c{.cnt} (for example \c{output.cnt}, if the main file is |
59 | \c{output.hlp}). |
60 | } |
61 | |
62 | \dt \cw{--man}[\cw{=}\e{filename}] |
63 | |
64 | \dd Makes Halibut generate an output file in Unix \cw{man} page |
65 | format. If the optional \e{filename} parameter is supplied, the |
66 | output \cw{man} page will be given that name. Otherwise, the name of |
67 | the output \cw{man} page will be as specified in the input files, or |
68 | \c{output.1} if none is specified at all. |
69 | |
a5df5e27 |
70 | \dt \cw{--info}[\cw{=}\e{filename}] |
71 | |
72 | \dd Makes Halibut generate an \c{info} file. If the optional |
73 | \e{filename} parameter is supplied, the output \c{info} file will be |
74 | given that name. Otherwise, the name of the output \c{info} file |
75 | will be as specified in the input files, or \c{output.info} if none |
76 | is specified at all. |
77 | |
78 | \lcont{ |
79 | By default, unless configured otherwise using the |
80 | \cw{\\cfg\{info-max-file-size\}\{0\}} directive, the \c{info} output |
81 | will be split into multiple files. The main file will have the name |
82 | you specify; the subsidiary files will have suffixes \c{-1}, \c{-2} |
83 | etc. |
84 | } |
85 | |
0287083a |
86 | \dt \cw{--ps}[\cw{=}\e{filename}] |
87 | |
88 | \dd Makes Halibut generate an output file in PostScript format. If |
89 | the optional \e{filename} parameter is supplied, the PostScript |
90 | output file will be given that name. Otherwise, the name of |
91 | the output PostScript file will be as specified in the input files, |
92 | or \c{output.ps} if none is specified at all. |
93 | |
94 | \dt \cw{--pdf}[\cw{=}\e{filename}] |
95 | |
96 | \dd Makes Halibut generate an output file in PDF format. If |
97 | the optional \e{filename} parameter is supplied, the PDF |
98 | output file will be given that name. Otherwise, the name of |
99 | the output PDF file will be as specified in the input files, |
100 | or \c{output.pdf} if none is specified at all. |
101 | |
c38da2b7 |
102 | \dt \cw{-C}\e{word}\cw{:}\e{word}[\cw{:}\e{word}...] |
103 | |
104 | \dd Adds a configuration directive to the input processed by |
105 | Halibut. Using this directive is exactly equivalent to appending an |
106 | extra input file to the command line which contains the directive |
107 | \cw{\\cfg\{}\e{word}\cw{\}\{}\e{word}\cw{\}\{}\e{word}...\cw{\}}. |
108 | |
109 | \dt \cw{--precise} |
110 | |
111 | \dd Makes Halibut report the column number as well as the line |
112 | number when it encounters an error in an input file. |
113 | |
114 | \dt \cw{--help} |
115 | |
116 | \dd Makes Halibut display a brief summary of its command-line |
117 | options. |
118 | |
119 | \dt \cw{--version} |
120 | |
121 | \dd Makes Halibut report its version number. |
122 | |
123 | \dt \cw{--licence} |
124 | |
125 | \dd Makes Halibut display its licence (MIT). |
126 | |
5ff1157f |
127 | \H{putty-manpage-more-information} MORE INFORMATION |
c38da2b7 |
128 | |
129 | For more information on Halibut, including full details of the input |
130 | file format, look in the full manual. If this is not installed |
131 | locally on your system, you can also find it at the Halibut web site: |
132 | |
133 | \W{http://www.chiark.greenend.org.uk/~sgtatham/halibut/}\cw{http://www.chiark.greenend.org.uk/~sgtatham/halibut/} |
134 | |
5ff1157f |
135 | \H{putty-manpage-bugs} BUGS |
c38da2b7 |
136 | |
137 | This man page isn't terribly complete. |
138 | |
139 | The HTML output isn't very good. |
140 | |
141 | Unicode handling is atrocious. |