<DIV CLASS="head">
<B>mdocml</B> – mdoc macro compiler
</DIV>
- <DIV CLASS="subhead">
- <A HREF="#description">Description</A> |
- <A HREF="#sources">Sources</A> |
- <A HREF="#documentation">Documentation</A> |
- <A HREF="#contact">Contact</A> |
- <A HREF="#news">News</A>
- </DIV>
</TD>
</TR>
<TR>
</H1>
<P>
- <SPAN CLASS="nm">mdocml</SPAN> is a suite of tools compiling <Q>-mdoc</Q>, the roff macro package
- of choice for BSD manual pages, and <Q>-man</Q>, the predominant historical package for UNIX
- manuals. The mission of <SPAN CLASS="nm">mdocml</SPAN> is to deprecate <A
- HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A>, the GNU roff implementation, for
- displaying -mdoc pages whilst providing token support for -man.
+ <SPAN CLASS="nm">mdocml</SPAN> is a suite of tools compiling <Q>-<A HREF="mdoc.7.html">mdoc</A></Q>, the
+ roff macro package of choice for BSD manual pages, and <Q>-<A HREF="man.7.html">man</A></Q>, 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 -mdoc pages whilst providing token support for -man.
</P>
<P>
Why? groff amounts to over 5 MB of source code, most of which is C++ and all of which is GPL. It runs
slowly, produces uncertain output, and varies in operation from system to system. mdocml strives to fix
- this (respectively small, C, ISC-licensed, fast and regular).
+ this (respectively small, C, <A CLASS="external"
+ HREF="http://www.isc.org/software/license">ISC</A>-licensed, fast and regular).
</P>
<P>
-
The core of <SPAN CLASS="nm">mdocml</SPAN> is composed of the <A HREF="mdoc.3.html">libmdoc</A>, <A
- HREF="man.3.html">libman</A>, and <A HREF="roff.3.html">libroff</A> validating compiler libraries. All
- are simple, fast libraries operating on memory buffers, so they may be used for a variety of front-ends
- (terminal-based, CGI and so on). The front-end is <A HREF="mandoc.1.html">mandoc</A>, which formats
- manuals for display.
+
<SPAN CLASS="nm">mdocml</SPAN> consists of the <A HREF="mdoc.3.html">libmdoc</A>, <A
+ HREF="man.3.html">libman</A>, and <A HREF="roff.3.html">libroff</A> validating compilers; and <A
+ 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>
- The <SPAN CLASS="nm">mdocml</SPAN> suite is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv
- Project</A> member.
+ <I>Disambiguation</I>: <SPAN CLASS="nm">mdocml</SPAN> is often referred to by its installed binary,
+ <Q>mandoc</Q>.
</P>
</TD>
</TR>
</H1>
<P>
- Sources correctly build and install on DragonFly BSD, FreeBSD, OpenBSD, NetBSD, GNU/Linux, and many
- other operating systems, tested variously on i386, AMD64, alpha, and others. The most current version
- is <SPAN CLASS="attn">@VERSION@</SPAN>, dated <SPAN class="attn">@VDATE@</SPAN>. A full <A
- HREF="ChangeLog.html">ChangeLog</A> (<A HREF="ChangeLog.txt">txt</A>) is written with each release.
+ <SPAN CLASS="nm">mdocml</SPAN> is architecture- and system-neutral, written in plain-old C. The most
+ current version is <SPAN CLASS="attn">@VERSION@</SPAN>, dated <SPAN class="attn">@VDATE@</SPAN>. A full
+ <A HREF="ChangeLog.html">ChangeLog</A> (<A HREF="ChangeLog.txt">txt</A>) is written with each release.
</P>
<H2>
</H1>
<P>
- These manuals are generated automatically and refer to the current snapshot.
+ These manuals are generated automatically and refer to the current snapshot.
</P>
<TABLE WIDTH="100%" SUMMARY="Documentation">
<TD VALIGN="top"><A HREF="man.3.html">man(3)</A></TD>
<TD VALIGN="top">
man macro compiler library
- <DIV STYLE="font-size: smaller;">
- <A HREF="man.3.txt">text</A> | <A HREF="man.3.ps">postscript</A>
- </DIV>
+ <SPAN STYLE="font-size: smaller;">
+ (<A HREF="man.3.txt">text</A> |
+ <A HREF="man.3.pdf">pdf</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
- <DIV STYLE="font-size: smaller;">
- <A HREF="man.7.txt">text</A> | <A HREF="man.7.ps">postscript</A>
- </DIV>
+ <SPAN STYLE="font-size: smaller;">
+ (<A HREF="man.7.txt">text</A> |
+ <A HREF="man.7.pdf">pdf</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
- <DIV STYLE="font-size: smaller;">
- <A HREF="mandoc.1.txt">text</A> | <A HREF="mandoc.1.ps">postscript</A>
- </DIV>
+ <SPAN STYLE="font-size: smaller;">
+ (<A HREF="mandoc.1.txt">text</A> |
+ <A HREF="mandoc.1.pdf">pdf</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
- <DIV STYLE="font-size: smaller;">
- <A HREF="mandoc_char.7.txt">text</A> | <A HREF="mandoc_char.7.ps">postscript</A>
- </DIV>
+ <SPAN STYLE="font-size: smaller;">
+ (<A HREF="mandoc_char.7.txt">text</A> |
+ <A HREF="mandoc_char.7.pdf">pdf</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
- <DIV STYLE="font-size: smaller;">
- <A HREF="mdoc.3.txt">text</A> | <A HREF="mdoc.3.ps">postscript</A>
- </DIV>
+ <SPAN STYLE="font-size: smaller;">
+ (<A HREF="mdoc.3.txt">text</A> |
+ <A HREF="mdoc.3.pdf">pdf</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
- <DIV STYLE="font-size: smaller;">
- <A HREF="mdoc.7.txt">text</A> | <A HREF="mdoc.7.ps">postscript</A>
- </DIV>
+ <SPAN STYLE="font-size: smaller;">
+ (<A HREF="mdoc.7.txt">text</A> |
+ <A HREF="mdoc.7.pdf">pdf</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
- <DIV STYLE="font-size: smaller;">
- <A HREF="roff.3.txt">text</A> | <A HREF="roff.3.ps">postscript</A>
- </DIV>
+ <SPAN STYLE="font-size: smaller;">
+ (<A HREF="roff.3.txt">text</A> |
+ <A HREF="roff.3.pdf">pdf</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
- <DIV STYLE="font-size: smaller;">
- <A HREF="roff.7.txt">text</A> | <A HREF="roff.7.ps">postscript</A>
- </DIV>
+ <SPAN STYLE="font-size: smaller;">
+ (<A HREF="roff.7.txt">text</A> |
+ <A HREF="roff.7.pdf">pdf</A> |
+ <A HREF="roff.7.ps">postscript</A>)
+ </SPAN>
</TD>
</TR>
</TBODY>
<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>
</H1>
<P>
- For all issues related to <SPAN CLASS="nm">mdocml</SPAN>, contact Kristaps Dzonsons, kris<A
- CLASS="external"
- HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q=="
- TITLE="Reveal this e-mail address">...</A>@bsd.lv.
+ 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). An
- archive is not yet available on-line, although you may request one once subscribed.
+ You may also subscribe to several mailing lists (these require subscription, which is
+ moderated).
</P>
<TABLE WIDTH="100%" SUMMARY="Mailing Lists">
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>high-level discussions and version announcements</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>low-level discussions</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</TD>
+ <TD>
+ source commit messages
+ <SPAN STYLE="font-size: smaller;">(<A HREF="/archives/source/summary.html">archive</A>)</SPAN>
+ </TD>
</TR>
</TBODY>
</TABLE>
<H1>
<A NAME="news">NEWS</A>
</H1>
+ <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>:
for yourself!).</LI>
</UL>
</DIV>
- <DIV CLASS="news">
- <P>
- <SPAN CLASS="date">13-05-2010</SPAN>:
- version 1.9.25
- </P>
- <P>
- Fixed handling of <Q>\*(Ba</Q> escape. Backed out <SPAN
- CLASS="flag">-fno-ign-chars</SPAN> (pointless complexity). Fixed erroneous
- breaking of literal lines. Fixed SYNOPSIS breaking lines before non-initial
- macros. Changed default section ordering. Most importantly, the framework for
- end-of-sentence double-spacing is in place, now implemented for the
- <Q>end-of-sentence, end-of-line</Q> rule. This is a stable roll-back point
- before the mandoc hackathon in Rostock!
- </P>
- </DIV>
- <DIV CLASS="news">
- <P>
- <SPAN CLASS="date">09-05-2010</SPAN>:
- version 1.9.24
- </P>
- <P>
- Rolled back break-at-hyphen. <SPAN CLASS="flag">-DUGLY</SPAN> is now the
- default (no feature splits!). Free-form text is not de-chunked any more: lines
- are passed whole-sale into the front-end, including whitespace. Added mailing
- lists. Lastly, <SPAN CLASS="nm">mdocml</SPAN> is the focus of two <A
- CLASS="external" HREF="http://socghop.appspot.com/">Google Summer of Code</A>
- projects this year: <Q><A CLASS="external"
- HREF="http://netbsd-soc.sourceforge.net/projects/mandoc_ps/">mandoc -Tps</A></Q>
- (NetBSD) and <Q><A CLASS="external"
- HREF="http://wiki.freebsd.org/SummerOfCode2010Projects">BSD-licensed
- Text-Processing Tools</A></Q> (FreeBSD).
- </P>
- </DIV>
<P>
See <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/index.sgml?cvsroot=mdocml">cvsweb</A> for
historical notes.
<TR>
<TD>
<DIV CLASS="foot">
- Copyright © 2008–2010 Kristaps Dzonsons, $Date: 2010/06/08 09:15:58 $
+ Copyright © 2008–2010 Kristaps Dzonsons, $Date: 2010/09/27 12:34:21 $
</DIV>
</TD>
</TR>
git.ckatri.com / mandoc.git / blobdiff