1 RST2MAN(1) text processing RST2MAN(1)
6 rst2man - generate unix manpages from reStructured text
8 S
\bSY
\bYN
\bNO
\bOP
\bPS
\bSI
\bIS
\bS
9 r
\brs
\bst
\bt2
\b2m
\bma
\ban
\bn -
\b--
\b-h
\bhe
\bel
\blp
\bp
11 r
\brs
\bst
\bt2
\b2m
\bma
\ban
\bn [ OPTIONS ] [ SOURCE [ _
\bd_
\be_
\bs_
\bt_
\bi_
\bn_
\ba_
\bt_
\bi_
\bo_
\bn ] ]
13 D
\bDE
\bES
\bSC
\bCR
\bRI
\bIP
\bPT
\bTI
\bIO
\bON
\bN
14 Run it and examine output.
16 O
\bOP
\bPT
\bTI
\bIO
\bON
\bNS
\bS
17 -
\b-o
\bo _
\bx an option
21 -
\b-f
\bf,
\b, -
\b--
\b-f
\bfo
\bor
\brc
\bce
\be
24 For all other options see -
\b--
\b-h
\bhe
\bel
\blp
\bp.
26 E
\bEX
\bXA
\bAM
\bMP
\bPL
\bLE
\bES
\bS
27 r
\brs
\bst
\bt2
\b2m
\bma
\ban
\bn.
\b.p
\bpy
\by x
\bxm
\bml
\bl-
\b-s
\bsc
\bch
\bhe
\bem
\bma
\ba-
\b-c
\bca
\bat
\bta
\bal
\blo
\bog
\bg.
\b.r
\brs
\bst
\bt x
\bxm
\bml
\bl-
\b-s
\bsc
\bch
\bhe
\bem
\bma
\ba-
\b-c
\bca
\bat
\bta
\bal
\blo
\bog
\bg.
\b.m
\bma
\ban
\bn
28 create a manpage from xml-schema-catalog.rst
30 C
\bCh
\bha
\bar
\bra
\bac
\bct
\bte
\ber
\br f
\bfo
\bor
\brm
\bma
\bat
\btt
\bti
\bin
\bng
\bg
31 _
\bB_
\bU_
\bG The section title should be separated from the title above.
33 Test b
\bbo
\bol
\bld
\bd or s
\bst
\btr
\bro
\bon
\bng
\bg formatting.
48 · and a longer entry, and a longer entry, and a longer entry, and a
49 longer entry, and a longer entry, and a longer entry, and a longer
50 entry, and a longer entry,
66 a. alphabetically list
84 10. bigger indentation if there are more than nine enumerated items
85 (or there are larger numbers)
87 a second paragraph that should be separated from the previous one
92 9. dont increment by 1
94 13. Problematic: indentation does not match for nonconsecutive entries.
96 This paragraph must not be indented with the text the last list-item,
97 but start at the left margin of the numbers.
99 a second paragraph that should be separated from the previous one and
102 D
\bDe
\bef
\bfi
\bin
\bni
\bit
\bti
\bio
\bon
\bn L
\bLi
\bis
\bst
\bts
\bs
103 T
\bTe
\ber
\brm
\bm Definition
105 T
\bTe
\ber
\brm
\bm classifier Definition paragraph 1.
107 Definition paragraph 2.
109 T
\bTe
\ber
\brm
\bm Definition
111 F
\bFi
\bie
\bel
\bld
\bd l
\bli
\bis
\bst
\bts
\bs
112 f
\bfi
\bir
\brs
\bst
\bt a short label and a short text
114 s
\bse
\bec
\bco
\bon
\bnd
\bdl
\bly
\by a
\ba l
\blo
\bon
\bng
\bge
\ber
\br l
\bla
\bab
\bbe
\bel
\bl
115 and some more text and some more text and some more text and
118 d
\bde
\bef
\bfi
\bin
\bni
\bit
\bti
\bio
\bon
\bn l
\bli
\bis
\bst
\bts
\bs
119 are also a valuable option and simple nonintrusive formatting
121 d
\bde
\bef
\bfi
\bin
\bni
\bit
\bti
\bio
\bon
\bn t
\bto
\boo
\bo :
\b:
124 D
\bDo
\boc
\bct
\bte
\bes
\bst
\bt B
\bBl
\blo
\boc
\bck
\bks
\bs
125 >>> print 'Python-specific usage examples; begun with ">>>"'
126 Python-specific usage examples; begun with ">>>"
127 >>> print '(cut and pasted from interactive Python sessions)'
128 (cut and pasted from interactive Python sessions)
130 T
\bTa
\bab
\bbl
\ble
\bes
\bs
131 +----------------+-------+
133 +----------------+-------+
136 +----------------+-------+
138 l
\bli
\bin
\bne
\beb
\bbl
\blo
\boc
\bck
\bk
144 A paragraph following the line block. lorem ipsum lorem ipsum lorem
145 ipsum lorem ipsum lorem ipsum lorem ipsum lorem ipsum lorem ipsum
147 L
\bLi
\bit
\bte
\ber
\bra
\bal
\bl
155 and a paragraph after the literal.
157 some special characters and roff formatting in literal:
159 .SS "." at line start
162 L
\bLi
\bin
\bne
\be b
\bbl
\blo
\boc
\bck
\bks
\bs
163 This is a line block. It ends with a blank line.
164 Each new line begins with a vertical bar ("|").
165 Line breaks and initial indents are preserved.
166 Continuation lines are wrapped portions of long lines;
167 they begin with a space in place of the vertical bar.
168 The left edge of a continuation line need not be aligned with
169 the left edge of the text above it.
171 This is a second line block.
173 Blank lines are permitted internally, but they must begin with a "|".
176 Take it away, Eric the Orchestra Leader!
177 A one, two, a one two three four
179 Half a bee, philosophically,
180 must, _
\bi_
\bp_
\bs_
\bo _
\bf_
\ba_
\bc_
\bt_
\bo, half not be.
181 But half the bee has got to be,
182 _
\bv_
\bi_
\bs _
\ba _
\bv_
\bi_
\bs its entity. D'you see?
184 But can a bee be said to be
185 or not to be an entire bee,
186 when half the bee is not a bee,
187 due to some ancient injury?
195 A
\bAd
\bdm
\bmo
\bon
\bni
\bit
\bti
\bio
\bon
\bns
\bs
200 Don't take any wooden nickels.
203 Mad scientist at work!
205 Error Does not compute.
207 Hint It's bigger than a bread box.
211 · Wash behind your ears.
213 · Clean up your room.
221 Tip 15% if the service is good.
224 Strong prose may provoke extreme mental exertion. Reader dis-
225 cretion is strongly advised.
229 You can make up your own admonition too.
231 With more than one paragraph.
233 Text after the admonition.
236 inline references _
\br_
\be_
\bf _
\bs_
\bo_
\bm_
\be_
\bt_
\bh_
\bi_
\bn_
\bg . Contained verbose. Nothing special.
238 T
\bTO
\bOP
\bP S
\bSE
\bEC
\bCT
\bTI
\bIO
\bON
\bN
241 T
\bTO
\bOP
\bP S
\bSE
\bEC
\bCT
\bTI
\bIO
\bON
\bN B
\bB C
\bC D
\bD E
\bE F
\bF G
\bG
242 with character formatting.
247 S
\bSE
\bEE
\bE A
\bAL
\bLS
\bSO
\bO
248 _
\bd_
\bo_
\bc_
\bu_
\bt_
\bi_
\bl_
\bs
250 r
\brs
\bst
\bt2
\b2x
\bxm
\bml
\bl(dummy)
252 More information can be found about
254 · xml-schema-catalog at _
\bh_
\bt_
\bt_
\bp_
\b:_
\b/_
\b/_
\bx_
\bm_
\bl_
\b-_
\bs_
\bc_
\bh_
\be_
\bm_
\ba_
\b-_
\bc_
\ba_
\bt_
\ba_
\bl_
\bo_
\bg_
\b._
\bo_
\br_
\bi_
\bg_
\bo_
\b._
\be_
\bt_
\bh_
\bz_
\b._
\bc_
\bh_
\b/
256 And see the stars at the sky!
259 Numerous mapping problems.
261 1. Where do we get the manual section number from ? Commandline ?
263 2. docutils authors should be filled into section "AUTHORS".
265 3. be carefull with linebreaks in generated code.
267 4. list items. bullets and enumerators.
269 A
\bAU
\bUT
\bTH
\bHO
\bOR
\bR
270 grubert@users.sourceforge.net
272 Organization: humankind
279 C
\bCO
\bOP
\bPY
\bYR
\bRI
\bIG
\bGH
\bHT
\bT
280 public domain Behave responsible.
285 0.0.1 2009-06-22 RST2MAN(1)