README

   1 This is the file README for the gzip distribution.
   2
   3 The GNU gzip home page is http://www.gnu.org/software/gzip.
   4
   5 gzip (GNU zip) is a compression utility designed to be a replacement
   6 for 'compress'. Its main advantages over compress are much better
   7 compression and freedom from patented algorithms.  The GNU Project
   8 uses it as the standard compression program for its system.
   9
  10 gzip currently uses by default the LZ77 algorithm used in zip 1.9 (the
  11 portable pkzip compatible archiver). The gzip format was however
  12 designed to accommodate several compression algorithms. See below
  13 for a comparison of zip and gzip.
  14
  15 gunzip can currently decompress files created by gzip, compress or
  16 pack. The detection of the input format is automatic.  For the
  17 gzip format, gunzip checks a 32 bit CRC. For pack, gunzip checks the
  18 uncompressed length.  The 'compress' format was not designed to allow
  19 consistency checks. However gunzip is sometimes able to detect a bad
  20 .Z file because there is some redundancy in the .Z compression format.
  21 If you get an error when uncompressing a .Z file, do not assume that
  22 the .Z file is correct simply because the standard uncompress does not
  23 complain.  This generally means that the standard uncompress does not
  24 check its input, and happily generates garbage output.
  25
  26 gzip produces files with a .gz extension. Previous versions of gzip
  27 used the .z extension, which was already used by the 'pack'
  28 Huffman encoder. gunzip is able to decompress .z files (packed
  29 or gzip'ed).
  30
  31 Several planned features are not yet supported (see the file TODO).
  32 See the file NEWS for a summary of changes since the last release.
  33 See the file INSTALL for installation instructions.
  34
  35 WARNING: gzip is sensitive to compiler bugs, particularly when
  36 optimizing.  Use "make check" to check that gzip was compiled
  37 correctly.  Try compiling gzip without any optimization if you have a
  38 problem.
  39
  40 Please send all comments and bug reports by electronic mail to
  41 <bug-gzip@gnu.org>.
  42
  43 Bug reports should ideally include:
  44
  45     * The complete output of "gzip -V" (or the contents of revision.h
  46       if you can't get gzip to compile)
  47     * The hardware and operating system (try "uname -a")
  48     * The compiler used to compile (if it is gcc, use "gcc -v")
  49     * A description of the bug behavior
  50     * The input to gzip, that triggered the bug
  51
  52 If you send me patches for machines I don't have access to, please test them
  53 very carefully. gzip is used for backups, it must be extremely reliable.
  54
  55 The znew and gzexe shell scripts provided with gzip benefit from
  56 (but do not require) the (non-GNU) cpmod utility to transfer file attributes.
  57
  58 The sample programs zread.c, sub.c and add.c in subdirectory sample
  59 are provided as examples of useful complements to gzip. Read the
  60 comments inside each source file.  The perl script ztouch is also
  61 provided as example (not installed by default since it relies on perl).
  62
  63
  64 gzip is free software, you can redistribute it and/or modify it under
  65 the terms of the GNU General Public License, a copy of which is
  66 provided under the name COPYING. The latest version of gzip are always
  67 available from ftp://ftp.gnu.org/gnu/gzip or in any of the gnu
  68 mirror sites.
  69
  70 - sources in gzip-*.tar (or .shar or .tar.gz).
  71 - MSDOS lha self-extracting exe in gzip-msdos-*.exe. Once extracted,
  72   copy gzip.exe to gunzip.exe and zcat.exe, or use "gzip -d" to decompress.
  73   gzip386.exe runs much faster but only on 386 and above; it was compiled with
  74   djgpp 1.10 available in directory omnigate.clarkson.edu:/pub/msdos/djgpp.
  75
  76 A VMS executable is in ftp://ftp.spc.edu/[.macro32.savesets]gzip-1-*.zip
  77 (use [.macro32]unzip.exe to extract). A PRIMOS executable is available
  78 in ftp://ftp.lysator.liu.se/pub/primos/run/gzip.run.
  79
  80 Some ftp servers can automatically make a tar.Z from a tar file. If
  81 you are getting gzip for the first time, you can ask for a tar.Z file
  82 instead of the much larger tar file.
  83
  84 Many thanks to those who provided me with bug reports and feedback.
  85 See the files THANKS and ChangeLog for more details.
  86
  87
  88                 Note about zip vs. gzip:
  89
  90 The name 'gzip' was a very unfortunate choice, because zip and gzip
  91 are two really different programs, although the actual compression and
  92 decompression sources were written by the same persons. A different
  93 name should have been used for gzip, but it is too late to change now.
  94
  95 zip is an archiver: it compresses several files into a single archive
  96 file. gzip is a simple compressor: each file is compressed separately.
  97 Both share the same compression and decompression code for the
  98 'deflate' method.  unzip can also decompress old zip archives
  99 (implode, shrink and reduce methods). gunzip can also decompress files
 100 created by compress and pack. zip 1.9 and gzip do not support
 101 compression methods other than deflation. (zip 1.0 supports shrink and
 102 implode). Better compression methods may be added in future versions
 103 of gzip. zip will always stick to absolute compatibility with pkzip,
 104 it is thus constrained by PKWare, which is a commercial company.  The
 105 gzip header format is deliberately different from that of pkzip to
 106 avoid such a constraint.
 107
 108 On Unix, gzip is mostly useful in combination with tar. GNU tar
 109 1.11.2 and later has a -z option to invoke gzip automatically.  "tar -z"
 110 compresses better than zip, since gzip can then take advantage of
 111 redundancy between distinct files. The drawback is that you must
 112 scan the whole tar.gz file in order to extract a single file near
 113 the end; unzip can directly seek to the end of the zip file. There
 114 is no overhead when you extract the whole archive anyway.
 115 If a member of a .zip archive is damaged, other files can still
 116 be recovered. If a .tar.gz file is damaged, files beyond the failure
 117 point cannot be recovered. (Future versions of gzip will have
 118 error recovery features.)
 119
 120 gzip and gunzip are distributed as a single program. zip and unzip
 121 are, for historical reasons, two separate programs, although the
 122 authors of these two programs work closely together in the Info-ZIP
 123 team. zip and unzip are not associated with the GNU project.
 124 See http://info-zip.org/ for more about zip and unzip.
 125
 126
 127 ========================================================================
 128
 129 Copyright (C) 1999, 2001, 2002, 2006, 2007, 2009, 2010 Free Software
 130 Foundation, Inc.
 131 Copyright (C) 1992, 1993 Jean-loup Gailly
 132
 133 Permission is granted to copy, distribute and/or modify this document
 134 under the terms of the GNU Free Documentation License, Version 1.3 or
 135 any later version published by the Free Software Foundation; with no
 136 Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
 137 Texts.  A copy of the license is included in the ``GNU Free
 138 Documentation License'' file as part of this distribution.