X-Git-Url: https://git.distorted.org.uk/~mdw/sgt/halibut/blobdiff_plain/43f61c25ffd4b1e5403c4ae6d49e6a0a39fd4444..e34ba5c3b8a7bcb8fceb437125da3a6a6f6d2dba:/doc/output.but diff --git a/doc/output.but b/doc/output.but index 74f4c2c..986f53d 100644 --- a/doc/output.but +++ b/doc/output.but @@ -247,7 +247,7 @@ which is why all of the configuration directives start with the word \dd Sets the \i{output file name} in which to store the top-level contents page. Since this is the first page a user ought to see when beginning to read the document, a good choice in many cases might be -\c{index.html} (but this is not the default, for historical +\c{index.html} (although this is not the default, for historical reasons). \dt \I{\cw{\\cfg\{xhtml-index-filename\}}}\cw{\\cfg\{xhtml-index-filename\}\{}\e{filename}\cw{\}} @@ -488,10 +488,10 @@ particular level, before displaying the section title. \dd This directive lets you specify a \i{template}, with exactly the same syntax used in \cw{\\cfg\{xhtml-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 within -a particular HTML file. So if you set this to \q{\cw{%k}}, for -example, then each individual section in your document will be +\k{output-html-file}), to be used for the anchor names (\i\cw{}) used to allow URLs to refer to specific sections +within a particular HTML file. So if you set this to \q{\cw{%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 internal section keyword. @@ -662,7 +662,8 @@ A traditional order for the arguments appears to be: For example, a typical \cw{man} page might contain -\c \cfg{man-identity}{make-foo}{1}{June 2003}{foo-utils}{Fred Bloggs} +\c \cfg{man-identity}{make-foo}{1}{June 2003}{foo-utils}{Fred +\c Bloggs} } @@ -704,7 +705,8 @@ simply says Then you have a file \c{make-foo.but}, and probably others like it as well, each of which looks something like this: -\c \cfg{man-identity}{make-foo}{1}{June 2003}{foo-utils}{Fred Bloggs} +\c \cfg{man-identity}{make-foo}{1}{June 2003}{foo-utils}{Fred +\c Bloggs} \c \c \H{man-foo} \cw{man} page for \c{make-foo} \c @@ -830,7 +832,8 @@ about assigning keywords to document sections). For example, in a document describing many game programs, the configuration directive -\c \cfg{info-dir-entry}{Games}{Chess}{Electronic chess game}{chess} +\c \cfg{info-dir-entry}{Games}{Chess}{Electronic chess +\c game}{chess} might produce text in the \c{dir} file looking something like this: @@ -841,3 +844,43 @@ if the output file were called \c{mygames.info} and the keyword \c{chess} had been used to define Chapter 3 of the document. } + +\H{output-ps} \i{PostScript} + +This output format generates a printable manual in PostScript format. + +This format is currently very new and is not yet configurable. There +is only one available configuration option: + +\dt \I{\cw{\\cfg\{ps-filename\}}}\cw{\\cfg\{ps-filename\}\{}\e{filename}\cw{\}} + +\dd Sets the \i{output file name} in which to store the PostScript +file. This directive is implicitly generated if you provide a file +name parameter after the command-line option \i\c{--ps} (see +\k{running-options}). + +The \i{default settings} for the PostScript output format are: + +\c \cfg{ps-filename}{output.ps} + +\H{output-pdf} \i{PDF} + +This output format generates a printable manual in PDF format. This +should look exactly identical to the PostScript output (see +\k{output-ps}), but also uses some PDF interactive features to +provide an outline of all the document's sections and clickable +cross-references between sections. + +This format is currently very new and is not yet configurable. There +is only one available configuration option: + +\dt \I{\cw{\\cfg\{pdf-filename\}}}\cw{\\cfg\{pdf-filename\}\{}\e{filename}\cw{\}} + +\dd Sets the \i{output file name} in which to store the PDF file. +This directive is implicitly generated if you provide a file name +parameter after the command-line option \i\c{--pdf} (see +\k{running-options}). + +The \i{default settings} for the PDF output format are: + +\c \cfg{pdf-filename}{output.pdf}