X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=INSTALL;h=2847ad807f80ac6f44c5584e9fa0a1b24351452a;hb=5908bb3ea6e6962308c70bd05a7f61baa8f2e0ce;hp=40c674169f21cfbff20bd7a34bec1c6380ff8d2d;hpb=1efef5542baed427045ce77fa41bb0264ca5e1e8;p=lyx.git
diff --git a/INSTALL b/INSTALL
index 40c674169f..2847ad807f 100644
--- 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
-----------------------
@@ -47,9 +52,8 @@ You will also probably need GNU m4 (perhaps installed as gm4).
Requirements
------------
-First of all, you will need a recent C++ compiler, where recent means
-that the compilers are close to C++11 standard conforming like gcc (at
-least 4.6) or clang.
+First of all, you will need a C++11 standard conforming compiler, like gcc (at
+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++
@@ -65,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
@@ -107,18 +114,22 @@ 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
+ also available. By default Qt5 is tried first, and then Qt4.
+
o --with-extra-lib=DIRECTORY that specifies the path where LyX will
- find extra libraries (qt4) it needs. Defaults to NONE
+ find extra libraries (like Qt) it needs. Defaults to NONE
(i.e. search in standard places). You can specify several
directories, separated by colons.
@@ -193,10 +204,13 @@ set CXXFLAGS variable to other values as follows:
Similarly, if you want to force the use of a specific compiler, you can
give a value to the CXX variable.
-If you encounter problems, please read the section 'Problems' at the end of
-this file.
+The following options allow you to tweak the generated code more
+precisely (see the description of --enable-build-type for the default
+values):
-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.
@@ -205,10 +219,6 @@ The following options allow you to tweak the generated code more precisely (see
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.
@@ -223,18 +233,10 @@ The following options allow you to tweak the generated code more precisely (see
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.
- o --enable-monolithic-build[=boost,client,insets,mathed,core,tex2lyx,frontend-qt4]
- that enables monolithic build of the given parts of the source
- code. This should reduce the compilation time provided you have
- enough memory (>500MB).
Compiling and installing LyX
@@ -280,57 +282,3 @@ the source code directory. After you have installed LyX for one
architecture, use `make distclean' before reconfiguring for another
architecture.
-Problems
---------
-
-This section provides several hints that have been submitted by LyX
-team members or users to help compiling on some particular
-architectures. If you find that some of these hints are wrong, please
-notify us.
-
- o On SUN Sparc Solaris, you need gnumake. The LyX makefiles do not
- work with Solaris make.
-
- The Solaris 8 ar seg-faults trying to build the insets library. You
- will need to use the ar from the GNU binutils for this subdirectory.
- There is no problem with the Solaris 9 and 10 ar.
-
- Qt4 uses the Xrender X11 extension for antialiased fonts. This
- extension was added to Xsun starting from the Solaris 10 8/07
- release, but it is not activated by default. To activate it, you
- must issue (as root) the following command:
- svccfg -s svc:/application/x11/x11-server setprop options/server_args=+xrender
- and then restart the X server.
-
- There is a problem with the fontconfig library shipped with
- Solaris 10 8/07 causing a seg-fault when it is used by Qt4.
- Until this is fixed, a workaround is replacing the shared library
- /usr/lib/libfontconfig.so.1 with a copy from a previous release or
- installing a new version of fontconfig from http://www.sunfreeware.com/
-
- On Solaris, the default fontconfig configuration gives preference
- to bitmap fonts at (not so small) sizes. As bitmapped fonts are not
- antialiased, you may prefer changing this configuration. This may be
- done by adding the following stanza
-
-
-
- false
-
-
-
- to either ~/.fonts.conf (for a per-user change) or /etc/fonts/local.conf
- (for a global system change). The stanza should be added between the
- and tags. If neither ~/.fonts.conf nor
- /etc/fonts/local.conf exists, you can create them with the following
- content:
-
-
-
-
-
-
- false
-
-
-