From swear@blarg.net  Thu Mar 28 19:28:35 2002
Return-Path: <swear@blarg.net>
Received: from lists.blarg.net (lists.blarg.net [206.124.128.17])
	by hub.freebsd.org (Postfix) with ESMTP id 60AE737B419
	for <FreeBSD-gnats-submit@freebsd.org>; Thu, 28 Mar 2002 19:28:34 -0800 (PST)
Received: from thig.blarg.net (thig.blarg.net [206.124.128.18])
	by lists.blarg.net (Postfix) with ESMTP id 07DE7BD13
	for <FreeBSD-gnats-submit@freebsd.org>; Thu, 28 Mar 2002 19:28:34 -0800 (PST)
Received: from localhost.localdomain ([206.124.139.115])
	by thig.blarg.net (8.9.3/8.9.3) with ESMTP id TAA13194
	for <FreeBSD-gnats-submit@freebsd.org>; Thu, 28 Mar 2002 19:28:33 -0800
Received: (from jojo@localhost)
	by localhost.localdomain (8.11.6/8.11.3) id g2T3R7H98383;
	Thu, 28 Mar 2002 19:27:07 -0800 (PST)
	(envelope-from swear@blarg.net)
Message-Id: <xod6xogik4.6xo@localhost.localdomain>
Date: 28 Mar 2002 19:27:07 -0800
From: "Gary W. Swearingen" <swear@blarg.net>
Reply-To: swear@blarg.net
To: FreeBSD-gnats-submit@freebsd.org
Subject: compress(1) manual has erroneous description of "zcat".
X-GNATS-Notify:

>Number:         36453
>Category:       docs
>Synopsis:       compress(1) manual has erroneous description of "zcat".
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    trhodes
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Thu Mar 28 19:30:01 PST 2002
>Closed-Date:    Fri Apr 12 09:10:32 PDT 2002
>Last-Modified:  Fri Apr 12 09:10:32 PDT 2002
>Originator:     Gary W. Swearingen
>Release:        FreeBSD 4.5-STABLE i386
>Organization:
none
>Environment:
n/a
================
>Description:

The compress(1) manual documents the command "zcat" which is better
documented by the zcat(1) manual and which doesn't belong in this manual.

The given description is wrong in any case because "zcat" doesn't insist
that the filename end with ".Z" as "uncompress -c" does.
================
>How-To-Repeat:
n/a
================
>Fix:

Remove all mention of "zcat" (four places) and add zcat(1) to the "See
Also" section.  Maybe also mention it in the description of "-c".
>Release-Note:
>Audit-Trail:

From: Giorgos Keramidas <keramida@freebsd.org>
To: "Gary W. Swearingen" <swear@blarg.net>
Cc: bug-followup@freebsd.org
Subject: Re: docs/36453: compress(1) manual has erroneous description of "zcat".
Date: Fri, 29 Mar 2002 06:07:02 +0200

 On 2002-03-28 19:27, Gary W. Swearingen wrote:
 > The compress(1) manual documents the command "zcat" which is better
 > documented by the zcat(1) manual and which doesn't belong in this manual.
 >
 > Remove all mention of "zcat" (four places) and add zcat(1) to the "See
 > Also" section.  Maybe also mention it in the description of "-c".
 
 How about this?  I haven't added zcat(1) to SEE ALSO, since it's not
 referenced anywhere in the manpage.  Also had a few reservations about
 adding only zcat(1).  If we add this, then we should probably add other
 compress-tools too, like gzip(1), gunzip(1), zmore(1), etc.
 
 What do you think?
 
     Index: compress.1
     ===================================================================
     RCS file: /home/ncvs/src/usr.bin/compress/compress.1,v
     retrieving revision 1.11
     diff -2 -u -r1.11 compress.1
     --- compress.1	11 Sep 2001 12:27:15 -0000	1.11
     +++ compress.1	29 Mar 2002 04:04:06 -0000
     @@ -42,6 +42,5 @@
      .Sh NAME
      .Nm compress ,
     -.Nm uncompress ,
     -.Nm zcat
     +.Nm uncompress
      .Nd compress and expand data
      .Sh SYNOPSIS
     @@ -53,6 +52,4 @@
      .Op Fl cfv
      .Op Ar
     -.Nm zcat
     -.Op Ar
      .Sh DESCRIPTION
      .Nm Compress
     @@ -154,5 +151,5 @@
      time to compute.
      .Sh DIAGNOSTICS
     -.Ex -std compress uncompress zcat
     +.Ex -std compress uncompress
      .Sh SEE ALSO
      .Rs

From: swear@blarg.net (Gary W. Swearingen)
To: Giorgos Keramidas <keramida@freebsd.org>
Cc: bug-followup@freebsd.org
Subject: Re: docs/36453: compress(1) manual has erroneous description of "zcat".
Date: 28 Mar 2002 22:53:15 -0800

 Giorgos Keramidas <keramida@freebsd.org> writes:
 
 > What do you think?
 
 I think I agree, except that I didn't see that your removed "zcat" and
 it's erroneous description from the DESCRIPTION section. (See subject! :)
 It seems like you meant to remove it.

