-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
-----------------------
These four steps will compile, test and install LyX:
- 0) Linux users beware: if compiling the Qt frontend, you need
- qt and qt-devel packages of the same version to compile LyX.
+ 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
+ distribution).
+
+ 1) ./configure configures LyX according to your system. You
+ may have to set --with-qt-dir=<path-to-your-qt-installation>
+ (for example, "--with-qt-dir=/usr/share/qt5/") if the
+ environment variable QTDIR is not set and pkg-config is not
+ available.
- 1) ./configure --with-frontend=[qt or xforms]
- configures LyX according to your system.
- When compiling for Qt, you may have to set
- --with-qt-dir=<path-to-your-qt-installation>
- if the environment variable QTDIR is not set.
+ See Note below if ./configure script is not present.
2) make
compiles the program.
if you want a smaller binary.
-Note for CVS checkouts
-----------------------
+Note for Git checkouts
+-----------------------------
-If you have checked this out from CVS, you need to have:
-* automake >= 1.5
-* autoconf >= 2.52
-* gettext >= 0.12
+If you have checked this out from Git, you need to have:
+* 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 below.
+files and proceed as stated above/below.
You will also probably need GNU m4 (perhaps installed as gm4).
+
Requirements
------------
-First of all, you will also need a recent C++ compiler, where recent
-means that the compilers are close to C++ standard conforming.
-Compilers that are known to compile LyX are gcc 2.95.x and later
-and Digital C++ version 6.1 and later. Please tell us your experience
-with other compilers.
-
-It is _not_ possible to compile LyX with gcc 2.7.x and 2.8.x.
-
-LyX 1.4.x 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. Users of gcc 2.95.x
-will have to install the STLPort version of these libraries as the
-ones that come with gcc 2.95.x are too broken for us to use.
-
-* Qt frontend
-
-LyX has been tested with Qt 3.x, though Qt 2.x may happen to work too.
-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.
+First of all, you will need a C++11 standard conforming compiler, like g++ (at
+least 4.9, to have proper srd::regex) or clang++.
-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
-maths symbols displayed properly. To find out, type:
+LyX makes great use of the C++ Standard Library. This means that gcc
+users will have to install the relevant libstdc++ library to be able
+to compile this version of LyX.
- ldd `which lyx` | grep fontconfig
+For full LyX usability we suggest to use Qt 5.6 and higher, or at the
+very least Qt 5.4. It is also possible to compile against Qt 6. 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.
-at the console. Both RH8 and Debian unstable distributions are known
-to use fontconfig.
+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.
-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.
+Users of debian-based distributions are well advised to run
+'apt-get build-dep lyx' before compiling to install proper dependencies.
-* xforms frontend
-
-Both an Xforms and Xpm libraries should be installed to compile LyX.
-It is imperative that you have the correct versions of these
-libraries, and their associated header files.
-
-The xforms library has been very recently updated to version 1.0.
-This version has been released under the LGPL (Lesser General Public
-License), and the availability of the source means that many bugs that
-have been plaguing LyX have been fixed in xforms. You are advised to
-upgrade to xforms 1.0 to enjoy all these new fixes.
-In fact, LyX 1.4.x no longer supports versions of xforms older than 1.0.
-
-You can get the source from
- http://savannah.nongnu.org/download/xforms/
-
-If you use a rpm-based linux distribution, such as RedHat or Mandrake,
-we recommend that you grab a version of xforms from
- ftp://ftp.lyx.org/pub/lyx/contrib
-Look for the xforms-1.0-release.src.rpm or the binary libforms*.i386.rpm.
-
-In addition, you must have libXpm version 4.7 or newer.
* 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/
-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
- as. Otherwise, LyX will not be able to run a number of tests. Note
- that users can run these tests manually with Edit>Reconfigure.
-
- o Python 1.5.2 or newer installed to be able to import older LyX files
- with the lyx2lyx script (this script is called automatically when
- opening a file).
+ 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
./configure
-For more complicated cases, LyX configure takes the following specific
+For more complicated cases, LyX configure honors the following specific
flags:
- o --with-frontend=FRONTEND that allows to specify which frontend you
- want to use. Default is "xforms", and the other possible value is
- "qt".
+ 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 profiling gprof
+ optimization -O2 -O2 -Og -O2 -O2
+ assertions X X
+ stdlib-assertions X
+ stdlib-debug
+ 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'.
+
+ 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 --enable-qt6 that checks configuration with Qt 6.x, and then Qt
+ 5.x. By default, only Qt5 is tried.
o --with-extra-lib=DIRECTORY that specifies the path where LyX will
- find extra libraries (Xpm, xforms, qt) 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.
o --with-extra-inc=DIRECTORY that gives the place where LyX will find
- xforms headers. Defaults to NONE (i.e. search in standard places).
+ extra headers. Defaults to NONE (i.e. search in standard places).
You can specify several directories, separated by colons.
o --with-extra-prefix[=DIRECTORY] that is equivalent to
--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.3.1
- The LyX data directory will be something like <whatever>/lyx-1.3.1/.
+ o --with-version-suffix[=SUFFIX] will install LyX as lyxSUFFIX. The
+ LyX data directory will be something like <whatever>/lyxSUFFIX/.
Additionally your user configuration files will be found in e.g.
- $HOME/.lyx-1.3.1
+ $HOME/.lyxSUFFIX. The default for SUFFIX is "-<currentversion>",
+ e.g. 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
own, by doing something like :
- ./configure --with-version-suffix=-latestcvs
+ ./configure --with-version-suffix=-latestdev
Note that the standard configure options --program-prefix,
--program-suffix and the others will not affect the shared LyX
directory etc. so it is recommended that you use --with-version-suffix
(or --prefix) instead.
- o --enable-optimization=VALUE enables you to set optimization to a
- higher level as the default (-O), 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 --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.
-
There are also flags to control the internationalization support in
LyX:
o --disable-nls suppresses all internationalization support,
- yielding a 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.
+ yielding somewhat smaller code.
o You can also set the environment variable LINGUAS to a list of
- language in case you do not want to install all the translation
+ languages in case you do not want to install all the translation
files. For example, if you are only interested in German and
Finnish, you can type (with sh or bash)
export LINGUAS='de fi'
installation. [defaults to /usr/local]
o --datadir=DIRECTORY gives the directory where all extra LyX
- files (lyxrc example, documentation, templates and layouts
- definitions) will be installed.
+ files (documentation, templates and layout definitions)
+ will be installed.
[defaults to ${prefix}/share/lyx${program_suffix}]
o --bindir=DIRECTORY gives the directory where the lyx binary
surprises.
Note that the --with-extra-* commands are not really robust when it
-comes to use of relative paths. If you really want to use a relative path
+comes to using relative paths. If you really want to use a relative path
here, you can prepend it with "`pwd`/".
If you do not like the default compile flags used (-g -O2 on gcc), you can
o CXXFLAGS='-O2' (sh, bash)
o setenv CXXFLAGS '-O2' (csh, tcsh)
-Similarly, if you want to force the use of some specific compiler, you can
+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):
+
+ 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++17, C++14, and
+ C++11, in this order.
+
+ o --enable-optimization=VALUE enables you to set optimization to a
+ higher level than the default, for example --enable-optimization=-O3.
+ Default is -Og when debugging is enabled, -O2 otherwise.
+
+ 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 be slower.
-In particular, the following options could be useful in some desperate
-cases:
+ 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.
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-assertions adds some bound checking code in the
+ libstdc++ standard library; this slows down the code, but has been
+ helpful in the past to find bugs. This has no effect when using
+ llvm's libc++ library.
+
+ o --enable-stdlib-debug encompasses stdlib-assertions and adds
+ additional checks in libstdc++. Note that this changes the ABI and
+ is in general incompatible with 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 hunspell
+ library. This has no effect when using llvm's libc++ 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.
Compiling and installing LyX
make install-strip
-BTW: in the images subdirectory there is also a small icon "lyx.xpm",
-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
------------------------------------------
-Even when configure fails, it creates a Makefile. You always can check
+Even when configure fails, it creates a Makefile. You can always check
the contents of this file, modify it and run 'make'.
Compiling For Multiple Architectures
`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.
-Preparing a binary distribution for the use of others
-------------------------------------------------------
-
- o Compile LyX with the right compiler switches for your
- architecture. Make sure you use the --without-latex-config switch
- of configure, since others might not be interested by your
- configuration :-)
-
- o Create a file README.bin describing your distribution and
- referring to *you* if problems arise. As a model, you can use the
- file development/tools/README.bin.example, which can be a good
- starting point.
-
- o Type `make bindist'. This will create a file
- lyx-1.xx.yy-bin.tar.gz. Rename it to reflect you architecture
- and the peculiarities of your build (e.g. static vs. dynamic).
-
- o Check that everything is correct by unpacking the distribution
- in some private place and running it. In particular, check the
- output of `ldd lyx' to know which libraries are really needed.
-
- o Upload your binary file to ftp.devel.lyx.org:/pub/incoming, and
- notify larsbj@lyx.org.
-
-
-Problems
---------
-
-This section provides several hints that have been submitted by LyX
-team member or users to help compiling on some particular
-architectures. If you find that some of this hints are wrong, please
-notify us.
-
- o If you have problems indicating that configure cannot find a part of
- the xforms or Xpm library, use the --with-extra-lib and --with-extra-inc
- options of configure to specify where these libraries reside.
-
- o Configure will seemingly fail to find xpm.h and forms.h on linux
- if the kernel headers are not available. Two cases are possible:
-
- - you have not installed the kernel sources. Then you should
- install them or at least the kernel-headers package (or
- whatever it is called in your distribution).
-
- - you have the sources, but you did a 'make mrproper' in the
- kernel directory (this this removes some symbolic links that
- are needed for compilation). A 'make symlinks' in linux kernel
- sources fixes that.
-
- o if you are using RedHat Linux 7.x, you must make sure you have the
- latest updated gcc and related packages installed (at least -85),
- or LyX will not compile or will be mis-compiled.
-
- o On SUN Sparc Solaris 8, you need gnumake. The LyX makefiles do not
- work with Solaris make.
-
- The Solaris ar seg-faults trying to build the insets library. You
- will need to use the ar from the GNU binutils for this subdirectory.
-
- o LyX can be compiled on Tru64 Unix with either GNU's gcc or the default
- Compaq cxx compiler.
-
- There are no Alpha-specific problems with gcc.
-
- The following notes all refer to compilation with the Compaq cxx compiler.
-
- LyX cannot be compiled on Tru64 Unix 4.0d or 4.0e with the default cxx
- compiler. You should upgrade to at least cxx V6.2, to be found at
- ftp::/ftp.compaq.com/pub/products/C-CXX/tru64/cxx/CXX622V40.tar. Users
- running Tru64 Unix 4.0f and greater should have no real problems compiling
- LyX.
-
- cxx V6.2 will compile LyX out of the box.
- cxx V6.3-020 is also known to work, although there is a bug in
- /usr/include/cxx/deque that will break compilation in FormPreferences.C.
- Compaq are investigating, but a patch that works /now/ is:
-
---- /usr/include/cxx/deque_safe Mon Mar 4 21:09:50 2002
-+++ /usr/include/cxx/deque Mon Mar 4 21:09:00 2002
-@@ -570,9 +570,11 @@
- {
- if (size() >= x.size())
- erase(copy(x.begin(), x.end(), begin()), end());
-- else
-- copy(x.begin() + size(), x.end(),
-- inserter(*this,copy(x.begin(),x.begin()+size(),begin())));
-+ else {
-+ const_iterator mid = x.begin() + difference_type(size());
-+ copy(x.begin(), mid, begin());
-+ insert(end(), mid, x.end());
-+ }
- }
- return *this;
- }
-
- At the time of writing, cxx V6.5-026 is the latest cxx compiler. It is
- /not/ recommended. The compiler itself appears to be both buggy and
- extremely bloated (trebling the size of the stripped LyX binary).
-
- In order to compile LyX with the cxx compiler, you should run configure
- with the following flags:
- CXX='cxx -std strict_ansi'
- CXXFLAGS='-nopure_cname -nocleanup -ptr /tmp/lyx_cxx_repository -O2'
- CC='cc -std1'
- The -nopure_cname flag is needed for compilers V6.3 and above because
- LyX makes use of functions like popen, pclose that are defined in the
- c version of <stdio.h> but are not formally part of any c/c++ standard.
- They are not, therefore, included in the <cstdio> header file.
projects / lyx.git / blobdiff