.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.39.4.
.TH H5PERF_SERIAL: "1" "August 2011" "h5perf_serial: Version 1.8.7" "User Commands"
.SH NAME
h5perf_serial: \- Measures HDF5 serial performance.
.SH DESCRIPTION
h5perf_serial: Version 1.8.7
usage: h5perf_serial [OPTIONS]
.IP
OPTIONS
.TP
\fB\-h\fR
Print an usage message and exit
.TP
\fB\-A\fR AL
Which APIs to test
[default: all of them]
.TP
\fB\-c\fR SL
Selects chunked storage and defines chunks dimensions
and sizes
[default: Off]
.TP
\fB\-e\fR SL
Dimensions and sizes of dataset
[default: 100,200]
.TP
\fB\-i\fR N
Number of iterations to perform
[default: 1]
.TP
\fB\-r\fR NL
Dimension access order (see below for description)
[default: 1,2]
.TP
\fB\-t\fR
Selects extendable dimensions for HDF5 dataset
[default: Off]
.TP
\fB\-v\fR VFD
Selects file driver for HDF5 access
[default: sec2]
.TP
\fB\-w\fR
Perform write tests, not the read tests
[default: Off]
.TP
\fB\-x\fR SL
Dimensions and sizes of the transfer buffer
[default: 10,20]
.TP
N
\- is an integer > 0.
.TP
S
\- is a size specifier, an integer > 0 followed by a size indicator:
.IP
K \- Kilobyte (1024)
M \- Megabyte (1048576)
G \- Gigabyte (1073741824)
.IP
Example: '37M' is 37 megabytes or 38797312 bytes
.IP
AL \- is an API list. Valid values are:
.IP
hdf5 \- HDF5
posix \- POSIX
.IP
Example: \fB\-A\fR posix,hdf5
.IP
NL \- is list of integers (N) separated by commas.
.IP
Example: 1,2,3
.IP
SL \- is list of size specifiers (S) separated by commas.
.IP
Example: 2K,2K,3K
.IP
The example defines an object (dataset, tranfer buffer) with three
dimensions. Be aware that as the number of dimensions increases, the
the total size of the object increases exponentially.
.TP
VFD
\- is an HDF5 file driver specifier. Valid values are:
.IP
sec2, stdio, core, split, multi, family, direct
.IP
Dimension access order:
.IP
Data access starts at the cardinal origin of the dataset using the
transfer buffer. The next access occurs on a dataset region next to
the previous one. For a multidimensional dataset, there are several
directions as to where to proceed. This can be specified in the dimension
access order. For example, \fB\-r\fR 1,2 states that the tool should traverse
dimension 1 first, and then dimension 2.
.IP
Environment variables:
.TP
HDF5_NOCLEANUP
Do not remove data files if set [default remove]
.TP
HDF5_PREFIX
Data file prefix
.PP
usage: h5perf_serial [OPTIONS]
.IP
OPTIONS
.TP
\fB\-h\fR
Print an usage message and exit
.TP
\fB\-A\fR AL
Which APIs to test
[default: all of them]
.TP
\fB\-c\fR SL
Selects chunked storage and defines chunks dimensions
and sizes
[default: Off]
.TP
\fB\-e\fR SL
Dimensions and sizes of dataset
[default: 100,200]
.TP
\fB\-i\fR N
Number of iterations to perform
[default: 1]
.TP
\fB\-r\fR NL
Dimension access order (see below for description)
[default: 1,2]
.TP
\fB\-t\fR
Selects extendable dimensions for HDF5 dataset
[default: Off]
.TP
\fB\-v\fR VFD
Selects file driver for HDF5 access
[default: sec2]
.TP
\fB\-w\fR
Perform write tests, not the read tests
[default: Off]
.TP
\fB\-x\fR SL
Dimensions and sizes of the transfer buffer
[default: 10,20]
.TP
N
\- is an integer > 0.
.TP
S
\- is a size specifier, an integer > 0 followed by a size indicator:
.IP
K \- Kilobyte (1024)
M \- Megabyte (1048576)
G \- Gigabyte (1073741824)
.IP
Example: '37M' is 37 megabytes or 38797312 bytes
.IP
AL \- is an API list. Valid values are:
.IP
hdf5 \- HDF5
posix \- POSIX
.IP
Example: \fB\-A\fR posix,hdf5
.IP
NL \- is list of integers (N) separated by commas.
.IP
Example: 1,2,3
.IP
SL \- is list of size specifiers (S) separated by commas.
.IP
Example: 2K,2K,3K
.IP
The example defines an object (dataset, tranfer buffer) with three
dimensions. Be aware that as the number of dimensions increases, the
the total size of the object increases exponentially.
.TP
VFD
\- is an HDF5 file driver specifier. Valid values are:
.IP
sec2, stdio, core, split, multi, family, direct
.IP
Dimension access order:
.IP
Data access starts at the cardinal origin of the dataset using the
transfer buffer. The next access occurs on a dataset region next to
the previous one. For a multidimensional dataset, there are several
directions as to where to proceed. This can be specified in the dimension
access order. For example, \fB\-r\fR 1,2 states that the tool should traverse
dimension 1 first, and then dimension 2.
.IP
Environment variables:
.TP
HDF5_NOCLEANUP
Do not remove data files if set [default remove]
.TP
HDF5_PREFIX
Data file prefix
.SH "SEE ALSO"
The full documentation for
.B h5perf_serial:
is maintained as a Texinfo manual.  If the
.B info
and
.B h5perf_serial:
programs are properly installed at your site, the command
.IP
.B info h5perf_serial:
.PP
should give you access to the complete manual.