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.82 and 1.102

version 1.82, 2010/06/19 20:43:35

version 1.102, 2011/01/04 23:32:39

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, PostScript, and PDF. <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 76

Line 69

</H2>

<COL>

<TBODY>

<TR>

Line 100

Line 93

</H2>

<COL>

<TBODY>

<TR>

Line 139

Line 132

</H2>

<COL>

<TBODY>

<TR>

Line 159

Line 152

</H1>

<P>

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

</P>

<COL>

<TBODY>

<TR>

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

</DIV>

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

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

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

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

</DIV>

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

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

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

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

</DIV>

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

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

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

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

</DIV>

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

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

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

</DIV>

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

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

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

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

</DIV>

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

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

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

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

</DIV>

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

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

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

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

</DIV>

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

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

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

</SPAN>

</TD>

</TR>

<TR>

tbl-mandoc language reference

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

</SPAN>

</TD>

</TR>

</TBODY>

</TABLE>

Line 254

Line 283

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

</P>

<COL>

<TBODY>

<TR>

Line 274

Line 303

disc<A CLASS="external" TITLE="Reveal this e-mail address"

HREF="http://www.google.com/recaptcha/mailhide/d?k=01KQ80PFH5n3BBNpF5Gs4sRg==&c=EV1QytpQqTHSItc2IXvZyocgYLPnG5K0JKw_gwMC9yc=">...</A>@mdocml.bsd.lv

</TD>

<TD>high-level discussions and version announcements</TD>

<TD>

bug-reports, general questions, and announcements

<SPAN STYLE="font-size: smaller;">(<A HREF="/archives/discuss/summary.html">archive</A>)</SPAN>

</TD>

</TR>

<TR>

<TD>

tec<A CLASS="external" TITLE="Reveal this e-mail address"

HREF="http://www.google.com/recaptcha/mailhide/d?k=01qDX_iV0RlUOarEvb6mR28g==&c=gRXsTjza0NNCFPaYu-Taj2tF0pmYZSc90EZkFkhkxgo=">...</A>@mdocml.bsd.lv

</TD>

<TD>low-level discussions</TD>

<TD>

patches and system discussions

<SPAN STYLE="font-size: smaller;">(<A HREF="/archives/tech/summary.html">archive</A>)</SPAN>

</TD>

</TR>

<TR>

<TD>

sou<A CLASS="external" TITLE="Reveal this e-mail address"

HREF="http://www.google.com/recaptcha/mailhide/d?k=01prQrAZhhl2EbIwVcRfABsQ==&c=KtTW4Yic9xk-8g40KzJoca4fR3MYXv28g8NC6OQV-T8=">...</A>@mdocml.bsd.lv

</TD>

<TD>source commit messages</TD>

<TD>

source commit messages

<SPAN STYLE="font-size: smaller;">(<A HREF="/archives/source/summary.html">archive</A>)</SPAN>

</TD>

</TR>

</TBODY>

</TABLE>

Line 301

Line 339

</H1>

<P>

<SPAN CLASS="date">19-06-2010</SPAN>:

<SPAN CLASS="date">03-01-2011</SPAN>:

version 1.10.2

version 1.10.9

</P>

<P>

Small release featuring text-decoration in <SPAN CLASS="flag">-Tps</SPAN> output, a few

<A HREF="tbl.7.html">tbl</A> functionality (see the <Q>TS</Q>, <Q>TE</Q>, and

minor relaxations of errors, and some optimisations.

<Q>T&</Q> macros in the <A HREF="roff.7.html#x5c265453">roff</A> manual) has been

merged from <A CLASS="external" HREF="http://tbl.bsd.lv">tbl.bsd.lv</A>. Many back-end

fixes have also been implemented, primarily in argument handling (quoting) and <A

HREF="man.7.html">man</A> documents.

</P>

</DIV>

<P>

<SPAN CLASS="date">07-06-2010</SPAN>:

<SPAN CLASS="date">24-12-2010</SPAN>:

version 1.10.1

version 1.10.8

</P>

<P>

This primarily focusses on the <Q>Bl</Q> and <Q>It</Q> macros described in <A

Significant improvements merged from <A CLASS="external"

HREF="mdoc.7.html">mdoc</A>. Multi-line column support is now fully compatible with

HREF="http://www.openbsd.org">OpenBSD</A> downstream, including

groff, as are implicit list entries for columns. Removed manuals.7 in favour of <A

