From: <gr...@us...> - 2009-07-26 15:01:57
|
Author: grubert Date: 2009-07-26 17:01:43 +0200 (Sun, 26 Jul 2009) New Revision: 6057 Modified: trunk/sandbox/manpage-writer/README.txt trunk/sandbox/manpage-writer/docutils/writers/manpage.py Log: Comments on fonts. Modified: trunk/sandbox/manpage-writer/README.txt =================================================================== --- trunk/sandbox/manpage-writer/README.txt 2009-07-26 12:07:27 UTC (rev 6056) +++ trunk/sandbox/manpage-writer/README.txt 2009-07-26 15:01:43 UTC (rev 6057) @@ -58,9 +58,11 @@ man pages from section 7, ``man`` and ``man-pages``. -Problems -'''''''' +.. [LMHT] Linux Man Page Howto. +Conventions +''''''''''' + * man pages have a special structure and organization. From the manpage to *man* :: @@ -98,11 +100,6 @@ eral exclusive invocations as is shown in the SYNOPSIS section of this manual page. -* use title and subtitle to built :: - - NAME - man - program to view ... - * new lines in general. Consecutive blank lines are merged by the viewer but not on printouts. @@ -129,6 +126,14 @@ Current indent is in register ``.i``. +* [LMHT]_ Filenames are always in italics, except in the SYNOPSIS section, use :: + + .I /usr/include/stdio.h + + and:: + + .B #include <stdio.h> + Open issues ''''''''''' Modified: trunk/sandbox/manpage-writer/docutils/writers/manpage.py =================================================================== --- trunk/sandbox/manpage-writer/docutils/writers/manpage.py 2009-07-26 12:07:27 UTC (rev 6056) +++ trunk/sandbox/manpage-writer/docutils/writers/manpage.py 2009-07-26 15:01:43 UTC (rev 6057) @@ -41,7 +41,6 @@ """ - __docformat__ = 'reStructuredText' import sys @@ -197,6 +196,11 @@ # what to output on : visit, depart # Do not use paragraph requests ``.PP`` because these set indentation. # use ``.sp``. Remove superfluous ``.sp`` in ``astext``. + # + # Fonts are put on a stack, the top one is used. + # ``.ft P`` or ``\\fP`` pop from stack. + # ``B`` bold, ``I`` italic, ``R`` roman should be available. + # Hopefully ``C`` courier too. self.defs = { 'indent' : ('.INDENT %.1f\n', '.UNINDENT\n'), 'definition_list' : ('', '.TP 0\n'), |