Add a --list-fonts option, since getting PostScript names out of TrueType
[sgt/halibut] / doc / output.but
index df4580e..7852692 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{\}}
 
@@ -739,8 +741,8 @@ available variants are:
 
 \dd This directive lets you specify a \i{template}, with exactly the
 same syntax used in \cw{\\cfg\{html-template-filename\}} (see
-\k{output-html-file}), to be used for the anchor names (\i\cw{<a
-name="...">}) used to allow URLs to refer to specific sections
+\k{output-html-file}), to be used for the anchor names (\i\cw{<A
+NAME="...">}) used to allow URLs to refer to specific sections
 within a particular HTML file. So if you set this to \cq{%k},
 for example, then each individual section in your document will be
 addressable by means of a URL ending in a \c{#} followed by your
@@ -769,10 +771,33 @@ visibly in the \i\cw{<ADDRESS>} section at the bottom of each HTML
 file. If it is set to \c{false}, they will only be included as HTML
 comments.
 
+\dt \I{\cw{\\cfg\{html-rellinks\}}}\cw{\\cfg\{html-rellinks\}\{}\e{boolean}\cw{\}}
+
+\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="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).
+
+\lcont{
+
+Some browsers make use of this semantic information, for instance to
+allow easy navigation through related pages, and to prefetch the next
+page. (Search engines can also make use of it.) However, many browsers
+ignore this markup, so it would be unwise to rely on it for
+navigation.
+
+The use and rendering of this information is entirely up to the
+browser; none of the other Halibut options for the navigation bar will
+have any effect.
+
+}
+
 \dt \I{\cw{\\cfg\{html-suppress-navlinks\}}}\cw{\\cfg\{html-suppress-navlinks\}\{}\e{boolean}\cw{\}}
 
-\dd If this is set to \c{true}, the usual \i{navigation links} at the
-top of each HTML file will be suppressed.
+\dd If this is set to \c{true}, the usual \i{navigation links} within
+the \e{body} of each HTML file (near the top of the rendered page) will
+be suppressed.
 
 \dt \I{\cw{\\cfg\{html-suppress-address\}}}\cw{\\cfg\{html-suppress-address\}\{}\e{boolean}\cw{\}}
 
@@ -892,7 +917,7 @@ has its own navigation facilities and it looks a bit strange to
 duplicate them.
 
 \b \cw{\\cfg\{html-suppress-address\}\{true\}}, because the
-\cw{<address>} section makes less sense in a help file than it does
+\cw{<ADDRESS>} section makes less sense in a help file than it does
 on a web page.
 
 \S{output-html-defaults} Default settings
@@ -942,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}
@@ -951,6 +977,8 @@ The \i{default settings} for Halibut's HTML output format are:
 \c \cfg{html-version}{html4}
 \c \cfg{html-template-fragment}{%b}
 \c \cfg{html-versionid}{true}
+\c \cfg{html-rellinks}{true}
+\c \cfg{html-suppress-navlinks{false}
 \c \cfg{html-suppress-address}{false}
 \c \cfg{html-author}{}
 \c \cfg{html-description}{}
@@ -1643,44 +1671,24 @@ 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 an
-ASCII-format (\I{PFA files}PFA) font file.  To provide an AFM or PFA file
-to Halibut, simply name it on Halibut's command line.  If both are named,
-the AFM file must come first.
+built into all PDF and most PostScript implementations.
+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.
+
+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).