summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorFrank Baker <fbaker@hdfgroup.org>1998-09-09 19:23:06 (GMT)
committerFrank Baker <fbaker@hdfgroup.org>1998-09-09 19:23:06 (GMT)
commit2a7c272a69a84366f197c8610715d3ff1f11c37b (patch)
tree239c0f27f220e3a74f4a1cabe612aaafa5b56cbe /doc
parentba9581e64c22112c20d1d43d617fa57cad43a752 (diff)
downloadhdf5-2a7c272a69a84366f197c8610715d3ff1f11c37b.zip
hdf5-2a7c272a69a84366f197c8610715d3ff1f11c37b.tar.gz
hdf5-2a7c272a69a84366f197c8610715d3ff1f11c37b.tar.bz2
[svn-r679] User-level descriptions of the HDF5 interactive tools:
h5dump h5ls h5repart This page is accessed via the HDF5 Reference Manual (RM_H5Front.html).
Diffstat (limited to 'doc')
-rw-r--r--doc/src/Tools.html256
1 files changed, 256 insertions, 0 deletions
diff --git a/doc/src/Tools.html b/doc/src/Tools.html
new file mode 100644
index 0000000..cf89313
--- /dev/null
+++ b/doc/src/Tools.html
@@ -0,0 +1,256 @@
+<html>
+<head><title>
+HDF5/Tools Draft API Specification
+</title></head>
+
+<body>
+
+<hr>
+<center>
+<a href="RM_H5Front.html">HDF5 Reference Manual</a>&nbsp;
+<a href="RM_H5.html">H5</a>&nbsp;&nbsp;
+<a href="RM_H5A.html">H5A</a>&nbsp;&nbsp;
+<a href="RM_H5D.html">H5D</a>&nbsp;&nbsp;
+<a href="RM_H5E.html">H5E</a>&nbsp;&nbsp;
+<a href="RM_H5F.html">H5F</a>&nbsp;&nbsp;
+<a href="RM_H5G.html">H5G</a>&nbsp;&nbsp;
+<a href="RM_H5P.html">H5P</a>&nbsp;&nbsp;
+<!--
+<a href="RM_H5R.html">H5R</a>&nbsp;&nbsp;
+-->
+<a href="RM_H5S.html">H5S</a>&nbsp;&nbsp;
+<a href="RM_H5T.html">H5T</a>&nbsp;&nbsp;
+<a href="RM_H5Z.html">H5Z</a>&nbsp;&nbsp;
+Tools&nbsp;&nbsp;
+<!--
+<a href="Glossary.html">Glossary</a>
+-->
+</center>
+<hr>
+
+<center>
+<h1>HDF5 Tools</h1>
+</center>
+
+<h2>HDF5 Tool Interfaces</h2>
+<p>
+These tools enable the user to examine HDF5 files interactively.
+
+
+<table border=0>
+<tr><td valign=top>
+<ul>
+ <li><a href="#Tools-Dump">h5dump</a> -- A tool for displaying
+ HDF5 file contents
+ <li><a href="#Tools-Ls">h5ls</a> -- A tool for listing specified
+ features of HDF5 file contents
+ <li><a href="#Tools-Repart">h5repart</a> -- A tool for repartitioning
+ a file, creating a family of files
+</ul>
+</td></tr>
+</table>
+
+<p>
+
+
+<hr>
+<dl>
+<dt><strong>Tool Name:</strong> <a name="Tools-Dump">h5dump</a>
+<dt><strong>Syntax:</strong>
+ <dd><code>h5dump
+ [-h]
+ [-bb]
+ [-header]
+ [-a </code><em>names</em><code>]
+ [-d </code><em>names</em><code>]
+ [-g </code><em>names</em><code>]
+ [-l </code><em>names</em><code>] </code>
+ <em>files</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 or to other tools.
+ <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, or attributes.
+ <p>
+ The <code>-header</code> option displays object
+ header information only and must appear before the
+ <code>-a</code>, <code>-d</code>, <code>-g</code>, or
+ <code>-l</code> options.
+ <p>
+ The <code>h5dump</code> output is described in detail in
+ <a href="ddl.html">DDL</a>, the <cite>Data Description
+ Language</cite> document.
+<dt><strong>Options and Parameters:</strong>
+ <dl>
+ <dt><code>-h</code>
+ <dd>Print information on this command.
+ <dt><code>-bb</code>
+ <dd>Displays the content of boot block. The default is
+ not to display.
+ <dt><code>-header</code>
+ <dd>Displays header information only; no data is displayed.
+ <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 all the objects within the specified group(s).
+ <dt><code>-l</code> <em>names</em>
+ <dd>Displays the specified link value(s).
+ <dt><em>files</em>
+ <dd>The file(s) to be examined.
+ </dl>
+<dt><strong>Current Status:</strong>
+ <dd>The current version of <code>h5dump</code> can display the
+ following types of information:
+ <ul>
+ <li>Group name
+ <li>Attribute name, data type, adata space, and data
+ <li>Dataset name, data type, data space, and data
+ <li>Soft link name, link value
+ </ul>
+
+ <dd>Limitions in the current implementaion include the
+ following:
+ <ul>
+ <li>Only one file is displayed at a time (file families are
+ not supported).
+ <li>The whole file content is displayed (none of above
+ options are supported).
+ <li>Compound data types are not yet supported.
+ <li>Complex data spaces are not yet supported.
+ </ul>
+<dt><strong>See Also:</strong>
+ <dd>HDF5 Data Description Language syntax
+ (<a href="ddl.html">DDL</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>
+ file</em><code>
+ [</code><em>group</em><code>]</code>
+<dt><strong>Purpose:</strong>
+ <dd>Prints information about a file or dataset.
+<dt><strong>Description:</strong>
+ <dd><code>h5ls</code> prints selected information about a file
+ or dataset in the specified format.
+<dt><strong>Options and Parameters:</strong>
+ <dl>
+ <dt><code>-h</code> &nbsp;&nbsp;or&nbsp;&nbsp; <code>-?</code> &nbsp;&nbsp;or&nbsp;&nbsp; <code>--help</code>
+ <dd>Print a usage message and exit.
+ <dt><code>-d</code> &nbsp;&nbsp;or&nbsp;&nbsp; <code>--dump</code>
+ <dd>Print the values of datasets.
+ <dt><code>-w</code><em>N</em> &nbsp;&nbsp;or&nbsp;&nbsp; <code>--width=</code><em>N</em>
+ <dd>Set the number of columns of output.
+ <dt><code>-v</code> &nbsp;&nbsp;or&nbsp;&nbsp; <code>--verbose</code>
+ <dd>Generate more verbose output.
+ <dt><code>-V</code> &nbsp;&nbsp;or&nbsp;&nbsp; <code>--version</code>
+ <dd>Print version number and exit.
+ <dt><em>file</em>
+ <dd>The file name may include a printf(3C) integer format
+ such as <code>%%05d</code> to open a file family.
+ <dt><em>group</em>
+ <dd>If a group name is not specified then the contents of
+ the root group, /, are displayed.
+
+ <dt><code> </code>
+ <dd>
+ <dt><code> </code>
+ <dd>
+ </dl>
+<dt><strong>Current Status:</strong>
+ <dd>
+<dt><strong>See Also:</strong>
+ <dd>
+</dl>
+
+
+<hr>
+<dl>
+<dt><strong>Tool Name:</strong> <a name="Tools-Repart">h5repart</a>
+<dt><strong>Syntax:</strong>
+ <dd><code>h5repart
+ [-v]
+ [-V]
+ [-[b|m]</code><em>N</em><code>[g|m|k]]</code>
+ <em>source_file
+ dest_file</em>
+<dt><strong>Purpose:</strong>
+ <dd>Repartitions a file or family of files.
+<dt><strong>Description:</strong>
+ <dd><code>h5repart</code> splits a single file into a family of
+ files, joins a family of files into a single file, or copies
+ one family of files to another while changing the size of the
+ family members. <code>h5repart</code> can also be used to
+ copy a single file to a single file with holes.
+ <p>
+ Sizes associated with the <code>-b</code> and <code>-m</code>
+ options may be suffixed with <code>g</code> for gigabytes,
+ <code>m</code> for megabytes, or <code>k</code> for kilobytes.
+ <p>
+ File family names include an integer <code>printf</code>
+ format such as <code>%%d</code>.
+<dt><strong>Options and Parameters:</strong>
+ <dl>
+ <dt><code>-v</code>
+ <dd>Produce verbose output.
+ <dt><code>-V</code>
+ <dd>Print a version number and exit.
+ <dt><code>-b</code><em>N</em>
+ <dd>The I/O block size, defaults to 1kB
+ <dt><code>-m</code><em>N</em>
+ <dd>The destination member size or 1GB
+ <dt><em>source_file</em>
+ <dd>The name of the source file
+ <dt><em>dest_file</em>
+ <dd>The name of the destination files
+ </dl>
+<dt><strong>Current Status:</strong>
+ <dd>
+<dt><strong>See Also:</strong>
+ <dd>
+</dl>
+
+
+<hr>
+<center>
+<a href="RM_H5Front.html">HDF5 Reference Manual</a>&nbsp;
+<a href="RM_H5.html">H5</a>&nbsp;&nbsp;
+<a href="RM_H5A.html">H5A</a>&nbsp;&nbsp;
+<a href="RM_H5D.html">H5D</a>&nbsp;&nbsp;
+<a href="RM_H5E.html">H5E</a>&nbsp;&nbsp;
+<a href="RM_H5F.html">H5F</a>&nbsp;&nbsp;
+<a href="RM_H5G.html">H5G</a>&nbsp;&nbsp;
+<a href="RM_H5P.html">H5P</a>&nbsp;&nbsp;
+<!--
+<a href="RM_H5R.html">H5R</a>&nbsp;&nbsp;
+-->
+<a href="RM_H5S.html">H5S</a>&nbsp;&nbsp;
+<a href="RM_H5T.html">H5T</a>&nbsp;&nbsp;
+<a href="RM_H5Z.html">H5Z</a>&nbsp;&nbsp;
+Tools&nbsp;&nbsp;
+<!--
+<a href="Glossary.html">Glossary</a>
+-->
+</center>
+<hr>
+
+<address>
+<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
+
+<br>
+Last modified: 9 September 1998
+
+</body>
+</html>