INSTALL

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