Add a --list-fonts option, since getting PostScript names out of TrueType
[sgt/halibut] / doc / running.but
index b2b2819..6d6cb7a 100644 (file)
@@ -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}.
@@ -41,10 +43,10 @@ have configured Halibut to generate a single file, it will be called
 \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.
 
+\b \c{output.ps} will be a printable PostScript manual.
+
 \H{running-options} \ii{Command-line options}
 
 Halibut supports command-line options in case you don't want to use
@@ -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{
 
@@ -123,18 +126,18 @@ 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.
 
+\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.
+
 If you do not specify any of the above options, Halibut will simply
 produce \e{all} of its output formats.
 
@@ -178,7 +181,7 @@ identically to \c{--text -Ctext-filename:myfile.txt}. The Windows
 Help and man page formats work similarly. HTML is slightly
 different, since it also arranges for single-file output if you pass
 a filename to \c{--html}; so \c{--html=myfile.html} is equivalent to
-\c{--html -Cxhtml-single-filename:myfile.html -Cxhtml-leaf-level:0}.
+\c{--html -Chtml-single-filename:myfile.html -Chtml-leaf-level:0}.
 (See \k{output} for explanations of all these configuration
 directives.)
 
@@ -186,7 +189,7 @@ In addition to these, there are also a few other options:
 
 \dt \i\cw{--input-charset}\cw{=}\e{charset}
 
-\dd Changes the default assumed character set for all input files from
+\dd Changes the default assumed \i{character set} for all input files from
 ASCII to something else. (\cw{-Cinput-charset} cannot be used for
 this, as \cw{-C} directives are processed after all other input, so
 wouldn't affect any files.)
@@ -200,6 +203,15 @@ See \k{input-config} for more information about the input character set.
 
 }
 
+\dt \I{character sets, enumerating}\i\cw{--list-charsets}
+
+\dd List character sets known to Halibut.
+
+\dt \i\cw{--list-fonts}
+
+\dd List fonts known to Halibut, both those it intrinsically knows about
+and those found in its input files.
+
 \dt \i\cw{--help}
 
 \dd Print a brief help message and exit immediately. (Don't confuse