Added Liviu Andronic, and modified generate_contributions.py to match what was in...

[lyx.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 8fec24e8f44ad507504a51a5bcb92f2cd379fef4..142ee9766fa9d2db9e12dc790932f86d94c3f988 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -14,6 +14,7 @@ These four steps will compile, test and install LyX:
           When compiling for Qt, you may have to set
              --with-qt4-dir=<path-to-your-qt4-installation>
            if the environment variable QTDIR is not set. 
+          See Note below if ./configure script is not present.
 
        2) make
           compiles the program.
@@ -26,12 +27,12 @@ These four steps will compile, test and install LyX:
            if you want a smaller binary.
 
 
-Note for Subversion checkouts
+Note for Subversion (SVN) checkouts
 -----------------------------
 
 If you have checked this out from Subversion, you need to have:
 * automake >= 1.5
-* autoconf >= 2.52
+* autoconf >= 2.59c
 * gettext >= 0.12
 Then type "./autogen.sh" to build the needed configuration
 files and proceed as stated below.
@@ -100,19 +101,21 @@ For more complicated cases, LyX configure takes the following specific
 flags:
 
   o --enable-build-type=[rel(ease), dev(elopment), pre(release)]
-    allows to tweak the compiled code. The options are equivalent to:
-
-    release: --enable-optimization=-O2 --disable-assertions 
-             --disable-stdlib-debug --disable-concept-checks
-             --disable-warnings --disable-debug
-
-    prerelease: --enable-optimization=-O2 --enable-assertions 
-             --disable-stdlib-debug --enable-concept-checks
-             --enable-warnings --enable-debug
-
-    development: --enable-optimization=-O --enable-assertions
-             --enable-stdlib-debug --enable-concept-checks
-             --enable-warnings --enable-debug
+    allows to tweak the compiled code. The following table describes
+    the settings in terms of various options that are described later
+
+                      release   prerelease  development
+    optimization        -O2         -O2         -O
+    assertions                       X           X
+    stdlib-debug                                 X
+    concept-checks                   X           X
+    warnings                         X           X
+    debug                            X           X
+
+    The default are as follows in terms of version number
+    release: stable release (1.x.y)
+    prerelease: version number contains alpha, beta, rc or pre.
+    development: version number contains svn.
 
   o --with-extra-lib=DIRECTORY that specifies the path where LyX will
     find extra libraries (qt4) it needs. Defaults to NONE
@@ -127,10 +130,10 @@ flags:
        --with-extra-lib=DIRECTORY/lib --with-extra-inc=DIRECTORY/include
     If DIRECTORY is not specified, the current prefix is used.
 
-  o --with-version-suffix will install LyX as lyx-<version>, e.g. lyx-1.6.1
-    The LyX data directory will be something like <whatever>/lyx-1.6.1/.
-    Additionally your user configuration files will be found in e.g.
-    $HOME/.lyx-1.6.1
+  o --with-version-suffix[=VERSION] will install LyX as lyx-VERSION,
+    e.g. lyx-1.6.1. The LyX data directory will be something like 
+    <whatever>/lyx-1.6.1/. Additionally your user configuration files 
+    will be found in e.g. $HOME/.lyx-1.6.1
 
     You can use this feature to install more than one version of LyX
     on the same system. You can optionally specify a "version" of your
@@ -199,8 +202,11 @@ give a value to the CXX variable.
 If you encounter problems, please read the section 'Problems' at the end of
 this file.
 
-In particular, the following options could be useful in some desperate
-cases:
+The following options allow to tweak more precisely the generated code:
+
+  o --enable-profiling instruments the code for use with the gprof
+    profiler. The result are only meaningful in conjunction with
+    --enable-build-type=release.
 
   o --enable-optimization=VALUE enables you to set optimization to a
     higher level as the default (-O), for example --enable-optimization=-O3.
@@ -241,6 +247,11 @@ cases:
     want to use. The default value is qt4, which is the only available
     frontend for now.
 
+  o --enable-monolithic-[boost,client,insets,mathed,core,tex2lyx,frontend-qt4]
+    that enable monolithic build of the given part of the source code. This
+    should reduce the compilation time provided you have enough memory
+    (>500MB).
+
 
 Compiling and installing LyX
 ----------------------------