Rationalize .TH manpage macro invocations.
authorLyndon Nerenberg <lyndon@orthanc.ca>
Sat, 20 Oct 2012 21:42:32 +0000 (14:42 -0700)
committerLyndon Nerenberg <lyndon@orthanc.ca>
Sat, 20 Oct 2012 21:42:32 +0000 (14:42 -0700)
This patch addresses the following issues with .TH macro usage:

  .TH COMP %manext1% "%nmhdate%" MH.6.8 [%nmhverion%]

1) "MH.6.8" is no longer relevant.

2) %nmhdate% is a hardwired value that only gets updated along with
   %nmhversion% and is therefore redundant.

This patch nukes the MH.6.8 tag, and replaces the hardwired
%nmhdate% field with the latest date the associated manpage has
been updated.  I pulled the dates - as best I could - from the
git logs.

Going forward, it is incumbent on developers to update the
manpage date stamps as they update the pages themselves.

59 files changed:
docs/README.manpages
man/ali.man
man/anno.man
man/ap.man
man/burst.man
man/comp.man
man/conflict.man
man/dist.man
man/dp.man
man/flist.man
man/fmtdump.man
man/folder.man
man/forw.man
man/inc.man
man/install-mh.man
man/mark.man
man/mh-alias.man
man/mh-chart-gen.sh
man/mh-draft.man
man/mh-format.man
man/mh-mail.man
man/mh-profile.man
man/mh-sequence.man
man/mh-tailor.man
man/mhbuild.man
man/mhl.man
man/mhlist.man
man/mhmail.man
man/mhn.man
man/mhparam.man
man/mhpath.man
man/mhshow.man
man/mhstore.man
man/msgchk.man
man/msh.man
man/new.man
man/next.man
man/nmh.man
man/packf.man
man/pick.man
man/post.man
man/prev.man
man/prompter.man
man/rcvdist.man
man/rcvpack.man
man/rcvstore.man
man/rcvtty.man
man/refile.man
man/repl.man
man/rmf.man
man/rmm.man
man/scan.man
man/send.man
man/sendfiles.man
man/show.man
man/slocal.man
man/sortm.man
man/whatnow.man
man/whom.man

index 8c6516a..ce9ac26 100644 (file)
@@ -2,7 +2,7 @@ NMH MANPAGE STYLE GUIDE
 
 nmh manpages should be in this general form:
 
-.TH COMP %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH COMP %manext1% "DATE" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
@@ -52,12 +52,31 @@ None
 .SH BUGS
 None
 
----------------------------------------
+---------------------------------------------------------------------
+
+The DATE in the .TH macro should reflect the most recent non-trivial
+update to the content of the manpage; formatting changes don't count.
+Spell out the date in English prose:  Month Day, Year
+
+  January 2, 1904
+
+not the unparseable
+
+  01/02/04
+
+
+Don't include a CONTEXT section if contexts don't directly apply to what the
+manpage describes.
+
+
 In the FILES section, prefer the default .TP indent. The pathnames are
 variable and long, so any indentation value that works for you won't
 work for someone else.
 
 
+The BUGS section goes last.
+
+
 Source files
 
        There should be no ".so" commands to source an external file,
