tee (2) - Linux Manuals
tee: duplicating pipe content
tee - duplicating pipe content
#define _GNU_SOURCE /* See feature_test_macros(7) */ #include <fcntl.h> ssize_t tee(int fd_in, int fd_out, size_t len, unsigned int flags);
DESCRIPTIONtee() duplicates up to len bytes of data from the pipe referred to by the file descriptor fd_in to the pipe referred to by the file descriptor fd_out. It does not consume the data that is duplicated from fd_in; therefore, that data can be copied by a subsequent splice(2).
flags is a bit mask that is composed by ORing together zero or more of the following values:
- Currently has no effect for tee(); see splice(2).
- Do not block on I/O; see splice(2) for further details.
- Currently has no effect for tee(), but may be implemented in the future; see splice(2).
- Unused for tee(); see vmsplice(2).
RETURN VALUEUpon successful completion, tee() returns the number of bytes that were duplicated between the input and output. A return value of 0 means that there was no data to transfer, and it would not make sense to block, because there are no writers connected to the write end of the pipe referred to by fd_in.
- SPLICE_F_NONBLOCK was specified in flags or one of the file descriptors had been marked as nonblocking (O_NONBLOCK), and the operation would block.
- fd_in or fd_out does not refer to a pipe; or fd_in and fd_out refer to the same pipe.
- Out of memory.
VERSIONSThe tee() system call first appeared in Linux 2.6.17; library support was added to glibc in version 2.5.
CONFORMING TOThis system call is Linux-specific.
NOTESConceptually, tee() copies the data between the two pipes. In reality no real data copying takes place though: under the covers, tee() assigns data to the output by merely grabbing a reference to the input.
EXAMPLESThe example below implements a basic tee(1) program using the tee() system call. Here is an example of its use:
Program source#define _GNU_SOURCE #include <fcntl.h> #include <stdio.h> #include <stdlib.h> #include <unistd.h> #include <errno.h> #include <limits.h>
main(int argc, char *argv)
COLOPHONThis page is part of release 5.10 of the Linux man-pages project. A description of the project, information about reporting bugs, and the latest version of this page, can be found at https://www.kernel.org/doc/man-pages/.