From: Giorgos Keramidas <keramida@freebsd.org>
To: "Gary W. Swearingen" <swear@blarg.net>
Cc: bug-followup@freebsd.org
Subject: Re: docs/36453: compress(1) manual has erroneous description of "zcat".
Date: Fri, 29 Mar 2002 16:56:41 +0200

 On 2002-03-28 22:53, Gary W. Swearingen wrote:
 > I think I agree, except that I didn't see that your removed "zcat" and
 > it's erroneous description from the DESCRIPTION section. (See subject! :)
 > It seems like you meant to remove it.
 
 Indeed.  I'll make the following changes later tonight, unless someone
 comes up with a good idea for the references in the SEE ALSO section.
 
 %%%
 Index: compress.1
 ===================================================================
 RCS file: /home/ncvs/src/usr.bin/compress/compress.1,v
 retrieving revision 1.11
 diff -2 -u -r1.11 compress.1
 --- compress.1	11 Sep 2001 12:27:15 -0000	1.11
 +++ compress.1	29 Mar 2002 14:52:27 -0000
 @@ -42,6 +42,5 @@
  .Sh NAME
  .Nm compress ,
 -.Nm uncompress ,
 -.Nm zcat
 +.Nm uncompress
  .Nd compress and expand data
  .Sh SYNOPSIS
 @@ -53,6 +52,4 @@
  .Op Fl cfv
  .Op Ar
 -.Nm zcat
 -.Op Ar
  .Sh DESCRIPTION
  .Nm Compress
 @@ -75,8 +72,4 @@
  extension.
  .Pp
 -.Nm Zcat
 -is an alias for
 -.Dq "uncompress -c" .
 -.Pp
  If renaming the files would cause files to be overwritten and the standard
  input device is a terminal, the user is prompted (on the standard error
 @@ -154,5 +147,5 @@
  time to compute.
  .Sh DIAGNOSTICS
 -.Ex -std compress uncompress zcat
 +.Ex -std compress uncompress
  .Sh SEE ALSO
  .Rs
 %%%
 
 Giorgos Keramidas                       FreeBSD Documentation Project
 keramida@{freebsd.org,ceid.upatras.gr}  http://www.FreeBSD.org/docproj/

From: <trhodes@FreeBSD.org>
To: FreeBSD-gnats-submit@FreeBSD.org
Cc:  
Subject: Re: docs/36453: [PATCH] compress(1)
Date: Mon, 1 Apr 2002 19:48:50 -0800 (PST)

 Follow-up to Giorgos's work and Gary's comments, this patch not
 only utilizes the patch made by Giorgos, but also adds some other
 compression utilities to compress(1).  Comments are welcome, Gary,
 what do you think?
 
 --
 Tom (darklogik) Rhodes
 
 
 --- compress.1.old	Mon Apr  1 22:40:49 2002
 +++ compress.1	Mon Apr  1 22:53:05 2002
 @@ -41,8 +41,6 @@
  .Os
  .Sh NAME
  .Nm compress ,
 -.Nm uncompress ,
 -.Nm zcat
  .Nd compress and expand data
  .Sh SYNOPSIS
  .Nm
 @@ -52,8 +50,6 @@
  .Nm uncompress
  .Op Fl cfv
  .Op Ar
 -.Nm zcat
 -.Op Ar
  .Sh DESCRIPTION
  .Nm Compress
  reduces the size of the named files using adaptive Lempel-Ziv coding.
 @@ -74,10 +70,6 @@
  .Dq .Z
  extension.
  .Pp
 -.Nm Zcat
 -is an alias for
 -.Dq "uncompress -c" .
 -.Pp
  If renaming the files would cause files to be overwritten and the standard
  input device is a terminal, the user is prompted (on the standard error
  output) for confirmation.
 @@ -153,8 +145,14 @@
  coding (as used in the historical command compact), and takes less
  time to compute.
  .Sh DIAGNOSTICS
 -.Ex -std compress uncompress zcat
 +.Ex -std compress uncompress
  .Sh SEE ALSO
 +.Xr zcat 1 ,
 +.Xr gunzip 1 ,
 +.Xr gzip 1 ,
 +.Xr zmore 1 ,
 +.Xr znew 1 ,
 +.Xr gzexe 1
  .Rs
  .%A Welch, Terry A.
  .%D June, 1984

From: Peter Pentchev <roam@ringlet.net>
To: trhodes@FreeBSD.org
Cc: bug-followup@FreeBSD.org
Subject: Re: docs/36453: [PATCH] compress(1)
Date: Tue, 2 Apr 2002 13:58:48 +0300

 On Mon, Apr 01, 2002 at 07:50:03PM -0800, trhodes@FreeBSD.org wrote:
 >  Follow-up to Giorgos's work and Gary's comments, this patch not
 >  only utilizes the patch made by Giorgos, but also adds some other
 >  compression utilities to compress(1).  Comments are welcome, Gary,
 >  what do you think?
 >  
 >  --
 >  Tom (darklogik) Rhodes
 >  
 >  
 >  --- compress.1.old	Mon Apr  1 22:40:49 2002
 >  +++ compress.1	Mon Apr  1 22:53:05 2002
 >  @@ -41,8 +41,6 @@
 >   .Os
 >   .Sh NAME
 >   .Nm compress ,
 >  -.Nm uncompress ,
 >  -.Nm zcat
 
 Err.. I believe you only wanted to axe 'zcat'; 'uncompress' should stay :)
 
 G'luck,
 Peter
 
 -- 
 Peter Pentchev	roam@ringlet.net	roam@FreeBSD.org
 PGP key:	http://people.FreeBSD.org/~roam/roam.key.asc
 Key fingerprint	FDBA FD79 C26F 3C51 C95E  DF9E ED18 B68D 1619 4553
 Thit sentence is not self-referential because "thit" is not a word.

