summaryrefslogtreecommitdiffstats
path: root/man-pages-posix-2013/man1p/uncompress.1p
diff options
context:
space:
mode:
Diffstat (limited to 'man-pages-posix-2013/man1p/uncompress.1p')
-rw-r--r--man-pages-posix-2013/man1p/uncompress.1p186
1 files changed, 186 insertions, 0 deletions
diff --git a/man-pages-posix-2013/man1p/uncompress.1p b/man-pages-posix-2013/man1p/uncompress.1p
new file mode 100644
index 0000000..7ab1245
--- /dev/null
+++ b/man-pages-posix-2013/man1p/uncompress.1p
@@ -0,0 +1,186 @@
+'\" et
+.TH UNCOMPRESS "1P" 2013 "IEEE/The Open Group" "POSIX Programmer's Manual"
+.SH PROLOG
+This manual page is part of the POSIX Programmer's Manual.
+The Linux implementation of this interface may differ (consult
+the corresponding Linux manual page for details of Linux behavior),
+or the interface may not be implemented on Linux.
+
+.SH NAME
+uncompress
+\(em expand compressed data
+.SH SYNOPSIS
+.LP
+.nf
+uncompress \fB[\fR\(micfv\fB] [\fIfile\fR...\fB]\fR
+.fi
+.SH DESCRIPTION
+The
+.IR uncompress
+utility shall restore files to their original state after they have
+been compressed using the
+.IR compress
+utility. If no files are specified, the standard input shall be
+uncompressed to the standard output. If the invoking process has
+appropriate privileges, the ownership, modes, access time, and
+modification time of the original file shall be preserved.
+.P
+This utility shall support the uncompressing of any files produced by
+the
+.IR compress
+utility on the same implementation. For files produced by
+.IR compress
+on other systems,
+.IR uncompress
+supports 9 to 14-bit compression (see
+.IR "\fIcompress\fR\^",
+.BR \(mib );
+it is implementation-defined whether values of
+.BR \(mib
+greater than 14 are supported.
+.SH OPTIONS
+The
+.IR uncompress
+utility shall conform to the Base Definitions volume of POSIX.1\(hy2008,
+.IR "Section 12.2" ", " "Utility Syntax Guidelines",
+except that Guideline 1 does apply since the utility name has ten letters.
+.P
+The following options shall be supported:
+.IP "\fB\(mic\fP" 10
+Write to standard output; no files are changed.
+.IP "\fB\(mif\fP" 10
+Do not prompt for overwriting files. Except when run in the
+background, if
+.BR \(mif
+is not given the user shall be prompted as to whether an existing file
+should be overwritten. If the standard input is not a terminal and
+.BR \(mif
+is not given,
+.IR uncompress
+shall write a diagnostic message to standard error and exit with a
+status greater than zero.
+.IP "\fB\(miv\fP" 10
+Write messages to standard error concerning the expansion of each file.
+.SH OPERANDS
+The following operand shall be supported:
+.IP "\fIfile\fR" 10
+A pathname of a file. If
+.IR file
+already has the
+.BR .Z
+suffix specified, it shall be used as the input file and the output
+file shall be named
+.BR file
+with the
+.BR .Z
+suffix removed. Otherwise,
+.IR file
+shall be used as the name of the output file and
+.BR file
+with the
+.BR .Z
+suffix appended shall be used as the input file.
+.SH STDIN
+The standard input shall be used only if no
+.IR file
+operands are specified, or if a
+.IR file
+operand is
+.BR '\(mi' .
+.SH "INPUT FILES"
+Input files shall be in the format produced by the
+.IR compress
+utility.
+.SH "ENVIRONMENT VARIABLES"
+The following environment variables shall affect the execution of
+.IR uncompress :
+.IP "\fILANG\fP" 10
+Provide a default value for the internationalization variables that are
+unset or null. (See the Base Definitions volume of POSIX.1\(hy2008,
+.IR "Section 8.2" ", " "Internationalization Variables"
+for the precedence of internationalization variables used to determine
+the values of locale categories.)
+.IP "\fILC_ALL\fP" 10
+If set to a non-empty string value, override the values of all the
+other internationalization variables.
+.IP "\fILC_CTYPE\fP" 10
+Determine the locale for the interpretation of sequences of bytes of
+text data as characters (for example, single-byte as opposed to
+multi-byte characters in arguments).
+.IP "\fILC_MESSAGES\fP" 10
+.br
+Determine the locale that should be used to affect the format and
+contents of diagnostic messages written to standard error.
+.IP "\fINLSPATH\fP" 10
+Determine the location of message catalogs for the processing of
+.IR LC_MESSAGES .
+.SH "ASYNCHRONOUS EVENTS"
+Default.
+.SH STDOUT
+When there are no
+.IR file
+operands or the
+.BR \(mic
+option is specified, the uncompressed output is written to standard
+output.
+.SH STDERR
+Prompts shall be written to the standard error output under the
+conditions specified in the DESCRIPTION and OPTIONS sections. The
+prompts shall contain the
+.IR file
+pathname, but their format is otherwise unspecified. Otherwise, the
+standard error output shall be used only for diagnostic messages.
+.SH "OUTPUT FILES"
+Output files are the same as the respective input files to
+.IR compress .
+.SH "EXTENDED DESCRIPTION"
+None.
+.SH "EXIT STATUS"
+The following exit values shall be returned:
+.IP "\00" 6
+Successful completion.
+.IP >0 6
+An error occurred.
+.SH "CONSEQUENCES OF ERRORS"
+The input file remains unmodified.
+.LP
+.IR "The following sections are informative."
+.SH "APPLICATION USAGE"
+The limit of 14 on the
+.IR compress
+.BR \(mib
+.IR bits
+argument is to achieve portability to all systems (within the
+restrictions imposed by the lack of an explicit published file
+format). Some implementations based on 16-bit architectures cannot
+support 15 or 16-bit uncompression.
+.SH EXAMPLES
+None.
+.SH RATIONALE
+None.
+.SH "FUTURE DIRECTIONS"
+None.
+.SH "SEE ALSO"
+.IR "\fIcompress\fR\^",
+.IR "\fIzcat\fR\^"
+.P
+The Base Definitions volume of POSIX.1\(hy2008,
+.IR "Chapter 8" ", " "Environment Variables",
+.IR "Section 12.2" ", " "Utility Syntax Guidelines"
+.SH COPYRIGHT
+Portions of this text are reprinted and reproduced in electronic form
+from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
+-- Portable Operating System Interface (POSIX), The Open Group Base
+Specifications Issue 7, Copyright (C) 2013 by the Institute of
+Electrical and Electronics Engineers, Inc and The Open Group.
+(This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the
+event of any discrepancy between this version and the original IEEE and
+The Open Group Standard, the original IEEE and The Open Group Standard
+is the referee document. The original Standard can be obtained online at
+http://www.unix.org/online.html .
+
+Any typographical or formatting errors that appear
+in this page are most likely
+to have been introduced during the conversion of the source files to
+man page format. To report such errors, see
+https://www.kernel.org/doc/man-pages/reporting_bugs.html .