1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
|
Description: Fix mandoc warnings and apply minor editoral changes.
Fixes warnings from 'mandoc -T lint compress.1'. Assumes that the
uncompress-real.patch has been applied first.
Author: Kenneth J. Pronovici <pronovic@debian.org>
Author: Bjarni Ingi Gislason <bjarniig@simnet.is>
Bug-Debian: http://bugs.debian.org/1071482
Index: ncompress/compress.1
===================================================================
--- ncompress.orig/compress.1
+++ ncompress/compress.1
@@ -1,4 +1,4 @@
-.TH COMPRESS 1 local
+.TH COMPRESS 1 2024-05-21 ncompress
.SH NAME
compress, uncompress.real \- compress and expand data
.SH SYNOPSIS
@@ -43,11 +43,10 @@ compress, uncompress.real \- compress an
.I "name \&..."
]
.SH DESCRIPTION
-.PP
Note that the program that would normally be installed as
.I uncompress
is installed for Debian as
-.I uncompress.real.
+.IR uncompress.real .
This has been done to avoid conflicting with the more-commonly-used
program with the same name that is part of the gzip package.
.PP
@@ -61,8 +60,8 @@ If no files are specified, the standard
standard output.
.I Compress
will only attempt to compress regular files.
-In particular, it will ignore symbolic links. If a file has multiple
-hard links,
+In particular, it will ignore symbolic links.
+If a file has multiple hard links,
.I compress
will refuse to compress it unless the
.B \-f
@@ -76,14 +75,14 @@ is run in the foreground,
the user is prompted as to whether an existing file should be overwritten.
.PP
Compressed files can be restored to their original form using
-.I uncompress.real.
+.IR uncompress.real .
.PP
.I uncompress.real
takes a list of files on its command line and replaces each
file whose name ends with
.B "\&.Z"
and which begins with the correct magic number with an uncompressed
-file without the
+file without the
.B "\&.Z."
The uncompressed file will have the mode, ownership and
timestamps of the compressed file.
@@ -102,10 +101,10 @@ write to the standard output; no files a
.PP
If the
.B \-r
-flag is specified,
+flag is specified,
.I compress
-will operate recursively. If any of the file names specified on the command
-line are directories,
+will operate recursively.
+If any of the file names specified on the command line are directories,
.I compress
will descend into the directory and compress all the files it finds there.
When compressing, any files already compressed will be ignored, and when
@@ -120,9 +119,9 @@ stderr before doing any compression or u
.I Compress
uses the modified Lempel\-Ziv algorithm popularized in
"A Technique for High Performance Data Compression",
-Terry A. Welch,
+Terry A.\& Welch,
.I "IEEE Computer,"
-vol. 17, no. 6 (June 1984), pp. 8\-19.
+vol.\& 17, no.\& 6 (June 1984), pp.\& 8\(en19.
Common substrings in the file are first replaced by 9\-bit codes 257 and up.
When code 512 is reached, the algorithm switches to 10\-bit codes and
continues to use more bits until the
@@ -149,13 +148,13 @@ the algorithm to adapt to the next "bloc
Note that the
.B \-b
flag is omitted for
-.I uncompress.real,
-since the
+.IR uncompress.real ,
+since the
.I bits
parameter specified during compression
is encoded within the output, along with
a magic number to ensure that neither decompression of random data nor
-recompression of compressed data is attempted.
+recompression of compressed data is attempted.
.PP
.ne 8
The amount of compression obtained depends on the size of the
@@ -163,7 +162,7 @@ input, the number of
.I bits
per code, and the distribution of common substrings.
Typically, text such as source code or English
-is reduced by 50\-60%.
+is reduced by 50\(en60%.
Compression is generally much better than that achieved by
Huffman coding (as used in
.IR pack ),
@@ -192,7 +191,7 @@ Invalid options were specified on the co
Missing maxbits
.in +8
Maxbits must follow
-.BR \-b \.
+.BR \-b .
.in -8
.IR file :
not in compressed format
@@ -202,19 +201,19 @@ The file specified to
has not been compressed.
.in -8
.IR file :
-compressed with
+compressed with
.I xx
-bits, can only handle
+bits, can only handle
.I yy
bits
.in +8
.I File
was compressed by a program that could deal with
-more
+more
.I bits
than the compress code on this machine.
Recompress the file with smaller
-.IR bits \.
+.IR bits .
.in -8
.IR file :
already has .Z suffix \-\- no change
@@ -240,26 +239,27 @@ uncompress.real: corrupt input
A SIGSEGV violation was detected which usually means that the input file has
been corrupted.
.in -8
-Compression:
+Compression:
.I "xx.xx%"
.in +8
Percentage of the input saved by compression.
(Relevant only for
-.BR \-v \.)
+.BR \-v .)
.in -8
\-\- not a regular file or directory: ignored
.in +8
When the input file is not a regular file or directory,
-(e.g. a symbolic link, socket, FIFO, device file), it is
+(e.g.\& a symbolic link, socket, FIFO, device file), it is
left unaltered.
.in -8
\-\- has
-.I xx
+.I xx
other links: unchanged
.in +8
The input file has links; it is left unchanged. See
.IR ln "(1)"
-for more information. Use the
+for more information.
+Use the
.B \-f
flag to force compression of multiply\-linked files.
.in -8
@@ -270,9 +270,9 @@ compression. The input remains virgin.
.in -8
.SH "BUGS"
Although compressed files are compatible between machines with large memory,
-.BR \-b \12
-should be used for file transfer to architectures with
-a small process data space (64KB or less, as exhibited by the DEC PDP
+.BR \-b 12
+should be used for file transfer to architectures with
+a small process data space (64\~KiB or less, as exhibited by the DEC PDP
series, the Intel 80286, etc.)
.SH "SEE ALSO"
.BR pack (1),
|