Document TrueType support.
[sgt/halibut] / doc / output.but
index 0cea3c2..c698a2b 100644 (file)
@@ -664,8 +664,10 @@ the index.
 
 \dt \I{\cw{\\cfg\{html-nav-next-text\}}}\cw{\\cfg\{html-nav-next-text\}\{}\e{text}\cw{\}}
 
-\dd The text used for the \q{previous page} and \q{next page} links on
-the navigation bar.
+\dt \I{\cw{\\cfg\{html-nav-up-text\}}}\cw{\\cfg\{html-nav-up-text\}\{}\e{text}\cw{\}}
+
+\dd The text used for the \q{previous page}, \q{next page}, and \q{up}
+links on the navigation bar.
 
 \dt \I{\cw{\\cfg\{html-nav-separator\}}}\cw{\\cfg\{html-nav-separator\}\{}\e{text}\cw{\}}
 
@@ -773,7 +775,7 @@ comments.
 
 \dd If this is set to \c{true}, machine-readable relational links will
 be emitted in each HTML file (\I{\cw{<LINK>} tags}\cw{<LINK
-REL="}\e{next}\cw{">} and so on within the \i\cw{<HEAD>} section)
+REL="next">} and so on within the \i\cw{<HEAD>} section)
 providing links to related files. The same set of links are provided
 as in the navigation bar (with which this should not be confused).
 
@@ -965,6 +967,7 @@ The \i{default settings} for Halibut's HTML output format are:
 \c \cfg{html-post-versionid}{]}
 \c \cfg{html-nav-prev-text}{Previous}
 \c \cfg{html-nav-next-text}{Next}
+\c \cfg{html-nav-up-text}{Up}
 \c \cfg{html-nav-separator}{ | }
 \c
 \c \cfg{html-output-charset}{ASCII}
@@ -1668,45 +1671,31 @@ The directives in this section control which fonts Halibut uses for
 various kinds of text.  Directives for setting the font normally take
 three font names, the first of which is used for normal text, the
 second for emphasised text, and the third for code.  Any fonts which
-aren't specified are left unchanged.  Fonts are named using their
-PostScript names.
+aren't specified are left unchanged.
 
 Halibut intrinsically knows about some fonts, and these fonts are also
-built into all PDF and most PostScript implementations.  These are:
-
-\b \cw{Times-Roman}
-
-\b \cw{Times-Italic}
-
-\b \cw{Times-Bold}
-
-\b \cw{Times-BoldItalic}
-
-\b \cw{Helvetica}
-
-\b \cw{Helvetica-Oblique}
-
-\b \cw{Helvetica-Bold}
-
-\b \cw{Helvetica-BoldOblique}
-
-\b \cw{Courier}
-
-\b \cw{Courier-Oblique}
-
-\b \cw{Courier-Bold}
-
-\b \cw{Courier-BoldOblique}
-
-These fonts can be used without further formality.  To use any other
-font, Halibut needs at least to know its measurements, which are
-provided in an \i{Adobe Font Metrics} (\I{AFM files}AFM) file.
-Halibut can also \I{embedding fonts}embed \i{Type 1 fonts} in its PDF
-and PostScript output if provided with font file in either hexadecimal (\I{PFA
-files}PFA) or IBM PC (\I{PFB files}PFB) format.  To provide
-an AFM, PFA, or PFB file to Halibut, simply name it on Halibut's command
-line.  If a PFA or PFB file is specified, the corresponding AFM file
-must come first.
+built into all PDF and most PostScript implementations.
+These fonts can be used without further formality.  Halibut can also use
+other fonts, and can \I{embedding fonts}embed them it its PDF and
+PostScript output.  These other fonts are supplied to Halibut by
+simply adding them to the list of input files on its command line.
+
+To use a \i{Type 1 font} Halibut needs both the font file itself,
+in either hexadecimal (\I{PFA files}PFA) or IBM PC (\I{PFB files}PFB)
+format, and an \i{Adobe Font Metrics} (\I{AFM files}AFM) file.  The AFM
+file must be specified first on the command line.  If Halibut gets an
+AFM file without a corresponding Type 1 font file, the PostScript and
+PDF output files will still use that font, but they won't contain it.
+
+Using a \i{TrueType font} is rather simpler, and simply requires you to
+pass the font file to Halibut.  Halibut does place a few restrictions on
+TrueType fonts, notably that they must include a \i{Unicode} mapping
+table and a PostScript name.
+
+Fonts are specified using their PostScript names.  Running Halibut with
+the \i\cw{\-\-list-fonts} option causes it to display the PostScript
+names of all the fonts it intrinsically knows about, along with any
+fonts the were supplied as input files.
 
 \ii{Font sizes} are specified in PostScript \i{points} (72 to the inch).