<!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_installgentoo">Installing GearBox on Gentoo Linux </a></h1><dl class="note"><dt><b>Note:</b></dt><dd>Reviewed for release 1.1</dd></dl>
<p>These are detailed instructions for installing GearBox on Gentoo Linux. See <a class="el" href="gbx__doc__getting.html">Download and Install GearBox</a> for general guidelines.</p>
<h2><a class="anchor" id="gbx_doc_installgentoo_portageoverlay">
Portage overlay</a></h2>
<p>The first step is to set up a local overlay for portage. If you already have a local overlay, you can skip this section. If you don't know what an overlay is, see the <a href="http://www.gentoo.org/proj/en/overlays/userguide.xml">Gentoo Documentation</a>.</p>
<p>Follow these simple steps to create an overlay:</p>
<ol type="1">
<li>Create a directory to store the overlay in, for example <b>/usr/local/portage</b> </li>
<li>Set the <b>PORTDIR_OVERLAY</b> variable in <b>/etc/make</b>.conf to include this directory.</li>
</ol>
<h2><a class="anchor" id="gbx_doc_installgentoo_copyebuild">
Download and copy ebuild</a></h2>
<p>Download the Gearbox ebuild from the Gearbox download page. This ebuild must be copied into the local overlay so that portage can find it. Extract the downloaded files into your local overlay directory. This should create a subdirectory called <b>dev-libs</b> with a subdirectory called <b>gearbox</b> inside it.</p>
<h2><a class="anchor" id="gbx_doc_installgentoo_keywordebuild">
Keyword the ebuild</a></h2>
<p>If the Gearbox ebuild is masked, it will need to be unmasked before it can be installed. Add the following line to /etc/portage/package.keywords to unmask it.</p>
<div class="fragment"><pre class="fragment">
dev-libs/gearbox **
</pre></div><h2><a class="anchor" id="gbx_doc_installgentoo_setuseflags">
Set USE flags</a></h2>
<p>This step is optional. If you wish to install Gearbox with the default options, move on to the next step.</p>
<p>The Gearbox ebuild provides many USE flags to control which libraries are installed. They can be set at install time by specifying them on the command line, for example:</p>
<div class="fragment"><pre class="fragment">
USE="hokuyo_aist" emerge gearbox -av
</pre></div><p>Alternatively, they can be set more permanantly be specifying them in /etc/portage/package.use:</p>
<div class="fragment"><pre class="fragment">
dev-libs/gearbox hokuyo_aist
</pre></div><p>A full list of available USE flags is given below. For a list of those provided by your current ebuild for Gearbox, run <b>equery</b> <b>uses</b> <b>gearbox</b>. </p>
<table class="doxtable">
<tr>
<td>doc</td><td>Installs the documentation </td></tr>
<tr>
<td>basic</td><td>Enable the basic example library. </td></tr>
<tr>
<td>gbxadvanced</td><td>Enable the advanced example library. </td></tr>
<tr>
<td>gbxgarminacfr</td><td>Enabled the GbxGarminAcfr GPS driver. </td></tr>
<tr>
<td>gbxserialacfr</td><td>Enable the GbxSerialAcfr serial communications library. </td></tr>
<tr>
<td>gbxsickacfr</td><td>Enable the GbxSickAcfr SICK laser scanner driver. </td></tr>
<tr>
<td>gbxsmartbatteryacfr</td><td>Enable the GbxSmartBatteryAcfr SmartBattery driver. </td></tr>
<tr>
<td>gbxutilacfr</td><td>Enable the GbxUtilAcfr utilities library. </td></tr>
<tr>
<td><a class="el" href="namespacehokuyo__aist.html" title="Hokuyo laser scanner driver name space.">hokuyo_aist</a></td><td>Enable the <a class="el" href="namespacehokuyo__aist.html" title="Hokuyo laser scanner driver name space.">hokuyo_aist</a> Hokuyo laser scanner library. </td></tr>
</table>
<h2><a class="anchor" id="gbx_doc_installgentoo_install">
Install</a></h2>
<p>Run the following command to install Gearbox.</p>
<div class="fragment"><pre class="fragment">
emerge gearbox
</pre></div><p>Gearbox will be automatically downloaded, compiled with the options you have selected via USE flags, and installed. Any necessary dependencies for the libraries to be installed will also be installed.</p>
<p>Gearbox will be installed with the prefix <b>/usr</b>. Remember to take this into account when setting compile options such as library and include paths for your programs.</p>
<h2><a class="anchor" id="gbx_doc_installgentoo_uninstall">
Uninstall</a></h2>
<p>To remove Gearbox from your system, run the following command.</p>
<div class="fragment"><pre class="fragment">
emerge -C gearbox
</pre></div> </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>
