From owner-freebsd-ports  Mon May 17 14:30: 7 1999
Delivered-To: freebsd-ports@freebsd.org
Received: from freefall.freebsd.org (freefall.FreeBSD.ORG [204.216.27.21])
	by hub.freebsd.org (Postfix) with ESMTP id 7238E156F3
	for <freebsd-ports@FreeBSD.org>; Mon, 17 May 1999 14:30:02 -0700 (PDT)
	(envelope-from gnats@FreeBSD.org)
Received: (from gnats@localhost)
	by freefall.freebsd.org (8.9.3/8.9.2) id OAA34332;
	Mon, 17 May 1999 14:30:02 -0700 (PDT)
	(envelope-from gnats@FreeBSD.org)
Received: from heart-of-gold.ironbridgenetworks.com (ibn-host12.ironbridgenetworks.com [146.115.140.12])
	by hub.freebsd.org (Postfix) with ESMTP
	id A601E15561; Mon, 17 May 1999 14:21:04 -0700 (PDT)
	(envelope-from lowell@heart-of-gold.ironbridgenetworks.com)
Received: (from lowell@localhost)
	by heart-of-gold.ironbridgenetworks.com (8.9.3/8.9.3) id RAA05921;
	Mon, 17 May 1999 17:21:04 -0400 (EDT)
	(envelope-from lowell)
Message-Id: <199905172121.RAA05921@heart-of-gold.ironbridgenetworks.com>
Date: Mon, 17 May 1999 17:21:04 -0400 (EDT)
From: lowell@world.std.com
To: FreeBSD-gnats-submit@freebsd.org, jmz@freebsd.org
X-Send-Pr-Version: 3.2
Subject: ports/11748: mtool man page patch
Sender: owner-freebsd-ports@FreeBSD.ORG
Precedence: bulk
X-Loop: FreeBSD.org


>Number:         11748
>Category:       ports
>Synopsis:       mtools.5 breaks whatis
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    freebsd-ports
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Mon May 17 14:30:01 PDT 1999
>Closed-Date:
>Last-Modified:
>Originator:     Lowell Gilbert
>Release:        FreeBSD 3.2-BETA i386
>Organization:
n/a
>Environment:

-STABLE, cvsup'd 17 May 1999

>Description:

I'm not too good on nroff, but I think the 
.SS Description
line in the mtools.5 man page should be 
.SH Description
instead.  

I'm not sure what the idea behind the indentation is supposed to be, but as
it is, pretty much the whole file gets included in the whatis index.  This
is presumably because all the other sections -- "Description" etc -- are
considered subsections of "Name".  Because I think it makes sense for most
of them to be subsections of "Descriptions", I think my described change is
probably the "right" one.

Or have I, perhaps, missed something?  If I'm right, this is so obvious that
I'm surprised no one else had complained before.  


>How-To-Repeat:

apropos configuration

will include among its output virtually the whole mtools man page

>Fix:

--- ./mtools.5.orig     Mon May 17 17:07:07 1999
+++ ./mtools.5  Mon May 17 17:07:22 1999
@@ -20,3 +20,3 @@
 .PP
-.SS Description
+.SH Description
 .PP

>Release-Note:
>Audit-Trail:
>Unformatted:


To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-ports" in the body of the message