From k-horik@yk.rim.or.jp  Tue Jan  5 07:18:39 1999
Received: from mail.yk.rim.or.jp (mail.yk.rim.or.jp [202.247.130.37])
          by hub.freebsd.org (8.8.8/8.8.8) with ESMTP id HAA25666
          for <FreeBSD-gnats-submit@freebsd.org>; Tue, 5 Jan 1999 07:18:35 -0800 (PST)
          (envelope-from k-horik@yk.rim.or.jp)
Received: from localhost (ppp424.yk.rim.or.jp [202.247.165.124])
	by mail.yk.rim.or.jp (8.8.5/3.6W-RIMNET-98-06-09) with ESMTP id AAA17183
	for <FreeBSD-gnats-submit@freebsd.org>; Wed, 6 Jan 1999 00:17:57 +0900 (JST)
Message-Id: <19990106001723T.k-horik@yk.rim.or.jp>
Date: Wed, 06 Jan 1999 00:17:23 +0900
From: Kazuo Horikawa <k-horik@yk.rim.or.jp>
Reply-To: horikawa@jp.freebsd.org
To: FreeBSD-gnats-submit@freebsd.org
Subject: vinum.8 should not use .TS H/.TH N (vinum.8 has "N()" as header)
X-Send-Pr-Version: 3.2

>Number:         9328
>Category:       docs
>Synopsis:       vinum.8 should not use .TS H/.TH N (vinum.8 has "N()" as header)
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    grog
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Tue Jan  5 07:20:00 PST 1999
>Closed-Date:    Fri Jan 8 18:16:56 PST 1999
>Last-Modified:  Fri Jan  8 19:03:19 PST 1999
>Originator:     Kazuo Horikawa
>Release:        FreeBSD 2.2.7-RELEASE i386
>Organization:
FreeBSD Users Group, Japan.
>Environment:

	src/sbin/vinum/vinum.8 revision 1.3 (HEAD)

>Description:

	Manpage src/sbin/vinum/vinum.8 uses .TS H/.TH N for multi-page
	boxed table, but -mdoc (/usr/share/tmac/tmac.doc) macro does
	not handle .TS H/.TH N for multi-page boxed table.


	Roff macro /usr/share/tmac/tmac.an defines "TH" as follows:

	.\" Load either tmac.an or tmac.doc.
	[snip]
	.de TH
	.rm TH
	.do mso tmac.groff_an
	\\*(TH\\
	..

	and roff macro /usr/share/tmac/tmac.groff_an defiles "TH" as
	follows:

	.\" .TH title section extra1 extra2 extra3
	.de TH
	.cp 0
	.de an-init \" We have to do it like this to get multiple man pages right.
	.ds an-title "\\$1
	.ds an-section "\\$2
	.ds an-extra1 "\\$3
	[snip]


	In manual pages which use -man macro, "TH" macro are used
	like:

	.TH GCC 1 "\*(Dt" "GNU Tools" "GNU Tools"

	So, formatting vinum.8 by
	$ tbl vinum.8 | groff -man -Tascii
	give us following output:
	[snip]
                                                                             6





N()                                                                        N()


             org organization   Specify the organization of the plex.
             [stripesize]       organization can be one of concat, striped or
	[snip]

>How-To-Repeat:

	$ man 8 vinum

>Fix:
	
	I think that ".TH N" should be removed from
	src/sbin/vinum/vinum.8 revision 1.3 (HEAD).

--- vinum.8.orig	Tue Jan  5 21:34:03 1999
+++ vinum.8	Tue Jan  5 21:34:11 1999
@@ -636,7 +636,6 @@
 tab(#) ;
 l lw50 .
 Option#Meaning
-.TH N
 T{
 .Nm plex
 .Ar plexname
@@ -701,7 +700,6 @@
 tab(#) ;
 l lw50 .
 Option#Meaning
-.TH N
 T{
 .Nm name
 .Ar plexname


>Release-Note:
>Audit-Trail:
Responsible-Changed-From-To: freebsd-doc->grog 
Responsible-Changed-By: grog 
Responsible-Changed-When: Tue Jan 5 13:15:41 PST 1999 
Responsible-Changed-Why:  
Assigned to responsible developer 
State-Changed-From-To: open->closed 
State-Changed-By: grog 
State-Changed-When: Fri Jan 8 18:16:56 PST 1999 
State-Changed-Why:  
I have applied the suggested fix, which also allows troff formatting, 
in revision 1.4 of vinum.8.  This is not an ideal solution: it means 
that the tables will not format correctly if they don't naturally fit 
on a page, and some warning messages may occur when formatting.  I'll 
apply a proper fix (which probably means not using tbl) when I have time. 
>Unformatted:

Greg Lehey <grog@FreeBSD.org>, 8 January 1998:

I have applied the suggested fix, which also allows troff formatting,
in revision 1.4 of vinum.8.  This is not an ideal solution: it means
that the tables will not format correctly if they don't naturally fit
on a page, and some warning messages may occur when formatting.  I'll
apply a proper fix (which probably means not using tbl) when I have time.
