rst2man(1)
NAME
rst2man - generate unix manpages from reStructured text
SYNOPSIS
rst2man.py inputfile outputfile
DESCRIPTION
rst2man transforms a reStructured text document into a unix man page.
In theory any valid reStructured text document should be processable,
in reality this is
o a goal, that is not met yet
- o a goal that might never be met, because only few constructs are used
- in man pages and because the common text file does not adhere to man page requirements.
- For example a unix man page belongs into a numbered section, 1 is user commands, 8 contains administrator commands and the headlines of all manpages are collected into a database, queryable with the programm apropos, therefore the headline should contain a short text describing into which group this command belongs.
- These informations are collected from title, subtitle and the docinfo, see this document as an example.
OPTIONS
- --config=<file>
- Read configuration settings from <file>, if it exists.
- --version , -V
- Show this program's version number and exit.
- --help , -h
- Show this help message and exit.
- And a lot more standard docutils options.
PROBLEMS
- 1. linux man page howto advises to use the man macro package, UCB uses
- the newer doc macros.
SEE ALSO
o docutils
o linux man page howto
o man man and man 7 man
BUGS
- o Format options are included as they are required, only the simplest
- options are supported, and no complex things should be used in man pages.
- o tables:
o no header allowedo always have a bordero cell alignment is always top/left.o images are not supported.Discussion is still open.
AUTHOR
grubert@users.sourceforge.net
COPYRIGHT
- public domain