X-Git-Url: https://git.cameronkatri.com/mandoc.git/blobdiff_plain/0d31fe8e373641961cf6174f5eda01fafe311ad3..4e957717ad89c68ef09435675e11743d569642be:/index.sgml diff --git a/index.sgml b/index.sgml index 2da1913e..f7b7f253 100644 --- a/index.sgml +++ b/index.sgml @@ -3,11 +3,11 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta name="resource-type" content="document"> - <link rel="stylesheet" href="style.css" type="text/css" media="all"> + <link rel="stylesheet" href="index.css" type="text/css" media="all"> <title>mdocml.bsd.lv</title> </head> <body> - <table width="600"> + <table class="frame" summary="[frame]"> <col width="100%"> <tbody> <tr> @@ -28,12 +28,7 @@ of choice for BSD manual pages, and “-man”, the predominant historical package for UNIX manuals. The mission of <span class="nm">mdocml</span> is to deprecate <a href="http://www.gnu.org/software/groff/" class="external">groff</a>, the GNU roff implementation, for - displaying <a href="mdoc.7.txt" class="man">mdoc(7)</a> pages whilst providing token support for <a - href="man.7.txt" class="man">man(7)</a>. - </p> - - <p> - What are UNIX manuals? Read <a href="manuals.7.txt" class="man">manuals(7)</a> for an introduction. + displaying -mdoc pages whilst providing token support for -man. </p> <p> @@ -43,118 +38,151 @@ </p> <p> - The core of <span class="nm">mdocml</span> are the <a href="man.3.txt" class="man">man(3)</a> and <a - href="mdoc.3.txt" class="man">mdoc(3)</a> libraries, validating compilers producing intermediate-form - 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). - </p> - - <p> - 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. - </p> - - <p> - <span class="attn">Please submit patches, bug reports and suggestions!</span> Although a significant - implementation exists, work remains for the backend library and especially the front-end utilities. See - the <a href="#contact">contact</a> information below for submissions. + The core of <span class="nm">mdocml</span> is composed of the <i>libmdoc</i> and <i>libman</i> + validating compiler libraries. 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 <i> + mandoc</i>, which formats manuals for display on the terminal. </p> </td> </tr> <tr> <td> <h1> - INSTALLING SOURCES + SOURCES </h1> <p> - Sources correctly build and install on FreeBSD, OpenBSD, NetBSD and Linux operating systems, tested - variously on i386, AMD64, alpha and others. - </p> - - <p> - The most current version is <span class="attn">@VERSION@</span>, dated - <span class="attn">@VDATE@</span>. + Sources correctly build and install on DragonFly BSD, FreeBSD, OpenBSD, NetBSD, and GNU/Linux operating + systems, tested variously on i386, AMD64, alpha, and others. The most current version is <span + class="attn">@VERSION@</span>, dated <span class="attn">@VDATE@</span>. A full <a + href="ChangeLog.html">ChangeLog</a> (<a href="ChangeLog.txt">txt</a>) is written with each release. </p> <h2> - Snapshot source + Current </h2> - <p> - CVS sources are checkedout and snapshotted with version updates. These may be found in the <a - href="/snapshots/">/snapshots/</a> directory. A full <a href="/snapshots/ChangeLog">ChangeLog</a> is - written with each new snapshot. - </p> - - <p class="boxed"> - % cd /tmp<br> - % ftp -V -o- <a href="http://mdocml.bsd.lv/snapshots/mdocml.tar.gz"> - http://mdocml.bsd.lv/snapshots/mdocml.tar.gz</a> | tar -zvxf -<br> - % cd mdocml<br> - % make all<br> - # make install - </p> + <table width="100%" summary="Current Sources"> + <col width="200"> + <col> + <tbody> + <tr> + <td>Source archive</td> + <td> + <a href="/snapshots/mdocml.tar.gz">/snapshots/mdocml.tar.gz</a> + (<a href="/snapshots/mdocml.md5">md5</a>) + </td> + </tr> + <tr> + <td>Online source</td> + <td> + <a class="external" href="http://bsd.lv/cgi-bin/cvsweb.cgi/?cvsroot=mdocml">cvsweb</a> + </td> + </tr> + </tbody> + </table> <h2> - Snapshot port/pkgsrc + Downstream </h2> - <p> - The source snapshot is automatically converted into OpenBSD, NetBSD and FreeBSD ports at <a - 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. - </p> + <table width="100%" summary="Downstream Sources"> + <col width="200"> + <col> + <tbody> + <tr> + <td>DragonFly BSD</td> + <td> + <a href="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc" + class="external">usr.bin/mandoc</a> + </td> + </tr> + <tr> + <td>FreeBSD</td> + <td> + <a href="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/" + class="external">ports/textproc/mdocml</a> + </td> + </tr> + <tr> + <td>NetBSD</td> + <td> + <a href="http://cvsweb.netbsd.org/bsdweb.cgi/src/external/bsd/mdocml/" + class="external">src/external/bsd/mdocml</a> + </td> + </tr> + <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> + </td> + </tr> + </tbody> + </table> - <h3> - OpenBSD port - </h3> - - <p class="boxed"> - # pkg_delete mdocml<br> - # cd /usr/ports/textproc/<br> - # rm -rf mdocml<br> - # 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 -<br> - # cd mdocml<br> - # make build<br> - # make install - </p> - - <h3> - NetBSD pkgsrc - </h3> - - <p class="boxed"> - # pkg_delete mdocml<br> - # cd /usr/pkgsrc/textproc/<br> - # rm -rf mdocml<br> - # 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 -<br> - # cd mdocml<br> - # make build<br> - # make install - </p> + <h2> + Historical + </h2> - <h3> - FreeBSD port - </h3> + <table width="100%" summary="Archived Sources"> + <col width="200"> + <col> + <tbody> + <tr> + <td>Source archive</td> + <td> + <a href="/snapshots/">/snapshots/</a> + </td> + </tr> + </tbody> + </table> + </td> + </tr> + <tr> + <td> + <h1> + DOCUMENTATION + </h1> - <p class="boxed"> - # pkg_delete -x mdocml<br> - # cd /tmp<br> - # 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 -<br> - # cd mdocml<br> - # make<br> - # make install - </p> + <p> + These manuals are generated automatically and refer to the current snapshot. + </p> + + <table width="100%" summary="Documentation"> + <col width="200"> + <col> + <tbody> + <tr> + <td><a href="mandoc.1.html">mandoc(1)</a> (<a href="mandoc.1.txt">text</a>)</td> + <td>format and display UNIX manuals</td> + </tr> + <tr> + <td><a href="mandoc_char.7.html">mandoc_char(7)</a> (<a href="mandoc_char.7.txt">text</a>)</td> + <td>mandoc special characters</td> + </tr> + <tr> + <td><a href="mdoc.7.html">mdoc(7)</a> (<a href="mdoc.7.txt">text</a>)</td> + <td>mdoc language reference</td> + </tr> + <tr> + <td><a href="man.7.html">man(7)</a> (<a href="man.7.txt">text</a>)</td> + <td>man language reference</td> + </tr> + <tr> + <td><a href="manuals.7.html">manuals(7)</a> (<a href="manuals.7.txt">text</a>)</td> + <td>a guide to writing UNIX manuals</td> + </tr> + <tr> + <td><a href="mdoc.3.html">mdoc(3)</a> (<a href="mdoc.3.txt">text</a>)</td> + <td>mdoc macro compiler library</td> + </tr> + <tr> + <td><a href="man.3.html">man(3)</a> (<a href="man.3.txt">text</a>)</td> + <td>man macro compiler library</td> + </tr> + </tbody> + </table> </td> </tr> <tr> @@ -164,24 +192,22 @@ </h1> <p> - Please contact Kristaps, kris<a class="external" + For all issues related to <span class="nm">mdocml</span>, contact Kristaps Džonsons, kris<a + class="external" 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. + title="Reveal this e-mail address">...</a>@kth.se. </p> - + <p> - If you'd like to submit patches, please contact us beforehand in case larger changes are pending but not - checked in. If making a bug report, please make sure it's repeatable on the most current snapshot. + If you want to receive a semi-automated mail-out of new releases, then please write with a message + subject of <i>subscribe mdocml</i> (or <i>unsubscribe mdocml</i>). </p> </td> </tr> <tr> <td> <div class="foot"> - Copyright © 2008, 2009 Kristaps Džonsons, $Date: 2009/06/11 13:34:14 $ + Copyright © 2008, 2009 Kristaps Džonsons, $Date: 2009/10/31 08:37:26 $ </div> </td> </tr>