doc: correct a diagnostic in man page to match actual

[debian/gzip] / gzip.1

diff --git a/gzip.1 b/gzip.1
index c97aeb1bf141ba7f74c23713a1e6efdb41124ea8..07995ea99366a1ae049e1e79168804b099734a62 100644 (file)
--- a/gzip.1
+++ b/gzip.1
@@ -4,7 +4,7 @@ gzip, gunzip, zcat \- compress or expand files
 .SH SYNOPSIS
 .ll +8
 .B gzip
 .SH SYNOPSIS
 .ll +8
 .B gzip

-.RB [ " \-acdfhlLnNrtvV19 " ]
+.RB [ " \-acdfhklLnNrtvV19 " ]

 .RB [ \-S\ suffix ]
 [
 .I "name \&..."
 .RB [ \-S\ suffix ]
 [
 .I "name \&..."


@@ -12,7 +12,7 @@ gzip, gunzip, zcat \- compress or expand files
 .ll -8
 .br
 .B gunzip
 .ll -8
 .br
 .B gunzip

-.RB [ " \-acfhlLnNrtvV " ]
+.RB [ " \-acfhklLnNrtvV " ]

 .RB [ \-S\ suffix ]
 [
 .I "name \&..."
 .RB [ \-S\ suffix ]
 [
 .I "name \&..."


@@ -218,6 +218,9 @@ prompts to verify whether an existing file should be overwritten.
 .B \-h --help
 Display a help screen and quit.
 .TP
 .B \-h --help
 Display a help screen and quit.
 .TP

+.B \-k --keep
+Keep (don't delete) input files during compression or decompression.
+.TP

 .B \-l --list
 For each compressed file, list the following fields:
 
 .B \-l --list
 For each compressed file, list the following fields:
 


@@ -361,17 +364,36 @@ such as tar or zip. GNU tar supports the -z option to invoke gzip
 transparently. gzip is designed as a complement to tar, not as a
 replacement.
 .SH "ENVIRONMENT"
 transparently. gzip is designed as a complement to tar, not as a
 replacement.
 .SH "ENVIRONMENT"

-The environment variable
+The obsolescent environment variable

 .B GZIP
 can hold a set of default options for
 .IR gzip .
 .B GZIP
 can hold a set of default options for
 .IR gzip .

-These options are interpreted first and can be overwritten by
-explicit command line parameters. For example:
-      for sh:    GZIP="-8v --name"; export GZIP
-      for csh:   setenv GZIP "-8v --name"
-      for MSDOS: set GZIP=-8v --name
+These options are interpreted first and can be overwritten by explicit
+command line parameters.  As this can cause problems when using
+scripts, this feature is supported only for options that are
+reasonably likely to not cause too much harm, and
+.I gzip
+warns if it is used.
+This feature will be removed in a future release of
+.IR gzip .
+.PP
+You can use an alias or script instead.  For example, if
+.I gzip
+is in the directory
+.B /usr/bin
+you can prepend
+.B $HOME/bin
+to your
+.B PATH
+and create an executable script
+.B $HOME/bin/gzip
+containing the following:
+
+      #! /bin/sh
+      export PATH=/usr/bin
+      exec gzip \-9 "$@"

 
 

-On Vax/VMS, the name of the environment variable is GZIP_OPT, to
+On VMS, the name of the obsolescent environment variable is GZIP_OPT, to

 avoid a conflict with the symbol set for invocation of the program.
 .SH "SEE ALSO"
 znew(1), zcmp(1), zmore(1), zforce(1), gzexe(1), zip(1), unzip(1), compress(1)
 avoid a conflict with the symbol set for invocation of the program.
 .SH "SEE ALSO"
 znew(1), zcmp(1), zmore(1), zforce(1), gzexe(1), zip(1), unzip(1), compress(1)


@@ -392,7 +414,7 @@ Internet RFC 1951 (May 1996).
 Exit status is normally 0;
 if an error occurs, exit status is 1. If a warning occurs, exit status is 2.
 .TP
 Exit status is normally 0;
 if an error occurs, exit status is 1. If a warning occurs, exit status is 2.
 .TP

-Usage: gzip [-cdfhlLnNrtvV19] [-S suffix] [file ...]
+Usage: gzip [-cdfhklLnNrtvV19] [-S suffix] [file ...]

 Invalid options were specified on the command line.
 .TP
 \fIfile\fP\^: not in gzip format
 Invalid options were specified on the command line.
 .TP
 \fIfile\fP\^: not in gzip format


@@ -415,7 +437,7 @@ than the decompress code on this machine.
 Recompress the file with gzip, which compresses better and uses
 less memory.
 .TP
 Recompress the file with gzip, which compresses better and uses
 less memory.
 .TP

-\fIfile\fP\^: already has .gz suffix -- no change
+\fIfile\fP\^: already has .gz suffix -- unchanged

 The file is assumed to be already compressed.
 Rename the file and try again.
 .TP
 The file is assumed to be already compressed.
 Rename the file and try again.
 .TP


@@ -451,17 +473,8 @@ read and the whole block is passed to
 for decompression,
 .I gunzip
 detects that there is extra trailing garbage after the compressed data
 for decompression,
 .I gunzip
 detects that there is extra trailing garbage after the compressed data

-and emits a warning by default. You have to use the --quiet option to
-suppress the warning. This option can be set in the
-.B GZIP
-environment variable as in:
-  for sh:  GZIP="-q"  tar -xfz --block-compress /dev/rst0
-  for csh: (setenv GZIP -q; tar -xfz --block-compr /dev/rst0
-
-In the above example, gzip is invoked implicitly by the -z option of
-GNU tar. Make sure that the same block size (-b option of tar) is used
-for reading and writing compressed data on tapes.  (This example
-assumes you are using the GNU version of tar.)
+and emits a warning by default.  You can use the --quiet option to
+suppress the warning.

 .SH BUGS
 The gzip format represents the input size modulo 2^32, so the
 --list option reports incorrect uncompressed sizes and compression
 .SH BUGS
 The gzip format represents the input size modulo 2^32, so the
 --list option reports incorrect uncompressed sizes and compression


@@ -480,7 +493,8 @@ the default compression level (-6). On some highly redundant files,
 compresses better than
 .IR gzip .
 .SH "COPYRIGHT NOTICE"
 compresses better than
 .IR gzip .
 .SH "COPYRIGHT NOTICE"

-Copyright \(co 1998, 1999, 2001, 2002, 2012 Free Software Foundation, Inc.
+Copyright \(co 1998-1999, 2001-2002, 2012, 2015-2016 Free Software Foundation,
+Inc.

 .br
 Copyright \(co 1992, 1993 Jean-loup Gailly
 .PP
 .br
 Copyright \(co 1992, 1993 Jean-loup Gailly
 .PP