Correction: The inset name is citation, not cite

[lyx.git] / INSTALL.cmake

diff --git a/INSTALL.cmake b/INSTALL.cmake
index c093097a1ec8432e2041b042547bc454778c8f3c..980eb8556ac3c7222d4e02e77a89f0773439dbff 100644 (file)
--- a/INSTALL.cmake
+++ b/INSTALL.cmake
@@ -16,14 +16,25 @@ Building LyX with CMake
         Linux/Unix: export PATH=<your path to qt>/bin:$PATH
         Windows   : set PATH=<your path to qt>\bin;%PATH%
     
-    
+    When you wanna run LyX without installing from a out-of-source
+    build directory you have to set the environment variable LYX_DIR_21x
+    and it must point to the lib dir in the source tree.
+        Linux/Unix: export LYX_DIR_21x=<lyx-source>/lib
+        Windows   : set LYX_DIR_21x=<lyx-source>\lib
+
     Windows specific
     
         On Windows install the supplementary modules:
         * Visual Studio 2008: ftp://ftp.lyx.org/pub/lyx/contrib/lyx-windows-deps-msvc2008.zip
         * Visual Studio 2010: ftp://ftp.devel.lyx.org/pub/contrib/windows/bin
-                              or use the option LYX_3RDPARTY_DOWNLOAD
-        
+                or use the option LYX_DEPENDENCIES_DOWNLOAD, then you have to add
+                these paths to your PATH variable:
+                  <build-dir>\msvc2010-deps\deps20\bin
+                  <build-dir>\msvc2010-deps\deps20\python
+                  <build-dir>\msvc2010-deps\deps20\imagemagick
+                  <build-dir>\msvc2010-deps\deps20\ghostscript
+                  <build-dir>\msvc2010-deps\deps20\gettext-tools
+
         If cmake couldn't find these modules set GNUWIN32_DIR, eg. 
         -DGNUWIN32_DIR=c:\gnuwin32. By default cmake searches in your 
         program folder. Or use the cmake GUI to set the GNUWIN32_DIR path.
@@ -63,6 +74,10 @@ Building out-of-source
     select this folder when using CMake's GUI, cmake-gui, or go into this folder
     when you call cmake from the shell.
 
+    Before performing an out-of-source build, ensure that all CMake generated
+    in-source build information is removed from the source directory,
+    e.g., CMakeFiles directory, CMakeCache.txt. 
+
     
 
 Using cmake
@@ -75,24 +90,24 @@ Using cmake
     Here some examples, assuming the build folder is in the same folder as the source tree:
 
     * Makefiles on Linux
-        cmake ../trunk/development/cmake
+        cmake ../trunk
     
     * Project files for QtCreator:
-        Open the trunk/development/cmake/CMakeLists.txt file and select the build folder
+        Open the trunk/CMakeLists.txt file and select the build folder
         or create the files in the command line using the -G"CodeBlocks *" option, eg
-            cmake ../trunk/development/cmake -G"CodeBlocks - Unix Makefiles"
+            cmake ../trunk -G"CodeBlocks - Unix Makefiles"
     
     * Project files for Xcode
-        cmake ../trunk/development/cmake -GXcode
+        cmake ../trunk -GXcode
         
     * Project files for Visual Studio 10
-        cmake ..\trunk\development\cmake -G"Visual Studio 10"
+        cmake ..\trunk -G"Visual Studio 10"
 
     * NMake files for Visual Studio
-        cmake ..\trunk\development\cmake -G"NMake Makefiles"
+        cmake ..\trunk -G"NMake Makefiles"
 
     * Makefiles for MinGW
-        cmake ..\trunk\development\cmake -G"MinGW Makefiles"
+        cmake ..\trunk -G"MinGW Makefiles"
 
 
     Daily work:
@@ -117,17 +132,17 @@ Build options
 
     Options could be passed by the -D prefix when running cmake.
     Available options will be listed on each cmake run.
-    Here the options with their default value:
+    -Dhelp=1 lists all available options:
     
     # Available on all systems/compilers
     -- LYX_CPACK                = OFF    : Use the CPack management (Implies LYX_INSTALL option)
     -- LYX_INSTALL              = OFF    : Build install projects/rules (implies a bunch of other options)
-    -- LYX_NLS                  = OFF    : Use nls
+    -- LYX_NLS                  = ON     : Use nls
     -- LYX_ASPELL               = OFF    : Require aspell
     -- LYX_ENCHANT              = OFF    : Require Enchant
     -- LYX_HUNSPELL             = OFF    : Require Hunspell
     -- LYX_DEVEL_VERSION        = OFF    : Build developer version
-    -- LYX_RELEASE              = ON     : Build release version, build debug when disabled
+    -- LYX_RELEASE              = OFF    : Build release version, build debug when disabled
     -- LYX_PACKAGE_SUFFIX       = ON     : Use version suffix for packaging
     -- LYX_PCH                  = OFF    : Use precompiled headers
     -- LYX_MERGE_FILES          = OFF    : Merge source files into one compilation unit
@@ -150,7 +165,7 @@ Build options
     -- LYX_VLD                  = OFF    : Use VLD with MSVC
     -- LYX_WALL                 = OFF    : Enable all warnings
     -- LYX_CONFIGURE_CHECKS     = OFF    : Also run configure checks for MSVC
-    -- LYX_3RDPARTY_DOWNLOAD    = OFF    : Download precompiled 3rd party libraries for MSVC 10
+    -- LYX_DEPENDENCIES_DOWNLOAD= OFF    : Download precompiled 3rd party libraries for MSVC 10