sandbox/manpage-writer/expected/optionslisttest.man

   1 .\" Man page generated from reStructuredText.
   2 .
   3 .TH OPTIONLISTTEST 1 "2008-04-29" "" ""
   4 .SH NAME
   5 OptionlistTest \- Test for correct intention/detention of option lists
   6 .
   7 .nr rst2man-indent-level 0
   8 .
   9 .de1 rstReportMargin
  10 \\$1 \\n[an-margin]
  11 level \\n[rst2man-indent-level]
  12 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
  13 -
  14 \\n[rst2man-indent0]
  15 \\n[rst2man-indent1]
  16 \\n[rst2man-indent2]
  17 ..
  18 .de1 INDENT
  19 .\" .rstReportMargin pre:
  20 . RS \\$1
  21 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
  22 . nr rst2man-indent-level +1
  23 .\" .rstReportMargin post:
  24 ..
  25 .de UNINDENT
  26 . RE
  27 .\" indent \\n[an-margin]
  28 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
  29 .nr rst2man-indent-level -1
  30 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
  31 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
  32 ..
  33 .\" -*- mode: rst -*-
  34 .
  35 .SH DESCRIPTION
  36 .sp
  37 After an option list:
  38 .INDENT 0.0
  39 .IP \(bu 2
  40 a paragraph within the same section must be intented
  41 .IP \(bu 2
  42 a section header directly following the list must \fInot\fP be
  43 intentend.
  44 .UNINDENT
  45 .sp
  46 This file tests this.
  47 .SH OPTIONS
  48 .sp
  49 This line must be in indented.
  50 .INDENT 0.0
  51 .TP
  52 .BI \-o \ x
  53 an option
  54 .TP
  55 .B \-b
  56 another
  57 .sp
  58 This option does the following points:
  59 .INDENT 7.0
  60 .IP \(bu 2
  61 one point
  62 .IP \(bu 2
  63 second point
  64 .INDENT 2.0
  65 .INDENT 3.5
  66 .INDENT 0.0
  67 .TP
  68 .B \-\-ccc
  69 option lists may be nested, even if this is rarely
  70 used.
  71 .UNINDENT
  72 .UNINDENT
  73 .UNINDENT
  74 .UNINDENT
  75 .TP
  76 .B \-k
  77 and even another
  78 .sp
  79 This option does the following points:
  80 .INDENT 7.0
  81 .IP \(bu 2
  82 one point
  83 .IP \(bu 2
  84 second point
  85 .UNINDENT
  86 .UNINDENT
  87 .sp
  88 For all other options see \fB\-\-help\fP\&. This line must be intented.
  89 .SH MORE OPTIONS
  90 .INDENT 0.0
  91 .TP
  92 .BI \-o \ x
  93 an option
  94 .TP
  95 .B \-b
  96 another
  97 .TP
  98 .BI \-m \ MESSAGE\fP,\fB \ \-\-message\fB= MESSAGE
  99 The message to display (beaware of \fB,\fP)
 100 .UNINDENT
 101 .SH EXAMPLES
 102 .sp
 103 The "Examples" section header must not be intented. But this paragraph
 104 is indented, as all text in man\-pages. This is level 0.
 105 .INDENT 0.0
 106 .IP \(bu 2
 107 Now let\(aqs test nested lists.
 108 .sp
 109 Line indented once. This is level 1.
 110 .INDENT 2.0
 111 .IP \(bu 2
 112 Nested item1.
 113 .IP \(bu 2
 114 Nested item2.
 115 .IP \(bu 2
 116 Nested item3.
 117 .sp
 118 Line for Nested item 3.
 119 .IP \(bu 2
 120 Nested item4.
 121 .UNINDENT
 122 .sp
 123 Paragraph at level 1. Same level as Line indented once.
 124 .UNINDENT
 125 .sp
 126 This paragraph should be at level 0.
 127 .SH EMPHASIZE
 128 .INDENT 0.0
 129 .TP
 130 .B plain text term
 131 definition paragraph 1
 132 .sp
 133 definition paragraph 2
 134 .TP
 135 .B term with \fIemphasis\fP in it
 136 paragraph 1 should not be preceeded by a blank line
 137 .sp
 138 definition paragraph 2
 139 .UNINDENT
 140 .SH DEFINITION LIST
 141 .INDENT 0.0
 142 .TP
 143 .B term1
 144 Description of Term 1 Description of Term 1 Description of Term 1
 145 Description of Term 1 Description of Term 1
 146 .sp
 147 Description of Term 1 Description of Term 1 Description of Term 1
 148 Description of Term 1 Description of Term 1
 149 .TP
 150 .B term1111111111
 151 Description of Term 1 Description of Term 1 Description of Term 1
 152 Description of Term 1 Description of Term 1
 153 .sp
 154 Description of Term 1 Description of Term 1 Description of Term 1
 155 Description of Term 1 Description of Term 1
 156 .TP
 157 .B term2
 158 Description of Term 2
 159 .INDENT 7.0
 160 .INDENT 3.5
 161 Description of Term 2 Description of Term 2 Description of Term 2
 162 Description of Term 2 Description of Term 2
 163 .sp
 164 Description of Term 2 Description of Term 2 Description of Term 2
 165 Description of Term 2 Description of Term 2
 166 .UNINDENT
 167 .UNINDENT
 168 .INDENT 7.0
 169 .TP
 170 .B term22
 171 Defintions lists may be nested, thus this at level 1.
 172 .sp
 173 More Description of Term 22. More Description of Term 22.
 174 More Description of Term 22. More Description of Term 22.
 175 .TP
 176 .B term23
 177 Defintions lists may be nested, thus this at level 1.
 178 .UNINDENT
 179 .sp
 180 This para is indented to term2, thus should be at level 1.
 181 .sp
 182 This para is indented to term2, thus should be at level 1.
 183 .TP
 184 .B term3
 185 Defintions lists are not nested
 186 .sp
 187 More Description for term3.
 188 .UNINDENT
 189 .sp
 190 This paragraph should be at level 0. But the rst\-manpage writer has a
 191 bug here. See the option list above.
 192 .SH AUTHOR
 193 h.goebel@goebel-consult.de
 194 .SH COPYRIGHT
 195 public domain
 196 .\" Generated by docutils manpage writer.
 197 .