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

version 1.154.2.7, 2013/10/05 14:05:09

version 1.154.2.15, 2013/12/31 11:23:23

Line 7

</HEAD>

<BODY>

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

Line 20

Line 21

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. The mission of mdocml is to deprecate <A

UNIX manuals.

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

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

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

The tool set features <A HREF="mandoc.1.html">mandoc</A>,

uncertain output, and varies in operation from system to system. mdocml strives to fix this (respectively small, C, <A

based on the <A HREF="mandoc.3.html">libmandoc</A> validating compiler,

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

to format output for UNIX terminals (with

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;

<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="apropos.1.html">apropos</A>, <A HREF="whatis.1.html">whatis</A>, and

<A HREF="man.cgi.7.html">man.cgi</A> (via <A HREF="catman.8.html">catman</A>) for semantic search of manual content.

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.dragonflybsd.org/">DragonFly</A>,

<A CLASS="external" HREF="http://www.netbsd.org/">NetBSD</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 should build and run on any modern system with

need <A HREF="http://www.oracle.com/technetwork/database/berkeleydb/overview/index.html">libdb</A> to build <A

<A HREF="http://www.oracle.com/technetwork/database/berkeleydb/overview/index.html">libdb</A>

HREF="apropos.1.html">apropos</A>, <A HREF="whatis.1.html">whatis</A>, <A HREF="man.cgi.7.html">man.cgi</A>, <A

(this is installed by default on BSD UNIX systems — see the Makefile if you're running Linux).

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 installed binary names

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

may be taken by existing utilities.

usually taken by existing utilities.

<H2>

Downstream

Line 61

Line 69

Several systems come bundled with mdocml utilities.

If your system does not appear below, the maintainers have not contacted me and it should not be considered

<Q>official</Q>.

<Q>official</Q>, so please <A HREF="#contact">contact us</A> if you plan on maintaining a downstream version!

Please <A HREF="#contact">contact us</A> if you plan on maintaining a downstream version!

Line 71

Line 78

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

<A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/contrib/mdocml" CLASS="external">contrib/mdocml</A> (1.12.3 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 86

Line 93

<TR>

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

<TD>

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

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

</TD>

</TR>

<TR>

Line 98

Line 105

<TR>

<TD>OpenBSD</TD>

<TD>

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

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

</TD>

</TR>

<TR>

<TD>pkgsrc</TD>

<TD>

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

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

</TD>

</TR>

<TR>

Line 116

Line 123

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

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

</TD>

</TR>

</TBODY>

Line 231

Line 238

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

Line 304

</H1>

02-10-2013: version 1.12.2

31-12-2013: version 1.12.3

In the <A HREF="mdoc.7.html">mdoc(7)</A> SYNOPSIS, line breaks and hanging indentation

now work correctly for .Fo/.Fa/.Fc and .Fn blocks.

Thanks to Franco Fichtner for doing part of the work.

The <A HREF="mdoc.7.html">mdoc(7)</A> .Bk macro got some addititonal bugfixes.

In <A HREF="mdoc.7.html">mdoc(7)</A> macro arguments, double quotes can now be quoted

by doubling them, just like in <A HREF="man.7.html">man(7)</A>.

Thanks to Tsugutomo ENAMI for the patch.

At the end of <A HREF="man.7.html">man(7)</A> macro lines, end-of-sentence spacing

now works. Thanks to Franco Fichtner for the patch.

For backward compatibility, the <A HREF="man.7.html">man(7)</A> parser now supports the

man-ext .UR/.UE (uniform resource identifier) block macros.

The <A HREF="man.7.html">man(7)</A> parser now handles closing blocks that are not open

more gracefully.

The <A HREF="man.7.html">man(7)</A> parser now ignores blank lines right after .SH and .SS.

In the <A HREF="man.7.html">man(7)</A> formatter, reset indentation when leaving a block,

not just when entering the next one.

The <A HREF="roff.7.html">roff(7)</A> .nr request now supports incrementing and decrementing

number registers and stops parsing the number right before the first non-digit character.

The <A HREF="roff.7.html">roff(7)</A> parser now supports the alternative escape sequence

syntax \C'uXXXX' for Unicode characters.

The <A HREF="roff.7.html">roff(7)</A> parser now parses and ignores the .fam (font family)

and .hw (hyphenation points) requests and the \d and \u escape sequences.

The <A HREF="roff.7.html">roff(7)</A> manual got a new ESCAPE SEQUENCE REFERENCE.

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

Line 396

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.

<H2>

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

<A>History</A>

</H2>

<UL>

23-03-2011: version 1.12.1

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

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

Very many changes are not mentioned here.

now much more robust.

</LI>

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

<LI>

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

<A HREF="history.html">Development history</A> going back to the beginning of the project, November 22, 2008.

such as GNU troff.

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,

The <A HREF="man.cgi.7.html">man.cgi</A> script is also now available for wider testing. It interfaces with <A

and to keep the size down, the individual entries are extremely terse and technical.

HREF="mandocdb.8.html">mandocdb</A> manuals cached by <A HREF="catman.8.html">catman</A>. HTML output is generated

Feel free to look up more details and longer explanations about individual entries

on-the-fly by <A HREF="mandoc.3.html">libmandoc</A> or internal methods to convert pre-formatted pages.

in the ChangeLog or in CVS.

</LI>

<LI>

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

<A HREF="ChangeLog">CVS ChangeLog</A> going back to the beginning of the project.

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

Very technical information of varying quality, strictly chronological.

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

All commits are mentioned, but some messages neglect to mention some changes.

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

Partly terse, partly detailed and verbose. In any case, the ChangeLog is very long -

more than 25,000 lines, more than 700 kB.

</LI>

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

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

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

</LI>

historical notes.

</UL>

CVSweb