]> git.lyx.org Git - lyx.git/blobdiff - INSTALL
another mini-fix from Kayvan
[lyx.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 36e5ae3ef6c71934ef4b138a9fbce185fe0af6ef..88ccbebf78672dce7dd481fad46b244cbb20ecc8 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -24,7 +24,8 @@ These four steps will compile, test and install LyX:
           runs the program so you can check it out.
 
        4) make install
-          will install it.
+          will install it. You can use "make install-strip" instead
+           if you want a smaller binary. 
 
 
 Requirements
@@ -34,18 +35,19 @@ You will need to have both an Xforms library and Xpm library to compile
 LyX.  It is imperative that you have the correct versions of these 
 libraries, and their associated header files.
 
-As of LyX version 1.1.1, you will need to have Xforms library and header
-version 0.81, 0.86, or 0.88.  Version 0.88 is a stable release and the
-recommended version.  On some systems, such as linux ELF, there are shared 
-library versions of the Xforms library, which require an installation step 
-to configure the system.
+As of LyX version 1.1.5, you will need to have Xforms library and
+header version 0.88 or 0.89.  Version 0.88 is a stable release and the
+recommended version, but 0.89.6 seems to be work very well too.  On
+some systems, such as linux ELF, there are shared library versions of
+the Xforms library, which require an installation step to configure
+the system.
 
 Xforms is available (free) only in binary format, source code is not
 available.  If it is not available for your machine, contact the Xforms
 developers to request a version for your system.  You can get it from
 
-    http://bragg.phys.uwm.edu/xforms
-    ftp://bragg.phys.uwm.edu/pub/xforms/
+    http://world.std.com/~xforms/
+    ftp://ncmir.ucsd.edu/pub/xforms/
     ftp://ftp.lyx.org/pub/xforms/
     ftp://ftp.fu-berlin.de/unix/X11/gui/xforms
     ftp://ftp.cs.ruu.nl/pub/XFORMS/
@@ -53,22 +55,35 @@ developers to request a version for your system.  You can get it from
 In addition, you must have libXpm version 4.7 (or newer; 4.8 rumoured
 to work).
 
+To use the thesaurus, you will need to install libAikSaurus, available
+from :
+
+    http://aiken.clan11.com/aiksaurus/ 
+You will also probably need GNU m4 (perhaps installed as gm4).
 libXpm can be found at:
            http://www.funet.fi/pub/Linux/sunsite/X11/libs/!INDEX.html
            (or similar locations at other sunsites like sunsite.unc.edu)
 
 You will also need a recent C++ compiler, where recent means that the
-compilers knows a bit about the C++ standard. Compilers that are known
-to compile LyX are gcc 2.8.1 and 2.95.x, the various versions of egcs
-and Digital C++ version 6.1. Please tell us your experience with other
-compilers. 
+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.
+
+Note that, contrary to LyX 1.0.x, LyX 1.1.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.
 
-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 find the latest (alpha) 
-version from:
+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 find the latest version
+from:
 
-    ftp://alpha.gnu.org/gnu/gettext-0.10.xx.tar.gz.
+    ftp://ftp.gnu.org/gnu/gettext-0.10.xx.tar.gz.
 
 LyX contains a hack to work around this, but you should not rely too
 much on it.
@@ -113,12 +128,24 @@ flags:
 
   o --with-extra-prefix[=DIRECTORY] that is equivalent to
        --with-extra-lib=DIRECTORY/lib --with-extra-inc=DIRECTORY/include
-   If DIRECTORY is not specified, the current prefix is used.
+    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/.
+    Additionally your user configuration files will be found in e.g.
+    $HOME/.lyx-1.2.0
 
-  o --with-two-colors=[yes|no] that forces LyX to use two colors pixmaps
-    (bitmaps) instead of the full-colored standard ones.  Defaults to no.
+    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
 
+  o --enable-optimization=VALUE enables you to set optimization to a
+    higher level as the default (-O), for example --enable-optimization=-O3.
 
+  o --disable-optimization - you can use this to disable compiler
+    optimization of LyX. The compile may be much quicker with some
+    compilers, but LyX will run more slowly. 
 There are also flags to control the internationalization support in
 LyX:
 
@@ -142,12 +169,7 @@ LyX:
 Moreover, the following generic configure flags may be useful:
 
   o --prefix=DIRECTORY specifies the root directory to use for
