[Nmh-commits] nmh man/forw.man man/inc.man man/mh-chart.man m...

[Peter Maydell]

CVSROOT:        /sources/nmh
Module name:    nmh
Changes by:     Peter Maydell <pm215>   08/08/03 15:14:24

Modified files:
        man            : forw.man inc.man mh-chart.man mhmail.man 
                         mhshow.man mhstore.man msgchk.man packf.man 
                         scan.man 
Added files:
        test/tests/manpages: test-manpages 

Log message:
        Bug #23436: fix some minor manpage syntax errors and add a test which 
runs
        groff over them and checks that no warnings are emitted.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/nmh/man/forw.man?cvsroot=nmh&r1=1.7&r2=1.8
http://cvs.savannah.gnu.org/viewcvs/nmh/man/inc.man?cvsroot=nmh&r1=1.14&r2=1.15
http://cvs.savannah.gnu.org/viewcvs/nmh/man/mh-chart.man?cvsroot=nmh&r1=1.5&r2=1.6
http://cvs.savannah.gnu.org/viewcvs/nmh/man/mhmail.man?cvsroot=nmh&r1=1.5&r2=1.6
http://cvs.savannah.gnu.org/viewcvs/nmh/man/mhshow.man?cvsroot=nmh&r1=1.6&r2=1.7
http://cvs.savannah.gnu.org/viewcvs/nmh/man/mhstore.man?cvsroot=nmh&r1=1.5&r2=1.6
http://cvs.savannah.gnu.org/viewcvs/nmh/man/msgchk.man?cvsroot=nmh&r1=1.9&r2=1.10
http://cvs.savannah.gnu.org/viewcvs/nmh/man/packf.man?cvsroot=nmh&r1=1.6&r2=1.7
http://cvs.savannah.gnu.org/viewcvs/nmh/man/scan.man?cvsroot=nmh&r1=1.5&r2=1.6
http://cvs.savannah.gnu.org/viewcvs/nmh/test/tests/manpages/test-manpages?cvsroot=nmh&rev=1.1

Patches:
Index: man/forw.man
===================================================================
RCS file: /sources/nmh/nmh/man/forw.man,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -b -r1.7 -r1.8
--- man/forw.man        25 Jan 2001 21:15:54 -0000      1.7
+++ man/forw.man        3 Aug 2008 15:14:23 -0000       1.8
@@ -1,6 +1,6 @@
 .\"
 .\" %nmhwarning%
-.\" $Id: forw.man,v 1.7 2001/01/25 21:15:54 ssen Exp $
+.\" $Id: forw.man,v 1.8 2008/08/03 15:14:23 pm215 Exp $
 .\"
 .TH FORW %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
 .SH NAME
@@ -96,10 +96,14 @@
 .B \-annotate
 switch is given, each message being forwarded will
 be annotated with the lines:
-
-     Forwarded:\ date
-     Forwarded:\ addrs
-
+.PP
+.RS 5
+.nf
+Forwarded:\ date
+Forwarded:\ addrs
+.fi
+.RE
+.PP
 where each address list contains as many lines as required.  This
 annotation will be done only if the message is sent directly from
 .BR forw .
@@ -295,8 +299,8 @@
 .BR \-mime ,
 and
 .B \-digest
-switches is bypassed, and the usual leading and trailing
-'Forwarded Message' delimiters are not added.
+switches is bypassed, and the usual leading and
+trailing 'Forwarded Message' delimiters are not added.
 The same caveats apply to this option as to the
 .B \-build
 switch.

Index: man/inc.man
===================================================================
RCS file: /sources/nmh/nmh/man/inc.man,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -b -r1.14 -r1.15
--- man/inc.man 27 Jan 2005 16:34:20 -0000      1.14
+++ man/inc.man 3 Aug 2008 15:14:23 -0000       1.15
@@ -1,6 +1,6 @@
 .\"
 .\" %nmhwarning%
-.\" $Id: inc.man,v 1.14 2005/01/27 16:34:20 opk Exp $
+.\" $Id: inc.man,v 1.15 2008/08/03 15:14:23 pm215 Exp $
 .\"
 .TH INC %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
 .SH NAME
@@ -88,7 +88,7 @@
 .PP
 .RS 5
 .nf
