<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<!-- $Id: header.html 8799 2010-06-28 04:12:42Z jpgr87 $ -->
<HEAD>
<meta HTTP-EQUIV="Content-Type" CONTENT="text/html;CHARSET=utf-8">
<meta name="keywords" content="stage, robot, simulation, player, player/stage">
<link href="doxygen.css" rel="stylesheet" type="text/css">
<style type="text/css">
.floatright { float: right; margin: 0 0 1em 1em; }
body {
font-family: sans-serif;
#font-family: Geneva, Verdana, Helvetica, Arial, sans-serif;
background-color: #FFF;
color:#000;
}
a:link {
color: #A00;
}
a:visited {
color: #800;
}
a { text-decoration: none; }
a:hover { text-decoration: underline; }
.timestamp { text-align:right; background-color: #DDD; font-size:75%;}
h1 {
font-size:160%;
}
h2 {
font-size:110%;
#color: #FFF;
#background-color: #666;
#padding:3px;
}
h3 { text-align:left; }
img {
border: 0;
}
ul.menu {
position:relative;
left:-2.5em;
margin-bottom:0px;
margin-top:0px;
}
ul.menu1 {
position:relative;
left:-2.1em;
margin-bottom:0px;
margin-top:0px;
}
li.menu {
list-style-type: none;
position:relative;
#left:-0.5em;
}
#sidebar { position: absolute; left:0px; padding:2em; top:0em; width:12em;}
#content { position: absolute; left:12em; top:0em; padding-left:3em; padding-right:3em; padding-bottom:2em; margin-top:1em; margin-right:2em; }
div.box { background-color:#EEE; border: 1px solid #000; padding: 0.5ex 0.4em 0.5ex 0.6em; margin:1em; }
div.title { font-weight:bold; background-color:#eee; margin-bottom:2px;}
div.topbar { position: absolute; top:0px; left:9em; margin:1em; }
</style>
<TITLE>Player Manual</TITLE>
</HEAD>
<body>
<div id="sidebar">
<h2 style="text-align:center;">
<a href="index.html">
<img width=140 src="http://playerstage.sourceforge.net/images/player_button_v3.png" alt="Player logo"><br></a>
</h2>
<div class="box">
<div class=title>Player</div>
<ul class=menu>
<li class=menu><a href="index.html">Frontpage</a>
<li class=menu><a href="modules.html">Contents</a>
</ul>
</div>
<div class="box">
<div class=title>User</div>
<ul class=menu>
<li class=menu><a href="install.html">Installation</a>
<li class=menu><a href="start.html">Quick start</a>
<li class=menu><a href="supported_hardware.html">Supported devices</a>
<li class=menu><a href="group__tutorials.html">Tutorials</a>
<li class=menu><a href="group__utils.html">Utilities</a>
<li class=menu><a href="group__clientlibs.html">Client libraries</a>
<li class=menu><a href="http://playerstage.sourceforge.net/wiki/Basic_FAQ">FAQ</a>
<li class=menu><a href="help.html">Help</a>
</ul>
</div>
<div class=box>
<div class="title">Developer</div>
<ul class=menu>
<li class=menu><a href="architecture.html">Architecture</a>
<li class=menu><a href="group__libplayercore.html">libplayercore</a>
<ul class=menu1>
<li class=menu><a href="group__interfaces.html">interfaces</a></li>
</ul>
<li class=menu><a href="group__libplayerdrivers.html">libplayerdrivers</a>
<ul class=menu1>
<li class=menu><a href="group__drivers.html">drivers</a></li>
</ul>
<li class=menu><a href="group__libplayercommon.html">libplayercommon</a>
<li class=menu><a href="group__libplayerutils.html">libplayerutils</a>
<li class=menu><a href="group__libplayersd.html">libplayersd</a>
<li class=menu><a href="group__libplayertcp.html">libplayertcp</a>
<li class=menu><a href="group__libplayerxdr.html">libplayerxdr</a>
<li class=menu><a href="todo.html">TODO</a>
</ul>
</div>
<div class=box>
<!-- <a href="http://sourceforge.net"><img border=0 src="http://sourceforge.net/sflogo.php?group_id=42445&type=1"></a> -->
<div class="title">Online</div>
<a href="http://playerstage.sourceforge.net">Homepage</a><br>
<a href="http://sourceforge.net/project/showfiles.php?group_id=42445">Download</a><br>
<a href="http://sourceforge.net/projects/playerstage">Project</a><br>
<a href="http://sourceforge.net/tracker/?group_id=42445">Bugs</a><br>
<a href="http://sourceforge.net/mail/?group_id=42445">Help</a>
</div>
</div>
<div id="content" >
<!-- Generated by Doxygen 1.7.1 -->
<div class="header">
<div class="headertitle">
<h1>Installation </h1> </div>
</div>
<div class="contents">
<h2><a class="anchor" id="stdinstall"></a>
Standard install procedure</h2>
<p>To install Player in the default location (/usr/local), follow these steps:</p>
<ol>
<li>
<p class="startli">Download the latest Player source tarball (player-<version>.tgz) from <a href="http://sourceforge.net/project/showfiles.php?group_id=42445">SourceForge</a>.</p>
<p class="endli"></p>
</li>
<li>
<p class="startli">Uncompress and expand the tarball: <br/>
<code>$ tar xzvf player-<version>.tgz</code></p>
<p class="endli"></p>
</li>
<li>
<p class="startli">`cd' into Player's source directory:<br/>
<code>$ cd player-<version></code></p>
<p class="endli"></p>
</li>
<li>
<p class="startli">Create a subdirectory called `build' and enter it:<br/>
<code>$ mkdir build</code><br/>
<code>$ cd build</code></p>
<p class="endli"></p>
</li>
<li>
<p class="startli">To configure Player with default settings:<br/>
<code>$ cmake ../</code><br/>
</p>
<p class="endli"></p>
</li>
<li>
<p class="startli">Compile Player:<br/>
<code>$ make</code></p>
<p class="endli"></p>
</li>
<li>
Install Player. By default, Player will be installed in /usr/local so you need to become root for this step. Remember to return to your normal user ID afterwards. <br/>
<code>$ make install</code><br/>
Executables (e.g., the <a class="el" href="group__utils.html">Player utilities</a>) are in /usr/local/bin, libraries (e.g., <a class="el" href="group__libplayercore.html">libplayercore</a>, <a class="el" href="group__libplayerdrivers.html">libplayerdrivers</a>) are in /usr/local/lib, and so on. </li>
</ol>
<h3><a class="anchor" id="pkgconfiginstall"></a>
pkg-config paths</h3>
<p>The <b>pkg-config</b> meta-data files (they have the extension <b>.pc</b>) are installed by default to /usr/local/lib/pkgconfig. On some systems (notably RedHat), this directory is not in the default search path for pkg-config. You can check like so: </p>
<p><code>$ pkg-config --libs playercore</code> </p>
<p>You should get something like (exact results vary by system): </p>
<p><code>-lplayercore -lltdl -lpthread -lplayercommon</code> </p>
<p>If instead you get this: </p>
<p><code>Package playercore was not found in the pkg-config search path.<br/>
Perhaps you should add the directory containing `playercore.pc'<br/>
to the PKG_CONFIG_PATH environment variable<br/>
No package 'playercore' found<br/>
</code> </p>
<p>then you need to add /usr/local/lib/pkgconfig to your PKG_CONFIG_PATH. E.g., in bash: </p>
<p><code>$ export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig:$PKG_CONFIG_PATH</code> </p>
<p>Otherwise you will <b>not</b> be able to compile programs that use any of Player's libraries.</p>
<h2><a class="anchor" id="custominstall"></a>
Customized installations</h2>
<p>Player uses CMake for its build system. You can use CMake's GUI configuration editor to change the build options:</p>
<p><code>$ ccmake ../</code></p>
<p>You can also specify options on the command line using `cmake' and the -D option:</p>
<p><code>$ cmake -D CMAKE_INSTALL_PREFIX="\<destination directory\>" ../</code></p>
<h3><a class="anchor" id="prefix"></a>
Installation prefix</h3>
<p>The most important option is CMAKE_INSTALL_PREFIX, used to change the installation directory from the default (which varies from system to system, but is usually /usr/local). You should use an absolute path, i.e. a complete path starting with a '/'.</p>
<p>For example, you might want to install Player in your home directory because you don't have root access: </p>
<p><code>$ cmake -D CMAKE_INSTALL_PREFIX="/home/gerkey/ps" ../</code><br/>
<code>$ make</code><br/>
<code>$ make install</code> </p>
<p>Now the executables are in /home/gerkey/ps/bin, the libraries are in /home/gerkey/ps/lib, and so on. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>You may have to change various environment variables if you install Player somewhere other than the default location. Variables that may need modification include: PATH, LD_LIBRARY_PATH (or DYLD_LIBRARY_PATH on Mac OS X), and PKG_CONFIG_PATH. More information on local installations can be found <a href="http://playerstage.sourceforge.net/index.php?src=faq#local">here</a>. </dd></dl>
<h3><a class="anchor" id="driveroptions"></a>
Selecting which drivers to build</h3>
<p>By default, all drivers that can be built on your system will be compiled and linked into <a class="el" href="group__libplayerdrivers.html">libplayerdrivers</a>. CMake determines which drivers will be built by running tests against your system to see which prerequisites are satisfied. You'll see output during these tests telling you what's going on. A summary is printed by <b>CMake</b> when it's done, telling you which drivers will not be built, and why. You can check the file <b>CMakeFiles/CMakeError.log</b> for detailed information about which tests failed and why. </p>
<p>You can override this default behavior by using ccmake to enable and disable certain drivers. For every driver <code>foo</code>, there will be an option in ccmake <code>ENABLE_DRIVER_FOO<code> that can be switched on or off. You can also pass the option on the command line to cmake. For example, to prevent compilation of the <a class="el" href="group__driver__sicklms400.html">sicklms400</a> driver: </code></code></p>
<p><code><code><code>$ cmake -D ENABLE_DRIVER_SICKLMS400=OFF ../</code></code></code></p>
<p><code><code></code></code></p>
<p><code><code> You can also set the value to <code>ON</code> to enable a driver <code>foo</code> that has been disabled by default. But keep in mind that such a driver is probably disabled for a reason; don't be surprised if it does not compile. And note that this will <b>not</b> force compilation of a driver whose prerequisites have not been met. </code></code></p>
<p><code><code></code></code></p>
<p><code><code></code></code></p>
<p><code><code> The order of these options on the command line does not matter. </code></code></p>
</div>
<!-- render the modification time of the source file -->
<div class="timestamp">
<hr>
<table style="width:100%;">
<tr>
<td style="text-align:left;">
Last updated 12 September 2005 21:38:45
<!--
<td style="text-align:right;">
<a href="http://validator.w3.org/check/referer"><img style="vertical-align:middle;border:0;width:88px;height:31px"
src="http://www.w3.org/Icons/valid-html401"
alt="Valid HTML 4.01!"></a>
<a href="http://jigsaw.w3.org/css-validator/">
<img style="vertical-align:middle;border:0;width:88px;height:31px"
src="http://jigsaw.w3.org/css-validator/images/vcss"
alt="Valid CSS!">
</a>
-->
</tr>
</table>
</div>
</tr>
</table>
</BODY>
</HTML>
