tcl-quill 0.3.0: Quill Project Automation System for Tcl/Tk

manpage(n): Man Page Processor -- quill(n)

SYNOPSIS
DESCRIPTION
Man Page Directories
COMMANDS
MACROS
AUTHOR
SEE ALSO

SYNOPSIS

package require quill 0.3.0
namespace import ::quill::*
manpage eval args...
manpage expand text
manpage lb
manpage rb
manpage format indir ?options?
manpage mansec num title

DESCRIPTION

The manpage(n) module provides formatting for software man pages written in manpage(5) format. manpage(5) is an HTML-like format in which the "tags" are macro(n) macros. manpage(n) formats the man pages nicely, adds tables of contents, links, and so forth.

At present, manpage(n) produces HTML output only; however, there is no reason why it could not be provided with multiple back-ends, each supporting a different output format.

Man Page Directories

manpage(n) assumes the same kind of manpage naming as Unix man pages, and supports the following man page sections:

manpage(n) assumes that the formatted man pages will end up in sibling directories, all named according to the pattern "mannum", e.g., "man1", "mann". This allows manpage(n) to build links from man pages in one section to man pages in another section.

COMMANDS

manpage(n) defines the following commands:

manpage eval args...
manpage expand text
manpage lb
manpage rb
These commands are all delegated to the object's internal instance of macro(n). eval and expand are primarily useful for debugging.

manpage format indir ?options?
Formats all "*.manpage" files found in directory indir, which is assumed to be named according to the usual naming convention; see Man Page Directories. Each input page produces a matching ".html" file; in addition, manpage(n) produces an "index.html" file that provides an index for the entire directory.

The following options may be used:

-header text
Specifies the text for the man page header. This text should usually identify the project name and version.

-version version
Specifies the project version number. It can be accessed using the version macro.

-outdir dirname
By default, the output files are written to the directory containing the input files. If this option is given, the output is written to the specified directory.

manpage mansec num title
Defines an additional man page section with number num and the given title. For example,
manpage mansec 3 "C Libraries"
Defines a man page section for C library man pages.

MACROS

The macros used to write man pages are defined in the manpage(5) man page.

AUTHOR

Will Duquette

SEE ALSO

quill(n), manpage(5), macro(n).
Generated from manpage.manpage on Sat Nov 08 09:29:59 PST 2014