-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:
- 1) ./configure
- configures LyX to your system.
+ 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.
+
+ See Note below if ./configure script is not present.
2) make
compiles the program.
4) make install
will install it. You can use "make install-strip" instead
- if you want a smaller binary.
+ 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, autoconf, and gettext installed. Then,
-type "./autogen.sh" to build the needed configuration
-files and proceed as stated below.
+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 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 egcs 1.1.x, 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, and this is not likely to change in the
-future.
-
-Note that, contrary to LyX 1.0.x, LyX 1.2.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.
-
-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.
-
-As of LyX version 1.2.0, you will need to have Xforms library and
-header version 0.88 or 0.89. Version 0.89.6 is the one which works
-best, but the old stable 0.88.1 version is still supported. On some
-systems, such as linux ELF, there are shared library versions of the
-Xforms library, which require an installation step to configure the
-system.
-
-Xforms is available (free) only in binary format, source code is not
-available. If it is not available for your machine, contact the Xforms
-developers to request a version for your system. You can get it from
-
- http://world.std.com/~xforms/
- ftp://ncmir.ucsd.edu/pub/xforms/
- ftp://ftp.lyx.org/pub/xforms/
- ftp://ftp.fu-berlin.de/unix/X11/gui/xforms
- ftp://ftp.cs.ruu.nl/pub/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
-as the rpm packages commonly found are compiled against glibc 2.0
-instead of 2.[12], and this causes occasional crashes.
-
-In addition, you must have libXpm version 4.7 or newer.
-
-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 find the latest version
-from:
-
- ftp://ftp.gnu.org/gnu/gettext-0.10.xx.tar.gz.
-
-LyX contains a hack to work around this, but you should not rely too
-much on it.
-
-To use the thesaurus, you will need to install libAikSaurus, available
-from :
-
- http://aiken.clan11.com/aiksaurus/
-
-Finally, the two following programs should be available at
-configuration time:
-
- o Perl (at least 5.002) is needed for the reLyX script. reLyX will
- not be installed if perl is not found. If the environment
- variable PERL is set to point to some program, this value will be
- used, even if the program does no exist (this can be useful if
- the machine on which LyX is built is not the one where it will
- run).
-
- 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.
+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++.
+
+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.
+
+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.
+
+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
+
+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 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
---------------------
-LyX can be configured using GNU autoconf utility which attempts to guess
-the configuration needed to suit your system. The standard way to use it
-is described in the file INSTALL.autoconf. In most cases you will be able
+LyX can be configured using GNU autoconf utility which attempts to guess
+the configuration needed to suit your system. The standard way to use it
+is described in the file INSTALL.autoconf. In most cases you will be able
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 --with-extra-lib=DIRECTORY that specifies the path where LyX will find
- extra libraries (Xpm, xforms) it needs. Defaults to NONE (i.e. search
- in standard places). You can specify several directories, separated
- by colons.
+ 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 -O -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 (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.2.0
- The LyX data directory will be something like <whatever>/lyx-1.2.0/.
+ 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.2.0
+ $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
+ 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=-latestdev
- o --enable-optimization=VALUE enables you to set optimization to a
- higher level as the default (-O), for example --enable-optimization=-O3.
+ 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 --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.
-
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 ou 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'
o --prefix=DIRECTORY specifies the root directory to use for
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.
+ o --datadir=DIRECTORY gives the directory where all extra LyX
+ 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
o --mandir=DIRECTORY gives the directory where the man pages will go.
[defaults to ${prefix}/man]
+ o --enable-maintainer-mode enables some code that automatically
+ rebuilds the configure script, makefiles templates and other useful
+ files when needed. This is off by default on releases, to avoid
+ 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
-here, you can prepend it with "`pwd`/".
+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
+If you do not like the default compile flags used (-g -O2 on gcc), you can
set CXXFLAGS variable to other values as follows:
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++14, and then
+ C++11.
-In particular, the following options could be useful in some
-desperate cases:
+ o --enable-optimization=VALUE enables you to set optimization to a
+ 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 --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 --with-broken-headers that provides prototypes to replace functions
- not correctly defined in SunOS4 and SCO header files. Its only effect is
- to suppress a few warnings. It is autodetected by default.
+ 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 --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 --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-liberty suppresses the detection of the -liberty library
- (see the section `Problems').
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 if you get an error message when compiling LyX that looks like this :
-
- ../../src/minibuffer.h:17: using directive `Object' introduced
- ambiguous type `_ObjectRec *'
-
- then you need to upgrade the version of the xforms library you have
- installed.
-
- o It is possible to compile lyx with Tru64 Unix cxx compiler
- version 6.2, provided one uses
- CXX='cxx -std strict_ansi'
- CXXFLAGS='-ptr /tmp/lyx_cxx_repository -g'
- CC=cc
-
- Note that this will not work when compiling directly from the cvs
- repository, due to the tricks used by automake for dependencies. Ask
- Jean-Marc.Lasgouttes@inria.fr for a workaround.
-
- Or rather, it may well work if you are using automake 1.5 and autoconf 2.5
- or greater, but you'll have to patch automake's depcomp first. (Depcomp
- is a little shell script to automagically work out file dependencies
- and it's broken for automake 1.5 and Tru64 :-(). The patch is to be found
- in config/depcomp.diff.
- Angus 22 March, 2002.
-
- o On Tru64 Unix, you may have to compile with
- --with-included-string to work around a Tru64 linker limitation
- (the STL string template creates names which may be too long). We
- also had reports that it helps with gcc 2.95.2 on solaris 2.6.
-
- Using Tru64 Unix 4.0e, the std::string is fine.
- Angus 22 March, 2002.
-
- o On Tru64 Unix with cxx, you may have a compilation error in
- lyx_main.C if you have GNU gettext installed. This is due to a bug
- in gettext. To solve this, you can either (1) configure with
- --with-included-gettext or (2) add -D__STDC__ to cxx flags.
-
- o On Tru64 Unix 4.0e, the STL library routine std::count is broken
- (/usr/include/cxx/algorithm.cc, line 289 on my machine).
- It calculates "n" but does not return it! The fix is to add "return n;" to
- the end of the (4-line long) routine.
- Angus 22 March, 2002.
-
- o On Tru64 Unix 4.0e, compilation of support/lyxsum.C dies horribly. The
- work-around is to use the old version, 1.18, of this routine. Ask
- Angus Leeming <leeming@lyx.org> for details.
- Angus 22 March, 2002.
-
- o Some systems lack functions that LyX needs. To fix this, configure
- tries to link against the -liberty library, if it is available.
- If you experience problems with missing symbols at link time, you
- could try to install libiberty.a, which comes with several GNU
- packages (in particular libg++). In any case, please report your
- problems to lyx-devel@lists.lyx.org.
-
- The option --without-liberty disable the detection of -liberty. It
- is meant for debugging purpose only.
-
- o According to David Sundqvist <David_Sundqvist@vd.volvo.se>, some
- changes are needed to compile with aCC on HP-UX 10.20. These are the
- relevant changes in the makefile (with comments tagged on):
-
- CXX = /opt/aCC/bin/aCC
- CXXFLAGS = -O +inst_none # The aCC compiler tries to run instantiations
- # which currently break.
-
- LIBS = -lforms -lXpm -lSM -lICE -lc -lm -lX11 -lCsup # must link with Csup
- LDFLAGS = -L/opt/aCC/lib # perhaps not needed.
-
-
projects / lyx.git / blobdiff