Revision: 7751
http://playerstage.svn.sourceforge.net/playerstage/?rev=7751&view=rev
Author: gbiggs
Date: 2009-06-02 00:11:04 +0000 (Tue, 02 Jun 2009)
Log Message:
-----------
Updated installation docs
Modified Paths:
--------------
code/player/trunk/doc/install.txt
Modified: code/player/trunk/doc/install.txt
===================================================================
--- code/player/trunk/doc/install.txt 2009-06-01 23:14:31 UTC (rev 7750)
+++ code/player/trunk/doc/install.txt 2009-06-02 00:11:04 UTC (rev 7751)
@@ -16,8 +16,12 @@
<li>`cd' into Player's source directory:<br>
<tt>$ cd player-\<version\></tt>
+<li>Create a subdirectory called `build' and enter it:<br>
+ <tt>$ mkdir build</tt><br>
+ <tt>$ cd build</tt></br>
+
<li>To configure Player with default settings:<br>
-<tt>$ ./configure</tt><br>
+<tt>$ cmake ../</tt><br>
<li>Compile Player:<br>
<tt>$ make</tt>
@@ -55,21 +59,25 @@
\section custominstall Customized installations
-<p>Player follows the standard GNU autotools conventions for build and
-install options. To see a list of all the available configuration
-options, do this:
+<p>Player uses CMake for its build system. You can use CMake's GUI
+configuration editor to change the build options:
-<p><tt>./configure --help</tt>
+<p><tt>$ ccmake ../</tt>
-\subsection prefix The --prefix option
-<p>The most important option is <tt>--prefix</tt>, used
-to change the installation directory from the default (which varies
-from system to system, but is usually /usr/local).
-Prefixes must be absolute paths, i.e. a complete path starting with a '/'.
+You can also specify options on the command line using `cmake' and the -D
+option:
+<p><tt>$ cmake -D CMAKE_INSTALL_PREFIX="\<destination directory\>" ../</tt>
+
+\subsection prefix Installation prefix
+<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>For example, you might want to install Player in your home directory
because you don't have root access:
-<p><tt>$ ./configure --prefix=/home/gerkey/ps</tt><br>
+<p><tt>$ cmake -D CMAKE_INSTALL_PREFIX="/home/gerkey/ps" ../</tt><br>
<tt>$ make</tt><br>
<tt>$ make install</tt></p>
<p>
@@ -88,31 +96,33 @@
<p>
By default, all drivers that can be built on your system will be compiled
-and linked into @ref libplayerdrivers. The <b>configure</b> script
+and linked into @ref libplayerdrivers. 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>configure</b> when it's done, telling you which drivers will not be
-built, and why. You can check the file <b>config.log</b> for detailed
+<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 passing options to <b>configure</b>
-to disable the compilation of certain drivers. For every driver
-<tt>foo</tt>, you can pass <tt>--disable-foo</tt> to <b>configure</b>. For
-example, to prevent compilation of the @ref driver_sicklms200 driver:
+You can override this default behavior by using ccmake to enable and disable
+certain drivers. For every driver <tt>foo</tt>, there will be an option in
+ccmake <tt>ENABLE_DRIVER_FOO<tt> 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 @ref driver_sicklms400 driver:
</p>
-<p><tt>$ ./configure --disable-sicklms200</tt></p>
+<p><tt>$ cmake -D ENABLE_DRIVER_SICKLMS400=OFF ../</tt></p>
+
<p>
-You can also pass <tt>--enable-foo</tt> to enable a driver <tt>foo</tt>
+You can also set the value to <tt>ON</tt> to enable a driver <tt>foo</tt>
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 <tt>--enable-foo</tt> will <b>not</b> force compilation of a
+And note that this will <b>not</b> force compilation of a
driver whose prerequisites have not been met.
</p>
<p>
-A special option is provided to disable <b>all</b> drivers:
+<!--A special option is provided to disable <b>all</b> drivers:
<tt>--disable-alldrivers</tt>. This option is useful, for example, when
building a small-footprint Player binary to run on an embedded system. You
can combine this option with any number of <tt>--enable-foo</tt> options to
@@ -121,13 +131,9 @@
driver_sicklms200 drivers:
</p>
<p><tt>$ ./configure --disable-alldrivers --enable-p2os
---enable-sicklms200</tt></p>
+--enable-sicklms200</tt></p>-->
<p>
-The order of these options on the command line does not matter. The
-<tt>--disable-alldrivers</tt> option, if present anywhere on the command
-line, is processed first. Then any <tt>--enable-foo</tt> options are
-processed.
-</p>
+The order of these options on the command line does not matter.</p>
*/
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
------------------------------------------------------------------------------
OpenSolaris 2009.06 is a cutting edge operating system for enterprises
looking to deploy the next generation of Solaris that includes the latest
innovations from Sun and the OpenSource community. Download a copy and
enjoy capabilities such as Networking, Storage and Virtualization.
Go to: http://p.sf.net/sfu/opensolaris-get
_______________________________________________
Playerstage-commit mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/playerstage-commit
