These four steps will compile, test and install LyX:
- 0) Linux users beware: if compiling the Qt frontend, you need
- qt4 and qt4-devel packages of the same version to compile LyX.
+ 0) Linux users beware: You need qt4 and qt4-devel packages
+ of the same version to compile LyX.
- 1) ./configure
- configures LyX according to your system.
- When compiling for Qt, you may have to set
- --with-qt4-dir=<path-to-your-qt4-installation>
- if the environment variable QTDIR is not set.
+ 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/qt4/") 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.
if you want a smaller binary.
-Note for Subversion checkouts
+Note for Git checkouts
-----------------------------
-If you have checked this out from Subversion, 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.8--1.15)
+* autoconf (supported versions are 2.60--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.
+First of all, you will need a recent C++ compiler, where recent means
+that the compilers are close to C++ standard conforming like gcc (at
+least 4.x) or clang. Note that the compiler will be used in C++11 mode
+when possible.
-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).
+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. 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.
-
-LyX has been tested with Qt 4.2.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.
+library to be able to compile this version of LyX.
-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:
+For full LyX usability we suggest to use Qt 4.x and at least Qt 4.8 which
+has been widely tested. For compilation you need to compile against at
+least Qt 4.5.0 and at Windows we advise at highest 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.
- ldd `which lyx` | grep 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.
-at the console. Both RH8 and Debian unstable distributions are known
-to use fontconfig.
-
-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.
* 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 2.3 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 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
./configure
-For more complicated cases, LyX configure takes the following specific
+For more complicated cases, LyX configure honors the following specific
flags:
+ 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-debug X
+ warnings X X
+ debug X X X 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 --with-extra-lib=DIRECTORY that specifies the path where LyX will
find extra libraries (qt4) it needs. Defaults to NONE
(i.e. search in standard places). You can specify several
--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.4.1
- The LyX data directory will be something like <whatever>/lyx-1.4.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.4.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=-latestsvn
+ ./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.
-
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'
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.
-In particular, the following options could be useful in some desperate
-cases:
+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, 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-cxx11 forces the compiler in C++98 mode. The default is
+ to use C++11 mode for known good compilers.
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.
- 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
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
------------------------------------------
-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
+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 8, you need gnumake. The LyX makefiles do not
+ o On SUN Sparc Solaris, you need gnumake. The LyX makefiles do not
work with Solaris make.
- The Solaris ar seg-faults trying to build the insets library. You
+ 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.
-
- 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.
+ 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
+
+ <match target="pattern">
+ <edit name="prefer_bitmap">
+ <bool>false</bool>
+ </edit>
+ </match>
+
+ 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
+ <fontconfig> and </fontconfig> tags. If neither ~/.fonts.conf nor
+ /etc/fonts/local.conf exists, you can create them with the following
+ content:
+
+ <?xml version="1.0"?>
+ <!DOCTYPE fontconfig SYSTEM "fonts.dtd">
+ <fontconfig>
+ <match target="pattern">
+ <edit name="prefer_bitmap">
+ <bool>false</bool>
+ </edit>
+ </match>
+ </fontconfig>
projects / lyx.git / blobdiff