Blame man-pages-posix-2013-a/man1p/uudecode.1p

Packit 7cfc04
'\" et
Packit 7cfc04
.TH UUDECODE "1P" 2013 "IEEE/The Open Group" "POSIX Programmer's Manual"
Packit 7cfc04
.SH PROLOG
Packit 7cfc04
This manual page is part of the POSIX Programmer's Manual.
Packit 7cfc04
The Linux implementation of this interface may differ (consult
Packit 7cfc04
the corresponding Linux manual page for details of Linux behavior),
Packit 7cfc04
or the interface may not be implemented on Linux.
Packit 7cfc04
Packit 7cfc04
.SH NAME
Packit 7cfc04
uudecode
Packit 7cfc04
\(em decode a binary file
Packit 7cfc04
.SH SYNOPSIS
Packit 7cfc04
.LP
Packit 7cfc04
.nf
Packit 7cfc04
uudecode \fB[\fR\(mio \fIoutfile\fB] [\fIfile\fB]\fR
Packit 7cfc04
.fi
Packit 7cfc04
.SH DESCRIPTION
Packit 7cfc04
The
Packit 7cfc04
.IR uudecode
Packit 7cfc04
utility shall read a file, or standard input if no file is specified,
Packit 7cfc04
that includes data created by the
Packit 7cfc04
.IR uuencode
Packit 7cfc04
utility. The
Packit 7cfc04
.IR uudecode
Packit 7cfc04
utility shall scan the input file, searching for data compatible with
Packit 7cfc04
one of the formats specified in
Packit 7cfc04
.IR uuencode ,
Packit 7cfc04
and attempt to create or overwrite the file described by the data (or
Packit 7cfc04
overridden by the
Packit 7cfc04
.BR \(mio
Packit 7cfc04
option). The pathname shall be contained in the data or specified by
Packit 7cfc04
the
Packit 7cfc04
.BR \(mio
Packit 7cfc04
option. The file access permission bits and contents for the file to be
Packit 7cfc04
produced shall be contained in that data. The mode bits of the created
Packit 7cfc04
file (other than standard output) shall be set from the file access
Packit 7cfc04
permission bits contained in the data; that is, other attributes of the
Packit 7cfc04
mode, including the file mode creation mask (see
Packit 7cfc04
.IR umask ),
Packit 7cfc04
shall not affect the file being produced. If either of the
Packit 7cfc04
.IR op
Packit 7cfc04
characters
Packit 7cfc04
.BR '\(pl' 
Packit 7cfc04
and
Packit 7cfc04
.BR '\(mi' 
Packit 7cfc04
(see
Packit 7cfc04
.IR chmod )
Packit 7cfc04
are specified in symbolic mode, the initial mode on which those
Packit 7cfc04
operations are based is unspecified.
Packit 7cfc04
.P
Packit 7cfc04
If the pathname of the file to be produced exists, and the user does
Packit 7cfc04
not have write permission on that file,
Packit 7cfc04
.IR uudecode
Packit 7cfc04
shall terminate with an error. If the pathname of the file to be
Packit 7cfc04
produced exists, and the user has write permission on that file, the
Packit 7cfc04
existing file shall be overwritten.
Packit 7cfc04
.P
Packit 7cfc04
If the input data was produced by
Packit 7cfc04
.IR uuencode
Packit 7cfc04
on a system with a different number of bits per byte than on the target
Packit 7cfc04
system, the results of
Packit 7cfc04
.IR uudecode
Packit 7cfc04
are unspecified.
Packit 7cfc04
.SH OPTIONS
Packit 7cfc04
The
Packit 7cfc04
.IR uudecode
Packit 7cfc04
utility shall conform to the Base Definitions volume of POSIX.1\(hy2008,
Packit 7cfc04
.IR "Section 12.2" ", " "Utility Syntax Guidelines".
Packit 7cfc04
.P
Packit 7cfc04
The following option shall be supported by the implementation:
Packit 7cfc04
.IP "\fB\(mio\ \fIoutfile\fR" 10
Packit 7cfc04
A pathname of a file that shall be used instead of any pathname
Packit 7cfc04
contained in the input data. Specifying an
Packit 7cfc04
.IR outfile
Packit 7cfc04
option-argument of
Packit 7cfc04
.BR /dev/stdout
Packit 7cfc04
shall indicate standard output.
Packit 7cfc04
.SH OPERANDS
Packit 7cfc04
The following operand shall be supported:
Packit 7cfc04
.IP "\fIfile\fR" 10
Packit 7cfc04
The pathname of a file containing the output of
Packit 7cfc04
.IR uuencode .
Packit 7cfc04
.SH STDIN
Packit 7cfc04
See the INPUT FILES section.
Packit 7cfc04
.SH "INPUT FILES"
Packit 7cfc04
The input files shall be files containing the output of
Packit 7cfc04
.IR uuencode .
Packit 7cfc04
.SH "ENVIRONMENT VARIABLES"
Packit 7cfc04
The following environment variables shall affect the execution of
Packit 7cfc04
.IR uudecode :
Packit 7cfc04
.IP "\fILANG\fP" 10
Packit 7cfc04
Provide a default value for the internationalization variables that are
Packit 7cfc04
unset or null. (See the Base Definitions volume of POSIX.1\(hy2008,
Packit 7cfc04
.IR "Section 8.2" ", " "Internationalization Variables"
Packit 7cfc04
for the precedence of internationalization variables used to determine
Packit 7cfc04
the values of locale categories.)
Packit 7cfc04
.IP "\fILC_ALL\fP" 10
Packit 7cfc04
If set to a non-empty string value, override the values of all the
Packit 7cfc04
other internationalization variables.
Packit 7cfc04
.IP "\fILC_CTYPE\fP" 10
Packit 7cfc04
Determine the locale for the interpretation of sequences of bytes of
Packit 7cfc04
text data as characters (for example, single-byte as opposed to
Packit 7cfc04
multi-byte characters in arguments and input files).
Packit 7cfc04
.IP "\fILC_MESSAGES\fP" 10
Packit 7cfc04
.br
Packit 7cfc04
Determine the locale that should be used to affect the format and
Packit 7cfc04
contents of diagnostic messages written to standard error.
Packit 7cfc04
.IP "\fINLSPATH\fP" 10
Packit 7cfc04
Determine the location of message catalogs for the processing of
Packit 7cfc04
.IR LC_MESSAGES .
Packit 7cfc04
.SH "ASYNCHRONOUS EVENTS"
Packit 7cfc04
Default.
Packit 7cfc04
.SH STDOUT
Packit 7cfc04
If the file data header encoded by
Packit 7cfc04
.IR uuencode
Packit 7cfc04
is
Packit 7cfc04
.BR \(mi
Packit 7cfc04
or
Packit 7cfc04
.BR /dev/stdout ,
Packit 7cfc04
or the
Packit 7cfc04
.BR \(mio
Packit 7cfc04
.BR /dev/stdout
Packit 7cfc04
option overrides the file data, the standard output shall be in the
Packit 7cfc04
same format as the file originally encoded by
Packit 7cfc04
.IR uuencode .
Packit 7cfc04
Otherwise, the standard output shall not be used.
Packit 7cfc04
.SH STDERR
Packit 7cfc04
The standard error shall be used only for diagnostic messages.
Packit 7cfc04
.SH "OUTPUT FILES"
Packit 7cfc04
The output file shall be in the same format as the file originally
Packit 7cfc04
encoded by
Packit 7cfc04
.IR uuencode .
Packit 7cfc04
.SH "EXTENDED DESCRIPTION"
Packit 7cfc04
None.
Packit 7cfc04
.SH "EXIT STATUS"
Packit 7cfc04
The following exit values shall be returned:
Packit 7cfc04
.IP "\00" 6
Packit 7cfc04
Successful completion.
Packit 7cfc04
.IP >0 6
Packit 7cfc04
An error occurred.
Packit 7cfc04
.SH "CONSEQUENCES OF ERRORS"
Packit 7cfc04
Default.
Packit 7cfc04
.LP
Packit 7cfc04
.IR "The following sections are informative."
Packit 7cfc04
.SH "APPLICATION USAGE"
Packit 7cfc04
The user who is invoking
Packit 7cfc04
.IR uudecode
Packit 7cfc04
must have write permission on any file being created.
Packit 7cfc04
.P
Packit 7cfc04
The output of
Packit 7cfc04
.IR uuencode
Packit 7cfc04
is essentially an encoded bit stream that is not cognizant of byte
Packit 7cfc04
boundaries. It is possible that a 9-bit byte target machine can
Packit 7cfc04
process input from an 8-bit source, if it is aware of the requirement,
Packit 7cfc04
but the reverse is unlikely to be satisfying. Of course, the only data
Packit 7cfc04
that is meaningful for such a transfer between architectures is
Packit 7cfc04
generally character data.
Packit 7cfc04
.SH EXAMPLES
Packit 7cfc04
None.
Packit 7cfc04
.SH RATIONALE
Packit 7cfc04
Input files are not necessarily text files, as stated by an early
Packit 7cfc04
proposal. Although the
Packit 7cfc04
.IR uuencode
Packit 7cfc04
output is a text file, that output could have been wrapped within
Packit 7cfc04
another file or mail message that is not a text file.
Packit 7cfc04
.P
Packit 7cfc04
The
Packit 7cfc04
.BR \(mio
Packit 7cfc04
option is not historical practice, but was added at the request of WG15
Packit 7cfc04
so that the user could override the target pathname without having to
Packit 7cfc04
edit the input data itself.
Packit 7cfc04
.P
Packit 7cfc04
In early drafts, the [\c
Packit 7cfc04
.BR \(mio
Packit 7cfc04
.IR outfile ]
Packit 7cfc04
option-argument allowed the use of
Packit 7cfc04
.BR \(mi
Packit 7cfc04
to mean standard output. The symbol
Packit 7cfc04
.BR \(mi
Packit 7cfc04
has only been used previously in POSIX.1\(hy2008 as a standard input indicator.
Packit 7cfc04
The standard developers did not wish to overload the meaning of
Packit 7cfc04
.BR \(mi
Packit 7cfc04
in this manner. The
Packit 7cfc04
.BR /dev/stdout
Packit 7cfc04
concept exists on most modern systems. The
Packit 7cfc04
.BR /dev/stdout
Packit 7cfc04
syntax does not refer to a new special file. It is just a magic cookie
Packit 7cfc04
to specify standard output.
Packit 7cfc04
.SH "FUTURE DIRECTIONS"
Packit 7cfc04
None.
Packit 7cfc04
.SH "SEE ALSO"
Packit 7cfc04
.IR "\fIchmod\fR\^",
Packit 7cfc04
.IR "\fIumask\fR\^",
Packit 7cfc04
.IR "\fIuuencode\fR\^"
Packit 7cfc04
.P
Packit 7cfc04
The Base Definitions volume of POSIX.1\(hy2008,
Packit 7cfc04
.IR "Chapter 8" ", " "Environment Variables",
Packit 7cfc04
.IR "Section 12.2" ", " "Utility Syntax Guidelines"
Packit 7cfc04
.SH COPYRIGHT
Packit 7cfc04
Portions of this text are reprinted and reproduced in electronic form
Packit 7cfc04
from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
Packit 7cfc04
-- Portable Operating System Interface (POSIX), The Open Group Base
Packit 7cfc04
Specifications Issue 7, Copyright (C) 2013 by the Institute of
Packit 7cfc04
Electrical and Electronics Engineers, Inc and The Open Group.
Packit 7cfc04
(This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the
Packit 7cfc04
event of any discrepancy between this version and the original IEEE and
Packit 7cfc04
The Open Group Standard, the original IEEE and The Open Group Standard
Packit 7cfc04
is the referee document. The original Standard can be obtained online at
Packit 7cfc04
http://www.unix.org/online.html .
Packit 7cfc04
Packit 7cfc04
Any typographical or formatting errors that appear
Packit 7cfc04
in this page are most likely
Packit 7cfc04
to have been introduced during the conversion of the source files to
Packit 7cfc04
man page format. To report such errors, see
Packit 7cfc04
https://www.kernel.org/doc/man-pages/reporting_bugs.html .