Chapter 4: Halibut output formats

Chapter 4: Halibut output formats

This chapter describes each of Halibut's current output formats. It gives some general information about the format, and also describes all the configuration directives which are specific to that format.

4.1 Plain text

This output format generates the document as a single plain text file. No table of contents or index is generated.

The precise formatting of the text file can be controlled by a variety of configuration directives. They are listed in the following subsections.

4.1.1 Output file name

\cfg{text-filename}{filename}: Sets the output file name in which to store the text file. This directive is implicitly generated if you provide a file name parameter after the command-line option --text (see section 2.1).

4.1.2 Indentation and line width

This section describes the configuration directives which control the horizontal dimensions of the output text file: how much paragraphs are indented by and how long the lines are.

\cfg{text-width}{width}: Sets the width of the main part of the document, in characters. This width will be used for wrapping paragraphs and for centring titles (if you have asked for titles to be centred - see section 4.1.3). This width does not include the left indentation set by \cfg{text-indent}; if you specify an indent of 8 and a width of 64, your maximum output line length will be 72.
\cfg{text-indent}{indent}: Sets the left indentation for the document. If you set this to zero, your document will look like an ordinary text file as someone with a text editor might have written it; if you set it above zero, the text file will have a margin down the left in the style of some printed manuals, and you can then configure the section numbers to appear in this margin (see section 4.1.3).
\cfg{text-indent-code}{indent}: Specifies how many extra characters of indentation (on top of the normal left indent) should be given to code paragraphs.
\cfg{text-list-indent}{indent}: Specifies how many extra spaces should be used to indent the bullet or number in a bulletted or numbered list. The actual body of the list item will be indented by this much plus the value configured by \cfg{text-listitem-indent}.
\cfg{text-listitem-indent}{indent}: Specifies how many extra spaces should be used to indent the body of a list item, over and above the number configured in \cfg{text-list-indent}.
\cfg{text-indent-preamble}{boolean}: When this is set to true, the document preamble (i.e. any paragraphs appearing before the first chapter heading) will be indented to the level specified by \cfg{text-indent}. If this setting is false, the document preamble will not be indented at all from the left margin.

4.1.3 Configuring heading display

The directives in this section allow you to configure the appearance of the title, chapter and section headings in your text file.

Several of the directives listed below specify the alignment of a heading. These alignment options have three possible values:

left: Align the heading to the very left of the text file (column zero).
leftplus: Align the section title to the left of the main display region (in other words, indented to the level specified by \cfg{text-indent}). The section number is placed to the left of that (so that it goes in the margin if there is room).
centre: Centre the heading.

Also, several of the directives below specify how a title should be underlined. The parameter to one of these directives should be either blank ({}) or a piece of text which will be repeated to produce the underline. So you might want to specify, for example, \text-title-underline{=} but \text-chapter-underline{-}.

You can also specify more than one underline setting, and Halibut will choose the first one that the output character set supports. So, for example, you could write \text-chapter-underline{\u203e}{-}, and Halibut would use the Unicode ‘OVERLINE’ character where possible and fall back to the ASCII minus sign otherwise.

\cfg{text-title-align}{alignment}: Specifies the alignment of the overall document title: left, leftplus or centre.
\cfg{text-title-underline}{underline-text}: Specifies how the overall document title should be underlined.
\cfg{text-chapter-align}{alignment}: Specifies the alignment of chapter and appendix headings.
\cfg{text-chapter-underline}{underline-text}: Specifies how chapter and appendix headings should be underlined.
\cfg{text-chapter-numeric}{boolean}: If this is set to true, then chapter headings will not contain the word ‘Chapter’ (or whatever other word you have defined in its place - see section 3.3.5 and section 3.6); they will just contain the chapter number, followed by the chapter title. If you set this to false, chapter headings will be prefixed by ‘Chapter’ or equivalent.
\cfg{text-chapter-suffix}{text}: This specifies the suffix text to be appended to the chapter number, before displaying the chapter title. For example, if you set this to ‘: ’, then the chapter title might look something like ‘Chapter 2: Doing Things’.
\cfg{text-section-align}{level}{alignment}: Specifies the alignment of 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. The alignment parameter is treated just like the other alignment directives listed above.
\cfg{text-section-underline}{level}{underline-text}: Specifies how to underline section headings at a particular level.
\cfg{text-section-numeric}{level}{boolean}: Specifies whether section headings at a particular level should contain the word ‘Section’ or equivalent (if false), or should be numeric only (if true).
\cfg{text-section-suffix}{level}{text}: Specifies the suffix text to be appended to section numbers at a particular level, before displaying the section title.

