| version 1.85, 2010/07/21 10:10:24 |
version 1.121, 2011/05/26 20:23:01 |
|
|
| <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 | mdoc macro compiler</TITLE> |
| </HEAD> |
</HEAD> |
| <BODY> |
<BODY> |
| <TABLE CLASS="frame" SUMMARY="[frame]"> |
<P CLASS="head"> |
| <COL WIDTH="100%"> |
<B>mdocml</B> – mdoc macro compiler |
| <TBODY> |
</P> |
| <TR> |
<H1> |
| <TD> |
<A NAME="description">Description</A> |
| <DIV CLASS="head"> |
</H1> |
| <B>mdocml</B> – mdoc macro compiler |
<P> |
| </DIV> |
<SPAN CLASS="nm">mdocml</SPAN> is a suite of tools compiling <I><A HREF="mdoc.7.html">mdoc</A></I>, the roff macro |
| </TD> |
package of choice for BSD manual pages, and <I><A HREF="man.7.html">man</A></I>, the predominant historical package for |
| </TR> |
UNIX manuals. The mission of <SPAN CLASS="nm">mdocml</SPAN> is to deprecate <A |
| <TR> |
HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A>, the GNU troff implementation, for displaying <I>mdoc</I> |
| <TD VALIGN="top"> |
pages whilst providing token support for <I>man</I>. |
| <H1> |
</P> |
| <A NAME="description">DESCRIPTION</A> |
<P> |
| </H1> |
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="makewhatis.1.html">makewhatis</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 UNIX system, although <A |
| |
HREF="makewhatis.1.html">makewhatis</A> requires <A CLASS="external" |
| |
HREF="http://www.oracle.com/technetwork/database/berkeleydb/overview/index.html">Berkeley Database</A> (this is |
| |
installed by default on all BSD operating systems). |
| |
To compile <SPAN CLASS="nm">mdocml</SPAN>, run <CODE>make</CODE>, then <CODE>make install</CODE> to install into |
| |
<I>/usr/local</I>. |
| |
Be aware: if you have an existing <A HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A> installation, |
| |
this may overwrite its <B>preconv</B> binary. |
| |
The <A HREF="makewhatis.1.html">makewhatis</A> utility is not yet linked to the build. You must run <CODE>make |
| |
makewhatis</CODE> to build it (it does not install). |
| |
</P> |
| |
<P> |
| |
The most current version of <SPAN CLASS="nm">mdocml</SPAN> is <SPAN CLASS="attn">@VERSION@</SPAN>, dated <SPAN |
| |
class="attn">@VDATE@</SPAN>. |
| |
</P> |
| |
|
| <P> |
<H2> |
| <SPAN CLASS="nm">mdocml</SPAN> is a suite of tools compiling <Q>-<A HREF="mdoc.7.html">mdoc</A></Q>, the |
Current |
| roff macro package of choice for BSD manual pages, and <Q>-<A HREF="man.7.html">man</A></Q>, the |
</H2> |
| 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 -mdoc pages whilst providing token support for -man. |
|
| </P> |
|
| |
|
| <P> |
<TABLE WIDTH="100%" SUMMARY="Current Sources"> |
| Why? groff amounts to over 5 MB of source code, most of which is C++ and all of which is GPL. It runs |
<COL WIDTH="175"> |
| slowly, produces uncertain output, and varies in operation from system to system. mdocml strives to fix |
<COL> |
| this (respectively small, C, <A CLASS="external" |
<TBODY> |
| HREF="http://www.isc.org/software/license">ISC</A>-licensed, fast and regular). |
<TR> |
| </P> |
<TD>Source archive</TD> |
| |
<TD> |
| |
<A HREF="/snapshots/mdocml.tar.gz">/snapshots/mdocml.tar.gz</A> |
| |
<SMALL>(<A HREF="/snapshots/mdocml.md5">md5</A>)</SMALL> |
| |
</TD> |
| |
</TR> |
| |
<TR> |
| |
<TD>Online source</TD> |
| |
<TD> |
| |
<A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A> |
| |
</TD> |
| |
</TR> |
| |
</TBODY> |
| |
</TABLE> |
| |
|
| <P> |
<H2> |
| <SPAN CLASS="nm">mdocml</SPAN> consists of the <A HREF="mdoc.3.html">libmdoc</A>, <A |
Downstream |
| HREF="man.3.html">libman</A>, and <A HREF="roff.3.html">libroff</A> validating compilers; and <A |
</H2> |
| HREF="mandoc.1.html">mandoc</A>, which interfaces with the compiler libraries to format output for UNIX |
|
| terminals, XHTML, HTML, and PostScript. <SPAN CLASS="nm">mdocml</SPAN> is a <A CLASS="external" |
|
| HREF="http://bsd.lv/">BSD.lv</A> project. |
|
| </P> |
|
| |
|
| <P> |
<TABLE WIDTH="100%" SUMMARY="Downstream Sources"> |
| <I>Disambiguation</I>: <SPAN CLASS="nm">mdocml</SPAN> is often referred to by its installed binary, |
<COL WIDTH="175"> |
| <Q>mandoc</Q>. |
<COL> |
| </P> |
<TBODY> |
| </TD> |
<TR> |
| </TR> |
<TD>DragonFly BSD</TD> |
| <TR> |
<TD> |
| <TD> |
<A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc" |
| <H1> |
CLASS="external">usr.bin/mandoc</A> |
| <A NAME="sources">SOURCES</A> |
</TD> |
| </H1> |
</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> |
| |
|
| <P> |
<H2> |
| <SPAN CLASS="nm">mdocml</SPAN> is architecture- and system-neutral, written in plain-old C. The most |
Historical |
| current version is <SPAN CLASS="attn">@VERSION@</SPAN>, dated <SPAN class="attn">@VDATE@</SPAN>. A full |
</H2> |
| <A HREF="ChangeLog.html">ChangeLog</A> (<A HREF="ChangeLog.txt">txt</A>) is written with each release. |
|
| </P> |
|
| |
|
| <H2> |
<TABLE WIDTH="100%" SUMMARY="Archived Sources"> |
| Current |
<COL WIDTH="175"> |
| </H2> |
<COL> |
| |
<TBODY> |
| |
<TR> |
| |
<TD>Source archive</TD> |
| |
<TD> |
| |
<A HREF="/snapshots/">/snapshots/</A> |
| |
</TD> |
| |
</TR> |
| |
</TBODY> |
| |
</TABLE> |
| |
|
| <TABLE WIDTH="100%" SUMMARY="Current Sources"> |
<H1> |
| <COL WIDTH="200"> |
<A NAME="documentation">Documentation</A> |
| <COL> |
</H1> |
| <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> |
|
| <TR> |
|
| <TD>Online source</TD> |
|
| <TD> |
|
| <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A> |
|
| </TD> |
|
| </TR> |
|
| </TBODY> |
|
| </TABLE> |
|
| |
|
| <H2> |
<P> |
| Downstream |
These manuals are generated automatically and refer to the current snapshot. |
| </H2> |
</P> |
| |
|
| <TABLE WIDTH="100%" SUMMARY="Downstream Sources"> |
<TABLE WIDTH="100%" SUMMARY="Documentation"> |
| <COL WIDTH="200"> |
<COL WIDTH="175"> |
| <COL> |
<COL> |
| <TBODY> |
<TBODY> |
| <TR> |
<TR> |
| <TD>DragonFly BSD</TD> |
<TD VALIGN="top"><A HREF="mandoc.1.html">mandoc(1)</A></TD> |
| <TD> |
<TD VALIGN="top"> |
| <A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc" |
format and display UNIX manuals |
| CLASS="external">usr.bin/mandoc</A> |
<SMALL> |
| </TD> |
(<A HREF="mandoc.1.txt">text</A> | |
| </TR> |
<A HREF="mandoc.1.xhtml">xhtml</A> | |
| <TR> |
<A HREF="mandoc.1.pdf">pdf</A> | |
| <TD>FreeBSD</TD> |
<A HREF="mandoc.1.ps">postscript</A>) |
| <TD> |
</SMALL> |
| <A HREF="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/" |
</TD> |
| CLASS="external">ports/textproc/mdocml</A> |
</TR> |
| </TD> |
<TR> |
| </TR> |
<TD VALIGN="top"><A HREF="makewhatis.1.html">makewhatis(1)</A></TD> |
| <TR> |
<TD VALIGN="top"> |
| <TD>NetBSD</TD> |
index UNIX manuals |
| <TD> |
<SMALL> |
| <A HREF="http://cvsweb.netbsd.org/bsdweb.cgi/src/external/bsd/mdocml/" |
(<A HREF="makewhatis.1.txt">text</A> | |
| CLASS="external">src/external/bsd/mdocml</A> |
<A HREF="makewhatis.1.xhtml">xhtml</A> | |
| </TD> |
<A HREF="makewhatis.1.pdf">pdf</A> | |
| </TR> |
<A HREF="makewhatis.1.ps">postscript</A>) |
| <TR> |
</SMALL> |
| <TD>OpenBSD</TD> |
</TD> |
| <TD> |
</TR> |
| <A HREF="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/" |
<TR> |
| CLASS="external">src/usr.bin/mandoc</A> |
<TD VALIGN="top"><A HREF="preconv.1.html">preconv(1)</A></TD> |
| </TD> |
<TD VALIGN="top"> |
| </TR> |
recode multibyte UNIX manuals |
| </TBODY> |
<SMALL> |
| </TABLE> |
(<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> |
| |
|
| <H2> |
<H1> |
| Historical |
<A NAME="contact">Contact</A> |
| </H2> |
</H1> |
| |
|
| <TABLE WIDTH="100%" SUMMARY="Archived Sources"> |
<P> |
| <COL WIDTH="200"> |
Use the mailing lists for bug-reports, patches, questions, etc. (these require subscription). Please check the |
| <COL> |
<A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/TODO?cvsroot=mdocml">TODO</A> for known issues |
| <TBODY> |
before posting. Beyond that, contact Kristaps at <A |
| <TR> |
HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q==" TITLE="Reveal |
| <TD>Source archive</TD> |
this e-mail address">kris...</A>@bsd.lv. |
| <TD> |
</P> |
| <A HREF="/snapshots/">/snapshots/</A> |
|
| </TD> |
|
| </TR> |
|
| </TBODY> |
|
| </TABLE> |
|
| </TD> |
|
| </TR> |
|
| <TR> |
|
| <TD> |
|
| <H1> |
|
| <A NAME="documentation">DOCUMENTATION</A> |
|
| </H1> |
|
| |
|
| <P> |
<TABLE WIDTH="100%" SUMMARY="Mailing Lists"> |
| These manuals are generated automatically and refer to the current snapshot. |
<COL WIDTH="175"> |
| </P> |
<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 |
| |
<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==&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==&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> |
| |
|
| <TABLE WIDTH="100%" SUMMARY="Documentation"> |
<H1> |
| <COL WIDTH="200"> |
<A NAME="news">News</A> |
| <COL> |
</H1> |
| <TBODY> |
|
| <TR> |
|
| <TD VALIGN="top"><A HREF="man.3.html">man(3)</A></TD> |
|
| <TD VALIGN="top"> |
|
| man macro compiler library |
|
| <SPAN STYLE="font-size: smaller;"> |
|
| (<A HREF="man.3.txt">text</A> | <A HREF="man.3.ps">postscript</A>) |
|
| </SPAN> |
|
| </TD> |
|
| </TR> |
|
| <TR> |
|
| <TD VALIGN="top"><A HREF="man.7.html">man(7)</A></TD> |
|
| <TD VALIGN="top"> |
|
| man language reference |
|
| <SPAN STYLE="font-size: smaller;"> |
|
| (<A HREF="man.7.txt">text</A> | <A HREF="man.7.ps">postscript</A>) |
|
| </SPAN> |
|
| </TD> |
|
| </TR> |
|
| <TR> |
|
| <TD VALIGN="top"><A HREF="mandoc.1.html">mandoc(1)</A></TD> |
|
| <TD VALIGN="top"> |
|
| format and display UNIX manuals |
|
| <SPAN STYLE="font-size: smaller;"> |
|
| (<A HREF="mandoc.1.txt">text</A> | <A HREF="mandoc.1.ps">postscript</A>) |
|
| </SPAN> |
|
| </TD> |
|
| </TR> |
|
| <TR> |
|
| <TD VALIGN="top"><A HREF="mandoc_char.7.html">mandoc_char(7)</A></TD> |
|
| <TD VALIGN="top"> |
|
| mandoc special characters |
|
| <SPAN STYLE="font-size: smaller;"> |
|
| (<A HREF="mandoc_char.7.txt">text</A> | <A |
|
| HREF="mandoc_char.7.ps">postscript</A>) |
|
| </SPAN> |
|
| </TD> |
|
| </TR> |
|
| <TR> |
|
| <TD VALIGN="top"><A HREF="mdoc.3.html">mdoc(3)</A></TD> |
|
| <TD VALIGN="top"> |
|
| mdoc macro compiler library |
|
| <SPAN STYLE="font-size: smaller;"> |
|
| (<A HREF="mdoc.3.txt">text</A> | <A HREF="mdoc.3.ps">postscript</A>) |
|
| </SPAN> |
|
| </TD> |
|
| </TR> |
|
| <TR> |
|
| <TD VALIGN="top"><A HREF="mdoc.7.html">mdoc(7)</A></TD> |
|
| <TD VALIGN="top"> |
|
| mdoc language reference |
|
| <SPAN STYLE="font-size: smaller;"> |
|
| (<A HREF="mdoc.7.txt">text</A> | <A HREF="mdoc.7.ps">postscript</A>) |
|
| </SPAN> |
|
| </TD> |
|
| </TR> |
|
| <TR> |
|
| <TD VALIGN="top"><A HREF="roff.3.html">roff(3)</A></TD> |
|
| <TD VALIGN="top"> |
|
| roff macro compiler library |
|
| <SPAN STYLE="font-size: smaller;"> |
|
| (<A HREF="roff.3.txt">text</A> | <A HREF="roff.3.ps">postscript</A>) |
|
| </SPAN> |
|
| </TD> |
|
| </TR> |
|
| <TR> |
|
| <TD VALIGN="top"><A HREF="roff.7.html">roff(7)</A></TD> |
|
| <TD VALIGN="top"> |
|
| roff-mandoc language reference |
|
| <SPAN STYLE="font-size: smaller;"> |
|
| (<A HREF="roff.7.txt">text</A> | <A HREF="roff.7.ps">postscript</A>) |
|
| </SPAN> |
|
| </TD> |
|
| </TR> |
|
| </TBODY> |
|
| </TABLE> |
|
| |
|
| <P> |
<P CLASS="news"> |
| See <Q><A CLASS="external" HREF="http://manpages.bsd.lv">Writing UNIX Manual Pages</A></Q> for a general |
19-05-2011: version 1.11.3 |
| introduction to manpages and mdoc. |
</P> |
| </P> |
<P> |
| </TD> |
Introduce locale-encoding of output with the <B>-Tlocale</B> output option and Unicode escaped-character input. |
| </TR> |
See <A HREF="mandoc.1.html">mandoc</A> and <A HREF="mandoc_char.7.html">mandoc_char</A>, respectively, for details. |
| <TR> |
This allows for non-ASCII characters (e.g., <I>\[u5000]</I>) to be rendered in the locale's encoding, if said |
| <TD> |
environment supports wide-character encoding (if it does not, <B>-Tascii</B> is used instead). |
| <H1> |
Locale support can be turned off at compile time by removing <I>-DUSE_WCHAR</I> in the <I>Makefile</I>, in which case |
| <A NAME="contact">CONTACT</A> |
<B>-Tlocale</B> is always a synonym for <B>-Tascii</B>. |
| </H1> |
</P> |
| |
<P> |
| |
Furthermore, multibyte-encoded documents, such as those in UTF-8, may be on-the-fly recoded as <A |
| |
HREF="mandoc.1.html">mandoc</A> input by using the newly-added <A HREF="preconv.1.html">preconv</A> utility. |
| |
Note: in the future, this feature may be integrated into <A HREF="mandoc.1.html">mandoc</A>. |
| |
</P> |
| |
|
| <P> |
<P CLASS="news"> |
| Please use the mailing lists for bug-reports, patches, questions, etc. Beyond that, contact |
12-05-2011: version 1.11.2 |
| Kristaps at <A |
</P> |
| HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q==" |
<P> |
| TITLE="Reveal this e-mail address">kris...</A>@bsd.lv. |
Corrected some installation issues in version 1.11.1. |
| </P> |
Further migration to <A HREF="mandoc.3.html">libmandoc</A>. |
| |
Initial public release (this utility is very much under development) of <A HREF="makewhatis.1.html">makewhatis</A>, |
| |
initially named mandoc-db. |
| |
This utility produces keyword databases of manual content |
| |
<A HREF="http://mdocml.bsd.lv/mandoc-cgi/index.html">mandoc-cgi</A>, which features semantic querying of manual content. |
| |
</P> |
| |
|
| <P> |
<P CLASS="news"> |
| You may also subscribe to several mailing lists (these require subscription, which is |
04-04-2011: version 1.11.1 |
| moderated). An archive is not yet available on-line, although you may request one once |
</P> |
| subscribed. |
<P> |
| </P> |
The earlier <I>libroff</I>, <I>libmdoc</I>, and <I>libman</I> soup have been merged into |
| |
a single library, <A HREF="mandoc.3.html">libmandoc</A>, which manages all aspects of |
| |
parsing real manuals (from line-handling to <A HREF="tbl.7.html">tbl</A> parsing). |
| |
</P> |
| |
<P> |
| |
Beyond this structural change, initial <A HREF="eqn.7.html">eqn</A> functionality is in |
| |
place. For the time being, this is limited to the recognition of equation blocks; |
| |
future version of <SPAN CLASS="nm">mdocml</SPAN> will expand upon this framework. |
| |
</P> |
| |
<P> |
| |
As usual, many general fixes and improvements have also occurred. In particular, a great |
| |
deal of redundancy and superfluous code has been removed with the merging of the backend |
| |
libraries. |
| |
</P> |
| |
|
| <TABLE WIDTH="100%" SUMMARY="Mailing Lists"> |
<P> |
| <COL WIDTH="200"> |
See <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/index.sgml?cvsroot=mdocml">cvsweb</A> for |
| <COL> |
historical notes. |
| <TBODY> |
</P> |
| <TR> |
|
| <TD> |
<P CLASS="foot"> |
| disc<A CLASS="external" TITLE="Reveal this e-mail address" |
<SMALL> |
| HREF="http://www.google.com/recaptcha/mailhide/d?k=01KQ80PFH5n3BBNpF5Gs4sRg==&c=EV1QytpQqTHSItc2IXvZyocgYLPnG5K0JKw_gwMC9yc=">...</A>@mdocml.bsd.lv |
Copyright © 2008–2011 |
| </TD> |
<A CLASS="external" HREF="http://kristaps.bsd.lv">Kristaps Dzonsons</A>, |
| <TD>bug-reports, general questions, and announcements</TD> |
$Date$ |
| </TR> |
</SMALL> |
| <TR> |
</P> |
| <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</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</TD> |
|
| </TR> |
|
| </TBODY> |
|
| </TABLE> |
|
| </TD> |
|
| </TR> |
|
| <TR> |
|
| <TD> |
|
| <H1> |
|
| <A NAME="news">NEWS</A> |
|
| </H1> |
|
| <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> |
|
| -Tps 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> |
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to index.sgml CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc