docutils.writers.manpage module

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 Writer

Bases: Writer

supported = ('manpage',)

Formats this writer supports.

output = None

Final translated form of document.

translate()

Do final translation of self.document into self.output. Called from write. Override in subclasses.

Usually done with a docutils.nodes.NodeVisitor subclass, in combination with a call to docutils.nodes.Node.walk() or docutils.nodes.Node.walkabout(). The NodeVisitor subclass must support all standard elements (listed in docutils.nodes.node_class_names) and possibly non-standard elements used by the current Reader as well.

class Table

Bases: object

new_row()

append_separator(separator)

Append the separator for table head.

append_cell(cell_lines)

cell_lines is an array of lines

_minimize_cell(cell_lines)

Remove leading and trailing blank and .sp lines

as_list()

class Translator(document)

Bases: NodeVisitor

words_and_spaces = re.compile('\\S+| +|\\n')

possibly_a_roff_command = re.compile('\\.\\w')

document_start = 'Man page generated from reStructuredText.'

comment_begin(text)

Return commented version of the passed text WITHOUT end of line/comment.

comment(text)

Return commented version of the passed text.

ensure_eol()

Ensure the last line in body is terminated by new line.

astext()

Return the final formatted document as a string.

deunicode(text)

visit_Text(node)

depart_Text(node)

list_start(node)

list_end()

header()

append_header()

append header with .TH and .SH NAME

visit_address(node)

depart_address(node)

visit_admonition(node, name=None)

depart_admonition(node)

visit_attention(node)

depart_attention(node)

visit_docinfo_item(node, name)

depart_docinfo_item(node)

visit_author(node)

depart_author(node)

visit_authors(node)

depart_authors(node)

visit_block_quote(node)

depart_block_quote(node)

visit_bullet_list(node)

depart_bullet_list(node)

visit_caption(node)

depart_caption(node)

visit_caution(node)

depart_caution(node)

visit_citation(node)

depart_citation(node)

visit_citation_reference(node)

visit_classifier(node)

depart_classifier(node)

visit_colspec(node)

depart_colspec(node)

write_colspecs()

visit_comment(node, sub=<built-in method sub of re.Pattern object>)

visit_contact(node)

depart_contact(node)

visit_container(node)

depart_container(node)

visit_compound(node)

depart_compound(node)

visit_copyright(node)

visit_danger(node)

depart_danger(node)

visit_date(node)

visit_decoration(node)

depart_decoration(node)

visit_definition(node)

depart_definition(node)

visit_definition_list(node)

depart_definition_list(node)

visit_definition_list_item(node)

depart_definition_list_item(node)

visit_description(node)

depart_description(node)

visit_docinfo(node)

depart_docinfo(node)

visit_doctest_block(node)

depart_doctest_block(node)

visit_document(node)

depart_document(node)

visit_emphasis(node)

depart_emphasis(node)

visit_entry(node)

depart_entry(node)

visit_enumerated_list(node)

depart_enumerated_list(node)

visit_error(node)

depart_error(node)

visit_field(node)

depart_field(node)

visit_field_body(node)

depart_field_body(node)

visit_field_list(node)

depart_field_list(node)

visit_field_name(node)

depart_field_name(node)

visit_figure(node)

depart_figure(node)

visit_footer(node)

depart_footer(node)

visit_footnote(node)

depart_footnote(node)

footnote_backrefs(node)

visit_footnote_reference(node)

depart_footnote_reference(node)

visit_generated(node)

depart_generated(node)

visit_header(node)

depart_header(node)

visit_hint(node)

depart_hint(node)

visit_subscript(node)

depart_subscript(node)

visit_superscript(node)

depart_superscript(node)

visit_attribution(node)

depart_attribution(node)

visit_image(node)

visit_important(node)

depart_important(node)

visit_inline(node)

depart_inline(node)

visit_label(node)

depart_label(node)

visit_legend(node)

depart_legend(node)

visit_line_block(node)

depart_line_block(node)

visit_line(node)

depart_line(node)

visit_list_item(node)

depart_list_item(node)

visit_literal(node)

depart_literal(node)

visit_literal_block(node)

depart_literal_block(node)

visit_math(node)

depart_math(node)

visit_math_block(node)

depart_math_block(node)

visit_note(node)

depart_note(node)

indent(by=0.5)

dedent()

visit_option_list(node)

depart_option_list(node)

visit_option_list_item(node)

depart_option_list_item(node)

visit_option_group(node)

depart_option_group(node)

visit_option(node)

depart_option(node)

visit_option_string(node)

depart_option_string(node)

visit_option_argument(node)

depart_option_argument(node)

visit_organization(node)

depart_organization(node)

first_child(node)

visit_paragraph(node)

depart_paragraph(node)

visit_problematic(node)

depart_problematic(node)

visit_raw(node)

visit_reference(node)

E.g. link or email address.

depart_reference(node)

visit_revision(node)

depart_revision(node)

visit_row(node)

depart_row(node)

visit_section(node)

depart_section(node)

visit_status(node)

depart_status(node)

visit_strong(node)

depart_strong(node)

visit_substitution_definition(node)

Internal only.

visit_substitution_reference(node)

visit_subtitle(node)

depart_subtitle(node)

visit_system_message(node)

depart_system_message(node)

visit_table(node)

depart_table(node)

visit_target(node)

visit_tbody(node)

depart_tbody(node)

visit_term(node)

depart_term(node)

visit_tgroup(node)

depart_tgroup(node)

visit_thead(node)

depart_thead(node)

visit_tip(node)

depart_tip(node)

visit_title(node)

depart_title(node)

visit_title_reference(node)

inline citation reference

depart_title_reference(node)

visit_topic(node)

depart_topic(node)

visit_sidebar(node)

depart_sidebar(node)

visit_rubric(node)

depart_rubric(node)

visit_transition(node)

depart_transition(node)

visit_version(node)

visit_warning(node)

depart_warning(node)

unimplemented_visit(node)