1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
|
RST2MAN(1) text processing RST2MAN(1)
NNAAMMEE
rst2man - generate unix manpages from reStructured text
SSYYNNOOPPSSIISS
rrsstt22mmaann ----hheellpp
rrsstt22mmaann [ OPTIONS ] [ SOURCE [ _d_e_s_t_i_n_a_t_i_o_n ] ]
DDEESSCCRRIIPPTTIIOONN
Run it and examine output.
OOPPTTIIOONNSS
--oo _x an option
--bb another
--ff, ----ffoorrccee
really do it
For all other options see ----hheellpp.
EEXXAAMMPPLLEESS
rrsstt22mmaann..ppyy xxmmll--sscchheemmaa--ccaattaalloogg..rrsstt xxmmll--sscchheemmaa--ccaattaalloogg..mmaann
create a manpage from xml-schema-catalog.rst
CChhaarraacctteerr ffoorrmmaattttiinngg
_B_U_G The section title should be separated from the title above.
Test bboolldd or ssttrroonngg formatting.
Special characters:
· backslash: \
· hyphen: -
· accents: ´ `
· quotes: ' "
.period ad line start.
LLiissttss
· bullet list
· and a longer entry, and a longer entry, and a longer entry, and a
longer entry, and a longer entry, and a longer entry, and a longer
entry, and a longer entry,
1. and a nested
2. enumeration
· some line
· bullets
3. a third
4. a third
5. a third
a. alphabetically list
b. betacarotin
c. grammar
6. a third
Y. the end
Z. yellow
7. a third
8. a third
9. a third
10. bigger indentation if there are more than nine enumerated items
(or there are larger numbers)
a second paragraph that should be separated from the previous one
and not flowing into.
7. dont start with 1
9. dont increment by 1
13. Problematic: indentation does not match for nonconsecutive entries.
This paragraph must not be indented with the text the last list-item,
but start at the left margin of the numbers.
a second paragraph that should be separated from the previous one and
not flowing into.
DDeeffiinniittiioonn LLiissttss
TTeerrmm Definition
TTeerrmm classifier Definition paragraph 1.
Definition paragraph 2.
..iinnii--ffiilleess
Term starting with period.
TTeerrmm Definition
FFiieelldd lliissttss
ffiirrsstt a short label and a short text
sseeccoonnddllyy aa lloonnggeerr llaabbeell
and some more text and some more text and some more text and
some more text
ddeeffiinniittiioonn lliissttss
are also a valuable option and simple nonintrusive formatting
ddeeffiinniittiioonn ttoooo ::
with the colon.
DDoocctteesstt BBlloocckkss
>>> print 'Python-specific usage examples; begun with ">>>"'
Python-specific usage examples; begun with ">>>"
>>> print '(cut and pasted from interactive Python sessions)'
(cut and pasted from interactive Python sessions)
TTaabblleess
+----------------+-------+
|single | frame |
+----------------+-------+
|no table header | |
+----------------+-------+
lliinneebblloocckk
paul
tel. 12345
LA
A paragraph following the line block. lorem ipsum lorem ipsum lorem
ipsum lorem ipsum lorem ipsum lorem ipsum lorem ipsum lorem ipsum
LLiitteerraall
some literal text
here now it starts
and continues
indented
and back
and a paragraph after the literal.
some special characters and roff formatting in literal:
.SS "." at line start
backslash "\"
LLiinnee bblloocckkss
This is a line block. It ends with a blank line.
Each new line begins with a vertical bar ("|").
Line breaks and initial indents are preserved.
Continuation lines are wrapped portions of long lines;
they begin with a space in place of the vertical bar.
The left edge of a continuation line need not be aligned with
the left edge of the text above it.
This is a second line block.
Blank lines are permitted internally, but they must begin with a "|".
Take it away, Eric the Orchestra Leader!
A one, two, a one two three four
Half a bee, philosophically,
must, _i_p_s_o _f_a_c_t_o, half not be.
But half the bee has got to be,
_v_i_s _a _v_i_s its entity. D'you see?
But can a bee be said to be
or not to be an entire bee,
when half the bee is not a bee,
due to some ancient injury?
Singing...
rraaww
raw input to man
AAddmmoonniittiioonnss
AATTTTEENNTTIIOONN!!::
Directives at large.
CCAAUUTTIIOONN!!::
Don't take any wooden nickels.
!!DDAANNGGEERR!!::
Mad scientist at work!
EERRRROORR::
Does not compute.
HHIINNTT::
It's bigger than a bread box.
IIMMPPOORRTTAANNTT::
· Wash behind your ears.
· Clean up your room.
· Call your mother.
· Back up your data.
NNOOTTEE::
This is a note.
TTIIPP::
15% if the service is good.
WWAARRNNIINNGG::
Strong prose may provoke extreme mental exertion. Reader discretion
is strongly advised.
And, by the way...
You can make up your own admonition too.
With more than one paragraph.
Text after the admonition.
ootthheerr
inline references _r_e_f _s_o_m_e_t_h_i_n_g . Contained verbose. Nothing special.
TTOOPP SSEECCTTIIOONN
With mixed case
TTOOPP SSEECCTTIIOONN BB CC DD EE FF GG
with character formatting.
FFIILLEESS
This is a file.
SSEEEE AALLSSOO
_d_o_c_u_t_i_l_s
rrsstt22xxmmll(dummy)
More information can be found about
· xml-schema-catalog at _h_t_t_p_:_/_/_x_m_l_-_s_c_h_e_m_a_-_c_a_t_a_l_o_g_._o_r_i_g_o_._e_t_h_z_._c_h_/
And see the stars at the sky!
BBUUGGSS
Numerous mapping problems.
1. Where do we get the manual section number from ? Commandline ?
2. docutils authors should be filled into section "AUTHORS".
3. be carefull with linebreaks in generated code.
4. list items. bullets and enumerators.
AAUUTTHHOORR
grubert@users.sourceforge.net
Organization: humankind
Address:
123 Example Street
Example, EX Canada
A1B 2C3
CCOOPPYYRRIIGGHHTT
public domain Behave responsible.
0.0.1 2009-06-22 RST2MAN(1)
|