hdf5/doc/html/H5.user.html
Frank Baker cd3b105997 [svn-r830] ======
Intro
======
H5.intro.html
	Major rewrite to Groups section.  New Example 7 (groups).
	Added TOC and requisite links.
	Numbered sections.
	Labelled figures and centered those that were not.
	Fixed table formatting.

===========
User Guide
===========
H5.user.html
	Linked in Chunking.html.
	Linked in References.html.
	Linked in DDL.html.

Chunking.html
        Minor edits.

DDL.html
References.html
	New documents.

Datatypes.html
	Added "R Reference" to base name description and
	   "H5T_STD_ROBJ -- Reference to an entire object
	   in a file" to list of datatype names.

Files.html
	H5Fflush
	   Added scope parameter.

Groups.html
	Removed references to "current working group."
	Removed H5Gpush, H5Gpop, and H5Gset functions.
        Removed note that H5Glink and H5Gunlink were not implemented.

=================
Reference Manual
=================
RM_*.html and Tools.html
	Updated Reference Manual internal cross-linking (the link
	   banner at the top and bottom of each page).
	Changed
		Returns SUCCEED (0) if successful;
		otherwise FAIL (-1).
	   to read
		Returns a non-negative value if successful;
		otherwise returns a negative value.
	   and several derived changes where circumstances differred
	   only slightly.
	Minor copy edits throughout.

RM_H5.html
	Corrected H5open "Purpose" statement.

RM_H5A.html
	Changed H5Aget_name return type to hssize_t.

RM_H5F.html
	H5Fflush
	   Added scope parameter.
        Added H5Freopen.

RM_H5Front.html
	Reordered listing of interfaces to alphabetical order (H5,
	   H5A, H5D, ...)
 	Added H5I, H5R, and H5RA.

RM_H5G.html
	H5Gopen
	   Edited "Description."
	H5Gget_objinfo
	   Added named datatype to list of valid values for loc_id.

RM_H5I.html  Identifier Interface
	New section.

RM_H5P.html
	Added H5Pset_fill_value and H5Pget_fill_value.
        Several minor copy edits.

RM_H5R.html  Reference Interface
	New section.

H5RA.html
	Essentially a new section.  It was in the tree previously,
	but it did not actually have content.

RM_H5S.html
	Changed H5Sget_select_npoints return type to hssize_t.

Tools.html
	Updated h5dump documentation.
1998-10-29 17:13:17 -05:00

103 lines
3.4 KiB
HTML

<html>
<head>
<title>
HDF5 Uer's Guide
</title>
</head>
<body>
<center><h1>A User Guide for HDF5</h1></center>
<p>The following documents form a loosely organized user's guide
to the HDF5 library.
<ul>
<li><a href="Files.html">HDF5 Files</a> -
A guide to the H5F interface.
<li><a href="Datasets.html">Datasets</a> -
A guide to the H5D interface.
<li><a href="Datatypes.html">Data Types</a> -
A guide to the H5T interface.
<li><a href="Dataspaces.html">Data Spaces</a> -
A guide to the H5S interface.
<li><a href="Groups.html">Groups</a> -
A guide to the H5G interface.
<li><a href="References.html">References and Identifiers</a> -
A guide to the H5R and H5I interfaces.
<li><a href="Attributes.html">Attributes</a> -
A guide to the H5A interface.
<li><a href="Properties.html">Property Lists</a> -
A guide to the H5P interface.
<li><a href="Errors.html">Error Handling</a> -
A guide to the H5E interface.
<li><a href="Filters.html">Filters</a> -
A guide to the H5Z interface.
<li><a href="Caching.html">Caching</a> -
A guide for meta and raw data caching.
<li><a href="Chunking.html">Dataset Chunking</a> -
A guide to the issues and pitfalls of dataset chunking.
<li><a href="Debugging.html">Debugging</a> -
A guide to debugging HDF5 API calls.
<li><a href="Environment.html">Environment Variables and
Configuration Parameters</a> -
A list of HDF5 environment variables and configuration parameters.
<li><a href="DDL.html">DDL for HDF5</a> -
A DDL in BNF for HDF5.
<li><a href="Ragged.html">Ragged Arrays</a> -
A guide to the H5RA interface.
&nbsp;&nbsp;<em><font color=red>(Experimental)</font></em>
</ul>
<p>The following documents form a loosely organized developer's guide to
aspects of the HDF5 library. (Some of the following documents
may be rather out of date as they were working papers for design
goals.)
<ul>
<li><a href="Version.html">Version Numbers</a> -
A description of HDF5 version numbers.
<li><a href="IOPipe.html">I/O Pipeline</a> -
A description of the raw data I/O pipeline.
<li><a href="ExternalFiles.html">Working with External Files</a> -
A guide to the use of multiple files with HDF5.
<li><a href="Big.html">Large Datasets</a> -
A guide to accessing large datasets on small computers.
<li><a href="MemoryManagement.html">Memory Management</a> -
A white paper about memory management issues in HDF5.
<li><a href="Coding.html">Coding Style</a> -
A white paper about coding style in the HDF5 library code.
<li><a href="compat.html">HDF4/HDF5 Compatibility</a> -
A white paper about compatibility issues between HDF4 and HDF5.
<li><a href="study.html">Chunking Performance Study</a> -
A white paper describing the HDF5 chunking performance.
</ul>
<!--
<hr>
<address><a href="mailto:koziol@ncsa.uiuc.edu">Quincey Koziol</a></address>
<address><a href="mailto:matzke@llnl.gov">Robb Matzke</a></address>
-->
<!-- hhmts start -->
<!--
Last modified: Wed Aug 19 15:29:11 PDT 1998
-->
<!-- hhmts end -->
<hr>
<address>
<table width=100% border=0>
<tr><td align=left valign=top>
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
<br>
Last modified: 27 October 1998
</td><td align=right valign=top>
<a href="Copyright.html">Copyright</a>&nbsp;&nbsp;
</td></tr>
</table>
</body>
</html>