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