summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorAlbert Cheng <acheng@hdfgroup.org>2000-09-26 16:10:33 (GMT)
committerAlbert Cheng <acheng@hdfgroup.org>2000-09-26 16:10:33 (GMT)
commitd01a78001faa924fd31ae27bb748648442c8913a (patch)
tree2d82665f75f4c6e614d445876f8c2f5aad7a7df0 /doc
parent406b5334a38d7ae2d91f593bb767903f9d7321c4 (diff)
downloadhdf5-d01a78001faa924fd31ae27bb748648442c8913a.zip
hdf5-d01a78001faa924fd31ae27bb748648442c8913a.tar.gz
hdf5-d01a78001faa924fd31ae27bb748648442c8913a.tar.bz2
[svn-r2595] Purpose:
Feature Description: Added a new document of all the controls (compiler macros, environment variables, ...) that affect the functionality of the libraries and tools. Platforms tested: Viewed with MS IE.
Diffstat (limited to 'doc')
-rw-r--r--doc/html/TechNotes.html6
-rwxr-xr-xdoc/html/TechNotes/SWControls.html37
2 files changed, 43 insertions, 0 deletions
diff --git a/doc/html/TechNotes.html b/doc/html/TechNotes.html
index 4a9c6b2..83145b0 100644
--- a/doc/html/TechNotes.html
+++ b/doc/html/TechNotes.html
@@ -158,6 +158,12 @@ HDF5 Technical Notes&nbsp;&nbsp;
datatypes, etc.
</td></tr>
+<tr><td valign=top><a href="TechNotes/SWControls.html">HDF5 Software Controls</a>
+ </td><td>&nbsp;</td><td valign=top>
+ A descriptions knobs and turns such as environment variables and settings
+ that controls the functionalities of HDF5 libraries and tools.
+</td></tr>
+
</table>
</center>
diff --git a/doc/html/TechNotes/SWControls.html b/doc/html/TechNotes/SWControls.html
new file mode 100755
index 0000000..c99d46f
--- /dev/null
+++ b/doc/html/TechNotes/SWControls.html
@@ -0,0 +1,37 @@
+<HTML>
+<HEAD>
+<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=windows-1252">
+<META NAME="Generator" CONTENT="Microsoft Word 97">
+<TITLE>HDF5 Software Controls</TITLE>
+<META NAME="Template" CONTENT="E:\Program Files\Microsoft Office\Office\html.dot">
+</HEAD>
+<BODY LINK="#0000ff" VLINK="#800080">
+
+<H1><!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">HDF5 Software Controls</H1>
+<I><P>(Work in progress draft)</P>
+</I><P>A descriptions knobs and turns such as environment variables and settings that controls the functionality of HDF5 libraries and tools. This is intended for HDF5 libraries and tools developers. HDF5 application users may consult the document <A HREF="../Debugging.html"><I>A guide to debugging HDF5 API calls</I></A>.</P>
+<B><FONT FACE="Arial" SIZE=4><P>Library Building Controls</P>
+</FONT><I><FONT FACE="Arial"><P>Environment variables</P>
+</B></I></FONT><P>CC -- Used by configure. Override the default C compiler.</P>
+<P>LIBS -- Used by configure. Add more libraries to be used.</P>
+<P>NP -- number of MPI-processes to invoke for testing. Default to 2.</P>
+<P>HDF5_NOCLEANUP -- Used by most test programs. When set, temporary files created during tests are NOT removed. Default is to remove them by the end of each test. Note that the variable value does not matter. E.g., the values of "yes", "no" and "" all have the same effect, that is, NO cleanup.</P>
+<P>H5FD_mpio_Debug--Used by the MPIO file driver for debugging. Need to have H5FDmpio_DEBUG macro defined during compiling. Should be set to a string to turn on various tracing. Valid values (cases matter) are:</P>
+<DL>
+<DT>t</DT>
+<DD>Trace all routine</DD>
+<DT>r</DT>
+<DD>Trace read routines</DD>
+<DT>w</DT>
+<DD>Trace write routines</DD>
+<DT>c</DT>
+<DD>Show result of MPI_Get_count</DD>
+</DL>
+<P>&nbsp;</P>
+<B><I><FONT FACE="Arial"><P>Compile Macros</P>
+</B></I></FONT><P>H5FDmpio_DEBUG--compile macro. Compile in the MPIO file driver related debugging statements. Defined if macro H5F_DEBUG is defined.</P>
+<P>H5FD_mpio_Debug--Compile in debugging used by the MPIO file driver. Need to have H5FDmpio_DEBUG macro defined during compiling. Should be set to a string to turn on the tracing. See environment variable H5FD_mpio_Debug for valid values.</P>
+<P><HR></P>
+<ADDRESS><A HREF="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</A></ADDRESS>
+<P><!-- Created: Fri Oct 3 11:52:31 EST 1997 --><!-- hhmts start -->Last modified: September 26, 2000 <!-- hhmts end --></P></BODY>
+</HTML>