docutils.writers.manpage Namespace Reference

Classes
class	Table
class	Translator
class	Writer

Variables
int	FIELD_LIST_INDENT = 7
int	DEFINITION_LIST_INDENT = 7
int	OPTION_LIST_INDENT = 7
float	BLOCKQOUTE_INDENT = 3.5
float	LITERAL_BLOCK_INDENT = 3.5
tuple	MACRO_DEF = ()

Detailed Description

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 https://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.