4.1.4 Configuring the characters used

\cfg{text-charset}{character set name}: This tells Halibut what character set the output should be in. Any Unicode characters representable in this set will be output verbatim; any other characters will not be output and their fallback text (if any) will be used instead.
The character set names are the same as for \cfg{input-charset} (see section 3.6). However, unlike \cfg{input-charset}, this directive affects the entire output; it's not possible to switch encodings halfway through.
\cfg{text-bullet}{text}[{text...}]: This specifies the text which should be used as the bullet in bulletted lists. It can be one character (\cfg{text-bullet}{-}), or more than one (\cfg{text-bullet}{(*)}).
Like \cfg{quotes} (see section 3.6), you can is tells 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.
--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).

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:

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

B.6 BUGS

This man page isn't terribly complete.

Comments to anakin@pobox.com
[$Id: blurb.but 7047 2007-01-01 15:40:57Z ben $]
[$Id: intro.but 6991 2006-12-11 19:43:10Z simon $]
[$Id: running.but 6991 2006-12-11 19:43:10Z simon $]
[$Id: input.but 7178 2007-01-28 18:42:50Z jacob $]
[$Id: output.but 7188 2007-01-31 22:23:09Z jacob $]
[$Id: licence.but 7047 2007-01-01 15:40:57Z ben $]
[$Id: manpage.but 6992 2006-12-11 23:28:51Z ben $]
[$Id: index.but 7177 2007-01-28 17:16:48Z jacob $]

./usr/share/doc/halibut/html/output.html0000644000000000000000000024721610716543760017240 0ustar rootroot Halibut output formats

Previous | Contents | Index | Next

Chapter 4: Halibut output formats

Chapter 4: Halibut output formats

4.1 Plain text

This output format generates the document as a single plain text file. No table of contents or index is generated.

The precise formatting of the text file can be controlled by a variety of configuration directives. They are listed in the following subsections.

4.1.1 Output file name

\cfg{text-filename}{filename}: Sets the output file name in which to store the text file. This directive is implicitly generated if you provide a file name parameter after the command-line option --text (see section 2.1).

4.1.2 Indentation and line width

This section describes the configuration directives which control the horizontal dimensions of the output text file: how much paragraphs are indented by and how long the lines are.

\cfg{text-width}{width}: Sets the width of the main part of the document, in characters. This width will be used for wrapping paragraphs and for centring titles (if you have asked for titles to be centred - see section 4.1.3). This width does not include the left indentation set by \cfg{text-indent}; if you specify an indent of 8 and a width of 64, your maximum output line length will be 72.
\cfg{text-indent}{indent}: Sets the left indentation for the document. If you set this to zero, your document will look like an ordinary text file as someone with a text editor might have written it; if you set it above zero, the text file will have a margin down the left in the style of some printed manuals, and you can then configure the section numbers to appear in this margin (see section 4.1.3).
\cfg{text-indent-code}{indent}: Specifies how many extra characters of indentation (on top of the normal left indent) should be given to code paragraphs.
\cfg{text-list-indent}{indent}: Specifies how many extra spaces should be used to indent the bullet or number in a bulletted or numbered list. The actual body of the list item will be indented by this much plus the value configured by \cfg{text-listitem-indent}.
\cfg{text-listitem-indent}{indent}: Specifies how many extra spaces should be used to indent the body of a list item, over and above the number configured in \cfg{text-list-indent}.
\cfg{text-indent-preamble}{boolean}: When this is set to true, the document preamble (i.e. any paragraphs appearing before the first chapter heading) will be indented to the level specified by \cfg{text-indent}. If this setting is false, the document preamble will not be indented at all from the left margin.

4.1.3 Configuring heading display

The directives in this section allow you to configure the appearance of the title, chapter and section headings in your text file.

Several of the directives listed below specify the alignment of a heading. These alignment options have three possible values:

left: Align the heading to the very left of the text file (column zero).
leftplus: Align the section title to the left of the main display region (in other words, indented to the level specified by \cfg{text-indent}). The section number is placed to the left of that (so that it goes in the margin if there is room).
centre: Centre the heading.