index 9d9deaf..a67cad1 100644 (file)
@@ -1,4 +1,4 @@
-.TH ALI %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH ALI %manext1% "January 1, 2001" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index 235ae36..ce1942b 100644 (file)
@@ -1,4 +1,4 @@
-.TH ANNO %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH ANNO %manext1% "December 7, 2005" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index 7c9a8a9..e0b5f63 100644 (file)
@@ -1,4 +1,4 @@
-.TH AP %manext8% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH AP %manext8% "March 6, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index 867f51d..4e2d0cc 100644 (file)
@@ -1,4 +1,4 @@
-.TH BURST %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH BURST %manext1% "January 1, 2001" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index 4929dc7..bd0a762 100644 (file)
@@ -1,4 +1,4 @@
-.TH COMP %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH COMP %manext1% "May 21, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index 1af15e3..3f2dc08 100644 (file)
@@ -1,4 +1,4 @@
-.TH CONFLICT %manext8% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH CONFLICT %manext8% "June 24, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index 1f6e041..dbfd251 100644 (file)
@@ -1,4 +1,4 @@
-.TH DIST %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH DIST %manext1% "June 18, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index e36042a..b9b4cc8 100644 (file)
@@ -1,4 +1,4 @@
-.TH DP %manext8% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH DP %manext8% "March 6, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index 64998b9..49b4502 100644 (file)
@@ -1,4 +1,4 @@
-.TH FLIST %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH FLIST %manext1% "January 1, 2001" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index c2dcc5f..9a71ac9 100644 (file)
@@ -1,4 +1,4 @@
-.TH FMTDUMP %manext8% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH FMTDUMP %manext8% "January 1, 2001" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index 52c4846..dadabbf 100644 (file)
@@ -1,4 +1,4 @@
-.TH FOLDER %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH FOLDER %manext1% "January 1, 2001" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index 124627e..2efa541 100644 (file)
@@ -1,4 +1,4 @@
-.TH FORW %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH FORW %manext1% "February 28, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index d725b6c..04c948b 100644 (file)
@@ -1,4 +1,4 @@
-.TH INC %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] XXX
+.TH INC %manext1% "July 1, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index 35114a6..33262d2 100644 (file)
@@ -1,4 +1,4 @@
-.TH INSTALL-MH %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH INSTALL-MH %manext1% "June 10, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index 1f12d9d..500fdb1 100644 (file)
@@ -1,4 +1,4 @@
-.TH MARK %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH MARK %manext1% "February 11, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index 1eef4e6..24cf0c2 100644 (file)
@@ -1,4 +1,4 @@
-.TH MH-ALIAS %manext5% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH MH-ALIAS %manext5% "Oct 14, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index 04af627..e0afd40 100755 (executable)
@@ -1,12 +1,18 @@
-#! /bin/sh
+#!/bin/sh
 #
 # Generates mh-chart.man from other .man files that have a SYNOPSIS
 # section.
 
 nmhmandir=`dirname $0`
 
-cat <<'EOF'
-.TH MH-CHART %manext7% "%nmhdate%" MH.6.8 [%nmhversion%]
+# The following ensures the generated date field in the manpage is divorced
+# from the local build environment when building distribution packages.
+export LC_TIME=C
+unset LANG
+datestamp=`date '+%B %d, %Y'`
+
+cat <<__HOOPY_FROOD
+.TH MH-CHART %manext7% "${datestamp}" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
@@ -14,7 +20,7 @@ cat <<'EOF'
 mh-chart \- Chart of nmh Commands
 .SH SYNOPSIS
 .na
