summaryrefslogtreecommitdiff
path: root/doc/running.but
diff options
context:
space:
mode:
authorSimon Tatham <anakin@pobox.com>2004-03-30 19:22:19 +0000
committerSimon Tatham <anakin@pobox.com>2004-03-30 19:22:19 +0000
commitc1469440142291402d5a77a4613c07f841bb3157 (patch)
tree8b1db116a562f58cd1e7fedd0a713124ede7aaf6 /doc/running.but
parent58cee09140826d377a1e20cb4b0d064723d1355e (diff)
downloadhalibut-c1469440142291402d5a77a4613c07f841bb3157.zip
halibut-c1469440142291402d5a77a4613c07f841bb3157.tar.gz
halibut-c1469440142291402d5a77a4613c07f841bb3157.tar.bz2
halibut-c1469440142291402d5a77a4613c07f841bb3157.tar.xz
The manual is now fully indexed.
[originally from svn r3999]
Diffstat (limited to 'doc/running.but')
-rw-r--r--doc/running.but43
1 files changed, 22 insertions, 21 deletions
diff --git a/doc/running.but b/doc/running.but
index d871459..5666e30 100644
--- a/doc/running.but
+++ b/doc/running.but
@@ -1,47 +1,48 @@
\C{running} Running Halibut
-Running Halibut is very simple. You provide a set of input files on
-its command line, and it produces a set of output files.
+\I{running Halibut}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.
\c $ halibut intro.but getting-started.but reference.but index.but
\e bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
-This will generate a large set of output files:
+This will generate a large set of \i{output files}:
-\b \c{output.txt} will be a plain ASCII text version of the input
+\b \i\c{output.txt} will be a \i{plain text} version of the input
document.
-\b \c{output.hlp} and \c{output.cnt} will be a Windows Help version
-of the same thing. (Most of the text is in \c{output.hlp};
+\b \i\c{output.hlp} and \i\c{output.cnt} will be a \i{Windows Help}
+version of the same thing. (Most of the text is in \c{output.hlp};
\c{output.cnt} contains additional contents data used by the Windows
help topic selector. If you lose the latter, the former should still
be usable, but it will look less modern.)
\lcont{
Note that Halibut does not require any external software such as a
-Help compiler. It \e{directly} generates Windows Help files, and
+\i{Help compiler}. It \e{directly} generates Windows Help files, and
therefore it doesn't need to be run on Windows to do so: it can
generate them even when run from an automated script on a Unix
machine.
}
-\b \c{output.1} will be a Unix man page.
+\b \c{output.1} will be a Unix \i{\cw{man} page}.
-\b The set of files \c{*.html} will contain an HTML version of the
-document. If you have configured Halibut to generate more than one
-HTML file (the default), then the file \c{Contents.html} will be the
-topmost one that users should be directed to initially. If you have
-configured Halibut to generate a single file, it will be called
+\b The set of files \c{*.html} will contain an \i{HTML} version of
+the document. If you have configured Halibut to generate more than
+one HTML file (the default), then the file \c{Contents.html} will be
+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}.
-Unfortunately, in the current version, it is not possible to
-tell Halibut to generate these files under different names; so you
-will need to rename them manually after they are generated. (Even
-this won't work for the multiple-file HTML document, because there
-will be lots of internal hyperlinks between the various files which
-use their names.) Neither is it possible to tell Halibut not to
-bother generating some of the output formats, so you will need to
-delete any that you don't want.
+Unfortunately, in the current version, it is not possible to tell
+Halibut to generate these files under different names; so you will
+need to \I{renaming files}rename them manually after they are
+generated. (Even this won't work for the multiple-file HTML
+document, because there will be lots of internal hyperlinks between
+the various files which use their names.) Neither is it possible to
+tell Halibut not to bother generating some of the output formats, so
+you will need to delete any that you don't want.
I regret this inconvenience; it arose because I was more interested
in getting the difficult document-formatting code to work than I was