\cfg{text-title-align}{alignment}: Specifies the alignment of the overall document title: left, leftplus or centre.
\cfg{text-title-underline}{underline-text}: Specifies how the overall document title should be underlined.
\cfg{text-chapter-align}{alignment}: Specifies the alignment of chapter and appendix headings.
\cfg{text-chapter-underline}{underline-text}: Specifies how chapter and appendix headings should be underlined.
\cfg{text-chapter-numeric}{boolean}: If this is set to true, then chapter headings will not contain the word ‘Chapter’ (or whatever other word you have defined in its place - see section 3.3.5 and section 3.6); they will just contain the chapter number, followed by the chapter title. If you set this to false, chapter headings will be prefixed by ‘Chapter’ or equivalent.
\cfg{text-chapter-suffix}{text}: This specifies the suffix text to be appended to the chapter number, before displaying the chapter title. For example, if you set this to ‘: ’, then the chapter title might look something like ‘Chapter 2: Doing Things’.
\cfg{text-section-align}{level}{alignment}: Specifies the alignment of 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. The alignment parameter is treated just like the other alignment directives listed above.
\cfg{text-section-underline}{level}{underline-text}: Specifies how to underline section headings at a particular level.
\cfg{text-section-numeric}{level}{boolean}: Specifies whether section headings at a particular level should contain the word ‘Section’ or equivalent (if false), or should be numeric only (if true).
\cfg{text-section-suffix}{level}{text}: Specifies the suffix text to be appended to section numbers at a particular level, before displaying the section title.

4.1.4 Configuring the characters used

\cfg{text-charset}{character set name}: This tells Halibut what character set the output should be in. Any Unicode characters representable in this set will be output verbatim; any other characters will not be output and their fallback text (if any) will be used instead.
The character set names are the same as for \cfg{input-charset} (see section 3.6). However, unlike \cfg{input-charset}, this directive affects the entire output; it's not possible to switch encodings halfway through.
\cfg{text-bullet}{text}[{text...}]: This specifies the text which should be used as the bullet in bulletted lists. It can be one character (\cfg{text-bullet}{-}), or more than one (\cfg{text-bullet}{(*)}).
Like \cfg{quotes} (see section 3.6), you can is tells 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.
--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).

B.5 MORE INFORMATION

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

B.6 BUGS

This man page isn't terribly complete.

./usr/share/doc/halibut/html/output.html0000644000000000000000000024721610716543760017240 0ustar rootroot Halibut output formats

Previous | Contents | Index | Next

Chapter 4: Halibut output formats

Chapter 4: Halibut output formats

4.1 Plain text

This output format generates the document as a single plain text file. No table of contents or index is generated.

The precise formatting of the text file can be controlled by a variety of configuration directives. They are listed in the following subsections.

4.1.1 Output file name

\cfg{text-filename}{filename}: Sets the output file name in which to store the text file. This directive is implicitly generated if you provide a file name parameter after the command-line option --text (see section 2.1).

4.1.2 Indentation and line width

This section describes the configuration directives which control the horizontal dimensions of the output text file: how much paragraphs are indented by and how long the lines are.

\cfg{text-width}{width}: Sets the width of the main part of the document, in characters. This width will be used for wrapping paragraphs and for centring titles (if you have asked for titles to be centred - see section 4.1.3). This width does not include the left indentation set by \cfg{text-indent}; if you specify an indent of 8 and a width of 64, your maximum output line length will be 72.
\cfg{text-indent}{indent}: Sets the left indentation for the document. If you set this to zero, your document will look like an ordinary text file as someone with a text editor might have written it; if you set it above zero, the text file will have a margin down the left in the style of some printed manuals, and you can then configure the section numbers to appear in this margin (see section 4.1.3).
\cfg{text-indent-code}{indent}: Specifies how many extra characters of indentation (on top of the normal left indent) should be given to code paragraphs.
\cfg{text-list-indent}{indent}: Specifies how many extra spaces should be used to indent the bullet or number in a bulletted or numbered list. The actual body of the list item will be indented by this much plus the value configured by \cfg{text-listitem-indent}.
\cfg{text-listitem-indent}{indent}: Specifies how many extra spaces should be used to indent the body of a list item, over and above the number configured in \cfg{text-list-indent}.
\cfg{text-indent-preamble}{boolean}: When this is set to true, the document preamble (i.e. any paragraphs appearing before the first chapter heading) will be indented to the level specified by \cfg{text-indent}. If this setting is false, the document preamble will not be indented at all from the left margin.

