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-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.
45 .period ad line start.
50 · and a longer entry, and a longer entry, and a longer entry, and a
51 longer entry, and a longer entry, and a longer entry, and a longer
52 entry, and a longer entry,
68 a. alphabetically list
86 10. bigger indentation if there are more than nine enumerated items
87 (or there are larger numbers)
89 a second paragraph that should be separated from the previous one
94 9. dont increment by 1
96 13. Problematic: indentation does not match for nonconsecutive entries.
98 This paragraph must not be indented with the text the last list-item,
99 but start at the left margin of the numbers.
101 a second paragraph that should be separated from the previous one and
104 D
\bDe
\bef
\bfi
\bin
\bni
\bit
\bti
\bio
\bon
\bn L
\bLi
\bis
\bst
\bts
\bs
105 T
\bTe
\ber
\brm
\bm Definition
107 T
\bTe
\ber
\brm
\bm classifier Definition paragraph 1.
109 Definition paragraph 2.
111 .
\b.i
\bin
\bni
\bi-
\b-f
\bfi
\bil
\ble
\bes
\bs
112 Term starting with period.
114 T
\bTe
\ber
\brm
\bm Definition
116 F
\bFi
\bie
\bel
\bld
\bd l
\bli
\bis
\bst
\bts
\bs
117 f
\bfi
\bir
\brs
\bst
\bt a short label and a short text
119 s
\bse
\bec
\bco
\bon
\bnd
\bdl
\bly
\by a
\ba l
\blo
\bon
\bng
\bge
\ber
\br l
\bla
\bab
\bbe
\bel
\bl
120 and some more text and some more text and some more text and
123 d
\bde
\bef
\bfi
\bin
\bni
\bit
\bti
\bio
\bon
\bn l
\bli
\bis
\bst
\bts
\bs
124 are also a valuable option and simple nonintrusive formatting
126 d
\bde
\bef
\bfi
\bin
\bni
\bit
\bti
\bio
\bon
\bn t
\bto
\boo
\bo :
\b:
129 D
\bDo
\boc
\bct
\bte
\bes
\bst
\bt B
\bBl
\blo
\boc
\bck
\bks
\bs
130 >>> print 'Python-specific usage examples; begun with ">>>"'
131 Python-specific usage examples; begun with ">>>"
132 >>> print '(cut and pasted from interactive Python sessions)'
133 (cut and pasted from interactive Python sessions)
135 T
\bTa
\bab
\bbl
\ble
\bes
\bs
136 +----------------+-------+
138 +----------------+-------+
140 +----------------+-------+
142 l
\bli
\bin
\bne
\beb
\bbl
\blo
\boc
\bck
\bk
148 A paragraph following the line block. lorem ipsum lorem ipsum lorem
149 ipsum lorem ipsum lorem ipsum lorem ipsum lorem ipsum lorem ipsum
151 L
\bLi
\bit
\bte
\ber
\bra
\bal
\bl
159 and a paragraph after the literal.
161 some special characters and roff formatting in literal:
163 .SS "." at line start
166 L
\bLi
\bin
\bne
\be b
\bbl
\blo
\boc
\bck
\bks
\bs
167 This is a line block. It ends with a blank line.
168 Each new line begins with a vertical bar ("|").
169 Line breaks and initial indents are preserved.
170 Continuation lines are wrapped portions of long lines;
171 they begin with a space in place of the vertical bar.
172 The left edge of a continuation line need not be aligned with
173 the left edge of the text above it.
175 This is a second line block.
177 Blank lines are permitted internally, but they must begin with a "|".
180 Take it away, Eric the Orchestra Leader!
181 A one, two, a one two three four
183 Half a bee, philosophically,
184 must, _
\bi_
\bp_
\bs_
\bo _
\bf_
\ba_
\bc_
\bt_
\bo, half not be.
185 But half the bee has got to be,
186 _
\bv_
\bi_
\bs _
\ba _
\bv_
\bi_
\bs its entity. D'you see?
188 But can a bee be said to be
189 or not to be an entire bee,
190 when half the bee is not a bee,
191 due to some ancient injury?
199 A
\bAd
\bdm
\bmo
\bon
\bni
\bit
\bti
\bio
\bon
\bns
\bs
200 A
\bAT
\bTT
\bTE
\bEN
\bNT
\bTI
\bIO
\bON
\bN!
\b!:
\b:
203 C
\bCA
\bAU
\bUT
\bTI
\bIO
\bON
\bN!
\b!:
\b:
204 Don't take any wooden nickels.
206 !
\b!D
\bDA
\bAN
\bNG
\bGE
\bER
\bR!
\b!:
\b:
207 Mad scientist at work!
209 E
\bER
\bRR
\bRO
\bOR
\bR:
\b:
213 It's bigger than a bread box.
215 I
\bIM
\bMP
\bPO
\bOR
\bRT
\bTA
\bAN
\bNT
\bT:
\b:
217 · Wash behind your ears.
219 · Clean up your room.
229 15% if the service is good.
231 W
\bWA
\bAR
\bRN
\bNI
\bIN
\bNG
\bG:
\b:
232 Strong prose may provoke extreme mental exertion. Reader discretion
237 You can make up your own admonition too.
239 With more than one paragraph.
241 Text after the admonition.
244 inline references _
\br_
\be_
\bf _
\bs_
\bo_
\bm_
\be_
\bt_
\bh_
\bi_
\bn_
\bg . Contained verbose. Nothing special.
246 T
\bTO
\bOP
\bP S
\bSE
\bEC
\bCT
\bTI
\bIO
\bON
\bN
249 T
\bTO
\bOP
\bP S
\bSE
\bEC
\bCT
\bTI
\bIO
\bON
\bN B
\bB C
\bC D
\bD E
\bE F
\bF G
\bG
250 with character formatting.
255 S
\bSE
\bEE
\bE A
\bAL
\bLS
\bSO
\bO
256 _
\bd_
\bo_
\bc_
\bu_
\bt_
\bi_
\bl_
\bs
258 r
\brs
\bst
\bt2
\b2x
\bxm
\bml
\bl(dummy)
260 More information can be found about
262 · 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/
264 And see the stars at the sky!
267 Numerous mapping problems.
269 1. Where do we get the manual section number from ? Commandline ?
271 2. docutils authors should be filled into section "AUTHORS".
273 3. be carefull with linebreaks in generated code.
275 4. list items. bullets and enumerators.
277 A
\bAU
\bUT
\bTH
\bHO
\bOR
\bR
278 grubert@users.sourceforge.net
280 Organization: humankind
287 C
\bCO
\bOP
\bPY
\bYR
\bRI
\bIG
\bGH
\bHT
\bT
288 public domain Behave responsible.
293 0.0.1 2009-06-22 RST2MAN(1)