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 :organization: humankind
  11 :Address: 123 Example Street
  12           Example, EX  Canada
  13           A1B 2C3
  14 :Date:   2009-06-22
  15 :Copyright: public domain
  16             Behave responsible.
  17 :Version: 0.0.1
  18 :Manual section: 1
  19 :Manual group: text processing
  20
  21 .. TODO: authors and author with name <email>
  22
  23 SYNOPSIS
  24 ========
  25
  26 ``rst2man`` ``--help``
  27
  28 ``rst2man`` [ OPTIONS ] [ SOURCE [ *destination* ] ]
  29
  30
  31 DESCRIPTION
  32 ===========
  33
  34 Run it and examine output.
  35
  36 OPTIONS
  37 =======
  38
  39 -o x   an option
  40 -b     another
  41 -f, --force
  42        really do it
  43
  44 For all other options see ``--help``.
  45
  46
  47 EXAMPLES
  48 ===========
  49
  50 :rst2man.py xml-schema-catalog.rst xml-schema-catalog.man:
  51     create a manpage from xml-schema-catalog.rst
  52
  53 .. comments : lorem ipsum lorem ipsum
  54    lorem ipsum lorem ipsum
  55
  56 Character formatting
  57 --------------------
  58
  59 *BUG* The section title should be separated from the title above.
  60
  61 Test **bold** or **strong** formatting.
  62
  63 Special characters:
  64
  65 * backslash: \\
  66 * hyphen: -
  67 * accents: ´ `
  68 * quotes: ' "
  69
  70 .period ad line start.
  71
  72 Lists
  73 -----
  74
  75 * bullet list
  76 * and a longer entry, and a longer entry, and a longer entry, and a longer entry,
  77   and a longer entry, and a longer entry, and a longer entry, and a longer entry,
  78
  79   1. and a nested
  80   2. enumeration
  81
  82      - some line
  83      - bullets
  84
  85   3. a third
  86   4. a third
  87   5. a third
  88
  89      a. alphabetically list
  90      b. betacarotin
  91      c. grammar
  92
  93   6. a third
  94
  95      Y. the end
  96      Z. yellow
  97
  98   7. a third
  99   8. a third
 100   9. a third
 101   10. bigger indentation if there are more than nine
 102       enumerated items (or there are larger numbers)
 103
 104       a second paragraph that should be separated from the previous
 105       one and not flowing into.
 106
 107 7. dont start with 1
 108
 109 9. dont increment by 1
 110
 111 13. Problematic: indentation does not match for nonconsecutive entries.
 112
 113 This paragraph must not be indented with the text the last list-item,
 114 but start at the left margin of the numbers.
 115
 116 a second paragraph that should be separated from the previous
 117 one and not flowing into.
 118
 119 Definition Lists
 120 ----------------
 121
 122 Term
 123     Definition
 124 Term : classifier
 125     Definition paragraph 1.
 126
 127     Definition paragraph 2.
 128 .ini-files
 129     Term starting with period.
 130 Term
 131     Definition
 132
 133
 134 Field lists
 135 -----------
 136
 137 :first: a short label and a short text
 138 :secondly a longer label: and some more text and some more text
 139   and some more text   and some more text
 140
 141 definition lists
 142   are also a valuable option and simple nonintrusive formatting
 143 definition too :
 144   with the colon.
 145
 146 Doctest Blocks
 147 --------------
 148
 149 >>> print 'Python-specific usage examples; begun with ">>>"'
 150 Python-specific usage examples; begun with ">>>"
 151 >>> print '(cut and pasted from interactive Python sessions)'
 152 (cut and pasted from interactive Python sessions)
 153
 154
 155 Tables
 156 ------
 157
 158 +----------+--------+
 159 | single   | frame  |
 160 +----------+--------+
 161 | no table |        |
 162 | header   |        |
 163 +----------+--------+
 164
 165 lineblock
 166 ---------
 167
 168 | paul
 169 | tel. 12345
 170 | LA
 171
 172 A paragraph following the line block.
 173 lorem ipsum lorem ipsum
 174 lorem ipsum lorem ipsum
 175 lorem ipsum lorem ipsum
 176 lorem ipsum lorem ipsum
 177
 178
 179 Literal
 180 -------
 181
 182 some literal text ::
 183
 184   here now it starts
 185   and continues
 186     indented
 187   and back
 188
 189 and a paragraph after the literal.
 190
 191 some special characters and roff formatting in literal::
 192
 193   .SS "." at line start
 194   backslash "\"
 195
 196 Line blocks
 197 -----------
 198
 199 | This is a line block.  It ends with a blank line.
 200 |     Each new line begins with a vertical bar ("|").
 201 |     Line breaks and initial indents are preserved.
 202 | Continuation lines are wrapped portions of long lines;
 203   they begin with a space in place of the vertical bar.
 204 |     The left edge of a continuation line need not be aligned with
 205   the left edge of the text above it.
 206
 207 | This is a second line block.
 208 |
 209 | Blank lines are permitted internally, but they must begin with a "|".
 210
 211 Take it away, Eric the Orchestra Leader!
 212
 213     | A one, two, a one two three four
 214     |
 215     | Half a bee, philosophically,
 216     |     must, *ipso facto*, half not be.
 217     | But half the bee has got to be,
 218     |     *vis a vis* its entity.  D'you see?
 219     |
 220     | But can a bee be said to be
 221     |     or not to be an entire bee,
 222     |         when half the bee is not a bee,
 223     |             due to some ancient injury?
 224     |
 225     | Singing...
 226
 227
 228
 229 raw
 230 ---
 231
 232 .. raw :: manpage
 233
 234    raw input to man
 235
 236 .. raw :: latex
 237
 238    never seen
 239
 240 Admonitions
 241 -----------
 242
 243 .. Attention:: Directives at large.
 244
 245 .. Caution::
 246
 247    Don't take any wooden nickels.
 248
 249 .. DANGER:: Mad scientist at work!
 250
 251 .. Error:: Does not compute.
 252
 253 .. Hint:: It's bigger than a bread box.
 254
 255 .. Important::
 256    - Wash behind your ears.
 257    - Clean up your room.
 258    - Call your mother.
 259    - Back up your data.
 260
 261 .. Note:: This is a note.
 262
 263 .. Tip:: 15% if the service is good.
 264
 265 .. WARNING:: Strong prose may provoke extreme mental exertion.
 266    Reader discretion is strongly advised.
 267
 268 .. admonition:: And, by the way...
 269
 270    You can make up your own admonition too.
 271
 272    With more than one paragraph.
 273
 274 Text after the admonition.
 275
 276 other
 277 -----
 278
 279 inline references `ref something` .
 280
 281 .. container:: verbose
 282
 283    Contained verbose. Nothing special.
 284
 285 Top Section
 286 ===========
 287
 288 With mixed case
 289
 290 Top section `b` c *d* e **f** g
 291 ===============================
 292
 293 with character formatting.
 294
 295 FILES
 296 =====
 297
 298 This is a file.
 299
 300 SEE ALSO
 301 ========
 302
 303 `docutils <http://docutils.sourceforge.net>`__
 304
 305 ``rst2xml``\(dummy)
 306
 307 More information can be found about
 308
 309 * xml-schema-catalog at
 310   http://xml-schema-catalog.origo.ethz.ch/
 311
 312 And see the stars at the sky!
 313
 314
 315 BUGS
 316 ====
 317
 318 Numerous mapping problems.
 319
 320 1. Where do we get the manual section number from ? Commandline ?
 321 2. docutils authors should be filled into section "AUTHORS".
 322 3. be carefull with linebreaks in generated code.
 323 4. list items.
 324    bullets and enumerators.
 325
 326