From schweikh@schweikhardt.net  Wed Oct  6 18:40:45 2004
Return-Path: <schweikh@schweikhardt.net>
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id BD74B16A4CE
	for <FreeBSD-gnats-submit@freebsd.org>; Wed,  6 Oct 2004 18:40:45 +0000 (GMT)
Received: from bremen.shuttle.de (bremen.shuttle.de [194.95.249.251])
	by mx1.FreeBSD.org (Postfix) with ESMTP id 93AB543D48
	for <FreeBSD-gnats-submit@freebsd.org>; Wed,  6 Oct 2004 18:40:44 +0000 (GMT)
	(envelope-from schweikh@schweikhardt.net)
Received: by bremen.shuttle.de (Postfix, from userid 10)
	id E9BCF3B945; Wed,  6 Oct 2004 20:40:42 +0200 (CEST)
Received: from hal9000.schweikhardt.net (localhost [127.0.0.1])
	by hal9000.schweikhardt.net (8.13.1/8.13.1) with ESMTP id i96IeWLZ080495
	for <FreeBSD-gnats-submit@freebsd.org>; Wed, 6 Oct 2004 20:40:32 +0200 (CEST)
	(envelope-from schweikh@hal9000.schweikhardt.net)
Received: (from schweikh@localhost)
	by hal9000.schweikhardt.net (8.13.1/8.13.1/Submit) id i96IeWfr080494;
	Wed, 6 Oct 2004 20:40:32 +0200 (CEST)
	(envelope-from schweikh)
Message-Id: <200410061840.i96IeWfr080494@hal9000.schweikhardt.net>
Date: Wed, 6 Oct 2004 20:40:32 +0200 (CEST)
From: Jens Schweikhardt <schweikh@schweikhardt.net>
To: FreeBSD-gnats-submit@freebsd.org
Cc:
Subject: emulators/mtools man pages are too funky for getNAME(1), mess up whatis database
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         72398
>Category:       bin
>Synopsis:       whatis(8): emulators/mtools man pages are too funky for getNAME(1), mess up whatis database
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-bugs
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          change-request
>Submitter-Id:   current-users
>Arrival-Date:   Wed Oct 06 18:50:27 GMT 2004
>Closed-Date:    
>Last-Modified:  Thu May 01 05:17:07 UTC 2008
>Originator:     Jens Schweikhardt
>Release:        FreeBSD 6.0-CURRENT i386
>Organization:
Digital Details
>Environment:
System: FreeBSD hal9000.schweikhardt.net 6.0-CURRENT FreeBSD 6.0-CURRENT #0: Tue Aug 31 17:07:43 CEST 2004 toor@hal9000.schweikhardt.net:/share/HEAD/obj/share/HEAD/src/sys/HAL9000 i386


>Description:
	The mtools come with non-standard troff manual pages which
getNAME(1) can not properly decode. This messes up the whatis(8) database.

