summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBill Wendling <wendling@ncsa.uiuc.edu>2001-01-09 20:02:16 (GMT)
committerBill Wendling <wendling@ncsa.uiuc.edu>2001-01-09 20:02:16 (GMT)
commitfbf2fd987f7150d051ca85a11f18d33d30570189 (patch)
tree935a71c4f135483b9b587a537cb83da4bfc9c205
parent4acce97e47623bb15975c9380cbf9a12e4075121 (diff)
downloadhdf5-fbf2fd987f7150d051ca85a11f18d33d30570189.zip
hdf5-fbf2fd987f7150d051ca85a11f18d33d30570189.tar.gz
hdf5-fbf2fd987f7150d051ca85a11f18d33d30570189.tar.bz2
[svn-r3247] Purpose:
h5dump attribute documentation. Description: Described the new flags for the H5 dumper. Platforms tested: Lynx
-rw-r--r--doc/html/Tools.html254
1 files 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.
<dt><strong>Tool Name:</strong> <a name="Tools-Dump">h5dump</a>
<dt><strong>Syntax:</strong>
<dd><code>h5dump
- [-h]
- [-bb]
- [-header]
- [-v]
- [-V]
- [-a </code><em>names</em><code>]
- [-d </code><em>names</em><code>]
- [-g </code><em>names</em><code>]
- [-l </code><em>names</em><code>]
- [-o </code><em>fname</em><code>]
- [-t </code><em>names</em><code>]
- [-w </code><em>number</em><code>]</code>
-
- <em>file</em>
+ [</code><em>OPTIONS</em><code>]</code> <em>file</em>
<dt><strong>Purpose:</strong>
<dd>Displays HDF5 file contents.
<dt><strong>Description:</strong>
<dd><code>h5dump</code> 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.
<p>
- <code>h5dump</code> 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.
+ <code>h5dump</code> 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.
+ </p>
<p>
- The <code>-header</code> option displays object
- header information only.
+ The <code>--header</code> option displays object header
+ information only.
+ </p>
<p>
- Names are the absolute names of the objects.
- <code>h5dump</code> displays objects in the order same as the
- command order. If a name does not start with a slash,
- <code>h5dump</code> begins searching for the specified object
- starting at the root group.
+ Names are the absolute names of the objects. <code>h5dump</code>
+ displays objects in the order same as the command order. If a
+ name does not start with a slash, <code>h5dump</code> begins
+ searching for the specified object starting at the root group.
+ </p>
<p>
- If an object is hard linked with multiple names,
+ If an object is hard linked with multiple names,
<code>h5dump</code> 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.
+ </p>
<p>
<code>h5dump</code> assigns a name for any unnamed data type in
- the form of <code>#</code><em>oid1</em><code>:</code><em>oid2</em>,
- where <em>oid1</em> and <em>oid2</em> are the object identifiers
+ the form of
+ <code>#</code><em>oid1</em><code>:</code><em>oid2</em>, where
+ <em>oid1</em> and <em>oid2</em> are the object identifiers
assigned by the library. The unnamed types are displayed within
the root group.
+ </p>
<p>
Data types are displayed with standard type names. For example,
if a data set is created with <code>H5T_NATIVE_INT</code> type
and the standard type name for integer on that machine is
<code>H5T_STD_I32BE</code>, <code>h5dump</code> displays
- <code>H5T_STD_I32BE</code> as the type of the data set.
+ <code>H5T_STD_I32BE</code> as the type of the data set.
+ </p>
<p>
- The <code>h5dump</code> output is described in detail in the
- <a href="ddl.html"><cite>DDL for HDF5</cite></a>, the
- <cite>Data Description Language</cite> document.
+ The <code>h5dump</code> output is described in detail in the <a
+ href="ddl.html"><cite>DDL for HDF5</cite></a>, the <cite>Data
+ Description Language</cite> document.
+ </p>
+ <p>
+ <em>Note</em>: 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:
+ </p>
+ <blockquote>
+ <code>h5dump -a /attr1 /attr2 foo.h5</code>
+ </blockquote>
+ <p>
+ and both <code>/attr1</code> and <code>/attr2</code> would be
+ dumped. In order to do this now, one must issue the command:
+ </p>
+ <blockquote>
+ <code>h5dump -a /attr1 -a /attr2 foo.h5</code>
+ </blockquote>
<dt><strong>Options and Parameters:</strong>
<dl>
- <dt><code>-h</code>
- <dd>Prints information on this command and exits.
- <dt><code>-bb</code>
- <dd>Displays the contents of the super block. The default is
- not to display.
- <BR>
- <em>(This option is not yet implemented.)</em>
- <dt><code>-header</code>
- <dd>Displays header information only; no data is displayed.
- <dt><code>-v</code>
- <dd>Displays the object ids.
- <dt><code>-V</code>
- <dd>Displays version information and exits.
- <dt><code>-a</code> <em>names</em>
- <dd>Displays the specified attribute(s).
- <dt><code>-d</code> <em>names</em>
- <dd>Displays the specified dataset(s).
- <dt><code>-g</code> <em>names</em>
- <dd>Displays the specified group(s) and all the members.
- <dt><code>-l</code> <em>names</em>
- <dd>Displays the values of the specified soft link(s).
- <dt><code>-t</code> <em>names</em>
- <dd>Displays the specified named data type(s).
- <dt><code>-w</code> <em>number</em>
- <dd>Displays the information with the specified number of columns.
- <dt><code>-o</code> <em>filename</em>
- <dd>Output the raw data of datasets to a separate file
- <code>filename</code>.
- <dt><em>file</em>
- <dd>The file to be examined.
+ <dt><code>-h</code> &nbsp;&nbsp;or&nbsp;&nbsp;
+ <code>--help</code></dt>
+ <dd>Print a usage message and exit.</dd>
+ <dt><code>-B</code> &nbsp;&nbsp;or&nbsp;&nbsp;
+ <code>--bootblock</code></dt>
+ <dd>Print the content of the boot block.<br>
+ <em>(This option is not yet implemented.)</em></dd>
+ <dt><code>-H</code> &nbsp;&nbsp;or&nbsp;&nbsp;
+ <code>--header</code></dt>
+ <dd>Print the header only; no data is displayed.</dd>
+ <dt><code>-i</code> &nbsp;&nbsp;or&nbsp;&nbsp;
+ <code>--object-ids</code></dt>
+ <dd>Print the object ids.</dd>
+ <dt><code>-V</code> &nbsp;&nbsp;or&nbsp;&nbsp;
+ <code>--version</code></dt>
+ <dd>Print version number and exit.</dd>
+ <dt><code>-a <em>P</em></code> &nbsp;&nbsp;or&nbsp;&nbsp;
+ <code>--attribute=<em>P<em></code></dt>
+ <dd>Print the specified attribute.</dd>
+ <dt><code>-d <em>P</em></code> &nbsp;&nbsp;or&nbsp;&nbsp;
+ <code>--dataset=<em>P<em></code></dt>
+ <dd>Print the specified dataset.</dd>
+ <dt><code>-g <em>P</em></code> &nbsp;&nbsp;or&nbsp;&nbsp;
+ <code>--group=<em>P<em></code></dt>
+ <dd>Print the specified group and all members.</dd>
+ <dt><code>-l <em>P</em></code> &nbsp;&nbsp;or&nbsp;&nbsp;
+ <code>--soft-link=<em>P<em></code></dt>
+ <dd>Print the value(s) of the specified soft link.</dd>
+ <dt><code>-o <em>P</em></code> &nbsp;&nbsp;or&nbsp;&nbsp;
+ <code>--output=<em>F<em></code></dt>
+ <dd>Output raw data into file F.</dd>
+ <dt><code>-t <em>P</em></code> &nbsp;&nbsp;or&nbsp;&nbsp;
+ <code>--datatype=<em>T<em></code></dt>
+ <dd>Print the specified named data type.</dd>
+ <dt><code>-w <em>P</em></code> &nbsp;&nbsp;or&nbsp;&nbsp;
+ <code>--width=<em>#<em></code></dt>
+ <dd>Set the number of columns of output.</dd>
+ <dt><em>file</em></dt>
+ <dd>The file to be examined.</dd>
</dl>
+ <ul>
+ <li><em>P</em> - is the full path from the root group to the
+ object.</li>
+ <li><em>T</em> - is the name of the data type.</li>
+ <li><em>F</em> - is a filename.</li>
+ <li><em>#</em> - is an integer greater than 1.</li>
+ </ul>
<dt><strong>Examples:</strong>
<ol>
<li>Dumping the group <code>/GroupFoo/GroupBar</code> in the file
@@ -193,51 +218,51 @@ These tools enable the user to examine HDF5 files interactively.
<dd>The current version of <code>h5dump</code> displays the
following information:
<ul>
- <li>Group
- <ul>
- <li>group attribute (see Attribute)
- <li>group member
- </ul>
- <li>Dataset
- <ul>
- <li>dataset attribute (see Attribute)
- <li>dataset type (see Data type)
- <li>dataset space (see Data space)
- <li>dataset data
- </ul>
- <li>Attribute
- <ul>
- <li>attribute type (see Data type)
- <li>attribute space (see Data space)
- <li>attribute data
- </ul>
- <li>Data type
- <ul>
- <li>integer type
- <dt>- H5T_STD_I8BE, H5T_STD_I8LE, H5T_STD_I16BE, ...
- <li>floating point type
- <dt>- H5T_IEEE_F32BE, H5T_IEEE_F32LE, H5T_IEEE_F64BE, ...
- <li>string type
- <li>compound type
- <dt>- named, unnamed and transient compound type
- <dt>- integer, floating or string type member
- <li>opaque types
- <li>reference type
- <dt>- object references
- <dt>- data regions
- <li>enum type
- <li>variable-length datatypes
- <dt>- atomic types only
- <dt>- scalar or single dimensional array of variable-length
- types supported
- </ul>
- <li>Data space
- <ul>
- <li>scalar and simple space
- </ul>
- <li>Soft link
- <li>Hard link
- <li>Loop detection
+ <li>Group
+ <ul>
+ <li>group attribute (see Attribute)
+ <li>group member
+ </ul>
+ <li>Dataset
+ <ul>
+ <li>dataset attribute (see Attribute)
+ <li>dataset type (see Data type)
+ <li>dataset space (see Data space)
+ <li>dataset data
+ </ul>
+ <li>Attribute
+ <ul>
+ <li>attribute type (see Data type)
+ <li>attribute space (see Data space)
+ <li>attribute data
+ </ul>
+ <li>Data type
+ <ul>
+ <li>integer type
+ <dt>- H5T_STD_I8BE, H5T_STD_I8LE, H5T_STD_I16BE, ...
+ <li>floating point type
+ <dt>- H5T_IEEE_F32BE, H5T_IEEE_F32LE, H5T_IEEE_F64BE, ...
+ <li>string type
+ <li>compound type
+ <dt>- named, unnamed and transient compound type
+ <dt>- integer, floating or string type member
+ <li>opaque types
+ <li>reference type
+ <dt>- object references
+ <dt>- data regions
+ <li>enum type
+ <li>variable-length datatypes
+ <dt>- atomic types only
+ <dt>- scalar or single dimensional array of variable-length
+ types supported
+ </ul>
+ <li>Data space
+ <ul>
+ <li>scalar and simple space
+ </ul>
+ <li>Soft link
+ <li>Hard link
+ <li>Loop detection
</ul>
<dt><strong>See Also:</strong>
@@ -245,15 +270,14 @@ These tools enable the user to examine HDF5 files interactively.
(<a href="ddl.html"><cite>DDL for HDF5</cite></a>)
</dl>
-
<hr>
<dl>
<dt><strong>Tool Name:</strong> <a name="Tools-Ls">h5ls</a>
<dt><strong>Syntax:</strong>
<dd><code>h5ls
- [</code><em>options</em><code>]</code><em>
+ [</code><em>OPTIONS</em><code>]</code><em>
file</em><code>
- [</code><em>objects...</em><code>]</code>
+ [</code><em>OBJECTS...</em><code>]</code>
<dt><strong>Purpose:</strong>
<dd>Prints information about a file or dataset.
<dt><strong>Description:</strong>
@@ -267,7 +291,7 @@ These tools enable the user to examine HDF5 files interactively.
<dd>Print a usage message and exit.
<dt><code>-a</code> &nbsp;&nbsp;or&nbsp;&nbsp;
<code>--address</code>
- <dd>Primt addresses for raw data.
+ <dd>Print addresses for raw data.
<dt><code>-d</code> &nbsp;&nbsp;or&nbsp;&nbsp; <code>--data</code>
<dd>Print the values of datasets.
<dt><code>-e</code> &nbsp;&nbsp;or&nbsp;&nbsp;