From fbf2fd987f7150d051ca85a11f18d33d30570189 Mon Sep 17 00:00:00 2001 From: Bill Wendling Date: Tue, 9 Jan 2001 15:02:16 -0500 Subject: [svn-r3247] Purpose: h5dump attribute documentation. Description: Described the new flags for the H5 dumper. Platforms tested: Lynx --- doc/html/Tools.html | 254 ++++++++++++++++++++++++++++------------------------ 1 file changed, 139 insertions(+), 115 deletions(-) diff --git a/doc/html/Tools.html b/doc/html/Tools.html index 1577b09..1ad3534 100644 --- a/doc/html/Tools.html +++ b/doc/html/Tools.html @@ -77,94 +77,119 @@ These tools enable the user to examine HDF5 files interactively.
Tool Name: h5dump
Syntax:
h5dump - [-h] - [-bb] - [-header] - [-v] - [-V] - [-a names] - [-d names] - [-g names] - [-l names] - [-o fname] - [-t names] - [-w number] - - file + [OPTIONS] file
Purpose:
Displays HDF5 file contents.
Description:
h5dump enables the user to interactively examine - the contents of an HDF5 file and dump those contents, - in human readable form, to an ASCII file. + the contents of an HDF5 file and dump those contents, in human + readable form, to an ASCII file.

- h5dump displays HDF5 file content on - standard output. It may display the content of the - whole HDF5 file or selected objects, which can be groups, - datasets, links, attributes, or data types. + h5dump displays HDF5 file content on standard + output. It may display the content of the whole HDF5 file or + selected objects, which can be groups, datasets, links, + attributes, or data types. +

- The -header option displays object - header information only. + The --header option displays object header + information only. +

- Names are the absolute names of the objects. - h5dump displays objects in the order same as the - command order. If a name does not start with a slash, - h5dump begins searching for the specified object - starting at the root group. + Names are the absolute names of the objects. h5dump + displays objects in the order same as the command order. If a + name does not start with a slash, h5dump begins + searching for the specified object starting at the root group. +

- If an object is hard linked with multiple names, + If an object is hard linked with multiple names, h5dump displays the content of the object in the - first occurrence. Only the link information is displayed in - later occurrences. + first occurrence. Only the link information is displayed in later + occurrences. +

h5dump assigns a name for any unnamed data type in - the form of #oid1:oid2, - where oid1 and oid2 are the object identifiers + the form of + #oid1:oid2, where + oid1 and oid2 are the object identifiers assigned by the library. The unnamed types are displayed within the root group. +

Data types are displayed with standard type names. For example, if a data set is created with H5T_NATIVE_INT type and the standard type name for integer on that machine is H5T_STD_I32BE, h5dump displays - H5T_STD_I32BE as the type of the data set. + H5T_STD_I32BE as the type of the data set. +

- The h5dump output is described in detail in the - DDL for HDF5, the - Data Description Language document. + The h5dump output is described in detail in the DDL for HDF5, the Data + Description Language document. +

+

+ Note: It is no longer permissable to specify multiple + attributes, datasets, data types, groups, or soft links with one + flag. For example, before one could issue the command: +

+
+ h5dump -a /attr1 /attr2 foo.h5 +
+

+ and both /attr1 and /attr2 would be + dumped. In order to do this now, one must issue the command: +

