sandbox/manpage-writer/input/optionslisttest.txt

   1 .. -*- mode: rst -*-
   2
   3 ===============
   4 OptionlistTest
   5 ===============
   6
   7 -----------------------------------------------------
   8 Test for correct intention/detention of option lists
   9 -----------------------------------------------------
  10
  11 :Author: h.goebel@goebel-consult.de
  12 :Date:   2008-04-29
  13 :Copyright: public domain
  14 :Manual section: 1
  15
  16
  17 DESCRIPTION
  18 ===========
  19
  20 After an option list:
  21
  22 - a paragraph within the same section must be intented
  23
  24 - a section header directly following the list must *not* be
  25   intentend.
  26
  27 This file tests this.
  28
  29 OPTIONS
  30 =======
  31 This line must be in indented.
  32
  33 -o x   an option
  34 -b     another
  35
  36        This option does the following points:
  37
  38        * one point
  39
  40        * second point
  41
  42           --ccc     option lists may be nested, even if this is rarely
  43                      used.
  44
  45
  46 -k     and even another
  47
  48        This option does the following points:
  49
  50        * one point
  51
  52        * second point
  53
  54 For all other options see ``--help``. This line must be intented.
  55
  56
  57 MORE OPTIONS
  58 =============
  59
  60 -o x   an option
  61 -b     another
  62
  63 -m MESSAGE, --message=MESSAGE  The message to display (beaware of ``,``)
  64
  65 EXAMPLES
  66 ===========
  67
  68 The "Examples" section header must not be intented. But this paragraph
  69 is indented, as all text in man-pages. This is level 0.
  70
  71 * Now let's test nested lists.
  72
  73   Line indented once. This is level 1.
  74
  75   * Nested item1.
  76   * Nested item2.
  77   * Nested item3.
  78
  79     Line for Nested item 3.
  80
  81   * Nested item4.
  82
  83   Paragraph at level 1. Same level as Line indented once.
  84
  85 This paragraph should be at level 0.
  86
  87 emphasize
  88 =========
  89
  90 plain text term
  91     definition paragraph 1
  92
  93     definition paragraph 2
  94
  95 term with *emphasis* in it
  96     paragraph 1 should not be preceeded by a blank line
  97
  98     definition paragraph 2
  99
 100
 101 DEFINITION LIST
 102 =================
 103
 104 :term1:
 105
 106     Description of Term 1 Description of Term 1 Description of Term 1
 107     Description of Term 1 Description of Term 1
 108
 109     Description of Term 1 Description of Term 1 Description of Term 1
 110     Description of Term 1 Description of Term 1
 111
 112 :term1111111111:
 113
 114     Description of Term 1 Description of Term 1 Description of Term 1
 115     Description of Term 1 Description of Term 1
 116
 117     Description of Term 1 Description of Term 1 Description of Term 1
 118     Description of Term 1 Description of Term 1
 119
 120
 121 :term2:    Description of Term 2
 122
 123     Description of Term 2 Description of Term 2 Description of Term 2
 124     Description of Term 2 Description of Term 2
 125
 126     Description of Term 2 Description of Term 2 Description of Term 2
 127     Description of Term 2 Description of Term 2
 128
 129    :term22:       Defintions lists may be nested, thus this at level 1.
 130
 131          More Description of Term 22. More Description of Term 22.
 132          More Description of Term 22. More Description of Term 22.
 133
 134    :term23:       Defintions lists may be nested, thus this at level 1.
 135
 136    This para is indented to term2, thus should be at level 1.
 137
 138    This para is indented to term2, thus should be at level 1.
 139
 140 :term3:       Defintions lists are not nested
 141
 142    More Description for term3.
 143
 144 This paragraph should be at level 0. But the rst-manpage writer has a
 145 bug here. See the option list above.
 146