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.83 and 1.84

version 1.83, 2010/07/11 23:07:47

version 1.84, 2010/07/21 09:59:52

Line 15

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

</DIV>

<A HREF="#description">Description</A> |

<A HREF="#sources">Sources</A> |

<A HREF="#documentation">Documentation</A> |

<A HREF="#contact">Contact</A> |

</DIV>

</TD>

</TR>

<TR>

Line 31

Line 24

</H1>

<P>

<SPAN CLASS="nm">mdocml</SPAN> is a suite of tools compiling <Q>-mdoc</Q>, the roff macro package

<SPAN CLASS="nm">mdocml</SPAN> is a suite of tools compiling <Q>-<A HREF="mdoc.7.html">mdoc</A></Q>, the

of choice for BSD manual pages, and <Q>-man</Q>, the predominant historical package for UNIX

roff macro package of choice for BSD manual pages, and <Q>-<A HREF="man.7.html">man</A></Q>, the

manuals. The mission of <SPAN CLASS="nm">mdocml</SPAN> is to deprecate <A

predominant historical package for UNIX manuals. The mission of <SPAN CLASS="nm">mdocml</SPAN> is to

HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A>, the GNU roff implementation, for

deprecate <A HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A>, the GNU troff

displaying -mdoc pages whilst providing token support for -man.

implementation, for displaying -mdoc pages whilst providing token support for -man.

</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, ISC-licensed, fast and regular).

this (respectively small, C, <A CLASS="external"

HREF="http://www.isc.org/software/license">ISC</A>-licensed, fast and regular).

</P>

<P>

The core of <SPAN CLASS="nm">mdocml</SPAN> is composed of the <A HREF="mdoc.3.html">libmdoc</A>, <A

<SPAN CLASS="nm">mdocml</SPAN> consists of the <A HREF="mdoc.3.html">libmdoc</A>, <A

HREF="man.3.html">libman</A>, and <A HREF="roff.3.html">libroff</A> validating compiler libraries. All

HREF="man.3.html">libman</A>, and <A HREF="roff.3.html">libroff</A> validating compilers; and <A

are simple, fast libraries operating on memory buffers, so they may be used for a variety of front-ends

HREF="mandoc.1.html">mandoc</A>, which interfaces with the compiler libraries to format output for UNIX

(terminal-based, CGI and so on). The front-end is <A HREF="mandoc.1.html">mandoc</A>, which formats

terminals, XHTML, HTML, and PostScript. <SPAN CLASS="nm">mdocml</SPAN> is a <A CLASS="external"

manuals for display.

HREF="http://bsd.lv/">BSD.lv</A> project.

</P>

<P>

The <SPAN CLASS="nm">mdocml</SPAN> suite is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv

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

Project</A> member.

<Q>mandoc</Q>.

</P>

</TD>

</TR>

Line 65

Line 59

</H1>

<P>

Sources correctly build and install on DragonFly BSD, FreeBSD, OpenBSD, NetBSD, GNU/Linux, and many

<SPAN CLASS="nm">mdocml</SPAN> is architecture- and system-neutral, written in plain-old C. The most

other operating systems, tested variously on i386, AMD64, alpha, and others. The most current version

current version is <SPAN CLASS="attn">@VERSION@</SPAN>, dated <SPAN class="attn">@VDATE@</SPAN>. A full

is <SPAN CLASS="attn">@VERSION@</SPAN>, dated <SPAN class="attn">@VDATE@</SPAN>. A full <A

<A HREF="ChangeLog.html">ChangeLog</A> (<A HREF="ChangeLog.txt">txt</A>) is written with each release.

HREF="ChangeLog.html">ChangeLog</A> (<A HREF="ChangeLog.txt">txt</A>) is written with each release.

</P>

<H2>

Line 159

Line 152

</H1>

<P>

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

</P>

Line 170

Line 163

man macro compiler library

<A HREF="man.3.txt">text</A> | <A HREF="man.3.ps">postscript</A>

(<A HREF="man.3.txt">text</A> | <A HREF="man.3.ps">postscript</A>)

</DIV>

</SPAN>

</TD>

</TR>

<TR>

man language reference

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

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

</DIV>

</SPAN>

</TD>

</TR>

<TR>

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

format and display UNIX manuals

<A HREF="mandoc.1.txt">text</A> | <A HREF="mandoc.1.ps">postscript</A>

(<A HREF="mandoc.1.txt">text</A> | <A HREF="mandoc.1.ps">postscript</A>)

</DIV>

</SPAN>

</TD>

</TR>

<TR>

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

mandoc special characters

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

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

</DIV>

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

</SPAN>

</TD>

</TR>

<TR>

mdoc macro compiler library

<A HREF="mdoc.3.txt">text</A> | <A HREF="mdoc.3.ps">postscript</A>

(<A HREF="mdoc.3.txt">text</A> | <A HREF="mdoc.3.ps">postscript</A>)

</DIV>

</SPAN>

</TD>

</TR>

<TR>

mdoc language reference

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

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

</DIV>

</SPAN>

</TD>

</TR>

<TR>

roff macro compiler library

<A HREF="roff.3.txt">text</A> | <A HREF="roff.3.ps">postscript</A>

(<A HREF="roff.3.txt">text</A> | <A HREF="roff.3.ps">postscript</A>)

</DIV>

</SPAN>

</TD>

</TR>

<TR>

roff-mandoc language reference

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

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

</DIV>

</SPAN>

</TD>

</TR>

</TBODY>

Line 254

Line 248

</H1>

<P>

For all issues related to <SPAN CLASS="nm">mdocml</SPAN>, contact Kristaps Dzonsons, kris<A

Please use the mailing lists for bug-reports, patches, questions, etc. Beyond that, contact

CLASS="external"

Kristaps at <A

HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q=="

TITLE="Reveal this e-mail address">...</A>@bsd.lv.

TITLE="Reveal this e-mail address">kris...</A>@bsd.lv.

</P>

<P>

You may also subscribe to several mailing lists (these require subscription, which is moderated). An

You may also subscribe to several mailing lists (these require subscription, which is

archive is not yet available on-line, although you may request one once subscribed.

moderated). An archive is not yet available on-line, although you may request one once

subscribed.

</P>

Line 388

Line 383

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

for yourself!).</LI>

</UL>

</DIV>

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

<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

CVSweb