mirror of
https://github.com/HDFGroup/hdf5.git
synced 2025-02-11 16:01:00 +08:00
82fb21b613
been checked into "HDF5 Development" branch. General ======= Various "copy edit" types of repairs. Revisions to document cross-linking. Added structural links tying all docs together (banners at top and bottom of documents, similar to Reference Manual banners of the Beta release). Set background color to white in all documents. NCSAfooterlogo.gif hdf2.jpg New image files to make the documents more self-contained (i.e., to prevent loading images from NCSA and HDF home servers). index.html Redesigned to isolate links external to the installation in a single location. Intro to HDF5 ============= H5.intro.html Fixed banner linking Intro to other docs. Set all URLs to be relative within the distribution; nothing points back to the HDF server. Updates to "Limits of the Current Release" and "Changes in the Current Release." HDF5 User's Guide ================= Changed several User Guide section titles such that all sections that are primarily about a particular interface are now titled in the format "The xxxxx Interface (H5x)". H5.user.html Commented out links to developer docs since they are marked in MANIFEST as not being for distribution in the release. Removed 2nd and 3rd indices from page. Changed "freeform" lists of sections (TOCs) to aligned tables. Datatypes.html Removed the sentence "I'm deferring definition until later since they're probably not as important as the other data types." from Section 3.3, "Properties of Date and Time Atomic Types." Added info regarding 'char' versus 'string' datatypes. Added as Section 3.7, "Character and String Datatype Issues." References.html Commented out substantial material (at end of document) from References planning document that is not appropriate for the User Guide but that is worth keeping around. Groups.html Final edits from elimination of "current working group." HDF5 Reference Manual ===================== Removed "Draft" from the <title>__</title> lines. RM_H5Front.html Removed 2nd and 3rd indices from page. Changed "freeform" lists of sections (TOCs) to aligned tables. RM_H5F.html RM_H5P.html Add file mounting information.
285 lines
9.6 KiB
HTML
285 lines
9.6 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
|
|
<html>
|
|
<<<<<<< Environment.html
|
|
<head>
|
|
<title>HDF5 Library Environment Variables and Configuration Parameters</title>
|
|
</head>
|
|
|
|
<body bgcolor="#FFFFFF">
|
|
|
|
|
|
<hr>
|
|
<center>
|
|
<table border=0 width=98%>
|
|
<tr><td valign=top align=left>
|
|
<a href="H5.intro.html">Introduction to HDF5</a> <br>
|
|
<a href="RM_H5Front.html">HDF5 Reference Manual</a> <br>
|
|
<a href="index.html">Other HDF5 documents and links</a> <br>
|
|
<!--
|
|
<a href="Glossary.html">Glossary</a><br>
|
|
-->
|
|
</td>
|
|
<td valign=top align=right>
|
|
And in this document, the
|
|
<a href="H5.user.html">HDF5 User's Guide</a>:
|
|
<a href="Files.html">Files</a>
|
|
<br>
|
|
<a href="Datasets.html">Datasets</a>
|
|
<a href="Datatypes.html">Data Types</a>
|
|
<a href="Dataspaces.html">Dataspaces</a>
|
|
<a href="Groups.html">Groups</a>
|
|
<a href="References.html">References</a>
|
|
<br>
|
|
<a href="Attributes.html">Attributes</a>
|
|
<a href="Properties.html">Property Lists</a>
|
|
<a href="Errors.html">Error Handling</a>
|
|
<a href="Filters.html">Filters</a>
|
|
<a href="Caching.html">Caching</a>
|
|
<br>
|
|
<a href="Chunking.html">Chunking</a>
|
|
<a href="Debugging.html">Debugging</a>
|
|
Environment
|
|
<a href="ddl.html">DDL</a>
|
|
<a href="Ragged.html">Ragged Arrays</a>
|
|
<!--
|
|
<hr>
|
|
And in this document, the
|
|
<a href="H5.user.html">HDF5 User's Guide</a>:
|
|
<a href="Attributes.html">H5A</a>
|
|
<a href="Datasets.html">H5D</a>
|
|
<a href="Errors.html">H5E</a>
|
|
<a href="Files.html">H5F</a>
|
|
<a href="Groups.html">H5G</a>
|
|
<a href="Properties.html">H5P</a>
|
|
<a href="References.html">H5R & H5I</a>
|
|
<a href="Ragged.html">H5RA</a>
|
|
<a href="Dataspaces.html">H5S</a>
|
|
<a href="Datatypes.html">H5T</a>
|
|
<a href="Filters.html">H5Z</a>
|
|
<a href="Caching.html">Caching</a>
|
|
<a href="Chunking.html">Chunking</a>
|
|
<a href="Debugging.html">Debugging</a>
|
|
<a href="Environment.html">Environment</a>
|
|
<a href="ddl.html">DDL</a>
|
|
-->
|
|
</td></tr>
|
|
</table>
|
|
</center>
|
|
<hr>
|
|
|
|
|
|
<h1>HDF5 Library Environment Variables and Configuration Parameters</h1>
|
|
|
|
<h2>1. Environment Variables</h2>
|
|
|
|
The HDF5 library uses UNIX environment variables to control
|
|
or adjust certain library features at runtime. The variables and
|
|
their defined effects are as follows:
|
|
|
|
<dir>
|
|
<dl>
|
|
<dt><tt>HDF5_DEBUG</tt>
|
|
<dd>Defines a list of debugging switches documented in the
|
|
<a href="Debugging.html">Debugging</a> section of the
|
|
<cite>HDF5 User's Guide</cite>.
|
|
|
|
<dt><tt>HDF5_NOCLEANUP</tt>
|
|
<dd>When set to a non-empty value, the programs in the test
|
|
directory do not remove temporary HDF5 data files.
|
|
The default is for each test to remove the files before exit.
|
|
|
|
<dt><tt>HDF5_MPI_OPT_TYPES</tt>
|
|
(for parallel beta version only)
|
|
<dd>When set to <code>1</code>, PHDF5 will use the MPI optimized
|
|
code to perform parallel read/write accesses to datasets.
|
|
Currently, this optimization fails when accessing extendable
|
|
datasets. The default is not to use the optimized code.
|
|
|
|
<dt><tt>HDF5_MPI_1_METAWRITE</tt>
|
|
(for parallel beta version only)
|
|
<dd>When set to <code>1</code>, PHDF5 will write the metadata
|
|
via process 0 of each opened parallel HDF5 file. This should
|
|
improve I/O throughput. The default is not to use this
|
|
optimization.
|
|
|
|
</dl>
|
|
</dir>
|
|
|
|
<h2>2. Configuration Parameters</h2>
|
|
|
|
The HDF5 configuration script accepts a list of parameters to control
|
|
configuration features when creating the Makefiles for the library.
|
|
The command
|
|
<br>
|
|
<code> configure --help </code>
|
|
<br>
|
|
will display the current list of parameters and their effects.
|
|
|
|
|
|
<hr>
|
|
<center>
|
|
<table border=0 width=98%>
|
|
<tr><td valign=top align=left>
|
|
<a href="H5.intro.html">Introduction to HDF5</a> <br>
|
|
<a href="RM_H5Front.html">HDF5 Reference Manual</a> <br>
|
|
<a href="index.html">Other HDF5 documents and links</a> <br>
|
|
<!--
|
|
<a href="Glossary.html">Glossary</a><br>
|
|
-->
|
|
</td>
|
|
<td valign=top align=right>
|
|
And in this document, the
|
|
<a href="H5.user.html">HDF5 User's Guide</a>:
|
|
<a href="Files.html">Files</a>
|
|
<br>
|
|
<a href="Datasets.html">Datasets</a>
|
|
<a href="Datatypes.html">Data Types</a>
|
|
<a href="Dataspaces.html">Dataspaces</a>
|
|
<a href="Groups.html">Groups</a>
|
|
<a href="References.html">References</a>
|
|
<br>
|
|
<a href="Attributes.html">Attributes</a>
|
|
<a href="Properties.html">Property Lists</a>
|
|
<a href="Errors.html">Error Handling</a>
|
|
<a href="Filters.html">Filters</a>
|
|
<a href="Caching.html">Caching</a>
|
|
<br>
|
|
<a href="Chunking.html">Chunking</a>
|
|
<a href="Debugging.html">Debugging</a>
|
|
Environment
|
|
<a href="ddl.html">DDL</a>
|
|
<a href="Ragged.html">Ragged Arrays</a>
|
|
<!--
|
|
<hr>
|
|
And in this document, the
|
|
<a href="H5.user.html">HDF5 User's Guide</a>:
|
|
<a href="Attributes.html">H5A</a>
|
|
<a href="Datasets.html">H5D</a>
|
|
<a href="Errors.html">H5E</a>
|
|
<a href="Files.html">H5F</a>
|
|
<a href="Groups.html">H5G</a>
|
|
<a href="Properties.html">H5P</a>
|
|
<a href="References.html">H5R & H5I</a>
|
|
<a href="Ragged.html">H5RA</a>
|
|
<a href="Dataspaces.html">H5S</a>
|
|
<a href="Datatypes.html">H5T</a>
|
|
<a href="Filters.html">H5Z</a>
|
|
<a href="Caching.html">Caching</a>
|
|
<a href="Chunking.html">Chunking</a>
|
|
<a href="Debugging.html">Debugging</a>
|
|
<a href="Environment.html">Environment</a>
|
|
<a href="ddl.html">DDL</a>
|
|
-->
|
|
</td></tr>
|
|
</table>
|
|
</center>
|
|
|
|
|
|
<hr>
|
|
|
|
<address>
|
|
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
|
|
</address>
|
|
=======
|
|
<head>
|
|
<title>HDF5 Library Environment Variables
|
|
and Configuration Parameters</title>
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<h1>HDF5 Library Environment Variables and Configuration Parameters</h1>
|
|
|
|
<h2>1. Environment Variables</h2>
|
|
|
|
The HDF5 library uses UNIX environment variables to control
|
|
or adjust certain library features at runtime. The variables and
|
|
their defined effects are as follows:
|
|
|
|
<center>
|
|
<table width="90%">
|
|
<tr>
|
|
<th>Variable</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
|
|
<tr valign=top>
|
|
<td><code>HDF5_DEBUG</code></td>
|
|
<td>Defines a list of debugging switches documented in the
|
|
<a href="Debugging.html">Debugging</a> section of the
|
|
<cite>HDF5 User's Guide</cite>.</td>
|
|
</tr>
|
|
|
|
<tr valign=top>
|
|
<td><code>HDF5_NOCLEANUP</code></td>
|
|
<td>If set then programs in the test directories do not
|
|
remove temporary files. The default is for each test to
|
|
remove the files before exit if the test succeeds but to
|
|
leave the files if the test fails.</td>
|
|
</tr>
|
|
|
|
<tr valign=top>
|
|
<td><code>HDF5_PREFIX</code></td>
|
|
<td>The value of this variable is prepended to all temporary
|
|
file names created by the test programs and separated from
|
|
the base name of the file by a slash. The default is no
|
|
prefix.</td>
|
|
</tr>
|
|
|
|
<tr valign=top>
|
|
<td><ode>HDF5_DRIVER</code></td>
|
|
<td>This variable should hold the name of a low-level HDF5
|
|
file driver such as <code>sec2</code>, <code>stdio</code>,
|
|
<code>core</code>, <code>split</code>, or
|
|
<code>family</code>. The family driver also takes an
|
|
optional real-valued family member size in MB which
|
|
defaults to 1. If this variable is not set or empty then
|
|
the library-defined default file driver is used (which can
|
|
be set at configuration time with the H5F_LOW_DFLT cpp
|
|
constant, usually <code>sec2</code>).</td>
|
|
</tr>
|
|
|
|
<tr valign=top>
|
|
<td><code>HDF5_MPI_OPT_TYPES</code></td>
|
|
<td>When set to <code>1</code>, parallel HDF5 will use the
|
|
MPI-optimized code to perform parallel read/write accesses
|
|
to datasets. Currently, this optimization fails when
|
|
accessing extendable datasets. The default is not to use
|
|
the optimized code.</td>
|
|
</tr>
|
|
|
|
<tr valign=top>
|
|
<td><code>HDF5_MPI_1_METAWRITE</code></td>
|
|
<td>When set to <code>1</code>, parallel HDF5 will write the
|
|
metadata via process 0 of each opened parallel HDF5 file.
|
|
This should improve I/O throughput. The default is not to
|
|
use this optimization.</td>
|
|
</tr>
|
|
|
|
</table>
|
|
</center>
|
|
|
|
|
|
<h2>2. Configuration Parameters</h2>
|
|
|
|
The HDF5 configuration script accepts a list of parameters to control
|
|
configuration features when creating the Makefiles for the library.
|
|
The command
|
|
<br>
|
|
<code> configure --help </code>
|
|
<br>
|
|
will display the current list of parameters and their effects.
|
|
|
|
|
|
<hr>
|
|
<address>
|
|
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
|
|
</address>
|
|
|
|
Last modified: 25 November 1998
|
|
|
|
|
|
</body>
|
|
</html>
|
|
|