Fixed inset-redraw problems on resizing lyx-window, and some other small

[lyx.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 515c9fcc548ef6038500d21194b20d9de26a397a..2a89c4b01a3d5136229e848a1025503384e8c5ee 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
@@ -58,11 +59,11 @@ libXpm can be found at:
            (or similar locations at other sunsites like sunsite.unc.edu)
 
 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 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. It is _not_ possible to compile LyX with gcc
-2.7.x, and this is not likely to change in the future. 
+compilers are close to C++ standard conforming. 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. It is _not_ possible to compile LyX with gcc 2.7.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
@@ -191,7 +192,7 @@ desperate cases:
     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
+    code which checks that some variables have sane values. Opposite
     is --disable-assertions.  By default, this flag is on for
     development versions only. 
 
@@ -218,6 +219,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.
 
@@ -244,17 +251,34 @@ 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
+------------------------------------------------------
+
+  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
+
+                make LYX_LIBS='/foo/libforms.a /bar/libXpm.a'
 
-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
+    Moreover, make sure you use the --without-latex-config switch
+    of configure, since others might not be interested by your
+   configuration :-) 
 
-          strip src/lyx
+  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. 
 
-before installing.  Note that this is done automatically for public
-versions.
+  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.lyx.org:/pub/lyx/uploads.
 
 
 Problems
@@ -329,14 +353,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'.    
-
   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):