From hiloshi@seikyou.ne.jp Fri Mar 26 14:24:55 1999
Return-Path: <hiloshi@seikyou.ne.jp>
Received: from ma3.seikyou.ne.jp (ma3.seikyou.ne.jp [202.211.152.179])
	by hub.freebsd.org (Postfix) with ESMTP id E039514E70
	for <FreeBSD-gnats-submit@freebsd.org>; Fri, 26 Mar 1999 14:24:52 -0800 (PST)
	(envelope-from hiloshi@seikyou.ne.jp)
Received: from hiloshi.seikyou.ne.jp (kyoto-453.seikyou.ne.jp [202.211.148.8])
	by ma3.seikyou.ne.jp (8.9.3/3.7WNSK99010601) with ESMTP id HAA26216;
	Sat, 27 Mar 1999 07:24:30 +0900
Received: (from hiloshi@localhost) by hiloshi.seikyou.ne.jp (8.8.5/3.5Wpl7) id HAA03587; Sat, 27 Mar 1999 07:24:25 +0900 (JST)
Message-Id: <199903262224.HAA03587@hiloshi.seikyou.ne.jp>
Date: Sat, 27 Mar 1999 07:24:25 +0900 (JST)
From: Kaneda Hiloshi <vanitas@ma3.seikyou.ne.jp>
Sender: hiloshi@seikyou.ne.jp
To: FreeBSD-gnats-submit@freebsd.org
Cc: vanitas@ma3.seikyou.ne.jp
Subject: [send-pr]: formating problem of vinum.4 man page
X-Send-Pr-Version: 3.2

>Number:         10809
>Category:       docs
>Synopsis:       formating problem of vinum.4 man page
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    grog
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Fri Mar 26 14:30:00 PST 1999
>Closed-Date:    Fri Mar 26 16:19:35 PST 1999
>Last-Modified:  Fri Mar 26 16:20:02 PST 1999
>Originator:     Kanenda
>Release:        FreeBSD 4.0-CURRENT i386
>Organization:
FreeBSD jp-man project
>Environment:

$Id: vinum.4,v 1.15 1999/03/24 09:22:06 grog Exp $
http://www.freebsd.org/cgi/cvsweb.cgi/src/share/man/man4/vinum.4?rev=1.15

>Description:

The man page vinum.4 (it seems to be updated frequently, though)
has following three problems:

(a) line 100-115:
   The PS output seems to be broken or nonsense:
   
    | each subdisk in turn: move right 2i down SD0: box SD1: box SD2: box
    | 
    | "plex 0" at SD0.n+(0,.2) "subdisk 0" rjust at SD0.w-(.2,0)
    ....

(b) line 366:
    | When choosing volume and plex names, bear in mind
    | that automatically generated plex and subvolume names
    | are longer than the name from which they are derived.
    
   The term `subvolume' is not described anywhere.
   It should be `subdisk'.

(c) line 447:
    | A subdisk name is the name of the plex followed by the letters
    | \f(CW.s\fR and a number identifying the subdisk.
    
   Due to the `\f(CW.s\fR' placed at begging of line,
   the whole line disappears when formatted.

>How-To-Repeat:

man 4 vinum
man -t 4 vinum

>Fix:
	
I'm not sure about how to fix (a).
To fix (b) and (c), try the following patch:

--- vinum.4.orig	Sat Mar 27 06:47:36 1999
+++ vinum.4	Sat Mar 27 06:55:13 1999
@@ -363,7 +363,7 @@
 them to letters, digits and the underscore characters.  The names of volumes,
 plexes and subdisks may be up to 64 characters long, and the names of drives may
 up to 32 characters long.  When choosing volume and plex names, bear in mind
-that automatically generated plex and subvolume names are longer than the
+that automatically generated plex and subdisk names are longer than the
 name from which they are derived.
 .Bl -bullet 
 .It
@@ -443,9 +443,9 @@
 .br
 .It
 Like plexes, subdisks are assigned names automatically, and explicit naming is
-discouraged.  A subdisk name is the name of the plex followed by the letters
-\f(CW.s\fR and a number identifying the subdisk.  For example, the subdisks of
-plex
+discouraged.  A subdisk name is the name of the plex followed by the
+letters \f(CW.s\fR and a number identifying the subdisk.  For example,
+the subdisks of plex
 .Ar vol3.p0
 are called
 .Ar vol3.p0.s0 ,

>Release-Note:
>Audit-Trail:
Responsible-Changed-From-To: freebsd-doc->grog 
Responsible-Changed-By: billf 
Responsible-Changed-When: Fri Mar 26 14:44:12 PST 1999 
Responsible-Changed-Why:  
Over to vinum maintainer/author. 
State-Changed-From-To: open->closed 
State-Changed-By: grog 
State-Changed-When: Fri Mar 26 16:19:35 PST 1999 
State-Changed-Why:  
Reported problems were fixed 
>Unformatted:
Greg Lehey, 27 March 1999

        Thanks for the input.  The problems your're experiencing with
        (a) are probably due to the fact that you're not passing it
        through pic(1).  Since there's no standard for formatting
        hardcopy output of man pages, I can't think of a good way to
        solve this problem.  On the other hand, it looks as if the
        diagrams were incomplete, so I've commented them out for now.

        I've applied the fix for (b) as suggested.  The problem with
        (c) is an old troff gotcha that causes lines to be interpreted
        as (non-existent) commands if they start with a period.  It
        doesn't look as if this one starts with a period, since
        there's a \f(CW in front, but that doesn't worry troff.  The
        solution is to add a \&:

          Like plexes, subdisks are assigned names automatically, and explicit naming is
          discouraged.  A subdisk name is the name of the plex followed by the letters
          \f(CW\&.s\fR and a number identifying the subdisk.  For example, the subdisks of
          plex

	I've changed the version of FreeBSD from FreeBSD 2.2.1-RELEASE
	i386 to FreeBSD 4.0-CURRENT i386.  Vinum was never supported
	in 2.2.1, and the revision of vinum.4 against which you
	submitted this PR is part of 4.0-CURRENT.