From: Giorgos Keramidas <keramida@freebsd.org>
To: "Gary W. Swearingen" <swear@blarg.net>
Cc: trhodes@freebsd.org, bug-followup@freebsd.org
Subject: Re: docs/36453: [PATCH] compress(1)
Date: Wed, 3 Apr 2002 18:09:40 +0300

 On 2002-04-02 15:20, Gary W. Swearingen wrote:
 > <trhodes@FreeBSD.ORG> writes:
 > >   .Sh SEE ALSO
 > >  +.Xr zcat 1 ,
 > >  +.Xr gunzip 1 ,
 > >  +.Xr gzip 1 ,
 > >  +.Xr zmore 1 ,
 > >  +.Xr znew 1 ,
 > >  +.Xr gzexe 1
 
 I believe these should be sorted alphabetically, since they are
 manpages of the same section.  Nice work though.  I think I'll assign
 this PR to trhodes :P
 
 > You'll take care of adding compress(1) and uncompress(1) to all those
 > manuals?  Ha Ha.  (I really don't care, as I have not yet determined
 > what "See Also" should list.  It seems good that they have helpful info
 > (you just showed me three unfamiliar commands), but I also think that
 > the "fvwm2" manual shouldn't make room (even in it's 6300 pages) to
 > list all or some or even any other window managers.)
 
 It's slightly different since fvwm2 is a port and not part of the base
 system.  We can't add stuff to port manpages with the same ease this
 can be done for parts of the base system.
 
 - Giorgos
Responsible-Changed-From-To: freebsd-doc->trhodes 
Responsible-Changed-By: trhodes 
Responsible-Changed-When: Wed Apr 3 07:29:32 PST 2002 
Responsible-Changed-Why:  
I'll work with Gary on this and try to get it closed. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=36453 

From: <trhodes@FreeBSD.org>
To: FreeBSD-gnats-submit@FreeBSD.org
Cc:  
Subject: Re: docs/36453 [PATCH] compress(1)
Date: Thu, 4 Apr 2002 19:10:37 -0800 (PST)

 --- compress.1.old	Mon Apr  1 22:40:49 2002
 +++ compress.1	Wed Apr  3 10:50:00 2002
 @@ -42,7 +42,6 @@
  .Sh NAME
  .Nm compress ,
  .Nm uncompress ,
 -.Nm zcat
  .Nd compress and expand data
  .Sh SYNOPSIS
  .Nm
 @@ -52,8 +51,6 @@
  .Nm uncompress
  .Op Fl cfv
  .Op Ar
 -.Nm zcat
 -.Op Ar
  .Sh DESCRIPTION
  .Nm Compress
  reduces the size of the named files using adaptive Lempel-Ziv coding.
 @@ -74,10 +71,6 @@
  .Dq .Z
  extension.
  .Pp
 -.Nm Zcat
 -is an alias for
 -.Dq "uncompress -c" .
 -.Pp
  If renaming the files would cause files to be overwritten and the standard
  input device is a terminal, the user is prompted (on the standard error
  output) for confirmation.
 @@ -153,8 +146,14 @@
  coding (as used in the historical command compact), and takes less
  time to compute.
  .Sh DIAGNOSTICS
 -.Ex -std compress uncompress zcat
 +.Ex -std compress uncompress
  .Sh SEE ALSO
 +.Xr gunzip 1 ,
 +.Xr gzexe 1 ,
 +.Xr gzip 1 ,
 +.Xr zcat 1 ,
 +.Xr zmore 1 ,
 +.Xr xnew 1
  .Rs
  .%A Welch, Terry A.
  .%D June, 1984
State-Changed-From-To: open->patched 
State-Changed-By: trhodes 
State-Changed-When: Tue Apr 9 13:41:03 PDT 2002 
State-Changed-Why:  
Patch applied to CURRENT I'll apply to STABLE in 3 days, thanks Gary! 

http://www.freebsd.org/cgi/query-pr.cgi?pr=36453 
State-Changed-From-To: patched->closed 
State-Changed-By: trhodes 
State-Changed-When: Fri Apr 12 09:09:58 PDT 2002 
State-Changed-Why:  
I have just committed the patch to STABLE, thanks for pointing this out 
Gary! 

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