summaryrefslogtreecommitdiffstats
path: root/tools/h5jam/testfiles/h5unjam-help.txt
diff options
context:
space:
mode:
authorJonathan Kim <jkm@hdfgroup.org>2011-08-16 20:41:47 (GMT)
committerJonathan Kim <jkm@hdfgroup.org>2011-08-16 20:41:47 (GMT)
commite703a6a2a4c6e6ee443d2e2af08fe61479789f79 (patch)
treeaae3f2453e6c8a536c2596868ebfde3fdf20dec5 /tools/h5jam/testfiles/h5unjam-help.txt
parent8d80bf4a93a2de494e710eb9719483178ad215e8 (diff)
downloadhdf5-e703a6a2a4c6e6ee443d2e2af08fe61479789f79.zip
hdf5-e703a6a2a4c6e6ee443d2e2af08fe61479789f79.tar.gz
hdf5-e703a6a2a4c6e6ee443d2e2af08fe61479789f79.tar.bz2
[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)
Diffstat (limited to 'tools/h5jam/testfiles/h5unjam-help.txt')
-rw-r--r--tools/h5jam/testfiles/h5unjam-help.txt34
1 files changed, 27 insertions, 7 deletions
diff --git a/tools/h5jam/testfiles/h5unjam-help.txt b/tools/h5jam/testfiles/h5unjam-help.txt
index 3eb73c5..f0d92e9 100644
--- a/tools/h5jam/testfiles/h5unjam-help.txt
+++ b/tools/h5jam/testfiles/h5unjam-help.txt
@@ -1,7 +1,27 @@
-usage: h5unjam -i h5_file -o user_block_file_out -o h5_file_out [-d | --delete]
- Extract user block from 'h5_file' into 'user_block_file'
- and HDF5 file into 'h5_file_out'
- h5unjam -h
- Print a usage message and exit
- h5unjam -V
- Print HDF5 library version and exit
+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.