summaryrefslogtreecommitdiffstats
path: root/tools/h5jam/testfiles/h5jam-help.txt
diff options
context:
space:
mode:
Diffstat (limited to 'tools/h5jam/testfiles/h5jam-help.txt')
-rw-r--r--tools/h5jam/testfiles/h5jam-help.txt33
1 files changed, 24 insertions, 9 deletions
diff --git a/tools/h5jam/testfiles/h5jam-help.txt b/tools/h5jam/testfiles/h5jam-help.txt
index f5d1f19..ce97c22 100644
--- a/tools/h5jam/testfiles/h5jam-help.txt
+++ b/tools/h5jam/testfiles/h5jam-help.txt
@@ -1,9 +1,24 @@
-usage: h5jam -u user_block_file -i h5_file [-o ofile | --clobber]
- Add 'user_block_file' to front of
- 'h5_file', pad so 'h5_file' starts on proper
- byte.
-
- h5jam -h
- Print a usage message and exit
- h5jam -V
- Print HDF5 library version and exit
+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.