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.1 and 1.17

version 1.1, 2009/02/23 15:19:47

version 1.17, 2009/06/11 13:34:14

Line 24

</h1>

mdocml is a suite of tools that compile “mdoc”, the roff macro

mdocml is a suite of tools compiling “-mdoc”, the roff macro package

package of the BSD manual pages. The mission of mdocml is to deprecate <a

of choice for BSD manual pages, and “-man”, the predominant historical package for UNIX

manuals. The mission of mdocml is to deprecate <a

href="http://www.gnu.org/software/groff/" class="external">groff</a>, the GNU roff implementation, for

displaying BSD mdoc pages. groff amounts to over 60 000 lines of GPL C++ source, which is a

displaying <a href="mdoc.7.txt" class="man">mdoc(7)</a> pages whilst providing token support for <a

considerable encumbrance to BSD operating system.

href="man.7.txt" class="man">man(7)</a>.

The core of mdocml is the libmdoc library, a validating scanner-parser producing

What are UNIX manuals? Read <a href="manuals.7.txt" class="man">manuals(7)</a> for an introduction.

intermediate-form output from mdoc input. libmdoc is a simple, fast library operating on memory buffers

of mdoc input. Its intermediate output, an abstract syntax tree, is fully documented in the <span

class="man">mdoc(3) reference manual.

There are three utilities implementing mdoc(3):

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

<ul>

<li>mdocterm(1) – formats mdoc input for display on the terminal

<li>mdochtml(1) – formats mdoc input as strict HTML (nascent)

<li>mdoclint(1) – validates mdoc input

<li>mdoctree(1) – prints input abstract syntax tree

</ul>

The mdocterm(1) utility is intended to deprecate usage of <a

The core of mdocml are the <a href="man.3.txt" class="man">man(3)</a> and <a

href="http://www.gnu.org/software/groff/" class="external">groff</a> for displaying BSD manuals to the

href="mdoc.3.txt" class="man">mdoc(3)</a> libraries, validating compilers producing intermediate-form

terminal, either directly or cached as a “catman” page.

output from -man or -mdoc input. Both are simple, fast libraries operating on memory buffers, so they

may be used for a variety of front-ends (terminal-based, CGI and so on).

The primary front-end is <a href="mandoc.1.txt" class="man">mandoc(1)</a>, which formats manuals for

display on the terminal. Its purpose is to deprecate usage of groff for displaying -mdoc and, to a

limited extent, -man manuals on the terminal.

Please submit patches! Although a significant implementation exists, work

Please submit patches, bug reports and suggestions! Although a significant

remains for the backend library and especially the front-end utilities. See the <a

implementation exists, work remains for the backend library and especially the front-end utilities. See

href="#contact">contact</a> information below to submit patches and bug reports.

the <a href="#contact">contact</a> information below for submissions.

</td>

</tr>

Line 68

INSTALLING SOURCES

</h1>

Sources correctly build and install on FreeBSD, OpenBSD, NetBSD and Linux operating systems, tested

variously on i386, AMD64, alpha and others.

The most current version is @VERSION@, dated

@VDATE@.

<h2>

nightly source

Snapshot source

</h2>

CVS sources are checkedout and snapshotted nightly. These may be found in the <a

CVS sources are checkedout and snapshotted with version updates. These may be found in the <a

href="/snapshots/">/snapshots/</a> directory.

href="/snapshots/">/snapshots/</a> directory. A full <a href="/snapshots/ChangeLog">ChangeLog</a> is

written with each new snapshot.

% cd /tmp

% ftp -V -o- http://mdocml.bsd.lv/snapshots/mdocml.tgz | tar -zxf -

% ftp -V -o- <a href="http://mdocml.bsd.lv/snapshots/mdocml.tar.gz">

http://mdocml.bsd.lv/snapshots/mdocml.tar.gz</a> | tar -zvxf -

% cd mdocml

% make

% make all

% make regress

# make install

% make install

<h2>

nightly port

Snapshot port/pkgsrc

</h2>

The nightly snapshot is automatically converted into an OpenBSD port (ports for other BSD systems not

The source snapshot is automatically converted into OpenBSD, NetBSD and FreeBSD ports at <a

yet available). These may be found in the <a href="/ports-openbsd/">/ports-openbsd/</a> directory.

href="/ports-openbsd/">/ports-openbsd/</a>, <a href="/ports-netbsd/">/ports-netbsd/</a> and <a

href="/ports-freebsd/">/ports-freebsd/</a>, respectively. Please read the <a class="external"

href="http://www.openbsd.org/faq/faq15.html">OpenBSD Ports FAQ</a>, the <a class="external"

href="http://www.netbsd.org/docs/software/packages.html">NetBSD pkgsrc guide</a> or the <a

class="external"

href="http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/ports-using.html">FreeBSD ports

guide</a>, first.

<h3>

If installing for the first time:

OpenBSD port

</h3>

% ftp -V -o- http://mdocml.bsd.lv/ports-openbsd/mdocml.tgz | tar -zxf -

# pkg_delete mdocml

% cd mdocml

# cd /usr/ports/textproc/

% sudo make

# rm -rf mdocml

% sudo make install

# ftp -V -o- <a href="http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz">

http://mdocml.bsd.lv/ports-openbsd/mdocml.tar.gz</a> | tar -zvxf -

# cd mdocml

# make build

# make install

<h3>

Subsequent installations:

NetBSD pkgsrc

</h3>

# pkg_delete mdocml

# cd /usr/pkgsrc/textproc/

# rm -rf mdocml

# ftp -V -o- <a href="http://mdocml.bsd.lv/ports-netbsd/mdocml.tar.gz">

http://mdocml.bsd.lv/ports-netbsd/mdocml.tar.gz</a> | tar -zvxf -

# cd mdocml

# make build

# make install

<h3>

FreeBSD port

</h3>

% sudo pkg_add -r mdocml

# pkg_delete -x mdocml

# cd /tmp

# ftp -V -o- <a href="http://mdocml.bsd.lv/ports-freebsd/mdocml.tar.gz">

http://mdocml.bsd.lv/ports-freebsd/mdocml.tar.gz</a> | tar -zvxf -

# cd mdocml

# make

# make install

</td>

</tr>

Line 126

Line 168

href="http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&c=sb5E6ulipc-eTnpTVqI-BQ=="

onclick="window.open('http://mailhide.recaptcha.net/d?k=01jt88xIsFONwVjHZmGpc4AQ==&c=sb5E6ulipc-eTnpTVqI-BQ==',

'', 'toolbar=0,scrollbars=0,location=0,statusbar=0,menubar=0,resizable=0,width=500,height=300'); return

false;" title="Reveal this e-mail address">...</a>@kth.se, with questions, bug reports, patches, and so on.

false;" title="Reveal this e-mail address">...</a>@kth.se, with questions, bug reports, patches, and so

on.

Line 138

Line 181

<tr>

<td>

</div>

</td>

</tr>

CVSweb