diff options
author | Albert Cheng <acheng@hdfgroup.org> | 2009-10-12 18:29:46 (GMT) |
---|---|---|
committer | Albert Cheng <acheng@hdfgroup.org> | 2009-10-12 18:29:46 (GMT) |
commit | 75920d6790e56a4e8aa9b70ca1417579de1e6c6d (patch) | |
tree | 48e91cfd3489fc8b625affd3e62c1d906d9112d9 | |
parent | 5985530d9b340c711126c4559dd8c4a6d816c76b (diff) | |
download | hdf5-75920d6790e56a4e8aa9b70ca1417579de1e6c6d.zip hdf5-75920d6790e56a4e8aa9b70ca1417579de1e6c6d.tar.gz hdf5-75920d6790e56a4e8aa9b70ca1417579de1e6c6d.tar.bz2 |
[svn-r17630] The previous return value description was incorrect.
Replaced it with "Exit Status:" that reflects what the tools actually
do.
-rw-r--r-- | doc/html/Tools/h5jam_and_h5unjam.htm | 21 |
1 files changed, 13 insertions, 8 deletions
diff --git a/doc/html/Tools/h5jam_and_h5unjam.htm b/doc/html/Tools/h5jam_and_h5unjam.htm index 06c5970..7286257 100644 --- a/doc/html/Tools/h5jam_and_h5unjam.htm +++ b/doc/html/Tools/h5jam_and_h5unjam.htm @@ -37,7 +37,7 @@ user block to a file or stdout and the HDF5 file to an HDF5 file with a header a <p> If <code>user_block</code> is set,the user block will be written to <code>user_block</code>. If <code>user_block</code> is not set, the user block (if any)<code></code> will be written to stdout. If <code>-delete</code> is selected, the user block will not be not written.</dd> -<dt><strong>Example Usage</strong></dt> +<dt><strong>Example Usage:</strong></dt> <dd>Create new file, <code>newfile.h5</code>, with the text in file <code>mytext.txt</code> as the user block for the HDF5 file <code>file.h5</code>. <pre> h5jam -u mytext.txt -i file.h5 -o newfile.h5</pre> @@ -51,13 +51,18 @@ Overwrite the user block (if any) in <code>file.h5</code> with the contents of < For an HDF5 file, <code>with_ub.h5</code>, with a user block, extract the user block to <code>user_block.txt</code> and the HDF5 file to <code>wo_ub.h5</code>. <pre> h5unjam -i with_ub.h5 -u user_block.txt -o wo_ub.h5</pre> - -<dt><strong></strong></dt><dt><strong>Return Value</strong></dt> -<dd><code>h5jam</code> returns the size of the output file, or -1 if an error occurs. - <p> - <code>h5unjam</code> returns the size of the output file, or -1 if an error occurs. - -<dt><strong>Caveats</strong></dt><dt><strong></strong> </dt> +<dt><strong>Exit Status:</strong></dt> + <dd><table border=0> + <tr valign=top align=left> + <td>0</td> + <td>Succeeded.</td> + </tr> + <tr valign=top align=left> + <td>>0 </td> + <td>An error occurred.</td> + </tr> + </table> +<dt><strong>Caveats:</strong></dt><dt><strong></strong> </dt> <dd>This tool copies all the data (sequentially) in the file(s) to new offsets. For a large file, this copy will take a long time. <p>The most efficient way to create a user block is to create the file |