[BACK]Return to index.xml CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / pod2mdoc

File: [cvsweb.bsd.lv] / pod2mdoc / index.xml (download)

Revision 1.10, Wed Apr 6 15:50:04 2016 UTC (4 years, 1 month ago) by schwarze
Branch: MAIN
Changes since 1.9: +2 -2 lines

link to man.openbsd.org

<!DOCTYPE html>
		<meta name="viewport" content="initial-scale=1.0, user-scalable=no" />
		<meta charset='utf-8' />
		<title>pod2mdoc | Convert POD data to mdoc input </title>
			html, body { margin: 0; padding: 0; }
			header { margin-top: 1em; }
			header span.nm { font-size: 16pt; }
			header span.nd { font-size: 14pt; }
			article span.nm, article a.nm { font-style: italic; }
			header, article, footer { width: 80%; margin-left: auto; margin-right: auto; }
			body { color: #333; font-family: Times,serif; line-height: 120%; }
			nav { color: #666; margin-top: 0.5ex; }
			nav span { border-left: thin solid silver; margin-left: 0.25ex; padding-left: 0.5ex; }
			nav span:first-child { border: 0; padding: 0; margin: 0; }
			a { text-decoration: none; }
			footer { margin-top: 1em; font-size: smaller; color: #666; }
			footer a { color: #000; }
			h2 { font-size: larger; font-weight: bolder; color: #333; }
			<span class="nm">pod2mdoc</span>
			<span class="nd">Convert POD data to mdoc input</span>
				<span>version <span>@VERSION@</span></span>
				<span><a href="snapshots/pod2mdoc.tgz">Sources</a></span>
				<span><a href="snapshots">Archives</a></span>
				The <span class="nm">pod2mdoc</span> utility is a converter from <a
					href="http://perldoc.perl.org/perlpod.html">POD</a> into <a
				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
				standalone <a rel="license"
					href="https://www.isc.org/downloads/software-support-policy/isc-license/">ISC</a>-licensed ISO C utility
				and should compile on any modern UNIX system.
				Be aware, as stated in the <a href="pod2mdoc.1.html">manual</a>:
				By way of being a presentational language, POD is not well-represented
				by mdoc(7).
				Semantic content must be inferred and may be wrong.
				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.
				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>.
				In addition to the release notes given below, a full <a href="ChangeLog">ChangeLog</a> is available.
				New in version 0.2 (May 19, 2015)
				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.
				New in version 0.1 (November 17, 2014)
				Simple <code>Ft/Fo/Fa/Fc</code> parser and formatter for the SYNOPSIS.
				New in version 0.0.13 (July 19, 2014)
				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.
				New in version 0.0.12 (July 11, 2014)
				Render <code>B&lt;NULL&gt;</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.
				New in version 0.0.11 (April 7, 2014)
				Properly render <code>#include</code> in the SYNOPSIS with <code>In</code>.
				Handle nested escape codes in <code>L&lt;&gt;</code> links (and ignore them).
				Properly consume whitespace following <code>X&lt;&gt;</code> and <code>N&lt;&gt;</code>.
			&#169; 2014 <a href="http://kristaps.bsd.lv">Kristaps Dzonsons</a> and Ingo Schwarze,
			$Date: 2016/04/06 15:50:04 $