sandbox/manpage-writer/input/test.txt

   1 =========
   2  rst2man
   3 =========
   4
   5 ---------------------------------------------
   6 generate unix manpages from reStructured text
   7 ---------------------------------------------
   8
   9 :Author: grubert@users.sourceforge.net
  10 :Date:   2006-10-22
  11 :Copyright: public domain
  12             Behave responsible.
  13 :Version: 0.0.1
  14 :Manual section: 1
  15 :Manual group: text processing
  16
  17 .. TODO: authors and author with name <email>
  18
  19 SYNOPSIS
  20 ========
  21
  22 ``rst2man`` ``--help``
  23
  24 ``rst2man`` [ OPTIONS ] [ SOURCE [ *destination* ] ]
  25
  26
  27 DESCRIPTION
  28 ===========
  29
  30 Run it and examine output.
  31
  32 OPTIONS
  33 =======
  34
  35 -o x   an option
  36 -b     another
  37
  38 For all other options see ``--help``.
  39
  40
  41 EXAMPLES
  42 ===========
  43
  44 :rst2man.py xml-schema-catalog.rst xml-schema-catalog.man:
  45     create a manpage from xml-schema-catalog.rst
  46
  47
  48 Character formatting
  49 --------------------
  50
  51 *BUG* The section title should be separated from the title above.
  52
  53
  54
  55 Lists
  56 -----
  57
  58 * bullet list
  59 * and a longer entry, and a longer entry, and a longer entry, and a longer entry,
  60   and a longer entry, and a longer entry, and a longer entry, and a longer entry,
  61
  62   1. and a nested
  63   2. enumeration
  64
  65      - some line
  66      - bullets
  67
  68   3. a third
  69   4. a third
  70   5. a third
  71
  72      a. alphabetically list
  73      b. betacarotin
  74      c. grammar
  75
  76   6. a third
  77   7. a third
  78   8. a third
  79   9. a third
  80   10. bigger indentation if there are more than nine
  81       enumerated items (or there are larger numbers)
  82
  83 7. dont start with 1
  84
  85 9. dont increment by 1
  86
  87 13. does not work.
  88
  89 This paragraph must not be indented with the text the last list-item,
  90 but start at the left margin of the numbers.
  91
  92
  93 Field lists
  94 -----------
  95
  96 :first: a short label and a short text
  97 :secondly a longer label: and some more text and some more text
  98   and some more text   and some more text
  99
 100 definition lists
 101   are also a valuable option and simple nonintrusive formatting
 102 definition too :
 103   with the colon.
 104
 105 Tables
 106 ------
 107
 108 +----------+--------+
 109 | single   | frame  |
 110 +----------+--------+
 111 | no table |        |
 112 | header   |        |
 113 +----------+--------+
 114
 115 lineblock
 116 ---------
 117
 118 | paul
 119 | tel. 12345
 120 | LA
 121
 122 raw
 123 ---
 124
 125 .. raw :: manpage
 126
 127    raw input to man
 128
 129 .. raw :: latex
 130
 131    never seen
 132
 133 other
 134 -----
 135
 136 inline references `ref something` .
 137
 138
 139 FILES
 140 =====
 141
 142 This is a file.
 143
 144 SEE ALSO
 145 ========
 146
 147 `docutils <http://docutils.sourceforge.net>`__
 148
 149 ``rst2xml``\(dummy)
 150
 151 More information can be found about
 152
 153 * xml-schema-catalog at
 154   http://xml-schema-catalog.origo.ethz.ch/
 155
 156 And see the stars at the sky!
 157
 158
 159 BUGS
 160 ====
 161
 162 Numerous mapping problems.
 163
 164 1. Where do we get the manual section number from ? Commandline ?
 165 2. docutils authors should be filled into section "AUTHORS".
 166 3. be carefull with linebreaks in generated code.
 167 4. list items.
 168    bullets and enumerators.
 169
 170