Finished section-by-section definitions in man.7 (will be used as baseline for mdoc.7).

3 files changed, 105 insertions, 38 deletions

diff --git a/Makefile b/Makefile
index 50f2daf4..193424aa 100644
--- a/Makefile
+++ b/Makefile
@@ -59,10 +59,10 @@ HEADS	   = mdoc.h libmdoc.h man.h libman.h term.h \
 GSGMLS	   = mandoc.1.sgml mdoc.3.sgml mdoc.7.sgml manuals.7.sgml \
 	     mandoc_char.7.sgml man.7.sgml man.3.sgml
 SGMLS	   = index.sgml
+HTMLS	   = ChangeLog.html index.html
 XSLS	   = ChangeLog.xsl
-HTMLS	   = index.html mandoc.1.html mdoc.3.html ChangeLog.html \
-	     man.3.html mdoc.7.html man.7.html mandoc_char.7.html \
-	     manuals.7.html
+GHTMLS	   = mandoc.1.html mdoc.3.html man.3.html mdoc.7.html \
+	     man.7.html mandoc_char.7.html manuals.7.html
 TEXTS	   = mandoc.1.txt mdoc.3.txt man.3.txt mdoc.7.txt man.7.txt \
 	     mandoc_char.7.txt manuals.7.txt ChangeLog.txt
 EXAMPLES   = example.style.css
@@ -74,7 +74,8 @@ MANS	   = mandoc.1 mdoc.3 mdoc.7 manuals.7 mandoc_char.7 \
 	     man.7 man.3
 BINS	   = mandoc
 CLEAN	   = $(BINS) $(LNS) $(LLNS) $(LIBS) $(OBJS) $(HTMLS) \
-	     $(TARGZS) tags $(MD5S) $(XMLS) $(TEXTS) $(GSGMLS)
+	     $(TARGZS) tags $(MD5S) $(XMLS) $(TEXTS) $(GSGMLS) \
+	     $(GHTMLS)
 INSTALL	   = $(SRCS) $(HEADS) Makefile $(MANS) $(SGMLS) $(STATICS) \
 	     $(DATAS) $(XSLS) $(EXAMPLES)
 
@@ -89,14 +90,16 @@ cleanlint:
 	rm -f $(LNS) $(LLNS)
 
 cleanhtml:
-	rm -f $(HTML) $(GSGMLS)
+	rm -f $(HTMLS) $(GSGMLS) $(GHTMLS)
 
 dist:	mdocml-$(VERSION).tar.gz
 
-www:	all $(HTMLS) $(TEXTS) $(MD5S) $(TARGZS)
+www:	all $(GSGMLS) $(GHTMLS) $(HTMLS) $(TEXTS) $(MD5S) $(TARGZS)
+
+htmls:	all $(GSGMLS) $(GHTMLS)
 
 installwww: www
-	install -m 0444 $(HTMLS) $(TEXTS) $(STATICS) $(PREFIX)/
+	install -m 0444 $(GHTMLS) $(HTMLS) $(TEXTS) $(STATICS) $(PREFIX)/
 	install -m 0444 mdocml-$(VERSION).tar.gz $(PREFIX)/snapshots/
 	install -m 0444 mdocml-$(VERSION).md5 $(PREFIX)/snapshots/
 	install -m 0444 mdocml-$(VERSION).tar.gz $(PREFIX)/snapshots/mdocml.tar.gz
diff --git a/index.sgml b/index.sgml
index 884f96fe..f7b7f253 100644
--- a/index.sgml
+++ b/index.sgml
@@ -52,8 +52,8 @@
 					</h1>
 
 					<p>
-					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 <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>
@@ -146,8 +146,7 @@
 					</h1>
 
 					<p>
-					These manuals are generated automatically (with <a href="mandoc.1.html">mandoc(1)</a> -Thtml) and refer to the
-					current snapshot.
+					These manuals are generated automatically and refer to the current snapshot.
 					</p>
 
 					<table width="100%" summary="Documentation">
@@ -208,7 +207,7 @@
 			<tr>
 				<td>
 					<div class="foot">
-						Copyright &#169; 2008, 2009 Kristaps D&#382;onsons, $Date: 2009/10/31 06:50:25 $
+						Copyright &#169; 2008, 2009 Kristaps D&#382;onsons, $Date: 2009/10/31 08:37:26 $
 					</div>
 				</td>
 			</tr>
diff --git a/man.7 b/man.7
index 5c2ac3a2..d94497dc 100644
--- a/man.7
+++ b/man.7
@@ -1,4 +1,4 @@
-.\"	$Id: man.7,v 1.41 2009/10/26 10:36:46 kristaps Exp $
+.\"	$Id: man.7,v 1.42 2009/10/31 08:37:26 kristaps Exp $
 .\"
 .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
 .\"
@@ -14,7 +14,7 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
-.Dd $Mdocdate: October 26 2009 $
+.Dd $Mdocdate: October 31 2009 $
 .Dt MAN 7
 .Os
 .
