version 1.4, 2014/04/07 12:07:30 |
version 1.10, 2016/04/06 15:50:04 |
|
|
<html> |
<html> |
<head> |
<head> |
<meta name="viewport" content="initial-scale=1.0, user-scalable=no" /> |
<meta name="viewport" content="initial-scale=1.0, user-scalable=no" /> |
<meta charset='utf-8' /> |
<meta charset='utf-8' /> |
<title>pod2mdoc | Convert POD data to mdoc input </title> |
<title>pod2mdoc | Convert POD data to mdoc input </title> |
<style> |
<style> |
html, body { margin: 0; padding: 0; } |
html, body { margin: 0; padding: 0; } |
|
|
<p> |
<p> |
The <span class="nm">pod2mdoc</span> utility is a converter from <a |
The <span class="nm">pod2mdoc</span> utility is a converter from <a |
href="http://perldoc.perl.org/perlpod.html">POD</a> into <a |
href="http://perldoc.perl.org/perlpod.html">POD</a> into <a |
href="http://www.openbsd.org/cgi-bin/man.cgi?query=mdoc&sektion=7">mdoc</a>. |
href="http://man.openbsd.org/mdoc.7">mdoc</a>. |
It's meant to operate like <a class="nm" href="http://perldoc.perl.org/pod2man.html">pod2man</a>; however, it |
It's meant to operate like <a class="nm" href="http://perldoc.perl.org/pod2man.html">pod2man</a>; however, it |
doesn't require a <a href="http://www.perl.org/">Perl</a> installation: <span class="nm">pod2mdoc</span> is a |
doesn't require a <a href="http://www.perl.org/">Perl</a> installation: <span class="nm">pod2mdoc</span> is a |
standalone <a rel="license" |
standalone <a rel="license" |
|
|
Semantic content must be inferred and may be wrong. |
Semantic content must be inferred and may be wrong. |
</blockquote> |
</blockquote> |
<p> |
<p> |
Contact <a href="http://kristaps.bsd.lv">Kristaps</a> with questions, but please make sure any formatting issue |
The <span class="nm">pod2mdoc</span> utility is still in an early stage of development and far from complete. |
|
However, when translating the <a href="http://www.libressl.org/">LibreSSL</a> <code>-lssl</code> manuals, |
|
it has been shown that with some manual postprocessing, it is already usable for real-world tasks. |
|
</p> |
|
<p> |
|
Contact the <a href="http://mdocml.bsd.lv/contact.html">mandoc developers</a> with questions, |
|
but please make sure any formatting issue |
hasn't already been covered in the <a href="pod2mdoc.1.html">manual</a>. |
hasn't already been covered in the <a href="pod2mdoc.1.html">manual</a>. |
</p> |
</p> |
|
<p> |
|
In addition to the release notes given below, a full <a href="ChangeLog">ChangeLog</a> is available. |
|
</p> |
<h2> |
<h2> |
New in version @VERSION@... |
New in version 0.2 (May 19, 2015) |
</h2> |
</h2> |
<p> |
<p> |
|
SYNOPSIS preprocessor lines use <code>Fd</code>. |
|
Names found in the SYNOPSIS are remembered |
|
using Marc Espie's ohash library (bundled |
|
for compatibility with operating systems |
|
lacking it); that information is used |
|
subsequently to mark up |
|
function names with <code>Fn</code>, |
|
function arguments with <code>Fa</code>, |
|
type names with <code>Vt</code>, |
|
preprocessor macros with <code>Dv</code>. |
|
Foreign function names are marked up |
|
with <code>Xr</code>. |
|
Whitespace handling has been improved |
|
in many respects (blank lines in literal |
|
displays; re-wrap text lines; new sentence, |
|
new line; better horizontal spacing; |
|
no more whitespace at the end of lines). |
|
Improved handling of closing punctuation. |
|
Escaping of quotes at the beginning of |
|
macro arguments. |
|
</p> |
|
<h2> |
|
New in version 0.1 (November 17, 2014) |
|
</h2> |
|
<p> |
|
Simple <code>Ft/Fo/Fa/Fc</code> parser and formatter for the SYNOPSIS. |
|
</p> |
|
<h2> |
|
New in version 0.0.13 (July 19, 2014) |
|
</h2> |
|
<p> |
|
Proper translation of POD commands |
|
and formatting codes into mdoc macros, |
|
including correct whitespace handling. |
|
Only capital ASCII letters A-Z |
|
can start a formatting code. |
|
Do not skip the content of invalid |
|
formatting codes. |
|
Improved handling of filename extensions. |
|
</p> |
|
<h2> |
|
New in version 0.0.12 (July 11, 2014) |
|
</h2> |
|
<p> |
|
Render <code>B<NULL></code> as <code>.Dv NULL</code>. |
|
Correctly check the number of arguments. |
|
Show the usage() message if there are too many arguments. |
|
Mention the optional "file" argument in the usage() message. |
|
</p> |
|
<h2> |
|
New in version 0.0.11 (April 7, 2014) |
|
</h2> |
|
<p> |
Properly render <code>#include</code> in the SYNOPSIS with <code>In</code>. |
Properly render <code>#include</code> in the SYNOPSIS with <code>In</code>. |
Handle nested escape codes in <code>L<></code> links (and ignore them). |
Handle nested escape codes in <code>L<></code> links (and ignore them). |
Properly consume whitespace following <code>X<></code> and <code>N<></code>. |
Properly consume whitespace following <code>X<></code> and <code>N<></code>. |
</p> |
</p> |
</article> |
</article> |
<footer> |
<footer> |
© 2014 <a href="http://kristaps.bsd.lv">Kristaps Dzonsons</a>, |
© 2014 <a href="http://kristaps.bsd.lv">Kristaps Dzonsons</a> and Ingo Schwarze, |
$Date$ |
$Date$ |
</footer> |
</footer> |
</body> |
</body> |