INSTALL

   1 Note for CVS checkouts
   2 ----------------------
   3
   4 If you have checked this out from CVS, you need to have
   5 automake, autoconf, and gettext installed.  Then,
   6 type "./autogen.sh" to build the needed configuration
   7 files and proceed as stated below.
   8
   9 Compiling and installing LyX
  10 ============================
  11
  12 Quick compilation guide
  13 -----------------------
  14
  15 These four steps will compile, test and install LyX:
  16
  17         1) ./configure
  18            configures LyX to your system.
  19
  20         2) make
  21            compiles the program.
  22
  23         3) src/lyx
  24            runs the program so you can check it out.
  25
  26         4) make install
  27            will install it.
  28
  29
  30 Requirements
  31 ------------
  32
  33 You will need to have both an Xforms library and Xpm library to compile
  34 LyX.  It is imperative that you have the correct versions of these
  35 libraries, and their associated header files.
  36
  37 As of LyX version 1.1.1, you will need to have Xforms library and header
  38 version 0.81, 0.86, or 0.88.  Version 0.88 is a stable release and the
  39 recommended version.  On some systems, such as linux ELF, there are shared
  40 library versions of the Xforms library, which require an installation step
  41 to configure the system.
  42
  43 Xforms is available (free) only in binary format, source code is not
  44 available.  If it is not available for your machine, contact the Xforms
  45 developers to request a version for your system.  You can get it from
  46
  47     http://bragg.phys.uwm.edu/xforms
  48     ftp://bragg.phys.uwm.edu/pub/xforms/
  49     ftp://ftp.lyx.org/pub/xforms/
  50     ftp://ftp.fu-berlin.de/unix/X11/gui/xforms
  51     ftp://ftp.cs.ruu.nl/pub/XFORMS/
  52
  53 In addition, you must have libXpm version 4.7 (or newer; 4.8 rumoured
  54 to work).
  55
  56 libXpm can be found at:
  57             http://www.funet.fi/pub/Linux/sunsite/X11/libs/!INDEX.html
  58             (or similar locations at other sunsites like sunsite.unc.edu)
  59
  60 You will also need a recent C++ compiler, where recent means that the
  61 compilers knows a bit about the C++ standard. Compilers that are known
  62 to compile LyX are gcc 2.8.1 and 2.95.x, the various versions of egcs
  63 and Digital C++ version 6.1. Please tell us your experience with other
  64 compilers.
  65
  66 If you make modifications to files in src/ (for example by applying a
  67 patch), you will need to have the GNU gettext package installed, due to
  68 some dependencies in the makefiles. You can find the latest (alpha)
  69 version from:
  70
  71     ftp://alpha.gnu.org/gnu/gettext-0.10.xx.tar.gz.
  72
  73 LyX contains a hack to work around this, but you should not rely too
  74 much on it.
  75
  76
  77 Finally, the two following programs should be available at
  78 configuration time:
  79
  80   o Perl (at least 5.002) is needed for the reLyX script. reLyX will
  81     not be installed if perl is not found.  If the environment
  82     variable PERL is set to point to some program, this value will be
  83     used, even if the program does no exist (this can be useful if
  84     the machine on which LyX is built is not the one where it will
  85     run).
  86
  87   o LaTeX2e should be correctly setup for the user you are logged
  88     as. Otherwise, LyX will not be able to run a number of tests. Note
  89     that users can run these tests manually with Option->Configure.
  90
  91
  92 Creating the Makefile
  93 ---------------------
  94
  95 LyX can be configured using GNU autoconf utility which attempts to guess
  96 the configuration needed to suit your system.  The standard way to use it
  97 is described in the file INSTALL.autoconf.  In most cases you will be able
  98 to create the Makefile by typing
  99
 100   ./configure
 101
 102 For more complicated cases, LyX configure takes the following specific
 103 flags:
 104
 105   o --with-extra-lib=DIRECTORY that specifies the path where LyX will find
 106     extra libraries (Xpm, xforms) it needs.  Defaults to NONE (i.e. search
 107     in standard places).  You can specify several directories, separated
 108     by colons.
 109
 110   o --with-extra-inc=DIRECTORY that gives the place where LyX will find
 111     xforms headers.  Defaults to NONE (i.e.  search in standard places).
 112     You can specify several directories, separated by colons.
 113
 114   o --with-extra-prefix[=DIRECTORY] that is equivalent to
 115        --with-extra-lib=DIRECTORY/lib --with-extra-inc=DIRECTORY/include
 116    If DIRECTORY is not specified, the current prefix is used.
 117
 118   o --with-two-colors=[yes|no] that forces LyX to use two colors pixmaps
 119     (bitmaps) instead of the full-colored standard ones.  Defaults to no.
 120
 121
 122 There are also flags to control the internationalization support in
 123 LyX:
 124
 125   o --disable-nls suppresses all internationalization support,
 126     yielding a somewhat smaller code.
 127
 128   o --with-included-gettext forces the use of the included GNU gettext
 129     library, although you might have another one installed.
 130
 131   o --with-catgets allows to use the catget() functions which can
 132     exist on your system.  This can cause problems, though. Use with
 133     care.
 134
 135   o You can also set the environment variable LINGUAS to a list of
 136     language in case ou do not want to install all the translation
 137     files. For example, if you are only interested in German and
 138     Finnish, you can type (with sh or bash)
 139         export LINGUAS='de fi'
 140     before running configure.
 141
 142 Moreover, the following generic configure flags may be useful:
 143
 144   o --prefix=DIRECTORY specifies the root directory to use for
 145     installation. [defaults to where lyx has already been installed or
 146     /usr/local]
 147
 148   o --program-suffix=STRING sets the name of the installed LyX binary and
 149       of the LyX library directory to lyxSTRING. This may be used to
 150       compile lyx as lyx-1.0.0 and avoid clashes with earlier/later versions.
 151
 152   o --datadir=DIRECTORY gives the directory where all extra LyX
 153     files (lyxrc example, documentation, templates and layouts
 154     definitions) will be installed.
 155     [defaults to ${prefix}/share/lyx${program_suffix}]
 156
 157   o --bindir=DIRECTORY gives the directory where the lyx binary
 158     will be installed. [defaults to ${prefix}/bin]
 159
 160   o --mandir=DIRECTORY gives the directory where the man pages will go.
 161     [defaults to ${prefix}/man]
 162
 163 Note that the --with-extra-* commands are not really robust when it
 164 comes to use of relative paths.  If you really want to use a relative path
 165 here, you can prepend it with "`pwd`/".
 166
 167 If you do not like the default compile flags used (-g -O2 on gcc), you can
 168 set CXXFLAGS variable to other values as follows:
 169
 170   o CXXFLAGS='-O2' (sh, bash)
 171   o setenv CXXFLAGS '-O2' (csh, tcsh)
 172
 173 Similarly, if you want to force the use of some specific compiler, you can
 174 give a value to the CXX variable.
 175
 176 If you encounter problems, please read the section 'Problems' at the end of
 177 this file.
 178
 179 In particular, the following options could be useful in some
 180 desperate cases:
 181
 182   o --with-debug that specifies whether you want to have debug information
 183     by default on standard error.  Default is no.
 184
 185   o --with-warnings that make the compiler output more warnings during
 186     the compilation of LyX.  Opposite is --without-warnings.  By default,
 187     this flag is on for development versions only.
 188
 189   o --with-broken-headers that provides prototypes to replace functions
 190     not correctly defined in SunOS4 and SCO header files.  Its only effect is
 191     to suppress a few warnings.  It is autodetected by default.
 192
 193   o --without-latex-config that disables the automatic detection of your
 194     latex.  This detection is automatically disabled if latex cannot be found.
 195     If you find that you have to use this flag, please report it as a bug.
 196
 197   o --with-broken-const attempts to fix a bug in gcc 2.7.[012] (see the
 198     section 'Problems').
 199
 200   o ---with-gcc-hack which provide a wrapper around gcc that tries to
 201     compile without optimization after a compilation failed (see the
 202     section 'Problems').
 203
 204   o --without-liberty suppresses the detection of the -liberty library
 205     (see the section 'Problems').
 206
 207
 208 Compiling and installing LyX
 209 ----------------------------
 210
 211 Once you've got the Makefile created, you just have to type:
 212
 213   make all
 214   make install
 215
 216 All should be OK ;)
 217
 218 BTW: in the images subdirectory there is also a small icon "lyx.xpm",
 219 that can be used to display lyx-documents in filemanagers.
 220
 221 If configure fails for some strange reason
 222 ------------------------------------------
 223
 224 Even when configure fails, it creates a Makefile.  You always can check
 225 the contents of this file, modify it and run 'make'.
 226
 227 Compiling For Multiple Architectures
 228 ------------------------------------
 229
 230 You can compile LyX for more than one kind of computer at the same
 231 time, by placing the object files for each architecture in their own
 232 directory.  To do this, you must use a version of `make' that supports
 233 the `VPATH' variable, such as GNU `make'.  `cd' to the directory where
 234 you want the object files and executables to go and run the
 235 `configure' script.  `configure' automatically checks for the source
 236 code in the directory that `configure' is in and in `..'.
 237
 238 If you have to use a `make' that does not supports the `VPATH'
 239 variable, you have to compile LyX for one architecture at a time in
 240 the source code directory.  After you have installed LyX for one
 241 architecture, use `make distclean' before reconfiguring for another
 242 architecture.
 243
 244 Stripping LyX
 245 -------------
 246
 247 A LyX binary for linux is about 1M when compiled without debug-information
 248 and with dynamic libraries.  If yours is much bigger you probably compiled
 249 it with debug-informations (-g).  If you don't want to debug LyX just enter
 250
 251           strip src/lyx
 252
 253 before installing.  Note that this is done automatically for public
 254 versions.
 255
 256
 257 Problems
 258 --------
 259
 260 This section provides several hints that have been submitted by LyX
 261 team member or users to help compiling on some particular
 262 architectures. If you find that some of this hints are wrong, please
 263 notify us.
 264
 265   o If you have problems indicating that configure cannot find a part of
 266     the xforms or Xpm library, use the --with-extra-lib and --with-extra-inc
 267     options of configure to specify where these libraries reside.
 268
 269   o Configure will seemingly fail to find xpm.h and forms.h on linux if
 270     you did a 'make mrproper' in the kernel directory, because this
 271     removes some symbolic links that are needed for compilation. A 'make
 272     symlinks' in linux kernel sources fixes that.
 273
 274   o If you have GNU gettext installed on your system (e.g. on linux),
 275     you will get tons of warnings like:
 276
 277     bullet_forms.C:101: warning: passing `char *' to argument 1 of
 278     `__builtin_constant_p(int)' lacks a cast
 279
 280     These are in harmless warnings caused by a bug in libintl.h, but
 281     will be solved if you use --with-included-gettext when configuring
 282     LyX.
 283
 284   o It is possible to compile lyx with Digital Unix cxx compiler
 285     version 6.1 (and presumably compaq C++ 6.2 on both Tru64 unix and
 286     linux/alpha, when this will be available), provided one uses
 287         CXX=cxx
 288         CXXFLAGS='-ptr /tmp/lyx_cxx_repository -std strict_ansi -g -O'
 289
 290     Note that this will not work when compiling directly from the cvs
 291     repository, due to the tricks used by automake for dependencies. Ask
 292     Jean-Marc.Lasgouttes@inria.fr for a workaround.
 293
 294   o On Digital Unix with cxx, you may have a compilation error in
 295     lyx_main.C if you have GNU gettext installed. This is due to a bug
 296     in gettext. To solve this, you can either (1) configure with
 297     --with-included-gettext or (2) add -D__STDC__ to cxx flags.
 298
 299   o The configure script seems to hang while it is checking the LaTeX setup.
 300     We think that this is not a real problem, but rather a symptom of the
 301     fact that the ec-fonts are being rendered.  This process can take quite
 302     some time, so the remedy is simply to have patience. (The fonts need to
 303     be rendered at some point to be usable anyways.)
 304
 305   o According to John Collins <collins@phys.psu.edu>, on SunOS 4.1.3 you may
 306     find two sets of X libraries, and they are of course incompatible :-)
 307     One is the set provided as part of OpenWindows, and one is the standard
 308     X distribution (e.g., X11R5).  If you encounter problems (or if, for
 309     some obscure reasons configure cannot find your X libraries) you can
 310     use the following options:
 311
 312      o --x-libraries=DIRECTORY that indicates where the X libraries reside.
 313
 314      o --x-includes=DIRECTORY that indicate where the X include files reside.
 315
 316     The standard X11R5 libraries should work when the OpenWindows ones
 317     don't.
 318
 319   o Some systems lack functions that LyX needs.  To fix this, configure
 320     tries to link against the -liberty library, if it is available.
 321     If you experience problems with missing symbols at link time, you
 322     could try to install libiberty.a, which comes with several GNU
 323     packages (in particular libg++).  In any case, please report your
 324     problems to lyx-devel@lists.lyx.org.
 325
 326     The option --without-liberty disable the detection of -liberty.  It
 327     is meant for debugging purpose only.
 328
 329   o There are several known bugs in gcc 2.7.xx that cause compiler
 330     errors.  This is in particular the case in spellchecker.C under
 331     HP-UX 9.05 (ask Bernhard Iselborn <biselbor@rhrk.uni-kl.de> for
 332     more comments) and in lyxrc.C under Linux/Alpha or DEC OSF/1.  In
 333     both cases, the solution is to recompile the offending file
 334     without optimization and resume the compilation process with
 335     'make'.  To make things simpler, you can use the option
 336     --with-gcc-hack of configure that will do that for you
 337     automatically.
 338
 339   o According to David Sundqvist <David_Sundqvist@vd.volvo.se>, some
 340     changes are needed to compile with aCC on HP-UX 10.20. These are the
 341     relevant changes in the makefile (with comments tagged on):
 342
 343     CXX = /opt/aCC/bin/aCC
 344     CXXFLAGS = -O +inst_none # The aCC compiler tries to run instantiations
 345                              # which currently break.
 346
 347     LIBS = -lforms -lXpm  -lSM -lICE -lc -lm -lX11 -lCsup # must link with Csup
 348     LDFLAGS = -L/opt/aCC/lib # perhaps not needed.
 349
 350   o There is a bug in gcc 2.7.[012] in the handling of const which can
 351     cause various unpredictable problems.  If you experience weird
 352     crashes with a LyX compiled by gcc 2.7.[012], try to configure
 353     with the --with-broken-const flag and recompile.  If this improves
 354     things, please report it to the mailing list.  Note that this
 355     compiler bug is fixed in gcc 2.7.2.1 and in several Linux
 356     distributions of gcc 2.7.[012].
 357
 358     This bug is currently not autodetected, but any code to do so
 359     would be welcome.  A patch for gcc 2.7.2 is as follows:
 360
 361 *** clean-ss-951203/expr.c      Sun Nov 26 08:18:07 1995
 362 --- ss-951203/expr.c    Mon Dec  4 11:41:18 1995
 363 *************** expand_expr (exp, target, tmode, modifie
 364 *** 4582,4587 ****
 365            through a pointer to const does not mean that the value there can
 366            never change.  Languages where it can never change should
 367            also set TREE_STATIC.  */
 368 !       RTX_UNCHANGING_P (temp) = TREE_READONLY (exp) | TREE_STATIC (exp);
 369         return temp;
 370         }
 371 --- 4582,4588 ----
 372            through a pointer to const does not mean that the value there can
 373            never change.  Languages where it can never change should
 374            also set TREE_STATIC.  */
 375 !       RTX_UNCHANGING_P (temp) = TREE_READONLY (exp) & TREE_STATIC (exp);
 376         return temp;
 377         }
 378
 379
 380   o On Digital Unix with gcc, you can get warnings like
 381
 382 warning, LyXFamilyNames not found in original or external symbol tables, value defaults to 0
 383 warning, LyXSeriesNames not found in original or external symbol tables, value de
 384
 385     These concern symbols beginning with an uppercase letter and seems
 386     to be harmless. Similarly, the compilation can end with the
 387     following warning:
 388
 389 /bin/ld:
 390 Warning: Linking some objects which contain exception information sections
 391         and some which do not. This may cause fatal runtime exception handling
 392         problems (last obj encountered without exceptions was ../intl/libintl.a).
 393
 394
 395     You can safely ignore it.
 396