-    installation. [defaults to where lyx has already been installed or
-    /usr/local]
-
-  o --program-suffix=STRING sets the name of the installed LyX binary and 
-      of the LyX library directory to lyxSTRING. This may be used to
-      compile lyx as lyx-1.0.0 and avoid clashes with earlier/later versions.
+    installation. [defaults to /usr/local]
 
   o --datadir=DIRECTORY gives the directory where all extra LyX 
     files (lyxrc example, documentation, templates and layouts
@@ -179,27 +201,23 @@ this file.
 In particular, the following options could be useful in some
 desperate cases:
 
-  o --with-debug that specifies whether you want to have debug information
-    by default on standard error.  Default is no. 
-
-  o --with-warnings that make the compiler output more warnings during
-    the compilation of LyX.  Opposite is --without-warnings.  By default,
+  o --enable-warnings that make the compiler output more warnings during
+    the compilation of LyX.  Opposite is --disable-warnings.  By default,
     this flag is on for development versions only.
 
+  o --enable-assertions that make the compilier generater run-time
+    code which checks that some variables have sane values. Opposite
+    is --disable-assertions.  By default, this flag is on for
+    development versions only. 
+
   o --with-broken-headers that provides prototypes to replace functions
     not correctly defined in SunOS4 and SCO header files.  Its only effect is
     to suppress a few warnings.  It is autodetected by default.
 
   o --without-latex-config that disables the automatic detection of your
-    latex.  This detection is automatically disabled if latex cannot be found. 
-    If you find that you have to use this flag, please report it as a bug.
-
-  o --with-broken-const attempts to fix a bug in gcc 2.7.[012] (see the
-    section 'Problems').
-
-  o ---with-gcc-hack which provide a wrapper around gcc that tries to
-    compile without optimization after a compilation failed (see the
-    section 'Problems').
+    latex configuration.  This detection is automatically disabled if
+    latex cannot be found.  If you find that you have to use this
+    flag, please report it as a bug. 
 
   o --without-liberty suppresses the detection of the -liberty library
     (see the section 'Problems').
@@ -215,6 +233,12 @@ Once you've got the Makefile created, you just have to type:
 
 All should be OK ;)
 
+Since the binaries with debug information tend to be huge (although
+this does not affect the run-time memory footprint), you maight want
+to strip the lyx binary. In this case replace "make install" with
+
+  make install-strip
+
 BTW: in the images subdirectory there is also a small icon "lyx.xpm",
 that can be used to display lyx-documents in filemanagers.
 
