summaryrefslogtreecommitdiffstats
path: root/doc/src/Tools.html
diff options
context:
space:
mode:
authorFrank Baker <fbaker@hdfgroup.org>1998-09-10 15:40:15 (GMT)
committerFrank Baker <fbaker@hdfgroup.org>1998-09-10 15:40:15 (GMT)
commit750856c53aa1cae3217e853ab7571b20bc658ffc (patch)
tree2ad244b7c01b98180e29883c74c87d4262ac1c62 /doc/src/Tools.html
parentd07894304f4a608af828aee0a99dbb875fba1fa1 (diff)
downloadhdf5-750856c53aa1cae3217e853ab7571b20bc658ffc.zip
hdf5-750856c53aa1cae3217e853ab7571b20bc658ffc.tar.gz
hdf5-750856c53aa1cae3217e853ab7571b20bc658ffc.tar.bz2
[svn-r684] RM_H5Front.html
Added link to Tools.html Clean up formatting. Added RM_H5R.html, Ragged Arrays, but link is commented out for Beta. RM_H5.html H5version Removed patch number parameter. H5check_version Removed patch number parameter. Corrected datatype to unsigned (was unsigned *). Added missing "Purpose:" statement. RM_H5A.html H5Aread/write Added reference to data conversion limitations. RM_H5D.html H5Dwrite Added "Writing to an external dataset will fail if the HDF5 file is not open for writing." H5Dread/write Added reference to data conversion limitations. RM_H5F.html H5Fflush Added H5Fflush. RM_H5G.html H5Gget_stat Fixed formatting error. Added mtime to the description of the data structure. Added the following "Note:", per Robb's checkin mesage: "Some systems will be able to record the time accurately but unable to retrieve the correct time; such systems (e.g., Irix64) will report an mtime value of 0 (zero)." Corrected successful return value. H5Gset_comment Added the following statement to "Description:" "Comments can be attached to any object that has an object header, e.g., data sets, groups, named data types, and data spaces, but not symbolic links. RM_H5P.html Cleaned up file formatting. H5Pset_filter Added these three functions. H5Pget_nfilters H5Pget_filter H5Pget_deflate Removed these three functions. (Actually, H5Pset_compression they are commented out, in case they should H5Pget_compression be reinstated.) RM_H5R.html Intial version of H5R reference manual entry, but still largely just a template. Not yet ready for distribution. Links to this document are currently commented out. RM_H5S.html H5S_set_extent_simple Changed name to H5Sselect_extent_simple. now: H5Sselect_extent_simpl H5Sselect_npoints Corrected return value. Now: H5Sget_select_npoints H5Sget_class Reinstated to RM. Changed name. now: H5Sget_space_type H5Soffset_simple Added these 6 functions. The there is a H5Sextent_copy link to Dataspaces.html for the 10 "not yet H5Sset_extent_none implemented (NYI)" functions. H5Sselect_all H5Sselect_none H5Sselect_valid RM_H5T.html Added the following datatypes (though the list of native datatypes is commented out): H5T_NATIVE_HSIZE H5T_NATIVE_HSSIZE H5T_NATIVE_HERR H5T_NATIVE_HBOOL Tools.html Corrected h5ls and h5repart sections. Glossary.html Unlinked for Beta. Copyright.html New file. Copyright statement, linked into User's Guide and Reference Manual. General Changed the following function names: From: To: H5version H5get_libversion H5vers_check H5check_version H5Anum_attrs H5Aget_num_attrs H5Fget_create_template H5Fget_create_plist H5Fget_access_template H5Fget_access_plist And associated "template" -> "property list" edits. H5Gstat H5Gget_stat H5Sextent_npoints H5Sget_simple_extent_npoints H5Sextent_ndims H5Sget_simple_extent_ndims H5Sextent_dims H5Sget_simple_extent_dims H5Sget_class H5Sget_simple_extent_type H5Sselect_npoints H5Sget_select_npoints Added links to Tools.html and RM_H5R.html (Ragged Arrays), though link to RM_H5R.html is commented out for now.
Diffstat (limited to 'doc/src/Tools.html')
-rw-r--r--doc/src/Tools.html27
1 files changed, 15 insertions, 12 deletions
diff --git a/doc/src/Tools.html b/doc/src/Tools.html
index cf89313..b19b57c 100644
--- a/doc/src/Tools.html
+++ b/doc/src/Tools.html
@@ -139,12 +139,12 @@ These tools enable the user to examine HDF5 files interactively.
<dd><code>h5ls
[</code><em>options</em><code>]</code><em>
file</em><code>
- [</code><em>group</em><code>]</code>
+ [</code><em>objects...</em><code>]</code>
<dt><strong>Purpose:</strong>
<dd>Prints information about a file or dataset.
<dt><strong>Description:</strong>
- <dd><code>h5ls</code> prints selected information about a file
- or dataset in the specified format.
+ <dd><code>h5ls</code> prints selected information about file objects
+ in the specified format.
<dt><strong>Options and Parameters:</strong>
<dl>
<dt><code>-h</code> &nbsp;&nbsp;or&nbsp;&nbsp; <code>-?</code> &nbsp;&nbsp;or&nbsp;&nbsp; <code>--help</code>
@@ -160,19 +160,19 @@ These tools enable the user to examine HDF5 files interactively.
<dt><em>file</em>
<dd>The file name may include a printf(3C) integer format
such as <code>%%05d</code> to open a file family.
- <dt><em>group</em>
- <dd>If a group name is not specified then the contents of
- the root group, /, are displayed.
-
- <dt><code> </code>
- <dd>
- <dt><code> </code>
- <dd>
+ <dt><em>objects</em>
+ <dd>The names of zero or more objects about which information
+ should be displayed. If a group is mentioned then
+ information about each of its members is displayed.
+ If no object names are specified then information about
+ all of the objects in the root group is displayed.
</dl>
+<!--
<dt><strong>Current Status:</strong>
<dd>
<dt><strong>See Also:</strong>
<dd>
+-->
</dl>
@@ -200,7 +200,8 @@ These tools enable the user to examine HDF5 files interactively.
<code>m</code> for megabytes, or <code>k</code> for kilobytes.
<p>
File family names include an integer <code>printf</code>
- format such as <code>%%d</code>.
+ format such as <code>%d</code>.
+
<dt><strong>Options and Parameters:</strong>
<dl>
<dt><code>-v</code>
@@ -216,10 +217,12 @@ These tools enable the user to examine HDF5 files interactively.
<dt><em>dest_file</em>
<dd>The name of the destination files
</dl>
+<!--
<dt><strong>Current Status:</strong>
<dd>
<dt><strong>See Also:</strong>
<dd>
+-->
</dl>