Files
oldlinux-files/Ref-docs/POSIX/susv3/utilities/tee.html
2024-02-19 00:21:47 -05:00

260 lines
8.1 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta name="generator" content="HTML Tidy, see www.w3.org">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link type="text/css" rel="stylesheet" href="style.css"><!-- Generated by The Open Group's rhtm tool v1.2.1 -->
<!-- Copyright (c) 2001 The Open Group, All Rights Reserved -->
<title>tee</title>
</head>
<body bgcolor="white">
<script type="text/javascript" language="JavaScript" src="../jscript/codes.js">
</script>
<basefont size="3"> <a name="tee"></a> <a name="tag_04_139"></a><!-- tee -->
<!--header start-->
<center><font size="2">The Open Group Base Specifications Issue 6<br>
IEEE Std 1003.1-2001<br>
Copyright &copy; 2001 The IEEE and The Open Group, All Rights reserved.</font></center>
<!--header end-->
<hr size="2" noshade>
<h4><a name="tag_04_139_01"></a>NAME</h4>
<blockquote>tee - duplicate standard input</blockquote>
<h4><a name="tag_04_139_02"></a>SYNOPSIS</h4>
<blockquote class="synopsis">
<p><code><tt>tee</tt> <b>[</b><tt>-ai</tt><b>][</b><i>file</i><tt>...</tt><b>]</b></code></p>
</blockquote>
<h4><a name="tag_04_139_03"></a>DESCRIPTION</h4>
<blockquote>
<p>The <i>tee</i> utility shall copy standard input to standard output, making a copy in zero or more files. The <i>tee</i> utility
shall not buffer output.</p>
<p>If the <b>-a</b> option is not specified, output files shall be written (see <a href="xcu_chap01.html#tag_01_07_01_04"><i>File
Read, Write, and Creation</i></a> .</p>
</blockquote>
<h4><a name="tag_04_139_04"></a>OPTIONS</h4>
<blockquote>
<p>The <i>tee</i> utility shall conform to the Base Definitions volume of IEEE&nbsp;Std&nbsp;1003.1-2001, <a href=
"../basedefs/xbd_chap12.html#tag_12_02">Section 12.2, Utility Syntax Guidelines</a>.</p>
<p>The following options shall be supported:</p>
<dl compact>
<dt><b>-a</b></dt>
<dd>Append the output to the files.</dd>
<dt><b>-i</b></dt>
<dd>Ignore the SIGINT signal.</dd>
</dl>
</blockquote>
<h4><a name="tag_04_139_05"></a>OPERANDS</h4>
<blockquote>
<p>The following operands shall be supported:</p>
<dl compact>
<dt><i>file</i></dt>
<dd>A pathname of an output file. Processing of at least 13 <i>file</i> operands shall be supported.</dd>
</dl>
</blockquote>
<h4><a name="tag_04_139_06"></a>STDIN</h4>
<blockquote>
<p>The standard input can be of any type.</p>
</blockquote>
<h4><a name="tag_04_139_07"></a>INPUT FILES</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_04_139_08"></a>ENVIRONMENT VARIABLES</h4>
<blockquote>
<p>The following environment variables shall affect the execution of <i>tee</i>:</p>
<dl compact>
<dt><i>LANG</i></dt>
<dd>Provide a default value for the internationalization variables that are unset or null. (See the Base Definitions volume of
IEEE&nbsp;Std&nbsp;1003.1-2001, <a href="../basedefs/xbd_chap08.html#tag_08_02">Section 8.2, Internationalization Variables</a> for
the precedence of internationalization variables used to determine the values of locale categories.)</dd>
<dt><i>LC_ALL</i></dt>
<dd>If set to a non-empty string value, override the values of all the other internationalization variables.</dd>
<dt><i>LC_CTYPE</i></dt>
<dd>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).</dd>
<dt><i>LC_MESSAGES</i></dt>
<dd>Determine the locale that should be used to affect the format and contents of diagnostic messages written to standard
error.</dd>
<dt><i>NLSPATH</i></dt>
<dd><sup>[<a href="javascript:open_code('XSI')">XSI</a>]</sup> <img src="../images/opt-start.gif" alt="[Option Start]" border="0">
Determine the location of message catalogs for the processing of <i>LC_MESSAGES .</i> <img src="../images/opt-end.gif" alt=
"[Option End]" border="0"></dd>
</dl>
</blockquote>
<h4><a name="tag_04_139_09"></a>ASYNCHRONOUS EVENTS</h4>
<blockquote>
<p>Default, except that if the <b>-i</b> option was specified, SIGINT shall be ignored.</p>
</blockquote>
<h4><a name="tag_04_139_10"></a>STDOUT</h4>
<blockquote>
<p>The standard output shall be a copy of the standard input.</p>
</blockquote>
<h4><a name="tag_04_139_11"></a>STDERR</h4>
<blockquote>
<p>The standard error shall be used only for diagnostic messages.</p>
</blockquote>
<h4><a name="tag_04_139_12"></a>OUTPUT FILES</h4>
<blockquote>
<p>If any <i>file</i> operands are specified, the standard input shall be copied to each named file.</p>
</blockquote>
<h4><a name="tag_04_139_13"></a>EXTENDED DESCRIPTION</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_04_139_14"></a>EXIT STATUS</h4>
<blockquote>
<p>The following exit values shall be returned:</p>
<dl compact>
<dt>&nbsp;0</dt>
<dd>The standard input was successfully copied to all output files.</dd>
<dt>&gt;0</dt>
<dd>An error occurred.</dd>
</dl>
</blockquote>
<h4><a name="tag_04_139_15"></a>CONSEQUENCES OF ERRORS</h4>
<blockquote>
<p>If a write to any successfully opened <i>file</i> operand fails, writes to other successfully opened <i>file</i> operands and
standard output shall continue, but the exit status shall be non-zero. Otherwise, the default actions specified in <a href=
"xcu_chap01.html#tag_01_11"><i>Utility Description Defaults</i></a> apply.</p>
</blockquote>
<hr>
<div class="box"><em>The following sections are informative.</em></div>
<h4><a name="tag_04_139_16"></a>APPLICATION USAGE</h4>
<blockquote>
<p>The <i>tee</i> utility is usually used in a pipeline, to make a copy of the output of some utility.</p>
<p>The <i>file</i> operand is technically optional, but <i>tee</i> is no more useful than <a href=
"../utilities/cat.html"><i>cat</i></a> when none is specified.</p>
</blockquote>
<h4><a name="tag_04_139_17"></a>EXAMPLES</h4>
<blockquote>
<p>Save an unsorted intermediate form of the data in a pipeline:</p>
<pre>
<tt>... | tee unsorted | sort &gt; sorted
</tt>
</pre>
</blockquote>
<h4><a name="tag_04_139_18"></a>RATIONALE</h4>
<blockquote>
<p>The buffering requirement means that <i>tee</i> is not allowed to use ISO&nbsp;C standard fully buffered or line-buffered
writes. It does not mean that <i>tee</i> has to do 1-byte reads followed by 1-byte writes.</p>
<p>It should be noted that early versions of BSD ignore any invalid options and accept a single <tt>'-'</tt> as an alternative to
<b>-i</b>. They also print a message if unable to open a file:</p>
<pre>
<tt>"tee: cannot access %s\n", &lt;</tt><i>pathname</i><tt>&gt;
</tt>
</pre>
<p>Historical implementations ignore write errors. This is explicitly not permitted by this volume of
IEEE&nbsp;Std&nbsp;1003.1-2001.</p>
<p>Some historical implementations use O_APPEND when providing append mode; others use the <a href=
"../functions/lseek.html"><i>lseek</i>()</a> function to seek to the end-of-file after opening the file without O_APPEND. This
volume of IEEE&nbsp;Std&nbsp;1003.1-2001 requires functionality equivalent to using O_APPEND; see <a href=
"xcu_chap01.html#tag_01_07_01_04"><i>File Read, Write, and Creation</i></a> .</p>
</blockquote>
<h4><a name="tag_04_139_19"></a>FUTURE DIRECTIONS</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_04_139_20"></a>SEE ALSO</h4>
<blockquote>
<p><a href="xcu_chap01.html#tag_01"><i>Introduction</i></a> , <a href="cat.html"><i>cat</i></a> , the System Interfaces volume of
IEEE&nbsp;Std&nbsp;1003.1-2001, <a href="../functions/lseek.html"><i>lseek</i>()</a></p>
</blockquote>
<h4><a name="tag_04_139_21"></a>CHANGE HISTORY</h4>
<blockquote>
<p>First released in Issue 2.</p>
</blockquote>
<h4><a name="tag_04_139_22"></a>Issue 6</h4>
<blockquote>
<p>IEEE PASC Interpretation 1003.2 #168 is applied.</p>
</blockquote>
<div class="box"><em>End of informative text.</em></div>
<hr>
<hr size="2" noshade>
<center><font size="2"><!--footer start-->
UNIX &reg; is a registered Trademark of The Open Group.<br>
POSIX &reg; is a registered Trademark of The IEEE.<br>
[ <a href="../mindex.html">Main Index</a> | <a href="../basedefs/contents.html">XBD</a> | <a href=
"../utilities/contents.html">XCU</a> | <a href="../functions/contents.html">XSH</a> | <a href="../xrat/contents.html">XRAT</a>
]</font></center>
<!--footer end-->
<hr size="2" noshade>
</body>
</html>