summaryrefslogtreecommitdiff
path: root/doc/running.but
diff options
context:
space:
mode:
authorSimon Tatham <anakin@pobox.com>2006-12-11 19:43:10 +0000
committerSimon Tatham <anakin@pobox.com>2006-12-11 19:43:10 +0000
commit7a4700f5f5afcea1580ec4fcfb628afe6beb3e6b (patch)
treef12b714c11a7d71c40462b05ebcf03ff8b6aa7f0 /doc/running.but
parent490fa6c766aece7ea7cd0cf11ee10c2b37efc386 (diff)
downloadhalibut-7a4700f5f5afcea1580ec4fcfb628afe6beb3e6b.zip
halibut-7a4700f5f5afcea1580ec4fcfb628afe6beb3e6b.tar.gz
halibut-7a4700f5f5afcea1580ec4fcfb628afe6beb3e6b.tar.bz2
halibut-7a4700f5f5afcea1580ec4fcfb628afe6beb3e6b.tar.xz
Support for the MS HTML Help system in the HTML back end. As yet I
don't know how to write out a .CHM directly, but I am at least able to have the HTML back end write out the three auxiliary files which enable a .CHM to be generated using the MS HTML Help compiler. [originally from svn r6991]
Diffstat (limited to 'doc/running.but')
-rw-r--r--doc/running.but29
1 files changed, 16 insertions, 13 deletions
diff --git a/doc/running.but b/doc/running.but
index 884c33f..8574708 100644
--- a/doc/running.but
+++ b/doc/running.but
@@ -14,18 +14,20 @@ This will generate a large set of \i{output files}:
\b \i\c{output.txt} will be a \i{plain text} version of the input
document.
-\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.)
+\b \i\c{output.hlp} and \i\c{output.cnt} will be an old-style
+\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
-\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.
+
+Note that to do this Halibut does not require any external software
+such as a \i{Help compiler}. It \e{directly} generates old-style
+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 \i{\cw{man} page}.
@@ -81,9 +83,10 @@ line, using the \c{-C} option).
\dt \i\cw{--winhelp}[\cw{=}\e{filename}]
-\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.
+\dd Specifies that you want to generate old-style 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.
\lcont{