<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>GearBox Project</title>
<link rel="icon" href="gbx_icon_cardbox_sky.png" type="image/png">
<link rel="shortcut icon" href="gbx_icon_cardbox_sky.png" type="image/png">
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
<!-- Google Analytics -->
<script type="text/javascript">
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
var pageTracker = _gat._getTracker("UA-3583782-1");
pageTracker._initData();
pageTracker._trackPageview();
</script>
<!-- Returning you to your regular programming -->
</head><body>
<!-- Header -->
<table border="0" cellspacing="0" cellpadding="0">
<tr><!-- create row -->
<!-- spacer cell -->
<!-- #CC CC CC -->
<td rowspan="1" colspan="1" bgcolor="#EEEEEE"> </td>
<!-- menu cell -->
<td width="170" rowspan="1" colspan="1" align="left" valign="top" bgcolor="#EEEEEE">
<p> </p>
<p align="center"><a href="index.html"><img src="gbx_logo_cardbox_sky_150x150.png"></a></p><br>
<strong>INTRODUCTION</strong><br>
<strong><a href="gbx_doc_overview.html" style="text-decoration:none">Overview</a></strong><br>
<strong><a href="gbx_doc_getting.html" style="text-decoration:none">Download and Install</a></strong><br>
<!-- <strong><a href="gbx_doc_quickstart.html" style="text-decoration:none">Quick Start</a></strong><br> -->
<strong><a href="gbx_doc_documentation.html" style="text-decoration:none">Documentation</a></strong><br>
<strong><a href="gbx_doc_publications.html" style="text-decoration:none">Publications</a></strong><br>
<br>
<strong>REPOSITORY</strong><br>
<strong><a href="group__gbx__libs.html" style="text-decoration:none">Libraries</a></strong><br>
<!-- <strong><a href="group__gbx__utils.html" style="text-decoration:none">Utilities</a></strong><br> -->
<br>
<strong>DEVELOPER</strong><br>
<!--<strong><a href="gbx_doc_tutorials.html" style="text-decoration:none">Tutorials</a></strong><br>
<strong><a href="group__gbx__examples.html" style="text-decoration:none">Examples</a></strong><br>-->
<strong><a href="gbx_doc_devguide.html" style="text-decoration:none">Dev Guide</a></strong><br>
<!--
<strong><a href="gbx_doc_faq.html" style="text-decoration:none">FAQ</a></strong><br>
-->
<strong><a href="http://cdash.acfr.usyd.edu.au/index.php?project=Gearbox" style="text-decoration:none">Dashboard</a></strong><br>
<!--<strong><a href="http://wiki2.cas.edu.au/orca">Wiki</a></strong><br>
login/pass: orca/orca<br>-->
<br>
<strong>PEOPLE</strong><br>
<strong><a href="gbx_doc_contributors.html" style="text-decoration:none">Contributors</a></strong><br>
<strong><a href="gbx_doc_users.html" style="text-decoration:none">Users</a></strong><br>
<br>
<a href="http://sourceforge.net"><img src="http://sourceforge.net/sflogo.php?group_id=216468&type=2" width="125" height="37" border="0" alt="SourceForge.net Logo" /></a><br>
<strong><a href="http://sourceforge.net/projects/gearbox">Project</a></strong><br>
<strong><a href="http://sourceforge.net/project/showfiles.php?group_id=216468">Download</a></strong><br>
<!--<strong><a href="http://sourceforge.net/tracker/?group_id=216468">Bugs/Feedback</a></strong><br>-->
<strong><a href="http://sourceforge.net/mail/?group_id=216468">Mailing lists</a></strong></p>
<p> </p>
</td><!-- /menu cell -->
<!-- one grey spacer cells -->
<td rowspan="1" colspan="1" bgcolor="#EEEEEE"> </td>
<!-- one white spacer cells -->
<td rowspan="1" colspan="1"> </td>
<!-- main content cell -->
<td rowspan="1" colspan="1" align="left" valign="top">
<!-- Generated by Doxygen 1.6.2-20100208 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1><a class="anchor" id="gbx_doc_getting">Download and Install GearBox </a></h1><dl class="note"><dt><b>Note:</b></dt><dd>Reviewed for release 0.0.1</dd></dl>
<p>GearBox distribution has one official dependency <a href="http://www.cmake.org/">CMake: Cross-Platform Make</a>.</p>
<h2><a class="anchor" id="gbx_doc_getting_download">
Download instructions for GearBox</a></h2>
<ul>
<li>Option 1. Download <b><a href="http://sourceforge.net/project/showfiles.php?group_id=216468" style="text-decoration:none">the latest distribution of GearBox</a></b></li>
</ul>
<ul>
<li>Option 2. Checkout source from SVN<ul>
<li>Anonymous checkout (your username/password will be asked on commit): <div class="fragment"><pre class="fragment">
$ svn co https://gearbox.svn.sf.net/svnroot/gearbox/gearbox/trunk gearbox
</pre></div></li>
<li>See links <a class="el" href="gbx__doc__version__control.html">to get started</a> with SVN.</li>
<li>See <b><a href="http://sourceforge.net/svn/?group_id=216468" style="text-decoration:none">more detailed SourceForge SVN instructions.</a></b></li>
</ul>
</li>
</ul>
<h2><a class="anchor" id="gbx_doc_getting_install">
Installation instructions</a></h2>
<p>Detailed instructions are available for these platforms/distributions:</p>
<ul>
<li><a class="el" href="gbx__doc__installdebian.html">Debian Linux</a> (also tested with Ubuntu/Kubuntu)</li>
<li><a class="el" href="gbx__doc__installgentoo.html">Gentoo Linux</a></li>
<li>Send feedback on building under other configurations.</li>
</ul>
<p>The instructions below are quite general, follow them if your platform/distribution combination is not described above:</p>
<ol type="1">
<li>Download and install <a href="http://www.cmake.org/">CMake: Cross-Platform Make</a> which is used to build the GearBox distribution.</li>
</ol>
<ul>
<li>Minimum version required 2.4-patch 4 (latest tested: 2.6-patch 3).<ul>
<li>Full instructions are available from the <a href="http://www.cmake.org/HTML/Download.html">download page</a>.</li>
</ul>
</li>
</ul>
<ol type="1">
<li>Download and install any optional dependencies you'd like. Or just skip this step and do it later.<ul>
<li>You may want to take a look at our notes on <a class="el" href="gbx__doc__depends.html">Installing some of GearBox's optional dependencies</a>.</li>
</ul>
</li>
<li>Build and install GearBox distribution.<ul>
<li>Download the <a class="el" href="gbx__doc__getting.html#gbx_doc_getting_download">GearBox source</a> archive and un-tar it.</li>
<li>Configure using CMake</li>
<li>Compile and install</li>
</ul>
</li>
<li>Set library paths<ul>
<li>Add the Gearbox library directory (by default, /usr/local/lib/gearbox) to the file /etc/ld.so.conf and run ldconfig. This will set the library path system-wide. If you wish to only set it for your user (the better option), specify the library path when linking using the -L option. For example, -L/usr/local/lib/gearbox. Setting the library path in the LD_LIBRARY_PATH environment variable is not recommended.</li>
</ul>
</li>
<li>Make sure that the libraries and executables are in the path. Finished! </li>
</ol>
</div>
</td>
<td colspan="1"> </td>
</tr>
</table>
<!-- end of table -->
<hr size="1"><address style="align: right;"><small>Generated for GearBox by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.5 </small></address>
</body>
</html>
