xref: /illumos-gate/usr/src/man/man1/tee.1 (revision a28480febf31f0e61debac062a55216a98a05a92)

Sun Microsystems, Inc. gratefully acknowledges The Open Group for
permission to reproduce portions of its copyrighted documentation.
Original documentation from The Open Group can be obtained online at
http://www.opengroup.org/bookstore/.

The Institute of Electrical and Electronics Engineers and The Open
Group, have given us permission to reprint portions of their
documentation.

In the following statement, the phrase ``this text'' refers to portions
of the system documentation.

Portions of this text are reprinted and reproduced in electronic form
in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
Standard for Information Technology -- Portable Operating System
Interface (POSIX), The Open Group Base Specifications Issue 6,
Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
Engineers, Inc and The Open Group. In the event of any discrepancy
between these versions 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.opengroup.org/unix/online.html.

This notice shall appear on any product containing this material.

The contents of this file are subject to the terms of the
Common Development and Distribution License (the "License").
You may not use this file except in compliance with the License.

You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
or http://www.opensolaris.org/os/licensing.
See the License for the specific language governing permissions
and limitations under the License.

When distributing Covered Code, include this CDDL HEADER in each
file and include the License file at usr/src/OPENSOLARIS.LICENSE.
If applicable, add the following below this CDDL HEADER, with the
fields enclosed by brackets "[]" replaced with your own identifying
information: Portions Copyright [yyyy] [name of copyright owner]


Copyright 1989 AT&T
Copyright (c) 1992, X/Open Company Limited. All Rights Reserved.
Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved

TEE 1 "Nov 20, 2007"
NAME
tee - replicate the standard output
SYNOPSIS
"/usr/bin/tee"

/usr/bin/tee [-ai] [file]...
"ksh93"

tee [-ail] [file]...
DESCRIPTION
"/usr/bin/tee"

/usr/bin/tee copies standard input to standard output, making a copy in zero or more files. tee does not buffer its output. The options determine if the specified files are overwritten or appended to.

"ksh93"

The tee built-in in ksh93 is associated with the /bin and /usr/bin paths. It is invoked when tee is executed without a pathname prefix and the pathname search finds a /bin/tee or /usr/bin/tee executable.

tee copies standard input to standard output and to zero or more files. The options determine whether the specified files are overwritten or appended to. The tee utility does not buffer output. If a write to a file fails, tee continues to write to other files although it exits with a non-zero exit status.

The number of file operands that can be specified is limited by the underlying operating system.

OPTIONS
"/usr/bin/tee"

The following options are supported by /usr/bin/tee: -a

Appends the output to the files rather than overwriting them.

-i

Ignores interrupts.

"ksh93"

The following options are supported by the tee built-in command in ksh93: -a

--append

Appends the output to the files rather than overwriting them.

-i

--ignore-interrupts

Ignores SIGINT signal.

-l

--line-buffer

Sets the standard output to be line buffered.

OPERANDS

The following operands are supported: file

A path name of an output file. Processing of at least 13 file operands are supported.

USAGE

See largefile(5) for the description of the behavior of tee when encountering files greater than or equal to 2 Gbyte ( 2^31 bytes).

ENVIRONMENT VARIABLES

See environ(5) for descriptions of the following environment variables that affect the execution of tee: LANG, LC_ALL, LC_CTYPE, LC_MESSAGES, and NLSPATH.

EXIT STATUS
"/usr/bin/tee"

The following exit values are returned by /usr/bin/tee: 0

The standard input was successfully copied to all output files.

>0

The number of files that could not be opened or whose status could not be obtained.

"ksh93"

The following exit values are returned by tee in ksh93: 0

Successful completion.

>0

An error occurred.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

"/usr/bin/tee"
ATTRIBUTE TYPE ATTRIBUTE VALUE
CSI Enabled
Interface Stability Committed
Standard See standards(5).
"ksh93"
ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability See below.

The ksh93 built-in binding to /bin and /usr/bin is Volatile. The built-in interfaces are Uncommitted.

SEE ALSO

cat(1), ksh93(1), attributes(5), environ(5), largefile(5), standards(5)