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