X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=INSTALL;h=152561818115ccec10f30f9128e4ea53d6fbd7e3;hb=8a17cc01e0fa81e2730ef96887d4bffbb641cfd0;hp=7ed8b1b46dcb4506fbdda9cd34717e264265f1b3;hpb=66dcc7f62c1e6c9ff0d4e55c6c13e3fbbf806bc6;p=lyx.git diff --git a/INSTALL b/INSTALL index 7ed8b1b46d..1525618181 100644 --- a/INSTALL +++ b/INSTALL @@ -6,16 +6,16 @@ Quick compilation guide These four steps will compile, test and install LyX: - 0) Linux users beware: You need qt4 and qt4-devel packages + 0) Linux users beware: You need qt5 and qt5-devel packages of the same version to compile LyX. In general, it is also recommended to have pkg-config - installed (the name might vary depending on your + installed (the name might vary depending on your distribution). 1) ./configure configures LyX according to your system. You - may have to set --with-qt4-dir= - (for example, "--with-qt4-dir=/usr/share/qt4/") if the + may have to set --with-qt-dir= + (for example, "--with-qt-dir=/usr/share/qt5/") if the environment variable QTDIR is not set and pkg-config is not available. @@ -36,9 +36,8 @@ Note for Git checkouts ----------------------------- If you have checked this out from Git, you need to have: -* automake >= 1.8 -* autoconf >= 2.59d -* gettext >= 0.16.1 +* automake (supported versions are 1.14--1.16) +* autoconf (supported versions are 2.65--2.69) Then type "./autogen.sh" to build the needed configuration files and proceed as stated above/below. @@ -48,17 +47,18 @@ 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++ standard conforming (gcc 4.x). +First of all, you will need a C++11 standard conforming compiler, like gcc (at +least 4.7) 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++ -library to be able to compile this version of LyX. +library to be able to compile this version of LyX. -For full LyX usability we suggest to use at least Qt 4.8 which has been -widely tested. For compilation you need to compile against at least -Qt 4.5.0. 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 Qt 5.6 and higher, or at the +very least Qt 5.4. For compilation you need to compile against at least +Qt 4.8 which has been widely tested, and for Windows we advise at least +Qt 4.8.4. 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. To build LyX with spell checking capabilities included you have to install at least one of the development packages of the spell checker @@ -67,23 +67,20 @@ libraries. See the RELEASE-NOTES for details. * Other things to note -If you make modifications to files in src/ (for example by applying a -patch), you will need to have the GNU gettext package installed, due -to some dependencies in the makefiles. You can get the latest version -from: +If you make modifications to the source that affect any of the +translations or you change the translation files themselves (po/*.po) +files, you will need to have the GNU gettext package installed to +compile LyX with up-to-date translations (at least gettext version +0.16.1 is needed). You can get the latest version from: ftp://ftp.gnu.org/gnu/gettext/ The two following programs should be available at configuration time: - o LaTeX2e should be correctly setup for the user you are logged in - as. Otherwise, LyX will not be able to run a number of tests. Note - that users can run these tests manually with Tools>Reconfigure. - - o Python 2.4 or 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). Python 3.0 or later is not supported. + 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. Creating the Makefile @@ -107,18 +104,23 @@ flags: optimization -O2 -O2 -O -O2 -O2 assertions X X stdlib-debug X - concept-checks X X warnings X X debug X X X X - gprof X The defaults are as follows in terms of version number - release: stable release (1.x.y) + release: stable release (2.x.y) prerelease: version number contains alpha, beta, rc or pre. development: version number contains dev. - o --with-extra-lib=DIRECTORY that specifies the path where LyX will - find extra libraries (qt4) it needs. Defaults to NONE + 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 (like Qt) it needs. Defaults to NONE (i.e. search in standard places). You can specify several directories, separated by colons. @@ -152,13 +154,6 @@ LyX: o --disable-nls suppresses all internationalization support, yielding somewhat smaller code. - o --with-included-gettext forces the use of the included GNU gettext - library, although you might have another one installed. - - o --with-catgets allows to use the catget() functions which can - exist on your system. This can cause problems, though. Use with - care. - o You can also set the environment variable LINGUAS to a list of languages in case you do not want to install all the translation files. For example, if you are only interested in German and @@ -200,58 +195,44 @@ 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: - - o --enable-gprof instruments the code for use with the gprof - profiler. The results are only meaningful in conjunction with - --enable-build-type=release. +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-optimization=VALUE enables you to set optimization to a - higher level than the default (-O), for example --enable-optimization=-O3. + higher level than the default, for example --enable-optimization=-O3. o --disable-optimization - you can use this to disable compiler 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. The default is to have debug information - for development versions and prereleases only. + 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. o --enable-warnings that make the compiler output more warnings during - the compilation of LyX. Opposite is --disable-warnings. By default, - this flag is on for development versions only. + the compilation of LyX. Opposite is --disable-warnings. o --enable-assertions that make the compiler generate run-time code which checks that some variables have sane values. Opposite - is --disable-assertions. By default, this flag is on for - development versions only. + is --disable-assertions. 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. By default, this flag is on for development - versions only. - - o --enable-concept-checks adds some compile-time checks. There is no - run-time penalty. By default, this flag is on for development - versions only. + 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 + --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. - o --without-latex-config that disables the automatic detection of your - latex configuration. This detection is automatically disabled if - latex cannot be found. If you find that you have to use this - flag, please report it as a bug. - - o --with-frontend=FRONTEND that allows to specify which frontend you - want to use. The default value is qt4, which is the only available - frontend for now. - - 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 @@ -270,8 +251,9 @@ to strip the lyx binary. In this case replace "make install" with make install-strip -BTW: in the images subdirectory there is also a small icon "lyx.png", -that can be used to display lyx-documents in filemanagers. +BTW: in the lib/images subdirectory there is also small icons +`lyx.png' and `lyx.svg', that can be used to display LyX documents in +filemanagers. If configure fails for some strange reason ------------------------------------------ @@ -290,64 +272,9 @@ you want the object files and executables to go and run the `configure' script. `configure' automatically checks for the source code in the directory that `configure' is in and in `..'. -If you have to use a `make' that does not supports the `VPATH' +If you have to use a `make' that does not support the `VPATH' variable, you have to compile LyX for one architecture at a time in 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 - - - -