[DAT/DAPL] document DAT build environment.

  Document DAPLtest scripts: dt-svr.bat & dt-cli.bat

git-svn-id: svn://openib.tc.cornell.edu/gen1@794 ad392aa1-c5ef-ae45-8dd8-e69d62a5ef86

diff --git a/trunk/docs/Manual.htm b/trunk/docs/Manual.htm
index b310d8a8674bf48028096660610f304442e5efb7..3f58fe83a1ef6d606e67e9d991360b7167dfe5ed 100644 (file)
--- a/trunk/docs/Manual.htm
+++ b/trunk/docs/Manual.htm
@@ -13,9 +13,9 @@ div.Section1
 <a name="TOP" href="#TOP"></a> </h1>\r
 <h1 align="center">Windows OpenFabrics </h1>\r
 <h1 align="center">User's Manual</h1>\r
-<h2 align="center">Release 1.0</h2>\r
+<h2 align="center">Release 1.0.1</h2>\r
 <h3 align="center">\r
-<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%m/%d/%Y" startspan -->08/14/2007<!--webbot bot="Timestamp" endspan i-checksum="12578" --></h3>\r
+<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%m/%d/%Y" startspan -->09/07/2007<!--webbot bot="Timestamp" endspan i-checksum="12620" --></h3>\r
 <h2 align="left"><u>Overview</u></h2>\r
 <p align="left"><span style="FONT-SIZE: 12pt; FONT-FAMILY: 'Times New Roman'">\r
 The Windows OpenFabrics (WinOF) package is composed of software modules intended \r
@@ -132,6 +132,9 @@ Display HCA attributes, statistics and error counters.<br>&nbsp;</li>
        <li>\r
        <h4 align="left"><a href="#DAPLtest-examples">DAPLtest Examples</a></h4>\r
        </li>\r
+       <li>\r
+       <p align="left"><b><a href="#DAT_App_Build">DAT Application Build</a></b><br>\r
+&nbsp;</li>\r
 </ul></li>\r
        <li>\r
        <h3 align="left"><a href="#SRP">SRP - SCSI RDMA Protocol</a></h3></li>\r
@@ -1141,7 +1144,7 @@ IPoIB.</p>
 </div>\r
 <p align="left">&nbsp;</p>\r
 <div align="left">\r
-       <h3 align="left"><font face="Courier New" size="3">DAT EXECUTION ENVIRONMENT</font><font face="Courier New" size="2">:</font></h3>\r
+       <h3 align="left"><font face="Courier New" size="3">DAT ENVIRONMENT</font><font face="Courier New" size="2">:</font></h3>\r
 </div>\r
 <blockquote>\r
        <p align="left"><font face="Courier New" size="2">In order for DAT/uDAPL \r
@@ -1167,14 +1170,35 @@ IPoIB.</p>
        all backslashes in the library path must be duplicated when enclosed in \r
        double-quotes\r
        (e.g., &quot;C:\\Programs Files\\WinOF\\dapl.dll&quot;).</font></p>\r
-       <p align="left"><font face="Courier New" size="2">A sample dat.conf file is \r
-       installed as '\Program Files\WinOF\dat.conf '.<br>\r
-       After the WinOF installation, move the \Program Files\WinOF\dat.conf file to \r
-       the default DAT configuration file location\r
-       '%SystemDrive%\DAT\dat.conf'.</font></p>\r
-       <p align="left"><font face="Courier New" size="2">In order to preserve existing installations, \r
-       the dat.conf file is not automatically installed in it's default location.</font></p>\r
-       <p align="left">&nbsp;</p>\r
+       <p align="left"><font face="Courier New" size="2">A sample InfiniBand dat.conf file is \r
+       installed as '\Program Files\WinOF\dat.conf '.&nbsp; If dat.conf does not \r
+       exist in the DAT default configuration folder '%SystemDrive%\DAT\', dat.conf \r
+       will be copied there.</font></p>\r
+       <p align="left"><b>\r
+<u><a name="DAT_App_Build"></a>DAT application build environment</u>:</b></p>\r
+       <p align="left"><font face="Courier New" size="2">DAT library header files \r
+       are selectively installed in the DAT default configuration folder as<br>'%SystemDrive%\DAT\v1-1' \r
+       or\r
+       '%SystemDrive%\DAT\v2-0'. Your C language based DAT 1.1 application compilation command line \r
+       should include'/I%SystemDrive%\DAT\v1-1' with C code referencing '#include &lt;DAT\dat.h&gt;'.<br>\r
+       <br>\r
+       Visual Studio 2005 command window - (nmake) Makefile Fragments:</font></p>\r
+       <blockquote>\r
+               <p align="left"><font face="Courier New" size="2">DAT_PATH=%SystemDrive%\DAT\v1-1<br>\r
+               CC = cl<br>\r
+               INC_FLAGS = /I $(DAT_PATH)<br>\r
+               <br>\r
+               CC_FLAGS= /nologo /Gy /W3 /Gm- /GR- /GF /O2 /Oi /Oy- /D_CRT_SECURE_NO_WARNINGS \r
+               \<br>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; /D_WIN64 \r
+               /D_X64_ /D_AMD64_ $(INC_FLAGS) <br>\r
+               <br>\r
+               LINK = link<br>\r
+               LIBS = ws2_32.lib advapi32.lib User32.lib bufferoverflowU.lib dat.lib<br>\r
+               <br>\r
+               LINK_FLAGS = /nologo /subsystem:console /machine:X64 \r
+               /libpath:$(DAT_PATH) $(LIBS)</font><b><br>&nbsp;</b></p>\r
+       </blockquote>\r
        <h4>\r
 <u>DAT library environment variables</u>:<br>\r
 &nbsp;</h4>\r
@@ -1187,8 +1211,8 @@ default location, 'C:\DAT\dat.conf'.
 Example: set DAT_OVERRIDE=%SystemDrive%\path\to\my\private.conf\r
 \r
 \r
-DAT_DBG_TYPE\r
-------------\r
+DAT_DBG_LEVEL\r
+-------------\r
 \r
 Value specifies which parts of the registry will print debugging\r
 information, valid values are \r
@@ -1204,7 +1228,7 @@ DAT_OS_DBG_TYPE_ALL          = 0xff
 or any combination of these. For example you can use 0xC to get both \r
 static and dynamic registry output.\r
 \r
-Example set DAT_DBG_TYPE=0xC\r
+Example set DAT_DBG_LEVEL=0xC\r
 \r
 DAT_DBG_DEST\r
 ------------ \r
@@ -1545,7 +1569,17 @@ USAGE - Limit test client
                         with two thread using four EPs each,\r
                         sending a more complicated buffer pattern\r
                         for a larger number of iterations,\r
-                        validating the data received.\r
+                        validating the data received.</pre>\r
+<pre>\r
+dt-svr.bat - DAPLtest server script; starts a DAPLtest server on the local node.\r
+       dt-svr [-D [hex-debug-bitmask] ]</pre>\r
+<pre>\r
+dt-cli.bat - DAPLtest client; drives testing by interacting with dt-svr.bat script.\r
+       dt-cli host-IPv4-address testname\r
+               example: dt-cli 10.10.2.20 trans\r
+                        dt-cli -h  # outputs help text.</pre>\r
+<pre>\r
+Verify dt-*.bat script is running same dapltest.exe(v1.1) or dapl2test.exe(v2.0)\r
 \r
 \r
 BUGS  (and  To Do List)\r