Update help text

This commit is contained in:
Shahram Najm 2016-04-02 12:27:30 +01:00
parent 3a79efa761
commit fd3ff5db11
4 changed files with 15 additions and 10 deletions

View File

@ -6,7 +6,7 @@ echo " Input messages can be written to the output by using the \"write\" statem
echo " is sent to multiple files depending on key values used in the output file name. \\n" echo " is sent to multiple files depending on key values used in the output file name. \\n"
echo " First we write a rules_file containing the following statement:\\n \\n" echo " First we write a rules_file containing the following statement:\\n \\n"
echo "\\verbatim" echo "\\verbatim"
echo "write \"../data/split/[bufrHeaderCentre:l]_[dataCategory].bufr[editionNumber]\";" echo "write \"../data/split/[bufrHeaderCentre:i]_[dataCategory].bufr[editionNumber]\";"
echo "\\endverbatim\\n" echo "\\endverbatim\\n"
echo "Then we create the BUFR file multitype.bufr from three others: \\n" echo "Then we create the BUFR file multitype.bufr from three others: \\n"
echo "\\verbatim" echo "\\verbatim"
@ -28,7 +28,7 @@ cat ../data/bufr/syno_1.bufr ../data/bufr/goes_87.bufr ../data/bufr/gosat.bufr >
cat > rules_file <<EOF cat > rules_file <<EOF
write "../data/split/[bufrHeaderCentre:l]_[dataCategory].bufr[editionNumber]"; write "../data/split/[bufrHeaderCentre:i]_[dataCategory].bufr[editionNumber]";
EOF EOF
echo ">bufr_filter rules_file ../data/split/multitype.bufr" echo ">bufr_filter rules_file ../data/split/multitype.bufr"

View File

@ -79,11 +79,11 @@ is printed.
echo "-# Some options are provided to compare only a set of keys in the messages. The option -H is used to compare only the headers echo "-# Some options are provided to compare only a set of keys in the messages. The option -H is used to compare only the headers
coded in the message, it doesn't compare the data values. coded in the message, it doesn't compare the data values.
The option \"-c key1:[l/d/s/n],key2:[l/d/s/n],... \" can be used to The option \"-c key1:[i/d/s/n],key2:[i/d/s/n],... \" can be used to
compare a set of keys or namespaces. The letter after the colon is optional and it is used to force the compare a set of keys or namespaces. The letter after the colon is optional and it is used to force the
type used in the comparison which is otherwise assumed to be the native type of the key. type used in the comparison which is otherwise assumed to be the native type of the key.
The possible types are: The possible types are:
- :l -> integer (C type long) - :i -> integer
- :d -> floating point (C type double) - :d -> floating point (C type double)
- :s -> string - :s -> string
- :n -> namespace. - :n -> namespace.
@ -137,7 +137,7 @@ $toolsDir/grib_compare -A 2 -c data:n first.grib1 second.grib1
set -e set -e
echo "\\endverbatim echo "\\endverbatim
and we see that the comparison is successful if the absolute tolerance is set to 2. and we see that the comparison is successful if the absolute tolerance is set to 2.
We can also set the relative tolerance for each key with the option -R:" We can also set the relative tolerance for each key with the option -R:"
echo "\\verbatim echo "\\verbatim
>grib_compare -R packedValues=0.4 -c data:n first.grib1 second.grib1" >grib_compare -R packedValues=0.4 -c data:n first.grib1 second.grib1"

View File

@ -11,6 +11,11 @@ echo "\verbatim"
echo "> grib_copy -w levtype!=pl ../data/tigge_pf_ecmwf.grib2 out.grib" echo "> grib_copy -w levtype!=pl ../data/tigge_pf_ecmwf.grib2 out.grib"
echo "\endverbatim\\n" echo "\endverbatim\\n"
echo "-# To copy only the first three fields from a file\\n"
echo "\verbatim"
echo "> grib_copy -w count=1/2/3 ../data/tigge_pf_ecmwf.grib2 out.grib"
echo "\endverbatim\\n"
echo "-# A grib_file with multi field messages can be converted in single field messages" echo "-# A grib_file with multi field messages can be converted in single field messages"
echo "with a simple grib_copy.\\n" echo "with a simple grib_copy.\\n"
echo "\verbatim" echo "\verbatim"
@ -20,5 +25,5 @@ echo "\endverbatim\\n"
echo "-# Use the square brackets to insert the value of a key" echo "-# Use the square brackets to insert the value of a key"
echo "in the name of the output file.\\n" echo "in the name of the output file.\\n"
echo "\verbatim" echo "\verbatim"
echo "> grib_copy in.grib out_[shortName].grib" echo "> grib_copy in.grib 'out_[shortName].grib'"
echo "\endverbatim\\n" echo "\endverbatim\\n"

View File

@ -31,15 +31,15 @@ ls ../data/split
echo "\\endverbatim\\n" echo "\\endverbatim\\n"
echo "-# The key values in the file name can also be obtained in a different format by indicating explicitly the type required after a colon." echo "-# The key values in the file name can also be obtained in a different format by indicating explicitly the type required after a colon."
echo " - :l for long" echo " - :i for integer"
echo " - :d for double" echo " - :d for double"
echo " - :s for string" echo " - :s for string"
echo " ." echo " ."
echo "The following statement works in a slightly different way from the previous example, " echo "The following statement works in a slightly different way from the previous example, "
echo " including in the output file name the long values for centre and dataType.\\n" echo " including in the output file name the integer values for centre and dataType.\\n"
echo "\\verbatim" echo "\\verbatim"
echo "write \"../data/split/[centre:l]_[date]_[dataType:l]_[levelType].grib[editionNumber]\";" echo "write \"../data/split/[centre:i]_[date]_[dataType:i]_[levelType].grib[editionNumber]\";"
echo "\\endverbatim\\n" echo "\\endverbatim\\n"
echo "Running the same command again we obtain a different list of files.\\n" echo "Running the same command again we obtain a different list of files.\\n"
echo "\\verbatim" echo "\\verbatim"
@ -52,7 +52,7 @@ else
fi fi
cat > rules_file <<EOF cat > rules_file <<EOF
write "../data/split/[centre:l]_[date]_[dataType:l]_[levelType].grib[editionNumber]"; write "../data/split/[centre:i]_[date]_[dataType:i]_[levelType].grib[editionNumber]";
EOF EOF
echo ">grib_filter rules_file ../data/tigge_pf_ecmwf.grib2" echo ">grib_filter rules_file ../data/tigge_pf_ecmwf.grib2"