+\versionid $Id$
+
\C{running} Running Halibut
\I{running Halibut}In the simplest case, running Halibut is very
-simple. You provide a set of input files on its \i{command line},
-and it produces a set of output files.
+easy. You provide a set of input files on its \i{command line}, and
+it produces a set of output files.
-\c $ halibut intro.but getting-started.but reference.but index.but
-\e bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
+\c $ halibut intro.but gettingstarted.but reference.but index.but
+\e bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
This will generate a large set of \i{output files}:
have configured Halibut to generate a single file, it will be called
\c{Manual.html}.
+\b \c{output.info}, and some additional files \c{output.info-1},
+\c{output.info-2} etc., will be files suitable for use with GNU
+\c{info}.
+
+\b \c{output.pdf} will be a printable PDF manual.
+
+\b \c{output.ps} will be a printable PostScript manual.
+
\H{running-options} \ii{Command-line options}
Halibut supports command-line options in case you don't want to use
\dt \i\cw{--winhelp}[\cw{=}\e{filename}]
-\dd Specifies that you want to generate plain text output. You can
+\dd Specifies that you want to generate Windows Help output. You can
optionally specify a file name (e.g. \c{--winhelp=myfile.hlp}), in
which case Halibut will change the name of the output file as well.
\dt \i\cw{--man}[\cw{=}\e{filename}]
-\dd Specifies that you want to generate plain text output. You can
-optionally specify a file name (e.g. \c{--man=myfile.5}), in which
-case Halibut will change the name of the output file as well.
+\dd Specifies that you want to generate \cw{man} page output. You
+can optionally specify a file name (e.g. \c{--man=myfile.5}), in
+which case Halibut will change the name of the output file as well.
+
+\dt \i\cw{--info}[\cw{=}\e{filename}]
+
+\dd Specifies that you want to generate GNU \c{info} output. You can
+optionally specify a file name (e.g. \c{--info=myfile.info}), in
+which case Halibut will change the name of the output file as well.
+
+\lcont{
+
+Unless the \c{info} output format is configured not to (see
+\k{output-info}), Halibut will divide the \c{info} output into many
+small files. The extra files will have numeric suffixes on their
+names; so, for example, \c{output.info} might be accompanied by
+additional files \c{output.info-1}, \c{output.info-2} and so on.
+
+}
+
+\dt \i\cw{--pdf}[\cw{=}\e{filename}]
+
+\dd Specifies that you want to generate PDF output. You
+can optionally specify a file name (e.g. \c{--pdf=myfile.pdf}), in
+which case Halibut will change the name of the output file as well.
+
+\dt \i\cw{--ps}[\cw{=}\e{filename}]
+
+\dd Specifies that you want to generate PostScript output. You
+can optionally specify a file name (e.g. \c{--ps=myfile.ps}), in
+which case Halibut will change the name of the output file as well.
+
+If you do not specify any of the above options, Halibut will simply
+produce \e{all} of its output formats.
Also, there is an option which allows you to specify an arbitrary
\i\c{\\cfg} configuration directive (see \k{input-config}):
\c \cfg{text-section-align}{2}{leftplus}
+(Note that your shell may also take an interest in backslashes,
+particularly under Unix. You may find that the backslash with which
+you escape a colon must be doubled in order to make the shell pass
+it to Halibut at all, and to pass a doubled backslash to Halibut you
+might have to type four backslashes on your shell command line. This
+is not part of Halibut's own behaviour, and it cannot do anything
+about it.)
+
+Configuration directives created in this way take effect after all
+other input has been processed. (In most cases, this has the effect of
+overriding any other instances of the directive in the input.)
+
}
The options which set the output file names actually work by
Help and man page formats work similarly. HTML is slightly
different, since it also arranges for single-file output if you pass
a filename to \c{--html}; so \c{--html=myfile.html} is equivalent to
-\c{--html -Cxhtml-single-filename:myfile.html -Cxhtml-leaf-level:0}.
+\c{--html -Chtml-single-filename:myfile.html -Chtml-leaf-level:0}.
(See \k{output} for explanations of all these configuration
directives.)
In addition to these, there are also a few other options:
+\dt \i\cw{--input-charset}\cw{=}\e{charset}
+
+\dd Changes the default assumed \i{character set} for all input files from
+ASCII to something else. (\cw{-Cinput-charset} cannot be used for
+this, as \cw{-C} directives are processed after all other input, so
+wouldn't affect any files.)
+
+\lcont{
+
+Any \cw{\\cfg\{input-charset\}} directives within input files override
+this option.
+
+See \k{input-config} for more information about the input character set.
+
+}
+
+\dt \I{character sets, enumerating}\i\cw{--list-charsets}
+
+\dd List character sets known to Halibut.
+
\dt \i\cw{--help}
\dd Print a brief help message and exit immediately. (Don't confuse
~mdw / sgt / halibut / blobdiff