X-Git-Url: https://git.distorted.org.uk/~mdw/sgt/halibut/blobdiff_plain/6761732390d3b85be048a805b8c1a2a241b85f1c..a167785523d1ecb246be0ea24d008629b2791b19:/doc/running.but

diff --git a/doc/running.but b/doc/running.but
index e79400d..37e36f3 100644
--- a/doc/running.but
+++ b/doc/running.but
@@ -1,11 +1,11 @@
 \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}:
 
@@ -35,6 +35,14 @@ the topmost one that users should be directed to initially. If you
 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.ps} will be a printable PostScript manual.
+
+\b \c{output.pdf} will be a printable PDF manual.
+
 \H{running-options} \ii{Command-line options}
 
 Halibut supports command-line options in case you don't want to use
@@ -71,7 +79,7 @@ line, using the \c{-C} option).
 
 \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.
 
@@ -93,9 +101,37 @@ Halibut will append it. Halibut will also generate a contents file
 
 \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{--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.
+
+\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.
 
 If you do not specify any of the above options, Halibut will simply
 produce \e{all} of its output formats.
@@ -119,6 +155,14 @@ will translate into the configuration directive
 
 \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.)
+
 }
 
 The options which set the output file names actually work by