-\*(<<inc\*(>> date
+<<inc>> date
 <scan line for first message>
 <scan line for second message>
 <etc.>

Index: man/mh-chart.man
===================================================================
RCS file: /sources/nmh/nmh/man/mh-chart.man,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -b -r1.5 -r1.6
--- man/mh-chart.man    21 Sep 2003 17:34:31 -0000      1.5
+++ man/mh-chart.man    3 Aug 2008 15:14:23 -0000       1.6
@@ -1,6 +1,6 @@
 .\"
 .\" %nmhwarning%
-.\" $Id: mh-chart.man,v 1.5 2003/09/21 17:34:31 gbburkhardt Exp $
+.\" $Id: mh-chart.man,v 1.6 2008/08/03 15:14:23 pm215 Exp $
 .\"
 .TH MH-CHART %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
 .SH NAME
@@ -331,7 +331,7 @@
 .IR text ]
 .RB [ \-cc
 .I addrs
-...]
+\&...]
 .RB [ \-from
 .IR addr ]
 .RB [ \-subject
@@ -450,7 +450,7 @@
 .RB [ \-snoop ]
 %nmhendpop%
 .RI [ users
-... ]
+\&... ]
 .RB [ \-version ]
 .RB [ \-help ]
 

Index: man/mhmail.man
===================================================================
RCS file: /sources/nmh/nmh/man/mhmail.man,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -b -r1.5 -r1.6
--- man/mhmail.man      25 Jan 2001 21:15:55 -0000      1.5
+++ man/mhmail.man      3 Aug 2008 15:14:23 -0000       1.6
@@ -1,6 +1,6 @@
 .\"
 .\" %nmhwarning%
-.\" $Id: mhmail.man,v 1.5 2001/01/25 21:15:55 ssen Exp $
+.\" $Id: mhmail.man,v 1.6 2008/08/03 15:14:23 pm215 Exp $
 .\"
 .TH MHMAIL %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
 .SH NAME
