diff options
author | Peter Tribble <peter.tribble@gmail.com> | 2020-02-05 09:50:49 +0000 |
---|---|---|
committer | Peter Tribble <peter.tribble@gmail.com> | 2020-02-06 16:52:58 +0000 |
commit | 34173ec8d0147391124bee4bbc60ac00807c0377 (patch) | |
tree | 384d10715286f61b135aec10b31828da91e65402 /usr/src/man/man1 | |
parent | 5801b0f01c3c34499a929ed96164a5a68b470945 (diff) | |
download | illumos-joyent-34173ec8d0147391124bee4bbc60ac00807c0377.tar.gz |
12284 errors in compress(1) and pack(1) man pages
Reviewed by: Andy Fiddaman <omnios@citrus-it.co.uk>
Approved by: Dan McDonald <danmcd@joyent.com>
Diffstat (limited to 'usr/src/man/man1')
-rw-r--r-- | usr/src/man/man1/compress.1 | 40 | ||||
-rw-r--r-- | usr/src/man/man1/pack.1 | 30 |
2 files changed, 12 insertions, 58 deletions
diff --git a/usr/src/man/man1/compress.1 b/usr/src/man/man1/compress.1 index 40693a0408..e7a9f63519 100644 --- a/usr/src/man/man1/compress.1 +++ b/usr/src/man/man1/compress.1 @@ -44,12 +44,11 @@ .\" Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved .\" Copyright (c) 2008 Sun Microsystems, Inc. All Rights Reserved .\" -.TH COMPRESS 1 "Mar 13, 2008" +.TH COMPRESS 1 "Feb 5, 2020" .SH NAME compress, uncompress, zcat \- compress, uncompress files or display expanded files .SH SYNOPSIS -.LP .nf \fBcompress\fR [\fB-fv/\fR] [\fB-b\fR \fIbits\fR] [\fIfile\fR]... .fi @@ -71,14 +70,12 @@ files .SH DESCRIPTION .SS "compress" -.sp -.LP The \fBcompress\fR utility attempts to reduce the size of the named files by using adaptive Lempel-Ziv coding. Except when the output is to the standard output, each file is replaced by one with the extension \fB\&.Z\fR, while keeping the same ownership modes, change times and modification times, ACLs, -and extended attributes. The compress utility also attempt to set the owner and -group of \fIfile\fR\fB\&.z\fR to the owner and group of file, but does not fail +and extended attributes. The compress utility also attempts to set the owner and +group of \fIfile\fR\fB\&.Z\fR to the owner and group of file, but does not fail if this cannot be done. If appending the \fB\&.Z\fR to the file pathname would make the pathname exceed \fB1023\fR bytes, the command fails. If no files are specified, the standard input is compressed to the standard output. @@ -93,8 +90,6 @@ specified during compression is encoded within the compressed file, along with a magic number to ensure that neither decompression of random data nor recompression of compressed data is subsequently allowed. .SS "uncompress" -.sp -.LP The \fBuncompress\fR utility restores files to their original state after they have been compressed using the \fBcompress\fR utility. If no files are specified, the standard input is uncompressed to the standard output. @@ -104,14 +99,10 @@ This utility supports the uncompressing of any files produced by \fBcompress\fR. For files produced by \fBcompress\fR on other systems, \fBuncompress\fR supports 9- to 16-bit compression (see \fB-b\fR). .SS "zcat" -.sp -.LP The \fBzcat\fR utility writes to standard output the uncompressed form of files that have been compressed using \fBcompress\fR. It is the equivalent of -\fBuncompress\fR\fB-c\fR. Input files are not affected. +\fBuncompress\fR \fB-c\fR. Input files are not affected. .SH OPTIONS -.sp -.LP The following options are supported: .sp .ne 2 @@ -181,8 +172,6 @@ diagnostic is written to \fBstderr\fR, and the final exit status is .RE .SH OPERANDS -.sp -.LP The following operand is supported: .sp .ne 2 @@ -197,14 +186,10 @@ standard input is used. .RE .SH USAGE -.sp -.LP See \fBlargefile\fR(5) for the description of the behavior of \fBcompress\fR, \fBuncompress\fR, and \fBzcat\fR when encountering files greater than or equal -to 2 Gbyte ( 2^31 bytes). +to 2 Gbyte (2^31 bytes). .SH ENVIRONMENT VARIABLES -.sp -.LP See \fBenviron\fR(5) for descriptions of the following environment variables that affect the execution of \fBcompress\fR, \fBuncompress\fR, and \fBzcat\fR: \fBLANG\fR, \fBLC_ALL\fR, \fBLC_COLLATE\fR, \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, @@ -220,8 +205,6 @@ in \fBLC_CTYPE\fR determines the locale for interpretation of sequences of bytes of text data a characters, the behavior of character classes used in the expression defined for the \fByesexpr\fR. See \fBlocale\fR(5). .SH EXIT STATUS -.sp -.LP The following error values are returned: .sp .ne 2 @@ -261,8 +244,6 @@ An error occurred. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -281,20 +262,17 @@ Standard See \fBstandards\fR(5). .TE .SH SEE ALSO -.sp -.LP \fBln\fR(1), \fBpack\fR(1), \fBfgetattr\fR(3C), \fBfsetattr\fR(3C), \fBattributes\fR(5), \fBenviron\fR(5), \fBlargefile\fR(5), \fBlocale\fR(5), \fBstandards\fR(5) .SH DIAGNOSTICS -.sp .ne 2 .na -\fBUsage: \fBcompress [-fv/] [-b\fR \fIbits\fR] [\fIfile\fR\|.\|.\|. ]\fR +\fBUsage: \fBcompress [-fv/] [-b\fR \fImaxbits\fR\fB]\fR [\fIfile\fR\|.\|.\|. ]\fR .ad .br .na -\fB\fBcompress c [-fv] [-b\fR \fIbits\fR] [\fIfile\fR\|.\|.\|. ]\fR +\fB\fBcompress c [-fv] [-b\fR \fImaxbits\fR\fB]\fR [\fIfile\fR]\fR .ad .sp .6 .RS 4n @@ -356,7 +334,7 @@ The file is assumed to be already compressed. Rename the file and try again. .sp .ne 2 .na -\fB\fIfile\fR: already exists; do you wish to overwrite (y or n)?\fR +\fB\fIfile\fR already exists; do you wish to overwrite (yes or no)?\fR .ad .sp .6 .RS 4n @@ -437,8 +415,6 @@ Extended system attributes could not be copied. .RE .SH NOTES -.sp -.LP Although compressed files are compatible between machines with large memory, \fB-b\fR 12 should be used for file transfer to architectures with a small process data space (64KB or less). diff --git a/usr/src/man/man1/pack.1 b/usr/src/man/man1/pack.1 index 08e885a3dd..5dcb68a713 100644 --- a/usr/src/man/man1/pack.1 +++ b/usr/src/man/man1/pack.1 @@ -44,11 +44,10 @@ .\" Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved .\" Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved .\" -.TH PACK 1 "Mar 13, 2008" +.TH PACK 1 "Feb 5, 2020" .SH NAME pack, pcat, unpack \- compress and expand files .SH SYNOPSIS -.LP .nf \fBpack\fR [\fB-f/\fR] [\fB-\fR] \fIfile\fR... .fi @@ -65,8 +64,6 @@ pack, pcat, unpack \- compress and expand files .SH DESCRIPTION .SS "pack" -.sp -.LP The \fBpack\fR command attempts to store the specified files in a compressed form. Wherever possible (and useful), each input file \fBfile\fR is replaced by a packed file \fBfile\fR\fB\&.z\fR with the same access modes, access and @@ -155,10 +152,8 @@ an I/O error occurred during processing. .sp .LP The last segment of the file name must be short enough to allow space for the -appended \fB\&.z\fRextension. Directories cannot be compressed. +appended \fB\&.z\fR extension. Directories cannot be compressed. .SS "pcat" -.sp -.LP The \fBpcat\fR command does for packed files what \fBcat\fR(1) does for ordinary files, except that \fBpcat\fR cannot be used as a filter. The specified files are unpacked and written to the standard output. @@ -179,8 +174,6 @@ the file cannot be opened; the file does not appear to be the output of \fBpack\fR. .RE .SS "unpack" -.sp -.LP The \fBunpack\fR command expands files created by \fBpack\fR. For each \fBfile\fR specified in the command, a search is made for a file called \fBfile\fR\fB\&.z\fR (or just \fBfile\fR, if \fBfile\fR ends in \fB\&.z\fR). If @@ -206,8 +199,6 @@ a file with the unpacked name already exists; the unpacked file cannot be created. .RE .SH OPTIONS -.sp -.LP The following options are supported by \fBpack\fR: .sp .ne 2 @@ -237,8 +228,6 @@ message is written to \fBstderr\fR, and the final exit status is .RE .SH OPERANDS -.sp -.LP The following operands are supported: .sp .ne 2 @@ -264,13 +253,10 @@ place of \fBfile\fR causes the internal flag to be set and reset. .RE .SH USAGE -.sp -.LP See \fBlargefile\fR(5) for the description of the behavior of \fBpack\fR, \fBpcat\fR, and \fBunpack\fR when encountering files greater than or equal to 2 -Gbyte ( 2^31 bytes). +Gbyte (2^31 bytes). .SH EXAMPLES -.LP \fBExample 1 \fRViewing a Packed File .sp .LP @@ -289,7 +275,7 @@ or just: \fBexample%\fR \fBpcat\fR \fBfile\fR .LP -\fBExample 2 \fRMaking and Unpacked Copy: +\fBExample 2 \fRMaking an Unpacked Copy: .sp .LP To make an unpacked copy, say \fBnnn\fR, of a packed file named \fBfile.z\fR @@ -300,14 +286,10 @@ To make an unpacked copy, say \fBnnn\fR, of a packed file named \fBfile.z\fR \fBexample%\fR \fBpcat\fR \fBfile\fR \fB>nnn\fR .SH ENVIRONMENT VARIABLES -.sp -.LP See \fBenviron\fR(5) for descriptions of the following environment variables that affect the execution of \fBpack\fR, \fBpcat\fR, and \fBunpack\fR: \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, and \fBNLSPATH\fR. .SH EXIT STATUS -.sp -.LP The following exit values are returned: .sp .ne 2 @@ -330,8 +312,6 @@ returned. .RE .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -346,7 +326,5 @@ CSI Enabled .TE .SH SEE ALSO -.sp -.LP \fBcat\fR(1), \fBcompress\fR(1), \fBzcat\fR(1), \fBfgetattr\fR(3C), \fBfsetattr\fR(3C), \fBattributes\fR(5), \fBenviron\fR(5), \fBlargefile\fR(5) |