mirrors/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2026-09-25 04:09:44 +03:00
Code Issues Packages Projects Releases Wiki Activity

Fix display of '--' options in documentation (#6318)

Browse Source 
* Fix display of '--' options in documentation

* Fix more formatting
This commit is contained in:
jhendersonHDF
2026-03-30 10:49:23 -05:00
committed by GitHub
parent 3494822b95
commit 8f960cae4b
18 changed files with 462 additions and 448 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doxygen/dox/AppDbgging.dox
+8 -7
View File
@@ -49,19 +49,20 @@ The error handling package (H5E) is described elsewhere.
\section sec_adddbg_invars Invariant Conditions
To include checks for invariant conditions the library should be configured
with --disable-production, the default for versions before 1.2. The library
designers have made every attempt to handle error conditions gracefully but
an invariant condition assertion may fail in certain cases. The output from
a failure usually looks something like this:
with <code>\--disable-production</code>, the default for versions before 1.2.
The library designers have made every attempt to handle error conditions
gracefully but an invariant condition assertion may fail in certain cases.
The output from a failure usually looks something like this:
\code
Assertion failed: H5.c:123: i<NELMTS(H5_debug_g)
IOT Trap, core dumped.
\endcode
\section sec_adddbg_stats Timings and Statistics
Code to accumulate statistics is included at compile time by using the --enable-debug
configure switch. The switch can be followed by an equal sign and a comma-separated
list of package names or else a default list is used.
Code to accumulate statistics is included at compile time by using the
<code>\--enable-debug</code> configure switch. The switch can be followed by
an equal sign and a comma-separated list of package names or else a default
list is used.
<table>
<tr>
<th><strong>Name</strong>
doxygen/dox/ViewTools.dox
+21 -21
View File
@@ -183,7 +183,7 @@ The \ref sec_cltools_h5dump and \ref sec_cltools_h5ls tools can both be used to
The \ref sec_cltools_h5dump tool dumps or displays the contents of an HDF5 file (textually). By default if you specify no options,
\ref sec_cltools_h5dump will display the entire contents of a file. There are many \ref sec_cltools_h5dump options for examining specific details
of a file. To see all of the available \ref sec_cltools_h5dump options, specify the <code style="background-color:whitesmoke;">-h</code>
or <code style="background-color:whitesmoke;">--help</code> option:
or <code style="background-color:whitesmoke;">\--help</code> option:
\code
h5dump -h
\endcode
@@ -196,27 +196,27 @@ The following \ref sec_cltools_h5dump options can be helpful in viewing the cont
<th>Comment</th>
</tr>
<tr>
<td>-n, --contents</td>
<td>-n, \--contents</td>
<td>Displays a list of the objects in a file</td>
<td>See @ref subsubsecViewToolsViewContent_h5dumpEx1</td>
</tr>
<tr>
<td>-n 1, --contents=1</td>
<td>-n 1, \--contents=1</td>
<td>Displays a list of the objects and attributes in a file</td>
<td>See @ref subsubsecViewToolsViewAttr_h5dumpEx6</td>
</tr>
<tr>
<td>-H, --header</td>
<td>-H, \--header</td>
<td>Displays header information only (no data)</td>
<td>See @ref subsubsecViewToolsViewContent_h5dumpEx2</td>
</tr>
<tr>
<td>-A 0, --onlyattr=0</td>
<td>-A 0, \--onlyattr=0</td>
<td>Suppresses the display of attributes</td>
<td>See @ref subsubsecViewToolsViewContent_h5dumpEx2</td>
</tr>
<tr>
<td>-N P, --any_path=P</td>
<td>-N P, \--any_path=P</td>
<td>Displays any object or attribute that matches path P</td>
<td>See @ref subsubsecViewToolsViewAttr_h5dumpEx6</td>
</tr>
@@ -376,7 +376,7 @@ Useful \ref sec_cltools_h5dump options for examining specific datasets include:
<th>Comment</th>
</tr>
<tr>
<td>-d D, --dataset=D
<td>-d D, \--dataset=D
</td>
<td>Displays dataset D
</td>
@@ -384,7 +384,7 @@ Useful \ref sec_cltools_h5dump options for examining specific datasets include:
</td>
</tr>
<tr>
<td> -H, --header
<td> -H, \--header
</td>
<td>Displays header information only
</td>
@@ -392,7 +392,7 @@ Useful \ref sec_cltools_h5dump options for examining specific datasets include:
</td>
</tr>
<tr>
<td>-p, --properties
<td>-p, \--properties
</td>
<td>Displays dataset filters, storage layout, and fill value properties
</td>
@@ -400,7 +400,7 @@ Useful \ref sec_cltools_h5dump options for examining specific datasets include:
</td>
</tr>
<tr>
<td>-A 0, --onlyattr=0
<td>-A 0, \--onlyattr=0
</td>
<td>Suppresses the display of attributes
</td>
@@ -408,7 +408,7 @@ Useful \ref sec_cltools_h5dump options for examining specific datasets include:
</td>
</tr>
<tr>
<td>-N P, --any_path=P
<td>-N P, \--any_path=P
</td>
<td>Displays any object or attribute that matches path P
</td>
@@ -509,14 +509,14 @@ The following options can be used to see detailed information about a dataset.
<th>Description</th>
</tr>
<tr>
<td>-v, --verbose
<td>-v, \--verbose
</td>
<td>Generates verbose output (lists dataset properties, attributes
and attribute values, but no dataset values)
</td>
</tr>
<tr>
<td>-d, --data
<td>-d, \--data
</td>
<td>Displays dataset values
</td>
@@ -557,19 +557,19 @@ The <code style="background-color:whitesmoke;">\ref sec_cltools_h5dump</code> op
<th>Description</th>
</tr>
<tr>
<td>-g G, --group=G
<td>-g G, \--group=G
</td>
<td>Displays group G and its members
</td>
</tr>
<tr>
<td>-H, --header
<td>-H, \--header
</td>
<td>Displays header information only
</td>
</tr>
<tr>
<td>-A 0, --onlyattr=0
<td>-A 0, \--onlyattr=0
</td>
<td>Suppresses the display of attributes
</td>
@@ -754,19 +754,19 @@ This can be done with the following <code style="background-color:whitesmoke;">\
<th>Description</th>
</tr>
<tr>
<td>-d D, --dataset=D
<td>-d D, \--dataset=D
</td>
<td>Dataset D
</td>
</tr>
<tr>
<td>-s START, --start=START
<td>-s START, \--start=START
</td>
<td>Offset or start of subsetting selection
</td>
</tr>
<tr>
<td>-S STRIDE, --stride=STRIDE
<td>-S STRIDE, \--stride=STRIDE
</td>
<td>Stride (sampling along a dimension). The default (unspecified, or 1) selects
every element along a dimension, a value of 2 selects every other element,
@@ -774,13 +774,13 @@ a value of 3 selects every third element, ...
</td>
</tr>
<tr>
<td>-c COUNT, --count=COUNT
<td>-c COUNT, \--count=COUNT
</td>
<td>Number of blocks to include in the selection
</td>
</tr>
<tr>
<td>-k BLOCK, --block=BLOCK
<td>-k BLOCK, \--block=BLOCK
</td>
<td>Size of the block in a hyperslab. The default (unspecified, or 1) is for
the block size to be the size of a single element.
doxygen/dox/ViewTools2.dox
+17 -17
View File
@@ -154,7 +154,7 @@ the filter and parameters specified. If objects are specified, then everything i
be written to the output file as is, except for the specified objects. They will be written to the
output file with the filter and parameters specified.
If you type <code style="background-color:whitesmoke;">h5repack --help</code> on the command line,
If you type <code style="background-color:whitesmoke;">h5repack \--help</code> on the command line,
you will see a detailed usage statement with examples of modifying a filter. There are actually
numerous filters that you can apply to a dataset:
<table>
@@ -278,43 +278,43 @@ Following are some of the options that can be used with <code style="background-
<th>h5copy Options</th><th>Description</th>
</tr>
<tr>
<td>-i, --input
<td>-i, \--input
</td>
<td>Input file name
</td>
</tr>
<tr>
<td>-o, --output
<td>-o, \--output
</td>
<td>Output file name
</td>
</tr>
<tr>
<td>-s, --source
<td>-s, \--source
</td>
<td>Source object name
</td>
</tr>
<tr>
<td>-d, --destination
<td>-d, \--destination
</td>
<td>Destination object name
</td>
</tr>
<tr>
<td>-p, --parents
<td>-p, \--parents
</td>
<td>Make parent groups as needed
</td>
</tr>
<tr>
<td>-v, --verbose
<td>-v, \--verbose
</td>
<td>Verbose mode
</td>
</tr>
<tr>
<td>-f, --flag
<td>-f, \--flag
</td>
<td>Flag type
</td>
@@ -491,25 +491,25 @@ into an ASCII file, which can then be imported into Excel and other applications
<th>Options</th><th>Description</th>
</tr>
<tr>
<td> -d D, --dataset=D
<td> -d D, \--dataset=D
</td>
<td>Display dataset D
</td>
</tr>
<tr>
<td> -o F, --output=F
<td> -o F, \--output=F
</td>
<td>Output raw data into file F
</td>
</tr>
<tr>
<td> -y, --noindex
<td> -y, \--noindex
</td>
<td>Suppress printing of array indices with the data
</td>
</tr>
<tr>
<td> -w N, --width=N
<td> -w N, \--width=N
</td>
<td>Set N number of columns of output. A value of 0
sets the number to 65535 (the maximum)
@@ -586,19 +586,19 @@ HDF5 dataset to a binary file with the following options:
<th>Options</th><th>Description</th>
</tr>
<tr>
<td>-d D, --dataset=D
<td>-d D, \--dataset=D
</td>
<td>Display dataset D
</td>
</tr>
<tr>
<td>-o F, --output=F
<td>-o F, \--output=F
</td>
<td>Output raw data into file F
</td>
</tr>
<tr>
<td>-b B, --binary=B
<td>-b B, \--binary=B
</td>
<td>Binary file output of form B.
Valid values are: LE, BE, NATIVE, FILE
@@ -677,7 +677,7 @@ The DDL file must be generated with the <code style="background-color:whitesmoke
The raw data file that can be imported into HDF5 using this method may contain either numeric or string data with the following restrictions:
\li Numeric data requires the use of the <code style="background-color:whitesmoke;">h5dump -b</code> option to produce a binary data file.
\li String data must be written with the <code style="background-color:whitesmoke;">h5dump -y</code> and
<code style="background-color:whitesmoke;">--width=1</code> options, generating a single column of strings without indices.
<code style="background-color:whitesmoke;">\--width=1</code> options, generating a single column of strings without indices.
Two examples follow: the first imports a dataset with a numeric datatype. Note that numeric data requires
the use of the <code style="background-color:whitesmoke;">h5dump -b</code> option to produce a binary data
@@ -730,7 +730,7 @@ The second example imports string data. The example program that creates this fi
from the \ref ExAPI page.
Note that string data requires use of the <code style="background-color:whitesmoke;">h5dump -y</code>
option to exclude indexes and the <code style="background-color:whitesmoke;">h5dump --width=1</code>
option to exclude indexes and the <code style="background-color:whitesmoke;">h5dump \--width=1</code>
option to generate a single column of strings. The <code style="background-color:whitesmoke;">-o</code>
option outputs the data into an ASCII file.
\code
doxygen/dox/ViewToolsJPSS.dox
+6 -6
View File
@@ -174,7 +174,7 @@ that can help with this:
<tr>
<td>@ref sec_cltools_h5dump
</td>
<td>The -B (--superblock) option displays the size of the user block in an HDF5 file
<td>The -B (\--superblock) option displays the size of the user block in an HDF5 file
</td>
</tr>
</table>
@@ -202,7 +202,7 @@ The <code style="background-color:whitesmoke;">UB.xml</code> file contains the u
which can be viewed with a browser.
\subsection subsecViewToolsJPSSView_h5dump h5dump
The \ref sec_cltools_h5dump utility has the <code style="background-color:whitesmoke;">-B (--superblock)</code> option for displaying the superblock in an HDF5 file.
The \ref sec_cltools_h5dump utility has the <code style="background-color:whitesmoke;">-B (\--superblock)</code> option for displaying the superblock in an HDF5 file.
The superblock contains information about the file such as the file signature, file consistency flags,
the number of bytes to store addresses and size of an object, as well as the size of the user block:
\code
@@ -255,25 +255,25 @@ There are several options that you may first want to use when examining a granul
<th>Option</th><th>Description</th>
</tr>
<tr>
<td>-H, --header
<td>-H, \--header
</td>
<td>Prints header (metadata) information only
</td>
</tr>
<tr>
<td>-d D, --dataset=D
<td>-d D, \--dataset=D
</td>
<td>Specifies the granule dataset
</td>
</tr>
<tr>
<td>-A 0, --onlyattr=0
<td>-A 0, \--onlyattr=0
</td>
<td>Suppresses attributes
</td>
</tr>
<tr>
<td>-p, --properties
<td>-p, \--properties
</td>
<td>Show properties of datasets
(See Properties)
doxygen/dox/hdf5_1_12.dox
+2 -2
View File
@@ -31,8 +31,8 @@ example, a 1.10 application can be built with 1.12 using either an application o
<ul><li>Autotools: <code>h5cc -DH5_USE_110_API (C)</code></li>
<li>CMake: <code>cmake -DCMAKE_C_FLAGS="-DH5_USE_110_API"</code> (and likewise for other <code>CMAKE_<LANG>_FLAGS</code>)</li></ul>
\li To build an HDF5 library with the 1.10 APIs specify:<br />
<ul><li>Autotools: <code>--with-default-api-version=v110</code><br />
execute: <code>./configure --with-default-api-version=v110</code></li>
<ul><li>Autotools: <code>\--with-default-api-version=v110</code><br />
execute: <code>./configure \--with-default-api-version=v110</code></li>
<li>CMake: <code>-DDEFAULT_API_VERSION:STRING=v110</code><br />
If using the source code packaged with CMake configuration files (CMake-hdf5-1.12.0*), edit HDF5options.cmake, and add this line:<br />
<code>set(ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DDEFAULT_API_VERSION:STRING=v110")</code></li></ul>
doxygen/dox/hdf5_1_8.dox
+90 -90
View File
@@ -296,13 +296,13 @@ The following wrappers were added to the class H5::ObjCreatPropList for the resp
the build systems used with HDF5.
The new unsupported declaration will cause an Autotools configure step to fail if
<code>--enable-threadsafe</code> and <code>--enable-hl</code> are combined unless additional options
<code>\--enable-threadsafe</code> and <code>\--enable-hl</code> are combined unless additional options
are specified (see below). Since the high-level library is built by default, this means that these
extra configuration options will need to be used any time <code>--enable-threadsafe</code> is selected.
extra configuration options will need to be used any time <code>\--enable-threadsafe</code> is selected.
To use Autotools to build an application with --enable-threadsafe, use one of the following approaches:
\li Use <code>--disable-h</code>l to disable the high-level library. (Recommended)
\li Use <code>--enable-unsupported</code> to build the high-level library with the thread-safety feature.
To use Autotools to build an application with <code>\--enable-threadsafe</code>, use one of the following approaches:
\li Use <code>\--disable-hl</code> to disable the high-level library. (Recommended)
\li Use <code>\--enable-unsupported</code> to build the high-level library with the thread-safety feature.
To use CMake to build an application with HDF5_ENABLE_THREADSAFE=ON, use one of the following approaches:
\li Use <code>HDF5_BUILD_HL_LIB=OFF</code> to disable the high-level library. (Recommended)
@@ -593,8 +593,8 @@ Also see \ref subsubsec_rel_spec_18_change_13_build below.
\subsubsection subsubsec_rel_spec_18_change_13_build Build and Configuration
<h4>Thread safety</h4>
When configuring a thread-safe HDF5 Library with <code>--enable-threadsafe</code>, it is no longer
necessary to specify <code>--with-pthreads</code> if the Pthreads library is in a standard location.
When configuring a thread-safe HDF5 Library with <code>\--enable-threadsafe</code>, it is no longer
necessary to specify <code>\--with-pthreads</code> if the Pthreads library is in a standard location.
<h4>Removed Functions and Wrappers</h4>
The MPI-POSIX driver has been removed. The following C functions and the corresponding
@@ -678,39 +678,39 @@ have changed to
\ref sec_cltools_h5dump has a new option for identifying objects by a full or partial path:
\li <code>-NP</code>
\li <code>--any-path=P</code>
\li <code>\--any-path=P</code>
The \ref sec_cltools_h5dump attributes-only option, <code>-A or --only-attr</code>, now accepts an optional parameter value of 0 (zero):
The \ref sec_cltools_h5dump attributes-only option, <code>-A or \--only-attr</code>, now accepts an optional parameter value of 0 (zero):
\li <code>-A 0</code>
\li <code>--only-attr=0</code>
\li <code>\--only-attr=0</code>
Specifying this value has the effect of reversing the role of the option to display everything except attributes.
\ref sec_cltools_h5repack
The \ref sec_cltools_h5repack option <code>-f, --filter</code> has a new parameter, UD, to enable the use of user-defined filters:
The \ref sec_cltools_h5repack option <code>-f, \--filter</code> has a new parameter, UD, to enable the use of user-defined filters:
\li <code>-f UD=\<filter_parameters\></code>
\li <code>--filter=UD=\<filter_parameters\></code>
\li <code>\--filter=UD=\<filter_parameters\></code>
\ref sec_cltools_h5stat
\ref sec_cltools_h5stat has three new options for setting print thresholds:
For attributes:
\li <code>-aN</code>
\li <code>--attribute=N</code>
\li <code>\--attribute=N</code>
For links in a group:
\li <code>-lN</code>
\li <code>--links=N</code>
\li <code>\--links=N</code>
For dimension sizes:
\li <code>-mN</code>
\li <code>--dims=N</code>
\li <code>\--dims=N</code>
\subsubsection subsubsec_rel_spec_18_change_12_build Build and Configuration
<h4>CMake and Autotools configuration</h4>
A new configuration option can be used to change the default plugin path:
\li Autotools configure option <code>--with-default-plugindir=location</code>
\li Autotools configure option <code>\--with-default-plugindir=location</code>
\li CMake option -DH5_DEFAULT_PLUGINDIR:PATH=location
CMake configuration
@@ -725,14 +725,14 @@ Compile Scripts with Changed Behavior
\li h5fc and h5pfc
These compile scripts have been modified to change the default behavior to link to shared libraries
in environments where HDF5 has been configured with <code>--disable-static</code>.
in environments where HDF5 has been configured with <code>\--disable-static</code>.
Command-line Tools with Changed Behavior
\ref sec_cltools_h5dump
\ref sec_cltools_h5dump output now displays USER_DEFINED_FILTER where it previously displayed UNKNOWN_FILTER.
\ref sec_cltools_h5dump now correctly exports subsetted data to a file using the <code>-o, --output</code> option.
\ref sec_cltools_h5dump now correctly exports subsetted data to a file using the <code>-o, \--output</code> option.
\subsection subsec_rel_spec_18_change_11 Release 1.8.11 of May 2013 versus Release 1.8.10
This section lists interface-level changes and other user-visible changes in behavior in the
@@ -780,7 +780,7 @@ See HDF5 \ref subsubsec_dataset_transfer_dyn_filter for further information.
\ref sec_cltools_h5dump has a new option to output the DDL structure of a file or object:
\li <code>-O\<filename\></code>
\li <code>--ddl=\<file_name\></code>
\li <code>\--ddl=\<file_name\></code>
[-O above is dash-uppercase-o.]
\ref sec_cltools_h5import can now take the output of <code>h5dump -O\<ddl_filename\> -o\<data_filename\></code>
@@ -807,7 +807,7 @@ The return value of the following high-level C function has changed:
a unique extra attribute attached to an object as a difference and returns with an exit code of 1.
Previously, \ref sec_cltools_h5diff did not recognize the extra attribute as a difference.
\ref sec_cltools_h5ls - The content of the <code>h5ls --help</code> output has been revised.
\ref sec_cltools_h5ls - The content of the <code>h5ls \--help</code> output has been revised.
\ref sec_cltools_h5dump - has been updated to display the compression ratio for user-defined filters.
In \ref sec_cltools_h5dump output, UNKNOWN_FILTER has been changed to USER_DEFINED_FILTER.
@@ -910,15 +910,15 @@ The content of the buffer returned by the following Fortran subroutine has chang
<h4>Command-line Utilities with New Options and/or Changed Behavior</h4>
\ref sec_cltools_h5repack has one new option and improved performance under certain circumstances:
\li <code>-Mn, --metadata_block_size=n</code> Sets the metadata block size in the output
\li <code>-Mn, \--metadata_block_size=n</code> Sets the metadata block size in the output
file. Performance is improved when repacking large chunked datasets (for example, when
dataset size exceeds 128 MB).
\ref sec_cltools_h5stat has one new option:
\li <code>-S, --summary</code> Displays a summary of file space usage for a file.
\li <code>-S, \--summary</code> Displays a summary of file space usage for a file.
\ref sec_cltools_h5dump has one new option, a new capability, and updated output:
\li <code>--no-compact-subset</code> Disables compact subsetting to allow the left-hand
\li <code>\--no-compact-subset</code> Disables compact subsetting to allow the left-hand
square bracket character ( <code>[</code> ) in a dataset name.
\li The files parameter now accommodates wildcards. With this change, \ref sec_cltools_h5dump
command-line options can be applied across multiple files without listing the files individually.
@@ -950,9 +950,9 @@ Features enabled in this upgrade are described in New Features in the HDF5 Fortr
Terminology:
\li If the Fortran compiler in use is Fortran 2003 compliant and the installed HDF5 Library was configured
using both the <code>--enable-fortran</code> and <code>--enable-fortran2003</code> flags, the resulting
using both the <code>\--enable-fortran</code> and <code>\--enable-fortran2003</code> flags, the resulting
HDF5 Fortran Library is referred to below as a Fortran 2003 environment. Without either of the Fortran
2003 compliant compiler or the <code>--enable-fortran2003</code> flag, the resulting HDF5 Fortran Library
2003 compliant compiler or the <code>\--enable-fortran2003</code> flag, the resulting HDF5 Fortran Library
is referred to below as a Fortran 90 environment.
<h4>New Fortran 2003-only subroutines</h4>
@@ -1045,7 +1045,7 @@ New default driver:
\li \ref sec_cltools_h5jam now checks the file that is to be inserted into the user block and
does not allow the insertion if it is an HDF5 file. This is necessary because an HDF5 file
in the user block will make the original HDF5 portion of the file inaccessible.
\li \ref sec_cltools_h5diff with the <code>--delta</code> option reports two NaN values as equal regardless
\li \ref sec_cltools_h5diff with the <code>\--delta</code> option reports two NaN values as equal regardless
of the type of NaN (as described in the reference manual entry).
\li \ref sec_cltools_h5diff, when comparing a file to itself, now reports no differences.
@@ -1053,13 +1053,13 @@ New default driver:
configure now uses the same flags and symbols in its tests as are used to build the library.
To build HDF5 with the Fortran 2003 interfaces requires the use of two configure options:
\li <code>--enable-fortran</code>
\li <code>--enable-fortran2003</code>
\li <code>\--enable-fortran</code>
\li <code>\--enable-fortran2003</code>
Note that building the Fortran 2003 interfaces requires a Fortran 2003-capable compiler
and that <code>--enable-fortran2003</code> cannot be used alone.
and that <code>\--enable-fortran2003</code> cannot be used alone.
The <code>--enable-h5dump-packed-bits</code> configure option has been removed. The code that
The <code>\--enable-h5dump-packed-bits</code> configure option has been removed. The code that
this option enabled is now always compiled into \ref sec_cltools_h5dump.
When building on Linux systems, the HDF5 Library now links with the bsd_compat library.
@@ -1135,14 +1135,14 @@ been limited to three dimensions.
<h4>Command-line Utilities with New Options</h4>
\ref sec_cltools_h5diff has a new verbose with levels option to display additional attribute information:
\li <code>-vn, --verbose=n</code>
\li <code>-vn, \--verbose=n</code>
\ref sec_cltools_h5dump has one new option to enable reporting of the HDF5 Library's error stack:
\li <code>--enable-error-stack</code>
\li <code>\--enable-error-stack</code>
<h4>Command-line Utility with Changed Option Name</h4>
\ref sec_cltools_h5ls has one changed option name:
\li <code>--enable-error-stack replaces --error.</code>. The --error option is deprecated but remains available.
\li <code>\--enable-error-stack</code> replaces <code>\--error</code>. The <code>\--error</code> option is deprecated but remains available.
<h4>Command-line Utilities with Changed Behavior</h4>
Attribute comparison with \ref sec_cltools_h5diff has been corrected to compare all attributes with common
@@ -1150,7 +1150,7 @@ names when comparing objects. Previously, \ref sec_cltools_h5diff compared attri
two objects had the same number of attributes and all attribute names were identical; if there was either
a value or name difference between two attributes, subsequent attributes were not compared.
\ref sec_cltools_h5diff <code>--use-system-epsilon</code> now employs the formula <code>'|a - b|'</code> instead of <code>'|a - b| / b'</code>.
\ref sec_cltools_h5diff <code>\--use-system-epsilon</code> now employs the formula <code>'|a - b|'</code> instead of <code>'|a - b| / b'</code>.
\ref sec_cltools_h5copy now accepts the same file as the source and target file; this enables object copying within a file.
@@ -1162,20 +1162,20 @@ a value or name difference between two attributes, subsequent attributes were no
Configure now generates Makefiles that build in silent make mode by default. In this mode,
compile and link lines are significantly simplified for clarity. You can opt out of this
default with either of the following approaches:
\li Use the <code>--disable-silent-rules flag</code> at configure time to override the default and view actual
\li Use the <code>\--disable-silent-rules</code> flag at configure time to override the default and view actual
compile and link lines during the build.
\li Use the make command with the <code>V=1</code> option to run a verbose make.
The new configure option <code>--enable-unsupported</code> can be used to stop configure from preventing
The new configure option <code>\--enable-unsupported</code> can be used to stop configure from preventing
the use of unsupported configure option combinations. For example, use of this option enables building
HDF5 with the unsupported and untested configurations of C++ in a parallel environment or Fortran
with a threadsafe library.
<code>WARNING: Use --enable-unsupported at your own risk! This option may result in a library that does not
<code>WARNING: Use \--enable-unsupported at your own risk! This option may result in a library that does not
compile or does not run as expected.</code>
<h4>Parallel HDF5</h4>
mpicc and mpif90 are now the default C and Fortran compilers on Linux systems when
<code>--enable-parallel</code> is specified but no $CC or $FC is defined.
<code>\--enable-parallel</code> is specified but no $CC or $FC is defined.
\subsection subsec_rel_spec_18_change_6 Release 1.8.6 versus Release 1.8.5, February 2011
This section lists interface-level changes and other user-visible changes in behavior in the
@@ -1194,11 +1194,11 @@ not all of the same endianness.
<h4>Command-line Utilities with New Options</h4>
\ref sec_cltools_h5diff has one new option:
\li <code>--exclude-path</code>
\li <code>\--exclude-path</code>
\ref sec_cltools_h5ls and \ref sec_cltools_h5diff have two new options:
\li <code>--follow-symlinks</code>
\li <code>--no-dangling-links</code>
\li <code>\--follow-symlinks</code>
\li <code>\--no-dangling-links</code>
<h4>Command-line Utilities with Changed Behavior</h4>
\li \ref sec_cltools_h5diff now compares member objects and groups recursively when
@@ -1276,8 +1276,8 @@ The overloaded forms of the following C++ member functions are new in this relea
<h4>Command-line Utility with New Options</h4>
\ref sec_cltools_h5diff has two new options:
\li <code>--follow-links</code>
\li <code>--no-dangling-links</code>
\li <code>\--follow-links</code>
\li <code>\--no-dangling-links</code>
<h4>Fortran Subroutines with Changed Interface</h4>
The link type parameter values associated with the following Fortran subroutines have changed in this release:
@@ -1311,7 +1311,7 @@ Library settings are now embedded in an HDF5 executable so that an "orphaned" ex
queried (via the Unix strings command, for example) to display the library settings used to build
it. The embedded settings information is the same as that normally found in the libhdf5.settings file.
This capability may be disabled with the use of the <code>--disable-embedded-libinfo</code> flag during configure.
This capability may be disabled with the use of the <code>\--disable-embedded-libinfo</code> flag during configure.
\subsubsection subsubsec_rel_spec_18_change_4_new New and Changed Functions
<h4>New Fortran Subroutine and Constant</h4>
@@ -1342,7 +1342,7 @@ The following Fortran subroutines have changed syntax in this release:
<h4>Tools with Changed Interface or Behavior</h4>
\ref sec_cltools_h5diff has one new option:
\li <code>--use-system-epsilon</code> - With this option, \ref sec_cltools_h5diff returns a difference
\li <code>\--use-system-epsilon</code> - With this option, \ref sec_cltools_h5diff returns a difference
if and only if the difference between two data values exceeds the system value for epsilon
(that is, if <code>|a-b| > epsilon</code>).<br />
The tool's default behavior has also changed; without this option, the tool now checks for strict
@@ -1350,7 +1350,7 @@ The following Fortran subroutines have changed syntax in this release:
This option has no short form.
\ref sec_cltools_h5dump has one new option and the behavior of another set of options has changed:<br />
\li <code>-R or --region</code> - With this option, \ref sec_cltools_h5dump prints the data pointed to
\li <code>-R or \--region</code> - With this option, \ref sec_cltools_h5dump prints the data pointed to
by a region reference. Without this option, \ref sec_cltools_h5dump prints only the reference.
Usage of the subsetting parameters has changed. All of <code>START</code>, <code>STRIDE</code>,
@@ -1359,7 +1359,7 @@ Usage of the subsetting parameters has changed. All of <code>START</code>, <code
<h4>Changed Library Configuration</h4>
The following configuration flag is new with this release:
\li <code>--disable-embedded-libinfo</code> - This flag disables the embedding of HDF5 Library settings in an HDF5 executable.
\li <code>\--disable-embedded-libinfo</code> - This flag disables the embedding of HDF5 Library settings in an HDF5 executable.
\subsection subsec_rel_spec_18_change_3 Release 1.8.3 versus Release 1.8.2, May 2009
This section lists API-level changes and changes in behavior in the transition from HDF5 Release 1.8.2 to Release 1.8.3.
@@ -1394,18 +1394,18 @@ While the API has not changed, users may see both a performance boost and increa
<h4>Tools with Changed Interface or Behavior</h4>
\ref sec_cltools_h5diff default behavior is now to detect and compare NaNs. Use the
<code>-N</code> or <code>--nan</code> option (below) to turn this behavior off and avoid the
<code>-N</code> or <code>\--nan</code> option (below) to turn this behavior off and avoid the
performance penalty that NaN detection and comparison entalis. (NaN detection and comparison
became the default in in HDF5 Release 1.6.8.)
This tool has two new options:
\li <code>-c, --compare</code> Lists objects that are not comparable.
\li <code>-N, --nan</code> Avoids NaNs detection.
\li <code>-c, \--compare</code> Lists objects that are not comparable.
\li <code>-N, \--nan</code> Avoids NaNs detection.
\ref sec_cltools_h5dump now correctly specifies an XML DTD or a schema URL.
\ref sec_cltools_h5dump binary output now defaults to NATIVE.
\li The new <code>-b, --binary</code> option can be used to specify alternate binary formats.
\li The new <code>-b, \--binary</code> option can be used to specify alternate binary formats.
\ref sec_cltools_h5repack - When a user does not specify a chunk size, \ref sec_cltools_h5repack
now defines the default chunk size to be the same same as the size of the hyperslab used to read the chunks.
@@ -1456,16 +1456,16 @@ The optional parameter mounted has been added to the following subroutines:
In each case, the old syntax remains available (though undocumented) to avoid breaking existing scripts.
\ref sec_cltools_h5repack - The following new options control the addition of user block data to an existing HDF5 file:
\li <code>-u U, --ublock=U</code> - Specifies the name of the file containing the user block data to be added.
\li <code>-b B, --block=B</code> - Specifies the size of the block to be added.
\li <code>-u U, \--ublock=U</code> - Specifies the name of the file containing the user block data to be added.
\li <code>-b B, \--block=B</code> - Specifies the size of the block to be added.
The following new options set parameters governing the tool's use of H5Pset_alignment:
\li <code>-t T, --threshold=T</code> - Specifies the threshold value for H5Pset_alignment.
\li <code>-a A, --alignment=A</code> - Specifies the alignment value for H5Pset_alignment.
\li <code>-t T, \--threshold=T</code> - Specifies the threshold value for H5Pset_alignment.
\li <code>-a A, \--alignment=A</code> - Specifies the alignment value for H5Pset_alignment.
\ref sec_cltools_h5repack
\li now supports multiple instances of the <code>'-f'</code> or
<code>'--filter'</code> option, allowing the use of multiple I/O filters with an object.
<code>'\--filter'</code> option, allowing the use of multiple I/O filters with an object.
\li With no change in the command-line syntax, \ref sec_cltools_h5repack now retains an existing
userblock when repacking an HDF5 file.
@@ -1482,7 +1482,7 @@ The following new options set parameters governing the tool's use of H5Pset_alig
\ref sec_cltools_h5dump
\li Binary output now defaults to NATIVE with the <code>'-b'</code> option, optionally
accepting NATIVE, FILE, BE, and LE.
\li The new <code>'-m T'</code> or <code>'--format T'</code> option enables a user-defined formatting string
\li The new <code>'-m T'</code> or <code>'\--format T'</code> option enables a user-defined formatting string
for printing floating-point numbers.
With no change in the command-line syntax, \ref sec_cltools_h5dump now prints a compression ratio when
@@ -1499,12 +1499,12 @@ The file libhdf5_fortran.settings is no longer installed with the HDF5 Library;
<h4>Changed Library Configuration</h4>
It is no longer necessary to manually set an SZIP library path in LD_LIBRARY_PATH when building HDF5
with shared SZIP libraries; configure will determine the correct path from the <code>--with-szlib</code> flag,
with shared SZIP libraries; configure will determine the correct path from the <code>\--with-szlib</code> flag,
prepending it to and exporting LD_LIBRARY_PATH.
Note that if an SZIP library path is set in a user-supplied LD_LIBRARY_PATH, in an existing script,
for example, that does not necessarily need to be changed; configure will prepend the SZIP library
path extracted from <code>--with-szlib</code> to the user-supplied LD_LIBRARY_PATH.
path extracted from <code>\--with-szlib</code> to the user-supplied LD_LIBRARY_PATH.
\subsection subsec_rel_spec_18_change_1 Release 1.8.1 versus Release 1.8.0
HDF5 Release 1.8.1 is a minor release with several bugfixes and optimizations and limited new features.
@@ -1668,19 +1668,19 @@ to:
An \ref sec_cltools_h5repack option to set the minimum number of links in indexed format was introduced
in Release 1.8.0 as:
\li <code>-d min_indexed_links</code>
\li <code>--indexed=min_indexed_links</code>.
\li <code>\--indexed=min_indexed_links</code>.
In Release 1.8.1,
the <code>-i</code> form has been changed to <code>-d</code> as follows:
\li <code>-d min_indexed_links</code>
\li <code>--indexed=min_indexed_links</code>
\li <code>\--indexed=min_indexed_links</code>
The command-line syntax of \ref sec_cltools_h5diff was changed in Release 1.8.0 to the following:
\li <code>h5diff [OPTIONS] file1 file2 [object1 [object2 ] ]</code>
<strong>Tools with new options</strong>
\ref sec_cltools_h5dump
\li <code>-m T</code> or <code>--format T</code> - Sets format of floating point output
\li <code>-m T</code> or <code>\--format T</code> - Sets format of floating point output
<h4>Changed Behavior or Output</h4>
Changed library behavior:
@@ -1698,7 +1698,7 @@ Tools with changed behavior and changed output:
\subsubsection subsubsec_rel_spec_18_change_1_config Changed Library Configuration
The following configuration flag is new with this release:
\li <code>--disable-sharedlib-rpath</code>
\li <code>\--disable-sharedlib-rpath</code>
\subsubsection subsubsec_rel_spec_18_change_1_patch Removed Patch Requirement
The patch that was required for Cygwin with HDF5 Release 1.8.0 has been rolled into this
@@ -2097,7 +2097,7 @@ Several functions, subroutines, and wrappers are deprecated in this HDF5 release
eventually be removed from the HDF5 distribution and from the HDF5 Reference Manual.
A Release 1.6.x compatibility mode is provided enabling these and other Release 1.6.x
compatibility features, but is available only if the HDF5 Library is configured with the
default settings or with the flag <code>--with-default-api-version=v16</code>. Release 1.8.0 also provides
default settings or with the flag <code>\--with-default-api-version=v16</code>. Release 1.8.0 also provides
macros that can be mapped selectively to 1.6.x and 1.8.0 function versions according to the
needs of a user application. The backward compatibility mode is enabled in the Release 1.8.0
binaries distributed by NCSA. See \ref api-compat-macros for full details.
@@ -2273,41 +2273,41 @@ The following property lists are new with this release:
The following configuration features have changed as follows.
New with this release:
\li <code>--disable-dependency-tracking</code>
\li <code>--enable-hdf5v1_6</code>
\li <code> --enable-dconv-exception</code>
\li <code>--disable-dconv-exception</code>
\li <code>--enable-dconv-accuracy</code>
\li <code>--disable-dconv-accuracy</code>
\li <code>--program-prefix=PREFIX</code>
\li <code>--program-prefix=SUFFIX</code>
\li <code>--program-transform-name=PROGRAM</code>
\li <code>--enable-maintainer-mode</code>
\li <code>--disable-dependency-tracking</code>
\li <code>--enable-dependency-tracking</code>
\li <code>--enable-codestack</code>
\li <code>--enable-direct-vfd</code>
\li <code>--with-tags[=TAGS]</code>
\li <code>\--disable-dependency-tracking</code>
\li <code>\--enable-hdf5v1_6</code>
\li <code>\--enable-dconv-exception</code>
\li <code>\--disable-dconv-exception</code>
\li <code>\--enable-dconv-accuracy</code>
\li <code>\--disable-dconv-accuracy</code>
\li <code>\--program-prefix=PREFIX</code>
\li <code>\--program-prefix=SUFFIX</code>
\li <code>\--program-transform-name=PROGRAM</code>
\li <code>\--enable-maintainer-mode</code>
\li <code>\--disable-dependency-tracking</code>
\li <code>\--enable-dependency-tracking</code>
\li <code>\--enable-codestack</code>
\li <code>\--enable-direct-vfd</code>
\li <code>\--with-tags[=TAGS]</code>
New with this release, but expected to be useful only to those working inside the HDF5 Library
or working very closely with HDF5 developers:
\li <code>--enable-build-all</code>
\li <code>--enable-metadata-trace-file</code>
\li <code>\--enable-build-all</code>
\li <code>\--enable-metadata-trace-file</code>
New with this release, but not actively supported:
\li <code>--enable-fphdf5</code>
\li <code>\--enable-fphdf5</code>
Changed in this release:
\li <code>--enable-shared[=PKGS]</code>
\li <code>--enable-static[=PKGS]</code>
\li <code>--enable-fast-install[=PKGS]</code>
\li <code>\--enable-shared[=PKGS]</code>
\li <code>\--enable-static[=PKGS]</code>
\li <code>\--enable-fast-install[=PKGS]</code>
Removed in this release:
\li <code>--enable-hdf5v1_4</code>
\li <code>--enable-funcstack</code>
\li <code>--with-ssl=LIB</code>
\li <code>--with-gass=DIR</code>
\li <code>--with-srb=DIR</code>
\li <code>\--enable-hdf5v1_4</code>
\li <code>\--enable-funcstack</code>
\li <code>\--with-ssl=LIB</code>
\li <code>\--with-gass=DIR</code>
\li <code>\--with-srb=DIR</code>
The environment variables, which are deprecated in this release.
\li FC replaces F9X
doxygen/dox/sw_changes_1.10.dox
+5 -5
View File
@@ -303,12 +303,12 @@ See the Release.txt file for details.
<h4>Tools</h4>
New options were added to the \ref sec_cltools_h5clear utility:
\li <code>--filesize</code> - Print the file's EOA and EOF
\li <code>--increment=C</code> - Set the file's EOA to the maximum of <code>(EOA, EOF) + C</code>
\li <code>\--filesize</code> - Print the file's EOA and EOF
\li <code>\--increment=C</code> - Set the file's EOA to the maximum of <code>(EOA, EOF) + C</code>
for the file <code>C is >= 0</code>; C is optional and will default to 1M when not set
A new option was added to \ref sec_cltools_h5diff
\li <code>--enable-error-stack</code> - Enable the error stack
\li <code>\--enable-error-stack</code> - Enable the error stack
\subsection subsec_rel_spec_110_change_2versus1_compat Compatibility Notes and Report
@@ -578,7 +578,7 @@ The existing version will be deprecated in a future release.
\li Integration into Main HDF5 Library - The Java HDF5 JNI library has been integrated into the HDF5 repository.
<strong>Configure option:</strong>
\li <code>--enable-java</code>
\li <code>\--enable-java</code>
<strong>CMake option:</strong>
\li <code>-DHDF5_BUILD_JAVA:BOOL=ON</code>
@@ -605,7 +605,7 @@ See \ref api-compat-macros for details on the following.
<h4>New API Compatibility Flag</h4>
A new v18 flag was added enabling the building of HDF5 such that the default API is compatible
with the HDF5 Release 1.8.x API:
\li <code>--with-default-api-version=v18</code>
\li <code>\--with-default-api-version=v18</code>
<h4>New versioned functions and associated compatibility macros</h4>
Two functions and a struct have been converted to a versioned form in this release.
hl/tools/h5watch/h5watch.h
+10 -10
View File
@@ -26,22 +26,22 @@
* <h4>h5watch [OPTIONS] [OBJECT]</h4>
*
* \subsection subsec_cltools_h5watch_error Error Report Option
* \li <strong>--enable-error-stack</strong> Prints messages from the HDF5 error stack as they occur.
* Optional value 2 also prints file open errors, --enable-error-stack=2.
* \li <strong>\--enable-error-stack</strong> Prints messages from the HDF5 error stack as they occur.
* Optional value 2 also prints file open errors, <code>\--enable-error-stack=2</code>.
*
* \subsection subsec_cltools_h5watch_options Options
* \li <strong>--help</strong> Print a usage message and exit
* \li <strong>--version</strong> Print the library version number and exit
* \li <strong>--label</strong> Label members of compound typed dataset.
* \li <strong>--simple</strong> Use a machine-readable output format.
* \li <strong>--dim</strong> Monitor changes in size of dataset dimensions only.
* \li <strong>--width=N</strong> Set the number of columns to N for output.<br />
* \li <strong>\--help</strong> Print a usage message and exit
* \li <strong>\--version</strong> Print the library version number and exit
* \li <strong>\--label</strong> Label members of compound typed dataset.
* \li <strong>\--simple</strong> Use a machine-readable output format.
* \li <strong>\--dim</strong> Monitor changes in size of dataset dimensions only.
* \li <strong>\--width=N</strong> Set the number of columns to N for output.<br />
* A value of 0 sets the number of columns to the
* maximum (65535). The default width is 80 columns.
* \li <strong>--polling=N</strong> Set the polling interval to N (in seconds) when the
* \li <strong>\--polling=N</strong> Set the polling interval to N (in seconds) when the
* dataset will be checked for appended data.
* The default polling interval is 1.
* \li <strong>--fields=\<list_of_fields\></strong>
* \li <strong>\--fields=\<list_of_fields\></strong>
* Display data for the fields specified in \<list_of_fields\>
* for a compound data type.
* \<list_of_fields\> can be specified as follows:
tools/src/h5copy/h5copy.h
+11 -11
View File
@@ -27,21 +27,21 @@
* <h4>h5copy [OPTIONS] [OBJECTS...]</h4>
*
* \subsection subsec_cltools_h5copy_objs Objects
* \li <strong>--input</strong> input file name
* \li <strong>--output</strong> output file name
* \li <strong>--source</strong> source object name
* \li <strong>--destination</strong> destination object name
* \li <strong>\--input</strong> input file name
* \li <strong>\--output</strong> output file name
* \li <strong>\--source</strong> source object name
* \li <strong>\--destination</strong> destination object name
*
* \subsection subsec_cltools_h5copy_error Error Report Option
* \li <strong>--enable-error-stack</strong> Prints messages from the HDF5 error stack as they occur.
Optional value 2 also prints file open errors, --enable-error-stack=2.
* \li <strong>\--enable-error-stack</strong> Prints messages from the HDF5 error stack as they occur.
* Optional value 2 also prints file open errors, <code>\--enable-error-stack=2</code>.
*
* \subsection subsec_cltools_h5copy_options Options
* \li <strong>--help</strong> Print a usage message and exit
* \li <strong>--parents</strong> No error if existing, make parent groups as needed
* \li <strong>--verbose</strong> Print information about OBJECTS and OPTIONS
* \li <strong>--version</strong> Print the library version number and exit
* \li <strong>--flag</strong> Flag type
* \li <strong>\--help</strong> Print a usage message and exit
* \li <strong>\--parents</strong> No error if existing, make parent groups as needed
* \li <strong>\--verbose</strong> Print information about OBJECTS and OPTIONS
* \li <strong>\--version</strong> Print the library version number and exit
* \li <strong>\--flag</strong> Flag type
*
* \subsubsection subsubsec_cltools_h5copy_options_args Flag Type Options
* Flag type is one of the following strings:
tools/src/h5diff/h5diff_main.h
+63 -59
View File
@@ -31,50 +31,50 @@
* \li <strong>[obj2]</strong> Name of an HDF5 object, in absolute path
*
* \subsection subsec_cltools_h5diff_error Error Report
* \li <strong>--enable-error-stack</strong> Prints messages from the HDF5 error stack as they occur.
* Optional value 2 also prints file open errors, --enable-error-stack=2.
* \li <strong>\--enable-error-stack</strong> Prints messages from the HDF5 error stack as they occur.
* Optional value 2 also prints file open errors, <code>\--enable-error-stack=2</code>.
*
* \subsection subsec_cltools_h5diff_options Options
* \li <strong>--help</strong> Print a usage message and exit.
* \li <strong>--version</strong> Print the library version number and exit.
* \li <strong>--report</strong> Report mode. Print differences.
* \li <strong>--verbose</strong> Verbose mode. Print differences information and list of objects.
* \li <strong>--verbose=N</strong> Verbose mode with level. Print differences and list of objects.
* \li <strong>\--help</strong> Print a usage message and exit.
* \li <strong>\--version</strong> Print the library version number and exit.
* \li <strong>\--report</strong> Report mode. Print differences.
* \li <strong>\--verbose</strong> Verbose mode. Print differences information and list of objects.
* \li <strong>\--verbose=N</strong> Verbose mode with level. Print differences and list of objects.
* Level of detail depends on value of N:
* <ul><li> <strong>0</strong> Identical to '-v' or '--verbose'.</li>
* <ul><li> <strong>0</strong> Identical to '-v' or '\--verbose'.</li>
* <li> <strong>1</strong> All level 0 information plus one-line attribute status summary.</li>
* <li> <strong>2</strong> All level 1 information plus extended attribute status report.</li>
* <li> <strong>3</strong> All level 2 information plus file names.</li></ul>
* \li <strong>--quiet</strong> Quiet mode. Do not produce output.
* \li <strong>--page-buffer-size=N</strong> Set the page buffer cache size, N=non-negative integers
* \li <strong>--vol-value-1</strong> Value (ID) of the VOL connector to use for opening the
* \li <strong>\--quiet</strong> Quiet mode. Do not produce output.
* \li <strong>\--page-buffer-size=N</strong> Set the page buffer cache size, N=non-negative integers
* \li <strong>\--vol-value-1</strong> Value (ID) of the VOL connector to use for opening the
* first HDF5 file specified
* \li <strong>--vol-name-1</strong> Name of the VOL connector to use for opening the first
* \li <strong>\--vol-name-1</strong> Name of the VOL connector to use for opening the first
* HDF5 file specified
* \li <strong>--vol-info-1</strong> VOL-specific info to pass to the VOL connector used for
* \li <strong>\--vol-info-1</strong> VOL-specific info to pass to the VOL connector used for
* opening the first HDF5 file specified
* \li <strong>--vol-value-2</strong> Value (ID) of the VOL connector to use for opening the
* \li <strong>\--vol-value-2</strong> Value (ID) of the VOL connector to use for opening the
* second HDF5 file specified
* \li <strong>--vol-name-2</strong> Name of the VOL connector to use for opening the second
* \li <strong>\--vol-name-2</strong> Name of the VOL connector to use for opening the second
* HDF5 file specified
* \li <strong>--vol-info-2</strong> VOL-specific info to pass to the VOL connector used for
* \li <strong>\--vol-info-2</strong> VOL-specific info to pass to the VOL connector used for
* opening the second HDF5 file specified.<br />
* If none of the above options are used to specify a VOL for a file, then
* the VOL named by HDF5_VOL_CONNECTOR (or the native VOL connector,
* if that environment variable is unset) will be used
* \li <strong>--vfd-value-1</strong> Value (ID) of the VFL driver to use for opening the
* \li <strong>\--vfd-value-1</strong> Value (ID) of the VFL driver to use for opening the
* first HDF5 file specified
* \li <strong>--vfd-name-1</strong> Name of the VFL driver to use for opening the first
* \li <strong>\--vfd-name-1</strong> Name of the VFL driver to use for opening the first
* HDF5 file specified
* \li <strong>--vfd-info-1 </strong> VFD-specific info to pass to the VFL driver used for
* \li <strong>\--vfd-info-1 </strong> VFD-specific info to pass to the VFL driver used for
* opening the first HDF5 file specified
* \li <strong>--vfd-value-2 </strong> Value (ID) of the VFL driver to use for opening the
* \li <strong>\--vfd-value-2 </strong> Value (ID) of the VFL driver to use for opening the
* second HDF5 file specified
* \li <strong>--vfd-name-2</strong> Name of the VFL driver to use for opening the second
* \li <strong>\--vfd-name-2</strong> Name of the VFL driver to use for opening the second
* HDF5 file specified
* \li <strong>--vfd-info-2</strong> VFD-specific info to pass to the VFL driver used for
* \li <strong>\--vfd-info-2</strong> VFD-specific info to pass to the VFL driver used for
* opening the second HDF5 file specified
* \li <strong>--follow-symlinks</strong>
* \li <strong>\--follow-symlinks</strong>
* Follow symbolic links (soft links and external links) and compare the
* links' target objects.<br />
* If symbolic link(s) with the same name exist in the files being
@@ -82,63 +82,67 @@
* object (dataset, group, or named datatype) or the link is a dangling
* link (a soft or external link pointing to a target object that does
* not yet exist).
* <ul><li> If both symbolic links are dangling links, they are treated as being
* the same; by default, h5diff returns an exit code of 0.
* If, however, --no-dangling-links is used with --follow-symlinks,
* this situation is treated as an error and h5diff returns an
* exit code of 2.</li>
* <li> If only one of the two links is a dangling link,they are treated as
* being different and h5diff returns an exit code of 1.
* If, however, --no-dangling-links is used with --follow-symlinks,
* this situation is treated as an error and h5diff returns an
* exit code of 2.</li>
* <li> If both symbolic links point to existing objects, h5diff compares the
* two objects.</li></ul>
* If any symbolic link specified in the call to h5diff does not exist,
* h5diff treats it as an error and returns an exit code of 2.
* \li <strong>--no-dangling-links</strong>
* Must be used with <strong>--follow-symlinks</strong> option; otherwise, h5diff shows
* error message and returns an exit code of 2.<br />
* Check for any symbolic links (soft links or external links) that do not
* resolve to an existing object (dataset, group, or named datatype).
* If any dangling link is found, this situation is treated as an error
* and h5diff returns an exit code of 2.
* \li <strong>--compare</strong> List objects that are not comparable
* \li <strong>--nan</strong> Avoid NaNs detection
* \li <strong>--count=C</strong> Print differences up to \b C. \b C must be a positive integer.
* \li <strong>--delta=D</strong>
* <ul>
* <li> If both symbolic links are dangling links, they are treated as being
* the same; by default, h5diff returns an exit code of 0.
* If, however, <strong>\--no-dangling-links</strong> is used with
* <strong>\--follow-symlinks</strong>, this situation is treated as an error
* and h5diff returns an exit code of 2.
* </li>
* <li> If only one of the two links is a dangling link, they are treated as being
* different and h5diff returns an exit code of 1. If, however,
* <strong>\--no-dangling-links</strong> is used with
* <strong>\--follow-symlinks</strong>, this situation is treated as an error
* and h5diff returns an exit code of 2.
* </li>
* <li> If both symbolic links point to existing objects, h5diff compares the two
* objects.
* </li>
* </ul>
* If any symbolic link specified in the call to h5diff does not exist, h5diff treats
* it as an error and returns an exit code of 2.
* \li <strong>\--no-dangling-links</strong>
* Must be used with <strong>\--follow-symlinks</strong> option; otherwise, h5diff
* shows error message and returns an exit code of 2.<br />
* Check for any symbolic links (soft links or external links) that do not resolve to
* an existing object (dataset, group, or named datatype). If any dangling link is found,
* this situation is treated as an error and h5diff returns an exit code of 2.
* \li <strong>\--compare</strong> List objects that are not comparable
* \li <strong>\--nan</strong> Avoid NaNs detection
* \li <strong>\--count=C</strong> Print differences up to \b C. \b C must be a positive integer.
* \li <strong>\--delta=D</strong>
* Print difference if (<strong>|a-b| > D</strong>). \b D must be a positive number, where \b a
* is the data point value in file1 and b is the data point value in file2.
* Can not use with '--relative' or '--use-system-epsilon'.
* \li <strong>--relative=R</strong>
* Can not use with '\--relative' or '\--use-system-epsilon'.
* \li <strong>\--relative=R</strong>
* Print difference if (<strong>|(a-b)/b| > R</strong>). \b R must be a positive number, where \b a
* is the data point value in file1 and \b b is the data point value in file2.
* Can not use with '--delta' or '--use-system-epsilon'.
* \li <strong>--use-system-epsilon</strong>
* Can not use with '\--delta' or '\--use-system-epsilon'.
* \li <strong>\--use-system-epsilon</strong>
* Print difference if (<strong>|a-b| > EPSILON</strong>), \b EPSILON is system defined value, where
* \b a is the data point value in file1 and \b b is the data point value in file2. If the system epsilon is
* not defined,one of the following predefined values will be used: <ul><li><code
* style="background-color:whitesmoke;">FLT_EPSILON = 1.19209E-07</code> for floating-point type</li>
* <li><code style="background-color:whitesmoke;">DBL_EPSILON = 2.22045E-16</code>
* for double precision</li></ul>
* type Can not use with '--relative' or '--delta'.
* \li <strong>--exclude-path "path"</strong> Exclude the specified path to an object when
* type Can not use with '\--relative' or '\--delta'.
* \li <strong>\--exclude-path "path"</strong> Exclude the specified path to an object when
* comparing files or groups. If a group is excluded, all member objects will also be excluded.
* The specified path is excluded wherever it occurs. This flexibility enables the same option
* to exclude either objects that exist only in one file or common objects that are known to differ.<br />
* When comparing files, "path" is the absolute path to the excluded object;
* when comparing groups, "path" is similar to the relative path from the group to the excluded object. This
* "path" can be taken from the first section of the output of the <strong>--verbose</strong> option.<br />
* "path" can be taken from the first section of the output of the <strong>\--verbose</strong> option.<br />
* For example, if you are comparing the group <code style="background-color:whitesmoke;">/groupA</code>
* in two files and you want to exclude
* <code style="background-color:whitesmoke;">/groupA/groupB/groupC</code> in both files,
* the exclude option would read as follows:<br />
* <code style="background-color:whitesmoke;">--exclude-path "/groupB/groupC"</code> <br />
* <code style="background-color:whitesmoke;">\--exclude-path "/groupB/groupC"</code> <br />
* If there are multiple paths to an object, only the specified path(s) will be excluded; the
* comparison will include any path not explicitly excluded.<br />
* This option can be used repeatedly to
* exclude multiple paths.
* \li <strong>--exclude-attribute "path/to/object/with/attribute"</strong> Exclude
* \li <strong>\--exclude-attribute "path/to/object/with/attribute"</strong> Exclude
* attributes on the specified path to an object when comparing files or groups.<br />
* If there are multiple paths to an object, only the specified path(s) will be excluded;
* the comparison will include any path not explicitly excluded.<br />
@@ -168,11 +172,11 @@
* The comparison is based on the return value of H5Tequal.
* \li 4) <strong>Symbolic links</strong>
* The paths to the target objects are compared.
* (The option --follow-symlinks overrides the default behavior when
* (The option \--follow-symlinks overrides the default behavior when
* symbolic links are compared.)
*
* \subsubsection subsubsec_cltools_h5diff_subset Subsetting Options
* \li <strong>--no-compact-subset</strong> Disable compact form of subsetting and allow the use
* \li <strong>\--no-compact-subset</strong> Disable compact form of subsetting and allow the use
* of "[" in dataset names.
*
* Subsetting is available by using the fcompact form of subsetting, as follows:
tools/src/h5dump/h5dump.h
+74 -68
View File
@@ -12,6 +12,7 @@
#ifndef H5DUMP_H
#define H5DUMP_H
/* clang-format off */
/** \page H5TOOL_DP_UG The HDF5 h5dump Tool
*
* Navigate back: \ref index "Main" / \ref UG / \ref CommandTools
@@ -23,96 +24,97 @@
* With h5dump, you can display objects from an HDF5 file.
*
* \subsection subsec_cltools_h5dump_usage Usage
* <h4>h5dump [OPTIONS] [files</h4>
* <h4>h5dump [OPTIONS] [files]</h4>
*
* \subsection subsec_cltools_h5dump_error Error Report Option
* \li <strong>--enable-error-stack</strong> Prints messages from the HDF5 error stack as they occur.
* Optional value 2 also prints file open errors, --enable-error-stack=2.
* \li <strong>\--enable-error-stack</strong> Prints messages from the HDF5 error stack as they occur.
* Optional value 2 also prints file open errors, <code>\--enable-error-stack=2</code>.
*
* \subsection subsec_cltools_h5dump_options Options
* \li <strong>--help</strong> Print a usage message and exit
* \li <strong>--version</strong> Print the library version number and exit
* \li <strong>\--help</strong> Print a usage message and exit
* \li <strong>\--version</strong> Print the library version number and exit
*
* \subsection subsec_cltools_h5dump_options_file File Options
* \li <strong>--contents</strong> Print a list of the file contents, group and dataset,
* names and values, then exit. Optional value 1 also prints attributes, --contents=1.
* \li <strong>--superblock</strong> Print the content of the super block
* \li <strong>--header</strong> Print the header only; no data is displayed
* \li <strong>--filedriver=D</strong> Specify which driver to open the file with
* \li <strong>--output=F</strong> Output raw data into file F
* \li <strong>--binary=B</strong> Binary file output, of form B
* \li <strong>--ddl=F</strong> Output ddl text into file F
* Use blank(empty) filename F to suppress ddl display
* \li <strong>--page-buffer-size=N</strong> Set the page buffer cache size, N=non-negative integers
* \li <strong>--endpoint-url=P</strong> Supply S3 endpoint url information to "ros3" vfd.
* P is the AWS service endpoint.
* Has no effect if filedriver is not "ros3".
* \li <strong>--s3-cred=\<cred\></strong> Supply S3 authentication information to "ros3" vfd.
* \code <cred> :: "(<aws-region>,<access-id>,<access-key>)" \endcode
* \code <cred> :: "(<aws-region>,<access-id>,<access-key>,<session-token>)" \endcode
* If absent or \code \<cred\> -> "(,,)" \endcode or \code \<cred\> -> "(,,,)"
* \endcode, no authentication. Has no effect if filedriver is not "ros3". \li
* <strong>--hdfs-attrs=\<attrs\></strong> Supply configuration information for HDFS file access. For use with
* <strong>--filedriver=hdfs</strong> \code <attrs> :: (<namenode name>,<namenode port>, <kerberos cache
* path>,<username>, <buffer size>) \endcode Any absent attribute will use a default value. \li
* <strong>--vol-value</strong> Value (ID) of the VOL connector to use for opening the HDF5 file specified \li
* <strong>--vol-name</strong> Name of the VOL connector to use for opening the HDF5 file specified \li
* <strong>--vol-info</strong> VOL-specific info to pass to the VOL connector used for opening the HDF5 file
* specified.<br /> If none of the above options are used to specify a VOL, then the VOL named by \b
* HDF5_VOL_CONNECTOR (or the native VOL connector, if that environment variable is unset) will be used
* \li<strong>--vfd-value</strong> Value (ID) of the VFL driver to use for opening the HDF5 file specified
* \li <strong>--vfd-name</strong> Name of the VFL driver to use for opening the HDF5 file specified
* \li <strong>--vfd-info</strong> VFD-specific info to pass to the VFL driver used for
* \li <strong>\--contents</strong> Print a list of the file contents, group and dataset,
* names and values, then exit. Optional value 1 also prints attributes, <code>\--contents=1</code>.
* \li <strong>\--superblock</strong> Print the content of the super block
* \li <strong>\--header</strong> Print the header only; no data is displayed
* \li <strong>\--filedriver=D</strong> Specify which driver to open the file with
* \li <strong>\--output=F</strong> Output raw data into file F
* \li <strong>\--binary=B</strong> Binary file output, of form B
* \li <strong>\--ddl=F</strong> Output ddl text into file F
* Use blank(empty) filename F to suppress ddl display
* \li <strong>\--page-buffer-size=N</strong> Set the page buffer cache size, N=non-negative integers
* \li <strong>\--endpoint-url=P</strong> Supply S3 endpoint url information to "ros3" vfd.
* P is the AWS service endpoint.
* Has no effect if filedriver is not "ros3".
* \li <strong>\--s3-cred=\<cred\></strong> Supply S3 authentication information to "ros3" vfd.
* \code <cred> :: "(<aws-region>,<access-id>,<access-key>)" \endcode
* \code <cred> :: "(<aws-region>,<access-id>,<access-key>,<session-token>)" \endcode
* If absent or \code \<cred\> -> "(,,)" \endcode or \code \<cred\> -> "(,,,)" \endcode,
* no authentication. Has no effect if filedriver is not "ros3".
* \li <strong>\--hdfs-attrs=\<attrs\></strong> Supply configuration information for HDFS file access. For use with
* <strong>\--filedriver=hdfs</strong>
* \code <attrs> :: (<namenode name>,<namenode port>, <kerberos cache path>,<username>, <buffer size>) \endcode
* Any absent attribute will use a default value.
* \li <strong>\--vol-value</strong> Value (ID) of the VOL connector to use for opening the HDF5 file specified
* \li <strong>\--vol-name</strong> Name of the VOL connector to use for opening the HDF5 file specified
* \li <strong>\--vol-info</strong> VOL-specific info to pass to the VOL connector used for opening the HDF5 file specified.<br />
* If none of the above options are used to specify a VOL, then the VOL named by
* \b HDF5_VOL_CONNECTOR (or the native VOL connector, if that environment variable
* is unset) will be used
* \li <strong>\--vfd-value</strong> Value (ID) of the VFL driver to use for opening the HDF5 file specified
* \li <strong>\--vfd-name</strong> Name of the VFL driver to use for opening the HDF5 file specified
* \li <strong>\--vfd-info</strong> VFD-specific info to pass to the VFL driver used for
* opening the HDF5 file specified
*
* \subsection subsec_cltools_h5dump_options_obj Object Options
* \li <strong>--attribute=P</strong> Print the specified attribute
* \li <strong>\--attribute=P</strong> Print the specified attribute.
* If an attribute name contains a slash (/), escape the
* slash with a preceding backslash (\).
* slash with a preceding backslash (\\).
* (See example section below.)
* \li <strong>--dataset=P</strong> Print the specified dataset
* \li <strong>--group=P</strong> Print the specified group and all members
* \li <strong>--soft-link=P</strong> Print the value(s) of the specified soft link
* \li <strong>--datatype=P</strong> Print the specified named datatype
* \li <strong>--any_path=P</strong> Print any attribute, dataset, group, datatype, or link that matches P
* \li <strong>\--dataset=P</strong> Print the specified dataset
* \li <strong>\--group=P</strong> Print the specified group and all members
* \li <strong>\--soft-link=P</strong> Print the value(s) of the specified soft link
* \li <strong>\--datatype=P</strong> Print the specified named datatype
* \li <strong>\--any_path=P</strong> Print any attribute, dataset, group, datatype, or link that matches P.
* P can be the absolute path or just a relative path.
* \li <strong>--onlyattr</strong> Print the header and value of attributes
* \li <strong>\--onlyattr</strong> Print the header and value of attributes.
* Optional value 0 suppresses printing attributes.
* \li <strong>--vds-view-first-missing</strong> Set the VDS bounds to first missing mapped elements.
* \li <strong>--vds-gap-size=N</strong> Set the missing file gap size, N=non-negative integers
* \li <strong>\--vds-view-first-missing</strong> Set the VDS bounds to first missing mapped elements.
* \li <strong>\--vds-gap-size=N</strong> Set the missing file gap size, N=non-negative integers
*
* \subsection subsec_cltools_h5dump_options_prop Object Property Options
* \li <strong>--object-ids</strong> Print the object ids
* \li <strong>--properties</strong> Print dataset filters, storage layout and fill value
* \li <strong>--packedbits=L</strong> Print packed bits as unsigned integers, using mask
* \li <strong>\--object-ids</strong> Print the object ids
* \li <strong>\--properties</strong> Print dataset filters, storage layout and fill value
* \li <strong>\--packedbits=L</strong> Print packed bits as unsigned integers, using mask
* format L for an integer dataset specified with
* option -d. L is a list of offset,length values,
* separated by commas. Offset is the beginning bit in
* the data value and length is the number of bits of
* the mask.
* \li <strong>--region</strong> Print dataset pointed by region references
* \li <strong>\--region</strong> Print dataset pointed by region references
*
* \subsection subsec_cltools_h5dump_options_fmt Formatting Options
* \li <strong>--escape</strong> Escape non printing characters
* \li <strong>--string</strong> Print 1-byte integer datasets as ASCII
* \li <strong>--noindex</strong> Do not print array indices with the data
* \li <strong>--format=T</strong> Set the floating point output format
* \li <strong>--lformat=T</strong> Set the floating point long double output format
* \li <strong>--sort_by=Q</strong> Sort groups and attributes by index Q
* \li <strong>--sort_order=Z</strong> Sort groups and attributes by order Z
* \li <strong>--no-compact-subset</strong> Disable compact form of subsetting and allow the use
* \li <strong>\--escape</strong> Escape non printing characters
* \li <strong>\--string</strong> Print 1-byte integer datasets as ASCII
* \li <strong>\--noindex</strong> Do not print array indices with the data
* \li <strong>\--format=T</strong> Set the floating point output format
* \li <strong>\--lformat=T</strong> Set the floating point long double output format
* \li <strong>\--sort_by=Q</strong> Sort groups and attributes by index Q
* \li <strong>\--sort_order=Z</strong> Sort groups and attributes by order Z
* \li <strong>\--no-compact-subset</strong> Disable compact form of subsetting and allow the use
* of "[" in dataset names.
* \li <strong>--width=N</strong> Set the number of columns of output. A value of 0 (zero)
* \li <strong>\--width=N</strong> Set the number of columns of output. A value of 0 (zero)
* sets the number of columns to the maximum (65535).
* Default width is 80 columns.
*
* \subsection subsec_cltools_h5dump_options_xml XML Options
* \li <strong>--xml</strong> Output in XML using Schema
* \li <strong>--use-dtd</strong> Output in XML using DTD
* \li <strong>--xml-dtd=U</strong> Use the DTD or schema at U
* \li <strong>--xml-ns=S</strong> (XML Schema) Use qualified names n the XML
* \li <strong>\--xml</strong> Output in XML using Schema
* \li <strong>\--use-dtd</strong> Output in XML using DTD
* \li <strong>\--xml-dtd=U</strong> Use the DTD or schema at U
* \li <strong>\--xml-ns=S</strong> (XML Schema) Use qualified names in the XML.
* ":": no namespace, default: "hdf5:"
* E.g., to dump a file called "-f", use h5dump -- -f
*
* \subsection subsec_cltools_h5dump_options_subset Subsetting Options
* Subsetting is available by using the following options with a dataset
@@ -122,21 +124,24 @@
* The \b STRIDE, \b COUNT, and \b BLOCK parameters are optional and will default to 1 in
* each dimension. \b START is optional and will default to 0 in each dimension.
*
* \li <strong>--start=START</strong> Offset of start of subsetting selection
* \li <strong>\--start=START</strong> Offset of start of subsetting selection
* \b START - is a list of integers, the number of which are equal to the
* number of dimensions in the dataspace being queried.<br />
* \li <strong>--stride=STRIDE</strong> Hyperslab stride
* \b COUNT - is a list of integers, the number of which are equal to the
* number of dimensions in the dataspace being queried.<br />
* \li <strong>--count=COUNT</strong> Number of blocks to include in selection
* \li <strong>\--stride=STRIDE</strong> Hyperslab stride
* \b STRIDE - is a list of integers, the number of which are equal to the
* number of dimensions in the dataspace being queried.<br />
* \li <strong>--block=BLOCK</strong> Size of block in hyperslab
* \li <strong>\--count=COUNT</strong> Number of blocks to include in selection
* \b COUNT - is a list of integers, the number of which are equal to the
* number of dimensions in the dataspace being queried.<br />
* \li <strong>\--block=BLOCK</strong> Size of block in hyperslab
* \b BLOCK - is a list of integers, the number of which are equal to the
* number of dimensions in the dataspace being queried.<br />
* (Alternate compact form of subsetting is described in the Reference Manual)
*
* \subsubsection subsubsec_cltools_h5dump_options_args Option Argument Conventions
*
* \li <strong>\--</strong> - Two dashes followed by whitespace. Indicates that the following argument is
* not an option. For example, to dump a file called "-f", use <code>h5dump \-- -f</code>.
* \li <strong>D</strong> - is the file driver to use in opening the file. Acceptable values are available
* from https://support.hdfgroup.org/releases/hdf5/documentation/registered_virtual_file_drivers_vfds.md.
* Without the file driver flag, the file will be opened with each driver in turn and in the order specified
@@ -208,6 +213,7 @@
* have been saved in the "source"/tools/test/h5dump/testfiles/xml folder.
*
*/
/* clang-format on */
#include "hdf5.h"
#include "H5private.h"
tools/src/h5format_convert/h5format_convert.h
+9 -9
View File
@@ -26,18 +26,18 @@
* <h4>h5format_convert [OPTIONS] file_name</h4>
*
* \subsection subsec_cltools_h5format_convert_error Error Report Option
* \li <strong>--enable-error-stack</strong> Prints messages from the HDF5 error stack as they occur.
* Optional value 2 also prints file open errors, --enable-error-stack=2.
* \li <strong>\--enable-error-stack</strong> Prints messages from the HDF5 error stack as they occur.
* Optional value 2 also prints file open errors, <code>\--enable-error-stack=2</code>.
*
* \subsection subsec_cltools_h5format_convert_options Options
* \li <strong>--help</strong> Print a usage message and exit
* \li <strong>--version</strong> Print the library version number and exit
* \li <strong>--verbose</strong> Turn on verbose mode
* \li <strong>--dname=dataset_name</strong> Pathname for the dataset
* \li <strong>--noop</strong> Perform all the steps except the actual conversion
* \li <strong>\--help</strong> Print a usage message and exit
* \li <strong>\--version</strong> Print the library version number and exit
* \li <strong>\--verbose</strong> Turn on verbose mode
* \li <strong>\--dname=dataset_name</strong> Pathname for the dataset
* \li <strong>\--noop</strong> Perform all the steps except the actual conversion
*
* \subsubsection subsubsec_cltools_h5format_convert_examples Usage Examples
* \li 1) h5format_convert --dname=/group/dataset file_name
* \li 1) h5format_convert \--dname=/group/dataset file_name
*
* Convert the dataset </group/dataset> in the HDF5 file <file_name>:
* - chunked dataset: convert the chunk indexing type to version 1 B-tree
@@ -51,7 +51,7 @@
* - compact/contiguous dataset: downgrade the layout version to 3
* - virtual dataset: no action
*
* \li 3) h5format_convert --noop --dname=/group/dataset file_name
* \li 3) h5format_convert \--noop \--dname=/group/dataset file_name
*
* Go through all the steps except the actual conversion when
* converting the dataset </group/dataset> in the HDF5 file <file_name>.
tools/src/h5jam/h5jam.h
+6 -6
View File
@@ -25,8 +25,8 @@
* data.
*
* \subsection subsec_cltools_h5jam_usage Usage
* <h4>h5jam -i \<in_file.h5\> -u \<in_user_file\> [-o \<out_file.h5\>] [--clobber]</h4>
* <h4>h5unjam -i \<in_file.h5\> [-o \<out_file.h5\> ] [-u \<out_user_file\> | --delete]</h4>
* <h4>h5jam -i \<in_file.h5\> -u \<in_user_file\> [-o \<out_file.h5\>] [\--clobber]</h4>
* <h4>h5unjam -i \<in_file.h5\> [-o \<out_file.h5\> ] [-u \<out_user_file\> | \--delete]</h4>
*
* \subsection subsec_cltools_h5jam_options h5jam Options
* \li <strong>-i in_file.h5</strong> Specifies the input HDF5 file.
@@ -35,7 +35,7 @@
* \li <strong>-o out_file.h5</strong> Specifies the output HDF5 file.
* If not specified, the user block will be concatenated in
* place to the input HDF5 file.
* \li <strong>--clobber</strong> Wipes out any existing user block before concatenating
* \li <strong>\--clobber</strong> Wipes out any existing user block before concatenating
* the given user block.
* The size of the new user block will be the larger of:
* - the size of existing user block in the input HDF5 file
@@ -54,14 +54,14 @@
* \li <strong>-u out_user_file</strong>
* Specifies the output file containing the data from the
* user block.
* Cannot be used with --delete option.
* \li <strong>--delete</strong> Remove the user block from the input HDF5 file. The content
* Cannot be used with <strong>\--delete</strong> option.
* \li <strong>\--delete</strong> Remove the user block from the input HDF5 file. The content
* of the user block is discarded.
* Cannot be used with the -u option.
* \li <strong>-h</strong> Prints a usage message and exits.
* \li <strong>-V</strong> Prints the HDF5 library version and exits.
*
* If neither <strong>--delete</strong> nor <strong>-u</strong> is specified, the user block from the input
* If neither <strong>\--delete</strong> nor <strong>-u</strong> is specified, the user block from the input
* file will be displayed to stdout stream.
*
* Previous Chapter \ref sec_cltools_h5import - Next Chapter \ref sec_cltools_h5ls
tools/src/h5ls/h5ls.h
+36 -35
View File
@@ -33,18 +33,18 @@
* "%05d" to open a file family.
*
* \subsection subsec_cltools_h5ls_error Error Report Option
* \li <strong>--enable-error-stack</strong> Prints messages from the HDF5 error stack as they occur.
* Optional value 2 also prints file open errors, --enable-error-stack=2.
* \li <strong>\--enable-error-stack</strong> Prints messages from the HDF5 error stack as they occur.
* Optional value 2 also prints file open errors, <code>\--enable-error-stack=2</code>.
*
* \subsection subsec_cltools_h5ls_options Options
* \li <strong>--help</strong> Print a usage message and exit
* \li <strong>--address</strong> Print raw data address. If dataset is contiguous, address
* \li <strong>\--help</strong> Print a usage message and exit
* \li <strong>\--address</strong> Print raw data address. If dataset is contiguous, address
* is offset in file of beginning of raw data. If chunked,
* returned list of addresses indicates offset of each chunk.
* Must be used with <strong>--verbose option</strong>.
* Must be used with <strong>\--verbose</strong> option.
* Provides no information for non-dataset objects.
* \li <strong>--data</strong> Print the values of datasets
* \li <strong>--follow-symlinks</strong>
* \li <strong>\--data</strong> Print the values of datasets
* \li <strong>\--follow-symlinks</strong>
* Follow symbolic links (soft links and external links)
* to display target object information.<br />
* Without this option, h5ls identifies a symbolic link
@@ -52,8 +52,8 @@
* assigned to the symbolic link; it does not provide any
* information regarding the target object or determine
* whether the link is a dangling link.
* \li <strong>--no-dangling-links</strong>
* Must be used with <strong>--follow-symlinks</strong> option;
* \li <strong>\--no-dangling-links</strong>
* Must be used with <strong>\--follow-symlinks</strong> option;
* otherwise, h5ls shows error message and returns an exit
* code of 1.<br />
* Check for any symbolic links (soft links or external links)
@@ -61,53 +61,54 @@
* or named datatype).<br />
* If any dangling link is found, this situation is treated
* as an error and h5ls returns an exit code of 1.
* \li <strong>--full</strong> Print full path names instead of base names
* \li <strong>--group</strong> Show information about a group, not its contents
* \li <strong>--label</strong> Label members of compound datasets
* \li <strong>--recursive</strong> List all groups recursively, avoiding cycles
* \li <strong>--string</strong> Print 1-byte integer datasets as ASCII
* \li <strong>--simple</strong> Use a machine-readable output format
* \li <strong>--width=N</strong> Set the number of columns of output
* \li <strong>--verbose</strong> Generate more verbose output
* \li <strong>--version</strong> Print the library version number and exit
* \li <strong>--page-buffer-size=N</strong> Set the page buffer cache size, N=non-negative integers
* \li <strong>--vfd=DRIVER</strong> Use the specified virtual file driver
* \li <strong>--hexdump</strong> Show raw data in hexadecimal format
* \li <strong>--endpoint-url=P</strong> Supply S3 endpoint url information to "ros3" vfd.
* \li <strong>\--full</strong> Print full path names instead of base names
* \li <strong>\--group</strong> Show information about a group, not its contents
* \li <strong>\--label</strong> Label members of compound datasets
* \li <strong>\--recursive</strong> List all groups recursively, avoiding cycles
* \li <strong>\--string</strong> Print 1-byte integer datasets as ASCII
* \li <strong>\--simple</strong> Use a machine-readable output format
* \li <strong>\--width=N</strong> Set the number of columns of output
* \li <strong>\--verbose</strong> Generate more verbose output
* \li <strong>\--version</strong> Print the library version number and exit
* \li <strong>\--page-buffer-size=N</strong> Set the page buffer cache size, N=non-negative integers
* \li <strong>\--vfd=DRIVER</strong> Use the specified virtual file driver
* \li <strong>\--hexdump</strong> Show raw data in hexadecimal format
* \li <strong>\--endpoint-url=P</strong> Supply S3 endpoint url information to "ros3" vfd.
* P is the AWS service endpoint.
* Has no effect if vfd flag not set to "ros3".
* \li <strong>--s3-cred=C</strong> Supply S3 authentication information to "ros3" vfd.
* \li <strong>\--s3-cred=C</strong> Supply S3 authentication information to "ros3" vfd.
* Accepts tuple of \code (<aws-region>,<access-id>,<access-key>) \endcode
* or \code (<aws-region>,<access-id>,<access-key>,<session-token>) \endcode.
* If absent or C = \code (,,) \endcode or C = \code (,,,) \endcode defaults to
* no-authentication. Has no effect if vfd flag not set to "ros3". \li <strong>--hdfs-attrs=A</strong> Supply
* configuration information to Hadoop VFD. Accepts tuple of \code (<namenode name>,<namenode port>,
* no-authentication. Has no effect if vfd flag not set to "ros3".
* \li <strong>\--hdfs-attrs=A</strong> Supply configuration information to Hadoop VFD. Accepts
* tuple of \code (<namenode name>,<namenode port>,
* ...<kerberos cache path>,<username>,<buffer size>) \endcode
* If absent or A == \code (,,,,) \endcode all default values are used.
* Has no effect if vfd flag is not 'hdfs'.
* \li <strong>--vol-value</strong> Value (ID) of the VOL connector to use for opening the
* \li <strong>\--vol-value</strong> Value (ID) of the VOL connector to use for opening the
* HDF5 file specified
* \li <strong>--vol-name</strong> Name of the VOL connector to use for opening the
* \li <strong>\--vol-name</strong> Name of the VOL connector to use for opening the
* HDF5 file specified
* \li <strong>--vol-info</strong> VOL-specific info to pass to the VOL connector used for
* \li <strong>\--vol-info</strong> VOL-specific info to pass to the VOL connector used for
* opening the HDF5 file specified
* If none of the above options are used to specify a VOL, then
* the VOL named by HDF5_VOL_CONNECTOR (or the native VOL connector,
* if that environment variable is unset) will be used
* \li <strong>--vfd-value</strong> Value (ID) of the VFL driver to use for opening the
* \li <strong>\--vfd-value</strong> Value (ID) of the VFL driver to use for opening the
* HDF5 file specified
* \li <strong>--vfd-name</strong> Name of the VFL driver to use for opening the
* \li <strong>\--vfd-name</strong> Name of the VFL driver to use for opening the
* HDF5 file specified
* \li <strong>--vfd-info</strong> VFD-specific info to pass to the VFL driver used for
* \li <strong>\--vfd-info</strong> VFD-specific info to pass to the VFL driver used for
* opening the HDF5 file specified
*
* \subsubsection subsubsec_cltools_h5ls_options_depre Deprecated Options
* The following options have been removed in HDF5 1.12. Use the indicated
* replacement option in all work.
* \li <strong>--external</strong> Follow external links.<br />
* Replaced by <strong>--follow-symlinks</strong>.
* \li <strong>--errors</strong> Show all HDF5 error reporting<br />
* Replaced by <strong>--enable-error-stack</strong>.
* \li <strong>\--external</strong> Follow external links.<br />
* Replaced by <strong>\--follow-symlinks</strong>.
* \li <strong>\--errors</strong> Show all HDF5 error reporting<br />
* Replaced by <strong>\--enable-error-stack</strong>.
*
* Previous Chapter \ref sec_cltools_h5jam - Next Chapter \ref sec_cltools_h5repack
*
tools/src/h5repack/h5repack.h
+52 -51
View File
@@ -29,73 +29,74 @@
* \li <strong>file2</strong> Output HDF5 File
*
* \subsection subsec_cltools_h5repack_error Error Report Option
* \li <strong>--enable-error-stack</strong> Prints messages from the HDF5 error stack as they occur.
* Optional value 2 also prints file open errors, --enable-error-stack=2.
* \li <strong>\--enable-error-stack</strong> Prints messages from the HDF5 error stack as they occur.
* Optional value 2 also prints file open errors, <code>\--enable-error-stack=2</code>.
*
* \subsection subsec_cltools_h5repack_options Options
* \li <strong>--help</strong> Print a usage message and exit
* \li <strong>--verbose=N</strong> Verbose mode, print object information.
* \li <strong>\--help</strong> Print a usage message and exit
* \li <strong>\--verbose=N</strong> Verbose mode, print object information.
* N - is an integer greater than 1, 2 displays read/write timing
* \li <strong>--version</strong> Print the library version number and exit
* \li <strong>--native</strong> Use a native HDF5 type when repacking
* \li <strong>--page-buffer-size=N</strong> Set the page buffer cache size, N=non-negative integers
* \li <strong>--src-vol-value</strong> Value (ID) of the VOL connector to use for opening the
* \li <strong>\--version</strong> Print the library version number and exit
* \li <strong>\--native</strong> Use a native HDF5 type when repacking
* \li <strong>\--page-buffer-size=N</strong> Set the page buffer cache size, N=non-negative integers
* \li <strong>\--src-vol-value</strong> Value (ID) of the VOL connector to use for opening the
* input HDF5 file specified
* \li <strong>--src-vol-name</strong> Name of the VOL connector to use for opening the input
* \li <strong>\--src-vol-name</strong> Name of the VOL connector to use for opening the input
* HDF5 file specified
* \li <strong>--src-vol-info</strong> VOL-specific info to pass to the VOL connector used for
* \li <strong>\--src-vol-info</strong> VOL-specific info to pass to the VOL connector used for
* opening the input HDF5 file specified
* \li <strong>--dst-vol-value</strong> Value (ID) of the VOL connector to use for opening the
* \li <strong>\--dst-vol-value</strong> Value (ID) of the VOL connector to use for opening the
* output HDF5 file specified
* \li <strong>--dst-vol-name</strong> Name of the VOL connector to use for opening the output
* \li <strong>\--dst-vol-name</strong> Name of the VOL connector to use for opening the output
* HDF5 file specified
* \li <strong>--dst-vol-info</strong> VOL-specific info to pass to the VOL connector used for
* \li <strong>\--dst-vol-info</strong> VOL-specific info to pass to the VOL connector used for
* opening the output HDF5 file specified
* \li <strong>--src-vfd-value</strong> Value (ID) of the VFL driver to use for opening the
* \li <strong>\--src-vfd-value</strong> Value (ID) of the VFL driver to use for opening the
* input HDF5 file specified
* \li <strong>--src-vfd-name</strong> Name of the VFL driver to use for opening the input
* \li <strong>\--src-vfd-name</strong> Name of the VFL driver to use for opening the input
* HDF5 file specified
* \li <strong>--src-vfd-info</strong> VFD-specific info to pass to the VFL driver used for
* \li <strong>\--src-vfd-info</strong> VFD-specific info to pass to the VFL driver used for
* opening the input HDF5 file specified
* \li <strong>--dst-vfd-value</strong> Value (ID) of the VFL driver to use for opening the
* \li <strong>\--dst-vfd-value</strong> Value (ID) of the VFL driver to use for opening the
* output HDF5 file specified
* \li <strong>--dst-vfd-name</strong> Name of the VFL driver to use for opening the output
* \li <strong>\--dst-vfd-name</strong> Name of the VFL driver to use for opening the output
* HDF5 file specified
* \li <strong>--dst-vfd-info</strong> VFD-specific info to pass to the VFL driver used for
* \li <strong>\--dst-vfd-info</strong> VFD-specific info to pass to the VFL driver used for
* opening the output HDF5 file specified
* \li <strong>--latest</strong> Use latest version of file format
* \li <strong>\--latest</strong> Use latest version of file format
* This option will take precedence over the options
* --low and --high
* \li <strong>--low=BOUND</strong> The low bound for library release versions to use
* <strong>\--low</strong> and <strong>\--high</strong>
* \li <strong>\--low=BOUND</strong> The low bound for library release versions to use
* when creating objects in the file
* (default is #H5F_LIBVER_EARLIEST)
* \li <strong>--high=BOUND</strong> The high bound for library release versions to use
* \li <strong>\--high=BOUND</strong> The high bound for library release versions to use
* when creating objects in the file
* (default is #H5F_LIBVER_LATEST)
* \li <strong>--merge</strong> Follow external soft link recursively and merge data
* \li <strong>--prune</strong> Do not follow external soft links and remove link
* \li <strong>--merge --prune</strong> Follow external link, merge data and remove dangling link
* \li <strong>--compact=L1</strong> Maximum number of links in header messages
* \li <strong>--indexed=L2</strong> Minimum number of links in the indexed format
* \li <strong>--ssize=S[:F]</strong> Shared object header message minimum size
* \li <strong>--minimum=M</strong> Do not apply the filter to datasets smaller than M
* \li <strong>--file=E</strong> Name of file E with the --file and --layout options
* \li <strong>--ublock=U</strong> Name of file U with user block data to be added
* \li <strong>--block=B</strong> Size of user block to be added
* \li <strong>--metadata_block_size=A</strong> Metadata block size for #H5Pset_meta_block_size
* \li <strong>--threshold=T</strong> Threshold value for #H5Pset_alignment
* \li <strong>--alignment=A</strong> Alignment value for #H5Pset_alignment
* \li <strong>--sort_by=Q</strong> Sort groups and attributes by index Q
* \li <strong>--sort_order=Z</strong> Sort groups and attributes by order Z
* \li <strong>--filter=FILT</strong> Filter type
* \li <strong>--layout=LAYT</strong> Layout type
* \li <strong>--fs_strategy=FS_STRATEGY</strong> File space management strategy for
* \li <strong>\--merge</strong> Follow external soft link recursively and merge data
* \li <strong>\--prune</strong> Do not follow external soft links and remove link
* \li <strong>\--merge \--prune</strong> Follow external link, merge data and remove dangling link
* \li <strong>\--compact=L1</strong> Maximum number of links in header messages
* \li <strong>\--indexed=L2</strong> Minimum number of links in the indexed format
* \li <strong>\--ssize=S[:F]</strong> Shared object header message minimum size
* \li <strong>\--minimum=M</strong> Do not apply the filter to datasets smaller than M
* \li <strong>\--file=E</strong> Name of file E with the <strong>\--file</strong> and
* <strong>\--layout</strong> options
* \li <strong>\--ublock=U</strong> Name of file U with user block data to be added
* \li <strong>\--block=B</strong> Size of user block to be added
* \li <strong>\--metadata_block_size=A</strong> Metadata block size for #H5Pset_meta_block_size
* \li <strong>\--threshold=T</strong> Threshold value for #H5Pset_alignment
* \li <strong>\--alignment=A</strong> Alignment value for #H5Pset_alignment
* \li <strong>\--sort_by=Q</strong> Sort groups and attributes by index Q
* \li <strong>\--sort_order=Z</strong> Sort groups and attributes by order Z
* \li <strong>\--filter=FILT</strong> Filter type
* \li <strong>\--layout=LAYT</strong> Layout type
* \li <strong>\--fs_strategy=FS_STRATEGY</strong> File space management strategy for
* #H5Pset_file_space_strategy
* \li <strong>--fs_persist=FS_PERSIST</strong> Persisting or not
* \li <strong>\--fs_persist=FS_PERSIST</strong> Persisting or not
* persisting free-space for #H5Pset_file_space_strategy
* \li <strong>--fs_threshold=FS_THRESHOLD</strong> : Free-space section
* \li <strong>\--fs_threshold=FS_THRESHOLD</strong> : Free-space section
* threshold for #H5Pset_file_space_strategy
* \li <strong>--fs_pagesize=FS_PAGESIZE</strong> File space page size for #H5Pset_file_space_page_size
* \li <strong>\--fs_pagesize=FS_PAGESIZE</strong> File space page size for #H5Pset_file_space_page_size
*
* \subsubsection subsubsec_cltools_h5repack_options_args Arguments to Certain Options
* \li <strong>M</strong> - is an integer greater than 1, size of dataset in bytes (default is 0)
@@ -207,33 +208,33 @@
*
* \subsection subsec_cltools_h5repack_examples Usage Examples
*
* \li 1) h5repack --verbose --filter=GZIP=1 file1 file2
* \li 1) h5repack \--verbose \--filter=GZIP=1 file1 file2
*
* GZIP compression with level 1 to all objects
*
* \li 2) h5repack --verbose --filter=dset1:SZIP=8,NN file1 file2
* \li 2) h5repack \--verbose \--filter=dset1:SZIP=8,NN file1 file2
*
* SZIP compression with 8 pixels per block and NN coding method to object dset1
*
* \li 3) h5repack --verbose --layout=dset1,dset2:CHUNK=20x10 --filter=dset3,dset4,dset5:NONE file1 file2
* \li 3) h5repack \--verbose \--layout=dset1,dset2:CHUNK=20x10 \--filter=dset3,dset4,dset5:NONE file1 file2
*
* Chunked layout, with a layout size of 20x10, to objects dset1 and dset2
* and remove filters to objects dset3, dset4, dset5
*
* \li 4) h5repack --latest --compact=10 --ssize=20:dtype file1 file2
* \li 4) h5repack \--latest \--compact=10 \--ssize=20:dtype file1 file2
*
* Using latest file format with maximum compact group size of 10 and
* minimum shared datatype size of 20
*
* \li 5) h5repack --filter=SHUF --filter=GZIP=1 file1 file2
* \li 5) h5repack \--filter=SHUF \--filter=GZIP=1 file1 file2
*
* Add both filters SHUF and GZIP in this order to all datasets
*
* \li 6) h5repack --filter=UD=307,0,1,9 file1 file2
* \li 6) h5repack \--filter=UD=307,0,1,9 file1 file2
*
* Add bzip2 filter to all datasets
*
* \li 7) h5repack --low=0 --high=1 file1 file2
* \li 7) h5repack \--low=0 \--high=1 file1 file2
*
* Set low=H5F_LIBVER_EARLIEST and high=H5F_LIBVER_V18 via
* H5Pset_libver_bounds() when creating the repacked file, file2
tools/src/h5stat/h5stat.h
+29 -28
View File
@@ -26,59 +26,60 @@
* <h4>h5stat [OPTIONS] file</h4>
*
* \subsection subsec_cltools_h5stat_error Error Report Option
* \li <strong>--enable-error-stack</strong> Prints messages from the HDF5 error stack as they occur.
* Optional value 2 also prints file open errors, --enable-error-stack=2.
* \li <strong>\--enable-error-stack</strong> Prints messages from the HDF5 error stack as they occur.
* Optional value 2 also prints file open errors, <code>\--enable-error-stack=2</code>.
*
* \subsection subsec_cltools_h5stat_options Options
* \li <strong>--help</strong> Print a usage message and exit
* \li <strong>--version</strong> Print the library version number and exit
* \li <strong>--file</strong> Print file information
* \li <strong>--filemetadata</strong> Print file space information for file's metadata
* \li <strong>--group</strong> Print group information
* \li <strong>--links=N</strong> Set the threshold for the # of links when printing
* \li <strong>\--help</strong> Print a usage message and exit
* \li <strong>\--version</strong> Print the library version number and exit
* \li <strong>\--file</strong> Print file information
* \li <strong>\--filemetadata</strong> Print file space information for file's metadata
* \li <strong>\--group</strong> Print group information
* \li <strong>\--links=N</strong> Set the threshold for the # of links when printing
* information for small groups. N is an integer greater
* than 0. The default threshold is 10.
* \li <strong>--groupmetadata </strong> Print file space information for groups' metadata
* \li <strong>--dset</strong> Print dataset information
* \li <strong>--dims=N</strong> Set the threshold for the dimension sizes when printing
* \li <strong>\--groupmetadata </strong> Print file space information for groups' metadata
* \li <strong>\--dset</strong> Print dataset information
* \li <strong>\--dims=N</strong> Set the threshold for the dimension sizes when printing
* information for small datasets. N is an integer greater
* than 0. The default threshold is 10.
* \li <strong>--dsetmetadata</strong> Print file space information for datasets' metadata
* \li <strong>--dtypemetadata</strong> Print datasets' datatype information
* \li <strong>--attribute</strong> Print attribute information
* \li <strong>--numattrs=N</strong> Set the threshold for the number of attributes when printing
* \li <strong>\--dsetmetadata</strong> Print file space information for datasets' metadata
* \li <strong>\--dtypemetadata</strong> Print datasets' datatype information
* \li <strong>\--attribute</strong> Print attribute information
* \li <strong>\--numattrs=N</strong> Set the threshold for the number of attributes when printing
* information for small number of attributes. N is an integer greater
* than 0. The default threshold is 10.
* \li <strong>--freespace</strong> Print free space information
* \li <strong>--summary</strong> Print summary of file space information
* \li <strong>--page-buffer-size=N</strong> Set the page buffer cache size, N=non-negative integers
* \li <strong>--endpoint-url=P</strong> Supply S3 endpoint url information to "ros3" vfd.
* \li <strong>\--freespace</strong> Print free space information
* \li <strong>\--summary</strong> Print summary of file space information
* \li <strong>\--page-buffer-size=N</strong> Set the page buffer cache size, N=non-negative integers
* \li <strong>\--endpoint-url=P</strong> Supply S3 endpoint url information to "ros3" vfd.
* P is the AWS service endpoint.
* Has no effect if vfd flag not set to "ros3".
* \li <strong>--s3-cred=C</strong> Supply S3 authentication information to "ros3" vfd.
* \li <strong>\--s3-cred=C</strong> Supply S3 authentication information to "ros3" vfd.
* Accepts tuple of \code (<aws-region>,<access-id>,<access-key>) \endcode
* or \code (<aws-region>,<access-id>,<access-key>,<session-token>) \endcode.
* If absent or C = \code (,,) \endcode or C = \code (,,,) \endcode defaults to
* no-authentication. Has no effect if vfd flag not set to "ros3". \li <strong>--hdfs-attrs=A</strong> Supply
* configuration information to Hadoop VFD. Accepts tuple of \code (\<namenode name\>,\<namenode port\>,
* no-authentication. Has no effect if vfd flag not set to "ros3".
* \li <strong>\--hdfs-attrs=A</strong> Supply configuration information to Hadoop VFD. Accepts
* tuple of \code (\<namenode name\>,\<namenode port\>,
* ...\<kerberos cache path\>,\<username\>,\<buffer size\>) \endcode
* If absent or A == \code (,,,,) \endcode all default values are used.
* Has no effect if vfd flag is not 'hdfs'.<br />
* If an attribute is empty, a default value will be used.
* \li <strong>--vol-value</strong> Value (ID) of the VOL connector to use for opening the
* \li <strong>\--vol-value</strong> Value (ID) of the VOL connector to use for opening the
* HDF5 file specified
* \li <strong>--vol-name</strong> Name of the VOL connector to use for opening the
* \li <strong>\--vol-name</strong> Name of the VOL connector to use for opening the
* HDF5 file specified
* \li <strong>--vol-info</strong> VOL-specific info to pass to the VOL connector used for
* \li <strong>\--vol-info</strong> VOL-specific info to pass to the VOL connector used for
* opening the HDF5 file specified
* If none of the above options are used to specify a VOL, then
* the VOL named by HDF5_VOL_CONNECTOR (or the native VOL connector,
* if that environment variable is unset) will be used
* \li <strong>--vfd-value</strong> Value (ID) of the VFL driver to use for opening the
* \li <strong>\--vfd-value</strong> Value (ID) of the VFL driver to use for opening the
* HDF5 file specified
* \li <strong>--vfd-name</strong> Name of the VFL driver to use for opening the
* \li <strong>\--vfd-name</strong> Name of the VFL driver to use for opening the
* HDF5 file specified
* \li <strong>--vfd-info</strong> VFD-specific info to pass to the VFL driver used for
* \li <strong>\--vfd-info</strong> VFD-specific info to pass to the VFL driver used for
* opening the HDF5 file specified
*
* Previous Chapter \ref sec_cltools_h5repack - Next Chapter \ref sec_cltools_h5clear
tools/src/misc/h5clear.h
+10 -10
View File
@@ -31,16 +31,16 @@
* <h4>h5clear [OPTIONS] file_name</h4>
*
* \subsection subsec_cltools_h5clear_error Error Report Option
* \li <strong>--enable-error-stack</strong> Prints messages from the HDF5 error stack as they occur.
* Optional value 2 also prints file open errors, --enable-error-stack=2.
* \li <strong>\--enable-error-stack</strong> Prints messages from the HDF5 error stack as they occur.
* Optional value 2 also prints file open errors, <code>\--enable-error-stack=2</code>.
*
* \subsection subsec_cltools_h5clear_options Options
* \li <strong>--help</strong> Print a usage message and exit
* \li <strong>--version</strong> Print the library version number and exit
* \li <strong>--status</strong> Clear the status_flags field in the file's superblock
* \li <strong>--image</strong> Remove the metadata cache image from the file
* \li <strong>--filesize </strong> Print the file's EOA and EOF
* \li <strong>--increment=C</strong> Set the file's EOA to the maximum of (EOA, EOF) + C for
* \li <strong>\--help</strong> Print a usage message and exit
* \li <strong>\--version</strong> Print the library version number and exit
* \li <strong>\--status</strong> Clear the status_flags field in the file's superblock
* \li <strong>\--image</strong> Remove the metadata cache image from the file
* \li <strong>\--filesize </strong> Print the file's EOA and EOF
* \li <strong>\--increment=C</strong> Set the file's EOA to the maximum of (EOA, EOF) + C for
* the file \<file_name\>.
* C is >= 0; C is optional and will default to 1M when not set.
* This option helps to repair a crashed SWMR file when the stored
@@ -57,11 +57,11 @@
*
* Remove the metadata cache image from the HDF5 file <file_name>.
*
* \li 3) h5clear --increment file_name
* \li 3) h5clear \--increment file_name
*
* Set the EOA to the maximum of (EOA, EOF) + 1M for the file <file_name>.
*
* \li 4) h5clear --increment=512 file_name
* \li 4) h5clear \--increment=512 file_name
*
* Set the EOA to the maximum of (EOA, EOF) + 512 for the file\<file_name>.
*
tools/src/misc/h5mkgrp.h
+13 -13
View File
@@ -26,29 +26,29 @@
* <h4>h5mkgrp [OPTIONS] FILE GROUP</h4>
*
* \subsection subsec_cltools_h5mkgrp_error Error Report Option
* \li<strong>--enable-error-stack</strong> Prints messages from the HDF5 error stack as they occur.
* Optional value 2 also prints file open errors, --enable-error-stack=2.
* \li <strong>\--enable-error-stack</strong> Prints messages from the HDF5 error stack as they occur.
* Optional value 2 also prints file open errors, <code>\--enable-error-stack=2</code>.
*
* \subsection subsec_cltools_h5mkgrp_options Options
* \li <strong>--help</strong> Print a usage message and exit
* \li <strong>--version</strong> Print the library version number and exit
* \li <strong>--verbose</strong> Print information about OBJECTS and OPTIONS
* \li <strong>--latest</strong> Use latest version of file format to create groups
* \li <strong>--parents</strong> No error if existing, make parent groups as needed
* \li <strong>--vol-value</strong> Value (ID) of the VOL connector to use for opening the
* \li <strong>\--help</strong> Print a usage message and exit
* \li <strong>\--version</strong> Print the library version number and exit
* \li <strong>\--verbose</strong> Print information about OBJECTS and OPTIONS
* \li <strong>\--latest</strong> Use latest version of file format to create groups
* \li <strong>\--parents</strong> No error if existing, make parent groups as needed
* \li <strong>\--vol-value</strong> Value (ID) of the VOL connector to use for opening the
* HDF5 file specified
* \li <strong>--vol-name</strong> Name of the VOL connector to use for opening the
* \li <strong>\--vol-name</strong> Name of the VOL connector to use for opening the
* HDF5 file specified
* \li <strong>--vol-info</strong> VOL-specific info to pass to the VOL connector used for
* \li <strong>\--vol-info</strong> VOL-specific info to pass to the VOL connector used for
* opening the HDF5 file specified.<br />
* If none of the above options are used to specify a VOL, then
* the VOL named by HDF5_VOL_CONNECTOR (or the native VOL connector,
* if that environment variable is unset) will be used
* \li <strong>--vfd-value</strong> Value (ID) of the VFL driver to use for opening the
* \li <strong>\--vfd-value</strong> Value (ID) of the VFL driver to use for opening the
* HDF5 file specified
* \li <strong>--vfd-name</strong> Name of the VFL driver to use for opening the
* \li <strong>\--vfd-name</strong> Name of the VFL driver to use for opening the
* HDF5 file specified
* \li <strong>--vfd-info</strong> VFD-specific info to pass to the VFL driver used for
* \li <strong>\--vfd-info</strong> VFD-specific info to pass to the VFL driver used for
* opening the HDF5 file specified
*
* Previous Chapter \ref sec_cltools_h5delete - Next Chapter \ref sec_cltools_h5repart