@@ -15,7 +15,7 @@
 .IR text ]
 .RB [ \-cc
 .I addrs
-...]
+\&...]
 .RB [ \-from
 .IR addr ]
 .RB [ \-subject
@@ -77,7 +77,7 @@
 .B mhmail
 will not send the message.  You can use the switch
 .B \-body
-\*(lr\*(rq to force an empty message.
+\*(lq\*(rq to force an empty message.
 .PP
 Normally, addresses appearing as arguments are put in the \*(lqTo:\*(rq
 field.  If the

Index: man/mhshow.man
===================================================================
RCS file: /sources/nmh/nmh/man/mhshow.man,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -b -r1.6 -r1.7
--- man/mhshow.man      25 Jan 2001 21:15:56 -0000      1.6
+++ man/mhshow.man      3 Aug 2008 15:14:23 -0000       1.7
@@ -1,6 +1,6 @@
 .\"
 .\" %nmhwarning%
-.\" $Id: mhshow.man,v 1.6 2001/01/25 21:15:56 ssen Exp $
+.\" $Id: mhshow.man,v 1.7 2008/08/03 15:14:23 pm215 Exp $
 .\"
 .TH MHSHOW %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
 .SH NAME
@@ -529,7 +529,7 @@
 different machines,
 .B mhshow
 will look for the environment variable
-.BE $MHSHOW .
+.BR $MHSHOW .
 If present, this specifies the name of an additional
 user profile which should be read.  Hence, when a user logs in on a
 particular display device, this environment variable should be set to

Index: man/mhstore.man
===================================================================
RCS file: /sources/nmh/nmh/man/mhstore.man,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -b -r1.5 -r1.6
--- man/mhstore.man     25 Jan 2001 21:15:56 -0000      1.5
+++ man/mhstore.man     3 Aug 2008 15:14:23 -0000       1.6
@@ -1,6 +1,6 @@
 .\"
 .\" %nmhwarning%
-.\" $Id: mhstore.man,v 1.5 2001/01/25 21:15:56 ssen Exp $
+.\" $Id: mhstore.man,v 1.6 2008/08/03 15:14:23 pm215 Exp $
 .\"
 .TH MHSTORE %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
 .SH NAME
@@ -162,8 +162,8 @@
 be used to store the content.  This information should be specified
 as the attribute \*(lqname=filename\*(rq in the \*(lqContent-Type\*(rq header
 for the content you are storing.  For security reasons, this filename
-will be ignored if it begins with the character '/', '.', '|', or
-'!', or if it contains the character '%'.  For the sake of security,
+will be ignored if it begins with the character '/', '.', '|', or '!',
+or if it contains the character '%'.  For the sake of security,
 this switch is not the default, and it is recommended that you do
 NOT put the
 .B \-auto
@@ -418,7 +418,7 @@
 different machines,
 .B mhstore
 will look for the environment variable
-.BE $MHSTORE .
+.BR $MHSTORE .
 If present, this specifies the name of an additional
 user profile which should be read.  Hence, when a user logs in on a
 particular machine, this environment variable should be set to

Index: man/msgchk.man
===================================================================
RCS file: /sources/nmh/nmh/man/msgchk.man,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -b -r1.9 -r1.10
--- man/msgchk.man      25 Jan 2001 21:15:56 -0000      1.9
+++ man/msgchk.man      3 Aug 2008 15:14:24 -0000       1.10
@@ -1,6 +1,6 @@
 .\"
 .\" %nmhwarning%
-.\" $Id: msgchk.man,v 1.9 2001/01/25 21:15:56 ssen Exp $
+.\" $Id: msgchk.man,v 1.10 2008/08/03 15:14:24 pm215 Exp $
 .\"
 .TH MSGCHK %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
 .SH NAME
@@ -27,7 +27,7 @@
 .RB [ \-snoop ]
 %nmhendpop%
 .RI [ users
-... ]
+\&... ]
 .RB [ \-version ]
 .RB [ \-help ]
 .ad

Index: man/packf.man
===================================================================
RCS file: /sources/nmh/nmh/man/packf.man,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -b -r1.6 -r1.7
--- man/packf.man       25 Jan 2001 21:15:57 -0000      1.6
+++ man/packf.man       3 Aug 2008 15:14:24 -0000       1.7
@@ -1,6 +1,6 @@
 .\"
 .\" %nmhwarning%
-.\" $Id: packf.man,v 1.6 2001/01/25 21:15:57 ssen Exp $
+.\" $Id: packf.man,v 1.7 2008/08/03 15:14:24 pm215 Exp $
 .\"
 .TH PACKF %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
 .SH NAME
@@ -91,4 +91,3 @@
 .SH CONTEXT
 If a folder is given, it will become the current folder.  The first
 message packed will become the current message.
-.En

Index: man/scan.man
===================================================================
RCS file: /sources/nmh/nmh/man/scan.man,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -b -r1.5 -r1.6
--- man/scan.man        25 Jan 2001 21:15:59 -0000      1.5
+++ man/scan.man        3 Aug 2008 15:14:24 -0000       1.6
@@ -1,6 +1,6 @@
 .\"
 .\" %nmhwarning%
-.\" $Id: scan.man,v 1.5 2001/01/25 21:15:59 ssen Exp $
+.\" $Id: scan.man,v 1.6 2008/08/03 15:14:24 pm215 Exp $
 .\"
 .TH SCAN %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
 .SH NAME
@@ -37,8 +37,8 @@
 .RS 5
 .nf
 .ta \w'15+- 'u +\w'07/\|05x 'u +\w'Dcrocker  'u
-15+    10/\|05 crocker nned\0\0\*(<<Last week I asked some of
-16\-   10/\|05 crocker message id format\0\0\*(<<I recommend
+15+    10/\|05 crocker nned\0\0<<Last week I asked some of
+16\-   10/\|05 crocker message id format\0\0\<<I recommend
 18     10/\|06 brien   Re: Exit status from mkdir
 19     10/\|07*brien   \*(lqscan\*(rq listing format in nmh
 .fi

Index: test/tests/manpages/test-manpages
===================================================================
RCS file: test/tests/manpages/test-manpages
diff -N test/tests/manpages/test-manpages
--- /dev/null   1 Jan 1970 00:00:00 -0000
+++ test/tests/manpages/test-manpages   3 Aug 2008 15:14:24 -0000       1.1
@@ -0,0 +1,53 @@
+#!/bin/sh
+######################################################
+#
+# Test that the manpages don't have any syntax errors
+# as detected by groff.
+#
+######################################################
+
+# First find out whether we have a groff on the path:
+
+# portable implementation of 'which' utility
+findprog()
+{
+  FOUND=
+  PROG="$1"
+  IFS_SAVE="$IFS"
+  IFS=:
+  for D in $PATH; do
+    if [ -z "$D" ]; then
+      D=.
+    fi
+    if [ -f "$D/$PROG" ] && [ -x "$D/$PROG" ]; then
+      printf '%s\n' "$D/$PROG"
+      break
+    fi
+  done
+  IFS="$IFS_SAVE"
+}
+
+if [ -z "$(findprog groff)" ]; then
+  echo "Test $0 SKIP (missing groff)"
+  exit 120
+fi
+
+cd $MH_TEST_DIR/share/man
+
+# groff will still exit with status zero even if warnings
+# were emitted, so we have to jump through hoops to
+# find out if any were emitted.
+
+expected=$MH_TEST_DIR/$$.expected
+actual=$MH_TEST_DIR/$$.actual
+
+# There aren't any expected warnings at the moment but
+# this mechanism does let us add them if necessary later.
+rm -f "$expected" "$actual"
+touch "$expected" "$actual"
+
+for manpage in man?/*.?; do
+  groff -Tutf8 -mandoc -wmac "$manpage" > /dev/null 2>>"$actual"
+done
+
+diff -u "$expected" "$actual"