1 Compiling and installing LyX
2 ============================
4 Quick compilation guide
5 -----------------------
7 These four steps will compile, test and install LyX:
10 configures LyX to your system.
16 runs the program so you can check it out.
19 will install it. You can use "make install-strip" instead
20 if you want a smaller binary.
23 Note for CVS checkouts
24 ----------------------
26 If you have checked this out from CVS, you need to have
27 automake, autoconf, and gettext installed. Then,
28 type "./autogen.sh" to build the needed configuration
29 files and proceed as stated below.
31 You will also probably need GNU m4 (perhaps installed as gm4).
36 First of all, you will also need a recent C++ compiler, where recent
37 means that the compilers are close to C++ standard conforming.
38 Compilers that are known to compile LyX are egcs 1.1.x, gcc 2.95.x and
39 later, and Digital C++ version 6.1 and later. Please tell us your
40 experience with other compilers. It is _not_ possible to compile LyX
41 with gcc 2.7.x and 2.8.x, and this is not likely to change in the
44 Note that, contrary to LyX 1.0.x, LyX 1.2.x makes great use of C++
45 Standard Template Library (STL); this means that gcc users will have
46 to install the relevant libstdc++ library to be able to compile this
49 Both an Xforms and Xpm libraries should be installed to compile LyX.
50 It is imperative that you have the correct versions of these
51 libraries, and their associated header files.
53 As of LyX version 1.2.0, you will need to have Xforms library and
54 header version 0.88 or 0.89. Version 0.89.6 is the one which works
55 best, but the old stable 0.88.1 version is still supported. On some
56 systems, such as linux ELF, there are shared library versions of the
57 Xforms library, which require an installation step to configure the
60 Xforms is available (free) only in binary format, source code is not
61 available. If it is not available for your machine, contact the Xforms
62 developers to request a version for your system. You can get it from
64 http://world.std.com/~xforms/
65 ftp://ncmir.ucsd.edu/pub/xforms/
66 ftp://ftp.lyx.org/pub/xforms/
67 ftp://ftp.fu-berlin.de/unix/X11/gui/xforms
68 ftp://ftp.cs.ruu.nl/pub/XFORMS/
70 If you use a rpm-based linux distribution, such as RedHat or Mandrake,
71 we recommend that you grab a version of xforms from
72 ftp://ftp.lyx.org/pub/lyx/contrib
73 as the rpm packages commonly found are compiled against glibc 2.0
74 instead of 2.[12], and this causes occasional crashes.
76 In addition, you must have libXpm version 4.7 or newer.
78 If you make modifications to files in src/ (for example by applying a
79 patch), you will need to have the GNU gettext package installed, due
80 to some dependencies in the makefiles. You can find the latest version
83 ftp://ftp.gnu.org/gnu/gettext-0.10.xx.tar.gz.
85 LyX contains a hack to work around this, but you should not rely too
88 To use the thesaurus, you will need to install libAikSaurus, available
91 http://aiken.clan11.com/aiksaurus/
93 Finally, the two following programs should be available at
96 o Perl (at least 5.002) is needed for the reLyX script. reLyX will
97 not be installed if perl is not found. If the environment
98 variable PERL is set to point to some program, this value will be
99 used, even if the program does no exist (this can be useful if
100 the machine on which LyX is built is not the one where it will
103 o LaTeX2e should be correctly setup for the user you are logged in
104 as. Otherwise, LyX will not be able to run a number of tests. Note
105 that users can run these tests manually with Edit>Reconfigure.
108 Creating the Makefile
109 ---------------------
111 LyX can be configured using GNU autoconf utility which attempts to guess
112 the configuration needed to suit your system. The standard way to use it
113 is described in the file INSTALL.autoconf. In most cases you will be able
114 to create the Makefile by typing
118 For more complicated cases, LyX configure takes the following specific
121 o --with-extra-lib=DIRECTORY that specifies the path where LyX will find
122 extra libraries (Xpm, xforms) it needs. Defaults to NONE (i.e. search
123 in standard places). You can specify several directories, separated
126 o --with-extra-inc=DIRECTORY that gives the place where LyX will find
127 xforms headers. Defaults to NONE (i.e. search in standard places).
128 You can specify several directories, separated by colons.
130 o --with-extra-prefix[=DIRECTORY] that is equivalent to
131 --with-extra-lib=DIRECTORY/lib --with-extra-inc=DIRECTORY/include
132 If DIRECTORY is not specified, the current prefix is used.
134 o --with-version-suffix will install LyX as lyx-<version>, e.g. lyx-1.2.0
135 The LyX data directory will be something like <whatever>/lyx-1.2.0/.
136 Additionally your user configuration files will be found in e.g.
139 You can use this feature to install more than one version of LyX on
140 the same system. You can optionally specify a "version" of your own,
141 by doing something like : ./configure --with-version-suffix=-latestcvs
143 o --enable-optimization=VALUE enables you to set optimization to a
144 higher level as the default (-O), for example --enable-optimization=-O3.
146 o --disable-optimization - you can use this to disable compiler
147 optimization of LyX. The compile may be much quicker with some
148 compilers, but LyX will run more slowly.
150 There are also flags to control the internationalization support in
153 o --disable-nls suppresses all internationalization support,
154 yielding a somewhat smaller code.
156 o --with-included-gettext forces the use of the included GNU gettext
157 library, although you might have another one installed.
159 o --with-catgets allows to use the catget() functions which can
160 exist on your system. This can cause problems, though. Use with
163 o You can also set the environment variable LINGUAS to a list of
164 language in case ou do not want to install all the translation
165 files. For example, if you are only interested in German and
166 Finnish, you can type (with sh or bash)
167 export LINGUAS='de fi'
168 before running configure.
170 Moreover, the following generic configure flags may be useful:
172 o --prefix=DIRECTORY specifies the root directory to use for
173 installation. [defaults to /usr/local]
175 o --datadir=DIRECTORY gives the directory where all extra LyX
176 files (lyxrc example, documentation, templates and layouts
177 definitions) will be installed.
178 [defaults to ${prefix}/share/lyx${program_suffix}]
180 o --bindir=DIRECTORY gives the directory where the lyx binary
181 will be installed. [defaults to ${prefix}/bin]
183 o --mandir=DIRECTORY gives the directory where the man pages will go.
184 [defaults to ${prefix}/man]
186 Note that the --with-extra-* commands are not really robust when it
187 comes to use of relative paths. If you really want to use a relative path
188 here, you can prepend it with "`pwd`/".
190 If you do not like the default compile flags used (-g -O2 on gcc), you can
191 set CXXFLAGS variable to other values as follows:
193 o CXXFLAGS='-O2' (sh, bash)
194 o setenv CXXFLAGS '-O2' (csh, tcsh)
196 Similarly, if you want to force the use of some specific compiler, you can
197 give a value to the CXX variable.
199 If you encounter problems, please read the section 'Problems' at the end of
202 In particular, the following options could be useful in some
205 o --enable-warnings that make the compiler output more warnings during
206 the compilation of LyX. Opposite is --disable-warnings. By default,
207 this flag is on for development versions only.
209 o --enable-assertions that make the compiler generate run-time
210 code which checks that some variables have sane values. Opposite
211 is --disable-assertions. By default, this flag is on for
212 development versions only.
214 o --with-broken-headers that provides prototypes to replace functions
215 not correctly defined in SunOS4 and SCO header files. Its only effect is
216 to suppress a few warnings. It is autodetected by default.
218 o --without-latex-config that disables the automatic detection of your
219 latex configuration. This detection is automatically disabled if
220 latex cannot be found. If you find that you have to use this
221 flag, please report it as a bug.
223 o --without-liberty suppresses the detection of the -liberty library
224 (see the section `Problems').
227 Compiling and installing LyX
228 ----------------------------
230 Once you've got the Makefile created, you just have to type:
237 Since the binaries with debug information tend to be huge (although
238 this does not affect the run-time memory footprint), you might want
239 to strip the lyx binary. In this case replace "make install" with
243 BTW: in the images subdirectory there is also a small icon "lyx.xpm",
244 that can be used to display lyx-documents in filemanagers.
246 If configure fails for some strange reason
247 ------------------------------------------
249 Even when configure fails, it creates a Makefile. You always can check
250 the contents of this file, modify it and run 'make'.
252 Compiling For Multiple Architectures
253 ------------------------------------
255 You can compile LyX for more than one kind of computer at the same
256 time, by placing the object files for each architecture in their own
257 directory. To do this, you must use a version of `make' that supports
258 the `VPATH' variable, such as GNU `make'. `cd' to the directory where
259 you want the object files and executables to go and run the
260 `configure' script. `configure' automatically checks for the source
261 code in the directory that `configure' is in and in `..'.
263 If you have to use a `make' that does not supports the `VPATH'
264 variable, you have to compile LyX for one architecture at a time in
265 the source code directory. After you have installed LyX for one
266 architecture, use `make distclean' before reconfiguring for another
269 Preparing a binary distribution for the use of others
270 ------------------------------------------------------
272 o Compile LyX with the right compiler switches for your
273 architecture. Make sure you use the --without-latex-config switch
274 of configure, since others might not be interested by your
277 o Create a file README.bin describing your distribution and
278 referring to *you* if problems arise. As a model, you can use the
279 file development/tools/README.bin.example, which can be a good
282 o Type `make bindist'. This will create a file
283 lyx-1.xx.yy-bin.tar.gz. Rename it to reflect you architecture
284 and the peculiarities of your build (e.g. static vs. dynamic).
286 o Check that everything is correct by unpacking the distribution
287 in some private place and running it. In particular, check the
288 output of `ldd lyx' to know which libraries are really needed.
290 o Upload your binary file to ftp.devel.lyx.org:/pub/incoming, and
291 notify larsbj@lyx.org.
297 This section provides several hints that have been submitted by LyX
298 team member or users to help compiling on some particular
299 architectures. If you find that some of this hints are wrong, please
302 o If you have problems indicating that configure cannot find a part of
303 the xforms or Xpm library, use the --with-extra-lib and --with-extra-inc
304 options of configure to specify where these libraries reside.
306 o Configure will seemingly fail to find xpm.h and forms.h on linux
307 if the kernel headers are not available. Two cases are possible:
309 - you have not installed the kernel sources. Then you should
310 install them or at least the kernel-headers package (or
311 whatever it is called in your distribution).
313 - you have the sources, but you did a 'make mrproper' in the
314 kernel directory (this this removes some symbolic links that
315 are needed for compilation). A 'make symlinks' in linux kernel
318 o if you are using RedHat Linux 7.x, you must make sure you have the
319 latest updated gcc and related packages installed (at least -85),
320 or LyX will not compile or will be mis-compiled.
322 o if you get an error message when compiling LyX that looks like this :
324 ../../src/minibuffer.h:17: using directive `Object' introduced
325 ambiguous type `_ObjectRec *'
327 then you need to upgrade the version of the xforms library you have
330 o It is possible to compile lyx with Tru64 Unix cxx compiler
331 version 6.2, provided one uses
332 CXX='cxx -std strict_ansi'
333 CXXFLAGS='-ptr /tmp/lyx_cxx_repository -g'
336 Note that this will not work when compiling directly from the cvs
337 repository, due to the tricks used by automake for dependencies. Ask
338 Jean-Marc.Lasgouttes@inria.fr for a workaround.
340 Or rather, it may well work if you are using automake 1.5 and autoconf 2.5
341 or greater, but you'll have to patch automake's depcomp first. (Depcomp
342 is a little shell script to automagically work out file dependencies
343 and it's broken for automake 1.5 and Tru64 :-(). The patch is to be found
344 in config/depcomp.diff.
345 Angus 22 March, 2002.
347 o On Tru64 Unix, you may have to compile with
348 --with-included-string to work around a Tru64 linker limitation
349 (the STL string template creates names which may be too long). We
350 also had reports that it helps with gcc 2.95.2 on solaris 2.6.
352 Using Tru64 Unix 4.0e, the std::string is fine.
353 Angus 22 March, 2002.
355 o On Tru64 Unix with cxx, you may have a compilation error in
356 lyx_main.C if you have GNU gettext installed. This is due to a bug
357 in gettext. To solve this, you can either (1) configure with
358 --with-included-gettext or (2) add -D__STDC__ to cxx flags.
360 o On Tru64 Unix 4.0e, the STL library routine std::count is broken
361 (/usr/include/cxx/algorithm.cc, line 289 on my machine).
362 It calculates "n" but does not return it! The fix is to add "return n;" to
363 the end of the (4-line long) routine.
364 Angus 22 March, 2002.
366 o On Tru64 Unix 4.0e, compilation of support/lyxsum.C dies horribly. The
367 work-around is to use the old version, 1.18, of this routine. Ask
368 Angus Leeming <leeming@lyx.org> for details.
369 Angus 22 March, 2002.
371 o Some systems lack functions that LyX needs. To fix this, configure
372 tries to link against the -liberty library, if it is available.
373 If you experience problems with missing symbols at link time, you
374 could try to install libiberty.a, which comes with several GNU
375 packages (in particular libg++). In any case, please report your
376 problems to lyx-devel@lists.lyx.org.
378 The option --without-liberty disable the detection of -liberty. It
379 is meant for debugging purpose only.
381 o According to David Sundqvist <David_Sundqvist@vd.volvo.se>, some
382 changes are needed to compile with aCC on HP-UX 10.20. These are the
383 relevant changes in the makefile (with comments tagged on):
385 CXX = /opt/aCC/bin/aCC
386 CXXFLAGS = -O +inst_none # The aCC compiler tries to run instantiations
387 # which currently break.
389 LIBS = -lforms -lXpm -lSM -lICE -lc -lm -lX11 -lCsup # must link with Csup
390 LDFLAGS = -L/opt/aCC/lib # perhaps not needed.