@@ -241,17 +265,35 @@ the source code directory.  After you have installed LyX for one
 architecture, use `make distclean' before reconfiguring for another
 architecture.
 
-Stripping LyX
--------------
+Preparing a binary distribution for the use of others
+------------------------------------------------------
 
-A LyX binary for linux is about 1M when compiled without debug-information 
-and with dynamic libraries.  If yours is much bigger you probably compiled 
-it with debug-informations (-g).  If you don't want to debug LyX just enter
+  o Compile LyX with the right compiler switches for your
+    architecture. In particular you might want to ensure that
+    libraries like xforms and xpm are statically linked. To this end,
+    you can use a command like
 
-          strip src/lyx
+                make LYX_LIBS='/foo/libforms.a /bar/libXpm.a'
 
-before installing.  Note that this is done automatically for public
-versions.
+    Moreover, make sure you use the --without-latex-config switch
+    of configure, since others might not be interested by your
+   configuration :-) 
+
+  o Create a file README.bin describing your distribution and
+    referring to *you* if problems arise. As a model, you can use the 
+    file development/tools/README.bin.example, which can be a good
+    starting point. 
+
+  o Type `make bindist'. This will create a file
+    lyx-1.xx.yy-bin.tar.gz. Rename it to reflect you architecture 
+    and the peculiarities of your build (e.g. static vs. dynamic).
+
+  o Check that everything is correct by unpacking the distribution 
+    in some private place and running it. In particular, check the 
+    output of `ldd lyx' to know which libraries are really needed.
+
+  o Upload your binary file to ftp.devel.lyx.org:/pub/incoming, and
+    notify larsbj@lyx.org.  
 
 
 Problems
@@ -266,42 +308,50 @@ notify us.
     the xforms or Xpm library, use the --with-extra-lib and --with-extra-inc 
     options of configure to specify where these libraries reside.  
 
-  o Configure will seemingly fail to find xpm.h and forms.h on linux if
-    you did a 'make mrproper' in the kernel directory, because this
-    removes some symbolic links that are needed for compilation. A 'make
-    symlinks' in linux kernel sources fixes that.
+  o Configure will seemingly fail to find xpm.h and forms.h on linux
+    if the kernel headers are not available. Two cases are possible: 
+
+      - you have not installed the kernel sources. Then you should
+        install them or at least the kernel-headers package (or
+        whatever it is called in your distribution).
 
-  o If you have GNU gettext installed on your system (e.g. on linux),
-    you will get tons of warnings like:
+      - you have the sources, but you did a 'make mrproper' in the
+       kernel directory (this  this removes some symbolic links that
+       are needed for compilation). A 'make symlinks' in linux kernel
+       sources fixes that. 
 
-    bullet_forms.C:101: warning: passing `char *' to argument 1 of
-    `__builtin_constant_p(int)' lacks a cast
+  o if you are using RedHat Linux 7.x, you must make sure you have the
+    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 :
 
-    These are in harmless warnings caused by a bug in libintl.h, but
-    will be solved if you use --with-included-gettext when configuring
-    LyX.
+    ../../src/minibuffer.h:17: using directive `Object' introduced
+    ambiguous type `_ObjectRec *'
 
-  o It is possible to compile lyx with Digital Unix cxx compiler
-    version 6.1 (and presumably compaq C++ 6.2 on both Tru64 unix and
-    linux/alpha, when this will be available), provided one uses
-       CXX=cxx
-       CXXFLAGS='-ptr /tmp/lyx_cxx_repository -std strict_ansi -g -O'
+    then you need to upgrade the version of the xforms library you have
+    installed.
+
+  o It is possible to compile lyx with Tru64 Unix cxx compiler
+    version 6.2, provided one uses
+       CXX='cxx -std strict_ansi'
+       CXXFLAGS='-ptr /tmp/lyx_cxx_repository -g'
+       CC=cc
 
     Note that this will not work when compiling directly from the cvs
     repository, due to the tricks used by automake for dependencies. Ask
     Jean-Marc.Lasgouttes@inria.fr for a workaround.
 
-  o On Digital Unix with cxx, you may have a compilation error in
+  o On Tru64 Unix, you may have to compile with
+    --with-included-string to work around a Tru64 linker limitation
+    (the STL string template creates names which may be too long). We
+    also had reports that it helps with gcc 2.95.2 on solaris 2.6. 
+
+  o On Tru64 Unix with cxx, you may have a compilation error in
     lyx_main.C if you have GNU gettext installed. This is due to a bug
     in gettext. To solve this, you can either (1) configure with
     --with-included-gettext or (2) add -D__STDC__ to cxx flags.
 
-  o The configure script seems to hang while it is checking the LaTeX setup.
-    We think that this is not a real problem, but rather a symptom of the 
-    fact that the ec-fonts are being rendered.  This process can take quite 
-    some time, so the remedy is simply to have patience. (The fonts need to 
-    be rendered at some point to be usable anyways.)
-
   o According to John Collins <collins@phys.psu.edu>, on SunOS 4.1.3 you may 
     find two sets of X libraries, and they are of course incompatible :-)
     One is the set provided as part of OpenWindows, and one is the standard
@@ -326,16 +376,6 @@ notify us.
     The option --without-liberty disable the detection of -liberty.  It
     is meant for debugging purpose only.
 
-  o There are several known bugs in gcc 2.7.xx that cause compiler
-    errors.  This is in particular the case in spellchecker.C under
-    HP-UX 9.05 (ask Bernhard Iselborn <biselbor@rhrk.uni-kl.de> for
-    more comments) and in lyxrc.C under Linux/Alpha or DEC OSF/1.  In
-    both cases, the solution is to recompile the offending file
-    without optimization and resume the compilation process with
-    'make'.  To make things simpler, you can use the option
-    --with-gcc-hack of configure that will do that for you
-    automatically.  
-
   o According to David Sundqvist <David_Sundqvist@vd.volvo.se>, some
     changes are needed to compile with aCC on HP-UX 10.20. These are the
     relevant changes in the makefile (with comments tagged on):  
@@ -347,40 +387,10 @@ notify us.
     LIBS = -lforms -lXpm  -lSM -lICE -lc -lm -lX11 -lCsup # must link with Csup
     LDFLAGS = -L/opt/aCC/lib # perhaps not needed. 
 
-  o There is a bug in gcc 2.7.[012] in the handling of const which can
-    cause various unpredictable problems.  If you experience weird
-    crashes with a LyX compiled by gcc 2.7.[012], try to configure
-    with the --with-broken-const flag and recompile.  If this improves
-    things, please report it to the mailing list.  Note that this 
-    compiler bug is fixed in gcc 2.7.2.1 and in several Linux 
-    distributions of gcc 2.7.[012].
-
-    This bug is currently not autodetected, but any code to do so
-    would be welcome.  A patch for gcc 2.7.2 is as follows:
-
-*** clean-ss-951203/expr.c      Sun Nov 26 08:18:07 1995
---- ss-951203/expr.c    Mon Dec  4 11:41:18 1995
-*************** expand_expr (exp, target, tmode, modifie
-*** 4582,4587 ****
-           through a pointer to const does not mean that the value there can
-           never change.  Languages where it can never change should
-           also set TREE_STATIC.  */
-!       RTX_UNCHANGING_P (temp) = TREE_READONLY (exp) | TREE_STATIC (exp);
-        return temp;
-        }
---- 4582,4588 ----
-           through a pointer to const does not mean that the value there can
-           never change.  Languages where it can never change should
-           also set TREE_STATIC.  */
-!       RTX_UNCHANGING_P (temp) = TREE_READONLY (exp) & TREE_STATIC (exp);
-        return temp;
-        }
-
 
   o On Digital Unix with gcc, you can get warnings like
 
 warning, LyXFamilyNames not found in original or external symbol tables, value defaults to 0
-warning, LyXSeriesNames not found in original or external symbol tables, value de
 
     These concern symbols beginning with an uppercase letter and seems
     to be harmless. Similarly, the compilation can end with the