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://world.std.com/~xforms/
  48     ftp://ncmir.ucsd.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. It is probably _not_ possible to compile LyX with gcc
  65 2.7.x, but this may change in the future.
  66
  67 Note that, contrary to LyX 1.0.x, LyX 1.1.x makes great use of C++
  68 Standard Template Library (STL); this means that gcc users will have
  69 to install the relevant libstdc++ library to be able to compile this
  70 version.
  71
  72 If you make modifications to files in src/ (for example by applying a
  73 patch), you will need to have the GNU gettext package installed, due to
  74 some dependencies in the makefiles. You can find the latest (alpha)
  75 version from:
  76
  77     ftp://alpha.gnu.org/gnu/gettext-0.10.xx.tar.gz.
  78
  79 LyX contains a hack to work around this, but you should not rely too
  80 much on it.
  81
  82
  83 Finally, the two following programs should be available at
  84 configuration time:
  85
  86   o Perl (at least 5.002) is needed for the reLyX script. reLyX will
  87     not be installed if perl is not found.  If the environment
  88     variable PERL is set to point to some program, this value will be
  89     used, even if the program does no exist (this can be useful if
  90     the machine on which LyX is built is not the one where it will
  91     run).
  92
  93   o LaTeX2e should be correctly setup for the user you are logged
  94     as. Otherwise, LyX will not be able to run a number of tests. Note
  95     that users can run these tests manually with Option->Configure.
  96
  97
  98 Creating the Makefile
  99 ---------------------
 100
 101 LyX can be configured using GNU autoconf utility which attempts to guess
 102 the configuration needed to suit your system.  The standard way to use it
 103 is described in the file INSTALL.autoconf.  In most cases you will be able
 104 to create the Makefile by typing
 105
 106   ./configure
 107
 108 For more complicated cases, LyX configure takes the following specific
 109 flags:
 110
 111   o --with-extra-lib=DIRECTORY that specifies the path where LyX will find
 112     extra libraries (Xpm, xforms) it needs.  Defaults to NONE (i.e. search
 113     in standard places).  You can specify several directories, separated
 114     by colons.
 115
 116   o --with-extra-inc=DIRECTORY that gives the place where LyX will find
 117     xforms headers.  Defaults to NONE (i.e.  search in standard places).
 118     You can specify several directories, separated by colons.
 119
 120   o --with-extra-prefix[=DIRECTORY] that is equivalent to
 121        --with-extra-lib=DIRECTORY/lib --with-extra-inc=DIRECTORY/include
 122     If DIRECTORY is not specified, the current prefix is used.
 123
 124   o --with-lyxname=STRING sets the name of the installed LyX binary and
 125     of the LyX library directory to STRING. This may be used to
 126     compile lyx as lyx-1.1 and avoid clashes with earlier/later
 127     versions. Default is "lyx".
 128
 129   o --with-two-colors=[yes|no] that forces LyX to use two colors pixmaps
 130     (bitmaps) instead of the full-colored standard ones.  Defaults to no.
 131
 132
 133 There are also flags to control the internationalization support in
 134 LyX:
 135
 136   o --disable-nls suppresses all internationalization support,
 137     yielding a somewhat smaller code.
 138
 139   o --with-included-gettext forces the use of the included GNU gettext
 140     library, although you might have another one installed.
 141
 142   o --with-catgets allows to use the catget() functions which can
 143     exist on your system.  This can cause problems, though. Use with
 144     care.
 145
 146   o You can also set the environment variable LINGUAS to a list of
 147     language in case ou do not want to install all the translation
 148     files. For example, if you are only interested in German and
 149     Finnish, you can type (with sh or bash)
 150         export LINGUAS='de fi'
 151     before running configure.
 152
 153 Moreover, the following generic configure flags may be useful:
 154
 155   o --prefix=DIRECTORY specifies the root directory to use for
 156     installation. [defaults to where lyx has already been installed or
 157     /usr/local]
 158
 159   o --datadir=DIRECTORY gives the directory where all extra LyX
 160     files (lyxrc example, documentation, templates and layouts
 161     definitions) will be installed.
 162     [defaults to ${prefix}/share/lyx${program_suffix}]
 163
 164   o --bindir=DIRECTORY gives the directory where the lyx binary
 165     will be installed. [defaults to ${prefix}/bin]
 166
 167   o --mandir=DIRECTORY gives the directory where the man pages will go.
 168     [defaults to ${prefix}/man]
 169
 170 Note that the --with-extra-* commands are not really robust when it
 171 comes to use of relative paths.  If you really want to use a relative path
 172 here, you can prepend it with "`pwd`/".
 173
 174 If you do not like the default compile flags used (-g -O2 on gcc), you can
 175 set CXXFLAGS variable to other values as follows:
 176
 177   o CXXFLAGS='-O2' (sh, bash)
 178   o setenv CXXFLAGS '-O2' (csh, tcsh)
 179
 180 Similarly, if you want to force the use of some specific compiler, you can
 181 give a value to the CXX variable.
 182
 183 If you encounter problems, please read the section 'Problems' at the end of
 184 this file.
 185
 186 In particular, the following options could be useful in some
 187 desperate cases:
 188
 189   o --with-warnings that make the compiler output more warnings during
 190     the compilation of LyX.  Opposite is --without-warnings.  By default,
 191     this flag is on for development versions only.
 192
 193   o --enable-assertions that make the compilier generater run-time
 194     code which checks that some variables have sane values.  Opposite
 195     is --disable-assertions.  By default, this flag is on for
 196     development versions only.
 197
 198   o --with-broken-headers that provides prototypes to replace functions
 199     not correctly defined in SunOS4 and SCO header files.  Its only effect is
 200     to suppress a few warnings.  It is autodetected by default.
 201
 202   o --without-latex-config that disables the automatic detection of your
 203     latex configuration.  This detection is automatically disabled if
 204     latex cannot be found.  If you find that you have to use this
 205     flag, please report it as a bug.
 206
 207   o --without-liberty suppresses the detection of the -liberty library
 208     (see the section 'Problems').
 209
 210
 211 Compiling and installing LyX
 212 ----------------------------
 213
 214 Once you've got the Makefile created, you just have to type:
 215
 216   make all
 217   make install
 218
 219 All should be OK ;)
 220
 221 BTW: in the images subdirectory there is also a small icon "lyx.xpm",
 222 that can be used to display lyx-documents in filemanagers.
 223
 224 If configure fails for some strange reason
 225 ------------------------------------------
 226
 227 Even when configure fails, it creates a Makefile.  You always can check
 228 the contents of this file, modify it and run 'make'.
 229
 230 Compiling For Multiple Architectures
 231 ------------------------------------
 232
 233 You can compile LyX for more than one kind of computer at the same
 234 time, by placing the object files for each architecture in their own
 235 directory.  To do this, you must use a version of `make' that supports
 236 the `VPATH' variable, such as GNU `make'.  `cd' to the directory where
 237 you want the object files and executables to go and run the
 238 `configure' script.  `configure' automatically checks for the source
 239 code in the directory that `configure' is in and in `..'.
 240
 241 If you have to use a `make' that does not supports the `VPATH'
 242 variable, you have to compile LyX for one architecture at a time in
 243 the source code directory.  After you have installed LyX for one
 244 architecture, use `make distclean' before reconfiguring for another
 245 architecture.
 246
 247 Stripping LyX
 248 -------------
 249
 250 A LyX binary for linux is about 1M when compiled without debug-information
 251 and with dynamic libraries.  If yours is much bigger you probably compiled
 252 it with debug-informations (-g).  If you don't want to debug LyX just enter
 253
 254           strip src/lyx
 255
 256 before installing.  Note that this is done automatically for public
 257 versions.
 258
 259
 260 Problems
 261 --------
 262
 263 This section provides several hints that have been submitted by LyX
 264 team member or users to help compiling on some particular
 265 architectures. If you find that some of this hints are wrong, please
 266 notify us.
 267
 268   o If you have problems indicating that configure cannot find a part of
 269     the xforms or Xpm library, use the --with-extra-lib and --with-extra-inc
 270     options of configure to specify where these libraries reside.
 271
 272   o Configure will seemingly fail to find xpm.h and forms.h on linux if
 273     you did a 'make mrproper' in the kernel directory, because this
 274     removes some symbolic links that are needed for compilation. A 'make
 275     symlinks' in linux kernel sources fixes that.
 276
 277   o If you have GNU gettext installed on your system (e.g. on linux),
 278     you will get tons of warnings like:
 279
 280     bullet_forms.C:101: warning: passing `char *' to argument 1 of
 281     `__builtin_constant_p(int)' lacks a cast
 282
 283     These are in harmless warnings caused by a bug in libintl.h, but
 284     will be solved if you use --with-included-gettext when configuring
 285     LyX.
 286
 287   o It is possible to compile lyx with Digital Unix cxx compiler
 288     version 6.1 (and presumably compaq C++ 6.2 on both Tru64 unix and
 289     linux/alpha, when this will be available), provided one uses
 290         CXX=cxx
 291         CXXFLAGS='-ptr /tmp/lyx_cxx_repository -std strict_ansi -g -O'
 292
 293     Note that this will not work when compiling directly from the cvs
 294     repository, due to the tricks used by automake for dependencies. Ask
 295     Jean-Marc.Lasgouttes@inria.fr for a workaround.
 296
 297   o On Digital Unix with cxx, you may have a compilation error in
 298     lyx_main.C if you have GNU gettext installed. This is due to a bug
 299     in gettext. To solve this, you can either (1) configure with
 300     --with-included-gettext or (2) add -D__STDC__ to cxx flags.
 301
 302   o The configure script seems to hang while it is checking the LaTeX setup.
 303     We think that this is not a real problem, but rather a symptom of the
 304     fact that the ec-fonts are being rendered.  This process can take quite
 305     some time, so the remedy is simply to have patience. (The fonts need to
 306     be rendered at some point to be usable anyways.)
 307
 308   o According to John Collins <collins@phys.psu.edu>, on SunOS 4.1.3 you may
 309     find two sets of X libraries, and they are of course incompatible :-)
 310     One is the set provided as part of OpenWindows, and one is the standard
 311     X distribution (e.g., X11R5).  If you encounter problems (or if, for
 312     some obscure reasons configure cannot find your X libraries) you can
 313     use the following options:
 314
 315      o --x-libraries=DIRECTORY that indicates where the X libraries reside.
 316
 317      o --x-includes=DIRECTORY that indicate where the X include files reside.
 318
 319     The standard X11R5 libraries should work when the OpenWindows ones
 320     don't.
 321
 322   o Some systems lack functions that LyX needs.  To fix this, configure
 323     tries to link against the -liberty library, if it is available.
 324     If you experience problems with missing symbols at link time, you
 325     could try to install libiberty.a, which comes with several GNU
 326     packages (in particular libg++).  In any case, please report your
 327     problems to lyx-devel@lists.lyx.org.
 328
 329     The option --without-liberty disable the detection of -liberty.  It
 330     is meant for debugging purpose only.
 331
 332   o There are several known bugs in gcc 2.7.xx that cause compiler
 333     errors.  This is in particular the case in spellchecker.C under
 334     HP-UX 9.05 (ask Bernhard Iselborn <biselbor@rhrk.uni-kl.de> for
 335     more comments) and in lyxrc.C under Linux/Alpha or DEC OSF/1.  In
 336     both cases, the solution is to recompile the offending file
 337     without optimization and resume the compilation process with
 338     'make'.
 339
 340   o According to David Sundqvist <David_Sundqvist@vd.volvo.se>, some
 341     changes are needed to compile with aCC on HP-UX 10.20. These are the
 342     relevant changes in the makefile (with comments tagged on):
 343
 344     CXX = /opt/aCC/bin/aCC
 345     CXXFLAGS = -O +inst_none # The aCC compiler tries to run instantiations
 346                              # which currently break.
 347
 348     LIBS = -lforms -lXpm  -lSM -lICE -lc -lm -lX11 -lCsup # must link with Csup
 349     LDFLAGS = -L/opt/aCC/lib # perhaps not needed.
 350
 351
 352   o On Digital Unix with gcc, you can get warnings like
 353
 354 warning, LyXFamilyNames not found in original or external symbol tables, value defaults to 0
 355
 356     These concern symbols beginning with an uppercase letter and seems
 357     to be harmless. Similarly, the compilation can end with the
 358     following warning:
 359
 360 /bin/ld:
 361 Warning: Linking some objects which contain exception information sections
 362         and some which do not. This may cause fatal runtime exception handling
 363         problems (last obj encountered without exceptions was ../intl/libintl.a).
 364
 365
 366     You can safely ignore it.
 367