]> git.lyx.org Git - lyx.git/blobdiff - INSTALL.scons
upgrade to latest package.C.in
[lyx.git] / INSTALL.scons
index 8ff95a9f5c2c47229e5e7122b8d2c46d21a317ac..f8d1d7b375f5fd19a80f585f396af3f9706b40c7 100644 (file)
@@ -2,7 +2,7 @@
 Building LyX with SCons
 =========================
 
-June, 2006
+July, 2006
 
 
 The GNU Build System (autoconf, automake and make) has been used to build
@@ -18,8 +18,8 @@ This file is organized as follows:
 2. *nix systems (Linux, Solaris and Mac OSX)
 3. Windows/mingw
 4. Windows/cygwin
-5. windows/msvc
-6. Other versions of lyx (1.4.x)
+5. Windows/msvc
+6. Tips and hints
 7. Troubleshooting
 
 
@@ -79,7 +79,7 @@ Components to use/build:
 
   * frontend=qt3/qt4: qt3 is the default for all *nix systems including
     windows cygwin. qt4 is the default for windows/mingw and windows/
-    msvc. xform and gtk are not currently supported.
+    msvc. gtk is not currently supported.
   * mode=debug/release: lyx will be built under the debug or release
     directory, with different default build options.
   * boost=included/system/auto: whether or not use included boost, system
@@ -115,7 +115,7 @@ Convenience options:
   * rebuild=target1,target2... By default, scons will exam all components
     when you build lyx. You can free scons from some hard work and save
     yourself some time by telling scons to rebuild only specified
-    component(s).
+    component(s). rebuild=no, none, yes or all can be used as well.
   * log_file: a log file of executed commands, default to scons_lyx.log
 
 
@@ -125,6 +125,8 @@ Installation options:
   * exec_dir: directory where lyx binaries will be installed.
     Default to $prefix/bin
   * dest_dir: if specified, install to this directory instead of $prefix.
+  * version_suffix=yes/no/something : if specified, this suffix will be 
+    appended to the user data directory.
 
 
 Compiler choice and flags:
@@ -244,21 +246,25 @@ extra_inc_path etc is needed.
 4. Windows/cygwin
 =================
 
-LyX should be easy to compile, but the qt3 library in the cygwin
-distribution does not work with the current cygwin dll (version 1.5.19-4
-as of June 2006) due to broken threading support. You should either wait
-for the forthcoming 1.5.20 version or install a recent snapshot from
-http://cygwin.com/snapshots.
+LyX should be easy to compile, but you must use the most recent cygwin
+dll (version 1.5.20-1 as of July 2006) because the qt3 library in the
+cygwin distribution does not work with previous versions due to broken
+threading support.
 
 To build lyx for cygwin, you should
 
   * install (using the cygwin setup program) at least the following
     packages and all other packages pulled in by dependencies:
 
-    aspell        grep       libintl1       qt3-bin      tar
-    coreutils     jbigkit    libintl2       qt3-devel    libiconv
-    diffutils     jpeg       libpng         python
-    gettext       libintl    libpng2        sed
+    aspell        gzip       libiconv     qt3-bin
+    aspell-dev    jpeg       libpng       qt3-devel
+    gcc           libintl    libpng2
+    gettext       libintl1   jpeg
+    gettext-devel libintl2   python
+
+  * install aiksaurus (http://aiksaurus.sourceforge.net/, optional):
+    There is no cygwin package for aiksaurus, so you should build it from
+    source. However, aiksaurus builds smoothly on cygwin.
 
   * run scons as you would do under linux.
 
@@ -269,7 +275,6 @@ directories can not be detected automatically, use options, for example,
   qt_dir=/usr/lib/qt3 qt_inc_path=/usr/include/qt3
 
 
-
 5. Windows/msvc
 ===============
 
@@ -287,7 +292,12 @@ To build lyx with msvc, you should
     directories in VCProjectEngine.dll.express.config, as suggested in
     http://msdn.microsoft.com/vstudio/express/visualc/usingpsdk/.
 
-  * build qt4
+  * build qt3 
+    - download qt3 source from Q../Free sourceforge.net website (not from 
+      trolltech).
+    - compile qt3 as instructed
+
+    or qt4
     - download qt4 source from trolltech (not the binary version, which
       only works with mingw)
     - get q../free patch for qt4
@@ -313,19 +323,13 @@ To build lyx with msvc, you should
       - To use the msvc debugger, you have to use mode=debug (default).
 
 
-6. Other versions of lyx (1.4.x)
-================================
-
-The scons build system is not yet distributed with lyx1.4.x. Support for
-the qt2 frontend of lyx1.4.x is, however, added to the trunk (1.5.x). If
-you have checked out both 1.4.x and the trunk, you can build lyx 1.4.x
-using commands similar to
-
-  > cd lyx-1.4.x
-  > scons -f ../lyx-1.5.x/development/scons/SConstruct
+6. Tips and hints
+=================
 
-Note that lyx 1.4.x does not use the latest version of the boost library
-so option boost=included is recommended.
+  * Using external boost libraries (install boost libraries and use
+    option boost=system) can speed up scons' starting time a lot, since
+    the boost headers will then be considered as system headers and will
+    not be included in the dependency tree.
 
 
 7. Troubleshooting