![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to index.sgml CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc|
Return to index.sgml CVS log | Up to [cvsweb.bsd.lv] / mandoc |
1.1 kristaps 1: <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
1.40 ! kristaps 2: <HTML>
! 3: <HEAD>
! 4: <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8">
! 5: <META NAME="resource-type" CONTENT="document">
! 6: <LINK REL="stylesheet" HREF="index.css" TYPE="text/css" MEDIA="all">
! 7: <TITLE>mdocml.bsd.lv</TITLE>
! 8: </HEAD>
! 9: <BODY>
! 10: <TABLE CLASS="frame" SUMMARY="[frame]">
! 11: <COL WIDTH="100%">
! 12: <TBODY>
! 13: <TR>
! 14: <TD>
! 15: <DIV CLASS="head">
! 16: <B>mdocml</B> – mdoc macro compiler
! 17: </DIV>
! 18: </TD>
! 19: </TR>
! 20: <TR>
! 21: <TD VALIGN="top">
! 22: <H1>
1.1 kristaps 23: DESCRIPTION
1.40 ! kristaps 24: </H1>
1.1 kristaps 25:
1.40 ! kristaps 26: <P>
! 27: <SPAN CLASS="nm">mdocml</SPAN> is a suite of tools compiling <Q>-mdoc</Q>, the roff macro package
! 28: of choice for BSD manual pages, and <Q>-man</Q>, the predominant historical package for UNIX
! 29: manuals. The mission of <SPAN CLASS="nm">mdocml</SPAN> is to deprecate <A
! 30: HREF="http://www.gnu.org/software/groff/" CLASS="external">groff</A>, the GNU roff implementation, for
1.18 kristaps 31: displaying -mdoc pages whilst providing token support for -man.
1.40 ! kristaps 32: </P>
1.9 kristaps 33:
1.40 ! kristaps 34: <P>
1.13 kristaps 35: Why? groff amounts to over 5 MB of source code, most of which is C++ and all of which is GPL. It runs
36: slowly, produces uncertain output, and varies in operation from system to system. mdocml strives to fix
37: this (respectively small, C, ISC-licensed, fast and regular).
1.40 ! kristaps 38: </P>
1.1 kristaps 39:
1.40 ! kristaps 40: <P>
! 41: The core of <SPAN CLASS="nm">mdocml</SPAN> is composed of the <i>libmdoc</i> and <i>libman</i>
1.19 kristaps 42: validating compiler libraries. Both are simple, fast libraries operating on memory buffers, so they may
43: be used for a variety of front-ends (terminal-based, CGI and so on). The primary front-end is <i>
44: mandoc</i>, which formats manuals for display on the terminal.
1.40 ! kristaps 45: </P>
! 46:
! 47: <P>
! 48: The <SPAN CLASS="nm">mdocml</SPAN> utility is a <A CLASS="external" HREF="http://bsd.lv/">BSD.lv
! 49: Project</A> member.
! 50: </P>
! 51: </TD>
! 52: </TR>
! 53: <TR>
! 54: <TD>
! 55: <H1>
1.33 kristaps 56: SOURCES
1.40 ! kristaps 57: </H1>
1.1 kristaps 58:
1.40 ! kristaps 59: <P>
1.39 kristaps 60: Sources correctly build and install on DragonFly BSD, FreeBSD, OpenBSD, NetBSD, and GNU/Linux operating
1.40 ! kristaps 61: systems, tested variously on i386, AMD64, alpha, and others. The most current version is <SPAN
! 62: CLASS="attn">@VERSION@</SPAN>, dated <SPAN class="attn">@VDATE@</SPAN>. A full <A
! 63: HREF="ChangeLog.html">ChangeLog</A> (<A HREF="ChangeLog.txt">txt</A>) is written with each release.
! 64: </P>
1.7 kristaps 65:
1.40 ! kristaps 66: <H2>
1.26 kristaps 67: Current
1.40 ! kristaps 68: </H2>
1.1 kristaps 69:
1.40 ! kristaps 70: <TABLE WIDTH="100%" SUMMARY="Current Sources">
! 71: <COL WIDTH="200">
! 72: <COL>
! 73: <TBODY>
! 74: <TR>
! 75: <TD>Source archive</TD>
! 76: <TD>
! 77: <A HREF="/snapshots/mdocml.tar.gz">/snapshots/mdocml.tar.gz</A>
! 78: (<A HREF="/snapshots/mdocml.md5">md5</A>)
! 79: </TD>
! 80: </TR>
! 81: <TR>
! 82: <TD>Online source</TD>
! 83: <TD>
! 84: <A CLASS="external" HREF="http://mdocml.bsd.lv/cgi-bin/cvsweb/?cvsroot=mdocml">cvsweb</A>
! 85: </TD>
! 86: </TR>
! 87: </TBODY>
! 88: </TABLE>
1.1 kristaps 89:
1.40 ! kristaps 90: <H2>
1.26 kristaps 91: Downstream
1.40 ! kristaps 92: </H2>
1.1 kristaps 93:
1.40 ! kristaps 94: <TABLE WIDTH="100%" SUMMARY="Downstream Sources">
! 95: <COL WIDTH="200">
! 96: <COL>
! 97: <TBODY>
! 98: <TR>
! 99: <TD>DragonFly BSD</TD>
! 100: <TD>
! 101: <A HREF="http://gitweb.dragonflybsd.org/dragonfly.git/tree/HEAD:/usr.bin/mandoc"
! 102: CLASS="external">usr.bin/mandoc</A>
! 103: </TD>
! 104: </TR>
! 105: <TR>
! 106: <TD>FreeBSD</TD>
! 107: <TD>
! 108: <A HREF="http://www.freebsd.org/cgi/cvsweb.cgi/ports/textproc/mdocml/"
! 109: CLASS="external">ports/textproc/mdocml</A>
! 110: </TD>
! 111: </TR>
! 112: <TR>
! 113: <TD>NetBSD</TD>
! 114: <TD>
! 115: <A HREF="http://cvsweb.netbsd.org/bsdweb.cgi/src/external/bsd/mdocml/"
! 116: CLASS="external">src/external/bsd/mdocml</A>
! 117: </TD>
! 118: </TR>
! 119: <TR>
! 120: <TD>OpenBSD</TD>
! 121: <TD>
! 122: <A HREF="http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/mandoc/"
! 123: CLASS="external">src/usr.bin/mandoc</A>
! 124: </TD>
! 125: </TR>
! 126: </TBODY>
! 127: </TABLE>
1.1 kristaps 128:
1.40 ! kristaps 129: <H2>
1.22 kristaps 130: Historical
1.40 ! kristaps 131: </H2>
1.10 kristaps 132:
1.40 ! kristaps 133: <TABLE WIDTH="100%" SUMMARY="Archived Sources">
! 134: <COL WIDTH="200">
! 135: <COL>
! 136: <TBODY>
! 137: <TR>
! 138: <TD>Source archive</TD>
! 139: <TD>
! 140: <A HREF="/snapshots/">/snapshots/</A>
! 141: </TD>
! 142: </TR>
! 143: </TBODY>
! 144: </TABLE>
! 145: </TD>
! 146: </TR>
! 147: <TR>
! 148: <TD>
! 149: <H1>
1.18 kristaps 150: DOCUMENTATION
1.40 ! kristaps 151: </H1>
1.18 kristaps 152:
1.40 ! kristaps 153: <P>
1.39 kristaps 154: These manuals are generated automatically and refer to the current snapshot.
1.40 ! kristaps 155: </P>
1.24 kristaps 156:
1.40 ! kristaps 157: <TABLE WIDTH="100%" SUMMARY="Documentation">
! 158: <COL WIDTH="200">
! 159: <COL>
! 160: <TBODY>
! 161: <TR>
! 162: <TD><A HREF="mandoc.1.html">mandoc(1)</A> (<A HREF="mandoc.1.txt">text</A>)</TD>
! 163: <TD>format and display UNIX manuals</TD>
! 164: </TR>
! 165: <TR>
! 166: <TD><A HREF="mandoc_char.7.html">mandoc_char(7)</A> (<A HREF="mandoc_char.7.txt">text</A>)</TD>
! 167: <TD>mandoc special characters</TD>
! 168: </TR>
! 169: <TR>
! 170: <TD><A HREF="mdoc.7.html">mdoc(7)</A> (<A HREF="mdoc.7.txt">text</A>)</TD>
! 171: <TD>mdoc language reference</TD>
! 172: </TR>
! 173: <TR>
! 174: <TD><A HREF="man.7.html">man(7)</A> (<A HREF="man.7.txt">text</A>)</TD>
! 175: <TD>man language reference</TD>
! 176: </TR>
! 177: <TR>
! 178: <TD><A HREF="manuals.7.html">manuals(7)</A> (<A HREF="manuals.7.txt">text</A>)</TD>
! 179: <TD>a guide to writing UNIX manuals</TD>
! 180: </TR>
! 181: <TR>
! 182: <TD><A HREF="mdoc.3.html">mdoc(3)</A> (<A HREF="mdoc.3.txt">text</A>)</TD>
! 183: <TD>mdoc macro compiler library</TD>
! 184: </TR>
! 185: <TR>
! 186: <TD><A HREF="man.3.html">man(3)</A> (<A HREF="man.3.txt">text</A>)</TD>
! 187: <TD>man macro compiler library</TD>
! 188: </TR>
! 189: </TBODY>
! 190: </TABLE>
! 191: </TD>
! 192: </TR>
! 193: <TR>
! 194: <TD>
! 195: <H1>
1.1 kristaps 196: CONTACT
1.40 ! kristaps 197: </H1>
1.1 kristaps 198:
1.40 ! kristaps 199: <P>
! 200: For all issues related to <SPAN CLASS="nm">mdocml</SPAN>, contact Kristaps Dzonsons, kris<A
! 201: CLASS="external"
! 202: HREF="http://mailhide.recaptcha.net/d?k=01M6h_w7twDp58ZgH57eWC_w==&c=Q2DBUt401ePlSeupJFrq_Q=="
! 203: TITLE="Reveal this e-mail address">...</A>@bsd.lv.
! 204: </P>
1.18 kristaps 205:
1.40 ! kristaps 206: <P>
1.24 kristaps 207: If you want to receive a semi-automated mail-out of new releases, then please write with a message
1.40 ! kristaps 208: subject of <I>subscribe mdocml</I> (or <I>unsubscribe mdocml</I>).
! 209: </P>
! 210: </TD>
! 211: </TR>
! 212: <TR>
! 213: <TD>
! 214: <H1>
! 215: NEWS
! 216: </H1>
! 217:
! 218: <TABLE WIDTH="100%" CELLPADDING="2">
! 219: <COL STYLE="width: 8em;">
! 220: <TBODY>
! 221: <TR>
! 222: <TD VALIGN="top"><SPAN CLASS="date">15-02-2010</SPAN></TD>
! 223: <TD VALIGN="top">
! 224: Moved to our new <A HREF="http://bsd.lv" CLASS="external">BSD.lv</A> home.
! 225: Version <SPAN CLASS="rev">1.9.15</SPAN>.
! 226: </TD>
! 227: </TR>
! 228: </TBODY>
! 229: </TABLE>
! 230: </TD>
! 231: </TR>
! 232: <TR>
! 233: <TD>
! 234: <DIV CLASS="foot">
! 235: Copyright © 2008–2010 Kristaps Dzonsons, $Date: 2009/10/31 08:37:26 $
! 236: </DIV>
! 237: </TD>
! 238: </TR>
! 239: </TBODY>
! 240: </TABLE>
! 241: </BODY>
! 242: </HTML>