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.
9 Compiling and installing LyX
10 ============================
12 Quick compilation guide
13 -----------------------
15 These four steps will compile, test and install LyX:
18 configures LyX to your system.
24 runs the program so you can check it out.
27 will install it. You can use "make install-strip" instead
28 if you want a smaller binary.
34 You will need to have both an Xforms library and Xpm library to compile
35 LyX. It is imperative that you have the correct versions of these
36 libraries, and their associated header files.
38 As of LyX version 1.1.5, you will need to have Xforms library and header
39 version 0.88 or 0.89. Version 0.88 is a stable release and the
40 recommended version. On some systems, such as linux ELF, there are shared
41 library versions of the Xforms library, which require an installation step
42 to configure the system.
44 Xforms is available (free) only in binary format, source code is not
45 available. If it is not available for your machine, contact the Xforms
46 developers to request a version for your system. You can get it from
48 http://world.std.com/~xforms/
49 ftp://ncmir.ucsd.edu/pub/xforms/
50 ftp://ftp.lyx.org/pub/xforms/
51 ftp://ftp.fu-berlin.de/unix/X11/gui/xforms
52 ftp://ftp.cs.ruu.nl/pub/XFORMS/
54 In addition, you must have libXpm version 4.7 (or newer; 4.8 rumoured
57 libXpm can be found at:
58 http://www.funet.fi/pub/Linux/sunsite/X11/libs/!INDEX.html
59 (or similar locations at other sunsites like sunsite.unc.edu)
61 You will also need a recent C++ compiler, where recent means that the
62 compilers are close to C++ standard conforming. Compilers that are
63 known to compile LyX are gcc 2.8.1 and 2.95.x, the various versions of
64 egcs and Digital C++ version 6.1. Please tell us your experience with
65 other compilers. It is _not_ possible to compile LyX with gcc 2.7.x,
66 and this is not likely to change in the future.
68 Note that, contrary to LyX 1.0.x, LyX 1.1.x makes great use of C++
69 Standard Template Library (STL); this means that gcc users will have
70 to install the relevant libstdc++ library to be able to compile this
73 If you make modifications to files in src/ (for example by applying a
74 patch), you will need to have the GNU gettext package installed, due to
75 some dependencies in the makefiles. You can find the latest (alpha)
78 ftp://alpha.gnu.org/gnu/gettext-0.10.xx.tar.gz.
80 LyX contains a hack to work around this, but you should not rely too
84 Finally, the two following programs should be available at
87 o Perl (at least 5.002) is needed for the reLyX script. reLyX will
88 not be installed if perl is not found. If the environment
89 variable PERL is set to point to some program, this value will be
90 used, even if the program does no exist (this can be useful if
91 the machine on which LyX is built is not the one where it will
94 o LaTeX2e should be correctly setup for the user you are logged
95 as. Otherwise, LyX will not be able to run a number of tests. Note
96 that users can run these tests manually with Option->Configure.
100 ---------------------
102 LyX can be configured using GNU autoconf utility which attempts to guess
103 the configuration needed to suit your system. The standard way to use it
104 is described in the file INSTALL.autoconf. In most cases you will be able
105 to create the Makefile by typing
109 For more complicated cases, LyX configure takes the following specific
112 o --with-extra-lib=DIRECTORY that specifies the path where LyX will find
113 extra libraries (Xpm, xforms) it needs. Defaults to NONE (i.e. search
114 in standard places). You can specify several directories, separated
117 o --with-extra-inc=DIRECTORY that gives the place where LyX will find
118 xforms headers. Defaults to NONE (i.e. search in standard places).
119 You can specify several directories, separated by colons.
121 o --with-extra-prefix[=DIRECTORY] that is equivalent to
122 --with-extra-lib=DIRECTORY/lib --with-extra-inc=DIRECTORY/include
123 If DIRECTORY is not specified, the current prefix is used.
125 o --with-version-suffix will install LyX as lyx-<version>, e.g. lyx-1.2.0
126 The LyX data directory will be something like <whatever>/lyx-1.2.0/.
127 Additionally your user configuration files will be found in e.g.
130 You can use this feature to install more than one version of LyX on
131 the same system. You can optionally specify a "version" of your own,
132 by doing something like : ./configure --with-version-suffix=-latestcvs
134 There are also flags to control the internationalization support in
137 o --disable-nls suppresses all internationalization support,
138 yielding a somewhat smaller code.
140 o --with-included-gettext forces the use of the included GNU gettext
141 library, although you might have another one installed.
143 o --with-catgets allows to use the catget() functions which can
144 exist on your system. This can cause problems, though. Use with
147 o You can also set the environment variable LINGUAS to a list of
148 language in case ou do not want to install all the translation
149 files. For example, if you are only interested in German and
150 Finnish, you can type (with sh or bash)
151 export LINGUAS='de fi'
152 before running configure.
154 Moreover, the following generic configure flags may be useful:
156 o --prefix=DIRECTORY specifies the root directory to use for
157 installation. [defaults to where lyx has already been installed or
160 o --datadir=DIRECTORY gives the directory where all extra LyX
161 files (lyxrc example, documentation, templates and layouts
162 definitions) will be installed.
163 [defaults to ${prefix}/share/lyx${program_suffix}]
165 o --bindir=DIRECTORY gives the directory where the lyx binary
166 will be installed. [defaults to ${prefix}/bin]
168 o --mandir=DIRECTORY gives the directory where the man pages will go.
169 [defaults to ${prefix}/man]
171 Note that the --with-extra-* commands are not really robust when it
172 comes to use of relative paths. If you really want to use a relative path
173 here, you can prepend it with "`pwd`/".
175 If you do not like the default compile flags used (-g -O2 on gcc), you can
176 set CXXFLAGS variable to other values as follows:
178 o CXXFLAGS='-O2' (sh, bash)
179 o setenv CXXFLAGS '-O2' (csh, tcsh)
181 Similarly, if you want to force the use of some specific compiler, you can
182 give a value to the CXX variable.
184 If you encounter problems, please read the section 'Problems' at the end of
187 In particular, the following options could be useful in some
190 o --with-warnings that make the compiler output more warnings during
191 the compilation of LyX. Opposite is --without-warnings. By default,
192 this flag is on for development versions only.
194 o --enable-assertions that make the compilier generater run-time
195 code which checks that some variables have sane values. Opposite
196 is --disable-assertions. By default, this flag is on for
197 development versions only.
199 o --with-broken-headers that provides prototypes to replace functions
200 not correctly defined in SunOS4 and SCO header files. Its only effect is
201 to suppress a few warnings. It is autodetected by default.
203 o --without-latex-config that disables the automatic detection of your
204 latex configuration. This detection is automatically disabled if
205 latex cannot be found. If you find that you have to use this
206 flag, please report it as a bug.
208 o --without-liberty suppresses the detection of the -liberty library
209 (see the section 'Problems').
212 Compiling and installing LyX
213 ----------------------------
215 Once you've got the Makefile created, you just have to type:
222 Since the binaries with debug information tend to be huge (although
223 this does not affect the run-time memory footprint), you maight want
224 to strip the lyx binary. In this case replace "make install" with
228 BTW: in the images subdirectory there is also a small icon "lyx.xpm",
229 that can be used to display lyx-documents in filemanagers.
231 If configure fails for some strange reason
232 ------------------------------------------
234 Even when configure fails, it creates a Makefile. You always can check
235 the contents of this file, modify it and run 'make'.
237 Compiling For Multiple Architectures
238 ------------------------------------
240 You can compile LyX for more than one kind of computer at the same
241 time, by placing the object files for each architecture in their own
242 directory. To do this, you must use a version of `make' that supports
243 the `VPATH' variable, such as GNU `make'. `cd' to the directory where
244 you want the object files and executables to go and run the
245 `configure' script. `configure' automatically checks for the source
246 code in the directory that `configure' is in and in `..'.
248 If you have to use a `make' that does not supports the `VPATH'
249 variable, you have to compile LyX for one architecture at a time in
250 the source code directory. After you have installed LyX for one
251 architecture, use `make distclean' before reconfiguring for another
254 Preparing a binary distribution for the use of others
255 ------------------------------------------------------
257 o Compile LyX with the right compiler switches for your
258 architecture. In particular you might want to ensure that
259 libraries like xforms and xpm are statically linked. To this end,
260 you can use a command like
262 make LYX_LIBS='/foo/libforms.a /bar/libXpm.a'
264 Moreover, make sure you use the --without-latex-config switch
265 of configure, since others might not be interested by your
268 o Create a file README.bin describing your distribution and
269 referring to *you* if problems arise. As a model, you can use the
270 file development/tools/README.bin.example, which can be a good
273 o Type `make bindist'. This will create a file
274 lyx-1.xx.yy-bin.tar.gz. Rename it to reflect you architecture
275 and the peculiarities of your build (e.g. static vs. dynamic).
277 o Check that everything is correct by unpacking the distribution
278 in some private place and running it. In particular, check the
279 output of `ldd lyx' to know which libraries are really needed.
281 o Upload your binary file to ftp.devel.lyx.org:/pub/incoming, and
282 notify larsbj@lyx.org.
288 This section provides several hints that have been submitted by LyX
289 team member or users to help compiling on some particular
290 architectures. If you find that some of this hints are wrong, please
293 o If you have problems indicating that configure cannot find a part of
294 the xforms or Xpm library, use the --with-extra-lib and --with-extra-inc
295 options of configure to specify where these libraries reside.
297 o Configure will seemingly fail to find xpm.h and forms.h on linux
298 if the kernel headers are not available. Two cases are possible:
300 - you have not installed the kernel sources. The you should
301 install them or at least the kernel-headers package (or
302 whatever it is called in your distribution).
304 - you have the sources, but you did a 'make mrproper' in the
305 kernel directory (this this removes some symbolic links that
306 are needed for compilation). A 'make symlinks' in linux kernel
309 o if you get an error message when compiling LyX that looks like this :
311 ../../src/minibuffer.h:17: using directive `Object' introduced
312 ambiguous type `_ObjectRec *'
314 then you need to upgrade the version of the xforms library you have
317 o If you are using RedHat 7.0 and the option --with-frontend=kde, you
318 will need to configure LyX as follows :
320 export QTDIR=/usr/lib/qt-1.45
321 export CC="egcs -L/usr/lib"
322 export CXX="egcs++ -L/usr/lib"
323 ./configure --with-frontend=kde
325 If you your version of gcc-c++ is > 2.96-69, you may not need to do
328 o If you have GNU gettext installed on your system (e.g. on linux),
329 you may get tons of warnings like:
331 bullet_forms.C:101: warning: passing `char *' to argument 1 of
332 `__builtin_constant_p(int)' lacks a cast
334 These are in harmless warnings caused by a bug in libintl.h, but
335 will be solved if you use --with-included-gettext when configuring
338 o It is possible to compile lyx with Tru64 Unix cxx compiler
339 version 6.2, provided one uses
340 CXX='cxx -std strict_ansi'
341 CXXFLAGS='-ptr /tmp/lyx_cxx_repository -g'
344 Note that this will not work when compiling directly from the cvs
345 repository, due to the tricks used by automake for dependencies. Ask
346 Jean-Marc.Lasgouttes@inria.fr for a workaround.
348 o On Tru64 Unix, you may have to compile with
349 --with-included-string to work around a Tru64 linker limitation
350 (the STL string template creates names which may be too long). We
351 also had reports that it helps with gcc 2.95.2 on solaris 2.6.
353 o On Tru64 Unix with cxx, you may have a compilation error in
354 lyx_main.C if you have GNU gettext installed. This is due to a bug
355 in gettext. To solve this, you can either (1) configure with
356 --with-included-gettext or (2) add -D__STDC__ to cxx flags.
358 o According to John Collins <collins@phys.psu.edu>, on SunOS 4.1.3 you may
359 find two sets of X libraries, and they are of course incompatible :-)
360 One is the set provided as part of OpenWindows, and one is the standard
361 X distribution (e.g., X11R5). If you encounter problems (or if, for
362 some obscure reasons configure cannot find your X libraries) you can
363 use the following options:
365 o --x-libraries=DIRECTORY that indicates where the X libraries reside.
367 o --x-includes=DIRECTORY that indicate where the X include files reside.
369 The standard X11R5 libraries should work when the OpenWindows ones
372 o Some systems lack functions that LyX needs. To fix this, configure
373 tries to link against the -liberty library, if it is available.
374 If you experience problems with missing symbols at link time, you
375 could try to install libiberty.a, which comes with several GNU
376 packages (in particular libg++). In any case, please report your
377 problems to lyx-devel@lists.lyx.org.
379 The option --without-liberty disable the detection of -liberty. It
380 is meant for debugging purpose only.
382 o According to David Sundqvist <David_Sundqvist@vd.volvo.se>, some
383 changes are needed to compile with aCC on HP-UX 10.20. These are the
384 relevant changes in the makefile (with comments tagged on):
386 CXX = /opt/aCC/bin/aCC
387 CXXFLAGS = -O +inst_none # The aCC compiler tries to run instantiations
388 # which currently break.
390 LIBS = -lforms -lXpm -lSM -lICE -lc -lm -lX11 -lCsup # must link with Csup
391 LDFLAGS = -L/opt/aCC/lib # perhaps not needed.
394 o On Digital Unix with gcc, you can get warnings like
396 warning, LyXFamilyNames not found in original or external symbol tables, value defaults to 0
398 These concern symbols beginning with an uppercase letter and seems
399 to be harmless. Similarly, the compilation can end with the
403 Warning: Linking some objects which contain exception information sections
404 and some which do not. This may cause fatal runtime exception handling
405 problems (last obj encountered without exceptions was ../intl/libintl.a).
408 You can safely ignore it.