1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
|
<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>
|
