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.129 and 1.161

version 1.129, 2011/07/23 09:47:25

version 1.161, 2013/10/06 17:34:30

Line 3

<HEAD>

<TITLE>mdocml | mdoc macro compiler</TITLE>

<TITLE>mdocml | UNIX manpage compiler</TITLE>

</HEAD>

<BODY>

<B>mdocml</B> – mdoc macro compiler

<B>mdocml</B> – UNIX manpage compiler, current version @VERSION@ (@VDATE@)

</P>

Sources: <A HREF="/snapshots/mdocml.tar.gz">current</A>,

<A HREF="/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A>

(<A HREF="/snapshots/">archives</A>)

</P>

<H1>

<A NAME="description">Description</A>

</H1>

Line 20

Line 25

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

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

</P>

Line 28

Line 33

<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; and <A

It also includes <A HREF="preconv.1.html">preconv</A> for recoding multibyte manuals,

HREF="mandocdb.8.html">mandocdb</A>, for indexing 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,

<A HREF="apropos.1.html">apropos</A> (includes whatis mode) for indexed manual search, and

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

</P>

<P>

<I>Disambiguation</I>: <SPAN CLASS="nm">mdocml</SPAN> is often referred to by its installed binary, <Q>mandoc</Q>.

</P>

<H1>

<H2>

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

</H1>

</H2>

<P>

<SPAN CLASS="nm">mdocml</SPAN> is in plain-old ANSI C and should build and run on any UNIX system, although <A

<SPAN CLASS="nm">mdocml</SPAN> is in ISO C99 and should build and run on any modern system; however, you'll need <A

HREF="mandocdb.8.html">mandocdb</A> requires <A CLASS="external"

HREF="http://www.sqlite.org">sqlite3</A> to build <A HREF="apropos.1.html">apropos</A> (links to whatis),

HREF="http://www.oracle.com/technetwork/database/berkeleydb/overview/index.html">Berkeley Database</A> (this is

<A HREF="man.cgi.7.html">man.cgi</A>, and <A HREF="mandocdb.8.html">mandocdb</A>.

installed by default on all BSD operating systems).

To build and install into <I>/usr/local/</I>, just run <CODE>make install</CODE>.

To compile <SPAN CLASS="nm">mdocml</SPAN>, run <CODE>make</CODE>, then <CODE>make install</CODE> to install into

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

<I>/usr/local</I>.

Be aware: if you have an existing <A HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A> installation,

this may overwrite its <B>preconv</B> binary.

The <A HREF="mandocdb.8.html">mandocdb</A> utility is not yet linked to the build. You must run <CODE>make

mandocdb</CODE> to build it (it does not install).

</P>

<P>

The most current version of <SPAN CLASS="nm">mdocml</SPAN> is <SPAN CLASS="attn">@VERSION@</SPAN>, dated <SPAN

class="attn">@VDATE@</SPAN>.

</P>

<H2>

Current

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>

<COL>

<TBODY>

<TR>

<TD>Source archive</TD>

<TD>DragonFly BSD</TD>

<TD>

<A HREF="/snapshots/mdocml.tar.gz">/snapshots/mdocml.tar.gz</A>

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

</TR>

<TR>

<TD>Online source</TD>

<TD>FreeBSD 10.0, -CURRENT</TD>

<TD>

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

<A HREF="http://svnweb.freebsd.org/base/head/contrib/mdocml/" CLASS="external">contrib/mdocml</A> (1.12.1 sources)

<A HREF="http://svnweb.freebsd.org/base/head/usr.bin/mandoc/" CLASS="external">usr.bin/mandoc</A> (build system)

</TD>

</TR>

</TBODY>

</TABLE>

<H2>

Downstream

</H2>

<COL>

<TBODY>

<TR>

<TD>DragonFly BSD</TD>

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

<TD>

<A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc"

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

CLASS="external">usr.bin/mandoc</A>

</TD>

</TR>

<TR>

<TD>FreeBSD</TD>

<TD>NetBSD</TD>

<TD>

<A HREF="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/"

<A HREF="http://cvsweb.netbsd.org/bsdweb.cgi/src/external/bsd/mdocml/" CLASS="external">src/external/bsd/mdocml</A> (1.12.1 sources plus patches and build system)

