Commit 74d3e8f6 authored by Karl-Hermann Wieners's avatar Karl-Hermann Wieners
Browse files

Added documentation to new split option for UUID generation

parent 4cbace09
......@@ -46,7 +46,7 @@ Operator catalog:
Merge merge Merge datasets with different fields
Merge mergetime Merge datasets sorted by date and time
Split splitcode Split code numbers
Split splitparam Split parammeter identifiers
Split splitparam Split parameter identifiers
Split splitname Split variable names
Split splitlevel Split levels
Split splitgrid Split grids
......
......@@ -17,7 +17,7 @@ of the output files depends on the chosen operator.
@BeginOperator_splitcode
@Title = Split code numbers
@Parameter = [swap]
@Parameter = [swap] [uuid=<attname>]
@BeginDescription
Splits a dataset into pieces, one for each different code number.
......@@ -27,19 +27,19 @@ Splits a dataset into pieces, one for each different code number.
@BeginOperator_splitparam
@Title = Split parammeter identifiers
@Parameter = [swap]
@Title = Split parameter identifiers
@Parameter = [swap] [uuid=<attname>]
@BeginDescription
Splits a dataset into pieces, one for each different parammeter identifier.
@file{xxx} will be a string with the parammeter identifier.
Splits a dataset into pieces, one for each different parameter identifier.
@file{xxx} will be a string with the parameter identifier.
@EndDescription
@EndOperator
@BeginOperator_splitname
@Title = Split variable names
@Parameter = [swap]
@Parameter = [swap] [uuid=<attname>]
@BeginDescription
Splits a dataset into pieces, one for each variable name.
......@@ -50,7 +50,7 @@ Splits a dataset into pieces, one for each variable name.
@BeginOperator_splitlevel
@Title = Split levels
@Parameter = [swap]
@Parameter = [swap] [uuid=<attname>]
@BeginDescription
Splits a dataset into pieces, one for each different level.
......@@ -61,7 +61,7 @@ Splits a dataset into pieces, one for each different level.
@BeginOperator_splitgrid
@Title = Split grids
@Parameter = [swap]
@Parameter = [swap] [uuid=<attname>]
@BeginDescription
Splits a dataset into pieces, one for each different grid.
......@@ -72,7 +72,7 @@ Splits a dataset into pieces, one for each different grid.
@BeginOperator_splitzaxis
@Title = Split z-axes
@Parameter = [swap]
@Parameter = [swap] [uuid=<attname>]
@BeginDescription
Splits a dataset into pieces, one for each different z-axis.
......@@ -83,7 +83,7 @@ Splits a dataset into pieces, one for each different z-axis.
@BeginOperator_splittabnum
@Title = Split parameter table numbers
@Parameter = [swap]
@Parameter = [swap] [uuid=<attname>]
@BeginDescription
Splits a dataset into pieces, one for each GRIB1 parameter table number.
......@@ -101,9 +101,11 @@ Splits a dataset into pieces, one for each GRIB1 parameter table number.
@c @EndDescription
@BeginParameter swap
@BeginParameter
@Item = swap
STRING Swap the position of obase and xxx in the output filename
@Item uuid=<attname>
STRING Add UUID as a global attribute <attname> to each output file
@EndParameter
......
......@@ -287,7 +287,7 @@ static char *SplitHelp[] = {
" splittabnum - Split a dataset",
"",
"SYNOPSIS",
" <operator>[,swap] ifile obase",
" <operator>[,swap[,uuid=<attname>]] ifile obase",
"",
"DESCRIPTION",
" This module splits ifile into pieces. The output files will be named <obase><xxx><suffix>",
......@@ -298,9 +298,9 @@ static char *SplitHelp[] = {
" splitcode Split code numbers",
" Splits a dataset into pieces, one for each different code number.",
" xxx will have three digits with the code number.",
" splitparam Split parammeter identifiers",
" Splits a dataset into pieces, one for each different parammeter identifier.",
" xxx will be a string with the parammeter identifier.",
" splitparam Split parameter identifiers",
" Splits a dataset into pieces, one for each different parameter identifier.",
" xxx will be a string with the parameter identifier.",
" splitname Split variable names",
" Splits a dataset into pieces, one for each variable name.",
" xxx will be a string with the variable name.",
......@@ -318,7 +318,8 @@ static char *SplitHelp[] = {
" xxx will have three digits with the GRIB1 parameter table number.",
"",
"PARAMETER",
" swap STRING Swap the position of obase and xxx in the output filename",
" swap STRING Swap the position of obase and xxx in the output filename",
" <attname> STRING Add UUID as a global attribute <attname> to each output file",
"",
"ENVIRONMENT",
" CDO_FILE_SUFFIX",
......
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