xsinfo: docu update.

OPERATORS

@@ -12,8 +12,8 @@ Operator catalog:
    Info          map             Dataset information and simple map
    Sinfo         sinfo           Short information listed by parameter identifier
    Sinfo         sinfon          Short information listed by parameter name
-   XSinfo        xsinfo          Extra short information listed by parameter identifier
-   XSinfo        xsinfon         Extra short information listed by parameter name
+   XSinfo        xsinfo          Extra short information listed by parameter name
+   XSinfo        xsinfop         Extra short information listed by parameter identifier
    Diff          diff            Compare two datasets listed by parameter id
    Diff          diffn           Compare two datasets listed by parameter name
    Ninfo         npar            Number of parameters

doc/tex/memory_requirements.tex

@@ -15,7 +15,7 @@ In multi-threaded mode (see option \textsl{-P}) the memory requirement can incre
 This increase grows with the number of threads used.
 
 The data type determines the number of bytes per value.
-Single precision floating point data (float) occupies 4 bytes per value.
+Single precision floating point data occupies 4 bytes per value.
 All other data types are read as double precision floats and thus occupy 8 bytes per value.
 With the {\CDO} option \textsl{-{}-single} all data is read as single precision floats.
 This can reduce the memory requirement by a factor of 2.

doc/tex/mod/XSinfo

+@BeginModule
+@NewPage
+@Name      = XSinfo
+@Title     = Extra short information
+@Section   = Information
+@Class     = Information
+@Arguments = infiles
+@Operators = xsinfo xsinfop
+
+@BeginDescription
+This module writes information about the structure of @file{infiles} to standard output.
+@file{infiles} is an arbitrary number of input files. All input files need to have 
+the same structure with the same variables on different timesteps.
+The information displayed depends on the chosen operator.
+@EndDescription
+@EndModule
+
+
+@BeginOperator_xsinfo
+@Title     = Extra short information listed by parameter name
+
+@BeginDescription
+Prints short information of a dataset. The information is divided into 4 sections.
+Section 1 prints one line per parameter with the following information:
+@BeginItemize
+@Item = institute and source
+@Item = time c=constant v=varying
+@Item = type of statistical processing
+@Item = number of levels and z-axis number
+@Item = horizontal grid size and number
+@Item = data type
+@Item = memory type (float or double)
+@Item = parameter name
+@EndItemize
+Section 2 to 4 gives a short overview of all grid, vertical and time coordinates.
+@EndDescription
+@EndOperator
+
+
+@BeginOperator_xsinfop
+@Title     = Extra short information listed by parameter identifier
+
+@BeginDescription
+The same as operator @oper{xsinfo} but using the identifier instead of the name to label the parameter.
+@EndDescription
+@EndOperator
+
+
+@BeginExample
+To print extra short information of a dataset use:
+@BeginVerbatim
+   cdo xsinfo infile
+@EndVerbatim
+This is the result of an ECHAM5 dataset with 3 parameter over 12 timesteps:
+@BeginListing
+  -1 : Institut Source  T Steptype Levels Num   Points Num Dtype Mtype : Name 
+   1 : MPIMET   ECHAM5  c instant       1   1     2048   1  F32   F32 : GEOSP 
+   2 : MPIMET   ECHAM5  v instant       4   2     2048   1  F32   F32 : T     
+   3 : MPIMET   ECHAM5  v instant       1   1     2048   1  F32   F32 : TSURF 
+ Grid coordinates :
+   1 : gaussian         : points=2048 (64x32)  F16
+               longitude: 0 to 354.375 by 5.625 degrees_east  circular
+                latitude: 85.7606 to -85.7606 degrees_north
+ Vertical coordinates :
+   1 : surface          : levels=1
+   2 : pressure         : levels=4
+                   level: 92500 to 20000 Pa
+ Time coordinate :
+                   steps: 12
+                    time: 1987-01-31T18:00:00 to 1987-12-31T18:00:00 by 1 month
+                   units: days since  1987-01-01T00:00:00
+                calendar: proleptic_gregorian
+@EndListing
+@EndExample

src/Sinfo.cc

@@ -391,7 +391,7 @@ addOperators(void)
   cdo_operator_add("seinfop", func_param,   1, nullptr);
   cdo_operator_add("seinfon", func_name,    1, nullptr);
   cdo_operator_add("seinfoc", func_code,    1, nullptr);
-  cdo_operator_add("xsinfo",  func_generic, 2, nullptr);
+  cdo_operator_add("xsinfo",  func_name,    2, nullptr);
   cdo_operator_add("xsinfop", func_param,   2, nullptr);
   cdo_operator_add("xsinfon", func_name,    2, nullptr);
   cdo_operator_add("xsinfoc", func_code,    2, nullptr);

src/operator_help.h

@@ -70,7 +70,7 @@ static const char *SinfoHelp[] = {
 
 static const char *XSinfoHelp[] = {
     "NAME",
-    "    xsinfo, xsinfon - Extra short information",
+    "    xsinfo, xsinfop - Extra short information",
     "",
     "SYNOPSIS",
     "    <operator>  infiles",
@@ -82,7 +82,7 @@ static const char *XSinfoHelp[] = {
     "    The information displayed depends on the chosen operator.",
     "",
     "OPERATORS",
-    "    xsinfo   Extra short information listed by parameter identifier",
+    "    xsinfo   Extra short information listed by parameter name",
     "             Prints short information of a dataset. The information is divided into 4 sections.",
     "             Section 1 prints one line per parameter with the following information:",
     "             - institute and source",
@@ -92,10 +92,10 @@ static const char *XSinfoHelp[] = {
     "             - horizontal grid size and number",
     "             - data type",
     "             - memory type (float or double)",
-    "             - parameter identifier",
+    "             - parameter name",
     "             Section 2 to 4 gives a short overview of all grid, vertical and time coordinates.",
-    "    xsinfon  Extra short information listed by parameter name",
-    "             The same as operator xsinfo but using the name instead of the identifier to label the parameter.",
+    "    xsinfop  Extra short information listed by parameter identifier",
+    "             The same as operator xsinfo but using the identifier instead of the name to label the parameter.",
     nullptr
 };