]> git.lyx.org Git - lyx.git/blobdiff - INSTALL
restore the correct behavior of suppression of misspelled marker for word at cursor...
[lyx.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 1b472854099115a417b1efac60893e38ef2f91a9..9a39b000a7c5f6c6e63e8415119c29ca253eee9c 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -13,7 +13,10 @@ These four steps will compile, test and install LyX:
           configures LyX according to your system. 
           You may have to set
            --with-qt4-dir=<path-to-your-qt4-installation>
-     if the environment variable QTDIR is not set. 
+     if the environment variable QTDIR is not set (for example,
+     '--with-qt4-dir=/usr/share/qt4/'). Alternatively, you could
+     install pkgconfig (the name might vary depending on your 
+     distribution). 
           See Note below if ./configure script is not present.
 
        2) make
@@ -46,14 +49,14 @@ Requirements
 First of all, you will also need a recent C++ compiler, where recent
 means that the compilers are close to C++ standard conforming (gcc 4.x).
 
-LyX 1.6.x makes great use of C++ Standard Template Library (STL).
+LyX makes great use of C++ Standard Template Library (STL).
 This means that gcc users will have to install the relevant libstdc++
 library to be able to compile this version of LyX. 
 
-LyX has been tested with all Qt versions since Qt 4.2.2. For compilation
-you need to compile against at least Qt 4.2.2. The only special point to
-make is that you must ensure that both LyX and the Qt libraries are
-compiled with the same C++ compiler.
+For full LyX usability we suggest to use at least Qt 4.6 which has been
+widely tested. For compilation you need to compile against at least
+Qt 4.2.2. The only special point to make is that you must ensure that both
+LyX and the Qt libraries are compiled with the same C++ compiler.
 
 Note that if Qt is using Xft2/fontconfig, you may need to install the
 latex-xft-fonts package (at ftp://ftp.lyx.org/pub/lyx/contrib/) to get
@@ -66,6 +69,11 @@ at the console. Most recent distributions are known to use fontconfig.
 If, however, your version of Qt does not use fontconfig, then TeX
 fonts should be added to the font path. 'man xset' is your friend.
 
+To build LyX with spell checking capabilities included you have to
+install at least one of the development packages of the spell checker
+libraries. See the RELEASE-NOTES for details.
+
+
 * Other things to note
 
 If you make modifications to files in src/ (for example by applying a
@@ -74,10 +82,6 @@ to some dependencies in the makefiles. You can get the latest version
 from:
        ftp://ftp.gnu.org/gnu/gettext/
 
-To use the thesaurus, you will need to install libAikSaurus, available
-from:
-       http://aiksaurus.sourceforge.net/
-
 The two following programs should be available at configuration time:
 
   o LaTeX2e should be correctly setup for the user you are logged in
@@ -86,7 +90,7 @@ The two following programs should be available at configuration time:
 
   o Python 2.3 or newer installed to be able to import older LyX files
     with the lyx2lyx script (this script is called automatically when
-    opening a file).
+    opening a file). Python 3.0 or later is not supported.
 
 
 Creating the Makefile
@@ -99,20 +103,21 @@ to create the Makefile by typing
 
   ./configure
 
-For more complicated cases, LyX configure takes the following specific
+For more complicated cases, LyX configure honors the following specific
 flags:
 
-  o --enable-build-type=[rel(ease), dev(elopment), pre(release)]
+  o --enable-build-type=[rel(ease), pre(release), dev(elopment), prof(iling), gprof]
     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
+                      release   prerelease  development profiling gprof
+    optimization        -O2         -O2         -O         -O2     -O2
     assertions                       X           X
     stdlib-debug                                 X
     concept-checks                   X           X
     warnings                         X           X
-    debug                            X           X
+    debug                            X           X           X       X
+    gprof                                                            X
 
     The default are as follows in terms of version number
     release: stable release (1.x.y)
@@ -207,7 +212,7 @@ this file.
 
 The following options allow to tweak more precisely the generated code:
 
-  o --enable-profiling instruments the code for use with the gprof
+  o --enable-gprof instruments the code for use with the gprof
     profiler. The result are only meaningful in conjunction with
     --enable-build-type=release.