cd3b105997
Intro
======
H5.intro.html
Major rewrite to Groups section. New Example 7 (groups).
Added TOC and requisite links.
Numbered sections.
Labelled figures and centered those that were not.
Fixed table formatting.
===========
User Guide
===========
H5.user.html
Linked in Chunking.html.
Linked in References.html.
Linked in DDL.html.
Chunking.html
Minor edits.
DDL.html
References.html
New documents.
Datatypes.html
Added "R Reference" to base name description and
"H5T_STD_ROBJ -- Reference to an entire object
in a file" to list of datatype names.
Files.html
H5Fflush
Added scope parameter.
Groups.html
Removed references to "current working group."
Removed H5Gpush, H5Gpop, and H5Gset functions.
Removed note that H5Glink and H5Gunlink were not implemented.
=================
Reference Manual
=================
RM_*.html and Tools.html
Updated Reference Manual internal cross-linking (the link
banner at the top and bottom of each page).
Changed
Returns SUCCEED (0) if successful;
otherwise FAIL (-1).
to read
Returns a non-negative value if successful;
otherwise returns a negative value.
and several derived changes where circumstances differred
only slightly.
Minor copy edits throughout.
RM_H5.html
Corrected H5open "Purpose" statement.
RM_H5A.html
Changed H5Aget_name return type to hssize_t.
RM_H5F.html
H5Fflush
Added scope parameter.
Added H5Freopen.
RM_H5Front.html
Reordered listing of interfaces to alphabetical order (H5,
H5A, H5D, ...)
Added H5I, H5R, and H5RA.
RM_H5G.html
H5Gopen
Edited "Description."
H5Gget_objinfo
Added named datatype to list of valid values for loc_id.
RM_H5I.html Identifier Interface
New section.
RM_H5P.html
Added H5Pset_fill_value and H5Pget_fill_value.
Several minor copy edits.
RM_H5R.html Reference Interface
New section.
H5RA.html
Essentially a new section. It was in the tree previously,
but it did not actually have content.
RM_H5S.html
Changed H5Sget_select_npoints return type to hssize_t.
Tools.html
Updated h5dump documentation.
291 lines
9.7 KiB
HTML
291 lines
9.7 KiB
HTML
<html>
|
|
<head><title>
|
|
HDF5/Tools Draft API Specification
|
|
</title></head>
|
|
|
|
<body>
|
|
|
|
<hr>
|
|
<center>
|
|
<a href="RM_H5Front.html">HDF5 Reference Manual</a>
|
|
<a href="RM_H5.html">H5</a>
|
|
<a href="RM_H5A.html">H5A</a>
|
|
<a href="RM_H5D.html">H5D</a>
|
|
<a href="RM_H5E.html">H5E</a>
|
|
<a href="RM_H5F.html">H5F</a>
|
|
<a href="RM_H5G.html">H5G</a>
|
|
<a href="RM_H5I.html">H5I</a>
|
|
<a href="RM_H5P.html">H5P</a>
|
|
<a href="RM_H5R.html">H5R</a>
|
|
<a href="RM_H5RA.html">H5RA</a>
|
|
<a href="RM_H5S.html">H5S</a>
|
|
<a href="RM_H5T.html">H5T</a>
|
|
<a href="RM_H5Z.html">H5Z</a>
|
|
Tools
|
|
<!--
|
|
<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>]
|
|
[-t </code><em>names</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.
|
|
<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.
|
|
<p>
|
|
The <code>-header</code> option displays object
|
|
header information only.
|
|
<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.
|
|
<p>
|
|
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.
|
|
<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
|
|
assigned by the library. The unnamed types are displayed within
|
|
the root group.
|
|
<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.
|
|
<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.
|
|
<dt><strong>Options and Parameters:</strong>
|
|
<dl>
|
|
<dt><code>-h</code>
|
|
<dd>Prints information on this command.
|
|
<dt><code>-bb</code>
|
|
<dd>Displays the contents of the 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 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><em>file</em>
|
|
<dd>The file to be examined.
|
|
</dl>
|
|
<dt><strong>Current Status:</strong>
|
|
<dd>The current version of <code>h5dump</code> displays the
|
|
following information:
|
|
<ul>
|
|
<li>Group
|
|
<ul>
|
|
<li>group attributes
|
|
<li>group member
|
|
</ul>
|
|
<li>Dataset
|
|
<ul>
|
|
<li>dataset attributes
|
|
<li>data type
|
|
<li>data space
|
|
<li>data
|
|
</ul>
|
|
<li>Data type
|
|
<ul>
|
|
<li>scalar type
|
|
<li>transient type
|
|
<li>named type
|
|
<li>unnamed type
|
|
</ul>
|
|
<li>Simple data space
|
|
<li>Soft link
|
|
<li>Hard link
|
|
</ul>
|
|
<dt><strong>See Also:</strong>
|
|
<dd>HDF5 Data Description Language syntax
|
|
(<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>
|
|
file</em><code>
|
|
[</code><em>objects...</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 file objects
|
|
in the specified format.
|
|
<dt><strong>Options and Parameters:</strong>
|
|
<dl>
|
|
<dt><code>-h</code> or <code>-?</code> or <code>--help</code>
|
|
<dd>Print a usage message and exit.
|
|
<dt><code>-d</code> or <code>--dump</code>
|
|
<dd>Print the values of datasets.
|
|
<dt><code>-w</code><em>N</em> or <code>--width=</code><em>N</em>
|
|
<dd>Set the number of columns of output.
|
|
<dt><code>-v</code> or <code>--verbose</code>
|
|
<dd>Generate more verbose output.
|
|
<dt><code>-V</code> or <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>objects</em>
|
|
<dd>The names of zero or more objects about which information
|
|
should be displayed. If a group is mentioned then
|
|
information about each of its members is displayed.
|
|
If no object names are specified then information about
|
|
all of the objects in the root group is displayed.
|
|
</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>
|
|
<a href="RM_H5.html">H5</a>
|
|
<a href="RM_H5A.html">H5A</a>
|
|
<a href="RM_H5D.html">H5D</a>
|
|
<a href="RM_H5E.html">H5E</a>
|
|
<a href="RM_H5F.html">H5F</a>
|
|
<a href="RM_H5G.html">H5G</a>
|
|
<a href="RM_H5I.html">H5I</a>
|
|
<a href="RM_H5P.html">H5P</a>
|
|
<a href="RM_H5R.html">H5R</a>
|
|
<a href="RM_H5RA.html">H5RA</a>
|
|
<a href="RM_H5S.html">H5S</a>
|
|
<a href="RM_H5T.html">H5T</a>
|
|
<a href="RM_H5Z.html">H5Z</a>
|
|
Tools
|
|
<!--
|
|
<a href="Glossary.html">Glossary</a>
|
|
-->
|
|
</center>
|
|
<hr>
|
|
|
|
<address>
|
|
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
|
|
|
|
<br>
|
|
Last modified: 27 October 1998
|
|
|
|
</body>
|
|
</html>
|