mandoc/index.sgml - diff

Return to index.sgml CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/Attic/index.sgml between version 1.154.2.12 and 1.159

version 1.154.2.12, 2013/11/07 21:57:14

version 1.159, 2013/10/02 06:45:43

Line 7

</HEAD>

<BODY>

mdocml – UNIX manpage compiler, current version @VERSION@ (@VDATE@)

Line 21

Line 20

mdocml is a suite of tools compiling <A HREF="mdoc.7.html">mdoc</A>, the roff macro

package of choice for BSD manual pages, and <A HREF="man.7.html">man</A>, the predominant historical package for

UNIX manuals.

UNIX manuals. The mission of mdocml is to deprecate <A

It is small, ISO C, <A CLASS="external" HREF="http://www.isc.org/software/license">ISC</A>-licensed, and quite fast.

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.

Why? groff amounts to over 5 MB of source code, most of which is C++ and GPL version 3. 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).

mdocml 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;

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.

mdocml has predominantly been developed on OpenBSD

and is both an <A CLASS="external" HREF="http://www.openbsd.org/">OpenBSD</A>

and a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv</A> project.

We strive to support all interested free operating systems, in particular

<A CLASS="external" HREF="http://www.netbsd.org/">NetBSD</A>,

<A CLASS="external" HREF="http://www.dragonflybsd.org/">DragonFly</A>,

<A CLASS="external" HREF="http://www.freebsd.org/">FreeBSD</A>,

<A CLASS="external" HREF="http://www.minix3.org/">Minix 3</A>,

and <A CLASS="external" HREF="http://www.gnu.org/">GNU</A>/Linux,

as well as all systems running the <A CLASS="external" HREF="http://www.pkgsrc.org/">pkgsrc</A> portable package build system.

All of these projects have helped to make mdocml better, by providing feedback and advice,

bug reports, and patches.

Disambiguation: mdocml is often referred to by its installed binary, <Q>mandoc</Q>.

<H2>

<A NAME="sources">Sources</A>

</H2>

mdocml is in plain-old ANSI C and should build and run on any modern system; however, you'll

mdocml 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 /usr/local/, just run <CODE>make install</CODE>.

systems — see the Makefile if you're running Linux). To build and install into /usr/local/, just

Be careful: the preconv, apropos, and whatis binary names are usually taken by existing utilities.

run <CODE>make install</CODE>. Be careful: the preconv, apropos, and whatis binary names are

usually taken by existing utilities.

<H2>

Downstream

Line 79

Line 69

<TR>

<TD>DragonFly BSD</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:/usr.bin/mandoc" CLASS="external">usr.bin/mandoc</A> (build system)

</TD>

Line 94

Line 84

<TR>

<TD>FreeBSD 9.x, 8.x</TD>

<TD>

<A HREF="http://svnweb.freebsd.org/ports/head/textproc/mdocml/" CLASS="external">ports/textproc/mdocml</A> (1.12.1 port)

<A HREF="http://svnweb.freebsd.org/ports/textproc/mdocml/" CLASS="external">ports/textproc/mdocml</A> (1.12.1 port)

</TD>

</TR>

<TR>

Line 112

Line 102

<TR>

<TD>pkgsrc</TD>

<TD>

<A HREF="http://pkgsrc.se/textproc/mdocml" CLASS="external">textproc/mdocml</A> (1.12.2 port)

<A HREF="http://pkgsrc.se/textproc/mdocml" CLASS="external">textproc/mdocml</A> (1.12.0 port)

</TD>

</TR>

<TR>

Line 121

Line 111

<A HREF="http://git.minix3.org/?p=minix.git;a=tree;f=external/bsd/mdocml" CLASS="external">external/bsd/mdocml</A> (1.10.9 sources and build system)

</TD>

</TR>

<TR>

<TD>Alpine Linux</TD>

<TD>

<A HREF="http://git.alpinelinux.org/cgit/aports/tree/main/mdocml" CLASS="external">aports/main/mdocml</A> (1.12.2 port)

</TD>

</TR>

</TBODY>

</TABLE>

<H1>

Line 166

Line 150

</TD>

</TR>

<TR>

<TD VALIGN="top"><A HREF="whatis.1.html">whatis(1)</A></TD>

search the manual page database

</TD>

</TR>

<TR>

<TD VALIGN="top"><A HREF="mandoc.3.html">mandoc(3)</A></TD>

mandoc macro compiler library

Line 226

Line 204

</TD>

</TR>

<TR>

<TD VALIGN="top"><A HREF="catman.8.html">catman(8)</A></TD>

update a man.cgi manpage cache

</TD>

</TR>

<TR>

<TD VALIGN="top"><A HREF="mandocdb.8.html">mandocdb(8)</A></TD>

index UNIX manuals

Line 239

Line 211

</TR>

</TBODY>

</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>

<A NAME="contact">Contact</A>

</H1>

Line 305

Line 258

</H1>

05-10-2013: version 1.12.2

xx-xx-2013: version 1.13.0

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.

01-10-2013: version 1.12.2

The <A HREF="mdoc.7.html">mdoc(7)</A> to <A HREF="man.7.html">man(7)</A> converter,

to be called as <CODE>mandoc -Tman</CODE>, is now fully functional.

Line 348

Line 309

a very small, very simplistic groff-versus-mandoc output comparison tool.

23-03-2012: version 1.12.1

23-03-2011: version 1.12.1

Significant work on <A HREF="apropos.1.html">apropos</A> and <A HREF="mandocdb.8.html">mandocdb</A>. These tools are

Line 371

Line 332

Lastly, I'm no longer providing binaries, as nobody has asked for them.

<H2>

<A>History</A>

See <A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/index.sgml?cvsroot=mdocml">cvsweb</A> for

</H2>

historical notes.

<UL>

<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>

CVSweb