Print this page
12284 errors in compress(1) and pack(1) man pages
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/man/man1/compress.1
+++ new/usr/src/man/man1/compress.1
1 1 .\"
2 2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
3 3 .\" permission to reproduce portions of its copyrighted documentation.
4 4 .\" Original documentation from The Open Group can be obtained online at
5 5 .\" http://www.opengroup.org/bookstore/.
6 6 .\"
7 7 .\" The Institute of Electrical and Electronics Engineers and The Open
8 8 .\" Group, have given us permission to reprint portions of their
9 9 .\" documentation.
10 10 .\"
11 11 .\" In the following statement, the phrase ``this text'' refers to portions
12 12 .\" of the system documentation.
13 13 .\"
14 14 .\" Portions of this text are reprinted and reproduced in electronic form
15 15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
16 16 .\" Standard for Information Technology -- Portable Operating System
17 17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
18 18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
19 19 .\" Engineers, Inc and The Open Group. In the event of any discrepancy
20 20 .\" between these versions and the original IEEE and The Open Group
21 21 .\" Standard, the original IEEE and The Open Group Standard is the referee
22 22 .\" document. The original Standard can be obtained online at
23 23 .\" http://www.opengroup.org/unix/online.html.
24 24 .\"
25 25 .\" This notice shall appear on any product containing this material.
26 26 .\"
27 27 .\" The contents of this file are subject to the terms of the
28 28 .\" Common Development and Distribution License (the "License").
29 29 .\" You may not use this file except in compliance with the License.
30 30 .\"
31 31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
32 32 .\" or http://www.opensolaris.org/os/licensing.
33 33 .\" See the License for the specific language governing permissions
34 34 .\" and limitations under the License.
35 35 .\"
36 36 .\" When distributing Covered Code, include this CDDL HEADER in each
|
↓ open down ↓ |
36 lines elided |
↑ open up ↑ |
37 37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
38 38 .\" If applicable, add the following below this CDDL HEADER, with the
39 39 .\" fields enclosed by brackets "[]" replaced with your own identifying
40 40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
41 41 .\"
42 42 .\"
43 43 .\" Copyright 1989 AT&T
44 44 .\" Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved
45 45 .\" Copyright (c) 2008 Sun Microsystems, Inc. All Rights Reserved
46 46 .\"
47 -.TH COMPRESS 1 "Mar 13, 2008"
47 +.TH COMPRESS 1 "Feb 5, 2020"
48 48 .SH NAME
49 49 compress, uncompress, zcat \- compress, uncompress files or display expanded
50 50 files
51 51 .SH SYNOPSIS
52 -.LP
53 52 .nf
54 53 \fBcompress\fR [\fB-fv/\fR] [\fB-b\fR \fIbits\fR] [\fIfile\fR]...
55 54 .fi
56 55
57 56 .LP
58 57 .nf
59 58 \fBcompress\fR \fB-c\fR [\fB-fv\fR] [\fB-b\fR \fIbits\fR] [\fIfile\fR]
60 59 .fi
61 60
62 61 .LP
63 62 .nf
|
↓ open down ↓ |
1 lines elided |
↑ open up ↑ |
64 63 \fBuncompress\fR [\fB-fv\fR] [\fB-c | -/\fR] [\fIfile\fR]...
65 64 .fi
66 65
67 66 .LP
68 67 .nf
69 68 \fBzcat\fR [\fIfile\fR]...
70 69 .fi
71 70
72 71 .SH DESCRIPTION
73 72 .SS "compress"
74 -.sp
75 -.LP
76 73 The \fBcompress\fR utility attempts to reduce the size of the named files by
77 74 using adaptive Lempel-Ziv coding. Except when the output is to the standard
78 75 output, each file is replaced by one with the extension \fB\&.Z\fR, while
79 76 keeping the same ownership modes, change times and modification times, ACLs,
80 -and extended attributes. The compress utility also attempt to set the owner and
81 -group of \fIfile\fR\fB\&.z\fR to the owner and group of file, but does not fail
77 +and extended attributes. The compress utility also attempts to set the owner and
78 +group of \fIfile\fR\fB\&.Z\fR to the owner and group of file, but does not fail
82 79 if this cannot be done. If appending the \fB\&.Z\fR to the file pathname would
83 80 make the pathname exceed \fB1023\fR bytes, the command fails. If no files are
84 81 specified, the standard input is compressed to the standard output.
85 82 .sp
86 83 .LP
87 84 The amount of compression obtained depends on the size of the input, the number
88 85 of \fIbits\fR per code, and the distribution of common substrings. Typically,
89 86 text such as source code or English is reduced by 50\(mi60%. Compression is
90 87 generally much better than that achieved by Huffman coding (as used in
91 88 \fBpack\fR(1)) and it takes less time to compute. The \fIbits\fR parameter
92 89 specified during compression is encoded within the compressed file, along with
93 90 a magic number to ensure that neither decompression of random data nor
94 91 recompression of compressed data is subsequently allowed.
95 92 .SS "uncompress"
96 -.sp
97 -.LP
98 93 The \fBuncompress\fR utility restores files to their original state after they
99 94 have been compressed using the \fBcompress\fR utility. If no files are
100 95 specified, the standard input is uncompressed to the standard output.
101 96 .sp
102 97 .LP
103 98 This utility supports the uncompressing of any files produced by
104 99 \fBcompress\fR. For files produced by \fBcompress\fR on other systems,
105 100 \fBuncompress\fR supports 9- to 16-bit compression (see \fB-b\fR).
106 101 .SS "zcat"
107 -.sp
108 -.LP
109 102 The \fBzcat\fR utility writes to standard output the uncompressed form of files
110 103 that have been compressed using \fBcompress\fR. It is the equivalent of
111 -\fBuncompress\fR\fB-c\fR. Input files are not affected.
104 +\fBuncompress\fR \fB-c\fR. Input files are not affected.
112 105 .SH OPTIONS
113 -.sp
114 -.LP
115 106 The following options are supported:
116 107 .sp
117 108 .ne 2
118 109 .na
119 110 \fB\fB-b\fR \fIbits\fR\fR
120 111 .ad
121 112 .RS 11n
122 113 Sets the upper limit (in bits) for common substring codes. \fIbits\fR must be
123 114 between 9 and 16 (16 is the default). Lowering the number of bits result in
124 115 larger, less compressed files.
125 116 .RE
126 117
127 118 .sp
128 119 .ne 2
129 120 .na
130 121 \fB\fB-c\fR\fR
131 122 .ad
132 123 .RS 11n
133 124 Writes to the standard output; no files are changed and no \fB\&.Z\fR files are
134 125 created. The behavior of \fBzcat\fR is identical to that of `\fBuncompress\fR
135 126 \fB-c\fR'.
136 127 .RE
137 128
138 129 .sp
139 130 .ne 2
140 131 .na
141 132 \fB\fB-f\fR\fR
142 133 .ad
143 134 .RS 11n
144 135 When compressing, forces compression of \fIfile\fR, even if it does not
145 136 actually reduce the size of the file, or if the corresponding
146 137 \fIfile\fR\fB\&.Z\fR file already exists.
147 138 .sp
148 139 If the \fB-f\fR option is not specified, and the process is not running in the
149 140 background, prompts to verify whether an existing file should be overwritten.
150 141 If the response is affirmative, the existing file is overwritten. When
151 142 uncompressing, does not prompt for overwriting files. If the \fB-f\fR option is
152 143 not specified, and the process is not running in the background, prompts to
153 144 verify whether an existing file should be overwritten. If the standard input is
154 145 not a terminal and \fB-f\fR is not specified, writes a diagnostic message to
155 146 standard error and exits with a status greater than \fB0\fR.
156 147 .RE
157 148
158 149 .sp
159 150 .ne 2
160 151 .na
161 152 \fB\fB-v\fR\fR
162 153 .ad
163 154 .RS 11n
164 155 Verbose. Writes to standard error messages concerning the percentage reduction
165 156 or expansion of each file.
166 157 .RE
167 158
168 159 .sp
169 160 .ne 2
170 161 .na
171 162 \fB\fB-/\fR\fR
172 163 .ad
173 164 .RS 11n
|
↓ open down ↓ |
49 lines elided |
↑ open up ↑ |
174 165 When compressing or decompressing, copies any extended system attributes
175 166 associated with the source file to the target file and copies any extended
176 167 system attributes associated with extended attributes of the source file to the
177 168 corresponding extended attributes associated with the target file. If any
178 169 extended system attributes cannot be copied, the original file is retained, a
179 170 diagnostic is written to \fBstderr\fR, and the final exit status is
180 171 \fBnon-zero\fR.
181 172 .RE
182 173
183 174 .SH OPERANDS
184 -.sp
185 -.LP
186 175 The following operand is supported:
187 176 .sp
188 177 .ne 2
189 178 .na
190 179 \fB\fIfile\fR\fR
191 180 .ad
192 181 .RS 8n
193 182 A path name of a file to be compressed by \fBcompress\fR, uncompressed by
194 183 \fBuncompress\fR, or whose uncompressed form is written to standard out by
195 184 \fBzcat\fR. If \fIfile\fR is \fB\(mi\fR, or if no \fIfile\fR is specified, the
196 185 standard input is used.
197 186 .RE
198 187
199 188 .SH USAGE
200 -.sp
201 -.LP
202 189 See \fBlargefile\fR(5) for the description of the behavior of \fBcompress\fR,
203 190 \fBuncompress\fR, and \fBzcat\fR when encountering files greater than or equal
204 -to 2 Gbyte ( 2^31 bytes).
191 +to 2 Gbyte (2^31 bytes).
205 192 .SH ENVIRONMENT VARIABLES
206 -.sp
207 -.LP
208 193 See \fBenviron\fR(5) for descriptions of the following environment variables
209 194 that affect the execution of \fBcompress\fR, \fBuncompress\fR, and \fBzcat\fR:
210 195 \fBLANG\fR, \fBLC_ALL\fR, \fBLC_COLLATE\fR, \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR,
211 196 and \fBNLSPATH\fR.
212 197 .sp
213 198 .LP
214 199 Affirmative responses are processed using the extended regular expression
215 200 defined for the \fByesexpr\fR keyword in the \fBLC_MESSAGES\fR category of the
216 201 user's locale. The locale specified in the \fBLC_COLLATE\fR category defines
217 202 the behavior of ranges, equivalence classes, and multi-character collating
218 203 elements used in the expression defined for \fByesexpr\fR. The locale specified
219 204 in \fBLC_CTYPE\fR determines the locale for interpretation of sequences of
220 205 bytes of text data a characters, the behavior of character classes used in the
221 206 expression defined for the \fByesexpr\fR. See \fBlocale\fR(5).
222 207 .SH EXIT STATUS
223 -.sp
224 -.LP
225 208 The following error values are returned:
226 209 .sp
227 210 .ne 2
228 211 .na
229 212 \fB\fB0\fR\fR
230 213 .ad
231 214 .RS 6n
232 215 Successful completion.
233 216 .RE
234 217
235 218 .sp
236 219 .ne 2
237 220 .na
238 221 \fB\fB1\fR\fR
239 222 .ad
240 223 .RS 6n
241 224 An error occurred.
242 225 .RE
243 226
244 227 .sp
245 228 .ne 2
246 229 .na
247 230 \fB\fB2\fR\fR
248 231 .ad
249 232 .RS 6n
250 233 One or more files were not compressed because they would have increased in size
251 234 (and the \fB-f\fR option was not specified).
252 235 .RE
253 236
|
↓ open down ↓ |
19 lines elided |
↑ open up ↑ |
254 237 .sp
255 238 .ne 2
256 239 .na
257 240 \fB\fB>2\fR\fR
258 241 .ad
259 242 .RS 6n
260 243 An error occurred.
261 244 .RE
262 245
263 246 .SH ATTRIBUTES
264 -.sp
265 -.LP
266 247 See \fBattributes\fR(5) for descriptions of the following attributes:
267 248 .sp
268 249
269 250 .sp
270 251 .TS
271 252 box;
272 253 c | c
273 254 l | l .
274 255 ATTRIBUTE TYPE ATTRIBUTE VALUE
275 256 _
276 257 CSI Enabled
277 258 _
278 259 Interface Stability Committed
279 260 _
280 261 Standard See \fBstandards\fR(5).
281 262 .TE
282 263
283 264 .SH SEE ALSO
284 -.sp
285 -.LP
286 265 \fBln\fR(1), \fBpack\fR(1), \fBfgetattr\fR(3C), \fBfsetattr\fR(3C),
287 266 \fBattributes\fR(5), \fBenviron\fR(5), \fBlargefile\fR(5), \fBlocale\fR(5),
288 267 \fBstandards\fR(5)
289 268 .SH DIAGNOSTICS
290 -.sp
291 269 .ne 2
292 270 .na
293 -\fBUsage: \fBcompress [-fv/] [-b\fR \fIbits\fR] [\fIfile\fR\|.\|.\|. ]\fR
271 +\fBUsage: \fBcompress [-fv/] [-b\fR \fImaxbits\fR\fB]\fR [\fIfile\fR\|.\|.\|. ]\fR
294 272 .ad
295 273 .br
296 274 .na
297 -\fB\fBcompress c [-fv] [-b\fR \fIbits\fR] [\fIfile\fR\|.\|.\|. ]\fR
275 +\fB\fBcompress c [-fv] [-b\fR \fImaxbits\fR\fB]\fR [\fIfile\fR]\fR
298 276 .ad
299 277 .sp .6
300 278 .RS 4n
301 279 Invalid options were specified on the command line.
302 280 .RE
303 281
304 282 .sp
305 283 .ne 2
306 284 .na
307 285 \fBUsage: \fBuncompress [-fv] [-c | -/] [\fR\fIfile\fR\fB]...\fR\fR
308 286 .ad
309 287 .sp .6
310 288 .RS 4n
311 289 Invalid options were specified on the command line.
312 290 .RE
313 291
314 292 .sp
315 293 .ne 2
316 294 .na
317 295 \fBMissing maxbits\fR
318 296 .ad
319 297 .sp .6
320 298 .RS 4n
321 299 Maxbits must follow \fB-b\fR, or invalid maxbits, not a numeric value.
322 300 .RE
323 301
324 302 .sp
325 303 .ne 2
326 304 .na
327 305 \fB\fIfile\fR: not in compressed format\fR
328 306 .ad
329 307 .sp .6
330 308 .RS 4n
331 309 The file specified to \fBuncompress\fR has not been compressed.
332 310 .RE
333 311
334 312 .sp
335 313 .ne 2
336 314 .na
337 315 \fB\fIfile\fR: compressed with \fIxx\fRbits, can only handle \fIyy\fRbits\fR
338 316 .ad
339 317 .sp .6
340 318 .RS 4n
341 319 \fBfile\fR was compressed by a program that could deal with more \fIbits\fR
342 320 than the compress code on this machine. Recompress the file with smaller
343 321 \fIbits\fR.
344 322 .RE
345 323
346 324 .sp
347 325 .ne 2
348 326 .na
|
↓ open down ↓ |
41 lines elided |
↑ open up ↑ |
349 327 \fB\fIfile\fR: already has .\|Z suffix -- no change\fR
350 328 .ad
351 329 .sp .6
352 330 .RS 4n
353 331 The file is assumed to be already compressed. Rename the file and try again.
354 332 .RE
355 333
356 334 .sp
357 335 .ne 2
358 336 .na
359 -\fB\fIfile\fR: already exists; do you wish to overwrite (y or n)?\fR
337 +\fB\fIfile\fR already exists; do you wish to overwrite (yes or no)?\fR
360 338 .ad
361 339 .sp .6
362 340 .RS 4n
363 341 Respond \fBy\fR if you want the output file to be replaced; \fBn\fR if not.
364 342 .RE
365 343
366 344 .sp
367 345 .ne 2
368 346 .na
369 347 \fBuncompress: corrupt input\fR
370 348 .ad
371 349 .sp .6
372 350 .RS 4n
373 351 A \fBSIGSEGV\fR violation was detected, which usually means that the input file
374 352 is corrupted.
375 353 .RE
376 354
377 355 .sp
378 356 .ne 2
379 357 .na
380 358 \fBCompression:\fIxx.xx\fR\fB%\fR\fR
381 359 .ad
382 360 .sp .6
383 361 .RS 4n
384 362 Percentage of the input saved by compression. (Relevant only for \fB-v\fR.)
385 363 .RE
386 364
387 365 .sp
388 366 .ne 2
389 367 .na
390 368 \fB- - not a regular file: unchanged\fR
391 369 .ad
392 370 .sp .6
393 371 .RS 4n
394 372 When the input file is not a regular file, (such as a directory), it is left
395 373 unaltered.
396 374 .RE
397 375
398 376 .sp
399 377 .ne 2
400 378 .na
401 379 \fB- - has \fIxx\fR other links: unchanged\fR
402 380 .ad
403 381 .sp .6
404 382 .RS 4n
405 383 The input file has links; it is left unchanged. See \fBln\fR(1) for more
406 384 information.
407 385 .RE
408 386
409 387 .sp
410 388 .ne 2
411 389 .na
412 390 \fB- - file unchanged\fR
413 391 .ad
414 392 .sp .6
415 393 .RS 4n
416 394 No savings are achieved by compression. The input remains uncompressed.
417 395 .RE
418 396
419 397 .sp
420 398 .ne 2
421 399 .na
422 400 \fB- -filename too long to tack on .Z\fR
423 401 .ad
424 402 .sp .6
425 403 .RS 4n
426 404 The path name is too long to append the \fB\&.Z\fR suffix.
427 405 .RE
428 406
429 407 .sp
|
↓ open down ↓ |
60 lines elided |
↑ open up ↑ |
430 408 .ne 2
431 409 .na
432 410 \fB- -cannot preserve extended attributes. file unchanged\fR
433 411 .ad
434 412 .sp .6
435 413 .RS 4n
436 414 Extended system attributes could not be copied.
437 415 .RE
438 416
439 417 .SH NOTES
440 -.sp
441 -.LP
442 418 Although compressed files are compatible between machines with large memory,
443 419 \fB-b\fR 12 should be used for file transfer to architectures with a small
444 420 process data space (64KB or less).
445 421 .sp
446 422 .LP
447 423 \fBcompress\fR should be more flexible about the existence of the \fB\&.\|Z\fR
448 424 suffix.
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX