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

File: [cvsweb.bsd.lv] / mandoc / Attic / index.sgml (download)

Revision 1.135, Tue Aug 16 22:21:04 2011 UTC (10 years, 3 months ago) by kristaps
Branch: MAIN
CVS Tags: VERSION_1_11_6
Changes since 1.134: +61 -54 lines

Added generation of Universal binary.  Fixed up index.sgml to be shorter
and more expressive.

<!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">
		<LINK REL="stylesheet" HREF="index.css" TYPE="text/css" MEDIA="all">
		<TITLE>mdocml | mdoc macro compiler</TITLE>
	</HEAD>
	<BODY>
		<P CLASS="head">
			<B>mdocml</B> &#8211; mdoc macro compiler,
			current version <SPAN CLASS="attn">@VERSION@</SPAN> (<SPAN class="attn">@VDATE@</SPAN>)
		</P>
		<H1>
			<A NAME="description">Description</A>
		</H1>
		<P>
			<SPAN CLASS="nm">mdocml</SPAN> is a suite of tools compiling <I><A HREF="mdoc.7.html">mdoc</A></I>, the roff macro
			package of choice for BSD manual pages, and <I><A HREF="man.7.html">man</A></I>, 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 troff implementation, for displaying <I>mdoc</I>
			pages whilst providing token support for <I>man</I>.
		</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, <A
			CLASS="external" HREF="http://www.isc.org/software/license">ISC</A>-licensed, fast and regular).
		</P>
		<P>
			<SPAN CLASS="nm">mdocml</SPAN> consists of the <A HREF="mandoc.3.html">libmandoc</A> validating compiler and <A
			HREF="mandoc.1.html">mandoc</A>, which interfaces with the compiler library to format output for UNIX terminals (with
			support for wide-character locales), XHTML, HTML, PostScript, and PDF.  
			It also includes <A HREF="preconv.1.html">preconv</A>, for recoding multibyte manuals; and <A
			HREF="mandocdb.8.html">mandocdb</A>, for indexing manuals.
			It is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv</A> project.  
		</P>
		<P>
			<I>Disambiguation</I>: <SPAN CLASS="nm">mdocml</SPAN> is often referred to by its installed binary, <Q>mandoc</Q>.
		</P>
		<H1>
			<A NAME="sources">Sources</A>
		</H1>
		<P>
			<SPAN CLASS="nm">mdocml</SPAN> is in plain-old ANSI C and should build and run on any modern system.
			To build and install into <I>/usr/local/</I>, just run <CODE>make install</CODE>.
			Be aware: if you have an existing groff installation, this may overwrite its <B>preconv</B> binary.  
			The <A HREF="mandocdb.8.html">mandocdb</A> utility is not yet linked to the build; please <A HREF="#contact">contact
			us</A> if you plan to use it.
		</P>
		<TABLE WIDTH="100%" SUMMARY="Current Sources">
			<COL WIDTH="200">
			<COL>
			<TBODY>
				<TR>
					<TD>Current</TD>
					<TD>
					<A HREF="/snapshots/mdocml.tar.gz">/snapshots/mdocml.tar.gz</A> (<A HREF="/snapshots/mdocml.md5">md5</A>)
					</TD>
				</TR>
				<TR>
					<TD>Archives</TD>
					<TD>
					<A HREF="/snapshots/">/snapshots/</A> 
					</TD>
				</TR>
				<TR>
					<TD>Online Repository</TD>
					<TD>
					<A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A>
					</TD>
				</TR>
			</TBODY>
		</TABLE>
		<H1>
			<A NAME="binaries">Binaries</A>
		</H1>
		<P>
			Binary archives consist of pre-compiled binaries, manuals, and other necessary files.
			Universal (Mac OS X) binaries are compiled for the PCC, i386, and x86_64 architectures.
			Windows binaries are compiled with <A CLASS="external" HREF="http://www.mingw.org">MingW</A> for the 32-bit (i686) and
			64-bit (x86_64) architectures.
		</P>
		<TABLE WIDTH="100%" SUMMARY="Current Binaries">
			<COL WIDTH="200">
			<COL>
			<TBODY>
				<TR>
					<TD>Windows 32-bit</TD>
					<TD>
					<A HREF="/binaries/mdocml-win32.zip">/binaries/mdocml-win32.zip</A>
					</TD>
				</TR>
				<TR>
					<TD>Windows 64-bit</TD>
					<TD>
					<A HREF="/binaries/mdocml-win64.zip">/binaries/mdocml-win64.zip</A>
					</TD>
				</TR>
				<TR>
					<TD>Mac OS X Universal Binary</TD>
					<TD>
					<A HREF="/binaries/mdocml-macosx.zip">/binaries/mdocml-macosx.zip</A>
					</TD>
				</TR>
				<TR>
					<TD>Archives</TD>
					<TD>
					<A HREF="/binaries/">/binaries/</A> 
					</TD>
				</TR>
			</TBODY>
		</TABLE>
		<H1>
			Downstream
		</H1>
		<P>
			Several systems come bundled with <SPAN CLASS="nm">mdocml</SPAN> utilities.
			If your system does not appear below, the maintainers have not contacted me and it should not be considered
			<Q>official</Q>.
			Please <A HREF="#contact">contact us</A> if you plan on maintaining a downstream version!
		</P>
		<TABLE WIDTH="100%" SUMMARY="Downstream Sources">
			<COL WIDTH="200">
			<COL>
			<TBODY>
				<TR>
					<TD>DragonFly BSD</TD>
					<TD>
					<A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc"
						CLASS="external">usr.bin/mandoc</A>
					</TD>
				</TR>
				<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/src/external/bsd/mdocml/"
						CLASS="external">src/external/bsd/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>
		<H1>
			<A NAME="documentation">Documentation</A>
		</H1>
		<P>
			These manuals are generated automatically and refer to the current release.
			They are the authoritative documentation for the <SPAN CLASS="nm">mdocml</SPAN> system.
		</P>

		<TABLE WIDTH="100%" SUMMARY="Documentation">
			<COL WIDTH="200">
			<COL>
			<TBODY>
				<TR>
					<TD VALIGN="top"><A HREF="mandoc.1.html">mandoc(1)</A></TD>
					<TD VALIGN="top">
						format and display UNIX manuals
						<SMALL>
							(<A HREF="mandoc.1.txt">text</A> | 
							<A HREF="mandoc.1.xhtml">xhtml</A> |
							<A HREF="mandoc.1.pdf">pdf</A> |
							<A HREF="mandoc.1.ps">postscript</A>)
						</SMALL>
					</TD>
				</TR>
				<TR>
					<TD VALIGN="top"><A HREF="mandocdb.8.html">mandocdb(8)</A></TD>
					<TD VALIGN="top">
						index UNIX manuals
						<SMALL>
							(<A HREF="mandocdb.8.txt">text</A> | 
							<A HREF="mandocdb.8.xhtml">xhtml</A> |
							<A HREF="mandocdb.8.pdf">pdf</A> |
							<A HREF="mandocdb.8.ps">postscript</A>)
						</SMALL>
					</TD>
				</TR>
				<TR>
					<TD VALIGN="top"><A HREF="preconv.1.html">preconv(1)</A></TD>
					<TD VALIGN="top">
						recode multibyte UNIX manuals
						<SMALL>
							(<A HREF="preconv.1.txt">text</A> | 
							<A HREF="preconv.1.xhtml">xhtml</A> |
							<A HREF="preconv.1.pdf">pdf</A> |
							<A HREF="preconv.1.ps">postscript</A>)
						</SMALL>
					</TD>
				</TR>
				<TR>
					<TD VALIGN="top"><A HREF="mandoc.3.html">mandoc(3)</A></TD>
					<TD VALIGN="top">
						mandoc macro compiler library
						<SMALL>
							(<A HREF="mandoc.3.txt">text</A> | 
							<A HREF="mandoc.3.xhtml">xhtml</A> |
							<A HREF="mandoc.3.pdf">pdf</A> |
							<A HREF="mandoc.3.ps">postscript</A>)
						</SMALL>
					</TD>
				</TR>
				<TR>
					<TD VALIGN="top"><A HREF="man.7.html">man(7)</A></TD>
					<TD VALIGN="top">
						man language reference
						<SMALL>
							(<A HREF="man.7.txt">text</A> | 
							<A HREF="man.7.xhtml">xhtml</A> |
							<A HREF="man.7.pdf">pdf</A> |
							<A HREF="man.7.ps">postscript</A>)
						</SMALL>
					</TD>
				</TR>
				<TR>
					<TD VALIGN="top"><A HREF="eqn.7.html">eqn(7)</A></TD>
					<TD VALIGN="top">
						eqn-mandoc language reference
						<SMALL>
							(<A HREF="eqn.7.txt">text</A> | 
							<A HREF="eqn.7.xhtml">xhtml</A> |
							<A HREF="eqn.7.pdf">pdf</A> |
							<A HREF="eqn.7.ps">postscript</A>)
						</SMALL>
					</TD>
				</TR>
				<TR>
					<TD VALIGN="top"><A HREF="mandoc_char.7.html">mandoc_char(7)</A></TD>
					<TD VALIGN="top">
						mandoc special characters
						<SMALL>
							(<A HREF="mandoc_char.7.txt">text</A> | 
							<A HREF="mandoc_char.7.xhtml">xhtml</A> |
							<A HREF="mandoc_char.7.pdf">pdf</A> |
							<A HREF="mandoc_char.7.ps">postscript</A>)
						</SMALL>
					</TD>
				</TR>
				<TR>
					<TD VALIGN="top"><A HREF="mdoc.7.html">mdoc(7)</A></TD>
					<TD VALIGN="top">
						mdoc language reference
						<SMALL>
							(<A HREF="mdoc.7.txt">text</A> | 
							<A HREF="mdoc.7.xhtml">xhtml</A> |
							<A HREF="mdoc.7.pdf">pdf</A> |
							<A HREF="mdoc.7.ps">postscript</A>)
						</SMALL>
					</TD>
				</TR>
				<TR>
					<TD VALIGN="top"><A HREF="roff.7.html">roff(7)</A></TD>
					<TD VALIGN="top">
						roff-mandoc language reference
						<SMALL>
							(<A HREF="roff.7.txt">text</A> | 
							<A HREF="roff.7.xhtml">xhtml</A> |
							<A HREF="roff.7.pdf">pdf</A> |
							<A HREF="roff.7.ps">postscript</A>)
						</SMALL>
					</TD>
				</TR>
				<TR>
					<TD VALIGN="top"><A HREF="tbl.7.html">tbl(7)</A></TD>
					<TD VALIGN="top">
						tbl-mandoc language reference
						<SMALL>
							(<A HREF="tbl.7.txt">text</A> | 
							<A HREF="tbl.7.xhtml">xhtml</A> |
							<A HREF="tbl.7.pdf">pdf</A> |
							<A HREF="tbl.7.ps">postscript</A>)
						</SMALL>
					</TD>
				</TR>
			</TBODY>
		</TABLE>
		<H1>
			<A NAME="contact">Contact</A>
		</H1>
		<P>
			Use the mailing lists for bug-reports, patches, questions, etc. (these require subscription).  Please check the
			<A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/TODO?cvsroot=mdocml">TODO</A> for known issues
			before posting.  Beyond that, contact Kristaps at <A
			HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&amp;c=Q2DBUt401ePlSeupJFrq_Q==" TITLE="Reveal
			this e-mail address">kris...</A>@bsd.lv.
		</P>
		<TABLE WIDTH="100%" SUMMARY="Mailing Lists">
			<COL WIDTH="200">
			<COL>
			<TBODY>
				<TR>
					<TD>
						disc<A CLASS="external" TITLE="Reveal this e-mail address"
						HREF="http://www.google.com/recaptcha/mailhide/d?k=01KQ80PFH5n3BBNpF5Gs4sRg==&amp;c=EV1QytpQqTHSItc2IXvZyocgYLPnG5K0JKw_gwMC9yc=">...</A>@mdocml.bsd.lv
					</TD>
					<TD>
						bug-reports, general questions, and announcements 
						<SMALL>(<A HREF="/archives/discuss/summary.html">archive</A>)</SMALL>
					</TD>
				</TR>
				<TR>
					<TD>
						tec<A CLASS="external" TITLE="Reveal this e-mail address"
						HREF="http://www.google.com/recaptcha/mailhide/d?k=01qDX_iV0RlUOarEvb6mR28g==&amp;c=gRXsTjza0NNCFPaYu-Taj2tF0pmYZSc90EZkFkhkxgo=">...</A>@mdocml.bsd.lv
					</TD>
					<TD>
						patches and system discussions 
						<SMALL>(<A HREF="/archives/tech/summary.html">archive</A>)</SMALL>
					</TD>
				</TR>
				<TR>
					<TD>
						sou<A CLASS="external" TITLE="Reveal this e-mail address"
						HREF="http://www.google.com/recaptcha/mailhide/d?k=01prQrAZhhl2EbIwVcRfABsQ==&amp;c=KtTW4Yic9xk-8g40KzJoca4fR3MYXv28g8NC6OQV-T8=">...</A>@mdocml.bsd.lv
					</TD>
					<TD>
						source commit messages 
						<SMALL>(<A HREF="/archives/source/summary.html">archive</A>)</SMALL>
					</TD>
				</TR>
			</TBODY>
		</TABLE>
		<H1>
			<A NAME="news">News</A>
		</H1>
		<P CLASS="news">
			16-08-2011: version 1.11.6
		</P>
		<P>
			Handling of <B>tr</B> macro in <A HREF="roff.7.html">roff</A> implemented.  This makes Perl documentation much more
			readable.  Hyphenation is also now enabled in <A HREF="man.7.html">man</A> format documents.  Many other general
			improvements have been implemented.  Furthermore, a 64-bit Windows binary is now available at <A
			HREF="/binaries/mdocml-win64.zip">mdocml-win64.zip</A> and a Mac OS X universal binary is available at <A
			HREF="/binaries/mdocml-macosx.zip">mdocml-macosx.zip</A>.
		</P>
		<P CLASS="news">
			24-07-2011: version 1.11.5
		</P>
		<P>
			Significant <A HREF="eqn.7.html">eqn</A> improvements.  <SPAN CLASS="nm">mdocml</SPAN> can now parse arbitrary eqn input
			(although few GNU extensions are accepted, nor is mixing low-level roff with eqn).  See the <A HREF="eqn.7.html">eqn</A>
			manual for details.  For the time being, equations are rendered as simple in-line text.  The equation parser satisfies
			the language specified in the <A CLASS="external" HREF="http://www.kohala.com/start/troff/v7man/eqn/eqn2e.ps">Second
			Edition User's Guide</A>.
		</P>
		<P>
			This is also the first release featuring a distributed Windows binary, available at <A
			HREF="/binaries/mdocml-win32.zip">/binaries/mdocml-win32.zip</A>.
		</P>
		<P CLASS="news">
			12-07-2011: version 1.11.4
		</P>
		<P>
			Bug-fixes and clean-ups across all systems, especially in <INS><A HREF="mandocdb.8.html">mandocdb</A></INS> <DEL>makewhatis</DEL> (note: still not
			connected to the general build and must be compiled with <INS><CODE>make mandocdb</CODE></INS> <DEL><CODE>make makewhatis</CODE></DEL>) and the <A
			HREF="man.7.html">man</A> parser.  This release was significantly assisted by participants in <A CLASS="external"
			HREF="http://www.openbsd.org">OpenBSD</A>'s c2k11.  Thanks!
		</P>
		<P>
			See <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/index.sgml?cvsroot=mdocml">cvsweb</A> for
			historical notes.
		</P>
		<P CLASS="foot">
			<SMALL>
				Copyright &#169; 2008&#8211;2011 
				<A CLASS="external" HREF="http://kristaps.bsd.lv">Kristaps Dzonsons</A>, 
				$Date: 2011/08/16 22:21:04 $
			</SMALL>
		</P>
	</BODY>
</HTML>