X-Git-Url: https://git.distorted.org.uk/~mdw/sgt/halibut/blobdiff_plain/fc8e7adbb194aca9bee7e1c76283b90af302618f..4105facaec17862f03a6217f93a1609606f2a7cd:/doc/running.but diff --git a/doc/running.but b/doc/running.but index b9fcdc2..884c33f 100644 --- a/doc/running.but +++ b/doc/running.but @@ -1,3 +1,5 @@ +\versionid $Id$ + \C{running} Running Halibut \I{running Halibut}In the simplest case, running Halibut is very @@ -39,10 +41,10 @@ have configured Halibut to generate a single file, it will be called \c{output.info-2} etc., will be files suitable for use with GNU \c{info}. -\b \c{output.ps} will be a printable PostScript manual. - \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 @@ -121,16 +123,16 @@ additional files \c{output.info-1}, \c{output.info-2} and so on. } -\dt \i\cw{--ps}[\cw{=}\e{filename}] +\dt \i\cw{--pdf}[\cw{=}\e{filename}] -\dd Specifies that you want to generate PostScript output. You -can optionally specify a file name (e.g. \c{--man=myfile.ps}), in +\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{--pdf}[\cw{=}\e{filename}] +\dt \i\cw{--ps}[\cw{=}\e{filename}] -\dd Specifies that you want to generate PDF output. You -can optionally specify a file name (e.g. \c{--man=myfile.pdf}), in +\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 @@ -163,6 +165,10 @@ 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 @@ -172,12 +178,32 @@ identically to \c{--text -Ctext-filename:myfile.txt}. The Windows 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