Previous | Contents | Index | Next

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> Halibut man page

Previous | Contents | Index | Next

Appendix B: Halibut man page

B.1 NAME

halibut - multi-format documentation formatting tool

B.2 SYNOPSIS

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

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.

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.
--winhelp[=filename]
Makes Halibut generate an output file in 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.

--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.
--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.
-Cword: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.

The HTML output isn't very good.

Unicode handling is atrocious.

Comments to anakin@pobox.com
[$Id: blurb.but 5454 2005-03-07 20:08:55Z jacob $]
[$Id: intro.but 5338 2005-02-17 22:20:32Z jacob $]
[$Id: running.but 5346 2005-02-18 20:23:58Z jacob $]
[$Id: input.but 5341 2005-02-18 13:17:28Z jacob $]
[$Id: output.but 5457 2005-03-08 01:55:34Z jacob $]
[$Id: licence.but 5337 2005-02-17 22:16:51Z jacob $]
[$Id: manpage.but 5341 2005-02-18 13:17:28Z jacob $]
[$Id: index.but 5349 2005-02-18 20:40:49Z jacob $]
./usr/share/doc/halibut/html/output.html0000644000000000000000000021547210275435553017237 0ustar rootroot Halibut output formats

Previous | Contents | Index | Next

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> Halibut man page

Previous | Contents | Index | Next

Appendix B: Halibut man page

B.1 NAME

halibut - multi-format documentation formatting tool

B.2 SYNOPSIS

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

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.

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.
--winhelp[=filename]
Makes Halibut generate an output file in 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.

--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.
--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.
-Cword: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.

The HTML output isn't very good.

Unicode handling is atrocious.

Comments to anakin@pobox.com
[$Id: blurb.but 5454 2005-03-07 20:08:55Z jacob $]
[$Id: intro.but 5338 2005-02-17 22:20:32Z jacob $]
[$Id: running.but 5346 2005-02-18 20:23:58Z jacob $]
[$Id: input.but 5341 2005-02-18 13:17:28Z jacob $]
[$Id: output.but 5457 2005-03-08 01:55:34Z jacob $]
[$Id: licence.but 5337 2005-02-17 22:16:51Z jacob $]
[$Id: manpage.but 5341 2005-02-18 13:17:28Z jacob $]
[$Id: index.but 5349 2005-02-18 20:40:49Z jacob $]
./usr/share/doc/halibut/html/output.html0000644000000000000000000021547210275435553017237 0ustar rootroot Halibut output formats

Previous | Contents | Index | Next

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> Halibut man page

Previous | Contents | Index | Next

Appendix B: Halibut man page

B.1 NAME

halibut - multi-format documentation formatting tool

B.2 SYNOPSIS

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

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.

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.
--winhelp[=filename]
Makes Halibut generate an output file in 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.

--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.
--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.
-Cword: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.

The HTML output isn't very good.

Unicode handling is atrocious.

Comments to anakin@pobox.com
[$Id: blurb.but 5454 2005-03-07 20:08:55Z jacob $]
[$Id: intro.but 5338 2005-02-17 22:20:32Z jacob $]
[$Id: running.but 5346 2005-02-18 20:23:58Z jacob $]
[$Id: input.but 5341 2005-02-18 13:17:28Z jacob $]
[$Id: output.but 5457 2005-03-08 01:55:34Z jacob $]
[$Id: licence.but 5337 2005-02-17 22:16:51Z jacob $]
[$Id: manpage.but 5341 2005-02-18 13:17:28Z jacob $]
[$Id: index.but 5349 2005-02-18 20:40:49Z jacob $]
./usr/share/doc/halibut/html/output.html0000644000000000000000000021547210275435553017237 0ustar rootroot Halibut output formats

Previous | Contents | Index | Next

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> Halibut man page

Previous | Contents | Index | Next

Appendix B: Halibut man page

B.1 NAME

halibut - multi-format documentation formatting tool

B.2 SYNOPSIS

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

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.

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.
--winhelp[=filename]
Makes Halibut generate an output file in 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.

--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.
--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.
-Cword: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.

The HTML output isn't very good.

Unicode handling is atrocious.

Comments to anakin@pobox.com
[$Id: blurb.but 5454 2005-03-07 20:08:55Z jacob $]
[$Id: intro.but 5338 2005-02-17 22:20:32Z jacob $]
[$Id: running.but 5346 2005-02-18 20:23:58Z jacob $]
[$Id: input.but 5341 2005-02-18 13:17:28Z jacob $]
[$Id: output.but 5457 2005-03-08 01:55:34Z jacob $]
[$Id: licence.but 5337 2005-02-17 22:16:51Z jacob $]
[$Id: manpage.but 5341 2005-02-18 13:17:28Z jacob $]
[$Id: index.but 5349 2005-02-18 20:40:49Z jacob $]
./usr/share/doc/halibut/html/output.html0000644000000000000000000021547210275435553017237 0ustar rootroot Halibut output formats

Previous | Contents | Index | Next

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>