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)