[PATCH 1/5] doc: bring up to date and fix troff typos

[Paul Eggert]

* doc/gzip.texi (Overview): Update RFC URLs.
* gzip.1: Likewise.  Don't say "SEE ALSO" to programs that almost
nobody has installed anymore.
* gzip.1, zmore.1: Fix some troff typos.
* zdiff.1: Clarify what happens with input files.  Don't talk
about temporary file names, as they're rarely used these days.
---
 doc/gzip.texi |  4 ++--
 gzip.1        | 51 +++++++++++++++++++++------------------------------
 zdiff.1       | 10 ++++++----
 zmore.1       | 11 ++++++-----
 4 files changed, 35 insertions(+), 41 deletions(-)

diff --git a/doc/gzip.texi b/doc/gzip.texi
index 8220960..106ecdb 100644
--- a/doc/gzip.texi
+++ b/doc/gzip.texi
@@ -171,10 +171,10 @@ ownership and time stamps of files when compressing or 
decompressing.
 
 The @command{gzip} file format is specified in P. Deutsch, @sc{gzip} file
 format specification version 4.3,
address@hidden://ftp.isi.edu/in-notes/rfc1952.txt, Internet @abbr{RFC} 1952} 
(May
address@hidden://www.ietf.org/rfc/rfc1952.txt, Internet @abbr{RFC} 1952} (May
 1996).  The @command{zip} deflation format is specified in P. Deutsch,
 @sc{deflate} Compressed Data Format Specification version 1.3,
address@hidden://ftp.isi.edu/in-notes/rfc1951.txt, Internet @abbr{RFC} 1951} 
(May
address@hidden://www.ietf.org/rfc/rfc1951.txt, Internet @abbr{RFC} 1951} (May
 1996).
 
 @node Sample
diff --git a/gzip.1 b/gzip.1
index 8db327d..c97aeb1 100644
--- a/gzip.1
+++ b/gzip.1
@@ -28,7 +28,7 @@ gzip, gunzip, zcat \- compress or expand files
 reduces the size of the named files using Lempel-Ziv coding (LZ77).
 Whenever possible,
 each file is replaced by one with the extension
-.B "\&.gz,"
+.BR "\&.gz" ,
 while keeping the same ownership modes, access and modification times.
 (The default extension is
 .B "\-gz"
@@ -65,7 +65,7 @@ Compressed files can be restored to their original form using
 or
 .I gunzip
 or
-.I zcat.
+.IR zcat .
 If the original name saved in the compressed file is not suitable for its
 file system, a new name is constructed from the original one to make it
 legal.
@@ -95,14 +95,19 @@ extension.
 .PP
 .I gunzip
 can currently decompress files created by
-.I gzip, zip, compress, compress -H
+.IR gzip ,
+.IR zip ,
+.IR compress ,
+.I "compress -H"
 or
-.I pack.
+.IR pack .
 The detection of the input format is automatic.  When using
 the first two formats,
 .I gunzip
 checks a 32 bit CRC. For
-.I pack, gunzip
+.I pack
+and
+.I gunzip
 checks the uncompressed length. The standard
 .I compress
 format was not designed to allow consistency checks. However
@@ -131,18 +136,18 @@ To extract zip files
 with several members, use
 .I unzip
 instead of
-.I gunzip.
+.IR gunzip .
 .PP
 .I zcat
 is identical to
 .I gunzip
-.B \-c.
+.BR \-c .
 (On some systems,
 .I zcat
 may be installed as
 .I gzcat
 to preserve the original link to
-.I compress.)
+.IR compress .)
 .I zcat
 uncompresses either a list of files on the command line or its
 standard input and writes the uncompressed data on standard output.
@@ -176,17 +181,6 @@ number of used disk blocks almost never increases.
 .I gzip
 preserves the mode, ownership and timestamps of files when compressing
 or decompressing.
-.PP
-The
-.I gzip
-file format is specified in P. Deutsch, \s-1GZIP\s0 file format
-specification version 4.3, <ftp://ftp.isi.edu/in-notes/rfc1952.txt>,
-Internet RFC 1952 (May 1996).  The
-.I zip
-deflation format is specified in P. Deutsch, \s-1DEFLATE\s0 Compressed
-Data Format Specification version 1.3,
-<ftp://ftp.isi.edu/in-notes/rfc1951.txt>, Internet RFC 1951 (May 1996).
-
 .SH OPTIONS
 .TP
 .B \-a --ascii
