| version 1.82, 2010/06/19 20:43:35 |
version 1.151, 2011/12/14 23:17:12 |
|
|
| <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> |
| |
| <DIV CLASS="subhead"> |
Binaries: <A |
| <A HREF="#description">Description</A> | |
HREF="/binaries/mdocml-win32.zip">windows 32-bit</A>, <A |
| <A HREF="#sources">Sources</A> | |
HREF="/binaries/mdocml-win64.zip">windows 64-bit</A>, <A |
| <A HREF="#documentation">Documentation</A> | |
HREF="/binaries/mdocml-macosx.zip">mac os x</A> |
| <A HREF="#contact">Contact</A> | |
(<A HREF="/binaries/">archives</A>) |
| <A HREF="#news">News</A> |
</P> |
| </DIV> |
<H1> |
| </TD> |
<A NAME="description">Description</A> |
| </TR> |
</H1> |
| <TR> |
<P> |
| <TD VALIGN="top"> |
<SPAN CLASS="nm">mdocml</SPAN> is a suite of tools compiling <I><A HREF="mdoc.7.html">mdoc</A></I>, the roff macro |
| <H1> |
package of choice for BSD manual pages, and <I><A HREF="man.7.html">man</A></I>, the predominant historical package for |
| <A NAME="description">DESCRIPTION</A> |
UNIX manuals. The mission of <SPAN CLASS="nm">mdocml</SPAN> is to deprecate <A |
| </H1> |
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>, <A HREF="whatis.1.html">whatis</A>, and |
| |
<A HREF="man.cgi.7.html">man.cgi</A> (via <A HREF="catman.8.html">catman</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>, <A HREF="man.cgi.7.html">man.cgi</A>, <A |
| |
HREF="catman.8.html">catman</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>-mdoc</Q>, the roff macro package |
<COL WIDTH="175"> |
| of choice for BSD manual pages, and <Q>-man</Q>, the predominant historical package for UNIX |
<COL> |
| manuals. The mission of <SPAN CLASS="nm">mdocml</SPAN> is to deprecate <A |
<TBODY> |
| HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A>, the GNU roff implementation, for |
<TR> |
| 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, ISC-licensed, fast and regular). |
<A HREF="apropos.1.ps">ps</A>) |
| </P> |
</TD> |
| |
</TR> |
| <P> |
<TR> |
| The core of <SPAN CLASS="nm">mdocml</SPAN> is composed of the <A HREF="mdoc.3.html">libmdoc</A>, <A |
<TD VALIGN="top"><A HREF="demandoc.1.html">demandoc(1)</A></TD> |
| HREF="man.3.html">libman</A>, and <A HREF="roff.3.html">libroff</A> validating compiler libraries. All |
<TD VALIGN="top"> |
| are simple, fast libraries operating on memory buffers, so they may be used for a variety of front-ends |
emit only text of UNIX manuals |
| (terminal-based, CGI and so on). The front-end is <A HREF="mandoc.1.html">mandoc</A>, which formats |
(<A HREF="demandoc.1.txt">text</A> | |
| manuals for display. |
<A HREF="demandoc.1.xhtml">xhtml</A> | |
| </P> |
<A HREF="demandoc.1.pdf">pdf</A> | |
| |
<A HREF="demandoc.1.ps">ps</A>) |
| <P> |
</TD> |
| The <SPAN CLASS="nm">mdocml</SPAN> suite is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv |
</TR> |
| Project</A> member. |
<TR> |
| </P> |
<TD VALIGN="top"><A HREF="mandoc.1.html">mandoc(1)</A></TD> |
| </TD> |
<TD VALIGN="top"> |
| </TR> |
format and display UNIX manuals |
| <TR> |
(<A HREF="mandoc.1.txt">text</A> | |
| <TD> |
<A HREF="mandoc.1.xhtml">xhtml</A> | |
| <H1> |
<A HREF="mandoc.1.pdf">pdf</A> | |
| <A NAME="sources">SOURCES</A> |
<A HREF="mandoc.1.ps">ps</A>) |
| </H1> |
</TD> |
| |
</TR> |
| <P> |
<TR> |
| Sources correctly build and install on DragonFly BSD, FreeBSD, OpenBSD, NetBSD, GNU/Linux, and many |
<TD VALIGN="top"><A HREF="preconv.1.html">preconv(1)</A></TD> |
| other operating systems, tested variously on i386, AMD64, alpha, and others. The most current version |
<TD VALIGN="top"> |
| is <SPAN CLASS="attn">@VERSION@</SPAN>, dated <SPAN class="attn">@VDATE@</SPAN>. A full <A |
recode multibyte UNIX manuals |
| 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="200"> |
<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="200"> |
<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="man.cgi.7.html">man.cgi(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> |
cgi for manpage query and display |
| </TD> |
(<A HREF="man.cgi.7.txt">text</A> | |
| </TR> |
<A HREF="man.cgi.7.xhtml">xhtml</A> | |
| <TR> |
<A HREF="man.cgi.7.pdf">pdf</A> | |
| <TD>FreeBSD</TD> |
<A HREF="man.cgi.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="eqn.7.html">eqn(7)</A></TD> |
| </TR> |
<TD VALIGN="top"> |
| <TR> |
eqn-mandoc language reference |
| <TD>NetBSD</TD> |
(<A HREF="eqn.7.txt">text</A> | |
| <TD> |
<A HREF="eqn.7.xhtml">xhtml</A> | |
| <A HREF="http://cvsweb.netbsd.org/bsdweb.cgi/src/external/bsd/mdocml/" |
<A HREF="eqn.7.pdf">pdf</A> | |
| CLASS="external">src/external/bsd/mdocml</A> |
<A HREF="eqn.7.ps">ps</A>) |
| </TD> |
</TD> |
| </TR> |
</TR> |
| <TR> |
<TR> |
| <TD>OpenBSD</TD> |
<TD VALIGN="top"><A HREF="mandoc_char.7.html">mandoc_char(7)</A></TD> |
| <TD> |
<TD VALIGN="top"> |
| <A HREF="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/" |
mandoc special characters |
| CLASS="external">src/usr.bin/mandoc</A> |
(<A HREF="mandoc_char.7.txt">text</A> | |
| </TD> |
<A HREF="mandoc_char.7.xhtml">xhtml</A> | |
| </TR> |
<A HREF="mandoc_char.7.pdf">pdf</A> | |
| </TBODY> |
<A HREF="mandoc_char.7.ps">ps</A>) |
| </TABLE> |
</TD> |
| |
</TR> |
| <H2> |
<TR> |
| Historical |
<TD VALIGN="top"><A HREF="mdoc.7.html">mdoc(7)</A></TD> |
| </H2> |
<TD VALIGN="top"> |
| |
mdoc language reference |
| <TABLE WIDTH="100%" SUMMARY="Archived Sources"> |
(<A HREF="mdoc.7.txt">text</A> | |
| <COL WIDTH="200"> |
<A HREF="mdoc.7.xhtml">xhtml</A> | |
| <COL> |
<A HREF="mdoc.7.pdf">pdf</A> | |
| <TBODY> |
<A HREF="mdoc.7.ps">ps</A>) |
| <TR> |
</TD> |
| <TD>Source archive</TD> |
</TR> |
| <TD> |
<TR> |
| <A HREF="/snapshots/">/snapshots/</A> |
<TD VALIGN="top"><A HREF="roff.7.html">roff(7)</A></TD> |
| </TD> |
<TD VALIGN="top"> |
| </TR> |
roff-mandoc language reference |
| </TBODY> |
(<A HREF="roff.7.txt">text</A> | |
| </TABLE> |
<A HREF="roff.7.xhtml">xhtml</A> | |
| </TD> |
<A HREF="roff.7.pdf">pdf</A> | |
| </TR> |
<A HREF="roff.7.ps">ps</A>) |
| <TR> |
</TD> |
| <TD> |
</TR> |
| <H1> |
<TR> |
| <A NAME="documentation">DOCUMENTATION</A> |
<TD VALIGN="top"><A HREF="tbl.7.html">tbl(7)</A></TD> |
| </H1> |
<TD VALIGN="top"> |
| |
tbl-mandoc language reference |
| <P> |
(<A HREF="tbl.7.txt">text</A> | |
| These manuals are generated automatically and refer to the current snapshot. |
<A HREF="tbl.7.xhtml">xhtml</A> | |
| </P> |
<A HREF="tbl.7.pdf">pdf</A> | |
| |
<A HREF="tbl.7.ps">ps</A>) |
| <TABLE WIDTH="100%" SUMMARY="Documentation"> |
</TD> |
| <COL WIDTH="200"> |
</TR> |
| <COL> |
<TR> |
| <TBODY> |
<TD VALIGN="top"><A HREF="catman.8.html">catman(8)</A></TD> |
| <TR> |
<TD VALIGN="top"> |
| <TD VALIGN="top"><A HREF="man.3.html">man(3)</A></TD> |
update a man.cgi manpage cache |
| <TD VALIGN="top"> |
(<A HREF="catman.8.txt">text</A> | |
| man macro compiler library |
<A HREF="catman.8.xhtml">xhtml</A> | |
| <DIV STYLE="font-size: smaller;"> |
<A HREF="catman.8.pdf">pdf</A> | |
| <A HREF="man.3.txt">text</A> | <A HREF="man.3.ps">postscript</A> |
<A HREF="catman.8.ps">ps</A>) |
| </DIV> |
</TD> |
| </TD> |
</TR> |
| </TR> |
<TR> |
| <TR> |
<TD VALIGN="top"><A HREF="mandocdb.8.html">mandocdb(8)</A></TD> |
| <TD VALIGN="top"><A HREF="man.7.html">man(7)</A></TD> |
<TD VALIGN="top"> |
| <TD VALIGN="top"> |
index UNIX manuals |
| man language reference |
(<A HREF="mandocdb.8.txt">text</A> | |
| <DIV STYLE="font-size: smaller;"> |
<A HREF="mandocdb.8.xhtml">xhtml</A> | |
| <A HREF="man.7.txt">text</A> | <A HREF="man.7.ps">postscript</A> |
<A HREF="mandocdb.8.pdf">pdf</A> | |
| </DIV> |
<A HREF="mandocdb.8.ps">ps</A>) |
| </TD> |
</TD> |
| </TR> |
</TR> |
| <TR> |
</TBODY> |
| <TD VALIGN="top"><A HREF="mandoc.1.html">mandoc(1)</A></TD> |
</TABLE> |
| <TD VALIGN="top"> |
<H1> |
| format and display UNIX manuals |
<A NAME="contact">Contact</A> |
| <DIV STYLE="font-size: smaller;"> |
</H1> |
| <A HREF="mandoc.1.txt">text</A> | <A HREF="mandoc.1.ps">postscript</A> |
<P> |
| </DIV> |
Use the mailing lists for bug-reports, patches, questions, etc. Please check the |
| </TD> |
<A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/TODO?cvsroot=mdocml">TODO</A> for known issues |
| </TR> |
before posting. All lists are subscription-only: send a blank e-mail to the listed address to subscribe. Beyond that, |
| <TR> |
contact Kristaps at <A HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q==" TITLE="Reveal |
| <TD VALIGN="top"><A HREF="mandoc_char.7.html">mandoc_char(7)</A></TD> |
this e-mail address">kris...</A>@bsd.lv. Archives are available at <A HREF="http://gmane.org/" CLASS="external">Gmane</A>. |
| <TD VALIGN="top"> |
</P> |
| mandoc special characters |
<TABLE WIDTH="100%" SUMMARY="Mailing Lists"> |
| <DIV STYLE="font-size: smaller;"> |
<COL WIDTH="175"> |
| <A HREF="mandoc_char.7.txt">text</A> | <A HREF="mandoc_char.7.ps">postscript</A> |
<COL> |
| </DIV> |
<TBODY> |
| </TD> |
<TR> |
| </TR> |
<TD> |
| <TR> |
disc<A CLASS="external" TITLE="Reveal this e-mail address" |
| <TD VALIGN="top"><A HREF="mdoc.3.html">mdoc(3)</A></TD> |
HREF="http://www.google.com/recaptcha/mailhide/d?k=01KQ80PFH5n3BBNpF5Gs4sRg==&c=EV1QytpQqTHSItc2IXvZyocgYLPnG5K0JKw_gwMC9yc=">...</A>@mdocml.bsd.lv |
| <TD VALIGN="top"> |
</TD> |
| mdoc macro compiler library |
<TD> |
| <DIV STYLE="font-size: smaller;"> |
bug-reports, general questions, and announcements |
| <A HREF="mdoc.3.txt">text</A> | <A HREF="mdoc.3.ps">postscript</A> |
</TD> |
| </DIV> |
</TR> |
| </TD> |
<TR> |
| </TR> |
<TD> |
| <TR> |
tec<A CLASS="external" TITLE="Reveal this e-mail address" |
| <TD VALIGN="top"><A HREF="mdoc.7.html">mdoc(7)</A></TD> |
HREF="http://www.google.com/recaptcha/mailhide/d?k=01qDX_iV0RlUOarEvb6mR28g==&c=gRXsTjza0NNCFPaYu-Taj2tF0pmYZSc90EZkFkhkxgo=">...</A>@mdocml.bsd.lv |
| <TD VALIGN="top"> |
</TD> |
| mdoc language reference |
<TD> |
| <DIV STYLE="font-size: smaller;"> |
patches and system discussions |
| <A HREF="mdoc.7.txt">text</A> | <A HREF="mdoc.7.ps">postscript</A> |
</TD> |
| </DIV> |
</TR> |
| </TD> |
<TR> |
| </TR> |
<TD> |
| <TR> |
sou<A CLASS="external" TITLE="Reveal this e-mail address" |
| <TD VALIGN="top"><A HREF="roff.3.html">roff(3)</A></TD> |
HREF="http://www.google.com/recaptcha/mailhide/d?k=01prQrAZhhl2EbIwVcRfABsQ==&c=KtTW4Yic9xk-8g40KzJoca4fR3MYXv28g8NC6OQV-T8=">...</A>@mdocml.bsd.lv |
| <TD VALIGN="top"> |
</TD> |
| roff macro compiler library |
<TD> |
| <DIV STYLE="font-size: smaller;"> |
source commit messages |
| <A HREF="roff.3.txt">text</A> | <A HREF="roff.3.ps">postscript</A> |
</TD> |
| </DIV> |
</TR> |
| </TD> |
</TBODY> |
| </TR> |
</TABLE> |
| <TR> |
<H1> |
| <TD VALIGN="top"><A HREF="roff.7.html">roff(7)</A></TD> |
<A NAME="news">News</A> |
| <TD VALIGN="top"> |
</H1> |
| roff-mandoc language reference |
<P CLASS="news"> |
| <DIV STYLE="font-size: smaller;"> |
xx-xx-2011: version 1.12.1 |
| <A HREF="roff.7.txt">text</A> | <A HREF="roff.7.ps">postscript</A> |
</P> |
| </DIV> |
<P> |
| </TD> |
Significant work on <A HREF="apropos.1.html">apropos</A> and <A HREF="mandocdb.8.html">mandocdb</A>. These tools are |
| </TR> |
now much more robust and in line with other manpage systems. A <A HREF="whatis.1.html">whatis</A> implementation is now |
| </TBODY> |
handled as an <A HREF="apropos.1.html">apropos</A> mode. These tools are also able to minimally handle pre-formatted |
| </TABLE> |
pages, that is, those already formatted by another utility such as GNU troff. |
| |
</P> |
| <P> |
<P> |
| See <Q><A CLASS="external" HREF="http://manpages.bsd.lv">Writing UNIX Manual Pages</A></Q> for a general |
The <A HREF="man.cgi.7.html">man.cgi</A> script is also now available for wider testing. It interfaces with <A |
| introduction to manpages and mdoc. |
HREF="mandocdb.8.html">mandocdb</A> manuals cached by <A HREF="catman.8.html">catman</A>. HTML output is generated |
| </P> |
on-the-fly by <A HREF="mandoc.3.html">libmandoc</A> or internal methods to convert pre-formatted pages. |
| </TD> |
</P> |
| </TR> |
<P> |
| <TR> |
Lastly, the mailing list archive for the discuss and tech lists are being hosted by <A CLASS="external" |
| <TD> |
HREF="http://www.gmane.org">Gmane</A> at <A HREF="http://dir.gmane.org/gmane.comp.tools.mdocml.user" |
| <H1> |
CLASS="external">gmane.comp.tools.mdocml.user</A> and <A HREF="http://dir.gmane.org/gmane.comp.tools.mdocml.devel" |
| <A NAME="contact">CONTACT</A> |
CLASS="external">gmane.comp.tools.mdocml.devel</A>, respectively. |
| </H1> |
</P> |
| |
<P CLASS="news"> |
| <P> |
08-10-2011: version 1.12.0 |
| For all issues related to <SPAN CLASS="nm">mdocml</SPAN>, contact Kristaps Dzonsons, kris<A |
</P> |
| CLASS="external" |
<P> |
| HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q==" |
This version features a new, work-in-progress <A HREF="mandoc.1.html">mandoc</A> output mode: -<B>Tman</B>. This mode |
| TITLE="Reveal this e-mail address">...</A>@bsd.lv. |
allows a system maintainer to distribute <A HREF="man.7.html">man</A> media for older systems that may not natively |
| </P> |
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> |
| You may also subscribe to several mailing lists (these require subscription, which is moderated). An |
<P> |
| archive is not yet available on-line, although you may request one once subscribed. |
While adding features, an <A HREF="apropos.1.html">apropos</A> utility has been merged from the mandoc-tools sandbox. |
| </P> |
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 |
| <TABLE WIDTH="100%" SUMMARY="Mailing Lists"> |
(such as for functions, utilities, etc.) and regular expressions. |
| <COL WIDTH="200"> |
Note that the calling syntax for <B>apropos</B> is likely to change as it settles down. |
| <COL> |
</P> |
| <TBODY> |
<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 |
| <TD> |
considerably more readable by adding <I>MACRO OVERVIEW</I> sections, by moving the gory details of the <I>LANGUAGE |
| disc<A CLASS="external" TITLE="Reveal this e-mail address" |
SYNTAX</I> to the <A HREF="roff.7.html">roff</A> manual, and by moving the very technical <I>MACRO SYNTAX</I> sections |
| HREF="http://www.google.com/recaptcha/mailhide/d?k=01KQ80PFH5n3BBNpF5Gs4sRg==&c=EV1QytpQqTHSItc2IXvZyocgYLPnG5K0JKw_gwMC9yc=">...</A>@mdocml.bsd.lv |
down to the bottom of the page. |
| </TD> |
</P> |
| <TD>high-level discussions and version announcements</TD> |
<P> |
| </TR> |
Furthermore, for <A HREF="tbl.7.html">tbl</A>, the -<B>Tascii</B> mode horizontal spacing of tables was rewritten |
| <TR> |
completely. It is now compatible with <A HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A>, both |
| <TD> |
with and without frames and rulers. Nesting of indented blocks is now supported in <A HREF="man.7.html">man</A>, and |
| tec<A CLASS="external" TITLE="Reveal this e-mail address" |
several bugs were fixed regarding indentation and alignment. The page headers in <A HREF="mdoc.7.html">mdoc</A> are now |
| HREF="http://www.google.com/recaptcha/mailhide/d?k=01qDX_iV0RlUOarEvb6mR28g==&c=gRXsTjza0NNCFPaYu-Taj2tF0pmYZSc90EZkFkhkxgo=">...</A>@mdocml.bsd.lv |
nicer for very long titles. |
| </TD> |
</P> |
| <TD>low-level discussions</TD> |
<P> |
| </TR> |
See <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/index.sgml?cvsroot=mdocml">cvsweb</A> for |
| <TR> |
historical notes. |
| <TD> |
</P> |
| sou<A CLASS="external" TITLE="Reveal this e-mail address" |
<P CLASS="foot"> |
| HREF="http://www.google.com/recaptcha/mailhide/d?k=01prQrAZhhl2EbIwVcRfABsQ==&c=KtTW4Yic9xk-8g40KzJoca4fR3MYXv28g8NC6OQV-T8=">...</A>@mdocml.bsd.lv |
<SMALL> |
| </TD> |
Copyright © 2008–2011 |
| <TD>source commit messages</TD> |
<A CLASS="external" HREF="http://kristaps.bsd.lv">Kristaps Dzonsons</A>, |
| </TR> |
$Date$ |
| </TBODY> |
</SMALL> |
| </TABLE> |
</P> |
| </TD> |
|
| </TR> |
|
| <TR> |
|
| <TD> |
|
| <H1> |
|
| <A NAME="news">NEWS</A> |
|
| </H1> |
|
| <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> |
|
| <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. |
|
| </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