CLASS="external">ports/textproc/mdocml</A>

</TD>

</TR>

<TR>

<TD>NetBSD</TD>

<TD>OpenBSD</TD>

<TD>

<A HREF="http://cvsweb.netbsd.org/bsdweb.cgi/src/external/bsd/mdocml/"

<A HREF="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/" CLASS="external">src/usr.bin/mandoc</A> (1.12.2 sources and build system)

CLASS="external">src/external/bsd/mdocml</A>

</TD>

</TR>

<TR>

<TD>OpenBSD</TD>

<TD>pkgsrc</TD>

<TD>

<A HREF="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/"

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

CLASS="external">src/usr.bin/mandoc</A>

</TD>

</TR>

</TBODY>

</TABLE>

<H2>

Historical

</H2>

<COL>

<TBODY>

<TR>

<TD>Source archive</TD>

<TD>Minix3</TD>

<TD>

<A HREF="/snapshots/">/snapshots/</A>

<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.1 port)

</TD>

</TR>

</TBODY>

</TABLE>

<H1>

<A NAME="documentation">Documentation</A>

</H1>

<P>

These manuals are generated automatically and refer to the current snapshot.

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>

Line 140

Line 132

<COL>

<TBODY>

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

format and display UNIX manuals

search the manual page database

<SMALL>

