version 1.140, 2011/09/02 14:00:09 |
version 1.150, 2011/12/10 23:44:42 |
|
|
<HEAD> |
<HEAD> |
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8"> |
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8"> |
<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> |
<P CLASS="head"> |
<P CLASS="head"> |
<B>mdocml</B> – mdoc macro compiler, current version @VERSION@ (@VDATE@) |
<B>mdocml</B> – UNIX manpage compiler, current version @VERSION@ (@VDATE@) |
</P> |
</P> |
<P CLASS="subhead"> |
<P CLASS="subhead"> |
Sources: <A HREF="/snapshots/mdocml.tar.gz">current</A>, |
Sources: <A HREF="/snapshots/mdocml.tar.gz">current</A>, |
|
|
support for wide-character locales), XHTML, HTML, PostScript, and PDF. |
support for wide-character locales), XHTML, HTML, PostScript, and PDF. |
It also includes <A HREF="preconv.1.html">preconv</A>, for recoding multibyte manuals; |
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="demandoc.1.html">demandoc</A>, for emitting only text parts of manuals; |
and <A HREF="mandocdb.8.html">mandocdb</A>, for indexing 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. |
It is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv</A> project. |
</P> |
</P> |
<P> |
<P> |
|
|
<A NAME="sources">Sources</A> |
<A NAME="sources">Sources</A> |
</H2> |
</H2> |
<P> |
<P> |
<SPAN CLASS="nm">mdocml</SPAN> is in plain-old ANSI C and should build and run on any modern system. |
<SPAN CLASS="nm">mdocml</SPAN> is in plain-old ANSI C and should build and run on any modern system; however, you'll |
To build and install into <I>/usr/local/</I>, just run <CODE>make install</CODE>. |
need <A HREF="http://www.oracle.com/technetwork/database/berkeleydb/overview/index.html">libdb</A> to build <A |
Be aware: if you have an existing groff installation, this may overwrite its <B>preconv</B> binary. |
HREF="apropos.1.html">apropos</A>, <A HREF="whatis.1.html">whatis</A>, <A HREF="man.cgi.7.html">man.cgi</A>, <A |
The <A HREF="mandocdb.8.html">mandocdb</A> utility is not yet linked to the build; please <A HREF="#contact">contact |
HREF="catman.8.html">catman</A>, and <A HREF="mandocdb.8.html">mandocdb</A> (this is installed by default on BSD UNIX |
us</A> if you plan to use it. |
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> |
</P> |
<H2> |
<H2> |
<A NAME="binaries">Binaries</A> |
<A NAME="binaries">Binaries</A> |
|
|
CLASS="external">src/usr.bin/mandoc</A> |
CLASS="external">src/usr.bin/mandoc</A> |
</TD> |
</TD> |
</TR> |
</TR> |
|
<TR> |
|
<TD>pkgsrc</TD> |
|
<TD> |
|
<A HREF="http://pkgsrc.se/textproc/mdocml" CLASS="external">textproc/mdocml</A> |
|
</TD> |
|
</TR> |
</TBODY> |
</TBODY> |
</TABLE> |
</TABLE> |
<H1> |
<H1> |
|
|
<COL> |
<COL> |
<TBODY> |
<TBODY> |
<TR> |
<TR> |
<TD VALIGN="top"><A HREF="mandoc.1.html">mandoc(1)</A></TD> |
<TD VALIGN="top"><A HREF="apropos.1.html">apropos(1)</A></TD> |
<TD VALIGN="top"> |
<TD VALIGN="top"> |
format and display UNIX manuals |
search the manual page database |
(<A HREF="mandoc.1.txt">text</A> | |
(<A HREF="apropos.1.txt">text</A> | |
<A HREF="mandoc.1.xhtml">xhtml</A> | |
<A HREF="apropos.1.xhtml">xhtml</A> | |
<A HREF="mandoc.1.pdf">pdf</A> | |
<A HREF="apropos.1.pdf">pdf</A> | |
<A HREF="mandoc.1.ps">ps</A>) |
<A HREF="apropos.1.ps">ps</A>) |
</TD> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
|
|
</TD> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
|
<TD VALIGN="top"><A HREF="mandoc.1.html">mandoc(1)</A></TD> |
|
<TD VALIGN="top"> |
|
format and display UNIX manuals |
|
(<A HREF="mandoc.1.txt">text</A> | |
|
<A HREF="mandoc.1.xhtml">xhtml</A> | |
|
<A HREF="mandoc.1.pdf">pdf</A> | |
|
<A HREF="mandoc.1.ps">ps</A>) |
|
</TD> |
|
</TR> |
|
<TR> |
<TD VALIGN="top"><A HREF="preconv.1.html">preconv(1)</A></TD> |
<TD VALIGN="top"><A HREF="preconv.1.html">preconv(1)</A></TD> |
<TD VALIGN="top"> |
<TD VALIGN="top"> |
recode multibyte UNIX manuals |
recode multibyte UNIX manuals |
|
|
</TD> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
|
<TD VALIGN="top"><A HREF="whatis.1.html">whatis(1)</A></TD> |
|
<TD VALIGN="top"> |
|
search the manual page database |
|
(<A HREF="whatis.1.txt">text</A> | |
|
<A HREF="whatis.1.xhtml">xhtml</A> | |
|
<A HREF="whatis.1.pdf">pdf</A> | |
|
<A HREF="whatis.1.ps">ps</A>) |
|
</TD> |
|
</TR> |
|
<TR> |
<TD VALIGN="top"><A HREF="mandoc.3.html">mandoc(3)</A></TD> |
<TD VALIGN="top"><A HREF="mandoc.3.html">mandoc(3)</A></TD> |
<TD VALIGN="top"> |
<TD VALIGN="top"> |
mandoc macro compiler library |
mandoc macro compiler library |
|
|
</TD> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
|
<TD VALIGN="top"><A HREF="man.cgi.7.html">man.cgi(7)</A></TD> |
|
<TD VALIGN="top"> |
|
cgi for manpage query and display |
|
(<A HREF="man.cgi.7.txt">text</A> | |
|
<A HREF="man.cgi.7.xhtml">xhtml</A> | |
|
<A HREF="man.cgi.7.pdf">pdf</A> | |
|
<A HREF="man.cgi.7.ps">ps</A>) |
|
</TD> |
|
</TR> |
|
<TR> |
<TD VALIGN="top"><A HREF="eqn.7.html">eqn(7)</A></TD> |
<TD VALIGN="top"><A HREF="eqn.7.html">eqn(7)</A></TD> |
<TD VALIGN="top"> |
<TD VALIGN="top"> |
eqn-mandoc language reference |
eqn-mandoc language reference |
|
|
</TD> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
|
<TD VALIGN="top"><A HREF="catman.8.html">catman(8)</A></TD> |
|
<TD VALIGN="top"> |
|
update a man.cgi manpage cache |
|
(<A HREF="catman.8.txt">text</A> | |
|
<A HREF="catman.8.xhtml">xhtml</A> | |
|
<A HREF="catman.8.pdf">pdf</A> | |
|
<A HREF="catman.8.ps">ps</A>) |
|
</TD> |
|
</TR> |
|
<TR> |
<TD VALIGN="top"><A HREF="mandocdb.8.html">mandocdb(8)</A></TD> |
<TD VALIGN="top"><A HREF="mandocdb.8.html">mandocdb(8)</A></TD> |
<TD VALIGN="top"> |
<TD VALIGN="top"> |
index UNIX manuals |
index UNIX manuals |
|
|
<A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/TODO?cvsroot=mdocml">TODO</A> for known issues |
<A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/TODO?cvsroot=mdocml">TODO</A> for known issues |
before posting. All lists are subscription-only: send a blank e-mail to the listed address to subscribe. Beyond that, |
before posting. All lists are subscription-only: send a blank e-mail to the listed address to subscribe. Beyond that, |
contact Kristaps at <A HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q==" TITLE="Reveal |
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. |
this e-mail address">kris...</A>@bsd.lv. Archives are available at <A HREF="http://gmane.org/" CLASS="external">Gmane</A>. |
</P> |
</P> |
<TABLE WIDTH="100%" SUMMARY="Mailing Lists"> |
<TABLE WIDTH="100%" SUMMARY="Mailing Lists"> |
<COL WIDTH="175"> |
<COL WIDTH="175"> |
|
|
</TD> |
</TD> |
<TD> |
<TD> |
bug-reports, general questions, and announcements |
bug-reports, general questions, and announcements |
(<A HREF="/archives/discuss/">archive</A>) |
|
</TD> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
|
|
</TD> |
</TD> |
<TD> |
<TD> |
patches and system discussions |
patches and system discussions |
(<A HREF="/archives/tech/">archive</A>) |
|
</TD> |
</TD> |
</TR> |
</TR> |
<TR> |
<TR> |
|
|
</TD> |
</TD> |
<TD> |
<TD> |
source commit messages |
source commit messages |
(<A HREF="/archives/source/">archive</A>) |
|
</TD> |
</TD> |
</TR> |
</TR> |
</TBODY> |
</TBODY> |
|
|
<A NAME="news">News</A> |
<A NAME="news">News</A> |
</H1> |
</H1> |
<P CLASS="news"> |
<P CLASS="news"> |
02-09-2011: version 1.11.7 |
xx-xx-2011: version 1.12.1 |
</P> |
</P> |
<P> |
<P> |
Added <A HREF="demandoc.1.html">demandoc</A> utility for stripping away macros and escapes. This replaces the |
Significant work on <A HREF="apropos.1.html">apropos</A> and <A HREF="mandocdb.8.html">mandocdb</A>. These tools are |
historical <CODE>deroff</CODE> utility. Also improved the <A HREF="mdoc.7.html">mdoc</A> and <A HREF="man.7.html">man</A> manuals. |
now much more robust and in line with other manpage systems. A <A HREF="whatis.1.html">whatis</A> implementation is now |
|
handled as an <A HREF="apropos.1.html">apropos</A> mode. These tools are also able to minimally handle pre-formatted |
|
pages, that is, those already formatted by another utility such as GNU troff. |
</P> |
</P> |
|
<P> |
|
The <A HREF="man.cgi.7.html">man.cgi</A> script is also now available for wider testing. It interfaces with <A |
|
HREF="mandocdb.8.html">mandocdb</A> manuals cached by <A HREF="catman.8.html">catman</A>. HTML output is generated |
|
on-the-fly by <A HREF="mandoc.3.html">libmandoc</A> or internal methods to convert pre-formatted pages. |
|
</P> |
<P CLASS="news"> |
<P CLASS="news"> |
16-08-2011: version 1.11.6 |
08-10-2011: version 1.12.0 |
</P> |
</P> |
<P> |
<P> |
Handling of <B>tr</B> macro in <A HREF="roff.7.html">roff</A> implemented. This makes Perl documentation much more |
This version features a new, work-in-progress <A HREF="mandoc.1.html">mandoc</A> output mode: -<B>Tman</B>. This mode |
readable. Hyphenation is also now enabled in <A HREF="man.7.html">man</A> format documents. Many other general |
allows a system maintainer to distribute <A HREF="man.7.html">man</A> media for older systems that may not natively |
improvements have been implemented. Furthermore, a 64-bit Windows binary is now available at <A |
support <A HREF="mdoc.7.html">mdoc</A>, such as old Solaris systems. |
HREF="/binaries/mdocml-win64.zip">mdocml-win64.zip</A> and a Mac OS X universal binary is available at <A |
The -<B>Ofragment</B> option was added to <A HREF="mandoc.1.html">mandoc</A>'s -<B>Thtml</B> and -<B>Txhtml</B> modes. |
HREF="/binaries/mdocml-macosx.zip">mdocml-macosx.zip</A>. |
|
</P> |
</P> |
<P CLASS="news"> |
<P> |
24-07-2011: version 1.11.5 |
While adding features, an <A HREF="apropos.1.html">apropos</A> utility has been merged from the mandoc-tools sandbox. |
|
This interfaces with <A HREF="mandocdb.8.html">mandocdb</A> for semantic search of manual content. <A |
|
HREF="apropos.1.html">apropos</A> is different from the traditional <B>apropos</B> primarily in allowing keyword search |
|
(such as for functions, utilities, etc.) and regular expressions. |
|
Note that the calling syntax for <B>apropos</B> is likely to change as it settles down. |
</P> |
</P> |
<P> |
<P> |
Significant <A HREF="eqn.7.html">eqn</A> improvements. <SPAN CLASS="nm">mdocml</SPAN> can now parse arbitrary eqn input |
In documentation news, the <A HREF="mdoc.7.html">mdoc</A> and <A HREF="man.7.html">man</A> manuals have been made |
(although few GNU extensions are accepted, nor is mixing low-level roff with eqn). See the <A HREF="eqn.7.html">eqn</A> |
considerably more readable by adding <I>MACRO OVERVIEW</I> sections, by moving the gory details of the <I>LANGUAGE |
manual for details. For the time being, equations are rendered as simple in-line text. The equation parser satisfies |
SYNTAX</I> to the <A HREF="roff.7.html">roff</A> manual, and by moving the very technical <I>MACRO SYNTAX</I> sections |
the language specified in the <A CLASS="external" HREF="http://www.kohala.com/start/troff/v7man/eqn/eqn2e.ps">Second |
down to the bottom of the page. |
Edition User's Guide</A>. |
|
</P> |
</P> |
<P> |
<P> |
This is also the first release featuring a distributed Windows binary, available at <A |
Furthermore, for <A HREF="tbl.7.html">tbl</A>, the -<B>Tascii</B> mode horizontal spacing of tables was rewritten |
HREF="/binaries/mdocml-win32.zip">/binaries/mdocml-win32.zip</A>. |
completely. It is now compatible with <A HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A>, both |
|
with and without frames and rulers. Nesting of indented blocks is now supported in <A HREF="man.7.html">man</A>, and |
|
several bugs were fixed regarding indentation and alignment. The page headers in <A HREF="mdoc.7.html">mdoc</A> are now |
|
nicer for very long titles. |
</P> |
</P> |
<P> |
<P> |
See <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/index.sgml?cvsroot=mdocml">cvsweb</A> for |
See <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/index.sgml?cvsroot=mdocml">cvsweb</A> for |