docs/84271: compress(1) doesn't warn about nasty link handling

[Gary W. Swearingen]

>Number:         84271
>Category:       docs
>Synopsis:       compress(1) doesn't warn about nasty link handling
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Fri Jul 29 04:30:26 GMT 2005
>Closed-Date:
>Last-Modified:
>Originator:     Gary W. Swearingen
>Release:        FreeBSD 5.4-RELEASE i386
>Organization:
none
>Environment:
n/a
>Description:
See synopsis.

>How-To-Repeat:
n/a

>Fix:
Apply patch with new paragraph at end of DESCRIPTION
and a new BUGS section:

--- /pr/work/compress..orig.1	Thu Jul 28 21:01:24 2005
+++ /pr/work/compress.1	Thu Jul 28 21:19:35 2005
@@ -152,6 +152,16 @@
 coding (as used in the historical command pack), or adaptive Huffman
 coding (as used in the historical command compact), and takes less
 time to compute.
+.Pp
+If
+.Ar file
+is a soft or hard link
+.Nm compress
+will replace it with a compressed copy of the linked-to file,
+leaving that file uncompressed.
+If
+.Ar file
+is hard linked, it will 
 .Sh DIAGNOSTICS
 .Ex -std compress uncompress
 .Pp
@@ -188,3 +198,5 @@
 .Nm
 command appeared in
 .Bx 4.3 .
+.Sh BUGS
+The program doesn't handle links well and has no link-handling options.
>Release-Note:
>Audit-Trail:
>Unformatted: