![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to index.xml CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / pod2mdoc|
Return to index.xml CVS log | Up to [cvsweb.bsd.lv] / pod2mdoc |
1.1 kristaps 1: <!DOCTYPE html>
2: <html>
3: <head>
4: <meta name="viewport" content="initial-scale=1.0, user-scalable=no" />
1.8 schwarze 5: <meta charset='utf-8' />
1.1 kristaps 6: <title>pod2mdoc | Convert POD data to mdoc input </title>
7: <style>
8: html, body { margin: 0; padding: 0; }
9: header { margin-top: 1em; }
10: header span.nm { font-size: 16pt; }
11: header span.nd { font-size: 14pt; }
12: article span.nm, article a.nm { font-style: italic; }
13: header, article, footer { width: 80%; margin-left: auto; margin-right: auto; }
14: body { color: #333; font-family: Times,serif; line-height: 120%; }
15: nav { color: #666; margin-top: 0.5ex; }
16: nav span { border-left: thin solid silver; margin-left: 0.25ex; padding-left: 0.5ex; }
17: nav span:first-child { border: 0; padding: 0; margin: 0; }
18: a { text-decoration: none; }
19: footer { margin-top: 1em; font-size: smaller; color: #666; }
20: footer a { color: #000; }
1.2 kristaps 21: h2 { font-size: larger; font-weight: bolder; color: #333; }
1.1 kristaps 22: </style>
23: </head>
24: <body>
25: <header>
26: <span class="nm">pod2mdoc</span>
27: —
28: <span class="nd">Convert POD data to mdoc input</span>
29: <nav>
30: <span>version <span>@VERSION@</span></span>
31: <span><a href="snapshots/pod2mdoc.tgz">Sources</a></span>
32: <span><a href="snapshots">Archives</a></span>
33: </nav>
34: </header>
35: <article>
36: <p>
37: The <span class="nm">pod2mdoc</span> utility is a converter from <a
38: href="http://perldoc.perl.org/perlpod.html">POD</a> into <a
1.6 schwarze 39: href="http://www.openbsd.org/cgi-bin/man.cgi?query=mdoc&sec=7">mdoc</a>.
1.1 kristaps 40: It's meant to operate like <a class="nm" href="http://perldoc.perl.org/pod2man.html">pod2man</a>; however, it
41: doesn't require a <a href="http://www.perl.org/">Perl</a> installation: <span class="nm">pod2mdoc</span> is a
42: standalone <a rel="license"
43: href="https://www.isc.org/downloads/software-support-policy/isc-license/">ISC</a>-licensed ISO C utility
44: and should compile on any modern UNIX system.
45: </p>
46: <p>
47: Be aware, as stated in the <a href="pod2mdoc.1.html">manual</a>:
48: </p>
49: <blockquote>
50: By way of being a presentational language, POD is not well-represented
51: by mdoc(7).
1.3 kristaps 52: Semantic content must be inferred and may be wrong.
1.1 kristaps 53: </blockquote>
54: <p>
1.7 schwarze 55: The <span class="nm">pod2mdoc</span> utility is still in an early stage of development and far from complete.
56: However, when translating the <a href="http://www.libressl.org/">LibreSSL</a> <code>-lssl</code> manuals,
57: it has been shown that with some manual postprocessing, it is already usable for real-world tasks.
58: </p>
59: <p>
60: Contact the <a href="http://mdocml.bsd.lv/contact.html">mandoc developers</a> with questions,
61: but please make sure any formatting issue
1.1 kristaps 62: hasn't already been covered in the <a href="pod2mdoc.1.html">manual</a>.
63: </p>
1.7 schwarze 64: <p>
65: In addition to the release notes given below, a full <a href="ChangeLog">ChangeLog</a> is available.
66: </p>
67: <h2>
1.9 ! schwarze 68: New in version 0.2 (May 19, 2015)
! 69: </h2>
! 70: <p>
! 71: SYNOPSIS preprocessor lines use <code>Fd</code>.
! 72: Names found in the SYNOPSIS are remembered
! 73: using Marc Espie's ohash library (bundled
! 74: for compatibility with operating systems
! 75: lacking it); that information is used
! 76: subsequently to mark up
! 77: function names with <code>Fn</code>,
! 78: function arguments with <code>Fa</code>,
! 79: type names with <code>Vt</code>,
! 80: preprocessor macros with <code>Dv</code>.
! 81: Foreign function names are marked up
! 82: with <code>Xr</code>.
! 83: Whitespace handling has been improved
! 84: in many respects (blank lines in literal
! 85: displays; re-wrap text lines; new sentence,
! 86: new line; better horizontal spacing;
! 87: no more whitespace at the end of lines).
! 88: Improved handling of closing punctuation.
! 89: Escaping of quotes at the beginning of
! 90: macro arguments.
! 91: </p>
! 92: <h2>
1.7 schwarze 93: New in version 0.1 (November 17, 2014)
94: </h2>
95: <p>
96: Simple <code>Ft/Fo/Fa/Fc</code> parser and formatter for the SYNOPSIS.
97: </p>
1.2 kristaps 98: <h2>
1.6 schwarze 99: New in version 0.0.13 (July 19, 2014)
100: </h2>
101: <p>
102: Proper translation of POD commands
103: and formatting codes into mdoc macros,
104: including correct whitespace handling.
105: Only capital ASCII letters A-Z
106: can start a formatting code.
107: Do not skip the content of invalid
108: formatting codes.
109: Improved handling of filename extensions.
110: </p>
111: <h2>
1.5 schwarze 112: New in version 0.0.12 (July 11, 2014)
113: </h2>
114: <p>
115: Render <code>B<NULL></code> as <code>.Dv NULL</code>.
116: Correctly check the number of arguments.
117: Show the usage() message if there are too many arguments.
118: Mention the optional "file" argument in the usage() message.
119: </p>
120: <h2>
121: New in version 0.0.11 (April 7, 2014)
1.2 kristaps 122: </h2>
123: <p>
1.4 kristaps 124: Properly render <code>#include</code> in the SYNOPSIS with <code>In</code>.
125: Handle nested escape codes in <code>L<></code> links (and ignore them).
126: Properly consume whitespace following <code>X<></code> and <code>N<></code>.
1.2 kristaps 127: </p>
1.1 kristaps 128: </article>
129: <footer>
1.6 schwarze 130: © 2014 <a href="http://kristaps.bsd.lv">Kristaps Dzonsons</a> and Ingo Schwarze,
1.9 ! schwarze 131: $Date: 2015/03/19 09:59:01 $
1.1 kristaps 132: </footer>
133: </body>
134: </html>