summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPedro Vicente Nunes <pvn@hdfgroup.org>2007-10-02 19:54:36 (GMT)
committerPedro Vicente Nunes <pvn@hdfgroup.org>2007-10-02 19:54:36 (GMT)
commitfa94f16ad894ccbd3ab5b3a7a0f9bf74c6ea4d9e (patch)
treea86d757a4208a465f81d62b7ebad1356ad200eb0
parentb2b63b3c75e14e55a4243751a5f22e8fbdbefb3e (diff)
downloadhdf5-fa94f16ad894ccbd3ab5b3a7a0f9bf74c6ea4d9e.zip
hdf5-fa94f16ad894ccbd3ab5b3a7a0f9bf74c6ea4d9e.tar.gz
hdf5-fa94f16ad894ccbd3ab5b3a7a0f9bf74c6ea4d9e.tar.bz2
[svn-r14174] new h5dump usage to include -q and -z
tested: windows, linux, solaris 5.10 usage: h5dump [OPTIONS] file OPTIONS -h, --help Print a usage message and exit -n, --contents Print a list of the file contents and exit -B, --bootblock Print the content of the boot block -H, --header Print the header only; no data is displayed -A, --onlyattr Print the header and value of attributes -i, --object-ids Print the object ids -r, --string Print 1-byte integer datasets as ASCII -e, --escape Escape non printing characters -V, --version Print version number and exit -a P, --attribute=P Print the specified attribute -d P, --dataset=P Print the specified dataset -y, --noindex Do not print array indices with the data -p, --properties Print dataset filters, storage layout and fill value -f D, --filedriver=D Specify which driver to open the file with -g P, --group=P Print the specified group and all members -l P, --soft-link=P Print the value(s) of the specified soft link -o F, --output=F Output raw data into file F -b B, --binary=B Binary file output, of form B -t P, --datatype=P Print the specified named datatype -w N, --width=N Set the number of columns of output -q Q, --sort_by=Q Sort groups and attributes by index Q -z Z, --sort_order=Z Sort groups and attributes by order Z -x, --xml Output in XML using Schema -u, --use-dtd Output in XML using DTD -D U, --xml-dtd=U Use the DTD or schema at U -X S, --xml-ns=S (XML Schema) Use qualified names n the XML ":": no namespace, default: "hdf5:" E.g., to dump a file called `-f', use h5dump -- -f Subsetting is available by using the following options with a dataset attribute. Subsetting is done by selecting a hyperslab from the data. Thus, the options mirror those for performing a hyperslab selection. The START and COUNT parameters are mandatory if you do subsetting. The STRIDE and BLOCK parameters are optional and will default to 1 in each dimension. -s L, --start=L Offset of start of subsetting selection -S L, --stride=L Hyperslab stride -c L, --count=L Number of blocks to include in selection -k L, --block=L Size of block in hyperslab D - is the file driver to use in opening the file. Acceptable values are "sec2", "family", "split", "multi", "direct", and "stream". Without the file driver flag, the file will be opened with each driver in turn and in the order specified above until one driver succeeds in opening the file. F - is a filename. P - is the full path from the root group to the object. N - is an integer greater than 1. L - is a list of integers the number of which are equal to the number of dimensions in the dataspace being queried U - is a URI reference (as defined in [IETF RFC 2396], updated by [IETF RFC 2732]) B - is the form of binary output: MEMORY for a memory type, FILE for the file type, LE or BE for pre-existing little or big endian types. Must be used with -o (output file) and it is recommended that -d (dataset) is used Q - is the sort index type. It can be "creation_order" or "name" (default) Z - is the sort order type. It can be "descending" or "ascending" (default) Examples: 1) Attribute foo of the group /bar_none in file quux.h5 h5dump -a /bar_none/foo quux.h5 2) Selecting a subset from dataset /foo in file quux.h5 h5dump -d /foo -s "0,1" -S "1,1" -c "2,3" -k "2,2" quux.h5 3) Saving dataset 'dset' in file quux.h5 to binary file 'out.bin' using a litt le-endian type h5dump -d /dset -b LE -o out.bin quux.h5
-rw-r--r--tools/h5dump/h5dump.c16
-rw-r--r--tools/testfiles/tnofilename.ddl16
2 files changed, 20 insertions, 12 deletions
diff --git a/tools/h5dump/h5dump.c b/tools/h5dump/h5dump.c
index d3e4bdd..bceb4be 100644
--- a/tools/h5dump/h5dump.c
+++ b/tools/h5dump/h5dump.c
@@ -609,8 +609,7 @@ usage(const char *prog)
fprintf(stdout, " -n, --contents Print a list of the file contents and exit\n");
fprintf(stdout, " -B, --bootblock Print the content of the boot block\n");
fprintf(stdout, " -H, --header Print the header only; no data is displayed\n");
- fprintf(stdout, " -A, --onlyattr Print the header and value of attributes; data \n");
- fprintf(stdout, " of datasets is not displayed\n");
+ fprintf(stdout, " -A, --onlyattr Print the header and value of attributes\n");
fprintf(stdout, " -i, --object-ids Print the object ids\n");
fprintf(stdout, " -r, --string Print 1-byte integer datasets as ASCII\n");
fprintf(stdout, " -e, --escape Escape non printing characters\n");
@@ -623,12 +622,11 @@ usage(const char *prog)
fprintf(stdout, " -g P, --group=P Print the specified group and all members\n");
fprintf(stdout, " -l P, --soft-link=P Print the value(s) of the specified soft link\n");
fprintf(stdout, " -o F, --output=F Output raw data into file F\n");
- fprintf(stdout, " -b B, --binary=B Binary file output, of form B. Recommended usage is\n");
- fprintf(stdout, " with -o (output file) and -d (dataset). B can be:\n");
- fprintf(stdout, " MEMORY for a memory type, FILE for the file type,\n");
- fprintf(stdout, " LE or BE for pre-existing little or big endian types\n");
+ fprintf(stdout, " -b B, --binary=B Binary file output, of form B\n");
fprintf(stdout, " -t P, --datatype=P Print the specified named datatype\n");
fprintf(stdout, " -w N, --width=N Set the number of columns of output\n");
+ fprintf(stdout, " -q Q, --sort_by=Q Sort groups and attributes by index Q\n");
+ fprintf(stdout, " -z Z, --sort_order=Z Sort groups and attributes by order Z\n");
fprintf(stdout, " -x, --xml Output in XML using Schema\n");
fprintf(stdout, " -u, --use-dtd Output in XML using DTD\n");
fprintf(stdout, " -D U, --xml-dtd=U Use the DTD or schema at U\n");
@@ -660,6 +658,12 @@ usage(const char *prog)
fprintf(stdout, " number of dimensions in the dataspace being queried\n");
fprintf(stdout, " U - is a URI reference (as defined in [IETF RFC 2396],\n");
fprintf(stdout, " updated by [IETF RFC 2732])\n");
+ fprintf(stdout, " B - is the form of binary output: MEMORY for a memory type, FILE for the\n");
+ fprintf(stdout, " file type, LE or BE for pre-existing little or big endian types.\n");
+ fprintf(stdout, " Must be used with -o (output file) and it is recommended that\n");
+ fprintf(stdout, " -d (dataset) is used\n");
+ fprintf(stdout, " Q - is the sort index type. It can be \"creation_order\" or \"name\" (default)\n");
+ fprintf(stdout, " Z - is the sort order type. It can be \"descending\" or \"ascending\" (default)\n");
fprintf(stdout, "\n");
fprintf(stdout, " Examples:\n");
fprintf(stdout, "\n");
diff --git a/tools/testfiles/tnofilename.ddl b/tools/testfiles/tnofilename.ddl
index 9eb9f88..a3625bf 100644
--- a/tools/testfiles/tnofilename.ddl
+++ b/tools/testfiles/tnofilename.ddl
@@ -7,8 +7,7 @@ usage: h5dump [OPTIONS] file
-n, --contents Print a list of the file contents and exit
-B, --bootblock Print the content of the boot block
-H, --header Print the header only; no data is displayed
- -A, --onlyattr Print the header and value of attributes; data
- of datasets is not displayed
+ -A, --onlyattr Print the header and value of attributes
-i, --object-ids Print the object ids
-r, --string Print 1-byte integer datasets as ASCII
-e, --escape Escape non printing characters
@@ -21,12 +20,11 @@ usage: h5dump [OPTIONS] file
-g P, --group=P Print the specified group and all members
-l P, --soft-link=P Print the value(s) of the specified soft link
-o F, --output=F Output raw data into file F
- -b B, --binary=B Binary file output, of form B. Recommended usage is
- with -o (output file) and -d (dataset). B can be:
- MEMORY for a memory type, FILE for the file type,
- LE or BE for pre-existing little or big endian types
+ -b B, --binary=B Binary file output, of form B
-t P, --datatype=P Print the specified named datatype
-w N, --width=N Set the number of columns of output
+ -q Q, --sort_by=Q Sort groups and attributes by index Q
+ -z Z, --sort_order=Z Sort groups and attributes by order Z
-x, --xml Output in XML using Schema
-u, --use-dtd Output in XML using DTD
-D U, --xml-dtd=U Use the DTD or schema at U
@@ -58,6 +56,12 @@ usage: h5dump [OPTIONS] file
number of dimensions in the dataspace being queried
U - is a URI reference (as defined in [IETF RFC 2396],
updated by [IETF RFC 2732])
+ B - is the form of binary output: MEMORY for a memory type, FILE for the
+ file type, LE or BE for pre-existing little or big endian types.
+ Must be used with -o (output file) and it is recommended that
+ -d (dataset) is used
+ Q - is the sort index type. It can be "creation_order" or "name" (default)
+ Z - is the sort order type. It can be "descending" or "ascending" (default)
Examples: