version 1.154.2.11, 2013/10/13 18:32:44 |
version 1.160, 2013/10/05 20:09:24 |
|
|
<SPAN CLASS="nm">mdocml</SPAN> consists of the <A HREF="mandoc.3.html">libmandoc</A> validating compiler and <A |
<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 |
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. |
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, |
<A HREF="mandocdb.8.html">mandocdb</A>, for indexing manuals; and |
<A HREF="mandocdb.8.html">mandocdb</A> for indexing manuals, |
<A HREF="apropos.1.html">apropos</A>, <A HREF="whatis.1.html">whatis</A>, and |
<A HREF="apropos.1.html">apropos</A> (includes whatis mode) for indexed manual search, and |
<A HREF="man.cgi.7.html">man.cgi</A> (via <A HREF="catman.8.html">catman</A>) for semantic search of manual content. |
<A HREF="man.cgi.7.html">man.cgi</A> for indexed manual search online. |
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; however, you'll |
<SPAN CLASS="nm">mdocml</SPAN> is in ISO C99 and should build and run on any modern system; however, you'll need <A |
need <A HREF="http://www.oracle.com/technetwork/database/berkeleydb/overview/index.html">libdb</A> to build <A |
HREF="http://www.sqlite.org">sqlite3</A> to build <A HREF="apropos.1.html">apropos</A> (links to whatis), |
HREF="apropos.1.html">apropos</A>, <A HREF="whatis.1.html">whatis</A>, <A HREF="man.cgi.7.html">man.cgi</A>, <A |
<A HREF="man.cgi.7.html">man.cgi</A>, and <A HREF="mandocdb.8.html">mandocdb</A>. |
HREF="catman.8.html">catman</A>, and <A HREF="mandocdb.8.html">mandocdb</A> (this is installed by default on BSD UNIX |
To build and install into <I>/usr/local/</I>, just run <CODE>make install</CODE>. |
systems — see the <I>Makefile</I> if you're running Linux). To build and install into <I>/usr/local/</I>, just |
Be careful: the <B>preconv</B>, <B>apropos</B>, and <B>whatis</B> binary names are usually taken by existing utilities. |
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> |
Downstream |
Downstream |
|
|
<TR> |
<TR> |
<TD>DragonFly BSD</TD> |
<TD>DragonFly BSD</TD> |
<TD> |
<TD> |
<A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/contrib/mdocml" CLASS="external">contrib/mdocml</A> (1.12.2 sources) |
<A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/contrib/mdocml" CLASS="external">contrib/mdocml</A> (1.12.1 sources) |
<A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/lib/libmandoc" CLASS="external">lib/libmandoc</A> |
<A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/lib/libmandoc" CLASS="external">lib/libmandoc</A> |
<A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc" CLASS="external">usr.bin/mandoc</A> (build system) |
<A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc" CLASS="external">usr.bin/mandoc</A> (build system) |
</TD> |
</TD> |
|
|
<TR> |
<TR> |
<TD>Alpine Linux</TD> |
<TD>Alpine Linux</TD> |
<TD> |
<TD> |
<A HREF="http://git.alpinelinux.org/cgit/aports/tree/main/mdocml" CLASS="external">aports/main/mdocml</A> (1.12.2 port) |
<A HREF="http://git.alpinelinux.org/cgit/aports/tree/main/mdocml" CLASS="external">aports/main/mdocml</A> (1.12.1 port) |
</TD> |
</TD> |
</TR> |
</TR> |
</TBODY> |
</TBODY> |
|
|
</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 |
|
</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="catman.8.html">catman(8)</A></TD> |
|
<TD VALIGN="top"> |
|
update a man.cgi manpage cache |
|
</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 |
|
|
</TR> |
</TR> |
</TBODY> |
</TBODY> |
</TABLE> |
</TABLE> |
<H2> |
|
<A NAME="links">Supplementary Information</A> |
|
</H2> |
|
<UL> |
|
<LI> |
|
<A HREF="http://manpages.bsd.lv/">Practical UNIX Manuals</A>: mdoc tutorial by Kristaps Dzonsons |
|
</LI> |
|
<LI> |
|
<A HREF="http://www.openbsd.org/faq/ports/specialtopics.html#Mandoc" CLASS="external">OpenBSD porting guide</A> |
|
chapter regarding manual pages |
|
</LI> |
|
<LI> |
|
<A HREF="press.html">Publications and media coverage</A> |
|
concerning mdocml and mandoc |
|
</LI> |
|
<LI> |
|
<A HREF="http://manpages.bsd.lv/history.html">History of UNIX Manpages</A>: a comprehensive overview by Kristaps Dzonsons |
|
</LI> |
|
</UL> |
|
<H1> |
<H1> |
<A NAME="contact">Contact</A> |
<A NAME="contact">Contact</A> |
</H1> |
</H1> |
|
|
<A NAME="news">News</A> |
<A NAME="news">News</A> |
</H1> |
</H1> |
<P CLASS="news"> |
<P CLASS="news"> |
|
xx-xx-2013: version 1.13.0 |
|
</P> |
|
<P> |
|
The <A HREF="mandocdb.8.html">mandocdb</A> tools (<A HREF="mandocdb.8.html">mandocdb</A>, <A |
|
HREF="apropos.1.html">apropos</A> (absorbing whatis), and <A HREF="man.cgi.7.html">man.cgi</A>) have been re-written to |
|
use <A CLASS="external" HREF="http://www.sqlite.org">sqlite3</A> as a database. |
|
</P> |
|
<P CLASS="news"> |
05-10-2013: version 1.12.2 |
05-10-2013: version 1.12.2 |
</P> |
</P> |
<P> |
<P> |
|
|
For mandoc developers, we now provide a <A HREF="tbl.3.html">tbl(3)</A> library manual and <CODE>gmdiff</CODE>, |
For mandoc developers, we now provide a <A HREF="tbl.3.html">tbl(3)</A> library manual and <CODE>gmdiff</CODE>, |
a very small, very simplistic groff-versus-mandoc output comparison tool. |
a very small, very simplistic groff-versus-mandoc output comparison tool. |
</P> |
</P> |
|
<P> |
|
See <A HREF="NEWS">NEWS</A> for historical notes. |
|
</P> |
<P CLASS="news"> |
<P CLASS="news"> |
23-03-2012: version 1.12.1 |
23-03-2012: version 1.12.1 |
</P> |
</P> |
|
|
<P> |
<P> |
Lastly, I'm no longer providing binaries, as nobody has asked for them. |
Lastly, I'm no longer providing binaries, as nobody has asked for them. |
</P> |
</P> |
<H2> |
<P> |
<A>History</A> |
See <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/index.sgml?cvsroot=mdocml">cvsweb</A> for |
</H2> |
historical notes. |
<UL> |
</P> |
<LI> |
|
<A HREF="NEWS">Release notes</A> going back to release 1.9.15, February 18, 2010. |
|
Briefly explaining the most important changes in each release in relatively easy terms. |
|
Very many changes are not mentioned here. |
|
</LI> |
|
<LI> |
|
<A HREF="history.html">Development history</A> going back to the beginning of the project, November 22, 2008. |
|
One-line entries for important commits, releases, merges, hackathons and talks. |
|
Makes it easy to find out who did what, and when, and when it became available where. |
|
However, this is still incomplete, mentioning only a small fraction of all commits, |
|
and to keep the size down, the individual entries are extremely terse and technical. |
|
Feel free to look up more details and longer explanations about individual entries |
|
in the ChangeLog or in CVS. |
|
</LI> |
|
<LI> |
|
<A HREF="ChangeLog">CVS ChangeLog</A> going back to the beginning of the project. |
|
Very technical information of varying quality, strictly chronological. |
|
All commits are mentioned, but some messages neglect to mention some changes. |
|
Partly terse, partly detailed and verbose. In any case, the ChangeLog is very long - |
|
more than 25,000 lines, more than 700 kB. |
|
</LI> |
|
<LI> |
|
<A HREF="/cgi-bin/cvsweb/?cvsroot=mdocml">CVS</A> web interface, going back to the beginning of the project. |
|
Source code, diffs and commit messages for each source file. The real thing. |
|
</LI> |
|
</UL> |
|
<P CLASS="foot"> |
<P CLASS="foot"> |
<SMALL> |
<SMALL> |
Copyright © 2008–2011 |
Copyright © 2008–2011 |