INSTALL

   1 Compiling and installing LyX
   2 ============================
   3
   4 Quick compilation guide
   5 -----------------------
   6
   7 These four steps will compile, test and install LyX:
   8
   9         0) Linux users beware: You need qt5 and qt5-devel packages
  10            of the same version to compile LyX.
  11
  12            In general, it is also recommended to have pkg-config
  13            installed (the name might vary depending on your
  14            distribution).
  15
  16         1) ./configure configures LyX according to your system. You
  17            may have to set --with-qt-dir=<path-to-your-qt-installation>
  18            (for example, "--with-qt-dir=/usr/share/qt5/") if the
  19            environment variable QTDIR is not set and pkg-config is not
  20            available.
  21
  22            See Note below if ./configure script is not present.
  23
  24         2) make
  25            compiles the program.
  26
  27         3) src/lyx
  28            runs the program so you can check it out.
  29
  30         4) make install
  31            will install it. You can use "make install-strip" instead
  32            if you want a smaller binary.
  33
  34
  35 Note for Git checkouts
  36 -----------------------------
  37
  38 If you have checked this out from Git, you need to have:
  39 * automake (supported versions are 1.14--1.16)
  40 * autoconf (supported versions are 2.65--2.69)
  41 Then type "./autogen.sh" to build the needed configuration
  42 files and proceed as stated above/below.
  43
  44 You will also probably need GNU m4 (perhaps installed as gm4).
  45
  46
  47 Requirements
  48 ------------
  49
  50 First of all, you will need a C++11 standard conforming compiler, like gcc (at
  51 least 4.8) or clang.
  52
  53 LyX makes great use of the C++ Standard Template Library (STL).
  54 This means that gcc users will have to install the relevant libstdc++
  55 library to be able to compile this version of LyX.
  56
  57 For full LyX usability we suggest to use Qt 5.6 and higher, or at the
  58 very least Qt 5.4. For compilation you need to compile against at least
  59 Qt 4.8 which has been widely tested, and for Windows we advise at least
  60 Qt 4.8.4. The only special point to make is that you must ensure that
  61 both LyX and the Qt libraries are compiled with the same C++ compiler.
  62
  63 To build LyX with spell checking capabilities included you have to
  64 install at least one of the development packages of the spell checker
  65 libraries. See the RELEASE-NOTES for details.
  66
  67 Users of debian-based distributions are well advised to run
  68 'apt-get build-dep lyx' before compiling to install proper dependencies.
  69
  70
  71 * Other things to note
  72
  73 If you make modifications to the source that affect any of the
  74 translations or you change the translation files themselves (po/*.po)
  75 files, you will need to have the GNU gettext package installed to
  76 compile LyX with up-to-date translations (at least gettext version
  77 0.16.1 is needed). You can get the latest version from:
  78         ftp://ftp.gnu.org/gnu/gettext/
  79
  80 The two following programs should be available at configuration time:
  81
  82   o Python 2.7 must be installed. Python is used for many simple tasks
  83     that are executed by external scripts, such as the automatic
  84     configuration step and the import of older LyX documents with the
  85     lyx2lyx script (this script is called automatically when opening a
  86     file). Python 3 (3.3 or later) support is work in progress.
  87
  88
  89 Creating the Makefile
  90 ---------------------
  91
  92 LyX can be configured using GNU autoconf utility which attempts to guess
  93 the configuration needed to suit your system.  The standard way to use it
  94 is described in the file INSTALL.autoconf.  In most cases you will be able
  95 to create the Makefile by typing
  96
  97   ./configure
  98
  99 For more complicated cases, LyX configure honors the following specific
 100 flags:
 101
 102   o --enable-build-type=[rel(ease), pre(release), dev(elopment), prof(iling), gprof]
 103     allows to tweak the compiled code. The following table describes
 104     the settings in terms of various options that are described later
 105
 106                       release   prerelease  development profiling gprof
 107     optimization        -O2         -O2         -O         -O2     -O2
 108     assertions                       X           X
 109     stdlib-debug                                 X
 110     warnings                         X           X
 111     debug                            X           X           X       X
 112
 113     The defaults are as follows in terms of version number
 114     release: stable release (2.x.y)
 115     prerelease: version number contains alpha, beta, rc or pre.
 116     development: version number contains dev.
 117
 118     The `profiling' build type uses the -fno-omit-frame-pointer option with gcc
 119
 120     The `gprof' build type compiles and links with -pg option with gcc.
 121
 122 o --disable-qt5 that forces configuration with Qt 4.x when Qt 5.x is
 123     also available. By default Qt5 is tried first, and then Qt4.
 124
 125 o --with-extra-lib=DIRECTORY that specifies the path where LyX will
 126     find extra libraries (like Qt) it needs. Defaults to NONE
 127     (i.e. search in standard places). You can specify several
 128     directories, separated by colons.
 129
 130   o --with-extra-inc=DIRECTORY that gives the place where LyX will find
 131     extra headers.  Defaults to NONE (i.e.  search in standard places).
 132     You can specify several directories, separated by colons.
 133
 134   o --with-extra-prefix[=DIRECTORY] that is equivalent to
 135        --with-extra-lib=DIRECTORY/lib --with-extra-inc=DIRECTORY/include
 136     If DIRECTORY is not specified, the current prefix is used.
 137
 138   o --with-version-suffix[=SUFFIX] will install LyX as lyxSUFFIX. The
 139     LyX data directory will be something like <whatever>/lyxSUFFIX/.
 140     Additionally your user configuration files will be found in e.g.
 141     $HOME/.lyxSUFFIX. The default for SUFFIX is "-<currentversion>",
 142     e.g. lyx-1.6.1.
 143
 144     You can use this feature to install more than one version of LyX
 145     on the same system. You can optionally specify a "version" of your
 146     own, by doing something like :
 147        ./configure --with-version-suffix=-latestdev
 148
 149     Note that the standard configure options --program-prefix,
 150     --program-suffix and the others will not affect the shared LyX
 151     directory etc. so it is recommended that you use --with-version-suffix
 152     (or --prefix) instead.
 153
 154 There are also flags to control the internationalization support in
 155 LyX:
 156
 157   o --disable-nls suppresses all internationalization support,
 158     yielding somewhat smaller code.
 159
 160   o You can also set the environment variable LINGUAS to a list of
 161     languages in case you do not want to install all the translation
 162     files. For example, if you are only interested in German and
 163     Finnish, you can type (with sh or bash)
 164         export LINGUAS='de fi'
 165     before running configure.
 166
 167 Moreover, the following generic configure flags may be useful:
 168
 169   o --prefix=DIRECTORY specifies the root directory to use for
 170     installation. [defaults to /usr/local]
 171
 172   o --datadir=DIRECTORY gives the directory where all extra LyX
 173     files (documentation, templates and layout definitions)
 174     will be installed.
 175     [defaults to ${prefix}/share/lyx${program_suffix}]
 176
 177   o --bindir=DIRECTORY gives the directory where the lyx binary
 178     will be installed. [defaults to ${prefix}/bin]
 179
 180   o --mandir=DIRECTORY gives the directory where the man pages will go.
 181     [defaults to ${prefix}/man]
 182
 183   o --enable-maintainer-mode enables some code that automatically
 184     rebuilds the configure script, makefiles templates and other useful
 185     files when needed. This is off by default on releases, to avoid
 186     surprises.
 187
 188 Note that the --with-extra-* commands are not really robust when it
 189 comes to using relative paths.  If you really want to use a relative path
 190 here, you can prepend it with "`pwd`/".
 191
 192 If you do not like the default compile flags used (-g -O2 on gcc), you can
 193 set CXXFLAGS variable to other values as follows:
 194
 195   o CXXFLAGS='-O2' (sh, bash)
 196   o setenv CXXFLAGS '-O2' (csh, tcsh)
 197
 198 Similarly, if you want to force the use of a specific compiler, you can
 199 give a value to the CXX variable.
 200
 201 The following options allow you to tweak the generated code more
 202 precisely (see the description of --enable-build-type for the default
 203 values):
 204
 205   o --enable-optimization=VALUE enables you to set optimization to a
 206     higher level than the default, for example --enable-optimization=-O3.
 207
 208   o --disable-optimization - you can use this to disable compiler
 209     optimization of LyX. The compile may be much quicker with some
 210     compilers, but LyX will run more slowly.
 211
 212   o --disable-std-regex forces the compiler to use boost::regex. The
 213     default is to use std::regex for known good C++ libraries, but the
 214     test is not robust for clang. --enable-std-regex will force the
 215     use of std::regex.
 216
 217   o --enable-debug will add debug information to your binary. This
 218     requires a lot more disk space, but is a must if you want to try
 219     to debug problems in LyX. There is no run-time penalty.
 220
 221   o --enable-warnings that make the compiler output more warnings during
 222     the compilation of LyX.  Opposite is --disable-warnings.
 223
 224   o --enable-assertions that make the compiler generate run-time
 225     code which checks that some variables have sane values. Opposite
 226     is --disable-assertions.
 227
 228   o --enable-stdlib-debug adds some debug code in the standard
 229     library; this slows down the code, but has been helpful in the
 230     past to find bugs. Note that this is in general incompatible with
 231     the system boost library (which is used when
 232     --without-included-boost is specified). You may have to use
 233     --disable-stdlib-debug when linking development versions against
 234     your system's boost library.
 235     The same problem applies to hunspell (as of hunspell 1.5). So either
 236     compile --with-included-hunspell or --disable-stdlib-debug when
 237     linking development versions against your system's hunspell library.
 238
 239
 240
 241 Compiling and installing LyX
 242 ----------------------------
 243
 244 Once you've got the Makefile created, you just have to type:
 245
 246   make all
 247   make install
 248
 249 All should be OK ;)
 250
 251 Since the binaries with debug information tend to be huge (although
 252 this does not affect the run-time memory footprint), you might want
 253 to strip the lyx binary. In this case replace "make install" with
 254
 255   make install-strip
 256
 257 BTW: in the lib/images subdirectory there is also small icons
 258 `lyx.png' and `lyx.svg', that can be used to display LyX documents in
 259 filemanagers.
 260
 261 If configure fails for some strange reason
 262 ------------------------------------------
 263
 264 Even when configure fails, it creates a Makefile.  You can always check
 265 the contents of this file, modify it and run 'make'.
 266
 267 Compiling For Multiple Architectures
 268 ------------------------------------
 269
 270 You can compile LyX for more than one kind of computer at the same
 271 time, by placing the object files for each architecture in their own
 272 directory.  To do this, you must use a version of `make' that supports
 273 the `VPATH' variable, such as GNU `make'.  `cd' to the directory where
 274 you want the object files and executables to go and run the
 275 `configure' script.  `configure' automatically checks for the source
 276 code in the directory that `configure' is in and in `..'.
 277
 278 If you have to use a `make' that does not support the `VPATH'
 279 variable, you have to compile LyX for one architecture at a time in
 280 the source code directory.  After you have installed LyX for one
 281 architecture, use `make distclean' before reconfiguring for another
 282 architecture.
 283