Commit bfe03869 authored by Oliver Heidmann's avatar Oliver Heidmann
Browse files

updated -tee operator help

parent e13d1f10
@BeginModule
@Name = Tee
@Title = Duplicate a data stream
@Title = Duplicate a data stream and write it to file
@Section = File operations
@Class = File operation
@Arguments = infile outfile1 outfile2
@Arguments = infile outfile
@Operators = tee
@BeginDescription
......@@ -13,9 +13,12 @@
@BeginOperator_tee
@Title = Duplicate a data stream
@Parameter = [filename]
@BeginDescription
This operator copies the input datasets to @file{outfile1} and @file{outfile2}.
This operator copies the input datasets to @file{outfile1}
which then can be further processesd with other cdo operators
and to a second output @file{filename} which is written to disk.
It can be used to store intermediate results to a file.
@EndDescription
@EndOperator
......@@ -24,6 +27,11 @@ It can be used to store intermediate results to a file.
@BeginExample
To compute the daily and monthy average of a dataset use:
@BeginVerbatim
cdo monavg -tee dayavg infile outfile_dayavg outfile_monavg
cdo monavg -tee,outfile_dayavg dayavg infile outfile_monavg
@EndVerbatim
@EndExample
@BeginParameter
@Item = filename
STRING Destination filename for the copy of @file{infile}
@EndParameter
......@@ -252,14 +252,19 @@ static const std::vector<std::string> CopyHelp = {
static const std::vector<std::string> TeeHelp = {
"NAME",
" tee - Duplicate a data stream",
" tee - Duplicate a data stream and write it to file",
"",
"SYNOPSIS",
" tee infile outfile1 outfile2",
" tee[,filename] infile outfile",
"",
"DESCRIPTION",
" This operator copies the input datasets to outfile1 and outfile2.",
" This operator copies the input datasets to outfile1",
" which then can be further processesd with other cdo operators",
" and to a second output filename which is written to disk.",
" It can be used to store intermediate results to a file.",
"",
"PARAMETER",
" filename STRING Destination filename for the copy of @file{infile}",
};
static const std::vector<std::string> ReplaceHelp = {
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment