]> git.lyx.org Git - lyx.git/blobdiff - INSTALL
fix format string
[lyx.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 61e7e1f7d4769deddffb6643394a510bac49dad4..2814f29657d890e5ce9322c314426c1c5ae1f300 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -6,8 +6,14 @@ 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. 
+
        1) ./configure
-          configures LyX to your system.
+          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.
 
        2) make
           compiles the program.
@@ -41,7 +47,7 @@ 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.
 
-Note that, contrary to LyX 1.0.x, LyX 1.2.x makes great use of C++
+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.
@@ -57,7 +63,7 @@ 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.0 no longer supports versions of xforms older than 0.89.5.
+In fact, LyX 1.3.x no longer supports versions of xforms older than 0.89.5.
 
 You can get the source from
        http://world.std.com/~xforms/
@@ -78,7 +84,7 @@ 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-ttf-fonts package, tobe found on ftp://ftp.lyx.org/ to get maths
+latex-ttf-fonts package (available on ftp://ftp.lyx.org/) 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
@@ -137,10 +143,14 @@ to create the Makefile by typing
 For more complicated cases, LyX configure takes the following specific
 flags:
 
-  o --with-extra-lib=DIRECTORY that specifies the path where LyX will find
-    extra libraries (Xpm, xforms) it needs.  Defaults to NONE (i.e. search
-    in standard places).  You can specify several directories, separated
-    by colons.
+  o --with-frontend=FRONTEND that allows to specify which frontend you
+    want to use. Default is "xforms", and the other possible value is
+    "qt".
+
+  o --with-extra-lib=DIRECTORY that specifies the path where LyX will
+    find extra libraries (Xpm, xforms, qt) it needs. Defaults to NONE
+    (i.e. search in standard places). You can specify several
+    directories, separated by colons.
 
   o --with-extra-inc=DIRECTORY that gives the place where LyX will find
     xforms headers.  Defaults to NONE (i.e.  search in standard places).
@@ -150,18 +160,20 @@ flags:
        --with-extra-lib=DIRECTORY/lib --with-extra-inc=DIRECTORY/include
     If DIRECTORY is not specified, the current prefix is used.
 
-  o --with-version-suffix will install LyX as lyx-<version>, e.g. lyx-1.2.0
-    The LyX data directory will be something like <whatever>/lyx-1.2.0/.
+  o --with-version-suffix will install LyX as lyx-<version>, e.g. lyx-1.3.1
+    The LyX data directory will be something like <whatever>/lyx-1.3.1/.
     Additionally your user configuration files will be found in e.g.
-    $HOME/.lyx-1.2.0
+    $HOME/.lyx-1.3.1
 
-    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 : ./configure --with-version-suffix=-latestcvs
+    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 : 
+       ./configure --with-version-suffix=-latestcvs
 
-    Note that the standard configure options --program-prefix,--program-suffix
-    and the others will not affect the shared LyX directory etc. so it
-    is recommended that you use --with-version-suffix (or --prefix) instead.
+    Note that the standard configure options --program-prefix,
+    --program-suffix and the others will not affect the shared LyX
+    directory etc. so it is recommended that you use --with-version-suffix
+    (or --prefix) instead.
 
   o --enable-optimization=VALUE enables you to set optimization to a
     higher level as the default (-O), for example --enable-optimization=-O3.
@@ -189,7 +201,7 @@ LyX:
     care.
 
   o You can also set the environment variable LINGUAS to a list of
-    language in case ou do not want to install all the translation
+    language in case you do not want to install all the translation
     files. For example, if you are only interested in German and
     Finnish, you can type (with sh or bash)
         export LINGUAS='de fi'
@@ -211,6 +223,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
+    rebuilds the configure script, makefiles templates and other useful
+    files when needed. This is off by default, 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
 here, you can prepend it with "`pwd`/".