This Info file generated by Halibut, version 1.3

INFO-DIR-SECTION Documentation
START-INFO-DIR-ENTRY
* Halibut: (halibut).   Multi-format documentation processing system
END-INFO-DIR-ENTRY

This manual is copyright 2004-2017 Simon Tatham. All rights reserved.
You may distribute this documentation under the MIT licence. See
*Note Appendix A:: for the licence text in full.

[Halibut version 1.3]

File: halibut.info,  Node: Section 4.6,  Prev: Section 4.5.5,  Up: Chapter 4,  Next: Section 4.6.1

Section 4.6: GNU Info
---------------------

This output format generates files which can be used with the GNU Info
program.

There are typically multiple output files: a primary file whose name
usually ends in `.info', and one or more subsidiary files whose names
have numbers on the end, so that they end in `.info-1', `.info-2' and
so on. Alternatively, this output format can be configured to output a
single large file containing the whole document.

The Info output format supports the following configuration
directives:

* Menu:

* Section 4.6.1:: Controlling the output filenames
* Section 4.6.2:: Indentation and line width
* Section 4.6.3:: Configuring heading display
* Section 4.6.4:: Controlling the characters used
* Section 4.6.5:: Miscellaneous configuration options
* Section 4.6.6:: Default settings

File: halibut.info,  Node: Section 4.6.1,  Prev: Section 4.6,  Up: Section 4.6,  Next: Section 4.6.2

Section 4.6.1: Controlling the output filenames
...............................................

