[QuantLibAddin-cvs] QuantLibAddin/Docs/pages build.tutorial.docs, 1.1.2.1, 1.1.2.2

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/quantlibaddin/QuantLibAddin/Docs/pages
In directory sc8-pr-cvs7.sourceforge.net:/tmp/cvs-serv5522

Modified Files:
      Tag: R000313f0-branch
	build.tutorial.docs 
Log Message:
update build tutorial

Index: build.tutorial.docs
===================================================================
RCS file: /cvsroot/quantlibaddin/QuantLibAddin/Docs/pages/build.tutorial.docs,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -C2 -d -r1.1.2.1 -r1.1.2.2
*** build.tutorial.docs	7 Aug 2006 14:59:44 -0000	1.1.2.1
--- build.tutorial.docs	10 Aug 2006 20:57:39 -0000	1.1.2.2
***************
*** 1,5 ****

  /*
!  Copyright (C) 2005, 2006 Eric Ehlers

   This file is part of QuantLib, a free-software/open-source library
--- 1,5 ----

  /*
!  Copyright (C) 2006 Eric Ehlers

   This file is part of QuantLib, a free-software/open-source library
***************
*** 42,46 ****
  \ref sec_build_links \n

! \section sec_build_vc8 Visual C++

  This section explains how to install Visual C++ (also known as VC8).  VC8 is
--- 42,46 ----
  \ref sec_build_links \n

! \section sec_build_vc8 Install Visual C++

  This section explains how to install Visual C++ (also known as VC8).  VC8 is
***************
*** 74,80 ****
  \li From the Start menu access <tt>Programs | Microsoft Visual Studio 2005 | Microsoft Visual Studio 2005 Command Prompt</tt>. Change the directory, selecting your Boost top level directory <tt>C:\\Projects\\boost_1_33_1</tt>
  \li run the command:
! \code
! C:\\Projects\\boost_1_33_1>bjam "-sTOOLS=vc-8_0" install
! \endcode
  This command will create the Boost include directory <tt>C:\\Boost\\include\\boost-1_33_1</tt> and the Boost library directory <tt>C:\\Boost\\lib</tt>. Relax: it takes a long while.
  \li You need to configure VC8 with the location of the Boost header files. Under <tt>Tools/Options/Projects and Solutions/VC++ Directories</tt>, select Include files and specify the path to the top level directory containing the Boost header files <tt>C:\\Boost\\include\\boost-1_33_1</tt>:
--- 74,80 ----
  \li From the Start menu access <tt>Programs | Microsoft Visual Studio 2005 | Microsoft Visual Studio 2005 Command Prompt</tt>. Change the directory, selecting your Boost top level directory <tt>C:\\Projects\\boost_1_33_1</tt>
  \li run the command:
! \verbatim
! C:\Projects\boost_1_33_1>bjam "-sTOOLS=vc-8_0" install
! \endverbatim
  This command will create the Boost include directory <tt>C:\\Boost\\include\\boost-1_33_1</tt> and the Boost library directory <tt>C:\\Boost\\lib</tt>. Relax: it takes a long while.
  \li You need to configure VC8 with the location of the Boost header files. Under <tt>Tools/Options/Projects and Solutions/VC++ Directories</tt>, select Include files and specify the path to the top level directory containing the Boost header files <tt>C:\\Boost\\include\\boost-1_33_1</tt>:
***************
*** 116,121 ****
  </table>

! As you're using VC8 be sure to open the workspaces named with the 
! <b>_vc8.sln</b> suffix.

  \section sec_build_directories A Note on Directories
--- 116,122 ----
  </table>

! As you're using VC8 be sure to open the workspaces named with the
! <b>_vc8.sln</b> suffix.  Note that VC6 workspaces are provided for QuantLib but
! not QuantLibAddin.

  \section sec_build_directories A Note on Directories
***************
*** 123,142 ****
  There is one requirement with regard to the directories to which the source
  code is unzipped -  QuantLibAddin and QuantLibXL must reside side by side in
! the directory tree, e.g:
! \code
! C:\\projects\\QuantLibAddin-0.3.13
! C:\\projects\\QuantLibXL-0.3.13
! \endcode

! This is because QuantLibAddin (via gensrc) autogenerates source code into 
! the QuantLibXL directory tree, on the assumption that the two directories
! are side by side.

  The other packages may be installed anywhere.  The location of each package
  is indicated by the appropriate environment variable:
- \li GENSRC_DIR (must be set manually)
  \li QL_DIR (must be set manually)
! \li OBJECT_HANDLER_DIR (set by the installer)
  \li LOG4CXX_DIR (set by the installer)

  \section sec_build_quantlib Install and Build QuantLib
--- 124,158 ----
  There is one requirement with regard to the directories to which the source
  code is unzipped -  QuantLibAddin and QuantLibXL must reside side by side in
! the directory tree, and the name of the QuantLibXL directory must be exactly
! "QuantLibXL" (no version number) e.g:
! \verbatim
! C:\projects\QuantLibAddin-0.3.13
! C:\projects\QuantLibXL
! \endverbatim

! This is because the QuantLibAddin project contains references to the QuantLibXL
! project in the format "..\QuantLibXL".

  The other packages may be installed anywhere.  The location of each package
  is indicated by the appropriate environment variable:
  \li QL_DIR (must be set manually)
! \li GENSRC_DIR (set by the installer)
  \li LOG4CXX_DIR (set by the installer)
+ \li OBJECT_HANDLER_DIR (set by the installer)
+ \li QUANTLIBADDIN_DIR (set by the installer)
+ 
+ For purposes of this tutorial we assume all packages are installed to C:\\projects e.g.:
+ \verbatim
+ C:\projects\QuantLib-0.3.13
+ C:\projects\gensrc-0.1.4
+ C:\projects\log4cxx-0.9.7a
+ C:\projects\ObjectHandler-0.1.4
+ C:\projects\QuantLibAddin-0.3.13
+ C:\projects\QuantLibXL
+ \endverbatim
+ 
+ You need to restart VC8 (and possibly Windows) to pick up changes to the values
+ of environment variables.  The environment variables above are required only
+ during the build process, no environment variables are referenced at run-time.

  \section sec_build_quantlib Install and Build QuantLib
***************
*** 166,170 ****
  It's a good idea to verify the status of the QuantLib library by compiling the testsuite. This will run the testsuite executable automatically (should take less than half an hour in Release configuration, few hours in Debug) and report something like: 

! \code
  1>Auto run test
  1>=====================================
--- 182,186 ----
  It's a good idea to verify the status of the QuantLib library by compiling the testsuite. This will run the testsuite executable automatically (should take less than half an hour in Release configuration, few hours in Debug) and report something like: 

! \verbatim
  1>Auto run test
  1>=====================================
***************
*** 187,191 ****
  1>"file://c:\Projects\QuantLib\test-suite\build\vc80\Release\BuildLog.htm"
  1>testsuite - 0 error(s), 0 warning(s)
! \endcode

  \section sec_build_quantlibfunctions Build QuantLibFunctions
--- 203,207 ----
  1>"file://c:\Projects\QuantLib\test-suite\build\vc80\Release\BuildLog.htm"
  1>testsuite - 0 error(s), 0 warning(s)
! \endverbatim

  \section sec_build_quantlibfunctions Build QuantLibFunctions
***************
*** 198,202 ****
  \section sec_build_log4cxx Install and Build log4cxx

! Download <tt>log4cxx-0.9.7.exe</tt> from the ObjectHandler 0.1.4 section of the
  <a href="http://sourceforge.net/project/showfiles.php?group_id=12740">QuantLib downloads page</a>
  and install it to your hard drive.  The installer sets environment variable
--- 214,218 ----
  \section sec_build_log4cxx Install and Build log4cxx

! Download <tt>log4cxx-0.9.7a.exe</tt> from the ObjectHandler 0.1.4 section of the
  <a href="http://sourceforge.net/project/showfiles.php?group_id=12740">QuantLib downloads page</a>
  and install it to your hard drive.  The installer sets environment variable
***************
*** 204,211 ****

  In VC8, open the log4cxx VC8 workspace
! <tt>log4cxx-0.9.7\\msvc\\log4cxx_vc8.sln</tt>.  Choose configuration
  <tt>Release</tt>, solution <tt>static</tt>, and do <tt>Build/Build Static</tt>.
  The build process creates file
! <tt>log4cxx-0.9.7\\msvc\\lib\\log4cxxs-vc80-mt-s.lib</tt>.

  \section sec_build_objecthandler Install and Build ObjectHandler
--- 220,227 ----

  In VC8, open the log4cxx VC8 workspace
! <tt>log4cxx-0.9.7a\\msvc\\log4cxx_vc8.sln</tt>.  Choose configuration
  <tt>Release</tt>, solution <tt>static</tt>, and do <tt>Build/Build Static</tt>.
  The build process creates file
! <tt>log4cxx-0.9.7a\\msvc\\lib\\log4cxxs-vc80-mt-s.lib</tt>.

  \section sec_build_objecthandler Install and Build ObjectHandler
***************
*** 230,234 ****
  the directory tree.

! There are no environment variables required for the QuantLibAddin/QuantLibXL projects.

  The QuantLibAddin VC8 workspace loads files from the QuantLibXL directory.  Therefore
--- 246,251 ----
  the directory tree.

! The installer sets environment variable QUANTLIBADDIN_DIR.  No environment variable is
! required for the QuantLibXL project.

  The QuantLibAddin VC8 workspace loads files from the QuantLibXL directory.  Therefore
***************
*** 238,244 ****
  In VC8, open the QuantLibAddin VC8 workspace
  <tt>QuantLibAddin\\QuantLibAddin_vc8.sln</tt>.  Choose configuration
! <tt>Release</tt>, solution <tt>AddinExcelStatic</tt>, and do <tt>Build/Build
! AddinExcelStatic</tt>.  The build process creates the QuantLibAddin XLL file
! <tt>QuantLibAddin\\Addins\\Excel\\xll\\QuantLibAddinStatic-vc80-mt-s-0_3_13.xll</tt>.

  \section sec_build_usage Usage
--- 255,261 ----
  In VC8, open the QuantLibAddin VC8 workspace
  <tt>QuantLibAddin\\QuantLibAddin_vc8.sln</tt>.  Choose configuration
! <tt>Release</tt>, solution <tt>QuantLibXL</tt>, and do <tt>Build/Build
! QuantLibXL</tt>.  The build process creates the QuantLibAddin XLL file
! <tt>QuantLibXL\\xll\\QuantLibXL-vc80-mt-s-0_3_13.xll</tt>.

  \section sec_build_usage Usage
***************
*** 246,254 ****
  To launch the QuantLibAddin Excel addin:
  - start Excel
! - load the addin <tt>QuantLibAddin\\Addins\\Excel\\xll\\QuantLibAddinStatic-vc80-mt-s-0_3_13.xll</tt>
! - load a sample spreadsheet e.g. <tt>QuantLibAddin\\Clients\\Excel\\QLADemo.xls</tt>
  - hit <tt>Ctrl-Alt-F9</tt> to force a recalculation of all formulas

! If you want to have the QuantLibAddin XLL loaded every time you start Excel, you can accomplish this as follows:
  \li start Excel
  \li ensure that at least one workbook is loaded - creating a new empty workbook if necessary
--- 263,272 ----
  To launch the QuantLibAddin Excel addin:
  - start Excel
! - load the addin <tt>QuantLibXL\\xll\\QuantLibXL-vc80-mt-s-0_3_13.xll</tt>
! - load a sample spreadsheet e.g. <tt>QuantLibXL\\Workbooks\\OriginalExamples\\instruments.xls</tt>
  - hit <tt>Ctrl-Alt-F9</tt> to force a recalculation of all formulas

! If you want to have the QuantLibAddin XLL loaded every time you start Excel,
! you can accomplish this as follows:
  \li start Excel
  \li ensure that at least one workbook is loaded - creating a new empty workbook if necessary
***************
*** 263,268 ****
  - <a href="http://quantlib.org/developerFAQ.shtml">QuantLib developer FAQ</a>
  - <a href="http://quantlib.org/objecthandler">ObjectHandler home page</a>
! - <a href="http://quantlib.org/quantlibaddin">QuantLibAddin home page</a>
! - <a href="http://quantlib.org/quantlibaddin/faq.html">QuantLibAddin FAQ</a>

  */
--- 281,286 ----
  - <a href="http://quantlib.org/developerFAQ.shtml">QuantLib developer FAQ</a>
  - <a href="http://quantlib.org/objecthandler">ObjectHandler home page</a>
! - <a href="http://www.quantlibaddin.org/">QuantLibAddin home page</a>
! - <a href="http://www.quantlibaddin.org/faq.html">QuantLibAddin FAQ</a>

  */