@@ -208,12 +202,12 @@ Force compression or decompression even if the file has 
multiple links
 or the corresponding file already exists, or if the compressed data
 is read from or written to a terminal. If the input data is not in
 a format recognized by
-.I gzip,
+.IR gzip ,
 and if the option --stdout is also given, copy the input data without change
 to the standard output: let
 .I zcat
 behave as
-.I cat.
+.IR cat .
 If
 .B \-f
 is not given,
@@ -298,8 +292,6 @@ are transferred to other systems.
 
 When decompressing, add .suf to the beginning of the list of
 suffixes to try, when deriving an output file name from an input file name.
-
-.IR pack "(1)".
 .TP
 .B \-t --test
 Test. Check the compressed file integrity.
@@ -372,7 +364,7 @@ replacement.
 The environment variable
 .B GZIP
 can hold a set of default options for
-.I gzip.
+.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
@@ -382,20 +374,19 @@ explicit command line parameters. For example:
 On Vax/VMS, the name of the 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),
-pack(1), compact(1)
+znew(1), zcmp(1), zmore(1), zforce(1), gzexe(1), zip(1), unzip(1), compress(1)
 .PP
 The
 .I gzip
 file format is specified in P. Deutsch, \s-1GZIP\s0 file format
 specification version 4.3,
-.BR <ftp://ftp.isi.edu/in-notes/rfc1952.txt> ,
+.BR <http://www.ietf.org/rfc/rfc1952.txt> ,
 Internet RFC 1952 (May 1996).
 The
 .I zip
 deflation format is specified in P. Deutsch, \s-1DEFLATE\s0 Compressed
 Data Format Specification version 1.3,
-.BR <ftp://ftp.isi.edu/in-notes/rfc1951.txt> ,
+.BR <http://www.ietf.org/rfc/rfc1951.txt> ,
 Internet RFC 1951 (May 1996).
 .SH "DIAGNOSTICS"
 Exit status is normally 0;
@@ -487,9 +478,9 @@ In some rare cases, the --best option gives worse 
compression than
 the default compression level (-6). On some highly redundant files,
 .I compress
 compresses better than
-.I gzip.
+.IR gzip .
 .SH "COPYRIGHT NOTICE"
-Copyright \(co 1998, 1999, 2001, 2002 Free Software Foundation, Inc.
+Copyright \(co 1998, 1999, 2001, 2002, 2012 Free Software Foundation, Inc.
 .br
 Copyright \(co 1992, 1993 Jean-loup Gailly
 .PP
diff --git a/zdiff.1 b/zdiff.1
index 588974c..0c826c3 100644
--- a/zdiff.1
+++ b/zdiff.1
@@ -23,14 +23,15 @@ All options specified are passed directly to
 .I cmp
 or
 .IR diff "."
-If only 1 file is specified, then the files compared are
+If only
 .I file1
-and an uncompressed
+is specified, it is compared to the uncompressed contents of
 .IR file1 ".gz."
-If two files are specified, then they are uncompressed if necessary and fed to
+If two files are specified, their contents (uncompressed if necessary) are fed 
to
 .I cmp
 or
 .IR diff "."
+The input files are not modified.
 The exit status from
 .I cmp
 or
@@ -43,4 +44,5 @@ Messages from the
 .I cmp
 or
 .I diff
-programs refer to temporary filenames instead of those specified.
+programs may refer to file names such as "\-" instead of to the file
+names specified.
diff --git a/zmore.1 b/zmore.1
index c5be894..e2ff835 100644
--- a/zmore.1
+++ b/zmore.1
@@ -10,9 +10,10 @@ is a filter which allows examination of compressed or plain 
text files
 one screenful at a time on a soft-copy terminal.
 .I zmore
 works on files compressed with
-.I compress, pack
+.IR compress ,
+.I pack
 or
-.I gzip,
+.IR gzip ,
 and also on uncompressed files.
 If a file does not exist,
 .I zmore
@@ -33,9 +34,9 @@ and to determine the default window size.
 On a terminal capable of displaying 24 lines,
 the default window size is 22 lines.
 To use a pager other than the default
-.I more,
+.IR more ,
 set environment variable PAGER to the name of the desired program, such as
-.I less.
+.IR less .
 .PP
 Other sequences which may be typed when
 .I zmore
@@ -120,7 +121,7 @@ commands.
 If the standard output is not a teletype, then
 .I zmore
 acts just like
-.I zcat,
+.IR zcat ,
 except that a header is printed before each file
 if there is more than one file.
 .SH FILES
-- 
1.7.11.7