version 1.100, 2011/01/04 10:29:41 |
version 1.149, 2011/11/29 11:21:47 |
|
|
<HTML> |
<HTML> |
<HEAD> |
<HEAD> |
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8"> |
<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"> |
<LINK REL="stylesheet" HREF="index.css" TYPE="text/css" MEDIA="all"> |
<TITLE>mdocml | mdoc macro compiler</TITLE> |
<TITLE>mdocml | UNIX manpage compiler</TITLE> |
</HEAD> |
</HEAD> |
<BODY> |
<BODY> |
<TABLE CLASS="frame" SUMMARY="[frame]"> |
<P CLASS="head"> |
<COL WIDTH="100%"> |
<B>mdocml</B> – UNIX manpage compiler, current version @VERSION@ (@VDATE@) |
<TBODY> |
</P> |
<TR> |
<P CLASS="subhead"> |
<TD> |
Sources: <A HREF="/snapshots/mdocml.tar.gz">current</A>, |
<DIV CLASS="head"> |
<A HREF="/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A> |
<B>mdocml</B> – mdoc macro compiler |
(<A HREF="/snapshots/">archives</A>) |
</DIV> |
| |
</TD> |
Binaries: <A |
</TR> |
HREF="/binaries/mdocml-win32.zip">windows 32-bit</A>, <A |
<TR> |
HREF="/binaries/mdocml-win64.zip">windows 64-bit</A>, <A |
<TD VALIGN="top"> |
HREF="/binaries/mdocml-macosx.zip">mac os x</A> |
<H1> |
(<A HREF="/binaries/">archives</A>) |
<A NAME="description">DESCRIPTION</A> |
</P> |
</H1> |
<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> and <A HREF="whatis.1.html">whatis</A>, for semantic search of manual content. |
|
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>, <A HREF="whatis.1.html">whatis</A>, and <A HREF="mandocdb.8.html">mandocdb</A> (this |
|
is installed by default on BSD UNIX systems — 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>, <B>apropos</B>, |
|
and <B>whatis</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> |
|
<TR> |
|
<TD>pkgsrc</TD> |
|
<TD> |
|
<A HREF="http://pkgsrc.se/textproc/mdocml" CLASS="external">textproc/mdocml</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> |
|
|
<P> |
<TABLE WIDTH="100%" SUMMARY="Documentation"> |
<SPAN CLASS="nm">mdocml</SPAN> is a suite of tools compiling <Q>-<A HREF="mdoc.7.html">mdoc</A></Q>, the |
<COL WIDTH="175"> |
roff macro package of choice for BSD manual pages, and <Q>-<A HREF="man.7.html">man</A></Q>, the |
<COL> |
predominant historical package for UNIX manuals. The mission of <SPAN CLASS="nm">mdocml</SPAN> is to |
<TBODY> |
deprecate <A HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A>, the GNU troff |
<TR> |
implementation, for displaying -mdoc pages whilst providing token support for -man. |
<TD VALIGN="top"><A HREF="apropos.1.html">apropos(1)</A></TD> |
</P> |
<TD VALIGN="top"> |
|
search the manual page database |
<P> |
(<A HREF="apropos.1.txt">text</A> | |
Why? groff amounts to over 5 MB of source code, most of which is C++ and all of which is GPL. It runs |
<A HREF="apropos.1.xhtml">xhtml</A> | |
slowly, produces uncertain output, and varies in operation from system to system. mdocml strives to fix |
<A HREF="apropos.1.pdf">pdf</A> | |
this (respectively small, C, <A CLASS="external" |
<A HREF="apropos.1.ps">ps</A>) |
HREF="http://www.isc.org/software/license">ISC</A>-licensed, fast and regular). |
</TD> |
</P> |
</TR> |
|
<TR> |
<P> |
<TD VALIGN="top"><A HREF="demandoc.1.html">demandoc(1)</A></TD> |
<SPAN CLASS="nm">mdocml</SPAN> consists of the <A HREF="mdoc.3.html">libmdoc</A>, <A |
<TD VALIGN="top"> |
HREF="man.3.html">libman</A>, and <A HREF="roff.3.html">libroff</A> validating compilers; and <A |
emit only text of UNIX manuals |
HREF="mandoc.1.html">mandoc</A>, which interfaces with the compiler libraries to format output for UNIX |
(<A HREF="demandoc.1.txt">text</A> | |
terminals, XHTML, HTML, PostScript, and PDF. <SPAN CLASS="nm">mdocml</SPAN> is a <A CLASS="external" |
<A HREF="demandoc.1.xhtml">xhtml</A> | |
HREF="http://bsd.lv/">BSD.lv</A> project. |
<A HREF="demandoc.1.pdf">pdf</A> | |
</P> |
<A HREF="demandoc.1.ps">ps</A>) |
|
</TD> |
<P> |
</TR> |
<I>Disambiguation</I>: <SPAN CLASS="nm">mdocml</SPAN> is often referred to by its installed binary, |
<TR> |
<Q>mandoc</Q>. |
<TD VALIGN="top"><A HREF="mandoc.1.html">mandoc(1)</A></TD> |
</P> |
<TD VALIGN="top"> |
</TD> |
format and display UNIX manuals |
</TR> |
(<A HREF="mandoc.1.txt">text</A> | |
<TR> |
<A HREF="mandoc.1.xhtml">xhtml</A> | |
<TD> |
<A HREF="mandoc.1.pdf">pdf</A> | |
<H1> |
<A HREF="mandoc.1.ps">ps</A>) |
<A NAME="sources">SOURCES</A> |
</TD> |
</H1> |
</TR> |
|
<TR> |
<P> |
<TD VALIGN="top"><A HREF="preconv.1.html">preconv(1)</A></TD> |
<SPAN CLASS="nm">mdocml</SPAN> is architecture- and system-neutral, written in plain-old C. The most |
<TD VALIGN="top"> |
current version is <SPAN CLASS="attn">@VERSION@</SPAN>, dated <SPAN class="attn">@VDATE@</SPAN>. A full |
recode multibyte UNIX manuals |
<A HREF="ChangeLog.html">ChangeLog</A> (<A HREF="ChangeLog.txt">txt</A>) is written with each release. |
(<A HREF="preconv.1.txt">text</A> | |
</P> |
<A HREF="preconv.1.xhtml">xhtml</A> | |
|
<A HREF="preconv.1.pdf">pdf</A> | |
<H2> |
<A HREF="preconv.1.ps">ps</A>) |
Current |
</TD> |
</H2> |
</TR> |
|
<TR> |
<TABLE WIDTH="100%" SUMMARY="Current Sources"> |
<TD VALIGN="top"><A HREF="whatis.1.html">whatis(1)</A></TD> |
<COL WIDTH="175"> |
<TD VALIGN="top"> |
<COL> |
search the manual page database |
<TBODY> |
(<A HREF="whatis.1.txt">text</A> | |
<TR> |
<A HREF="whatis.1.xhtml">xhtml</A> | |
<TD>Source archive</TD> |
<A HREF="whatis.1.pdf">pdf</A> | |
<TD> |
<A HREF="whatis.1.ps">ps</A>) |
<A HREF="/snapshots/mdocml.tar.gz">/snapshots/mdocml.tar.gz</A> |
</TD> |
(<A HREF="/snapshots/mdocml.md5">md5</A>) |
</TR> |
</TD> |
<TR> |
</TR> |
<TD VALIGN="top"><A HREF="mandoc.3.html">mandoc(3)</A></TD> |
<TR> |
<TD VALIGN="top"> |
<TD>Online source</TD> |
mandoc macro compiler library |
<TD> |
(<A HREF="mandoc.3.txt">text</A> | |
<A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A> |
<A HREF="mandoc.3.xhtml">xhtml</A> | |
</TD> |
<A HREF="mandoc.3.pdf">pdf</A> | |
</TR> |
<A HREF="mandoc.3.ps">ps</A>) |
</TBODY> |
</TD> |
</TABLE> |
</TR> |
|
<TR> |
<H2> |
<TD VALIGN="top"><A HREF="man.7.html">man(7)</A></TD> |
Downstream |
<TD VALIGN="top"> |
</H2> |
man language reference |
|
(<A HREF="man.7.txt">text</A> | |
<TABLE WIDTH="100%" SUMMARY="Downstream Sources"> |
<A HREF="man.7.xhtml">xhtml</A> | |
<COL WIDTH="175"> |
<A HREF="man.7.pdf">pdf</A> | |
<COL> |
<A HREF="man.7.ps">ps</A>) |
<TBODY> |
</TD> |
<TR> |
</TR> |
<TD>DragonFly BSD</TD> |
<TR> |
<TD> |
<TD VALIGN="top"><A HREF="eqn.7.html">eqn(7)</A></TD> |
<A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc" |
<TD VALIGN="top"> |
CLASS="external">usr.bin/mandoc</A> |
eqn-mandoc language reference |
</TD> |
(<A HREF="eqn.7.txt">text</A> | |
</TR> |
<A HREF="eqn.7.xhtml">xhtml</A> | |
<TR> |
<A HREF="eqn.7.pdf">pdf</A> | |
<TD>FreeBSD</TD> |
<A HREF="eqn.7.ps">ps</A>) |
<TD> |
</TD> |
<A HREF="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/" |
</TR> |
CLASS="external">ports/textproc/mdocml</A> |
<TR> |
</TD> |
<TD VALIGN="top"><A HREF="mandoc_char.7.html">mandoc_char(7)</A></TD> |
</TR> |
<TD VALIGN="top"> |
<TR> |
mandoc special characters |
<TD>NetBSD</TD> |
(<A HREF="mandoc_char.7.txt">text</A> | |
<TD> |
<A HREF="mandoc_char.7.xhtml">xhtml</A> | |
<A HREF="http://cvsweb.netbsd.org/bsdweb.cgi/src/external/bsd/mdocml/" |
<A HREF="mandoc_char.7.pdf">pdf</A> | |
CLASS="external">src/external/bsd/mdocml</A> |
<A HREF="mandoc_char.7.ps">ps</A>) |
</TD> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
<TD>OpenBSD</TD> |
<TD VALIGN="top"><A HREF="mdoc.7.html">mdoc(7)</A></TD> |
<TD> |
<TD VALIGN="top"> |
<A HREF="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/" |
mdoc language reference |
CLASS="external">src/usr.bin/mandoc</A> |
(<A HREF="mdoc.7.txt">text</A> | |
</TD> |
<A HREF="mdoc.7.xhtml">xhtml</A> | |
</TR> |
<A HREF="mdoc.7.pdf">pdf</A> | |
</TBODY> |
<A HREF="mdoc.7.ps">ps</A>) |
</TABLE> |
</TD> |
|
</TR> |
<H2> |
<TR> |
Historical |
<TD VALIGN="top"><A HREF="roff.7.html">roff(7)</A></TD> |
</H2> |
<TD VALIGN="top"> |
|
roff-mandoc language reference |
<TABLE WIDTH="100%" SUMMARY="Archived Sources"> |
(<A HREF="roff.7.txt">text</A> | |
<COL WIDTH="175"> |
<A HREF="roff.7.xhtml">xhtml</A> | |
<COL> |
<A HREF="roff.7.pdf">pdf</A> | |
<TBODY> |
<A HREF="roff.7.ps">ps</A>) |
<TR> |
</TD> |
<TD>Source archive</TD> |
</TR> |
<TD> |
<TR> |
<A HREF="/snapshots/">/snapshots/</A> |
<TD VALIGN="top"><A HREF="tbl.7.html">tbl(7)</A></TD> |
</TD> |
<TD VALIGN="top"> |
</TR> |
tbl-mandoc language reference |
</TBODY> |
(<A HREF="tbl.7.txt">text</A> | |
</TABLE> |
<A HREF="tbl.7.xhtml">xhtml</A> | |
</TD> |
<A HREF="tbl.7.pdf">pdf</A> | |
</TR> |
<A HREF="tbl.7.ps">ps</A>) |
<TR> |
</TD> |
<TD> |
</TR> |
<H1> |
<TR> |
<A NAME="documentation">DOCUMENTATION</A> |
<TD VALIGN="top"><A HREF="mandocdb.8.html">mandocdb(8)</A></TD> |
</H1> |
<TD VALIGN="top"> |
|
index UNIX manuals |
<P> |
(<A HREF="mandocdb.8.txt">text</A> | |
These manuals are generated automatically and refer to the current snapshot. |
<A HREF="mandocdb.8.xhtml">xhtml</A> | |
</P> |
<A HREF="mandocdb.8.pdf">pdf</A> | |
|
<A HREF="mandocdb.8.ps">ps</A>) |
<TABLE WIDTH="100%" SUMMARY="Documentation"> |
</TD> |
<COL WIDTH="175"> |
</TR> |
<COL> |
</TBODY> |
<TBODY> |
</TABLE> |
<TR> |
<H1> |
<TD VALIGN="top"><A HREF="man.3.html">man(3)</A></TD> |
<A NAME="contact">Contact</A> |
<TD VALIGN="top"> |
</H1> |
man macro compiler library |
<P> |
<SPAN STYLE="font-size: smaller;"> |
Use the mailing lists for bug-reports, patches, questions, etc. Please check the |
(<A HREF="man.3.txt">text</A> | |
<A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/TODO?cvsroot=mdocml">TODO</A> for known issues |
<A HREF="man.3.xhtml">xhtml</A> | |
before posting. All lists are subscription-only: send a blank e-mail to the listed address to subscribe. Beyond that, |
<A HREF="man.3.pdf">pdf</A> | |
contact Kristaps at <A HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q==" TITLE="Reveal |
<A HREF="man.3.ps">postscript</A>) |
this e-mail address">kris...</A>@bsd.lv. Archives are available at <A HREF="http://gmane.org/" CLASS="external">Gmane</A>. |
</SPAN> |
</P> |
</TD> |
<TABLE WIDTH="100%" SUMMARY="Mailing Lists"> |
</TR> |
<COL WIDTH="175"> |
<TR> |
<COL> |
<TD VALIGN="top"><A HREF="man.7.html">man(7)</A></TD> |
<TBODY> |
<TD VALIGN="top"> |
<TR> |
man language reference |
<TD> |
<SPAN STYLE="font-size: smaller;"> |
disc<A CLASS="external" TITLE="Reveal this e-mail address" |
(<A HREF="man.7.txt">text</A> | |
HREF="http://www.google.com/recaptcha/mailhide/d?k=01KQ80PFH5n3BBNpF5Gs4sRg==&c=EV1QytpQqTHSItc2IXvZyocgYLPnG5K0JKw_gwMC9yc=">...</A>@mdocml.bsd.lv |
<A HREF="man.7.xhtml">xhtml</A> | |
</TD> |
<A HREF="man.7.pdf">pdf</A> | |
<TD> |
<A HREF="man.7.ps">postscript</A>) |
bug-reports, general questions, and announcements |
</SPAN> |
</TD> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
<TD> |
<TD VALIGN="top"><A HREF="mandoc.1.html">mandoc(1)</A></TD> |
tec<A CLASS="external" TITLE="Reveal this e-mail address" |
<TD VALIGN="top"> |
HREF="http://www.google.com/recaptcha/mailhide/d?k=01qDX_iV0RlUOarEvb6mR28g==&c=gRXsTjza0NNCFPaYu-Taj2tF0pmYZSc90EZkFkhkxgo=">...</A>@mdocml.bsd.lv |
format and display UNIX manuals |
</TD> |
<SPAN STYLE="font-size: smaller;"> |
<TD> |
(<A HREF="mandoc.1.txt">text</A> | |
patches and system discussions |
<A HREF="mandoc.1.xhtml">xhtml</A> | |
</TD> |
<A HREF="mandoc.1.pdf">pdf</A> | |
</TR> |
<A HREF="mandoc.1.ps">postscript</A>) |
<TR> |
</SPAN> |
<TD> |
</TD> |
sou<A CLASS="external" TITLE="Reveal this e-mail address" |
</TR> |
HREF="http://www.google.com/recaptcha/mailhide/d?k=01prQrAZhhl2EbIwVcRfABsQ==&c=KtTW4Yic9xk-8g40KzJoca4fR3MYXv28g8NC6OQV-T8=">...</A>@mdocml.bsd.lv |
<TR> |
</TD> |
<TD VALIGN="top"><A HREF="mandoc_char.7.html">mandoc_char(7)</A></TD> |
<TD> |
<TD VALIGN="top"> |
source commit messages |
mandoc special characters |
</TD> |
<SPAN STYLE="font-size: smaller;"> |
</TR> |
(<A HREF="mandoc_char.7.txt">text</A> | |
</TBODY> |
<A HREF="mandoc_char.7.xhtml">xhtml</A> | |
</TABLE> |
<A HREF="mandoc_char.7.pdf">pdf</A> | |
<H1> |
<A HREF="mandoc_char.7.ps">postscript</A>) |
<A NAME="news">News</A> |
</SPAN> |
</H1> |
</TD> |
<P CLASS="news"> |
</TR> |
xx-xx-2011: version 1.12.1 |
<TR> |
</P> |
<TD VALIGN="top"><A HREF="mdoc.3.html">mdoc(3)</A></TD> |
<P> |
<TD VALIGN="top"> |
Significant work on <A HREF="apropos.1.html">apropos</A> and <A HREF="mandocdb.8.html">mandocdb</A>. These tools are |
mdoc macro compiler library |
now much more robust and in line with other manpage systems. A <A HREF="whatis.1.html">whatis</A> implementation is now |
<SPAN STYLE="font-size: smaller;"> |
handled as an <A HREF="apropos.1.html">apropos</A> mode. |
(<A HREF="mdoc.3.txt">text</A> | |
</P> |
<A HREF="mdoc.3.xhtml">xhtml</A> | |
<P CLASS="news"> |
<A HREF="mdoc.3.pdf">pdf</A> | |
08-10-2011: version 1.12.0 |
<A HREF="mdoc.3.ps">postscript</A>) |
</P> |
</SPAN> |
<P> |
</TD> |
This version features a new, work-in-progress <A HREF="mandoc.1.html">mandoc</A> output mode: -<B>Tman</B>. This mode |
</TR> |
allows a system maintainer to distribute <A HREF="man.7.html">man</A> media for older systems that may not natively |
<TR> |
support <A HREF="mdoc.7.html">mdoc</A>, such as old Solaris systems. |
<TD VALIGN="top"><A HREF="mdoc.7.html">mdoc(7)</A></TD> |
The -<B>Ofragment</B> option was added to <A HREF="mandoc.1.html">mandoc</A>'s -<B>Thtml</B> and -<B>Txhtml</B> modes. |
<TD VALIGN="top"> |
</P> |
mdoc language reference |
<P> |
<SPAN STYLE="font-size: smaller;"> |
While adding features, an <A HREF="apropos.1.html">apropos</A> utility has been merged from the mandoc-tools sandbox. |
(<A HREF="mdoc.7.txt">text</A> | |
This interfaces with <A HREF="mandocdb.8.html">mandocdb</A> for semantic search of manual content. <A |
<A HREF="mdoc.7.xhtml">xhtml</A> | |
HREF="apropos.1.html">apropos</A> is different from the traditional <B>apropos</B> primarily in allowing keyword search |
<A HREF="mdoc.7.pdf">pdf</A> | |
(such as for functions, utilities, etc.) and regular expressions. |
<A HREF="mdoc.7.ps">postscript</A>) |
Note that the calling syntax for <B>apropos</B> is likely to change as it settles down. |
</SPAN> |
</P> |
</TD> |
<P> |
</TR> |
In documentation news, the <A HREF="mdoc.7.html">mdoc</A> and <A HREF="man.7.html">man</A> manuals have been made |
<TR> |
considerably more readable by adding <I>MACRO OVERVIEW</I> sections, by moving the gory details of the <I>LANGUAGE |
<TD VALIGN="top"><A HREF="roff.3.html">roff(3)</A></TD> |
SYNTAX</I> to the <A HREF="roff.7.html">roff</A> manual, and by moving the very technical <I>MACRO SYNTAX</I> sections |
<TD VALIGN="top"> |
down to the bottom of the page. |
roff macro compiler library |
</P> |
<SPAN STYLE="font-size: smaller;"> |
<P> |
(<A HREF="roff.3.txt">text</A> | |
Furthermore, for <A HREF="tbl.7.html">tbl</A>, the -<B>Tascii</B> mode horizontal spacing of tables was rewritten |
<A HREF="roff.3.xhtml">xhtml</A> | |
completely. It is now compatible with <A HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A>, both |
<A HREF="roff.3.pdf">pdf</A> | |
with and without frames and rulers. Nesting of indented blocks is now supported in <A HREF="man.7.html">man</A>, and |
<A HREF="roff.3.ps">postscript</A>) |
several bugs were fixed regarding indentation and alignment. The page headers in <A HREF="mdoc.7.html">mdoc</A> are now |
</SPAN> |
nicer for very long titles. |
</TD> |
</P> |
</TR> |
<P> |
<TR> |
See <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/index.sgml?cvsroot=mdocml">cvsweb</A> for |
<TD VALIGN="top"><A HREF="roff.7.html">roff(7)</A></TD> |
historical notes. |
<TD VALIGN="top"> |
</P> |
roff-mandoc language reference |
<P CLASS="foot"> |
<SPAN STYLE="font-size: smaller;"> |
<SMALL> |
(<A HREF="roff.7.txt">text</A> | |
Copyright © 2008–2011 |
<A HREF="roff.7.xhtml">xhtml</A> | |
<A CLASS="external" HREF="http://kristaps.bsd.lv">Kristaps Dzonsons</A>, |
<A HREF="roff.7.pdf">pdf</A> | |
$Date$ |
<A HREF="roff.7.ps">postscript</A>) |
</SMALL> |
</SPAN> |
</P> |
</TD> |
|
</TR> |
|
</TBODY> |
|
</TABLE> |
|
|
|
<P> |
|
See <Q><A CLASS="external" HREF="http://manpages.bsd.lv">Writing UNIX Manual Pages</A></Q> for a general |
|
introduction to manpages and mdoc. |
|
</P> |
|
</TD> |
|
</TR> |
|
<TR> |
|
<TD> |
|
<H1> |
|
<A NAME="contact">CONTACT</A> |
|
</H1> |
|
|
|
<P> |
|
Please use the mailing lists for bug-reports, patches, questions, etc. Beyond that, contact |
|
Kristaps at <A |
|
HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q==" |
|
TITLE="Reveal this e-mail address">kris...</A>@bsd.lv. |
|
</P> |
|
|
|
<P> |
|
You may also subscribe to several mailing lists (these require subscription, which is |
|
moderated). |
|
</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==&c=EV1QytpQqTHSItc2IXvZyocgYLPnG5K0JKw_gwMC9yc=">...</A>@mdocml.bsd.lv |
|
</TD> |
|
<TD> |
|
bug-reports, general questions, and announcements |
|
<SPAN STYLE="font-size: smaller;">(<A HREF="/archives/discuss/summary.html">archive</A>)</SPAN> |
|
</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==&c=gRXsTjza0NNCFPaYu-Taj2tF0pmYZSc90EZkFkhkxgo=">...</A>@mdocml.bsd.lv |
|
</TD> |
|
<TD> |
|
patches and system discussions |
|
<SPAN STYLE="font-size: smaller;">(<A HREF="/archives/tech/summary.html">archive</A>)</SPAN> |
|
</TD> |
|
</TR> |
|
<TR> |
|
<TD> |
|
sou<A CLASS="external" TITLE="Reveal this e-mail address" |
|
HREF="http://www.google.com/recaptcha/mailhide/d?k=01prQrAZhhl2EbIwVcRfABsQ==&c=KtTW4Yic9xk-8g40KzJoca4fR3MYXv28g8NC6OQV-T8=">...</A>@mdocml.bsd.lv |
|
</TD> |
|
<TD> |
|
source commit messages |
|
<SPAN STYLE="font-size: smaller;">(<A HREF="/archives/source/summary.html">archive</A>)</SPAN> |
|
</TD> |
|
</TR> |
|
</TBODY> |
|
</TABLE> |
|
</TD> |
|
</TR> |
|
<TR> |
|
<TD> |
|
<H1> |
|
<A NAME="news">NEWS</A> |
|
</H1> |
|
<DIV CLASS="news"> |
|
<P> |
|
<SPAN CLASS="date">03-01-2011</SPAN>: |
|
version 1.10.9 |
|
</P> |
|
<P> |
|
Table functionality (see the <A HREF="roff.7.html#x5c265453">roff</A> manual) has been |
|
merged from <A CLASS="external" HREF="http://tbl.bsd.lv">tbl.bsd.lv</A>. Many back-end |
|
fixes have also been implemented, primarily in argument handling (quoting) and <A |
|
HREF="man.7.html">man</A> documents. |
|
</P> |
|
</DIV> |
|
<DIV CLASS="news"> |
|
<P> |
|
<SPAN CLASS="date">24-12-2010</SPAN>: |
|
version 1.10.8 |
|
</P> |
|
<P> |
|
Significant improvements merged from <A CLASS="external" |
|
HREF="http://www.openbsd.org">OpenBSD</A> downstream, including |
|
</P> |
|
<UL> |
|
<LI>many new <A HREF="roff.7.html">roff</A> components,</LI> |
|
<LI>in-line implementation of troff's soelim,</LI> |
|
<LI>broken-block handling,</LI> |
|
<LI>overhauled error classifications, and</LI> |
|
<LI>cleaned up handling of error conditions.</LI> |
|
</UL> |
|
<P> |
|
Also overhauled the <SPAN CLASS="flag">-Thtml</SPAN> and <SPAN |
|
CLASS="flag">-Txhtml</SPAN> output modes. They now display readable output in arbitrary |
|
browsers, including text-based ones like <A CLASS="external" |
|
HREF="http://lynx.isc.org">lynx</A>. See HTML and XHTML manuals in the <A |
|
HREF="#documentation">DOCUMENTATION</A> section for examples. <SPAN |
|
CLASS="attn">Attention: available style-sheet classes have been considerably |
|
changed!</SPAN> See the <SPAN CLASS="file">example.style.css</SPAN> file for details. |
|
Lastly, <A HREF="mdoc.3.html">libmdoc</A> and <A HREF="man.3.html">libman</A> have been |
|
cleaned up and reduced in size and complexity. |
|
</P> |
|
</DIV> |
|
<DIV CLASS="news"> |
|
<P> |
|
<SPAN CLASS="date">27-09-2010</SPAN>: |
|
version 1.10.6 |
|
</P> |
|
<P> |
|
Calling conventions for <A HREF="mandoc.1.html">mandoc</A> have changed: <SPAN |
|
CLASS="flag">-W</SPAN> improved and <SPAN CLASS="flag">-f</SPAN> deprecated. Non-ASCII |
|
characters are also now uniformly discarded. Lots of documentation improvements. Many |
|
incremental fixes accomodating for groff's more interesting productions. Lastly, <A |
|
HREF="http://perldoc.perl.org/pod2man.html" CLASS="external">pod2man</A> preambles are |
|
now fully accepted after some considerable <A HREF="roff.7.html">roff</A> and special |
|
character support. |
|
</P> |
|
</DIV> |
|
<DIV CLASS="news"> |
|
<P> |
|
<SPAN CLASS="date">27-07-2010</SPAN>: |
|
version 1.10.5 |
|
</P> |
|
<P> |
|
Primarily a bug-fix and polish release, but including <SPAN CLASS="flag">-Tpdf</SPAN> |
|
support in <A HREF="mandoc.1.html">mandoc</A> by way of <A CLASS="external" |
|
HREF="http://netbsd-soc.sourceforge.net/projects/mandoc_ps/">Summer of Code</A>. |
|
Highlights: |
|
</P> |
|
<UL> |
|
<LI>fix <Q>Sm</Q> and <Q>Bd</Q> handling</LI> |
|
<LI>fix end-of-sentence handling for embedded sentences</LI> |
|
<LI>polish <A HREF="man.7.html">man</A> documentation</LI> |
|
<LI>document all <A HREF="mdoc.7.html">mdoc</A> macros</LI> |
|
<LI>polish <A HREF="mandoc.1.html">mandoc</A> <SPAN CLASS="flag">-Tps</SPAN> output</LI> |
|
<LI>lots of internal clean-ups in character escapes</LI> |
|
<LI>un-break literal contexts in <A HREF="man.7.html">man</A> documents</LI> |
|
<LI>improve <SPAN CLASS="flag">-Thtml</SPAN> output for <SPAN CLASS="flag">-man</SPAN></LI> |
|
<LI>add <A HREF="mandoc.1.html">mandoc</A> <SPAN CLASS="flag">-Tpdf</SPAN> support</LI> |
|
</UL> |
|
</DIV> |
|
<DIV CLASS="news"> |
|
<P> |
|
<SPAN CLASS="date">12-07-2010</SPAN>: |
|
version 1.10.4 |
|
</P> |
|
<P> |
|
Lots of features developed during both <A CLASS="external" |
|
HREF="http://netbsd-soc.sourceforge.net/projects/mandoc_ps/">Summer of Code</A> and the |
|
<A CLASS="external" HREF="http://www.openbsd.org">OpenBSD</A> c2k10 hackathon: |
|
</P> |
|
<UL> |
|
<LI>minimal <Q>ds</Q> <A HREF="roff.7.html">roff</A> symbols are supported</LI> |
|
<LI><Q>Bk</Q> <A HREF="mdoc.7.html">mdoc</A> support</LI> |
|
<LI>beautified SYNOPSIS section output</LI> |
|
<LI>variable font-width and paper-size support in <A HREF="mandoc.1.html">mandoc</A> |
|
<SPAN CLASS="flag">-Tps</SPAN> output</LI> |
|
<LI>acceptance of scope-block breakage in <A HREF="mdoc.7.html">mdoc</A></LI> |
|
<LI>clarify error message status</LI> |
|
<LI>many minor bug-fixes and formatting issues resolved</LI> |
|
</UL> |
|
</DIV> |
|
<DIV CLASS="news"> |
|
<P> |
|
<SPAN CLASS="date">19-06-2010</SPAN>: |
|
version 1.10.2 |
|
</P> |
|
<P> |
|
Small release featuring text-decoration in <SPAN CLASS="flag">-Tps</SPAN> output, a few |
|
minor relaxations of errors, and some optimisations. |
|
</P> |
|
</DIV> |
|
<DIV CLASS="news"> |
|
<P> |
|
<SPAN CLASS="date">07-06-2010</SPAN>: |
|
version 1.10.1 |
|
</P> |
|
<P> |
|
This primarily focusses on the <Q>Bl</Q> and <Q>It</Q> macros described in <A |
|
HREF="mdoc.7.html">mdoc</A>. Multi-line column support is now fully compatible with |
|
groff, as are implicit list entries for columns. Removed manuals.7 in favour of <A |
|
CLASS="external" HREF="http://manpages.bsd.lv">http://manpages.bsd.lv</A>. The way we |
|
handle the SYNOPSIS section (see the SYNOPSIS documentation in <A |
|
HREF="mdoc.7.html#x4d414e55414cx20x535452554354555245">MANUAL STRUCTURE</A>) has also |
|
been considerably simplified compared to groff's method. Furthermore, the <SPAN |
|
CLASS="flag">-Owidth=width</SPAN> output option has been added to <SPAN |
|
CLASS="flag">-Tascii</SPAN> (see <A HREF="mandoc.1.html">mandoc</A>). Lastly, initial |
|
PostScript output has been added with the <SPAN CLASS="flag">-Tps</SPAN> option to <A |
|
HREF="mandoc.1.html">mandoc</A>. It's brutally simple at the moment: fixed-font, with |
|
no font decorations. |
|
</P> |
|
</DIV> |
|
<DIV CLASS="news"> |
|
<P> |
|
<SPAN CLASS="date">29-05-2010</SPAN>: |
|
version 1.10.0 |
|
</P> |
|
<P> |
|
Release consisting of the results from the m2k10 hackathon and up-merge from OpenBSD. |
|
This requires a significant note of thanks to Ingo Schwarze (OpenBSD) and Joerg |
|
Sonnenberger (NetBSD) for their hard work, and again to Joerg for hosting m2k10. |
|
Highlights (mostly cribbed from Ingo's m2k10 report) follow in no particular order: |
|
</P> |
|
<UL> |
|
<LI>a <A HREF="roff.3.html">libroff</A> preprocessor in front of <A |
|
HREF="mdoc.3.html">libmdoc</A> and <A HREF="man.3.html">libman</A> stripping out |
|
<A HREF="roff.7.html">roff</A> instructions;</LI> |
|
<LI>end-of-sentence (EOS) detection in free-form and macro lines;</LI> |
|
<LI>correct handling of tab-separated columnar lists in <SPAN |
|
CLASS="flag">-mdoc</SPAN>;</LI> |
|
<LI>improved main calling routines to optionally use mmap() for better |
|
performance;</LI> |
|
<LI>cleaned up exiting when invoked as <SPAN CLASS="flag">-Tlint</SPAN> or over |
|
multiple files with <SPAN CLASS="flag">-fign-errors</SPAN>;</LI> |
|
<LI>error and warning message handling re-written to be unified for <A |
|
HREF="roff.3.html">libroff</A>, <A HREF="mdoc.3.html">libmdoc</A>, and <A |
|
HREF="man.3.html">libman</A>;</LI> |
|
<LI>handling of badly-nested explicit-scoped macros;</LI> |
|
<LI>improved free-form text parsing in <A HREF="man.3.html">libman</A> and <A |
|
HREF="mdoc.3.html">libmdoc</A>;</LI> |
|
<LI>significant GNU troff compatibility improvements in <SPAN |
|
CLASS="flag">-Tascii</SPAN>, largely in terms of spacing;</LI> |
|
<LI>a regression framework for making sure the many fragilities of GNU troff |
|
aren't trampled in subsequent work;</LI> |
|
<LI>support for <SPAN CLASS="flag">-Tascii</SPAN> breaking at hyphens |
|
encountered in free-form text;</LI> |
|
<LI>and many more minor fixes and improvements (no really, consult <A |
|
HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A> and see |
|
for yourself!).</LI> |
|
</UL> |
|
</DIV> |
|
<P> |
|
See <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/index.sgml?cvsroot=mdocml">cvsweb</A> for |
|
historical notes. |
|
</P> |
|
</TD> |
|
</TR> |
|
<TR> |
|
<TD> |
|
<DIV CLASS="foot"> |
|
Copyright © 2008–2010 Kristaps Dzonsons, $Date$ |
|
</DIV> |
|
</TD> |
|
</TR> |
|
</TBODY> |
|
</TABLE> |
|
</BODY> |
</BODY> |
</HTML> |
</HTML> |