Modify h5repack usage so that it is more descriptive.

This commit is contained in:
Vailin Choi
2018-01-16 17:35:29 -06:00
parent 120d02657b
commit d202b3cfa1
2 changed files with 31 additions and 9 deletions

View File

@@ -6,10 +6,13 @@ usage: h5repack [OPTIONS] file1 file2
-v, --verbose Verbose mode, print object information
-V, --version Print version number and exit
-n, --native Use a native HDF5 type when repacking
-E --enable-error-stack Prints messages from the HDF5 error stack as they occur
-L, --latest Use latest version of file format
This option will take precedence over the -j and -k options
-j, --low The low bound as in H5Pset_libver_bounds()
-k, --high The high bound as in H5Pset_libver_bounds()
-j BOUND, --low=BOUND The low bound for library release versions to use when creating
objects in the file
-k BOUND, --high=BOUND The high bound for library release versions to use when creating
objects in the file
-c L1, --compact=L1 Maximum number of links in header messages
-d L2, --indexed=L2 Minimum number of links in the indexed format
-s S[:F], --ssize=S[:F] Shared object header message minimum size
@@ -42,8 +45,11 @@ usage: h5repack [OPTIONS] file1 file2
F - is the shared object header message type, any of <dspace|dtype|fill|
pline|attr>. If F is not specified, S applies to all messages
--enable-error-stack Prints messages from the HDF5 error stack as they
occur.
BOUND is an integer indicating the library release versions to use when creating
objects in the file (see H5Pset_libver_bounds()):
0: This is H5F_LIBVER_EARLIEST in H5F_libver_t struct
1: This is H5F_LIBVER_V18 in H5F_libver_t struct
2: This is H5F_LIBVER_V110 in H5F_libver_t struct
FS_STRATEGY is a string indicating the file space strategy used:
FSM_AGGR:
@@ -133,6 +139,11 @@ Examples of use:
Using latest file format with maximum compact group size of 10 and
and minimum shared datatype size of 20
5) h5repack -j 0 -k 1 file1 file2
Set low=H5F_LIBVER_EARLIEST and high=H5F_LIBVER_V18 via H5Pset_libver_bounds() when
creating the repacked file: file2
5) h5repack -f SHUF -f GZIP=1 file1 file2
Add both filters SHUF and GZIP in this order to all datasets