summaryrefslogtreecommitdiff
path: root/doc/running.but
diff options
context:
space:
mode:
authorSimon Tatham <anakin@pobox.com>2004-04-14 22:34:21 +0000
committerSimon Tatham <anakin@pobox.com>2004-04-14 22:34:21 +0000
commitb62a309209cf4b85d41d67c2b0b1229d565e7d27 (patch)
treecaaf81aa0fe4ffe79eb9d87513133c43a096c2c5 /doc/running.but
parentd7e234693f1eb9d0aafb251e1e4e7999ec8b3cfa (diff)
downloadhalibut-b62a309209cf4b85d41d67c2b0b1229d565e7d27.zip
halibut-b62a309209cf4b85d41d67c2b0b1229d565e7d27.tar.gz
halibut-b62a309209cf4b85d41d67c2b0b1229d565e7d27.tar.bz2
halibut-b62a309209cf4b85d41d67c2b0b1229d565e7d27.tar.xz
After printing out the PDF manual and reading it through, here's a
collection of minor edits for clarity, and also quite a few intended to keep down the length of lines in code paragraphs (because Courier is not just a thoroughly ugly font but is also WAY TOO WIDE). [originally from svn r4076]
Diffstat (limited to 'doc/running.but')
-rw-r--r--doc/running.but16
1 files changed, 12 insertions, 4 deletions
diff --git a/doc/running.but b/doc/running.but
index e0c0e78..b9fcdc2 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}:
@@ -155,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