git: fc1e79740e4a - main - compress(1): warn about link handling

[Fernando Apesteguía]

The branch main has been updated by fernape (doc, ports committer):

URL: https://cgit.FreeBSD.org/src/commit/?id=fc1e79740e4a83013aa0050fc95a991ec9c78e27

commit fc1e79740e4a83013aa0050fc95a991ec9c78e27
Author:     Fernando Apesteguía <fernape at FreeBSD.org>
AuthorDate: 2021-02-09 09:11:22 +0000
Commit:     Fernando Apesteguía <fernape at FreeBSD.org>
CommitDate: 2021-03-04 13:52:12 +0000

    compress(1): warn about link handling
    
    compress(1) handles links badly and does not provide link-handling options.
    Document this behavior.
    
    PR:     84271
    Submitted by: garys at opusnet.com
    Approved by: gbe@ (mentor)
    Differential Revision:  https://reviews.freebsd.org/D28552
---
 usr.bin/compress/compress.1 | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/usr.bin/compress/compress.1 b/usr.bin/compress/compress.1
index de44653775ea..3aa18a963cdc 100644
--- a/usr.bin/compress/compress.1
+++ b/usr.bin/compress/compress.1
@@ -32,7 +32,7 @@
 .\"     @(#)compress.1	8.2 (Berkeley) 4/18/94
 .\" $FreeBSD$
 .\"
-.Dd October 20, 2020
+.Dd March 4, 2021
 .Dt COMPRESS 1
 .Os
 .Sh NAME
@@ -177,6 +177,13 @@ Compression is generally much better than that achieved by Huffman
 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
+will replace it with a compressed copy of the file pointed to by the link.
+The link's target file is left uncompressed.
 .Sh EXIT STATUS
 .Ex -std compress uncompress
 .Pp
@@ -248,6 +255,8 @@ The
 command appeared in
 .Bx 4.3 .
 .Sh BUGS
+The program does not handle links well and has no link-handling options.
+.Pp
 Some of these might be considered otherwise-undocumented features.
 .Pp
 .Nm compress :