-EOF
+__HOOPY_FROOD
 
 for i in $nmhmandir/*.man; do
   case $i in
index 73a086e..ab16e8a 100644 (file)
@@ -1,4 +1,4 @@
-.TH MH-DRAFT %manext5% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH MH-DRAFT %manext5% "January 2, 2001" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index 7d417aa..7aad129 100644 (file)
@@ -1,4 +1,4 @@
-.TH MH-FORMAT %manext5% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH MH-FORMAT %manext5% "March 24, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index f8d6862..c6ebffa 100644 (file)
@@ -1,4 +1,4 @@
-.TH MH-MAIL %manext5% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH MH-MAIL %manext5% "July 9, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index 6395dd6..0e92a5f 100644 (file)
@@ -1,4 +1,4 @@
-.TH MH-PROFILE %manext5% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH MH-PROFILE %manext5% "October 15, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index cd6b3b7..f48f80d 100644 (file)
@@ -1,4 +1,4 @@
-.TH MH-SEQUENCE %manext5% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH MH-SEQUENCE %manext5% "January 9, 2001" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index cc86504..8c76e4b 100644 (file)
@@ -1,4 +1,4 @@
-.TH MH-TAILOR %manext5% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH MH-TAILOR %manext5% "July 11, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index ce84f48..896278f 100644 (file)
@@ -1,4 +1,4 @@
-.TH MHBUILD %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH MHBUILD %manext1% "May 31, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index 065a455..afa68bd 100644 (file)
@@ -1,4 +1,4 @@
-.TH MHL %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH MHL %manext1% "January 31, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index 57d0118..fab619f 100644 (file)
@@ -1,4 +1,4 @@
-.TH MHLIST %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH MHLIST %manext1% "January 9, 2001" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index 4e686fc..2061762 100644 (file)
@@ -1,4 +1,4 @@
-.TH MHMAIL %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH MHMAIL %manext1% "October 16, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index dea216f..02ce8d5 100644 (file)
@@ -1,4 +1,4 @@
-.TH MHN %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH MHN %manext1% "January 9, 2001" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index 1f8f6da..4c2ad88 100644 (file)
@@ -1,4 +1,4 @@
-.TH MHPARAM %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH MHPARAM %manext1% "June 14, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index e9879f4..c4928b4 100644 (file)
@@ -1,4 +1,4 @@
-.TH MHPATH %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH MHPATH %manext1% "February 18, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index 2e69944..04a88c4 100644 (file)
@@ -1,4 +1,4 @@
-.TH MHSHOW %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH MHSHOW %manext1% "April 30, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index 3838d80..79be43f 100644 (file)
@@ -1,4 +1,4 @@
-.TH MHSTORE %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH MHSTORE %manext1% "September 15, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index 3a2a7dc..cadf46c 100644 (file)
@@ -1,4 +1,4 @@
-.TH MSGCHK %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH MSGCHK %manext1% "January 27, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index e0ba587..ba239ce 100644 (file)
@@ -1,4 +1,4 @@
-.TH MSH %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH MSH %manext1% "January 8, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index fcfa39f..7f93b9a 100644 (file)
@@ -1,4 +1,4 @@
-.TH NEW %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH NEW %manext1% "January 17, 2009" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index d06a1f1..9138c1c 100644 (file)
@@ -1,4 +1,4 @@
-.TH NEXT %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH NEXT %manext1% "January 9, 2001" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index 0fccece..cc62145 100644 (file)
@@ -1,4 +1,4 @@
-.TH NMH %manext7% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH NMH %manext7% "September 11, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index 0dc7125..3e3dc41 100644 (file)
@@ -1,4 +1,4 @@
-.TH PACKF %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH PACKF %manext1% "January 8, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index 2db2527..aca0918 100644 (file)
@@ -1,4 +1,4 @@
-.TH PICK %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH PICK %manext1% "March 6, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index 98b2251..d59a6f9 100644 (file)
@@ -1,4 +1,4 @@
-.TH POST %manext8% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH POST %manext8% "July 21, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index 54cda4a..71eb8f7 100644 (file)
@@ -1,4 +1,4 @@
-.TH PREV %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH PREV %manext1% "January 9, 2001" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index 1391134..3796a29 100644 (file)
@@ -1,4 +1,4 @@
-.TH PROMPTER %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH PROMPTER %manext1% "January 18, 2001" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index 56780ea..6b4af63 100644 (file)
@@ -1,4 +1,4 @@
-.TH RCVDIST %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH RCVDIST %manext1% "January 18, 2001" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index e474599..a3763f1 100644 (file)
@@ -1,4 +1,4 @@
-.TH RCVPACK %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH RCVPACK %manext1% "January 18, 2001" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index 8e23aae..2a64f1d 100644 (file)
@@ -1,4 +1,4 @@
-.TH RCVSTORE %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH RCVSTORE %manext1% "January 18, 2001" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index 917b1ea..8b9dd44 100644 (file)
@@ -1,4 +1,4 @@
-.TH RCVTTY %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH RCVTTY %manext1% "January 18, 2001" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index 2cbec30..55b78eb 100644 (file)
@@ -1,4 +1,4 @@
-.TH REFILE %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH REFILE %manext1% "January 18, 2001" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index 81e22b8..6a9367e 100644 (file)
@@ -1,4 +1,4 @@
-.TH REPL %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH REPL %manext1% "July 1, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index b89f3f6..3c1b464 100644 (file)
@@ -1,4 +1,4 @@
-.TH RMF %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH RMF %manext1% "January 18, 2001" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index 3e7e393..97170b7 100644 (file)
@@ -1,4 +1,4 @@
-.TH RMM %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH RMM %manext1% "November 9, 2010" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index 2d3d43c..7bca7d2 100644 (file)
@@ -1,4 +1,4 @@
-.TH SCAN %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH SCAN %manext1% "March 6, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index fcec2ae..b954aa2 100644 (file)
@@ -1,7 +1,7 @@
 .\"
 .\" %nmhwarning%
 .\"
-.TH SEND %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH SEND %manext1% "September 11, 2012" "%nmhversion%"
 .SH NAME
 send \- send a message
 .SH SYNOPSIS
index d8c7f3d..af396f1 100644 (file)
@@ -1,4 +1,4 @@
-.TH SENDFILES %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH SENDFILES %manext1% "October 16, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index fde9b43..c69a7d7 100644 (file)
@@ -1,4 +1,4 @@
-.TH SHOW %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH SHOW %manext1% "June 6, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index f1a2e39..cc0f4ce 100644 (file)
@@ -1,4 +1,4 @@
-.TH SLOCAL %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH SLOCAL %manext1% "January 16, 2006" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index e051910..4d03446 100644 (file)
@@ -1,4 +1,4 @@
-.TH SORTM %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH SORTM %manext1% "October 11, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index b25f006..ce0ded8 100644 (file)
@@ -1,4 +1,4 @@
-.TH WHATNOW %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH WHATNOW %manext1% "%nmhdate%" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
index 59618bc..4994270 100644 (file)
@@ -1,4 +1,4 @@
-.TH WHOM %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH WHOM %manext1% "July 11, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"