usr.bin/compress/compress.1

   1 .\" Copyright (c) 1986, 1990, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to Berkeley by
   5 .\" James A. Woods, derived from original work by Spencer Thomas
   6 .\" and Joseph Orost.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. All advertising materials mentioning features or use of this software
  17 .\"    must display the following acknowledgement:
  18 .\"     This product includes software developed by the University of
  19 .\"     California, Berkeley and its contributors.
  20 .\" 4. Neither the name of the University nor the names of its contributors
  21 .\"    may be used to endorse or promote products derived from this software
  22 .\"    without specific prior written permission.
  23 .\"
  24 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34 .\" SUCH DAMAGE.
  35 .\"
  36 .\"     @(#)compress.1  8.2 (Berkeley) 4/18/94
  37 .\" $FreeBSD$
  38 .\"
  39 .Dd May 17, 2002
  40 .Dt COMPRESS 1
  41 .Os
  42 .Sh NAME
  43 .Nm compress ,
  44 .Nm uncompress
  45 .Nd compress and expand data
  46 .Sh SYNOPSIS
  47 .Nm
  48 .Op Fl fv
  49 .Op Fl b Ar bits
  50 .Op Ar
  51 .Nm
  52 .Fl c
  53 .Op Fl b Ar bits
  54 .Op Ar file
  55 .Nm uncompress
  56 .Op Fl f
  57 .Op Ar
  58 .Nm uncompress
  59 .Fl c
  60 .Op Ar file
  61 .Sh DESCRIPTION
  62 The
  63 .Nm
  64 utility reduces the size of files using adaptive Lempel-Ziv coding.
  65 Each
  66 .Ar file
  67 is renamed to the same name plus the extension
  68 .Pa .Z .
  69 A
  70 .Ar file
  71 argument with a
  72 .Pa .Z
  73 extension will be ignored except it will cause an
  74 error exit after other arguments are processed.
  75 If compression would not reduce the size of a
  76 .Ar file ,
  77 the file is ignored.
  78 .Pp
  79 The
  80 .Nm uncompress
  81 utility restores compressed files to their original form, renaming the
  82 files by deleting the
  83 .Pa .Z
  84 extensions.
  85 A file specification need not include the file's
  86 .Pa .Z
  87 extension.
  88 If a file's name in its file system does not have a
  89 .Pa .Z
  90 extension, it will not be uncompressed and it will cause
  91 an error exit after other arguments are processed.
  92 .Pp
  93 If renaming the files would cause files to be overwritten and the standard
  94 input device is a terminal, the user is prompted (on the standard error
  95 output) for confirmation.
  96 If prompting is not possible or confirmation is not received, the files
  97 are not overwritten.
  98 .Pp
  99 As many of the modification time, access time, file flags, file mode,
 100 user ID, and group ID as allowed by permissions are retained in the
 101 new file.
 102 .Pp
 103 If no files are specified or a
 104 .Ar file
 105 argument is a single dash
 106 .Pq Sq Fl ,
 107 the standard input is compressed or uncompressed to the standard output.
 108 If either the input and output files are not regular files, the checks for
 109 reduction in size and file overwriting are not performed, the input file is
 110 not removed, and the attributes of the input file are not retained
 111 in the output file.
 112 .Pp
 113 The options are as follows:
 114 .Bl -tag -width ".Fl b Ar bits"
 115 .It Fl b Ar bits
 116 The code size (see below) is limited to
 117 .Ar bits ,
 118 which must be in the range 9..16.
 119 The default is 16.
 120 .It Fl c
 121 Compressed or uncompressed output is written to the standard output.
 122 No files are modified.
 123 The
 124 .Fl v
 125 option is ignored.
 126 Compression is attempted even if the results will be larger than the
 127 original.
 128 .It Fl f
 129 Files are overwritten without prompting for confirmation.
 130 Also, for
 131 .Nm compress ,
 132 files are compressed even if they are not actually reduced in size.
 133 .It Fl v
 134 Print the percentage reduction of each file.
 135 Ignored by
 136 .Nm uncompress
 137 or if the
 138 .Fl c
 139 option is also used.
 140 .El
 141 .Pp
 142 The
 143 .Nm
 144 utility uses a modified Lempel-Ziv algorithm.
 145 Common substrings in the file are first replaced by 9-bit codes 257 and up.
 146 When code 512 is reached, the algorithm switches to 10-bit codes and
 147 continues to use more bits until the
 148 limit specified by the
 149 .Fl b
 150 option or its default is reached.
 151 .Pp
 152 After the limit is reached,
 153 .Nm
 154 periodically checks the compression ratio.
 155 If it is increasing,
 156 .Nm
 157 continues to use the existing code dictionary.
 158 However, if the compression ratio decreases,
 159 .Nm
 160 discards the table of substrings and rebuilds it from scratch.
 161 This allows
 162 the algorithm to adapt to the next "block" of the file.
 163 .Pp
 164 The
 165 .Fl b
 166 option is unavailable for
 167 .Nm uncompress
 168 since the
 169 .Ar bits
 170 parameter specified during compression
 171 is encoded within the output, along with
 172 a magic number to ensure that neither decompression of random data nor
 173 recompression of compressed data is attempted.
 174 .Pp
 175 The amount of compression obtained depends on the size of the
 176 input, the number of
 177 .Ar bits
 178 per code, and the distribution of common substrings.
 179 Typically, text such as source code or English is reduced by 50\-60%.
 180 Compression is generally much better than that achieved by Huffman
 181 coding (as used in the historical command pack), or adaptive Huffman
 182 coding (as used in the historical command compact), and takes less
 183 time to compute.
 184 .Sh EXIT STATUS
 185 .Ex -std compress uncompress
 186 .Pp
 187 The
 188 .Nm compress
 189 utility exits 2 if attempting to compress a file would not reduce its size
 190 and the
 191 .Fl f
 192 option was not specified and if no other error occurs.
 193 .Sh SEE ALSO
 194 .Xr gunzip 1 ,
 195 .Xr gzexe 1 ,
 196 .Xr gzip 1 ,
 197 .Xr zcat 1 ,
 198 .Xr zmore 1 ,
 199 .Xr znew 1
 200 .Rs
 201 .%A Welch, Terry A.
 202 .%D June, 1984
 203 .%T "A Technique for High Performance Data Compression"
 204 .%J "IEEE Computer"
 205 .%V 17:6
 206 .%P pp. 8-19
 207 .Re
 208 .Sh STANDARDS
 209 The
 210 .Nm compress
 211 and
 212 .Nm uncompress
 213 utilities conform to
 214 .St -p1003.1-2001 .
 215 .Sh HISTORY
 216 The
 217 .Nm
 218 command appeared in
 219 .Bx 4.3 .
 220 .Sh BUGS
 221 Some of these might be considered otherwise-undocumented features.
 222 .Pp
 223 .Nm compress :
 224 If the utility does not compress a file because doing so would not
 225 reduce its size, and a file of the same name except with an
 226 .Pa .Z
 227 extension exists, the named file is not really ignored as stated above;
 228 it causes a prompt to confirm the overwriting of the file with the extension.
 229 If the operation is confirmed, that file is deleted.
 230 .Pp
 231 .Nm uncompress :
 232 If an empty file is compressed (using
 233 .Fl f ) ,
 234 the resulting
 235 .Pa .Z
 236 file is also empty.
 237 That seems right, but if
 238 .Nm uncompress
 239 is then used on that file, an error will occur.
 240 .Pp
 241 Both utilities: If a
 242 .Sq Fl
 243 argument is used and the utility prompts the user, the standard input
 244 is taken as the user's reply to the prompt.
 245 .Pp
 246 Both utilities:
 247 If the specified file does not exist, but a similarly-named one with (for
 248 .Nm compress )
 249 or without (for
 250 .Nm uncompress )
 251 a
 252 .Pa .Z
 253 extension does exist, the utility will waste the user's time by not
 254 immediately emitting an error message about the missing file and
 255 continuing.
 256 Instead, it first asks for confirmation to overwrite
 257 the existing file and then does not overwrite it.