+
+ h5dump -a /attr1 -a /attr2 foo.h5 +
Options and Parameters:
-
-h -
Prints information on this command and exits. -
-bb -
Displays the contents of the super block. The default is - not to display. -
- (This option is not yet implemented.) -
-header -
Displays header information only; no data is displayed. -
-v -
Displays the object ids. -
-V -
Displays version information and exits. -
-a names -
Displays the specified attribute(s). -
-d names -
Displays the specified dataset(s). -
-g names -
Displays the specified group(s) and all the members. -
-l names -
Displays the values of the specified soft link(s). -
-t names -
Displays the specified named data type(s). -
-w number -
Displays the information with the specified number of columns. -
-o filename -
Output the raw data of datasets to a separate file - filename. -
file -
The file to be examined. +
-h   or   + --help
+
Print a usage message and exit.
+
-B   or   + --bootblock
+
Print the content of the boot block.
+ (This option is not yet implemented.)
+
-H   or   + --header
+
Print the header only; no data is displayed.
+
-i   or   + --object-ids
+
Print the object ids.
+
-V   or   + --version
+
Print version number and exit.
+
-a P   or   + --attribute=P
+
Print the specified attribute.
+
-d P   or   + --dataset=P
+
Print the specified dataset.
+
-g P   or   + --group=P
+
Print the specified group and all members.
+
-l P   or   + --soft-link=P
+
Print the value(s) of the specified soft link.
+
-o P   or   + --output=F
+
Output raw data into file F.
+
-t P   or   + --datatype=T
+
Print the specified named data type.
+
-w P   or   + --width=#
+
Set the number of columns of output.
+
file
+
The file to be examined.
+
    +
  • P - is the full path from the root group to the + object.
    • +
  • T - is the name of the data type.
    • +
  • F - is a filename.
    • +
  • # - is an integer greater than 1.
    • +
Examples:
  1. Dumping the group /GroupFoo/GroupBar in the file @@ -193,51 +218,51 @@ These tools enable the user to examine HDF5 files interactively.
    The current version of h5dump displays the following information:
      -
    • Group -
        -
      • group attribute (see Attribute) -
      • group member -
      -
    • Dataset -
        -
      • dataset attribute (see Attribute) -
      • dataset type (see Data type) -
      • dataset space (see Data space) -
      • dataset data -
      -
    • Attribute -
        -
      • attribute type (see Data type) -
      • attribute space (see Data space) -
      • attribute data -
      -
    • Data type -
        -
      • integer type -
        - H5T_STD_I8BE, H5T_STD_I8LE, H5T_STD_I16BE, ... -
      • floating point type -
        - H5T_IEEE_F32BE, H5T_IEEE_F32LE, H5T_IEEE_F64BE, ... -
      • string type -
      • compound type -
        - named, unnamed and transient compound type -
        - integer, floating or string type member -
      • opaque types -
      • reference type -
        - object references -
        - data regions -
      • enum type -
      • variable-length datatypes -
        - atomic types only -
        - scalar or single dimensional array of variable-length - types supported -
      -
    • Data space -
        -
      • scalar and simple space -
      -
    • Soft link -
    • Hard link -
    • Loop detection +
    • Group +
        +
      • group attribute (see Attribute) +
      • group member +
      +
    • Dataset +
        +
      • dataset attribute (see Attribute) +
      • dataset type (see Data type) +
      • dataset space (see Data space) +
      • dataset data +
      +
    • Attribute +
        +
      • attribute type (see Data type) +
      • attribute space (see Data space) +
      • attribute data +
      +
    • Data type +
        +
      • integer type +
        - H5T_STD_I8BE, H5T_STD_I8LE, H5T_STD_I16BE, ... +
      • floating point type +
        - H5T_IEEE_F32BE, H5T_IEEE_F32LE, H5T_IEEE_F64BE, ... +
      • string type +
      • compound type +
        - named, unnamed and transient compound type +
        - integer, floating or string type member +
      • opaque types +
      • reference type +
        - object references +
        - data regions +
      • enum type +
      • variable-length datatypes +
        - atomic types only +
        - scalar or single dimensional array of variable-length + types supported +
      +
    • Data space +
        +
      • scalar and simple space +
      +
    • Soft link +
    • Hard link +
    • Loop detection
    See Also: @@ -245,15 +270,14 @@ These tools enable the user to examine HDF5 files interactively. (DDL for HDF5) -
    Tool Name: h5ls
    Syntax:
    h5ls - [options] + [OPTIONS] file - [objects...] + [OBJECTS...]
    Purpose:
    Prints information about a file or dataset.
    Description: @@ -267,7 +291,7 @@ These tools enable the user to examine HDF5 files interactively.
    Print a usage message and exit.
    -a   or   --address -
    Primt addresses for raw data. +
    Print addresses for raw data.
    -d   or   --data
    Print the values of datasets.
    -e   or   -- cgit v0.12