hdf5/tools/h5jam/testfiles/h5unjam-help.txt
Jonathan Kim e703a6a2a4 [svn-r21236] Purpose:
Work for:
   HDFFV-7515 - GMQS: h5unjam - incorrect help page and should display when 
   no file is given.
   and
   HDFFV-5941 - h5jam: specifying a user block file with a proper HDF5 magic
   number will result in a corrupted HDF5 file.


Description:
   - Revised command help pages of h5jam and h5unjam. The descriptions
     were not up to date and some were missing. (HDFFV-7515)
   - Fixed h5jam not to allow specifying an HDF5 formatted file as input 
     file for -u (user block file) option, because the original HDF5 file 
     will not be accessible if allows. (HDFFV-5941)

Tested:
    jam (linux32-LE), koala (linux64-LE), heiwa (linuxppc64-BE), tejeda (mac32-LE), linew (solaris-BE), Cmake (jam, Wondows)
2011-08-16 15:41:47 -05:00

28 lines
1.1 KiB
Plaintext

usage: h5unjam -i <in_file.h5> [-o <out_file.h5> ] [-u <out_user_file> | --delete]
Splits user file and HDF5 file into two files: user block data and HDF5 data.
OPTIONS
-i in_file.h5 Specifies the HDF5 as input. If the input HDF5 file
contains no user block, exit with an error message.
-o out_file.h5 Specifies output HDF5 file without a user block.
If not specified, the user block will be removed from the
input HDF5 file.
-u out_user_file
Specifies the output file containing the data from the
user block.
Cannot be used with --delete option.
--delete Remove the user block from the input HDF5 file. The content
of the user block is discarded.
Cannot be used with the -u option.
-h Prints a usage message and exits.
-V Prints the HDF5 library version and exits.
If neither --delete nor -u is specified, the user block from the input file
will be displayed to stdout.
Exit Status:
0 Succeeded.
>0 An error occurred.