4.1.3 Configuring heading display

The directives in this section allow you to configure the appearance of the title, chapter and section headings in your text file.

Several of the directives listed below specify the alignment of a heading. These alignment options have three possible values:

left: Align the heading to the very left of the text file (column zero).
leftplus: Align the section title to the left of the main display region (in other words, indented to the level specified by \cfg{text-indent}). The section number is placed to the left of that (so that it goes in the margin if there is room).
centre: Centre the heading.

\cfg{text-title-align}{alignment}: Specifies the alignment of the overall document title: left, leftplus or centre.
\cfg{text-title-underline}{underline-text}: Specifies how the overall document title should be underlined.
\cfg{text-chapter-align}{alignment}: Specifies the alignment of chapter and appendix headings.
\cfg{text-chapter-underline}{underline-text}: Specifies how chapter and appendix headings should be underlined.
\cfg{text-chapter-numeric}{boolean}: If this is set to true, then chapter headings will not contain the word ‘Chapter’ (or whatever other word you have defined in its place - see section 3.3.5 and section 3.6); they will just contain the chapter number, followed by the chapter title. If you set this to false, chapter headings will be prefixed by ‘Chapter’ or equivalent.
\cfg{text-chapter-suffix}{text}: This specifies the suffix text to be appended to the chapter number, before displaying the chapter title. For example, if you set this to ‘: ’, then the chapter title might look something like ‘Chapter 2: Doing Things’.
\cfg{text-section-align}{level}{alignment}: Specifies the alignment of 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. The alignment parameter is treated just like the other alignment directives listed above.
\cfg{text-section-underline}{level}{underline-text}: Specifies how to underline section headings at a particular level.
\cfg{text-section-numeric}{level}{boolean}: Specifies whether section headings at a particular level should contain the word ‘Section’ or equivalent (if false), or should be numeric only (if true).
\cfg{text-section-suffix}{level}{text}: Specifies the suffix text to be appended to section numbers at a particular level, before displaying the section title.

4.1.4 Configuring the characters used

\cfg{text-charset}{character set name}: This tells Halibut what character set the output should be in. Any Unicode characters representable in this set will be output verbatim; any other characters will not be output and their fallback text (if any) will be used instead.
The character set names are the same as for \cfg{input-charset} (see section 3.6). However, unlike \cfg{input-charset}, this directive affects the entire output; it's not possible to switch encodings halfway through.
\cfg{text-bullet}{text}[{text...}]: This specifies the text which should be used as the bullet in bulletted lists. It can be one character (\cfg{text-bullet}{-}), or more than one (\cfg{text-bullet}{(*)}).
Like \cfg{quotes} (see section 3.6), you can is tells 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.
--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).

B.5 MORE INFORMATION

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

B.6 BUGS

This man page isn't terribly complete.

./usr/share/doc/halibut/html/output.html0000644000000000000000000024721610716543760017240 0ustar rootroot Halibut output formats

Previous | Contents | Index | Next

Chapter 4: Halibut output formats

Chapter 4: Halibut output formats

4.1 Plain text

This output format generates the document as a single plain text file. No table of contents or index is generated.

The precise formatting of the text file can be controlled by a variety of configuration directives. They are listed in the following subsections.

4.1.1 Output file name

\cfg{text-filename}{filename}: Sets the output file name in which to store the text file. This directive is implicitly generated if you provide a file name parameter after the command-line option --text (see section 2.1).

4.1.2 Indentation and line width

This section describes the configuration directives which control the horizontal dimensions of the output text file: how much paragraphs are indented by and how long the lines are.