\cfg{info-filename}{_filename_}

    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 `--info' (see
    *Note Section 2.1::).

    The suffixes `-1', `-2', `-3' and so on will be appended to your
    output file name to produce any subsidiary files required.

    Note that Info files refer to their own names internally, so these
    files cannot be renamed after creation and remain useful.

\cfg{info-max-file-size}{_bytes_}

    Sets the preferred maximum file size for each subsidiary file.
    As a special case, if you set this to zero, there will be no
    subsidiary files and the whole document will be placed in a single
    self-contained output file. (However, note that this file can
    still 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 Info nodes may not
    be split between files).


File: halibut.info,  Node: Section 4.6.2,  Prev: Section 4.6.1,  Up: Section 4.6,  Next: Section 4.6.3

Section 4.6.2: Indentation and line width
.........................................

\cfg{info-width}{_width_}

    Sets the width of the main part of the document, in characters.
    Works exactly like the \cfg{text-width} directive (see
    *Note Section 4.1.2::).

\cfg{info-indent-code}{_indent_}

    Specifies the extra indentation for  code paragraphs. Works
    exactly like the \cfg{text-indent-code} directive (see
    *Note Section 4.1.2::).

\cfg{info-index-width}{_width_}

    Specifies how much horizontal space to leave in the index node for
    the text of index terms, before displaying the sections the terms
    occur in.

\cfg{info-list-indent}{_indent_}

    Specifies the extra indentation before the bullet or number in a
    list item. Works exactly like the \cfg{text-list-indent} directive
    (see *Note Section 4.1.2::).

\cfg{info-listitem-indent}{_indent_}

    Specifies the additional indentation before the body of a list
    item. Works exactly like the \cfg{text-listitem-indent} directive
    (see *Note Section 4.1.2::).


File: halibut.info,  Node: Section 4.6.3,  Prev: Section 4.6.2,  Up: Section 4.6,  Next: Section 4.6.4

Section 4.6.3: Configuring heading display
..........................................

\cfg{info-section-suffix}{_text_}

    Specifies the suffix text to be appended to each section number
    before displaying the section title. For example, if you set this
    to `: ', then a typical section title might look something like
    `Section 3.1: Something Like This'.

\cfg{info-title-underline}{_text_}[{_text_}...]

    Specifies the text to be used to underline the overall document
    title. Works very much like the \cfg{text-title-underline}
    directive (see *Note Section 4.1.3::). You can specify more than
    one option, and Halibut will choose the first one supported by the
    character set.

\cfg{info-chapter-underline}{_text_}[{_text_}...]

    Specifies how chapter and appendix headings should be underlined.

\cfg{info-section-underline}{_level_}{_text_}[{_text_}...]

    Specifies how to underline section headings at a particular
    level. The _level_ parameter specifies which level of section
    headings you want to affect: 0 means first-level headings (`\H'),
    1 means second-level headings (`\S'), 2 means the level below that
    (`\S2'), and so on.


File: halibut.info,  Node: Section 4.6.4,  Prev: Section 4.6.3,  Up: Section 4.6,  Next: Section 4.6.5

Section 4.6.4: Controlling the characters used
..............................................

\cfg{info-charset}{_character set_}

    Specifies what character set the output should be in, similarly to
    \cfg{text-charset} (see *Note Section 4.1.4::).

\cfg{info-bullet}{_text_}[{_text_}...]

    Specifies the text to use as the bullet in bulletted lists. You
    can specify multiple fallback options. Works exactly like the
    \cfg{text-bullet} directive (see *Note Section 4.1.4::).

\cfg{info-rule}{_text_}[{_text_}...]

    Specifies the text used to draw horizontal rules. You can specify
    multiple fallback options. Works exactly like the \cfg{text-rule}
    directive (see *Note Section 4.1.4::).

\cfg{info-quotes}{_open-quote_}{_close-quote_}[{_open-quote_}{_close-
quote_...}]

    Specifies the quotation marks to use, overriding any
    \cfg{quotes} directive. You can specify multiple fallback
    options. Works exactly like the \cfg{text-quotes} directive (see
    *Note Section 4.1.4::).

\cfg{info-emphasis}{_start-emph_}{_end-emph_}[{_start-emph_}{_end-
emph_...}]

    Specifies how to display emphasised text. You can specify multiple
    fallback options. Works exactly like the \cfg{text-emphasis}
    directive (see *Note Section 4.1.4::).

\cfg{info-strong}{_start-strong_}{_end-strong_}[{_start-strong_}{_end-
strong_...}]

    Specifies how to display strong text. You can specify multiple
    fallback options. Works exactly like the \cfg{text-emphasis}
    directive (see *Note Section 4.1.4::).


File: halibut.info,  Node: Section 4.6.5,  Prev: Section 4.6.4,  Up: Section 4.6,  Next: Section 4.6.6

Section 4.6.5: Miscellaneous configuration options
..................................................

\cfg{info-list-suffix}{_text_}

    Specifies the text to append to the item numbers in a numbered
    list. Works exactly like the \cfg{text-list-suffix} directive (see
    *Note Section 4.1.5::).

\cfg{info-dir-entry}{_section_}{_short name_}{_long
name_}[{_keyword_}]

    Constructs an INFO-DIR-ENTRY section and places it in the header
    of the Info file. This mechanism is used to automatically generate
    the `dir' file at the root of a Unix system's Info collection.

    The parameters to this directive are:

    _section_

        Specifies the section of the `dir' file in which you want your
        document referenced. For example, `Development', or `Games',
        or `Miscellaneous'.

    _short name_

        Specifies a short name for the directory entry, which will
        appear at the start of the menu line.

    _long name_

        Specifies a long name for the directory entry, which will
        appear at the end of the menu line.

    _keyword_

        This parameter is optional. If it is present, then the
        directory entry will cause a jump to a particular subsection
        of your document, rather than starting at the top. The
        subsection will be the one referred to by the given keyword
        (see *Note Section 3.3.5:: for details about assigning
        keywords to document sections).

    For example, in a document describing many game programs, the
    configuration directive

      \cfg{info-dir-entry}{Games}{Chess}{Electronic chess
      game}{chess}

    might produce text in the `dir' file looking something like this:

      Games
      * Chess: (mygames)Chapter 3.   Electronic chess game

    if the output file were called `mygames.info' and the keyword
    `chess' had been used to define Chapter 3 of the document.


File: halibut.info,  Node: Section 4.6.6,  Prev: Section 4.6.5,  Up: Section 4.6,  Next: Section 4.7

Section 4.6.6: Default settings
...............................

The default settings for the Info output format are:

  \cfg{info-filename}{output.info}
  \cfg{info-max-file-size}{65536}
  
  \cfg{info-width}{70}
  \cfg{info-indent-code}{2}
  \cfg{info-index-width}{40}
  \cfg{info-list-indent}{1}
  \cfg{info-listitem-indent}{3}
  
  \cfg{info-section-suffix}{: }
  \cfg{info-title-underline}{*}
  \cfg{info-chapter-underline}{=}
  \cfg{info-section-underline}{0}{-}
  \cfg{info-section-underline}{1}{.}
  \cfg{info-section-underline}{2}{.}
  ... and so on for all section levels below this ...
  
  \cfg{info-charset}{ASCII}
  \cfg{info-bullet}{\u2022}{-}
  \cfg{info-rule}{\u2500}{-}
  \cfg{info-quotes}{\u2018}{\u2019}{`}{'}
  \cfg{info-emphasis}{_}{_}
  \cfg{info-strong}{*}{*}
  
  \cfg{info-list-suffix}{.}

and no \cfg{info-dir-entry} directives.


File: halibut.info,  Node: Section 4.7,  Prev: Section 4.6.6,  Up: Chapter 4,  Next: Section 4.7.1

Section 4.7: Paper formats
--------------------------

These output formats (currently PDF and PostScript) generate printable
manuals. As such, they share a number of configuration directives.

* Menu:

* Section 4.7.1:: PDF
* Section 4.7.2:: PostScript
* Section 4.7.3:: Configuring layout and measurements
* Section 4.7.4:: Configuring the characters used
* Section 4.7.5:: Default settings for paper formats

File: halibut.info,  Node: Section 4.7.1,  Prev: Section 4.7,  Up: Section 4.7,  Next: Section 4.7.2

Section 4.7.1: PDF
..................

This output format generates a printable manual in PDF format. In
addition, it uses some PDF interactive features to provide an outline
of all the document's sections and clickable cross-references between
sections.

There is one configuration option specific to PDF:

\cfg{pdf-filename}{_filename_}

    Sets the 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 `--pdf' (see
    *Note Section 2.1::).

The default settings for the PDF output format are:

  \cfg{pdf-filename}{output.pdf}


File: halibut.info,  Node: Section 4.7.2,  Prev: Section 4.7.1,  Up: Section 4.7,  Next: Section 4.7.3

Section 4.7.2: PostScript
.........................

This output format generates a printable manual in PostScript
format. This should look exactly identical to the PDF output (see
*Note Section 4.7.2::), and uses `pdfmark' to arrange that if
converted to PDF it will contain the same interactive features.

There is one configuration option specific to PostScript:

\cfg{ps-filename}{_filename_}

    Sets the 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 `--ps' (see
    *Note Section 2.1::).

