usr.bin/gzip/gzip.1

   1 .\"     $NetBSD: gzip.1,v 1.18 2005/09/30 13:46:56 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 1997, 2003, 2004 Matthew R. Green
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. The name of the author may not be used to endorse or promote products
  15 .\"    derived from this software without specific prior written permission.
  16 .\"
  17 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  22 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  24 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  25 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27 .\" SUCH DAMAGE.
  28 .\"
  29 .\" $FreeBSD$
  30 .Dd June 6, 2007
  31 .Dt GZIP 1
  32 .Os
  33 .Sh NAME
  34 .Nm gzip
  35 .Nd compression/decompression tool using Lempel-Ziv coding (LZ77)
  36 .Sh SYNOPSIS
  37 .Nm
  38 .Op Fl cdfhkLlNnqrtVv
  39 .Op Fl S Ar suffix
  40 .Ar file
  41 .Oo
  42 .Ar file Oo ...
  43 .Oc
  44 .Oc
  45 .Nm gunzip
  46 .Op Fl cfhkLNqrtVv
  47 .Op Fl S Ar suffix
  48 .Ar file
  49 .Oo
  50 .Ar file Oo ...
  51 .Oc
  52 .Oc
  53 .Nm zcat
  54 .Op Fl fhV
  55 .Ar file
  56 .Oo
  57 .Ar file Oo ...
  58 .Oc
  59 .Oc
  60 .Sh DESCRIPTION
  61 The
  62 .Nm
  63 program compresses and decompresses files using Lempel-Ziv coding
  64 (LZ77).
  65 If no
  66 .Ar files
  67 are specified,
  68 .Nm
  69 will compress from standard input, or decompress to standard output.
  70 When in compression mode, each
  71 .Ar file
  72 will be replaced with another file with the suffix, set by the
  73 .Fl S Ar suffix
  74 option, added, if possible.
  75 In decompression mode, each
  76 .Ar file
  77 will be checked for existence, as will the file with the suffix
  78 added.
  79 .Pp
  80 If invoked as
  81 .Nm gunzip
  82 then the
  83 .Fl d
  84 option is enabled.
  85 If invoked as
  86 .Nm zcat
  87 or
  88 .Nm gzcat
  89 then both the
  90 .Fl c
  91 and
  92 .Fl d
  93 options are enabled.
  94 .Pp
  95 This version of
  96 .Nm
  97 is also capable of decompressing files compressed using
  98 .Xr compress 1
  99 or
 100 .Xr bzip2 1 .
 101 .Sh OPTIONS
 102 The following options are available:
 103 .Bl -tag -width XXrXXXrecursiveX
 104 .It Fl 1 , -fast
 105 .It Fl 2 , 3 , 4 , 5 , 6 , 7 , 8
 106 .It Fl 9 , -best
 107 These options change the compression level used, with the
 108 .Fl 1
 109 option being the fastest, with less compression, and the
 110 .Fl 9
 111 option being the slowest, with optimal compression.
 112 The default compression level is 6.
 113 .It Fl c , -stdout , -to-stdout
 114 This option specifies that output will go to the standard output
 115 stream, leaving files intact.
 116 .It Fl d , -decompress , -uncompress
 117 This option selects decompression rather than compression.
 118 .It Fl f , -force
 119 This option turns on force mode.
 120 This allows files with multiple links, overwriting of pre-existing
 121 files, reading from or writing to a terminal, and when combined
 122 with the
 123 .Fl c
 124 option, allowing non-compressed data to pass through unchanged.
 125 .It Fl h , -help
 126 This option prints a usage summary and exits.
 127 .It Fl k , -keep
 128 Keep (don't delete) input files during compression
 129 or decompression.
 130 .It Fl L , -license
 131 This option prints
 132 .Nm
 133 license.
 134 .It Fl l , -list
 135 This option displays information about the file's compressed and
 136 uncompressed size, ratio, uncompressed name.
 137 With the
 138 .Fl v
 139 option, it also displays the compression method, CRC, date and time
 140 embedded in the file.
 141 .It Fl N , -name
 142 This option causes the stored filename in the input file to be used
 143 as the output file.
 144 .It Fl n , -no-name
 145 This option stops the filename from being stored in the output
 146 file.
 147 .It Fl q , -quiet
 148 With this option, no warnings or errors are printed.
 149 .It Fl r , -recursive
 150 This option is used to
 151 .Nm
 152 the files in a directory tree individually, using the
 153 .Xr fts 3
 154 library.
 155 .It Fl S Ar suffix , Fl -suffix Ar suffix
 156 This option changes the default suffix from .gz to
 157 .Ar suffix .
 158 .It Fl t , -test
 159 This option will test compressed files for integrity.
 160 .It Fl V , -version
 161 This option prints the version of the
 162 .Nm
 163 program.
 164 .It Fl v , -verbose
 165 This option turns on verbose mode, which prints the compression
 166 ratio for each file compressed.
 167 .El
 168 .Sh ENVIRONMENT
 169 If the environment variable
 170 .Ev GZIP
 171 is set, it is parsed as a white-space separated list of options
 172 handled before any options on the command line.
 173 Options on the command line will override anything in
 174 .Ev GZIP .
 175 .Sh SEE ALSO
 176 .Xr bzip2 1 ,
 177 .Xr compress 1 ,
 178 .Xr fts 3 ,
 179 .Xr zlib 3
 180 .Sh HISTORY
 181 The
 182 .Nm
 183 program was originally written by Jean-loup Gailly, licensed under
 184 the GNU Public Licence.
 185 Matthew R. Green wrote a simple front end for
 186 .Nx 1.3
 187 distribution media, based on the freely re-distributable zlib library.
 188 It was enhanced to be mostly feature-compatible with the original
 189 GNU
 190 .Nm
 191 program for
 192 .Nx 2.0 .
 193 .Pp
 194 This implementation of
 195 .Nm
 196 was ported based on the
 197 .Nx
 198 .Nm
 199 20060927, and first appeared in
 200 .Fx 7.0 .
 201 .Sh AUTHORS
 202 This implementation of
 203 .Nm
 204 was written by
 205 .An Matthew R. Green Aq mrg@eterna.com.au .
 206 .Sh BUGS
 207 According to RFC 1952, the recorded file size is stored in a 32-bit
 208 integer and therefore it can not represent files that is bigger than
 209 4GB in size.  This limitation also applies to
 210 .Fl l
 211 option of
 212 .Nm
 213 utility.