\cfg{text-width}{width}: Sets the width of the main part of the document, in characters. This width will be used for wrapping paragraphs and for centring titles (if you have asked for titles to be centred - see section 4.1.3). This width does not include the left indentation set by \cfg{text-indent}; if you specify an indent of 8 and a width of 64, your maximum output line length will be 72.
\cfg{text-indent}{indent}: Sets the left indentation for the document. If you set this to zero, your document will look like an ordinary text file as someone with a text editor might have written it; if you set it above zero, the text file will have a margin down the left in the style of some printed manuals, and you can then configure the section numbers to appear in this margin (see section 4.1.3).
\cfg{text-indent-code}{indent}: Specifies how many extra characters of indentation (on top of the normal left indent) should be given to code paragraphs.
\cfg{text-list-indent}{indent}: Specifies how many extra spaces should be used to indent the bullet or number in a bulletted or numbered list. The actual body of the list item will be indented by this much plus the value configured by \cfg{text-listitem-indent}.
\cfg{text-listitem-indent}{indent}: Specifies how many extra spaces should be used to indent the body of a list item, over and above the number configured in \cfg{text-list-indent}.
\cfg{text-indent-preamble}{boolean}: When this is set to true, the document preamble (i.e. any paragraphs appearing before the first chapter heading) will be indented to the level specified by \cfg{text-indent}. If this setting is false, the document preamble will not be indented at all from the left margin.

4.1.3 Configuring heading display

The directives in this section allow you to configure the appearance of the title, chapter and section headings in your text file.

Several of the directives listed below specify the alignment of a heading. These alignment options have three possible values:

left: Align the heading to the very left of the text file (column zero).
leftplus: Align the section title to the left of the main display region (in other words, indented to the level specified by \cfg{text-indent}). The section number is placed to the left of that (so that it goes in the margin if there is room).
centre: Centre the heading.

\cfg{text-title-align}{alignment}: Specifies the alignment of the overall document title: left, leftplus or centre.
\cfg{text-title-underline}{underline-text}: Specifies how the overall document title should be underlined.
\cfg{text-chapter-align}{alignment}: Specifies the alignment of chapter and appendix headings.
\cfg{text-chapter-underline}{underline-text}: Specifies how chapter and appendix headings should be underlined.
\cfg{text-chapter-numeric}{boolean}: If this is set to true, then chapter headings will not contain the word ‘Chapter’ (or whatever other word you have defined in its place - see section 3.3.5 and section 3.6); they will just contain the chapter number, followed by the chapter title. If you set this to false, chapter headings will be prefixed by ‘Chapter’ or equivalent.
\cfg{text-chapter-suffix}{text}: This specifies the suffix text to be appended to the chapter number, before displaying the chapter title. For example, if you set this to ‘: ’, then the chapter title might look something like ‘Chapter 2: Doing Things’.
\cfg{text-section-align}{level}{alignment}: Specifies the alignment of 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. The alignment parameter is treated just like the other alignment directives listed above.
\cfg{text-section-underline}{level}{underline-text}: Specifies how to underline section headings at a particular level.
\cfg{text-section-numeric}{level}{boolean}: Specifies whether section headings at a particular level should contain the word ‘Section’ or equivalent (if false), or should be numeric only (if true).
\cfg{text-section-suffix}{level}{text}: Specifies the suffix text to be appended to section numbers at a particular level, before displaying the section title.

4.1.4 Configuring the characters used

\cfg{text-charset}{character set name}: This tells Halibut what character set the output should be in. Any Unicode characters representable in this set will be output verbatim; any other characters will not be output and their fallback text (if any) will be used instead.
The character set names are the same as for \cfg{input-charset} (see section 3.6). However, unlike \cfg{input-charset}, this directive affects the entire output; it's not possible to switch encodings halfway through.
\cfg{text-bullet}{text}[{text...}]: This specifies the text which should be used as the bullet in bulletted lists. It can be one character (\cfg{text-bullet}{-}), or more than one (\cfg{text-bullet}{(*)}).
Like \cfg{quotes} (see section 3.6), you can is tells 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.
--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).

B.5 MORE INFORMATION

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

B.6 BUGS

This man page isn't terribly complete.

./usr/share/doc/halibut/html/output.html0000644000000000000000000024721610716543760017240 0ustar rootroot Halibut output formats

Previous | Contents | Index | Next

Chapter 4: Halibut output formats

Chapter 4: Halibut output formats

4.1 Plain text

This output format generates the document as a single plain text file. No table of contents or index is generated.

The precise formatting of the text file can be controlled by a variety of configuration directives. They are listed in the following subsections.

4.1.1 Output file name

\cfg{text-filename}{filename}: Sets the output file name in which to store the text file. This directive is implicitly generated if you provide a file name parameter after the command-line option --text (see section 2.1).

4.1.2 Indentation and line width

This section describes the configuration directives which control the horizontal dimensions of the output text file: how much paragraphs are indented by and how long the lines are.

