[Plplot-cvs] SF.net SVN: plplot:[12690] trunk/INSTALL

[<arj...@us...>]

Revision: 12690
          http://sourceforge.net/p/plplot/code/12690
Author:   arjenmarkus
Date:     2013-11-13 12:15:17 +0000 (Wed, 13 Nov 2013)
Log Message:
-----------
Added a concise explanation of the CMake example - the full explanation appeared lower down the file. (In response to a question on the plplot-general list)

Modified Paths:
--------------
    trunk/INSTALL

Modified: trunk/INSTALL
===================================================================
--- trunk/INSTALL	2013-11-13 09:10:07 UTC (rev 12689)
+++ trunk/INSTALL	2013-11-13 12:15:17 UTC (rev 12690)
@@ -9,7 +9,7 @@
 gives good results on Unix, Linux, and Mac OS X and Cygwin, MinGW,
 MinGW/MSYS, and bare windows.
 
-Building PLplot with our CMake-based build system 
+Building PLplot with our CMake-based build system
 =================================================
 
 Our CMake-based build system has been made available as part of our
@@ -34,7 +34,7 @@
 -------------------------------------------------------------------------
 
 Here is one particular example (which must be executed before the cmake
-invocation discussed below). 
+invocation discussed below).
 
 export CMAKE_INCLUDE_PATH=/home/software/autotools/install/include:/home/software/cgmlib/cd1.3
 export CMAKE_LIBRARY_PATH=/home/software/autotools/install/lib:/home/software/cgmlib/cd1.3
@@ -45,7 +45,7 @@
 CMAKE_LIBRARY_PATH helps cmake to find the libltdl and libcd libraries in
 non-standard install locations; and PKG_CONFIG_PATH helps cmake to use the
 pkg-config command internally to find a libLASi pkg-config module file that
-is installed in a non-standard location. 
+is installed in a non-standard location.
 
 In general, CMAKE_INCLUDE_PATH helps cmake find headers and other files that
 are installed in non-standard locations; CMAKE_LIBRARY_PATH helps cmake find
@@ -61,7 +61,7 @@
 --------------------------------------------------------------------------
 
 Here is one particular example (which must be executed before the cmake
-invocation discussed below). 
+invocation discussed below).
 
 export CC="gcc -O2"
 export CXX="g++ -O2"
@@ -72,20 +72,30 @@
 for gcc-related compilers for our build system which makes for fast builds,
 but slow execution.
 
-cmake invocation
+CMake invocation
 ----------------
 
-Here is one typical example. 
+Here is one typical example.
 
 mkdir build_dir
 cd build_dir
-cmake -DCMAKE_INSTALL_PREFIX=/my/prefix \
-../plplot_cmake >& cmake.out
+cmake -DCMAKE_INSTALL_PREFIX=/my/prefix ../plplot_cmake >& cmake.out
 
+(Note:
+- "build_dir" is the directory where you want to build the libraries.
+- "/my/prefix" is the directory where you want to install the PLplot libraries
+  for actual use. If you leave the option -DCMAKE_INSTALL_PREFIX= out, a
+  default installation directory will be selected. This actual default directory
+  depends on the operating system you are using.
+- "plplot_cmake" is the directory where all the source files are contained,
+  most notably the file "CMakeLists.txt", as that is the file that CMake will
+  start its build preparation from.
+All of these directories can be given any name you like, of course.)
+
 (CMake is capable of generating builds within the source tree, but we have
 emphasized a build with a separate build tree here because of its
 fundamental advantage that the source tree remains clean with no generated
-files in it.) 
+files in it.)
 
 Check the cmake.out file for any configuration issues, especially WARNING
 messages which signal that a component of PLplot has been removed because
@@ -95,7 +105,7 @@
 http://www.miscdebris.net/plplot_wiki/index.php?title=CMake_options_for_PLplot)
 which can be set for cmake to personalize your build. Use the ccmake front
 end to cmake to obtain documentation of all these options. In the above case
-we have specified a particular install prefix "/my/prefix". 
+we have specified a particular install prefix "/my/prefix".
 
 Note in the above example an initially empty build directory (arbitrarily)
 named build_dir is used to insure a clean start, and ../plplot_cmake is the

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.