Files
hdf5/tools/h5jam/testfiles/h5jam-help.txt
Jonathan Kim 00cdf98d00 [svn-r21264] 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:
    - Merged from HDF5 trunk r21236,
    - 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, win)
2011-08-19 11:02:57 -05:00

25 lines
1.1 KiB
Plaintext

usage: h5jam -i <in_file.h5> -u <in_user_file> [-o <out_file.h5>] [--clobber]
Adds user block to front of an HDF5 file and creates a new concatenated file.
OPTIONS
-i in_file.h5 Specifies the input HDF5 file.
-u in_user_file Specifies the file to be inserted into the user block.
Can be any file format except an HDF5 format.
-o out_file.h5 Specifies the output HDF5 file.
If not specified, the user block will be concatenated in
place to the input HDF5 file.
--clobber 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
- the size of user block required by new input user file
(size = 512 x 2N, N is positive integer.)
-h Prints a usage message and exits.
-V Prints the HDF5 library version and exits.
Exit Status:
0 Succeeded.
>0 An error occurred.