@@ -229,7 +229,7 @@ The \efBfoo\efR utility processes files...
 \&.\e\*q The next is for sections 2, 3, & 9 only.
 \&.\e\*q .SH ERRORS
 \&.\e\*q .SH SEE ALSO
-\&.\e\*q \efBbar\efR(1)
+\&.\e\*q .BR foo ( 1 )
 \&.\e\*q .SH STANDARDS
 \&.\e\*q .SH HISTORY
 \&.\e\*q .SH AUTHORS
@@ -242,19 +242,19 @@ The sections in a
 .Nm
 document are conventionally ordered as they appear above.  Sections
 should be composed as follows:
-.Bl -tag -width Ds -offset Ds
-.It NAME
+.Bl -ohang -offset indent
+.It Em NAME
 The name(s) and a short description of the documented material.  The
 syntax for this is generally as follows:
 .Pp
 .D1 \efBname\efR \e(en description
-.It LIBRARY
+.It Em LIBRARY
 The name of the library containing the documented material, which is
 assumed to be a function in a section 2 or 3 manual.  For functions in
 the C library, this may be as follows:
 .Pp
 .D1 Standard C Library (libc, -lc)
-.It SYNOPSIS
+.It Em SYNOPSIS
 Documents the utility invocation syntax, function call syntax, or device
 configuration. 
 .Pp
@@ -271,28 +271,93 @@ And for the third, configurations (section 4):
 .Pp
 .D1 \. Ns Sx \&B No name* at cardbus ? function ?
 .Pp
-Manuals not in these sections generally don't need a SYNOPSIS.
-.It DESCRIPTION
-This expands upon the brief, one-line description in NAME.  It usually
-contains a break-down of the options (if documenting a command).
-.It IMPLEMENTATION NOTES
+Manuals not in these sections generally don't need a 
+.Em SYNOPSIS .
+.It Em DESCRIPTION
+This expands upon the brief, one-line description in 
+.Em NAME .
+It usually contains a break-down of the options (if documenting a
+command).
+.It Em IMPLEMENTATION NOTES
 Implementation-specific notes should be kept here.  This is useful when
 implementing standard functions that may have side effects or notable
 algorithmic implications.
-.It EXIT STATUS
-.It RETURN VALUES
-.It ENVIRONMENT
-.It FILES
-.It EXAMPLES
-.It DIAGNOSTICS
-.It ERRORS
-.It SEE ALSO
-.It STANDARDS
-.It HISTORY
-.It AUTHORS
-.It CAVEATS
-.It BUGS
-.It SECURITY CONSIDERATIONS
+.It Em EXIT STATUS
+Command exit status for section 1, 6, and 8 manuals.  This section is
+the dual of
+.Em RETURN VALUES ,
+which is used for functions.  Historically, this information was
+described in
+.Em DIAGNOSTICS ,
+a practise that is now discouraged.
+.
+.It Em RETURN VALUES
+This section is the dual of
+.Em EXIT STATUS ,
+which is used for commands.  It documents the return values of functions
+in sections 2, 3, and 9.
+.
+.It Em ENVIRONMENT
+Documents any usages of environment variables, e.g.,
+.Xr environ 7 .
+.
+.It Em FILES
+Documents files used.  It's helpful to document both the file and a
+short description of how the file is used (created, modified, etc.).
+.
+.It Em EXAMPLES
+Example usages.  This often contains snippets of well-formed,
+well-tested invocations.  Make doubly sure that your examples work
+properly!  Assume that users will skip to this section and use your
+example verbatim.
+.
+.It Em DIAGNOSTICS
+Documents error conditions.  This is most useful in section 4 manuals.
+Historically, this section was used in place of
+.Em EXIT STATUS
+for manuals in sections 1, 6, and 8; however, this practise is
+discouraged.
+.
+.It Em ERRORS
+Documents error handling in sections 2, 3, and 9.
+.
+.It Em SEE ALSO
+References other manuals with related topics.  This section should exist
+for most manuals.  Cross-references should conventionally be ordered
+first by section, then alphabetically.
+.Pp
+.D1 \. Ns Sx \&BR No bar \&( 1 \&),
+.D1 \. Ns Sx \&BR No foo \&( 1 \&),
+.D1 \. Ns Sx \&BR No baz \&( 2 \&).
+.
+.It Em STANDARDS
+References any standards implemented or used, such as
+.Pp
+.D1 IEEE Std 1003.2 (\e(lqPOSIX.2\e(rq)
+.Pp
+If not adhering to any standards, the
+.Em HISTORY
+section should be used.
+.
+.It Em HISTORY
+The history of any manual without a
+.Em STANDARDS
+section should be described in this section.
+.
+.It Em AUTHORS
+Credits to authors, if applicable, should appear in this section.
+Authors should generally be noted by both name and an e-mail address.
+.
+.It Em CAVEATS
+Explanations of common misuses and misunderstandings should be explained
+in this section.
+.
+.It Em BUGS
+Extant bugs should be described in this section.
+.
+.It Em SECURITY CONSIDERATIONS
+Documents any security precautions that operators should consider.
+.
 .El
 .
 .