X-Git-Url: https://git.distorted.org.uk/~mdw/sgt/halibut/blobdiff_plain/2e032f926f6ad66ecc1546fe582430007bf05907..97079f675c8899177e44a5ff6a7a7710b8cc72c8:/doc/output.but diff --git a/doc/output.but b/doc/output.but index 0cea3c2..f109d94 100644 --- a/doc/output.but +++ b/doc/output.but @@ -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{} tags}\cw{} and so on within the \i\cw{} section) +REL="next">} and so on within the \i\cw{} 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} @@ -1259,10 +1262,10 @@ The \i{default settings} for the \cw{man} page output format are: \c \cfg{man-rule}{\u2500}{-} \c \cfg{man-quotes}{\u2018}{\u2019}{"}{"} -\H{output-info} GNU \c{info} +\H{output-info} GNU Info This output format generates files which can be used with the \i{GNU -\c{info}} program. +Info} program. There are typically multiple output files: a primary file whose name usually ends in \c{.info}, and one or more subsidiary files whose @@ -1271,14 +1274,14 @@ names have numbers on the end, so that they end in \c{.info-1}, configured to output a single large file containing the whole document. -The \c{info} output format supports the following configuration +The Info output format supports the following configuration directives: \S{output-info-file} Controlling the output filenames \dt \I{\cw{\\cfg\{info-filename\}}}\cw{\\cfg\{info-filename\}\{}\e{filename}\cw{\}} -\dd Sets the output file name in which to store the \c{info} file. +\dd Sets the output file name in which to store the Info file. This directive is implicitly generated if you provide a file name parameter after the command-line option \i\c{--info} (see \k{running-options}). @@ -1288,8 +1291,8 @@ parameter after the command-line option \i\c{--info} (see The suffixes \c{-1}, \c{-2}, \c{-3} and so on will be appended to your output file name to produce any subsidiary files required. -Note that \c{info} files refer to their own names internally, so -these files cannot be \I{renaming \c{info} files}renamed after +Note that Info files refer to their own names internally, so +these files cannot be \I{renaming Info files}renamed after creation and remain useful. } @@ -1306,7 +1309,7 @@ not be renamed usefully.) The preferred maximum file size is only a guideline. Halibut may be forced to exceed it if a single section of the document is larger -than the maximum size (since individual \c{info} nodes may not be +than the maximum size (since individual Info nodes may not be split between files). } @@ -1416,7 +1419,7 @@ name}\cw{\}\{}\e{long name}\cw{\}}[\cw{\{}\e{keyword}\cw{\}}] \dd Constructs an \i\cw{INFO-DIR-ENTRY} section and places it in the header of the Info file. This mechanism is used to automatically generate the \i{\c{dir} file} at the root of a Unix system's -\c{info} collection. +Info collection. \lcont{ @@ -1464,7 +1467,7 @@ if the output file were called \c{mygames.info} and the keyword \S{output-info-defaults} Default settings -The \i{default settings} for the \c{info} output format are: +The \i{default settings} for the Info output format are: \c \cfg{info-filename}{output.info} \c \cfg{info-max-file-size}{65536} @@ -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).