\cfg{text-width}{width}: Sets the width of the main part of the document, in characters. This width will be used for wrapping paragraphs and for centring titles (if you have asked for titles to be centred - see section 4.1.3). This width does not include the left indentation set by \cfg{text-indent}; if you specify an indent of 8 and a width of 64, your maximum output line length will be 72.
\cfg{text-indent}{indent}: Sets the left indentation for the document. If you set this to zero, your document will look like an ordinary text file as someone with a text editor might have written it; if you set it above zero, the text file will have a margin down the left in the style of some printed manuals, and you can then configure the section numbers to appear in this margin (see section 4.1.3).
\cfg{text-indent-code}{indent}: Specifies how many extra characters of indentation (on top of the normal left indent) should be given to code paragraphs.
\cfg{text-list-indent}{indent}: Specifies how many extra spaces should be used to indent the bullet or number in a bulletted or numbered list. The actual body of the list item will be indented by this much plus the value configured by \cfg{text-listitem-indent}.
\cfg{text-listitem-indent}{indent}: Specifies how many extra spaces should be used to indent the body of a list item, over and above the number configured in \cfg{text-list-indent}.
\cfg{text-indent-preamble}{boolean}: When this is set to true, the document preamble (i.e. any paragraphs appearing before the first chapter heading) will be indented to the level specified by \cfg{text-indent}. If this setting is false, the document preamble will not be indented at all from the left margin.

4.1.3 Configuring heading display

The directives in this section allow you to configure the appearance of the title, chapter and section headings in your text file.

Several of the directives listed below specify the alignment of a heading. These alignment options have three possible values:

left: Align the heading to the very left of the text file (column zero).
leftplus: Align the section title to the left of the main display region (in other words, indented to the level specified by \cfg{text-indent}). The section number is placed to the left of that (so that it goes in the margin if there is room).
centre: Centre the heading.

\cfg{text-title-align}{alignment}: Specifies the alignment of the overall document title: left, leftplus or centre.
\cfg{text-title-underline}{underline-text}: Specifies how the overall document title should be underlined.
\cfg{text-chapter-align}{alignment}: Specifies the alignment of chapter and appendix headings.
\cfg{text-chapter-underline}{underline-text}: Specifies how chapter and appendix headings should be underlined.
\cfg{text-chapter-numeric}{boolean}: If this is set to true, then chapter headings will not contain the word ‘Chapter’ (or whatever other word you have defined in its place - see section 3.3.5 and section 3.6); they will just contain the chapter number, followed by the chapter title. If you set this to false, chapter headings will be prefixed by ‘Chapter’ or equivalent.
\cfg{text-chapter-suffix}{text}: This specifies the suffix text to be appended to the chapter number, before displaying the chapter title. For example, if you set this to ‘: ’, then the chapter title might look something like ‘Chapter 2: Doing Things’.
\cfg{text-section-align}{level}{alignment}: Specifies the alignment of 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. The alignment parameter is treated just like the other alignment directives listed above.
\cfg{text-section-underline}{level}{underline-text}: Specifies how to underline section headings at a particular level.
\cfg{text-section-numeric}{level}{boolean}: Specifies whether section headings at a particular level should contain the word ‘Section’ or equivalent (if false), or should be numeric only (if true).
\cfg{text-section-suffix}{level}{text}: Specifies the suffix text to be appended to section numbers at a particular level, before displaying the section title.

4.1.4 Configuring the characters used

\cfg{text-charset}{character set name}: This tells Halibut what character set the output should be in. Any Unicode characters representable in this set will be output verbatim; any other characters will not be output and their fallback text (if any) will be used instead.
The character set names are the same as for \cfg{input-charset} (see section 3.6). However, unlike \cfg{input-charset}, this directive affects the entire output; it's not possible to switch encodings halfway through.
\cfg{text-bullet}{text}[{text...}]: This specifies the text which should be used as the bullet in bulletted lists. It can be one character (\cfg{text-bullet}{-}), or more than one (\cfg{text-bullet}{(*)}).
Like \cfg{quotes} (see section 3.6), you can is tells 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.
--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).

B.5 MORE INFORMATION

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

B.6 BUGS

This man page isn't terribly complete.

./usr/share/doc/halibut/html/output.html0000644000000000000000000024721610716543760017240 0ustar rootroot Halibut output formats

Previous | Contents | Index | Next