The default settings for the PostScript output format are:

  \cfg{ps-filename}{output.ps}


File: halibut.info,  Node: Section 4.7.3,  Prev: Section 4.7.2,  Up: Section 4.7,  Next: Section 4.7.3.1

Section 4.7.3: Configuring layout and measurements
..................................................

All measurements are in PostScript points (72 points to the inch).

* Menu:

* Section 4.7.3.1:: Page properties
* Section 4.7.3.2:: Vertical spacing
* Section 4.7.3.3:: Indentation
* Section 4.7.3.4:: Headings
* Section 4.7.3.5:: Contents and index
* Section 4.7.3.6:: Fonts
* Section 4.7.3.7:: Miscellaneous

File: halibut.info,  Node: Section 4.7.3.1,  Prev: Section 4.7.3,  Up: Section 4.7.3,  Next: Section 4.7.3.2

Section 4.7.3.1: Page properties
................................

\cfg{paper-page-width}{_points_}

\cfg{paper-page-height}{_points_}

    Specify the absolute limits of the paper.

\cfg{paper-left-margin}{_points_}

\cfg{paper-top-margin}{_points_}

\cfg{paper-right-margin}{_points_}

\cfg{paper-bottom-margin}{_points_}

    Specify the margins. Most text appears within these margins,
    except:

     -  Section numbers, which appear in the left margin.

     -  The footer (containing page numbers), which appears in the
        bottom margin.


