[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.

1 files changed, 49 insertions, 15 deletions

diff --git a/doc/src/RM_H5F.html b/doc/src/RM_H5F.html
index 926d7ba..5ecc148 100644
--- a/doc/src/RM_H5F.html
+++ b/doc/src/RM_H5F.html
@@ -18,7 +18,10 @@ H5F  
 <a href="RM_H5S.html">H5S</a>&nbsp;&nbsp;
 <a href="RM_H5T.html">H5T</a>&nbsp;&nbsp;
 <a href="RM_H5Z.html">H5Z</a>&nbsp;&nbsp;
+<a href="Tools.html">Tools</a>&nbsp;&nbsp;
+<!--
 <a href="Glossary.html">Glossary</a>
+-->
 </center>
 <hr>
 
@@ -37,16 +40,17 @@ documented below.
 <ul>
     <li><a href="#File-Open">H5Fopen</a>
     <li><a href="#File-Create">H5Fcreate</a>
+    <li><a href="#File-IsHDF5">H5Fis_hdf5</a>
 </ul>
 </td><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td><td valign=top>
 <ul>
-    <li><a href="#File-IsHDF5">H5Fis_hdf5</a>
+    <li><a href="#File-Flush">H5Fflush</a>
     <li><a href="#File-Close">H5Fclose</a>
 </ul>
 </td><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td><td valign=top>
 <ul>
-    <li><a href="#File-GetCreateTemplate">H5Fget_create_template</a>
-    <li><a href="#File-GetAccessTemplate">H5Fget_access_template</a>
+    <li><a href="#File-GetCreatePlist">H5Fget_create_plist</a>
+    <li><a href="#File-GetAccessPlist">H5Fget_access_plist</a>
 </ul>
 </td></tr>
 </table>
@@ -126,8 +130,8 @@ documented below.
             The more complex behaviors of file creation and access
             are controlled through the file-creation and file-access
             property lists.  The value of <code>H5P_DEFAULT</code> for 
-            a template value indicates that the library should use 
-            the default values for the appropriate template.  Also see 
+            a property list value indicates that the library should use
+            the default values for the appropriate property list.  Also see
             <code>H5Fpublic.h</code> for the list of supported flags. 
 <dt><strong>Parameters:</strong>
     <dl>
@@ -151,14 +155,14 @@ documented below.
                         <dd>Apply default file access and creation properties.
                 </dl></ul>
         <dt><em>hid_t</em> <code>create_id</code>
-            <dd>File creation template identifier, used when modifying 
+            <dd>File creation property list identifier, used when modifying
                 default file meta-data.
         <dt><em>hid_t</em> <code>access_id</code>
             <dd>File access property list identifier.
                 If parallel file access is desired, this is a collective
                 call according to the communicator stored in the
-                <code>access_template</code>.  
-                Use <code>0</code> for default access template.
+                <code>access_id</code>. 
+                Use <code>0</code> for default access properties.
     </dl>
 <dt><strong>Returns:</strong>
     <dd>Returns a file identifier if successful;
@@ -168,6 +172,33 @@ documented below.
 
 <hr>
 <dl>
+<dt><strong>Name:</strong> <a name="File-Flush">H5Fflush</a>
+<dt><strong>Signature:</strong>
+    <dd><em>herr_t </em><code>H5Fis_hdf5</code>(<em>hid_t </em><code>object_id</code>
+        )
+<dt><strong>Purpose:</strong>
+        <dd>Flushes all buffers associated with a file to disk.
+<dt><strong>Description:</strong>
+        <dd><code>H5Fflush</code> causes all buffers associated with a
+        file to be immediately flushed to disk without removing the
+        data from the cache.  
+        <p>
+        <code>object_id</code> can be any object associated with the file, 
+        including the file itself, a dataset, a group, an attribute, or 
+        a named data type.
+<dt><strong>Parameters:</strong>
+    <dl>
+        <dt><em>const char *</em><code>object_id</code>
+            <dd>Identifier of object used to identify the file.
+    </dl>
+<dt><strong>Returns:</strong>
+    <dd>Returns SUCCEED (0) if successful;
+        otherwise returns FAIL (-1).
+</dl>
+
+
+<hr>
+<dl>
 <dt><strong>Name:</strong> <a name="File-IsHDF5">H5Fis_hdf5</a>
 <dt><strong>Signature:</strong>
     <dd><em>hbool_t </em><code>H5Fis_hdf5</code>(<em>const char *</em><code>name</code>
@@ -190,14 +221,14 @@ documented below.
 
 <hr>
 <dl>
-<dt><strong>Name:</strong> <a name="File-GetCreateTemplate">H5Fget_create_template</a>
+<dt><strong>Name:</strong> <a name="File-GetCreatePlist">H5Fget_create_plist</a>
 <dt><strong>Signature:</strong>
-    <dd><em>hid_t </em><code>H5Fget_create_template</code>(<em>hid_t</em> <code>file_id</code>
+    <dd><em>hid_t </em><code>H5Fget_create_plist</code>(<em>hid_t</em> <code>file_id</code>
         )
 <dt><strong>Purpose:</strong>
         <dd>Returns a file creation property list identifier.
 <dt><strong>Description:</strong>
-        <dd><code>H5Fget_create_template</code> returns a file creation 
+        <dd><code>H5Fget_create_plist</code> returns a file creation 
             property list identifier identifying the creation properties 
             used to create this file.  This function is useful for 
             duplicating properties when creating another file.
@@ -222,13 +253,13 @@ documented below.
 
 <hr>
 <dl>
-<dt><strong>Name:</strong> <a name="File-GetAccessTemplate">H5Fget_access_template</a>
+<dt><strong>Name:</strong> <a name="File-GetAccessPlist">H5Fget_access_plist</a>
 <dt><strong>Signature:</strong>
-    <dd><em>hid_t </em><code>H5Fget_access_template</code>(<em>hid_t</em> <code>file_id</code>)
+    <dd><em>hid_t </em><code>H5Fget_access_plist</code>(<em>hid_t</em> <code>file_id</code>)
 <dt><strong>Purpose:</strong>
         <dd>Returns a file access property list identifier.
 <dt><strong>Description:</strong>
-        <dd><code>H5Fget_access_template</code> returns the 
+        <dd><code>H5Fget_access_plist</code> returns the 
             file access property list identifier of the specified file.
             <p>
             See "File Access Properties" in 
@@ -286,7 +317,10 @@ H5F&nbsp;&nbsp;
 <a href="RM_H5S.html">H5S</a>&nbsp;&nbsp;
 <a href="RM_H5T.html">H5T</a>&nbsp;&nbsp;
 <a href="RM_H5Z.html">H5Z</a>&nbsp;&nbsp;
+<a href="Tools.html">Tools</a>&nbsp;&nbsp;
+<!--
 <a href="Glossary.html">Glossary</a>
+-->
 </center>
 <hr>
 
@@ -294,7 +328,7 @@ H5F&nbsp;&nbsp;
 <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> 
 
 <br>
-Last modified:  14 July 1998
+Last modified:  14 August 1998
 
 </body>
 </html>