aboutsummaryrefslogtreecommitdiff
path: root/pkg/system/doc/tee.hlp
diff options
context:
space:
mode:
authorJoe Hunkeler <jhunkeler@gmail.com>2015-08-11 16:51:37 -0400
committerJoe Hunkeler <jhunkeler@gmail.com>2015-08-11 16:51:37 -0400
commit40e5a5811c6ffce9b0974e93cdd927cbcf60c157 (patch)
tree4464880c571602d54f6ae114729bf62a89518057 /pkg/system/doc/tee.hlp
downloadiraf-osx-40e5a5811c6ffce9b0974e93cdd927cbcf60c157.tar.gz
Repatch (from linux) of OSX IRAF
Diffstat (limited to 'pkg/system/doc/tee.hlp')
-rw-r--r--pkg/system/doc/tee.hlp36
1 files changed, 36 insertions, 0 deletions
diff --git a/pkg/system/doc/tee.hlp b/pkg/system/doc/tee.hlp
new file mode 100644
index 00000000..466b3751
--- /dev/null
+++ b/pkg/system/doc/tee.hlp
@@ -0,0 +1,36 @@
+.help tee Nov84 system
+.ih
+NAME
+tee -- tee the standard output to a file
+.ih
+USAGE
+tee file
+.ih
+PARAMETERS
+.ls file
+The name of the output file.
+.le
+.ls out_type = "text"
+The type of output file to be created, either "text" or "binary".
+.le
+.ls append = no
+If set, append to an existing file, otherwise create a new file.
+.le
+.ih
+DESCRIPTION
+\fITee\fR copies its input to both the standard output and the named file.
+Its primary use is in pipes where one wants to capture some intermediate output.
+.ih
+EXAMPLES
+
+1. The results of the \fIset\fR command are captured in the file "temp",
+and are also passed on to the "match" command. The result is
+a "temp" file of perhaps 100 lines, with the output to the screen
+only around 5 lines.
+
+ cl> set | tee temp | match tty
+.ih
+BUGS
+Since the processes in an IRAF pipe execute serially rather than concurrently,
+the teed output will not appear until all tasks to the left have completed.
+.endhelp