]> git.lyx.org Git - lyx.git/blobdiff - INSTALL
Fix for bug #11926
[lyx.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index d19159fb6e332431cf2478af04c0faf0d5d136e6..ad3acf1175a59d885e0630306b78e26d6b57cab8 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,5 +1,10 @@
-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
 -----------------------
@@ -47,9 +52,8 @@ You will also probably need GNU m4 (perhaps installed as gm4).
 Requirements
 ------------
 
-First of all, you will need a recent C++ compiler, where recent means
-that the compilers are close to C++11 standard conforming like gcc (at
-least 4.6) or clang.
+First of all, you will need a C++11 standard conforming compiler, like gcc (at
+least 4.8) 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++
@@ -65,6 +69,9 @@ 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
 
@@ -107,20 +114,21 @@ flags:
     stdlib-debug                                 X
     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.
+    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 --disable-qt5 that forces configuration with Qt 4.x when Qt 5.x is
+  o --disable-qt5 that forces configuration with Qt 4.x when Qt 5.x is
     also available. By default Qt5 is tried first, and then Qt4.
 
-o --with-extra-lib=DIRECTORY that specifies the path where LyX will
+  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.
@@ -196,10 +204,9 @@ set CXXFLAGS variable to other values as follows:
 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):
+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.
@@ -208,9 +215,10 @@ The following options allow you to tweak the generated code more precisely (see
     optimization of LyX. The compile may be much quicker with some
     compilers, but LyX will run more slowly.
 
-  o --disable-std-regex forces the compiler to use boost::regex. The default is
-    to use std::regex for known good C++ libraries, but the test is not robust for clang.
-    --enable-std-regex will force the use of std::regex.
+  o --disable-std-regex forces the compiler to use boost::regex. The
+    default is to use std::regex for known good C++ libraries, but the
+    test is not robust for clang. --enable-std-regex will force the
+    use of std::regex.
 
   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
@@ -279,57 +287,3 @@ the source code directory.  After you have installed LyX for one
 architecture, use `make distclean' before reconfiguring for another
 architecture.
 
-Problems
---------
-
-This section provides several hints that have been submitted by LyX
-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, you need gnumake. The LyX makefiles do not
-    work with Solaris make.
-
-    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.
-    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>