File: halibut.info,  Node: Section 4.7.3.2,  Prev: Section 4.7.3.1,  Up: Section 4.7.3,  Next: Section 4.7.3.3

Section 4.7.3.2: Vertical spacing
.................................

\cfg{paper-base-leading}{_points_}

    Specifies the amount of space between lines of text within a
    paragraph. (So, if the font size is 12pt and there is 2pt of
    leading, there will be 14pt between successive baselines.)

\cfg{paper-base-para-spacing}{_points_}

    Specifies the amount of vertical space between paragraphs. (The
    vertical space between paragraphs does _not_ include `paper-base-
    leading'.)


File: halibut.info,  Node: Section 4.7.3.3,  Prev: Section 4.7.3.2,  Up: Section 4.7.3,  Next: Section 4.7.3.4

Section 4.7.3.3: Indentation
............................

\cfg{paper-list-indent}{_points_}

    Specifies the indentation of the bullet or number in a bulletted
    or numbered list, similarly to \cfg{text-list-indent} (see
    *Note Section 4.1.2::).

\cfg{paper-listitem-indent}{_points_}

    Specifies the _extra_ indentation for the body of a list item,
    over and above the amount configured in \cfg{paper-list-indent}.

\cfg{paper-quote-indent}{_points_}

    Specifies the amount of indentation for a level of quoting. Used
    for \quote (see *Note Section 3.3.4::) and code quotes with \c
    (see *Note Section 3.2.2::).


File: halibut.info,  Node: Section 4.7.3.4,  Prev: Section 4.7.3.3,  Up: Section 4.7.3,  Next: Section 4.7.3.5

Section 4.7.3.4: Headings
.........................

\cfg{paper-chapter-top-space}{_points_}

    Specifies the space between the top margin and the top of the
    chapter heading. (Each chapter begins on a new page.)

\cfg{paper-chapter-underline-thickness}{_points_}

    Specifies the vertical thickness of the black rule under chapter
    headings.

\cfg{paper-chapter-underline-depth}{_points_}

    Specifies the distance between the base of the chapter heading and
    the _base_ of the underlying rule.

\cfg{paper-sect-num-left-space}{_points_}

    Specifies the distance between the left margin and the _right_ of
    section numbers (which are in the left margin).


File: halibut.info,  Node: Section 4.7.3.5,  Prev: Section 4.7.3.4,  Up: Section 4.7.3,  Next: Section 4.7.3.6

Section 4.7.3.5: Contents and index
...................................

\cfg{paper-contents-indent-step}{_points_}

    Specifies by how much to indent each entry in the table of
    contents per level of subdivision in the document. (In other
    words, chapter titles appear at the left of the table of contents,
    headings within the chapter are indented by the amount configured
    here, subheadings by twice that, and so on.)

\cfg{paper-contents-margin}{_points_}

    Specifies the amount of space on the right of the table of
    contents which should be reserved for page numbers only. Headings
    in the table of contents which extend into this space will be
    wrapped.

\cfg{paper-leader-separation}{_points_}

    Specifies the horizontal spacing between dots in _leaders_ (the
    dotted lines that appear between section headings and page numbers
    in the table of contents).

\cfg{paper-footer-distance}{_points_}

    Specifies the distance between the bottom margin and the _base_ of
    the footer (which contains page numbers).

\cfg{paper-index-columns}{_columns_}

    Specifies the number of columns the index should be divided into.

\cfg{paper-index-gutter}{_points_}

    Specifies the amount of  horizontal space between index columns.

\cfg{paper-index-minsep}{_points_}

    Specifies the minimum allowable horizontal space between an index
    entry and its page number. If the gap is smaller, the page number
    is moved to the next line.


File: halibut.info,  Node: Section 4.7.3.6,  Prev: Section 4.7.3.5,  Up: Section 4.7.3,  Next: Section 4.7.3.7

Section 4.7.3.6: Fonts
......................

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.

Halibut intrinsically knows about some fonts, and these fonts are also
built into all PDF and most PostScript implementations. These fonts
can be used without further formality. Halibut can also use other
fonts, and can 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 Type 1 font Halibut needs both the font file itself, in
either hexadecimal (PFA) or IBM PC (PFB) format, and an Adobe Font
Metrics (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 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 Unicode mapping
table and a PostScript name.

Fonts are specified using their PostScript names. Running Halibut with
the --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.

Font sizes are specified in PostScript points (72 to the inch).

\cfg{paper-title-fonts}{_normal-font_}[{_emph-font_}[{_code-font_}]]

    Specifies the fonts to use for text in the document title.

\cfg{paper-title-font-size}{_points_}

    Specifies the font size of the document title.

\cfg{paper-chapter-fonts}{_normal-font_}[{_emph-font_}[{_code-font_}]]

    Specifies the fonts to use for text in chapter titles.

\cfg{paper-chapter-font-size}{_points_}

    Specifies the font size of chapter titles.

\cfg{paper-section-fonts}{_level_}{_normal-font_}[{_emph-
font_}[{_code-font_}]]

    Specifies the fonts to use for text in section headings at the
    _level_ specified.

\cfg{paper-section-font-size}{_level_}{_points_}

    Specifies the font size of section headings at the _level_
    specified.

\cfg{paper-base-fonts}{_normal-font_}[{_emph-font_}[{_code-font_}]]

    Specifies the fonts to use for text in the body text.

\cfg{paper-base-font-size}{_points_}

    Specifies the font size of body text.

\cfg{paper-code-fonts}{_bold-font_}[{_italic-font_}[{_normal-font_}]]

    Specifies the fonts to use for text in code paragraphs. The _bold-
    font_ is used for bold text, the _italic-font_ for emphasised
    text, and the _normal-font_ for normal code.

\cfg{paper-code-font-size}{_points_}

    Specifies the font size of text in code paragraphs.

\cfg{paper-pagenum-font-size}{_points_}

    Specifies the font size to use for page numbers.


File: halibut.info,  Node: Section 4.7.3.7,  Prev: Section 4.7.3.6,  Up: Section 4.7.3,  Next: Section 4.7.4

Section 4.7.3.7: Miscellaneous
..............................

\cfg{paper-rule-thickness}{_points_}

    Specifies the vertical thickness of the rule produced by the \rule
    command (see *Note Section 3.3.3::). (Note that no extra space is
    reserved for thicker rules.)


File: halibut.info,  Node: Section 4.7.4,  Prev: Section 4.7.3.7,  Up: Section 4.7,  Next: Section 4.7.5

Section 4.7.4: Configuring the characters used
..............................................

\cfg{paper-bullet}{_text_}[{_text_}...]

    Specifies the text to use as the bullet in bulletted lists. You
    can specify multiple fallback options. Works exactly like the
    \cfg{text-bullet} directive (see *Note Section 4.1.4::).

\cfg{paper-quotes}{_open-quote_}{_close-quote_}[{_open-quote_}{_close-
quote_...}]

    Specifies the quotation marks to use, overriding any
    \cfg{quotes} directive. You can specify multiple fallback
    options. Works exactly like the \cfg{text-quotes} directive (see
    *Note Section 4.1.4::).


File: halibut.info,  Node: Section 4.7.5,  Prev: Section 4.7.4,  Up: Section 4.7,  Next: Appendix A

Section 4.7.5: Default settings for paper formats
.................................................

The default page size corresponds to 210 x 297 mm, i.e., A4 paper.

  \cfg{paper-page-width}{595} 
  \cfg{paper-page-height}{842} 
  
  \cfg{paper-left-margin}{72} 
  \cfg{paper-top-margin}{72} 
  \cfg{paper-right-margin}{72} 
  \cfg{paper-bottom-margin}{108} 
  
  \cfg{paper-base-leading}{1} 
  \cfg{paper-base-para-spacing}{10} 
  
  \cfg{paper-list-indent}{6} 
  \cfg{paper-listitem-indent}{18} 
  \cfg{paper-quote-indent}{18} 
  
  \cfg{paper-chapter-top-space}{72} 
  \cfg{paper-chapter-underline-thickness}{3} 
  \cfg{paper-chapter-underline-depth}{14} 
  \cfg{paper-sect-num-left-space}{12} 
  
  \cfg{paper-contents-indent-step}{24} 
  \cfg{paper-contents-margin}{84} 
  \cfg{paper-leader-separation}{12} 
  \cfg{paper-footer-distance}{32} 
  \cfg{paper-index-columns}{2} 
  \cfg{paper-index-gutter}{36} 
  \cfg{paper-index-minsep}{18} 
  
  \cfg{paper-base-fonts}{Times-Roman}{Times-Italic}{Courier}
  \cfg{paper-base-font-size}{12} 
  \cfg{paper-code-fonts}{Courier-Bold}{Courier-Oblique}{Courier}
  \cfg{paper-code-font-size}{12}
  \cfg{paper-title-fonts}{Helvetica-Bold}
      {Helvetica-BoldOblique}{Courier-Bold}
  \cfg{paper-title-font-size}{24}
  \cfg{paper-chapter-fonts}{Helvetica-Bold}
      {Helvetica-BoldOblique}{Courier-Bold}
  \cfg{paper-chapter-font-size}{20}
  \cfg{paper-section-fonts}{0}{Helvetica-Bold}
      {Helvetica-BoldOblique}{Courier-Bold}
  \cfg{paper-section-font-size}{0}{16}
  \cfg{paper-section-fonts}{1}{Helvetica-Bold}
      {Helvetica-BoldOblique}{Courier-Bold}
  \cfg{paper-section-font-size}{1}{14}
  \cfg{paper-section-fonts}{2}{Helvetica-Bold}
      {Helvetica-BoldOblique}{Courier-Bold}
  \cfg{paper-section-font-size}{2}{13}
  ... and so on for all section levels below this ...
  
  \cfg{paper-pagenum-font-size}{12} 
  
  \cfg{paper-rule-thickness}{1} 
  
  \cfg{paper-bullet}{\u2022}{-}
  \cfg{paper-quotes}{\u2018}{\u2019}{'}{'}


File: halibut.info,  Node: Appendix A,  Prev: Section 4.7.5,  Up: Top,  Next: Appendix B

Appendix A: Halibut Licence
===========================

Halibut is copyright (c) 1999-2021 Simon Tatham.

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Halibut contains font metrics derived from the _Font Metrics for
PDF Core 14 Fonts_, which carry the following copyright notice and
licence:

  Copyright (c) 1985, 1987, 1989, 1990, 1991, 1992, 1993, 1997 Adobe
  Systems Incorporated. All Rights Reserved.

  This file and the 14 PostScript(R) AFM files it accompanies may be
  used, copied, and distributed for any purpose and without charge,
  with or without modification, provided that all copyright notices
  are retained; that the AFM files are not distributed without this
  file; that all modifications to this file or any of the AFM files
  are prominently noted in the modified file(s); and that this
  paragraph is not modified. Adobe Systems has no responsibility or
  obligation to support the use of the AFM files.


File: halibut.info,  Node: Appendix B,  Prev: Appendix A,  Up: Top,  Next: Section B.1

Appendix B: Halibut man page
============================

* Menu:

* Section B.1:: NAME
* Section B.2:: SYNOPSIS
* Section B.3:: DESCRIPTION
* Section B.4:: OPTIONS
* Section B.5:: MORE INFORMATION
* Section B.6:: BUGS

File: halibut.info,  Node: Section B.1,  Prev: Appendix B,  Up: Appendix B,  Next: Section B.2

Section B.1: NAME
-----------------

halibut - multi-format documentation formatting tool


File: halibut.info,  Node: Section B.2,  Prev: Section B.1,  Up: Appendix B,  Next: Section B.3

Section B.2: SYNOPSIS
---------------------

  halibut [options] file1.but [file2.but ...]


File: halibut.info,  Node: Section B.3,  Prev: Section B.2,  Up: Appendix B,  Next: Section B.4

Section B.3: DESCRIPTION
------------------------

`halibut' reads the given set of input files, assembles them into a
document, and outputs that document in one or more formats.

The available command-line options can configure what formats Halibut
should output in, and can also configure other things about the way
Halibut works.


File: halibut.info,  Node: Section B.4,  Prev: Section B.3,  Up: Appendix B,  Next: Section B.5

Section B.4: OPTIONS
--------------------

The command-line options supported by `halibut' are:

--text[=_filename_]

    Makes Halibut generate an output file in plain text format. If the
    optional _filename_ parameter is supplied, the output text file
    will be given that name. Otherwise, the name of the output text
    file will be as specified in the input files, or `output.txt' if
    none is specified at all.

--html[=_filename_]

    Makes Halibut generate one or more output files in HTML format.
    If the optional _filename_ parameter is supplied, there will be
    precisely one HTML output file with that name, containing the
    whole document. Otherwise, there may be one or more than one
    HTML file produced as output; this, and the file names, will be
    as specified in the input files, or given a set of default names
    starting with `Contents.html' if none is specified at all.

--chm[=_filename_]

    Makes Halibut generate an output file in Windows HTML Help format.
    If the optional _filename_ parameter is supplied, the output help
    file will be given that name. Otherwise, the name of the output
    help file will be as specified in the input files, or `output.chm'
    if none is specified at all.

--winhelp[=_filename_]

    Makes Halibut generate an output file in old-style Windows Help
    format. If the optional _filename_ parameter is supplied, the
    output help file will be given that name. Otherwise, the name of
    the output help file will be as specified in the input files, or
    `output.hlp' if none is specified at all.

    The output help file must have a name ending in `.hlp'; if it
    does not, `.hlp' will be added. A secondary contents file will be
    created alongside the main help file, with the same name except
    that it will end in `.cnt' (for example `output.cnt', if the main
    file is `output.hlp').

--man[=_filename_]

    Makes Halibut generate an output file in Unix man page format.
    If the optional _filename_ parameter is supplied, the output man
    page will be given that name. Otherwise, the name of the output
    man page will be as specified in the input files, or `output.1' if
    none is specified at all.

--info[=_filename_]

    Makes Halibut generate an `info' file. If the optional _filename_
    parameter is supplied, the output `info' file will be given
    that name. Otherwise, the name of the output `info' file will
    be as specified in the input files, or `output.info' if none is
    specified at all.

    By default, unless configured otherwise using the \cfg{info-max-
    file-size}{0} directive, the `info' output will be split into
    multiple files. The main file will have the name you specify; the
    subsidiary files will have suffixes `-1', `-2' etc.

--pdf[=_filename_]

    Makes Halibut generate an output file in PDF format. If the
    optional _filename_ parameter is supplied, the PDF output file
    will be given that name. Otherwise, the name of the output PDF
    file will be as specified in the input files, or `output.pdf' if
    none is specified at all.

--ps[=_filename_]

    Makes Halibut generate an output file in PostScript format. If
    the optional _filename_ parameter is supplied, the PostScript
    output file will be given that name. Otherwise, the name of the
    output PostScript file will be as specified in the input files, or
    `output.ps' if none is specified at all.

-C_word_:_word_[:_word_...]

    Adds a configuration directive to the input processed by Halibut.
    Using this directive is exactly equivalent to appending an extra
    input file to the command line which contains the directive
    \cfg{_word_}{_word_}{_word_...}.

--input-charset=_charset_

    Changes the assumed character set for input files from the default
    of ASCII.

--list-charsets

    Makes Halibut list character sets known to it.

--list-fonts

    Makes Halibut list fonts known to it, either intrinsically or by
    being passed as input files.

--precise

    Makes Halibut report the column number as well as the line number
    when it encounters an error in an input file.

--help

    Makes Halibut display a brief summary of its command-line options.

--version

    Makes Halibut report its version number.

--licence

    Makes Halibut display its licence (MIT).


File: halibut.info,  Node: Section B.5,  Prev: Section B.4,  Up: Appendix B,  Next: Section B.6

Section B.5: MORE INFORMATION
-----------------------------

For more information on Halibut, including full details of the input
file format, look in the full manual. If this is not installed locally
on your system, you can also find it at the Halibut web site:

https://www.chiark.greenend.org.uk/~sgtatham/halibut/


File: halibut.info,  Node: Section B.6,  Prev: Section B.5,  Up: Appendix B,  Next: Index

Section B.6: BUGS
-----------------

This man page isn't terribly complete.

