Bug 36453
| Summary: | compress(1) manual has erroneous description of "zcat". | ||
|---|---|---|---|
| Product: | Documentation | Reporter: | Gary W. Swearingen <swear> |
| Component: | Books & Articles | Assignee: | Tom Rhodes <trhodes> |
| Status: | Closed FIXED | ||
| Severity: | Affects Only Me | ||
| Priority: | Normal | ||
| Version: | Latest | ||
| Hardware: | Any | ||
| OS: | Any | ||
|
Description
Gary W. Swearingen
2002-03-29 03:30:01 UTC
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 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. 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/ 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 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. 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 I'll work with Gary on this and try to get it closed. --- 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 Patch applied to CURRENT I'll apply to STABLE in 3 days, thanks Gary! State Changed From-To: patched->closed I have just committed the patch to STABLE, thanks for pointing this out Gary! |
