Changeset 19201
- Timestamp:
- 08/13/06 09:37:05 (2 years ago)
- Files:
-
- juggler/branches/2.0/INSTALL.html (modified) (7 diffs)
- juggler/branches/2.0/INSTALL.txt (modified) (14 diffs)
Legend:
- Unmodified
- Added
- Removed
- Modified
- Copied
- Moved
juggler/branches/2.0/INSTALL.html
r18954 r19201 1 1 <html><head> 2 2 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> 3 <title>Building and Installing the Juggler Project (Version 2.0)</title><link rel="stylesheet" href="base_style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.70.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article" lang="en"><div class="titlepage"><div><div><h1 class="title"><a name="d0e1"></a>Building and Installing the Juggler Project (Version 2.0)</h1></div><div><div class="authorgroup"><div class="author"><h3 class="author"><span class="othername">The Juggler Team</span></h3></div></div></div><div><p class="pubdate">$Date$</p></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#d0e15">Introduction</a></span></dt><dd><dl><dt><span class="section"><a href="#d0e30">Important Notes for IRIX Users</a></span></dt><dt><span class="section"><a href="#d0e114">Important Note for Windows Users</a></span></dt></dl></dd><dt><span class="section"><a href="#source.code.section">Getting the Source Code and the Dependencies</a></span></dt><dd><dl><dt><span class="section"><a href="#section.cvs.access">How to Get the Juggler Suite from CVS</a></span></dt><dt><span class="section"><a href="#d0e216">Downloading Third-Party Dependencies</a></span></dt></dl></dd><dt><span class="section"><a href="#compile.section">Compiling</a></span></dt><dd><dl><dt><span class="section"><a href="#d0e308">Important Note Regarding Compiling</a></span></dt><dt><span class="section"><a href="#d0e319">Compiling the Juggler Suite of Tools</a></span></dt><dt><span class="section"><a href="#compile.individual.section">Tips for Compiling Individual Tools in the Juggler3 <title>Building and Installing the Juggler Project (Version 2.0)</title><link rel="stylesheet" href="base_style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.70.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article" lang="en"><div class="titlepage"><div><div><h1 class="title"><a name="d0e1"></a>Building and Installing the Juggler Project (Version 2.0)</h1></div><div><div class="authorgroup"><div class="author"><h3 class="author"><span class="othername">The Juggler Team</span></h3></div></div></div><div><p class="pubdate">$Date$</p></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#d0e15">Introduction</a></span></dt><dd><dl><dt><span class="section"><a href="#d0e30">Important Notes for IRIX Users</a></span></dt><dt><span class="section"><a href="#d0e114">Important Note for Windows Users</a></span></dt></dl></dd><dt><span class="section"><a href="#source.code.section">Getting the Source Code and the Dependencies</a></span></dt><dd><dl><dt><span class="section"><a href="#section.cvs.access">How to Get the Juggler Suite from Subversion</a></span></dt><dt><span class="section"><a href="#d0e216">Downloading Third-Party Dependencies</a></span></dt></dl></dd><dt><span class="section"><a href="#compile.section">Compiling</a></span></dt><dd><dl><dt><span class="section"><a href="#d0e308">Important Note Regarding Compiling</a></span></dt><dt><span class="section"><a href="#d0e319">Compiling the Juggler Suite of Tools</a></span></dt><dt><span class="section"><a href="#compile.individual.section">Tips for Compiling Individual Tools in the Juggler 4 4 Suite</a></span></dt></dl></dd></dl></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e15"></a>Introduction</h2></div></div></div><p>You have downloaded the source code for Version 2.0 of the Juggler 5 5 Project. This document explains how to build the modules of the Juggler 6 6 Project from the source code. We begin by explaining some issues related 7 7 to specific operating systems. We then explain how to get the source 8 code from our CVS repository. (Those users who downloaded a pre-packaged 9 source release can skip ahead to <a href="#using.configure.pl" title="Using configure.pl">the section called “Using <span><strong class="command">configure.pl</strong></span>”</a>). 10 We conclude with instructions on how to build VR Juggler and its 11 individual components.</p><p>Before reading further, we recommend that readers take a look at 12 the Wiki page relating to building from CVS (<a href="http://www.vrjuggler.org/twiki_public/bin/view/Juggler/BuildingFromCvs" target="_top">http://www.vrjuggler.org/twiki_public/bin/view/Juggler/BuildingFromCvs</a>). 8 code from our Subversion repository. (Those users who downloaded a 9 pre-packaged source release can skip ahead to <a href="#using.configure.pl" title="Using configure.pl">the section called “Using <span><strong class="command">configure.pl</strong></span>”</a>). We conclude with instructions on how 10 to build VR Juggler and its individual components.</p><p>Before reading further, we recommend that readers take a look at 11 the Wiki page relating to building from source (<a href="http://www.vrjuggler.org/twiki_public/bin/view/Juggler/BuildingFromSvn" target="_top">http://www.vrjuggler.org/twiki_public/bin/view/Juggler/BuildingFromSvn</a>). 13 12 It is a <span class="emphasis"><em>supplement</em></span> to this document containing tips 14 and reminders for those users building the CVSversion of VR Juggler. It13 and reminders for those users building the SVN version of VR Juggler. It 15 14 is not a replacement for this document, nor can it stand on its own as 16 15 build instructions. You are reading the definitive build instructions; … … 66 65 Studio 6.0, and it appears that they have no plans to fix these 67 66 problems. Therefore, we require the use of Visual Studio 7.x (.NET 68 2002 or 2003) to compile the source code.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="source.code.section"></a>Getting the Source Code and the Dependencies</h2></div></div></div><p>In this section, we explain how to get the Juggler Project source67 2002 or 2003) or newer to compile the source code.</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="source.code.section"></a>Getting the Source Code and the Dependencies</h2></div></div></div><p>In this section, we explain how to get the Juggler Project source 69 68 code and the dependencies required to build Juggler. There are two ways 70 69 to get the source code: from a pre-packaged source release archive or 71 from the CVS repository on SourceForge. If you got the code from a72 pre-packaged source archive, that code is a complete73 “<span class="quote">snapshot</span>” of the CVS repository at the time of release. It74 contains all dependencies that would otherwise have been acquired using75 CVS. It <span class="emphasis"><em>does not</em></span> contain binary dependencies that76 must be downloaded separately (such as NSPR, the Java Developer Kit, a77 C++ compiler, etc.).</p><p>The current list of <span class="emphasis"><em>required</em></span> software70 from the Subversion repository on RealityForge. If you got the code from 71 a pre-packaged source archive, that code is a complete 72 “<span class="quote">snapshot</span>” of the Subversion repository at the time of 73 release. It contains all dependencies that would otherwise have been 74 acquired using Subversion. It <span class="emphasis"><em>does not</em></span> contain 75 binary dependencies that must be downloaded separately (such as NSPR, 76 the Java Developer Kit, a C++ compiler, etc.).</p><p>The current list of <span class="emphasis"><em>required</em></span> software 78 77 packages is as follows:</p><div class="itemizedlist"><ul type="disc"><li><p>CppDOM (<a href="http://www.sourceforge.net/projects/xml-cppdom/" target="_top">http://www.sf.net/projects/xml-cppdom/</a>): 79 78 A lightweight, easy-to-use XML parser written in C++. CppDOM must … … 99 98 use of extensions to CppUnit. An extended version of the CppUnit 100 99 source that includes these extensions can be acquired from the 101 Juggler CVS repository in the module <code class="literal">cppunit</code>.102 Refer to <a href="#section.cvs.access" title="How to Get the Juggler Suite from CVS">the section called “How to Get the Juggler Suite from CVS”</a> for instructions103 about accessing the Juggler CVSrepository.</p></li></ul></div><p>The third-party dependencies must be downloaded from the sites100 Juggler Subversion repository in the module 101 <code class="literal">cppunit</code>. Refer to <a href="#section.cvs.access" title="How to Get the Juggler Suite from Subversion">the section called “How to Get the Juggler Suite from Subversion”</a> for instructions about accessing 102 the Juggler Subversion repository.</p></li></ul></div><p>The third-party dependencies must be downloaded from the sites 104 103 listed above and installed manually. You may also have to compile one or 105 104 more of the packages if binary distributions are not available. Which … … 107 106 carefully which packages are needed based on the software you have 108 107 installed and what versions of tools (such as the JDK) that you 109 download.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="section.cvs.access"></a>How to Get the Juggler Suite from CVS</h3></div></div></div><p>You can optionally get the Juggler Project as a source code108 download.</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="section.cvs.access"></a>How to Get the Juggler Suite from Subversion</h3></div></div></div><p>You can optionally get the Juggler Project as a source code 110 109 tarball from the website (<a href="http://www.vrjuggler.org/" target="_top">http://www.vrjuggler.org/</a>) or 111 you can execute the following command sfrom a shell to get the code112 from our CVS repository:</p><pre class="screen">cvs -d :pserver:anonymous@cvs.sourceforge.net:/cvsroot/vrjuggler login113 cvs -z3 -d :pserver:anonymous@cvs.sourceforge.net:/cvsroot/vrjuggler co juggler</pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e216"></a>Downloading Third-Party Dependencies</h3></div></div></div><p>In addition to source the dependencies acquired through CVS, 114 there are some third-party dependencies that must be installed115 separately. Remember that no Java code in VR Juggler can be used116 without the JDK and a working Java version of CORBA.</p><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="d0e221"></a>Boost</h4></div></div></div><p>The minimum required version of Boost, as of this writing,110 you can execute the following command from a shell to get the code 111 from our Subversion repository:</p><pre class="screen">svn co https://realityforge.vrsource.org/svn/vrjuggler/juggler/branches/2.0 juggler 112 </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e216"></a>Downloading Third-Party Dependencies</h3></div></div></div><p>In addition to source the dependencies acquired through 113 Subversion, there are some third-party dependencies that must be 114 installed separately. Remember that no Java code in VR Juggler can be 115 used without the JDK and a working Java version of CORBA.</p><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="d0e221"></a>Boost</h4></div></div></div><p>The minimum required version of Boost, as of this writing, 117 116 is 1.31.0. The Boost source can be downloaded from <a href="http://www.sf.net/projects/boost/" target="_top">http://www.sf.net/projects/boost/</a>. 118 117 To compile and install Boost, refer to its installation … … 156 155 may not be stable, and it may not even compile. Compiling VR Juggler 157 156 itself can be a little complicated for anyone who does not have some 158 background in using CVS, Autoconf, C++, and <span><strong class="command">make</strong></span>159 or Visual Studio.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e319"></a>Compiling the Juggler Suite of Tools</h3></div></div></div><p>This section explains how to get, configure, and compile all of157 background in using Subversion, Autoconf, C++, and 158 <span><strong class="command">make</strong></span> or Visual Studio.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="d0e319"></a>Compiling the Juggler Suite of Tools</h3></div></div></div><p>This section explains how to get, configure, and compile all of 160 159 the tools that make up VR Juggler. Each tool compiles to its own 161 160 library and can be installed individually. (Refer to the … … 314 313 how to configure Sonix to use Audiere, OpenAL, or 315 314 AudioWorks.</p><p>For example uses of <span><strong class="command">configure.pl</strong></span>, take 316 a look at the Wiki page relating to building from CVS (<a href="http://www.vrjuggler.org/twiki_public/bin/view/Juggler/BuildingFromCvs" target="_top">http://www.vrjuggler.org/twiki_public/bin/view/Juggler/BuildingFromCvs</a>). 315 a look at the Wiki page relating to building from source 316 (<a href="http://www.vrjuggler.org/twiki_public/bin/view/Juggler/BuildingFromSvn" target="_top">http://www.vrjuggler.org/twiki_public/bin/view/Juggler/BuildingFromSvn</a>). 317 317 It is not a replacement for this document, but it shows how 318 318 some members of the Juggler team configure VR Juggler. It also … … 336 336 tools in the Juggler Suite are compiled correctly. For the most part, 337 337 this duplicates information that can be found on the Wiki page 338 relating to building from CVS (<a href="http://www.vrjuggler.org/twiki_public/bin/view/Juggler/BuildingFromCvs" target="_top">http://www.vrjuggler.org/twiki_public/bin/view/Juggler/BuildingFromCvs</a>).</p><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="sonix.compile.section"></a>Sonix</h4></div></div></div><p>Sonix wraps other audio subsystems such as OpenAL (<a href="http://www.openal.org/" target="_top">www.openal.org</a>), Audiere338 relating to building from source (<a href="http://www.vrjuggler.org/twiki_public/bin/view/Juggler/BuildingFromSvn" target="_top">http://www.vrjuggler.org/twiki_public/bin/view/Juggler/BuildingFromSvn</a>).</p><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="sonix.compile.section"></a>Sonix</h4></div></div></div><p>Sonix wraps other audio subsystems such as OpenAL (<a href="http://www.openal.org/" target="_top">www.openal.org</a>), Audiere 339 339 (<a href="http://audiere.sf.net/" target="_top">audiere.sf.net</a>), or 340 340 AudioWorks (<a href="http://www.multigen.com/" target="_top">multigen.com</a>). At least one juggler/branches/2.0/INSTALL.txt
r18954 r19201 24 24 25 25 26 How to Get the Juggler Suite from CVS26 How to Get the Juggler Suite from Subversion 27 27 28 28 Downloading Third-Party Dependencies … … 45 45 This document explains how to build the modules of the Juggler Project from 46 46 the source code. We begin by explaining some issues related to specific 47 operating systems. We then explain how to get the source code from our CVS48 repository. (Those users who downloaded a pre-packaged source release can49 skip ahead to the section called "Using configure.pl"). We47 operating systems. We then explain how to get the source code from our 48 Subversion repository. (Those users who downloaded a pre-packaged source 49 release can skip ahead to the section called "Using configure.pl"). We 50 50 conclude with instructions on how to build VR Juggler and its individual 51 51 components. 52 52 53 53 Before reading further, we recommend that readers take a look at the Wiki 54 page relating to building from CVS (http://www.vrjuggler.org/twiki_public/ 55 bin/view/Juggler/BuildingFromCvs). It is a supplement to this document 56 containing tips and reminders for those users building the CVS version of 57 VR Juggler. It is not a replacement for this document, nor can it stand on 58 its own as build instructions. You are reading the definitive build 59 instructions; the Wiki page merely provides informal, extra information. 54 page relating to building from source (http://www.vrjuggler.org/ 55 twiki_public/bin/view/Juggler/BuildingFromSvn). It is a supplement to this 56 document containing tips and reminders for those users building the SVN 57 version of VR Juggler. It is not a replacement for this document, nor can 58 it stand on its own as build instructions. You are reading the definitive 59 build instructions; the Wiki page merely provides informal, extra 60 information. 60 61 61 62 … … 136 137 the C++ Standard with Visual Studio 6.0, and it appears that they have no 137 138 plans to fix these problems. Therefore, we require the use of Visual Studio 138 7.x (.NET 2002 or 2003) to compile the source code.139 7.x (.NET 2002 or 2003) or newer to compile the source code. 139 140 140 141 … … 143 144 In this section, we explain how to get the Juggler Project source code and 144 145 the dependencies required to build Juggler. There are two ways to get the 145 source code: from a pre-packaged source release archive or from the CVS146 repository on SourceForge. If you got the code from a pre-packaged source147 archive, that code is a complete "snapshot" of the CVS148 repository at the time of release. It contains all dependencies that would149 otherwise have been acquired using CVS. It does not contain binary150 dependencies that must be downloaded separately (such as NSPR, the Java151 Developer Kit, a C++ compiler, etc.).146 source code: from a pre-packaged source release archive or from the 147 Subversion repository on RealityForge. If you got the code from a pre- 148 packaged source archive, that code is a complete "snapshot" of the 149 Subversion repository at the time of release. It contains all dependencies 150 that would otherwise have been acquired using Subversion. It does not 151 contain binary dependencies that must be downloaded separately (such as 152 NSPR, the Java Developer Kit, a C++ compiler, etc.). 152 153 153 154 The current list of required software packages is as follows: … … 193 194 C++. The Juggler C++ test suties make use of extensions to CppUnit. An 194 195 extended version of the CppUnit source that includes these extensions can 195 be acquired from the Juggler CVS repository in the module cppunit. Refer 196 to the section called "How to Get the Juggler Suite from CVS" 197 for instructions about accessing the Juggler CVS repository. 196 be acquired from the Juggler Subversion repository in the module cppunit. 197 Refer to the section called "How to Get the Juggler Suite from 198 Subversion" for instructions about accessing the Juggler Subversion 199 repository. 198 200 199 201 … … 206 208 207 209 208 How to Get the Juggler Suite from CVS210 How to Get the Juggler Suite from Subversion 209 211 210 212 You can optionally get the Juggler Project as a source code tarball from 211 213 the website (http://www.vrjuggler.org/) or you can execute the following 212 commands from a shell to get the code from our CVS repository: 213 214 215 cvs -d :pserver:anonymous@cvs.sourceforge.net:/cvsroot/vrjuggler login 216 cvs -z3 -d :pserver:anonymous@cvs.sourceforge.net:/cvsroot/vrjuggler co 217 juggler 214 command from a shell to get the code from our Subversion repository: 215 216 217 svn co https://realityforge.vrsource.org/svn/vrjuggler/juggler/branches/ 218 2.0 juggler 218 219 219 220 220 221 Downloading Third-Party Dependencies 221 222 222 In addition to source the dependencies acquired through CVS, there are some223 third-party dependencies that must be installed separately. Remember that224 no Java code in VR Juggler can be used without the JDK and a working Java225 version of CORBA.223 In addition to source the dependencies acquired through Subversion, there 224 are some third-party dependencies that must be installed separately. 225 Remember that no Java code in VR Juggler can be used without the JDK and a 226 working Java version of CORBA. 226 227 227 228 … … 232 233 compile and install Boost, refer to its installation documentation (http:// 233 234 www.boost.org/more/getting_started.html#Build_Install). Note that you need 234 the command bjam (referred to as "boost-jam" on the Boost 235 download page) tobuild Boost.235 the command bjam (referred to as "boost-jam" on the Boost download page) to 236 build Boost. 236 237 237 238 238 239 Important 239 240 240 Mac OS X users should compile the Boost libraries using the 241 "darwin"toolset.241 Mac OS X users should compile the Boost libraries using the "darwin" 242 toolset. 242 243 243 244 … … 293 294 Ports Collection). Because of this, several extra options must be specified 294 295 in order to tell the Tweek configure script where to find everything. 295 Please refer to the section called "Tweek" for more details on 296 this. 296 Please refer to the section called "Tweek" for more details on this. 297 297 298 298 … … 308 308 You have downloaded developmental code. It may not be stable, and it may 309 309 not even compile. Compiling VR Juggler itself can be a little complicated 310 for anyone who does not have some background in using CVS, Autoconf, C++,311 and make or Visual Studio.310 for anyone who does not have some background in using Subversion, Autoconf, 311 C++, and make or Visual Studio. 312 312 313 313 … … 618 618 Using configure.pl 619 619 620 In the base juggler source directory, we have a "global" 621 configure script written in Perl called configure.pl. To get the command-622 line options for this script, use one of the following (the second being623 much moredetailed):620 In the base juggler source directory, we have a "global" configure script 621 written in Perl called configure.pl. To get the command-line options for 622 this script, use one of the following (the second being much more 623 detailed): 624 624 625 625 … … 649 649 various modules, should you need to run one individually. 650 650 651 configure.pl can run in a unique "build" directory or in the 652 directory where it resides. Here is how we (the Juggler Team) have been 653 using it: 651 configure.pl can run in a unique "build" directory or in the directory 652 where it resides. Here is how we (the Juggler Team) have been using it: 654 653 655 654 … … 694 693 case. Sonix can make use of Aaudiere, OpenAL, or AudioWorks to add sound to 695 694 VR Juggler applications. If none of those packages is found, Sonix will 696 "stub out" its sound APIs. This means that Sonix and the VR 697 Juggler Sound Manager can still be used in applications, but no audio will 698 be heard at run time. See the section called "Sonix" for more 699 information about how to configure Sonix to use Audiere, OpenAL, or 700 AudioWorks. 695 "stub out" its sound APIs. This means that Sonix and the VR Juggler Sound 696 Manager can still be used in applications, but no audio will be heard at 697 run time. See the section called "Sonix" for more information about how to 698 configure Sonix to use Audiere, OpenAL, or AudioWorks. 701 699 702 700 For example uses of configure.pl, take a look at the Wiki page relating to 703 building from CVS (http://www.vrjuggler.org/twiki_public/bin/view/Juggler/704 BuildingFromCvs). It is not a replacement for this document, but it shows705 how some members of the Juggler team configure VR Juggler. It also has706 information on more advanced uses of configure.pl that are beyond the scope707 of this document.701 building from source (http://www.vrjuggler.org/twiki_public/bin/view/ 702 Juggler/BuildingFromSvn). It is not a replacement for this document, but it 703 shows how some members of the Juggler team configure VR Juggler. It also 704 has information on more advanced uses of configure.pl that are beyond the 705 scope of this document. 708 706 709 707 … … 711 709 712 710 As noted in the section called "Getting the Source Code and the 713 Dependencies", VR Juggler depends on several external software 714 packages. As an example, consider the case where the GMTL library is715 installed in /home/user1/pkgs/GMTL with the headers in /home/user1/pkgs/716 GMTL/include. Touse this installation, run configure.pl as follows:711 Dependencies", VR Juggler depends on several external software packages. As 712 an example, consider the case where the GMTL library is installed in 713 /home/user1/pkgs/GMTL with the headers in /home/user1/pkgs/GMTL/include. To 714 use this installation, run configure.pl as follows: 717 715 718 716 … … 749 747 Juggler Suite are compiled correctly. For the most part, this duplicates 750 748 information that can be found on the Wiki page relating to building from 751 CVS(http://www.vrjuggler.org/twiki_public/bin/view/Juggler/752 BuildingFrom Cvs).749 source (http://www.vrjuggler.org/twiki_public/bin/view/Juggler/ 750 BuildingFromSvn). 753 751 754 752
