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