summaryrefslogblamecommitdiffstats
path: root/index.sgml
blob: 2e60abeb2bf98e3be12961f158820dbb2dfc7f4b (plain) (tree)
1
2
3
4
5
6
7
8
9
                                                                                          


                                                                                   
                                                                                    
                                                           

               
                                











                                                                                                      
                    
                    
                                                             
                     






                                                                                                                                                      




                                                                                                                                                

                                                                                                                                       

                                                                                                                                             

                                                                                                               
                                                                                         

                                                                                                                                                
                                                                                               
                    


                                                                                                                                          
                    
                                                     
                     
                   





                                                                                                                                              
                    
                    
                                                       
                     





                                                                                                                                              
                    
                                  
                     





                                                                                                                                   
                                                                 
                                         































                                                                                                                        
                    
                                                                 
                     
                   

                                                                                                               
                    
 
                                                            
                                         


                                    
                                                                                                     
                                                         




                                                                                             


                                             
                                                                                                       
                                                         




                                                                                              


                                             









                                                                                                   


                                                                                                     


                                                                                             
                                                                                      


                                             


                                                                                                   


                                                                                            
                                                                                     





                                                                                             


                                                                                         
                                                                                  





                                                                                             


                                                                                         
                                                                                  





                                                                                                             


                                                                                                 
                                                                                          





                                                                                               


                                                                                          
                                                                                   





                                                                                               


                                                                                          
                                                                                   





                                                                                             


                                                                                         
                                                                                  

                                             









                                                                                                       

                                
                    
                                                     
                     
                   
                                                                                                         
                                                                                                                   

                                                                                                                                                               

                                                                
                                                            
                                         








                                                                                                                                                                                                       
                                                                                          








                                                                                                                                                                                                       
                                                                                       








                                                                                                                                                                                                       
                                                                                         



                                             
                    
                                               
                     
                                
                                                  

                    



                                                                                                                                              

                    
                                                                                                                                             


                                                                                                                                               
                                                                                                               





                                                                                                                                              






                                                                                                                                                

                                
                                                  


                                                                                                                                      
                                                                                                                                                           

                                




                                                                                                                                           


                                                                                                                                 
                    



                                                                                                                  
                                




                                                                                                         
                    

               
<!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 @VERSION@ (@VDATE@)
		</P>
		<P CLASS="subhead">
			Sources: <A HREF="/snapshots/mdocml.tar.gz">current</A>,
			<A HREF="/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A>
			(<A HREF="/snapshots/">archives</A>)
			|
			Binaries: <A
			HREF="/binaries/mdocml-win32.zip">windows 32-bit</A>, <A
			HREF="/binaries/mdocml-win64.zip">windows 64-bit</A>, <A
			HREF="/binaries/mdocml-macosx.zip">mac os x</A>
			(<A HREF="/binaries/">archives</A>)
		</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; 
			<A HREF="demandoc.1.html">demandoc</A>, for emitting only text parts of manuals;
			<A HREF="mandocdb.8.html">mandocdb</A>, for indexing manuals; and
			<A HREF="apropos.1.html">apropos</A>, for semantic search of manual content (both <B>mandocdb</B> and <B>apropos</B> are
			still experimental).
			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>
		<H2>
			<A NAME="sources">Sources</A>
		</H2>
		<P>
			<SPAN CLASS="nm">mdocml</SPAN> is in plain-old ANSI C and should build and run on any modern system; however, you'll
			need <A HREF="http://www.oracle.com/technetwork/database/berkeleydb/overview/index.html">libdb</A> to build <A
			HREF="apropos.1.html">apropos</A> and <A HREF="mandocdb.8.html">mandocdb</A> (this is installed by default on BSD UNIX
			systems &mdash; see the <I>Makefile</I> if you're running Linux).  To build and install into <I>/usr/local/</I>, just
			run <CODE>make install</CODE>.  Be careful: the <B>preconv</B> and <B>apropos</B> binary names are usually taken by
			existing utilities.
		</P>
		<H2>
			<A NAME="binaries">Binaries</A>
		</H2>
		<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>
		<H2>
			Downstream
		</H2>
		<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="175">
			<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="175">
			<COL>
			<TBODY>
				<TR>
					<TD VALIGN="top"><A HREF="apropos.1.html">apropos(1)</A></TD>
					<TD VALIGN="top">
						search the manual page database
							(<A HREF="apropos.1.txt">text</A> | 
							<A HREF="apropos.1.xhtml">xhtml</A> |
							<A HREF="apropos.1.pdf">pdf</A> |
							<A HREF="apropos.1.ps">ps</A>)
					</TD>
				</TR>
				<TR>
					<TD VALIGN="top"><A HREF="demandoc.1.html">demandoc(1)</A></TD>
					<TD VALIGN="top">
						emit only text of UNIX manuals
							(<A HREF="demandoc.1.txt">text</A> | 
							<A HREF="demandoc.1.xhtml">xhtml</A> |
							<A HREF="demandoc.1.pdf">pdf</A> |
							<A HREF="demandoc.1.ps">ps</A>)
					</TD>
				</TR>
				<TR>
					<TD VALIGN="top"><A HREF="mandoc.1.html">mandoc(1)</A></TD>
					<TD VALIGN="top">
						format and display UNIX manuals
							(<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">ps</A>)
					</TD>
				</TR>
				<TR>
					<TD VALIGN="top"><A HREF="preconv.1.html">preconv(1)</A></TD>
					<TD VALIGN="top">
						recode multibyte UNIX manuals
							(<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">ps</A>)
					</TD>
				</TR>
				<TR>
					<TD VALIGN="top"><A HREF="mandoc.3.html">mandoc(3)</A></TD>
					<TD VALIGN="top">
						mandoc macro compiler library
							(<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">ps</A>)
					</TD>
				</TR>
				<TR>
					<TD VALIGN="top"><A HREF="man.7.html">man(7)</A></TD>
					<TD VALIGN="top">
						man language reference
							(<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">ps</A>)
					</TD>
				</TR>
				<TR>
					<TD VALIGN="top"><A HREF="eqn.7.html">eqn(7)</A></TD>
					<TD VALIGN="top">
						eqn-mandoc language reference
							(<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">ps</A>)
					</TD>
				</TR>
				<TR>
					<TD VALIGN="top"><A HREF="mandoc_char.7.html">mandoc_char(7)</A></TD>
					<TD VALIGN="top">
						mandoc special characters
							(<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">ps</A>)
					</TD>
				</TR>
				<TR>
					<TD VALIGN="top"><A HREF="mdoc.7.html">mdoc(7)</A></TD>
					<TD VALIGN="top">
						mdoc language reference
							(<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">ps</A>)
					</TD>
				</TR>
				<TR>
					<TD VALIGN="top"><A HREF="roff.7.html">roff(7)</A></TD>
					<TD VALIGN="top">
						roff-mandoc language reference
							(<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">ps</A>)
					</TD>
				</TR>
				<TR>
					<TD VALIGN="top"><A HREF="tbl.7.html">tbl(7)</A></TD>
					<TD VALIGN="top">
						tbl-mandoc language reference
							(<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">ps</A>)
					</TD>
				</TR>
				<TR>
					<TD VALIGN="top"><A HREF="mandocdb.8.html">mandocdb(8)</A></TD>
					<TD VALIGN="top">
						index UNIX manuals
							(<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">ps</A>)
					</TD>
				</TR>
			</TBODY>
		</TABLE>
		<H1>
			<A NAME="contact">Contact</A>
		</H1>
		<P>
			Use the mailing lists for bug-reports, patches, questions, etc.  Please check the
			<A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/TODO?cvsroot=mdocml">TODO</A> for known issues
			before posting.  All lists are subscription-only: send a blank e-mail to the listed address to subscribe.  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="175">
			<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 
						(<A HREF="/archives/discuss/">archive</A>)
					</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 
						(<A HREF="/archives/tech/">archive</A>)
					</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 
						(<A HREF="/archives/source/">archive</A>)
					</TD>
				</TR>
			</TBODY>
		</TABLE>
		<H1>
			<A NAME="news">News</A>
		</H1>
		<P CLASS="news">
			08-10-2011: version 1.12.0
		</P>
		<P>
			This version features a new, work-in-progress <A HREF="mandoc.1.html">mandoc</A> output mode: -<B>Tman</B>.  This mode
			allows a system maintainer to distribute <A HREF="man.7.html">man</A> media for older systems that may not natively
			support <A HREF="mdoc.7.html">mdoc</A>, such as old Solaris systems.
			The -<B>Ofragment</B> option was added to <A HREF="mandoc.1.html">mandoc</A>'s -<B>Thtml</B> and -<B>Txhtml</B> modes.
		</P>
		<P>
			While adding features, an <A HREF="apropos.1.html">apropos</A> utility has been merged from the mandoc-tools sandbox.
			This interfaces with <A HREF="mandocdb.8.html">mandocdb</A> for semantic search of manual content.  <A
			HREF="apropos.1.html">apropos</A> is different from the traditional <B>apropos</B> primarily in allowing keyword search
			(such as for functions, utilities, etc.) and regular expressions.
			Note that the calling syntax for <B>apropos</B> is likely to change as it settles down.
		</P>
		<P>
			In documentation news, the <A HREF="mdoc.7.html">mdoc</A> and <A HREF="man.7.html">man</A> manuals have been made
			considerably more readable by adding <I>MACRO OVERVIEW</I> sections, by moving the gory details of the <I>LANGUAGE
			SYNTAX</I> to the <A HREF="roff.7.html">roff</A> manual, and by moving the very technical <I>MACRO SYNTAX</I> sections
			down to the bottom of the page.
		</P>
		<P>
			Furthermore, for <A HREF="tbl.7.html">tbl</A>, the -<B>Tascii</B> mode horizontal spacing of tables was rewritten
			completely.  It is now compatible with <A HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A>, both
			with and without frames and rulers.  Nesting of indented blocks is now supported in <A HREF="man.7.html">man</A>, and
			several bugs were fixed regarding indentation and alignment.  The page headers in <A HREF="mdoc.7.html">mdoc</A> are now
			nicer for very long titles.
		</P>
		<P CLASS="news">
			02-09-2011: version 1.11.7
		</P>
		<P>
			Added <A HREF="demandoc.1.html">demandoc</A> utility for stripping away macros and escapes.  This replaces the
			historical <CODE>deroff</CODE> utility.  Also improved the <A HREF="mdoc.7.html">mdoc</A> and <A HREF="man.7.html">man</A> manuals.
		</P>
		<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>
			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$
			</SMALL>
		</P>
	</BODY>
</HTML>