We seem to have ended up with duplicate documentation of --man. Gone.
[sgt/halibut] / doc / running.but
index e0c0e78..37e36f3 100644 (file)
@@ -1,11 +1,11 @@
 \C{running} Running Halibut
 
 \I{running Halibut}In the simplest case, running Halibut is very
 \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}:
 
 
 This will generate a large set of \i{output files}:
 
@@ -124,13 +124,13 @@ 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
 \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{--man=myfile.ps}), in
+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
 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{--man=myfile.pdf}), in
+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
 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
@@ -155,6 +155,14 @@ will translate into the configuration directive
 
 \c \cfg{text-section-align}{2}{leftplus}
 
 
 \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
 }
 
 The options which set the output file names actually work by