logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

uncompress.1p (5961B)


  1. '\" et
  2. .TH UNCOMPRESS "1P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
  3. .\"
  4. .SH PROLOG
  5. This manual page is part of the POSIX Programmer's Manual.
  6. The Linux implementation of this interface may differ (consult
  7. the corresponding Linux manual page for details of Linux behavior),
  8. or the interface may not be implemented on Linux.
  9. .\"
  10. .SH NAME
  11. uncompress
  12. \(em expand compressed data
  13. .SH SYNOPSIS
  14. .LP
  15. .nf
  16. uncompress \fB[\fR-cfv\fB] [\fIfile\fR...\fB]\fR
  17. .fi
  18. .SH DESCRIPTION
  19. The
  20. .IR uncompress
  21. utility shall restore files to their original state after they have
  22. been compressed using the
  23. .IR compress
  24. utility. If no files are specified, the standard input shall be
  25. uncompressed to the standard output. If the invoking process has
  26. appropriate privileges, the ownership, modes, access time, and
  27. modification time of the original file shall be preserved.
  28. .P
  29. This utility shall support the uncompressing of any files produced by
  30. the
  31. .IR compress
  32. utility on the same implementation. For files produced by
  33. .IR compress
  34. on other systems,
  35. .IR uncompress
  36. supports 9 to 14-bit compression (see
  37. .IR "\fIcompress\fR\^",
  38. .BR \-b );
  39. it is implementation-defined whether values of
  40. .BR \-b
  41. greater than 14 are supported.
  42. .SH OPTIONS
  43. The
  44. .IR uncompress
  45. utility shall conform to the Base Definitions volume of POSIX.1\(hy2017,
  46. .IR "Section 12.2" ", " "Utility Syntax Guidelines",
  47. except that Guideline 1 does apply since the utility name has ten letters.
  48. .P
  49. The following options shall be supported:
  50. .IP "\fB\-c\fP" 10
  51. Write to standard output; no files are changed.
  52. .IP "\fB\-f\fP" 10
  53. Do not prompt for overwriting files. Except when run in the
  54. background, if
  55. .BR \-f
  56. is not given the user shall be prompted as to whether an existing file
  57. should be overwritten. If the standard input is not a terminal and
  58. .BR \-f
  59. is not given,
  60. .IR uncompress
  61. shall write a diagnostic message to standard error and exit with a
  62. status greater than zero.
  63. .IP "\fB\-v\fP" 10
  64. Write messages to standard error concerning the expansion of each file.
  65. .SH OPERANDS
  66. The following operand shall be supported:
  67. .IP "\fIfile\fR" 10
  68. A pathname of a file. If
  69. .IR file
  70. already has the
  71. .BR .Z
  72. suffix specified, it shall be used as the input file and the output
  73. file shall be named
  74. .BR file
  75. with the
  76. .BR .Z
  77. suffix removed. Otherwise,
  78. .IR file
  79. shall be used as the name of the output file and
  80. .BR file
  81. with the
  82. .BR .Z
  83. suffix appended shall be used as the input file.
  84. .SH STDIN
  85. The standard input shall be used only if no
  86. .IR file
  87. operands are specified, or if a
  88. .IR file
  89. operand is
  90. .BR '\-' .
  91. .SH "INPUT FILES"
  92. Input files shall be in the format produced by the
  93. .IR compress
  94. utility.
  95. .SH "ENVIRONMENT VARIABLES"
  96. The following environment variables shall affect the execution of
  97. .IR uncompress :
  98. .IP "\fILANG\fP" 10
  99. Provide a default value for the internationalization variables that are
  100. unset or null. (See the Base Definitions volume of POSIX.1\(hy2017,
  101. .IR "Section 8.2" ", " "Internationalization Variables"
  102. for the precedence of internationalization variables used to determine
  103. the values of locale categories.)
  104. .IP "\fILC_ALL\fP" 10
  105. If set to a non-empty string value, override the values of all the
  106. other internationalization variables.
  107. .IP "\fILC_CTYPE\fP" 10
  108. Determine the locale for the interpretation of sequences of bytes of
  109. text data as characters (for example, single-byte as opposed to
  110. multi-byte characters in arguments).
  111. .IP "\fILC_MESSAGES\fP" 10
  112. .br
  113. Determine the locale that should be used to affect the format and
  114. contents of diagnostic messages written to standard error.
  115. .IP "\fINLSPATH\fP" 10
  116. Determine the location of message catalogs for the processing of
  117. .IR LC_MESSAGES .
  118. .SH "ASYNCHRONOUS EVENTS"
  119. Default.
  120. .SH STDOUT
  121. When there are no
  122. .IR file
  123. operands or the
  124. .BR \-c
  125. option is specified, the uncompressed output is written to standard
  126. output.
  127. .SH STDERR
  128. Prompts shall be written to the standard error output under the
  129. conditions specified in the DESCRIPTION and OPTIONS sections. The
  130. prompts shall contain the
  131. .IR file
  132. pathname, but their format is otherwise unspecified. Otherwise, the
  133. standard error output shall be used only for diagnostic messages.
  134. .SH "OUTPUT FILES"
  135. Output files are the same as the respective input files to
  136. .IR compress .
  137. .SH "EXTENDED DESCRIPTION"
  138. None.
  139. .SH "EXIT STATUS"
  140. The following exit values shall be returned:
  141. .IP "\00" 6
  142. Successful completion.
  143. .IP >0 6
  144. An error occurred.
  145. .SH "CONSEQUENCES OF ERRORS"
  146. The input file remains unmodified.
  147. .LP
  148. .IR "The following sections are informative."
  149. .SH "APPLICATION USAGE"
  150. The limit of 14 on the
  151. .IR compress
  152. .BR \-b
  153. .IR bits
  154. argument is to achieve portability to all systems (within the
  155. restrictions imposed by the lack of an explicit published file
  156. format). Some implementations based on 16-bit architectures cannot
  157. support 15 or 16-bit uncompression.
  158. .SH EXAMPLES
  159. None.
  160. .SH RATIONALE
  161. None.
  162. .SH "FUTURE DIRECTIONS"
  163. None.
  164. .SH "SEE ALSO"
  165. .IR "\fIcompress\fR\^",
  166. .IR "\fIzcat\fR\^"
  167. .P
  168. The Base Definitions volume of POSIX.1\(hy2017,
  169. .IR "Chapter 8" ", " "Environment Variables",
  170. .IR "Section 12.2" ", " "Utility Syntax Guidelines"
  171. .\"
  172. .SH COPYRIGHT
  173. Portions of this text are reprinted and reproduced in electronic form
  174. from IEEE Std 1003.1-2017, Standard for Information Technology
  175. -- Portable Operating System Interface (POSIX), The Open Group Base
  176. Specifications Issue 7, 2018 Edition,
  177. Copyright (C) 2018 by the Institute of
  178. Electrical and Electronics Engineers, Inc and The Open Group.
  179. In the event of any discrepancy between this version and the original IEEE and
  180. The Open Group Standard, the original IEEE and The Open Group Standard
  181. is the referee document. The original Standard can be obtained online at
  182. http://www.opengroup.org/unix/online.html .
  183. .PP
  184. Any typographical or formatting errors that appear
  185. in this page are most likely
  186. to have been introduced during the conversion of the source files to
  187. man page format. To report such errors, see
  188. https://www.kernel.org/doc/man-pages/reporting_bugs.html .