fr/Additional: amend 65030649

[lyx.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 6229f6ef0903d83bff8413f15120bf5d6e9b1808..f26fba6aa9059566d828eee546905487ba9363b2 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,5 +1,10 @@
-Compiling and installing LyX
-============================
+Compiling and installing LyX with autotools
+===========================================
+
+This document is about compiling LyX with the autotools suite. If you
+want to compile using using CMake (in particular on windows), please
+refer to the INSTALL.cmake file.
+
 
 Quick compilation guide
 -----------------------
@@ -48,7 +53,7 @@ Requirements
 ------------
 
 First of all, you will need a C++11 standard conforming compiler, like gcc (at
-least 4.8) or clang.
+least 4.9) or clang.
 
 LyX makes great use of the C++ Standard Template Library (STL).
 This means that gcc users will have to install the relevant libstdc++
@@ -64,6 +69,9 @@ 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.
 
+Users of debian-based distributions are well advised to run
+'apt-get build-dep lyx' before compiling to install proper dependencies.
+
 
 * Other things to note
 
@@ -76,11 +84,10 @@ compile LyX with up-to-date translations (at least gettext version
 
 The two following programs should be available at configuration time:
 
-  o Python 2.7 must be installed. Python is used for many simple tasks
-    that are executed by external scripts, such as the automatic
-    configuration step and the import of older LyX documents with the
-    lyx2lyx script (this script is called automatically when opening a
-    file). Python 3 (3.3 or later) support is work in progress.
+  o Python (2.7 or 3.5 and newer) must be installed. Python is used for many
+    simple tasks that are executed by external scripts, such as the automatic
+    configuration step and the import of older LyX documents with the lyx2lyx
+    script (this script is called automatically when opening a file).
 
 
 Creating the Makefile
@@ -106,20 +113,21 @@ flags:
     stdlib-debug                                 X
     warnings                         X           X
     debug                            X           X           X       X
+    maintainer-mode                              X
 
     The defaults are as follows in terms of version number
     release: stable release (2.x.y)
-    prerelease: version number contains alpha, beta, rc or pre.
-    development: version number contains dev.
+    prerelease: version number contains `alpha', `beta', `rc' or `pre'.
+    development: version number contains `dev'.
 
     The `profiling' build type uses the -fno-omit-frame-pointer option with gcc
 
     The `gprof' build type compiles and links with -pg option with gcc.
 
-o --disable-qt5 that forces configuration with Qt 4.x when Qt 5.x is
+  o --disable-qt5 that forces configuration with Qt 4.x when Qt 5.x is
     also available. By default Qt5 is tried first, and then Qt4.
 
-o --with-extra-lib=DIRECTORY that specifies the path where LyX will
+  o --with-extra-lib=DIRECTORY that specifies the path where LyX will
     find extra libraries (like Qt) it needs. Defaults to NONE
     (i.e. search in standard places). You can specify several
     directories, separated by colons.
@@ -199,6 +207,10 @@ The following options allow you to tweak the generated code more
 precisely (see the description of --enable-build-type for the default
 values):
 
+  o --enable-cxx-mode=VALUE can be used to select a C++ standard, for
+    example --enable-cxx-mode=11. The default is to try C++14, and then
+    C++11.
+
   o --enable-optimization=VALUE enables you to set optimization to a
     higher level than the default, for example --enable-optimization=-O3.
 
@@ -206,11 +218,6 @@ values):
     optimization of LyX. The compile may be much quicker with some
     compilers, but LyX will run more slowly.
 
-  o --disable-std-regex forces the compiler to use boost::regex. The
-    default is to use std::regex for known good C++ libraries, but the
-    test is not robust for clang. --enable-std-regex will force the
-    use of std::regex.
-
   o --enable-debug will add debug information to your binary. This
     requires a lot more disk space, but is a must if you want to try
     to debug problems in LyX. There is no run-time penalty.
@@ -225,13 +232,9 @@ values):
   o --enable-stdlib-debug adds some debug code in the standard
     library; this slows down the code, but has been helpful in the
     past to find bugs. Note that this is in general incompatible with
-    the system boost library (which is used when
-    --without-included-boost is specified). You may have to use
+    the system hunspell library (as of version 1.5). You may have to use
     --disable-stdlib-debug when linking development versions against
-    your system's boost library.
-    The same problem applies to hunspell (as of hunspell 1.5). So either
-    compile --with-included-hunspell or --disable-stdlib-debug when
-    linking development versions against your system's hunspell library.
+    your system's hunspell library.