Commit e6d4f33c authored by Uwe Schulzweida's avatar Uwe Schulzweida
Browse files

apply: docu update.

parent f7678cb9
Pipeline #4411 passed with stages
in 15 minutes and 3 seconds
......@@ -42,7 +42,7 @@ Operator catalog:
-------------------------------------------------------------
File operations
-------------------------------------------------------------
Apply apply Apply an operator on each input file.
Apply apply Apply operators on each input file.
Copy copy Copy datasets
Copy cat Concatenate datasets
Tee tee Duplicate a data stream
......
@BeginModule
@NewPage
@Name = Apply
@Title = Apply an operator
@Title = Apply operators
@Section = File operations
@Class = File operation
@Arguments = infiles
@Operators = apply
@BeginDescription
The apply utility runs the named operator on each input file.
The input files must be enclosed in square brackets.
This utility can only be used on a series of input files.
These are all operators with more than one input file (@file{infiles}).
Here is an incomplete list of these operators:
@oper{copy}, @oper{cat}, @oper{merge}, @oper{mergetime}, @oper{select}, @oper{ENSSTAT}
The apply utility runs the named operators on each input file. The input files must be enclosed in square brackets.
This utility can only be used on a series of input files. These are all operators with more than one input file (@file{infiles}).
Here is an incomplete list of these operators: @oper{copy}, @oper{cat}, @oper{merge}, @oper{mergetime}, @oper{select}, @oper{ENSSTAT}.
The parameter operators is a blank-separated list of CDO operators. Use quotation marks if more than one operator is needed.
Each operator may have only one input and output stream.
@EndDescription
@EndModule
@BeginOperator_apply
@Title = Apply an operator on each input file.
@Parameter = operator
@Title = Apply operators on each input file.
@Parameter = operators
@EndOperator
@BeginParameter
@Item = operator
STRING CDO operator with a single input and output file.
@Item = operators
STRING Blank-separated list of CDO operators.
@EndParameter
......
......@@ -238,7 +238,7 @@ Some operators need one or more parameter. A list of parameter is indicated by t
\begin{itemize}
\item STRING
Unquoted characters without blanks and tabs.
String parameters require quotes if the string contains blanks or other characters interpreted by the shell.
The following command select variables with the name \texttt{pressure} and \texttt{tsurf}:
\begin{verbatim}
cdo selvar,pressure,tsurf infile outfile
......
......@@ -236,21 +236,20 @@ static const char *FiledesHelp[] = {
static const char *ApplyHelp[] = {
"NAME",
" apply - Apply an operator",
" apply - Apply operators",
"",
"SYNOPSIS",
" apply,operator infiles",
" apply,operators infiles",
"",
"DESCRIPTION",
" The apply utility runs the named operator on each input file.",
" The input files must be enclosed in square brackets.",
" This utility can only be used on a series of input files.",
" These are all operators with more than one input file (infiles).",
" Here is an incomplete list of these operators:",
" copy, cat, merge, mergetime, select, ENSSTAT",
" The apply utility runs the named operators on each input file. The input files must be enclosed in square brackets.",
" This utility can only be used on a series of input files. These are all operators with more than one input file (infiles).",
" Here is an incomplete list of these operators: copy, cat, merge, mergetime, select, ENSSTAT.",
" The parameter operators is a blank-separated list of CDO operators. Use quotation marks if more than one operator is needed.",
" Each operator may have only one input and output stream.",
"",
"PARAMETER",
" operator STRING CDO operator with a single input and output file.",
" operators STRING Blank-separated list of CDO operators.",
nullptr
};
......
Supports Markdown
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