(<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">postscript</A>)

</SMALL>

</TD>

</TR>

<TR>

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

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

index UNIX manuals

emit only text of UNIX manuals

<SMALL>

(<A HREF="mandocdb.8.txt">text</A> |

<A HREF="mandocdb.8.xhtml">xhtml</A> |

<A HREF="mandocdb.8.pdf">pdf</A> |

<A HREF="mandocdb.8.ps">postscript</A>)

</SMALL>

</TD>

</TR>

<TR>

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

format and display UNIX manuals

</TD>

</TR>

<TR>

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

recode multibyte UNIX manuals

<SMALL>

(<A HREF="preconv.1.txt">text</A> |

<A HREF="preconv.1.xhtml">xhtml</A> |

<A HREF="preconv.1.pdf">pdf</A> |

<A HREF="preconv.1.ps">postscript</A>)

</SMALL>

</TD>

</TR>

<TR>

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

mandoc macro compiler library

<SMALL>

(<A HREF="mandoc.3.txt">text</A> |

<A HREF="mandoc.3.xhtml">xhtml</A> |

<A HREF="mandoc.3.pdf">pdf</A> |

<A HREF="mandoc.3.ps">postscript</A>)

</SMALL>

</TD>

</TR>

<TR>

man language reference

roff table parser library for mandoc

<SMALL>

(<A HREF="man.7.txt">text</A> |

<A HREF="man.7.xhtml">xhtml</A> |

<A HREF="man.7.pdf">pdf</A> |

<A HREF="man.7.ps">postscript</A>)

</SMALL>

</TD>

</TR>

<TR>

eqn-mandoc language reference

<SMALL>

(<A HREF="eqn.7.txt">text</A> |

<A HREF="eqn.7.xhtml">xhtml</A> |

<A HREF="eqn.7.pdf">pdf</A> |

<A HREF="eqn.7.ps">postscript</A>)

</SMALL>

</TD>

</TR>

<TR>

man language reference

</TD>

</TR>

<TR>

cgi for manpage query and display

</TD>

</TR>

<TR>

<TD VALIGN="top"><A HREF="mandoc_char.7.html">mandoc_char(7)</A></TD>

mandoc special characters

<SMALL>

(<A HREF="mandoc_char.7.txt">text</A> |

<A HREF="mandoc_char.7.xhtml">xhtml</A> |

<A HREF="mandoc_char.7.pdf">pdf</A> |

<A HREF="mandoc_char.7.ps">postscript</A>)

</SMALL>

</TD>

</TR>

<TR>

mdoc language reference

<SMALL>

(<A HREF="mdoc.7.txt">text</A> |

<A HREF="mdoc.7.xhtml">xhtml</A> |

<A HREF="mdoc.7.pdf">pdf</A> |

<A HREF="mdoc.7.ps">postscript</A>)

</SMALL>

</TD>

</TR>

<TR>

roff-mandoc language reference

<SMALL>

(<A HREF="roff.7.txt">text</A> |

<A HREF="roff.7.xhtml">xhtml</A> |

<A HREF="roff.7.pdf">pdf</A> |

<A HREF="roff.7.ps">postscript</A>)

</SMALL>

</TD>

</TR>

<TR>

tbl-mandoc language reference

<SMALL>

(<A HREF="tbl.7.txt">text</A> |

<A HREF="tbl.7.xhtml">xhtml</A> |

<A HREF="tbl.7.pdf">pdf</A> |

<A HREF="tbl.7.ps">postscript</A>)

</SMALL>

</TD>

</TR>

<TR>

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

index UNIX manuals

</TD>

</TR>

</TBODY>

</TABLE>

<H1>

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

</H1>

<P>

Use the mailing lists for bug-reports, patches, questions, etc. (these require subscription). Please check the

Use the mailing lists for bug-reports, patches, questions, etc. Please check the

<A HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/TODO?cvsroot=mdocml">TODO</A> for known issues

before posting. Beyond that, contact Kristaps at <A

before posting. All lists are subscription-only: send a blank e-mail to the listed address to subscribe. Beyond that,

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>

Line 282

Line 238

</TD>

<TD>

bug-reports, general questions, and announcements

<SMALL>(<A HREF="/archives/discuss/summary.html">archive</A>)</SMALL>

</TD>

</TR>

<TR>

Line 292

Line 247

</TD>

<TD>

patches and system discussions

<SMALL>(<A HREF="/archives/tech/summary.html">archive</A>)</SMALL>

</TD>

</TR>

<TR>

Line 302

Line 256

</TD>

<TD>

source commit messages

<SMALL>(<A HREF="/archives/source/summary.html">archive</A>)</SMALL>

</TD>

</TR>

</TBODY>

Line 311

Line 264

</H1>

xx-07-2011: version 1.11.5

xx-xx-2013: version 1.13.0

</P>

<P>

Significant <A HREF="eqn.7.html">eqn</A> improvements. <SPAN CLASS="nm">mdocml</SPAN> can now parse arbitrary equations

The <A HREF="mandocdb.8.html">mandocdb</A> tools (<A HREF="mandocdb.8.html">mandocdb</A>, <A

(although few GNU troff extensions are accepted, nor is mixing low-level roff with eqn). See the <A

HREF="apropos.1.html">apropos</A> (absorbing whatis), and <A HREF="man.cgi.7.html">man.cgi</A>) have been re-written to

HREF="eqn.7.html">eqn</A> manual for details. For the time being, equations are rendered as simple in-line text.

use <A CLASS="external" HREF="http://www.sqlite.org">sqlite3</A> as a database.

</P>

12-07-2011: version 1.11.4

05-10-2013: version 1.12.2

</P>

<P>

Bug-fixes and clean-ups across all systems, especially in <INS><A HREF="mandocdb.8.html">mandocdb</A></INS> <DEL>makewhatis</DEL> (note: still not

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

connected to the general build and must be compiled with <INS><CODE>make mandocdb</CODE></INS> <DEL><CODE>make makewhatis</CODE></DEL>) and the <A

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

HREF="man.7.html">man</A> parser. This release was significantly assisted by participants in <A CLASS="external"

HREF="http://www.openbsd.org">OpenBSD</A>'s c2k11. Thanks!

</P>

<P>

26-05-2011: version 1.11.3

The <A HREF="mandoc.1.html">mandoc(1)</A> utility now supports the <CODE>-Ios</CODE> (default operating system)

input option, and the <CODE>-Tutf8</CODE> output mode now actually works.

</P>

<P>

Introduce locale-encoding of output with the <B>-Tlocale</B> output option and Unicode escaped-character input.

The <A HREF="mandocdb.8.html">mandocdb(8)</A> utility no longer truncates existing databases when starting to build new ones,

See <A HREF="mandoc.1.html">mandoc</A> and <A HREF="mandoc_char.7.html">mandoc_char</A>, respectively, for details.

but only replaces them when the build actually succeeds.

This allows for non-ASCII characters (e.g., <I>\[u5000]</I>) to be rendered in the locale's encoding, if said

environment supports wide-character encoding (if it does not, <B>-Tascii</B> is used instead).

Locale support can be turned off at compile time by removing <I>-DUSE_WCHAR</I> in the <I>Makefile</I>, in which case

<B>-Tlocale</B> is always a synonym for <B>-Tascii</B>.

</P>

<P>

Furthermore, multibyte-encoded documents, such as those in UTF-8, may be on-the-fly recoded into <A

The <A HREF="man.7.html">man(7)</A> parser now supports the <EM>PD</EM> macro (paragraph distance),

HREF="mandoc.1.html">mandoc</A> input by using the newly-added <A HREF="preconv.1.html">preconv</A> utility.

and (for GNU man-ext compatibility only) <EM>EX</EM> (example block) and <EM>EE</EM> (example end).

Note: in the future, this feature may be integrated into <A HREF="mandoc.1.html">mandoc</A>.

Plus several bugfixes regarding indentation, line breaks, and vertical spacing,

and regarding <EM>RS</EM> following <EM>TP</EM>.

</P>

<P>

The <A HREF="roff.7.html">roff(7)</A> parser now supports the <EM>\f(BI</EM> (bold+italic) font escape,

the <EM>\z</EM> (zero cursor advance) escape and the <EM>cc</EM> (change control character)

and <EM>it</EM> (input line trap) requests.

Plus bugfixes regarding the <EM>\t</EM> (tab) escape, nested escape sequences, and conditional requests.

</P>

<P>

In <A HREF="mdoc.7.html">mdoc(7)</A>, several bugs were fixed related to UTF-8 output of quoting enclosures,

delimiter handling, list indentation and horizontal and vertical spacing,

formatting of the <EM>Lk</EM>, <EM>%U</EM>, and <EM>%C</EM> macros,

plus some bugfixes related to the handling of syntax errors like badly nested font blocks,

stray <EM>Ta</EM> macros outside column lists, unterminated <EM>It Xo</EM> blocks,

and non-text children of <EM>Nm</EM> blocks.

</P>

<P>

In <A HREF="tbl.7.html">tbl(7)</A>, the width of horizontal spans and the vertical spacing around tables was corrected,

and in <A HREF="man.7.html">man(7)</A> files, a crash was fixed that was triggered by some particular unclosed <EM>T{</EM> macros.

</P>

<P>

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.

</P>

<P>

See <A HREF="NEWS">NEWS</A> for historical notes.

</P>

12-05-2011: version 1.11.2

23-03-2012: version 1.12.1

</P>

<P>

Corrected some installation issues in version 1.11.1.

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

Further migration to <A HREF="mandoc.3.html">libmandoc</A>.

now much more robust.

Initial public release (this utility is very much under development) of <INS><A HREF="mandocdb.8.html">mandocdb</A></INS><DEL>makewhatis</DEL>,

A <A HREF="whatis.1.html">whatis</A> implementation is now handled as an <A HREF="apropos.1.html">apropos</A> mode.

initially named mandoc-db.

These tools are also able to minimally handle pre-formatted pages, that is, those already formatted by another utility

This utility produces keyword databases of manual content

such as GNU troff.

<DEL>mandoc-cgi</DEL>,

<A HREF="http://mdocml.bsd.lv/mandoc-tools/index.html">mandoc-tools</A>,

which features semantic querying of manual content.

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

The mailing list archive for the discuss and tech lists are being hosted by <A CLASS="external"

HREF="http://www.gmane.org">Gmane</A> at <A HREF="http://dir.gmane.org/gmane.comp.tools.mdocml.user"

CLASS="external">gmane.comp.tools.mdocml.user</A> and <A HREF="http://dir.gmane.org/gmane.comp.tools.mdocml.devel"

CLASS="external">gmane.comp.tools.mdocml.devel</A>, respectively.

</P>

<P>

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

</P>

<P>

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

historical notes.

</P>

Line 364

Line 349

<SMALL>

<A CLASS="external" HREF="http://kristaps.bsd.lv">Kristaps Dzonsons</A>,

$Date$

</SMALL>

</P>

CVSweb