]> git.lyx.org Git - lyx.git/blobdiff - INSTALL
fix generation of ERT labels.
[lyx.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 8ecbd562fc49683905a91322f17acaf077bfc586..6e1a2a7f238a14204a5fc956ac394cb6dc0b7dea 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -7,13 +7,13 @@ Quick compilation guide
 These four steps will compile, test and install LyX:
 
        0) Linux users beware: if compiling the Qt frontend, you need
-           qt and qt-devel packages of the same version to compile LyX. 
+           qt and qt-devel packages of the same version to compile LyX.
 
-       1) ./configure
-          configures LyX to your system. By default, LyX configures
-           the xforms frontend, use --with-frontend=qt to build a Qt
-           version. You may have to set 
-           --with-qt-dir=<path-to-your-qt-installation> to succeed.
+       1) ./configure --with-frontend=[qt or xforms]
+          configures LyX according to your system. 
+          When compiling for Qt, you may have to set
+             --with-qt-dir=<path-to-your-qt-installation>
+           if the environment variable QTDIR is not set. 
 
        2) make
           compiles the program.
@@ -29,9 +29,11 @@ These four steps will compile, test and install LyX:
 Note for CVS checkouts
 ----------------------
 
-If you have checked this out from CVS, you need to have
-automake, autoconf, and gettext installed.  Then,
-type "./autogen.sh" to build the needed configuration
+If you have checked this out from CVS, you need to have:
+* automake >= 1.5
+* autoconf >= 2.52
+* gettext >= 0.12
+Then type "./autogen.sh" to build the needed configuration
 files and proceed as stated below.
 
 You will also probably need GNU m4 (perhaps installed as gm4).
@@ -41,16 +43,35 @@ 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 egcs 1.1.x, gcc 2.95.x and
-later, and Digital C++ version 6.1 and later. Please tell us your
-experience with other compilers. It is _not_ possible to compile LyX
-with gcc 2.7.x and 2.8.x, and this is not likely to change in the
-future.
+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.
 
-Note that, contrary to LyX 1.0.x, LyX 1.3.x makes great use of 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.
+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).
+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.
+
+* Qt frontend
+
+LyX has been tested with Qt 3.x, though Qt 2.x may happen to work too.
+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.
+
+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:
+
+       ldd `which lyx` | grep fontconfig
+
+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.
 
 * xforms frontend
 
@@ -63,12 +84,10 @@ This version has been released under the LGPL (Lesser General Public
 License), and the availability of the source means that many bugs that
 have been plaguing LyX have been fixed in xforms. You are advised to
 upgrade to xforms 1.0 to enjoy all these new fixes.
-In fact, LyX 1.3.x no longer supports versions of xforms older than 0.89.5.
+In fact, LyX 1.4.x no longer supports versions of xforms older than 1.0.
 
 You can get the source from
-       http://world.std.com/~xforms/
-       ftp://ncmir.ucsd.edu/pub/xforms/OpenSource/xforms-1.0-release.tgz
-       ftp://ftp.lyx.org/pub/xforms/OpenSource/xforms-1.0-release.tgz
+       http://savannah.nongnu.org/download/xforms/
 
 If you use a rpm-based linux distribution, such as RedHat or Mandrake,
 we recommend that you grab a version of xforms from
@@ -77,38 +96,13 @@ Look for the xforms-1.0-release.src.rpm or the binary libforms*.i386.rpm.
 
 In addition, you must have libXpm version 4.7 or newer.
 
-* Qt frontend
-
-LyX has been tested with both Qt 2.x and 3.x libraries. 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.
-
-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:
-
-       ldd `which lyx` | grep fontconfig
-
-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 the
-/usr/local/share/lyx/xfonts directory (or equivalent) should be added to
-the font path. This is done automatically by LyX if LyX is run on
-the local machine, and the X server supports Postscript fonts. If, however,
-you're running LyX remotely, then you'll have to do this step yourself.
-'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:
-       ftp://ftp.gnu.org/gnu/gettext/gettext-0.11.4.tar.gz
-
-LyX contains a hack to work around this, but you should not rely too
-much on it.
+       ftp://ftp.gnu.org/gnu/gettext/
 
 To use the thesaurus, you will need to install libAikSaurus, available
 from:
@@ -116,20 +110,13 @@ from:
 
 The two following programs should be available at configuration time:
 
-  o Perl (at least 5.002) is needed for the reLyX script. reLyX will
-    not be installed if perl is not found.  If the environment
-    variable PERL is set to point to some program, this value will be
-    used, even if the program does no exist (this can be useful if
-    the machine on which LyX is built is not the one where it will
-    run).
-
   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.
 
-Finally, you will need to have python 1.5.2 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 1.5.2 or newer installed to be able to import older LyX files
+    with the lyx2lyx script (this script is called automatically when
+    opening a file).
 
 
 Creating the Makefile
@@ -169,7 +156,7 @@ flags:
 
     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 : 
+    own, by doing something like :
        ./configure --with-version-suffix=-latestcvs
 
     Note that the standard configure options --program-prefix,
@@ -225,9 +212,10 @@ Moreover, the following generic configure flags may be useful:
   o --mandir=DIRECTORY gives the directory where the man pages will go.
     [defaults to ${prefix}/man]
 
-  o --enable-mainainer-mode enables some code that automatically
+  o --enable-maintainer-mode enables some code that automatically
     rebuilds the configure script, makefiles templates and other useful
-    files when needed. This is off by default, to avoid surprises.
+    files when needed. This is off by default on releases, to avoid
+    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
@@ -358,14 +346,6 @@ notify us.
     latest updated gcc and related packages installed (at least -85),
     or LyX will not compile or will be mis-compiled.
 
-  o if you get an error message when compiling LyX that looks like this :
-
-    ../../src/minibuffer.h:17: using directive `Object' introduced
-    ambiguous type `_ObjectRec *'
-
-    then you need to upgrade the version of the xforms library you have
-    installed.
-
   o On SUN Sparc Solaris 8, you need gnumake. The LyX makefiles do not
     work with Solaris make.