first pass for new make
[unix-history] / usr / src / usr.bin / compress / compress.1
index 5c665b3..4da064d 100644 (file)
@@ -1,11 +1,30 @@
-.\"    @(#)compress.1  6.3 (Berkeley) %G%
+.\" Copyright (c) 1986 The Regents of the University of California.
+.\" All rights reserved.
+.\"
+.\" This code is derived from software contributed to Berkeley by
+.\" James A. Woods, derived from original work by Spencer Thomas
+.\" and Joseph Orost.
+.\"
+.\" Redistribution and use in source and binary forms are permitted
+.\" provided that the above copyright notice and this paragraph are
+.\" duplicated in all such forms and that any documentation,
+.\" advertising materials, and other materials related to such
+.\" distribution and use acknowledge that the software was developed
+.\" by the University of California, Berkeley.  The name of the
+.\" University may not be used to endorse or promote products derived
+.\" from this software without specific prior written permission.
+.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
+.\" IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+.\" WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\"
+.\"    @(#)compress.1  6.6 (Berkeley) %G%
 .\"
 .TH COMPRESS 1 ""
 .UC 6
 .SH NAME
 compress, uncompress, zcat \- compress and expand data
 .\"
 .TH COMPRESS 1 ""
 .UC 6
 .SH NAME
 compress, uncompress, zcat \- compress and expand data
-.PU
 .SH SYNOPSIS
 .SH SYNOPSIS
+.PU
 .ll +8
 .B compress
 [
 .ll +8
 .B compress
 [
@@ -54,15 +73,18 @@ or
 The
 .B \-f
 option will force compression of
 The
 .B \-f
 option will force compression of
-.I name.
-This is useful for compressing an entire directory,
-even if some of the files do not actually shrink.
-If
+.IR name ,
+even if it does not actually shrink
+or the corresponding
+.IR name .Z
+file already exists.
+Except when run in the background under
+.IR /bin/sh ,
+if
 .B \-f
 .B \-f
-is not given and
-.I compress
-is run in the foreground,
-the user is prompted as to whether an existing file should be overwritten.
+is not given the user is prompted as to whether an existing
+.IR name .Z
+file should be overwritten.
 .PP
 The
 .B \-c
 .PP
 The
 .B \-c
@@ -129,15 +151,14 @@ or adaptive Huffman coding
 .RI ( compact ),
 and takes less time to compute.
 .PP
 .RI ( compact ),
 and takes less time to compute.
 .PP
-Under the
+The
 .B \-v
 .B \-v
-option,
-a message is printed yielding the percentage of
-reduction for each file compressed.
+option causes
+the printing of the percentage reduction of each file.
 .PP
 .PP
-Exit status is normally 0;
-if the last file is larger after (attempted) compression, the status is 2;
-if an error occurs, exit status is 1.
+If an error occurs, exit status is 1, else
+if the last file was not compressed because it became larger, the status
+is 2; else the status is 0.
 .SH "DIAGNOSTICS"
 Usage: compress [\-fvc] [\-b maxbits] [file ...]
 .in +8
 .SH "DIAGNOSTICS"
 Usage: compress [\-fvc] [\-b maxbits] [file ...]
 .in +8
@@ -226,3 +247,6 @@ Although compressed files are compatible between machines with large memory,
 should be used for file transfer to architectures with 
 a small process data space (64KB or less, as exhibited by the DEC PDP
 series, the Intel 80286, etc.)
 should be used for file transfer to architectures with 
 a small process data space (64KB or less, as exhibited by the DEC PDP
 series, the Intel 80286, etc.)
+.PP
+.I compress
+should be more flexible about the existence of the `.Z' suffix.