Changeset 19201 for juggler/branches/2.0/INSTALL.html
- Timestamp:
- 08/13/06 09:37:05 (2 years ago)
- Files:
-
- juggler/branches/2.0/INSTALL.html (modified) (7 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
