summaryrefslogtreecommitdiffstats
path: root/doc/html/TechNotes/SWControls.html
blob: 8dac1ceeb3acbdbc35b791325708bc3105e733af (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
<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>HDF5 Software Controls</H1>

<P>
<I>(Work in progress draft)</i>
</P>

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

<P>
<H2><FONT FACE="Arial">Library Building Controls</FONT></H2>
</P>

<P>
<H3><FONT FACE="Arial">Environment variables</FONT></H3>
</P>

<DL>
	<DT><B>CC</B></DT>
		<DD><I>Used by configure.</I> Override the default C compiler.</DD>
	<DT><B>LIBS</B></DT>
		<DD><I>Used by configure.</I> Add more libraries to be used.</DD>
	<DT><B>NP</B></DT>
		<DD>Number of MPI-processes to invoke for testing. Default to 2.</DD>
	<DT><B>HDF5_NOCLEANUP</B></DT>
		<DD><I>Used by most test programs.</I> 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.</DD>
	<DT><B>H5FD_mpio_Debug</B></DT>
		<DD><I>Used by the MPIO file driver for debugging.</I> 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:
				<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>
		</DD>
	<DT><B>HDF5_MPI_OPT_TYPES</B></DT>
		<DD><I>Used by the MPIO file driver to control the use of the optimized
				mpi input/output routine.</I> 0 turns it off, 1 turns it on (uses
				optimized code if it can).</DD>
</DL>

<P>
<H3><FONT FACE="Arial">Compile Macros</FONT></H3>
</P>

<DL>
	<DT><B>H5FDmpio_DEBUG</B></DT>
		<DD><I>Compile macro.</I> Compile in the MPIO file driver related debugging
				statements. Defined if macro H5F_DEBUG is defined.</DD>
	<DT><B>H5FD_mpio_Debug</B></DT>
		<DD>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.</DD>
</DL>

<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: December 11, 2000 <!-- hhmts end --></P>

</BODY>
</HTML>