path: root/index.sgml



<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
	<head>
		<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
		<meta name="resource-type" content="document">
		<link rel="stylesheet" href="index.css" type="text/css" media="all">
		<title>mdocml.bsd.lv</title>
	</head>
	<body>
	<table class="frame">
		<col width="100%">
		<tbody>
			<tr>
				<td>
					<div class="head">
						<b>mdocml</b> &#8211; mdoc macro compiler
					</div>
				</td>
			</tr>
			<tr>
				<td valign="top">
					<h1>
					DESCRIPTION
					</h1>

					<p>
					<span class="nm">mdocml</span> is a suite of tools compiling &#8220;-mdoc&#8221;, the roff macro package
					of choice for BSD manual pages, and &#8220;-man&#8221;, the predominant historical package for UNIX
					manuals.  The mission of <span class="nm">mdocml</span> is to deprecate <a
					href="http://www.gnu.org/software/groff/" class="external">groff</a>, the GNU roff implementation, for
					displaying -mdoc pages whilst providing token support for -man.
					</p>

					<p>
					Why?  groff amounts to over 5 MB of source code, most of which is C++ and all of which is GPL.  It runs
					slowly, produces uncertain output, and varies in operation from system to system.  mdocml strives to fix
					this (respectively small, C, ISC-licensed, fast and regular).
					</p>

					<p>
					The core of <span class="nm">mdocml</span> is composed of the <i>libmdoc</i> and <i>libman</i>
					validating compiler libraries.  Both are simple, fast libraries operating on memory buffers, so they may
					be used for a variety of front-ends (terminal-based, CGI and so on).  The primary front-end is <i>
					mandoc</i>, which formats manuals for display on the terminal.
					</p>
				</td>
			</tr>
			<tr>
				<td>
					<h1>
					DOWNLOADS
					</h1>

					<p>
					Sources correctly build and install on FreeBSD, OpenBSD, NetBSD and Linux operating systems, tested
					variously on i386, AMD64, alpha, and others.  The most current version is <span
					class="attn">@VERSION@</span>, dated <span class="attn">@VDATE@</span>.  A full <a
					href="ChangeLog.txt">ChangeLog</a> is written with each release.
					</p>

					<h2>
					Current
					</h2>

					<table width="100%">
					<col width="200">
					<col>
					<tbody>
						<tr>
							<td>Source archive</td>
							<td>
							<a href="/snapshots/mdocml.tar.gz">/snapshots/mdocml.tar.gz</a> 
							(<a href="/snapshots/mdocml.md5">md5</a>)
							</td>
						</tr>
					</tbody>
					</table>

					<h2>
					Downstream
					</h2>

					<table width="100%">
					<col width="200">
					<col>
					<tbody>
						<tr>
							<td>FreeBSD</td>
							<td>
							<a href="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/" 
								class="external">ports/textproc/mdocml</a>
							</td>
						</tr>
						<tr>
							<td>NetBSD</td>
							<td>
							<a href="http://cvsweb.netbsd.org/bsdweb.cgi/pkgsrc/textproc/mdocml/"
								class="external">pkgsrc/textproc/mdocml</a> 
							</td>
						</tr>
						<tr>
							<td>OpenBSD</td>
							<td>
							<a href="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/"
								class="external">src/usr.bin/mandoc</a> 
							</td>
						</tr>
					</tbody>
					</table>

					<h2>
					Historical
					</h2>

					<table width="100%">
					<col width="200">
					<col>
					<tbody>
						<tr>
							<td>Source archive</td>
							<td>
							<a href="/snapshots/">/snapshots/</a> 
							</td>
						</tr>
					</tbody>
					</table>
				</td>
			</tr>
			<tr>
				<td>
					<h1>
					DOCUMENTATION
					</h1>

					<p>
					These manuals are generated automatically (with <a href="mandoc.1.html">mandoc(1)</a> -Thtml) and refer to the
					current snapshot.
					</p>

					<table width="100%">
					<col width="200">
					<col>
					<tbody>
						<tr>
							<td><a href="mandoc.1.html">mandoc(1)</a> [<a href="mandoc.1.txt">text</a>]</td>
							<td>format and display UNIX manuals</td>
						</tr>
						<tr>
							<td><a href="mandoc_char.7.html">mandoc_char(7)</a> [<a href="mandoc_char.7.txt">text</a>]</td>
							<td>mandoc special characters</td>
						</tr>
						<tr>
							<td><a href="mdoc.7.html">mdoc(7)</a> [<a href="mdoc.7.txt">text</a>]</td>
							<td>mdoc language reference</td>
						</tr>
						<tr>
							<td><a href="man.7.html">man(7)</a> [<a href="man.7.txt">text</a>]</td>
							<td>man language reference</td>
						</tr>
						<tr>
							<td><a href="manuals.7.html">manuals(7)</a> [<a href="manuals.7.txt">text</a>]</td>
							<td>a guide to writing UNIX manuals</td>
						</tr>
						<tr>
							<td><a href="mdoc.3.html">mdoc(3)</a> [<a href="mdoc.3.txt">text</a>]</td>
							<td>mdoc macro compiler library</td>
						</tr>
						<tr>
							<td><a href="man.3.html">man(3)</a> [<a href="man.3.txt">text</a>]</td>
							<td>man macro compiler library</td>
						</tr>
					</tbody>
					</table>
				</td>
			</tr>
			<tr>
				<td>
					<h1>
					CONTACT
					</h1>

					<p>
					For all issues related to <span class="nm">mdocml</span>, contact Kristaps D&#382;onsons, kris<a
					class="external"
					href="http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&amp;c=sb5E6ulipc-eTnpTVqI-BQ=="
					title="Reveal this e-mail address">...</a>@kth.se.
					</p>

					<p>
					If you want to receive a semi-automated mail-out of new releases, then please write with a message
					subject of <i>subscribe mdocml</i> (or <i>unsubscribe mdocml</i>).
					</p>
				</td>
			</tr>
			<tr>
				<td>
					<div class="foot">
						Copyright &#169; 2008, 2009 Kristaps D&#382;onsons, $Date$
					</div>
				</td>
			</tr>
		</tbody>
	</table>
	</body>
</html>