Date: 2007-11-24 09:54:36 +0100 (Sat, 24 Nov 2007)
New Revision: 5463
More file documentation
--- trunk/sandbox/manpage-writer/writers/manpage.py 2007-11-12 13:34:59 UTC (rev 5462)
+++ trunk/sandbox/manpage-writer/writers/manpage.py 2007-11-24 08:54:36 UTC (rev 5463)
@@ -3,12 +3,27 @@
# Copyright: This module is put into the public domain.
-Man page formatting for reStructuredText.
+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.
@@ -16,9 +31,14 @@
SEE ALSO ,
+A unix-like system keeps an index of the DESCRIPTIONs, which is accesable
+by the command whatis or apropos.
# NOTE: the macros only work when at line start, so try the rule