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.139 and 1.151

version 1.139, 2011/09/02 13:04:05

version 1.151, 2011/12/14 23:17:12

Line 3

<HEAD>

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

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

</HEAD>

<BODY>

mdocml – mdoc macro compiler, current version @VERSION@ (@VDATE@)

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

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

Line 41

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;

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

Line 51

Line 53

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

</H2>

mdocml is in plain-old ANSI C and should build and run on any modern system.

mdocml is in plain-old ANSI C and should build and run on any modern system; however, you'll

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

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

Be aware: if you have an existing groff installation, this may overwrite its preconv binary.

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

The <A HREF="mandocdb.8.html">mandocdb</A> utility is not yet linked to the build; please <A HREF="#contact">contact

HREF="catman.8.html">catman</A>, and <A HREF="mandocdb.8.html">mandocdb</A> (this is installed by default on BSD UNIX

us</A> if you plan to use it.

systems — see the Makefile if you're running Linux). To build and install into /usr/local/, just

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

usually taken by existing utilities.

<H2>

<A NAME="binaries">Binaries</A>

Line 107

Line 111

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

</TD>

</TR>

<TR>

<TD>pkgsrc</TD>

<TD>

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

</TD>

</TR>

</TBODY>

</TABLE>

<H1>

Line 122

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

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

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

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

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

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

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

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

<A HREF="apropos.1.ps">ps</A>)

</TD>

</TR>

<TR>

Line 142

Line 152

</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.xhtml">xhtml</A> |

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

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

</TD>

</TR>

<TR>

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

recode multibyte UNIX manuals

Line 152

Line 172

</TD>

</TR>

<TR>

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

search the manual page database

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

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

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

<A HREF="whatis.1.ps">ps</A>)

</TD>

</TR>

<TR>

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

mandoc macro compiler library

Line 172

Line 202

</TD>

</TR>

<TR>

cgi for manpage query and display

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

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

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

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

</TD>

</TR>

<TR>

eqn-mandoc language reference

Line 222

Line 262

</TD>

</TR>

<TR>

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

update a man.cgi manpage cache

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

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

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

<A HREF="catman.8.ps">ps</A>)

</TD>

</TR>

<TR>

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

index UNIX manuals

Line 241

Line 291

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

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

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

Line 254

Line 304

</TD>

<TD>

bug-reports, general questions, and announcements

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

</TD>

</TR>

<TR>

Line 264

Line 313

</TD>

<TD>

patches and system discussions

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

</TD>

</TR>

<TR>

Line 274

Line 322

</TD>

<TD>

source commit messages

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

</TD>

</TR>

</TBODY>

Line 283

Line 330

</H1>

02-09-2011: version 1.11.7

xx-xx-2011: version 1.12.1

Added <A HREF="demandoc.1.html">demandoc</A> utility for stripping away macros and escapes. This replaces the

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

historical <CODE>deroff</CODE> utility. Also improved the <A HREF="mdoc.7.html">mdoc</A> and <A HREF="man.7.html">man</A> manuals.

now much more robust and in line with other manpage systems. A <A HREF="whatis.1.html">whatis</A> implementation is now

handled as an <A HREF="apropos.1.html">apropos</A> mode. These tools are also able to minimally handle pre-formatted

pages, that is, those already formatted by another utility such as GNU troff.

16-08-2011: version 1.11.6

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.

Handling of tr macro in <A HREF="roff.7.html">roff</A> implemented. This makes Perl documentation much more

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

readable. Hyphenation is also now enabled in <A HREF="man.7.html">man</A> format documents. Many other general

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

improvements have been implemented. Furthermore, a 64-bit Windows binary is now available at <A

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

HREF="/binaries/mdocml-win64.zip">mdocml-win64.zip</A> and a Mac OS X universal binary is available at <A

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

HREF="/binaries/mdocml-macosx.zip">mdocml-macosx.zip</A>.

24-07-2011: version 1.11.5

08-10-2011: version 1.12.0

Significant <A HREF="eqn.7.html">eqn</A> improvements. mdocml can now parse arbitrary eqn input

This version features a new, work-in-progress <A HREF="mandoc.1.html">mandoc</A> output mode: -Tman. This mode

(although few GNU extensions are accepted, nor is mixing low-level roff with eqn). See the <A HREF="eqn.7.html">eqn</A>

allows a system maintainer to distribute <A HREF="man.7.html">man</A> media for older systems that may not natively

manual for details. For the time being, equations are rendered as simple in-line text. The equation parser satisfies

support <A HREF="mdoc.7.html">mdoc</A>, such as old Solaris systems.

the language specified in the <A CLASS="external" HREF="http://www.kohala.com/start/troff/v7man/eqn/eqn2e.ps">Second

The -Ofragment option was added to <A HREF="mandoc.1.html">mandoc</A>'s -Thtml and -Txhtml modes.

Edition User's Guide</A>.

This is also the first release featuring a distributed Windows binary, available at <A

While adding features, an <A HREF="apropos.1.html">apropos</A> utility has been merged from the mandoc-tools sandbox.

HREF="/binaries/mdocml-win32.zip">/binaries/mdocml-win32.zip</A>.

This interfaces with <A HREF="mandocdb.8.html">mandocdb</A> for semantic search of manual content. <A

HREF="apropos.1.html">apropos</A> is different from the traditional apropos primarily in allowing keyword search

(such as for functions, utilities, etc.) and regular expressions.

Note that the calling syntax for apropos is likely to change as it settles down.

In documentation news, the <A HREF="mdoc.7.html">mdoc</A> and <A HREF="man.7.html">man</A> manuals have been made

considerably more readable by adding MACRO OVERVIEW sections, by moving the gory details of the LANGUAGE

SYNTAX to the <A HREF="roff.7.html">roff</A> manual, and by moving the very technical MACRO SYNTAX sections

down to the bottom of the page.

Furthermore, for <A HREF="tbl.7.html">tbl</A>, the -Tascii mode horizontal spacing of tables was rewritten

completely. It is now compatible with <A HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A>, both

with and without frames and rulers. Nesting of indented blocks is now supported in <A HREF="man.7.html">man</A>, and

several bugs were fixed regarding indentation and alignment. The page headers in <A HREF="mdoc.7.html">mdoc</A> are now

nicer for very long titles.

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

CVSweb