freebsd-skq/usr.bin/tee/tee.1

.\" Copyright (c) 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" the Institute of Electrical and Electronics Engineers, Inc.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)tee.1	8.1 (Berkeley) 6/6/93
.\" $FreeBSD$
.\"
.Dd June 23, 2020
.Dt TEE 1
.Os
.Sh NAME
.Nm tee
.Nd duplicate standard input
.Sh SYNOPSIS
.Nm
.Op Fl ai
.Op Ar
.Sh DESCRIPTION
The
.Nm
utility copies standard input to standard output,
making a copy in zero or more files.
The output is unbuffered.
.Pp
The following options are available:
.Bl -tag -width indent
.It Fl a
Append the output to the files rather than
overwriting them.
.It Fl i
Ignore the
.Dv SIGINT
signal.
.El
.Pp
The following operands are available:
.Bl -tag -width indent
.It Ar file
A pathname of an output
.Ar file .
.El
.Pp
The
.Nm
utility takes the default action for all signals,
except in the event of the
.Fl i
option.
.Sh EXIT STATUS
.Ex -std
.Sh EXAMPLES
Send the echoed message both to stdout and to the
.Pa greetings.txt
file:
.Bd -literal -offset indent
$ echo "Hello" | tee greetings.txt
Hello
.Ed
.Sh STANDARDS
The
.Nm
utility is expected to be
.St -p1003.2
compatible.
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\" Copyright (c) 1991, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
			`.\"`
			`.\" This code is derived from software contributed to Berkeley by`
			`.\" the Institute of Electrical and Electronics Engineers, Inc.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
Renumber copyright clause 4 Renumber cluase 4 to 3, per what everybody else did when BSD granted them permission to remove clause 3. My insistance on keeping the same numbering for legal reasons is too pedantic, so give up on that point. Submitted by: Jan Schaumann <jschauma@stevens.edu> Pull Request: https://github.com/freebsd/freebsd/pull/96 2017-02-28 23:42:47 +00:00			`.\" 3. Neither the name of the University nor the names of its contributors`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
			`.\" @(#)tee.1 8.1 (Berkeley) 6/6/93`
$Id$ -> $FreeBSD$ 1999-08-28 01:08:13 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\"`
tee(1): Add EXAMPLES section Add one simple example Approved by: bcr@ Differential Revision: https://reviews.freebsd.org/D25337 2020-06-23 10:05:07 +00:00			`.Dd June 23, 2020`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Dt TEE 1`
			`.Os`
			`.Sh NAME`
			`.Nm tee`
- Steal short description from POSIX; it's more technical and was easier to translate. - Fix some markup nits. 2007-11-13 11:34:20 +00:00			`.Nd duplicate standard input`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh SYNOPSIS`
Use err(3) instead of local redefinition. Add usage(). 1997-08-14 06:42:43 +00:00			`.Nm`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Op Fl ai`
Use err(3) instead of local redefinition. Add usage(). 1997-08-14 06:42:43 +00:00			`.Op Ar`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh DESCRIPTION`
			`The`
Use err(3) instead of local redefinition. Add usage(). 1997-08-14 06:42:43 +00:00			`.Nm`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`utility copies standard input to standard output,`
			`making a copy in zero or more files.`
			`The output is unbuffered.`
			`.Pp`
			`The following options are available:`
- Steal short description from POSIX; it's more technical and was easier to translate. - Fix some markup nits. 2007-11-13 11:34:20 +00:00			`.Bl -tag -width indent`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.It Fl a`
			`Append the output to the files rather than`
			`overwriting them.`
			`.It Fl i`
			`Ignore the`
			`.Dv SIGINT`
			`signal.`
			`.El`
			`.Pp`
			`The following operands are available:`
- Steal short description from POSIX; it's more technical and was easier to translate. - Fix some markup nits. 2007-11-13 11:34:20 +00:00			`.Bl -tag -width indent`
Use err(3) instead of local redefinition. Add usage(). 1997-08-14 06:42:43 +00:00			`.It Ar file`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`A pathname of an output`
			`.Ar file .`
			`.El`
			`.Pp`
			`The`
Use err(3) instead of local redefinition. Add usage(). 1997-08-14 06:42:43 +00:00			`.Nm`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`utility takes the default action for all signals,`
			`except in the event of the`
			`.Fl i`
			`option.`
Added the EXIT STATUS section where appropriate. 2005-01-17 07:44:44 +00:00			`.Sh EXIT STATUS`
mdoc(7) police: utilize the new .Ex macro. 2001-08-15 09:09:47 +00:00			`.Ex -std`
tee(1): Add EXAMPLES section Probably the simplest one ever. Approved by: gbe@, 0mp@ Differential Revision: https://reviews.freebsd.org/D25206 2020-06-18 10:48:37 +00:00			`.Sh EXAMPLES`
tee.1: Add a missing article 2020-06-23 10:22:58 +00:00			`Send the echoed message both to stdout and to the`
tee(1): Add EXAMPLES section Add one simple example Approved by: bcr@ Differential Revision: https://reviews.freebsd.org/D25337 2020-06-23 10:05:07 +00:00			`.Pa greetings.txt`
			`file:`
tee(1): Add EXAMPLES section Probably the simplest one ever. Approved by: gbe@, 0mp@ Differential Revision: https://reviews.freebsd.org/D25206 2020-06-18 10:48:37 +00:00			`.Bd -literal -offset indent`
			`$ echo "Hello" \| tee greetings.txt`
			`Hello`
			`.Ed`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh STANDARDS`
			`The`
Use err(3) instead of local redefinition. Add usage(). 1997-08-14 06:42:43 +00:00			`.Nm`
Add DIAGNOSTICS section name 2000-03-26 15:06:46 +00:00			`utility is expected to be`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.St -p1003.2`
			`compatible.`