>How-To-Repeat:
	Install emulators/mtools.
	# cd /usr/local/man
	# grep TQ whatis
	floppyd(1)               - floppy daemon for remote access to floppy drive floppyd_installtest - tests whether floppyd is installed and running '" t TQ \$1 . (is' (if` (pd"
	floppyd_installtest(1)   - tests whether floppyd is installed and running '" t TQ \$1 . (is' (if` (pd"
	mattrib(1)               - change MSDOS file attribute flags '" t TQ \$1 . (is' (if` (pd"
	mbadblocks(1)            - tests a floppy disk, and marks the bad blocks in the FAT '" t TQ \$1 . (is' (if` (pd"
	mcat(1)                  - dump raw disk image '" t TQ \$1 . (is' (if` (pd"
	mcd(1)                   - change MSDOS directory '" t TQ \$1 . (is' (if` (pd"
	mcopy(1)                 - copy MSDOS files to/from Unix '" t TQ \$1 . (is' (if` (pd"
	mdel(1)                  - delete an MSDOS file mdeltree - recursively delete an MSDOS directory and its contents '" t TQ \$1 . (is' (if` (pd"
	mdeltree(1)              - recursively delete an MSDOS directory and its contents '" t TQ \$1 . (is' (if` (pd"
	mdir(1)                  - display an MSDOS directory '" t TQ \$1 . (is' (if` (pd"
	mdu(1)                   - display the amount of space occupied by an MSDOS directory '" t TQ \$1 . (is' (if` (pd"
	mformat(1)               - add an MSDOS filesystem to a low-level formatted floppy disk '" t TQ \$1 . (is' (if` (pd"
	minfo(1)                 - print the parameters of a MSDOS filesystem '" t TQ \$1 . (is' (if` (pd"
	mkmanifest(1)            - makes list of file names and their DOS 8+3 equivalent '" t TQ \$1 . (is' (if` (pd"
	mlabel(1)                - make an MSDOS volume label '" t TQ \$1 . (is' (if` (pd"
	mmd(1)                   - make an MSDOS subdirectory '" t TQ \$1 . (is' (if` (pd"
	mmount(1)                - mount an MSDOS disk '" t TQ \$1 . (is' (if` (pd"
	mmove(1)                 - move or rename an MSDOS file or subdirectory '" t TQ \$1 . (is' (if` (pd"
	mpartition(1)            - partition an MSDOS hard disk '" t TQ \$1 . (is' (if` (pd"
	mrd(1)                   - remove an MSDOS subdirectory '" t TQ \$1 . (is' (if` (pd"
	mren(1)                  - rename an existing MSDOS file '" t TQ \$1 . (is' (if` (pd"
	mshowfat(1)              - shows FAT clusters allocated to file '" t TQ \$1 . (is' (if` (pd"
	mtools(1)                - utilities to access DOS disks in Unix. '" t TQ \$1 . (is' (if` (pd"
	mtools(5), mtools.conf(5) - mtools configuration files '" t TQ \$1 . (is' (if` (pd" St Mtools '\*(St''%' '%''\*(St'
	mtoolstest(1)            - tests and displays the configuration '" t TQ \$1 . (is' (if` (pd"
	mtype(1)                 - display contents of an MSDOS file '" t TQ \$1 . (is' (if` (pd"
	mzip(1)                  - change protection mode and eject disk on Zip/Jaz drive '" t TQ \$1 . (is' (if` (pd"

>Fix:

	Hit the mtools maintainer over the head with a troff manual. :-)
	The TQ macro does not seem to be used anywhere. I have no idea about
	the "is", "if" and "pd" stuff.

>Release-Note:
>Audit-Trail:
Responsible-Changed-From-To: freebsd-ports-bugs->jmz 
Responsible-Changed-By: schweikh 
Responsible-Changed-When: Wed Oct 6 20:04:47 GMT 2004 
Responsible-Changed-Why:  
Over to port's MAINTAINER. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=72398 
State-Changed-From-To: open->suspended 
State-Changed-By: vs 
State-Changed-When: Fri Sep 16 08:04:12 GMT 2005 
State-Changed-Why:  
Please submit patches :) 

http://www.freebsd.org/cgi/query-pr.cgi?pr=72398 
State-Changed-From-To: suspended->open 
State-Changed-By: schweikh 
State-Changed-When: Fri Sep 16 17:16:21 GMT 2005 
State-Changed-Why:  
I thought about how to fix this in a more general way. 
The problem is that our makewhatis(1) deals only with 
a subset of funky NAME contents. It can be improved by 
handling more non-standard NAME contents. I privately emailed 
the makewhatis author John Rochester john AT jrochester.org, if he 
wants to take a look at it. Thus reopen until further notice. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=72398 
Responsible-Changed-From-To: jmz->freebsd-bugs 
Responsible-Changed-By: edwin 
Responsible-Changed-When: Thu Dec 29 02:15:30 UTC 2005 
Responsible-Changed-Why:  
This is a makewhatis problem, not an mtools problem 

(but to quote: 
<grOogle> On the other hand, the man pages are Really Ugly. 
<grOogle> But that's a separate issue. 
) 

http://www.freebsd.org/cgi/query-pr.cgi?pr=72398 
>Unformatted:
