docutils.writers.manpage

module documentation
(source)

Simple man page writer for reStructuredText.

Man pages (short for "manual pages") contain system documentation on unix-like systems. The pages are grouped in numbered sections:

1 executable programs and shell commands 2 system calls 3 library functions 4 special files 5 file formats 6 games 7 miscellaneous 8 system administration

Man pages are written troff, a text file formatting system.

See http://www.tldp.org/HOWTO/Man-Page for a start.

Man pages have no subsection only parts. Standard parts

NAME , SYNOPSIS , DESCRIPTION , OPTIONS , FILES , SEE ALSO , BUGS ,

and

AUTHOR .

A unix-like system keeps an index of the DESCRIPTIONs, which is accessible by the command whatis or apropos.

Class Table No class docstring; 0/4 instance variable, 3/6 methods documented
Class Translator No summary
Class Writer No class docstring; 1/2 instance variable, 1/1 class variable, 0/2 method documented
Constant BLOCKQOUTE_INDENT Undocumented
Constant DEFINITION_LIST_INDENT Undocumented
Constant FIELD_LIST_INDENT Undocumented
Constant LITERAL_BLOCK_INDENT Undocumented
Constant MACRO_DEF Undocumented
Constant OPTION_LIST_INDENT Undocumented
BLOCKQOUTE_INDENT: float = (source)

Undocumented

Value
3.5
DEFINITION_LIST_INDENT: int = (source)

Undocumented

Value
7
FIELD_LIST_INDENT: int = (source)

Undocumented

Value
7
LITERAL_BLOCK_INDENT: float = (source)

Undocumented

Value
3.5
MACRO_DEF: str = (source)

Undocumented

Value
'''.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\\\$1 \\\\n[an-margin]
level \\\\n[rst2man-indent-level]
level margin: \\\\n[rst2man-indent\\\\n[rst2man-indent-level]]
...
OPTION_LIST_INDENT: int = (source)

Undocumented

Value
7