CLASS="external" HREF="http://manpages.bsd.lv">http://manpages.bsd.lv</A>. The way we

handle the SYNOPSIS section (see the SYNOPSIS documentation in <A

HREF="mdoc.7.html#x4d414e55414cx20x535452554354555245">MANUAL STRUCTURE</A>) has also

been considerably simplified compared to groff's method. Furthermore, the <SPAN

CLASS="flag">-Owidth=width</SPAN> output option has been added to <SPAN

CLASS="flag">-Tascii</SPAN> (see <A HREF="mandoc.1.html">mandoc</A>). Lastly, initial

PostScript output has been added with the <SPAN CLASS="flag">-Tps</SPAN> option to <A

HREF="mandoc.1.html">mandoc</A>. It's brutally simple at the moment: fixed-font, with

no font decorations.

</P>

</DIV>

<P>

<SPAN CLASS="date">29-05-2010</SPAN>:

version 1.10.0

</P>

<P>

Release consisting of the results from the m2k10 hackathon and up-merge from OpenBSD.

This requires a significant note of thanks to Ingo Schwarze (OpenBSD) and Joerg

Sonnenberger (NetBSD) for their hard work, and again to Joerg for hosting m2k10.

Highlights (mostly cribbed from Ingo's m2k10 report) follow in no particular order:

</P>

<UL>

<LI>a <A HREF="roff.3.html">libroff</A> preprocessor in front of <A

<LI>many new <A HREF="roff.7.html">roff</A> components,</LI>

HREF="mdoc.3.html">libmdoc</A> and <A HREF="man.3.html">libman</A> stripping out

<LI>in-line implementation of troff's soelim,</LI>

<A HREF="roff.7.html">roff</A> instructions;</LI>

<LI>broken-block handling,</LI>

<LI>end-of-sentence (EOS) detection in free-form and macro lines;</LI>

<LI>overhauled error classifications, and</LI>

<LI>correct handling of tab-separated columnar lists in <SPAN

<LI>cleaned up handling of error conditions.</LI>

CLASS="flag">-mdoc</SPAN>;</LI>

<LI>improved main calling routines to optionally use mmap() for better

performance;</LI>

<LI>cleaned up exiting when invoked as <SPAN CLASS="flag">-Tlint</SPAN> or over

multiple files with <SPAN CLASS="flag">-fign-errors</SPAN>;</LI>

<LI>error and warning message handling re-written to be unified for <A

HREF="roff.3.html">libroff</A>, <A HREF="mdoc.3.html">libmdoc</A>, and <A

HREF="man.3.html">libman</A>;</LI>

<LI>handling of badly-nested explicit-scoped macros;</LI>

<LI>improved free-form text parsing in <A HREF="man.3.html">libman</A> and <A

HREF="mdoc.3.html">libmdoc</A>;</LI>

<LI>significant GNU troff compatibility improvements in <SPAN

CLASS="flag">-Tascii</SPAN>, largely in terms of spacing;</LI>

<LI>a regression framework for making sure the many fragilities of GNU troff

aren't trampled in subsequent work;</LI>

<LI>support for <SPAN CLASS="flag">-Tascii</SPAN> breaking at hyphens

encountered in free-form text;</LI>

<LI>and many more minor fixes and improvements (no really, consult <A

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

Also overhauled the <SPAN CLASS="flag">-Thtml</SPAN> and <SPAN

version 1.9.25

CLASS="flag">-Txhtml</SPAN> output modes. They now display readable output in arbitrary

</P>

browsers, including text-based ones like <A CLASS="external"

<P>

HREF="http://lynx.isc.org">lynx</A>. See HTML and XHTML manuals in the <A

Fixed handling of <Q>\*(Ba</Q> escape. Backed out <SPAN

HREF="#documentation">DOCUMENTATION</A> section for examples. <SPAN

CLASS="flag">-fno-ign-chars</SPAN> (pointless complexity). Fixed erroneous

CLASS="attn">Attention: available style-sheet classes have been considerably

breaking of literal lines. Fixed SYNOPSIS breaking lines before non-initial

changed!</SPAN> See the <SPAN CLASS="file">example.style.css</SPAN> file for details.

macros. Changed default section ordering. Most importantly, the framework for

Lastly, <A HREF="mdoc.3.html">libmdoc</A> and <A HREF="man.3.html">libman</A> have been

end-of-sentence double-spacing is in place, now implemented for the

cleaned up and reduced in size and complexity.

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

CVSweb