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
39 header version 0.88 or 0.89. Version 0.88 is a stable release and the
40 recommended version, but 0.89.6 seems to be work very well too. On
41 some systems, such as linux ELF, there are shared library versions of
42 the Xforms library, which require an installation step to configure
45 Xforms is available (free) only in binary format, source code is not
46 available. If it is not available for your machine, contact the Xforms
47 developers to request a version for your system. You can get it from
49 http://world.std.com/~xforms/
50 ftp://ncmir.ucsd.edu/pub/xforms/
51 ftp://ftp.lyx.org/pub/xforms/
52 ftp://ftp.fu-berlin.de/unix/X11/gui/xforms
53 ftp://ftp.cs.ruu.nl/pub/XFORMS/
55 In addition, you must have libXpm version 4.7 (or newer; 4.8 rumoured
58 You will also probably need GNU m4 (perhaps installed as gm4).
60 libXpm can be found at:
61 http://www.funet.fi/pub/Linux/sunsite/X11/libs/!INDEX.html
62 (or similar locations at other sunsites like sunsite.unc.edu)
64 You will also need a recent C++ compiler, where recent means that the
65 compilers are close to C++ standard conforming. Compilers that are
66 known to compile LyX are egcs 1.1.x, gcc 2.95.x and later, and Digital
67 C++ version 6.1 and later. Please tell us your experience with other
68 compilers. It is _not_ possible to compile LyX with gcc 2.7.x and
69 2.8.x, and this is not likely to change in the future.
71 Note that, contrary to LyX 1.0.x, LyX 1.1.x makes great use of C++
72 Standard Template Library (STL); this means that gcc users will have
73 to install the relevant libstdc++ library to be able to compile this
76 If you make modifications to files in src/ (for example by applying a
77 patch), you will need to have the GNU gettext package installed, due
78 to some dependencies in the makefiles. You can find the latest version
81 ftp://ftp.gnu.org/gnu/gettext-0.10.xx.tar.gz.
83 LyX contains a hack to work around this, but you should not rely too
87 Finally, the two following programs should be available at
90 o Perl (at least 5.002) is needed for the reLyX script. reLyX will
91 not be installed if perl is not found. If the environment
92 variable PERL is set to point to some program, this value will be
93 used, even if the program does no exist (this can be useful if
94 the machine on which LyX is built is not the one where it will
97 o LaTeX2e should be correctly setup for the user you are logged
98 as. Otherwise, LyX will not be able to run a number of tests. Note
99 that users can run these tests manually with Option->Configure.
102 Creating the Makefile
103 ---------------------
105 LyX can be configured using GNU autoconf utility which attempts to guess
106 the configuration needed to suit your system. The standard way to use it
107 is described in the file INSTALL.autoconf. In most cases you will be able
108 to create the Makefile by typing
112 For more complicated cases, LyX configure takes the following specific
115 o --with-extra-lib=DIRECTORY that specifies the path where LyX will find
116 extra libraries (Xpm, xforms) it needs. Defaults to NONE (i.e. search
117 in standard places). You can specify several directories, separated
120 o --with-extra-inc=DIRECTORY that gives the place where LyX will find
121 xforms headers. Defaults to NONE (i.e. search in standard places).
122 You can specify several directories, separated by colons.
124 o --with-extra-prefix[=DIRECTORY] that is equivalent to
125 --with-extra-lib=DIRECTORY/lib --with-extra-inc=DIRECTORY/include
126 If DIRECTORY is not specified, the current prefix is used.
128 o --with-version-suffix will install LyX as lyx-<version>, e.g. lyx-1.2.0
129 The LyX data directory will be something like <whatever>/lyx-1.2.0/.
130 Additionally your user configuration files will be found in e.g.
133 You can use this feature to install more than one version of LyX on
134 the same system. You can optionally specify a "version" of your own,
135 by doing something like : ./configure --with-version-suffix=-latestcvs
137 o --enable-optimization=VALUE enables you to set optimization to a
138 higher level as the default (-O), for example --enable-optimization=-O3.
140 o --disable-optimization - you can use this to disable compiler
141 optimization of LyX. The compile may be much quicker with some
142 compilers, but LyX will run more slowly.
144 There are also flags to control the internationalization support in
147 o --disable-nls suppresses all internationalization support,
148 yielding a somewhat smaller code.
150 o --with-included-gettext forces the use of the included GNU gettext
151 library, although you might have another one installed.
153 o --with-catgets allows to use the catget() functions which can
154 exist on your system. This can cause problems, though. Use with
157 o You can also set the environment variable LINGUAS to a list of
158 language in case ou do not want to install all the translation
159 files. For example, if you are only interested in German and
160 Finnish, you can type (with sh or bash)
161 export LINGUAS='de fi'
162 before running configure.
164 Moreover, the following generic configure flags may be useful:
166 o --prefix=DIRECTORY specifies the root directory to use for
167 installation. [defaults to where lyx has already been installed or
170 o --datadir=DIRECTORY gives the directory where all extra LyX
171 files (lyxrc example, documentation, templates and layouts
172 definitions) will be installed.
173 [defaults to ${prefix}/share/lyx${program_suffix}]
175 o --bindir=DIRECTORY gives the directory where the lyx binary
176 will be installed. [defaults to ${prefix}/bin]
178 o --mandir=DIRECTORY gives the directory where the man pages will go.
179 [defaults to ${prefix}/man]
181 Note that the --with-extra-* commands are not really robust when it
182 comes to use of relative paths. If you really want to use a relative path
183 here, you can prepend it with "`pwd`/".
185 If you do not like the default compile flags used (-g -O2 on gcc), you can
186 set CXXFLAGS variable to other values as follows:
188 o CXXFLAGS='-O2' (sh, bash)
189 o setenv CXXFLAGS '-O2' (csh, tcsh)
191 Similarly, if you want to force the use of some specific compiler, you can
192 give a value to the CXX variable.
194 If you encounter problems, please read the section 'Problems' at the end of
197 In particular, the following options could be useful in some
200 o --enable-warnings that make the compiler output more warnings during
201 the compilation of LyX. Opposite is --disable-warnings. By default,
202 this flag is on for development versions only.
204 o --enable-assertions that make the compilier generater run-time
205 code which checks that some variables have sane values. Opposite
206 is --disable-assertions. By default, this flag is on for
207 development versions only.
209 o --with-broken-headers that provides prototypes to replace functions
210 not correctly defined in SunOS4 and SCO header files. Its only effect is
211 to suppress a few warnings. It is autodetected by default.
213 o --without-latex-config that disables the automatic detection of your
214 latex configuration. This detection is automatically disabled if
215 latex cannot be found. If you find that you have to use this
216 flag, please report it as a bug.
218 o --without-liberty suppresses the detection of the -liberty library
219 (see the section 'Problems').
222 Compiling and installing LyX
223 ----------------------------
225 Once you've got the Makefile created, you just have to type:
232 Since the binaries with debug information tend to be huge (although
233 this does not affect the run-time memory footprint), you maight want
234 to strip the lyx binary. In this case replace "make install" with
238 BTW: in the images subdirectory there is also a small icon "lyx.xpm",
239 that can be used to display lyx-documents in filemanagers.
241 If configure fails for some strange reason
242 ------------------------------------------
244 Even when configure fails, it creates a Makefile. You always can check
245 the contents of this file, modify it and run 'make'.
247 Compiling For Multiple Architectures
248 ------------------------------------
250 You can compile LyX for more than one kind of computer at the same
251 time, by placing the object files for each architecture in their own
252 directory. To do this, you must use a version of `make' that supports
253 the `VPATH' variable, such as GNU `make'. `cd' to the directory where
254 you want the object files and executables to go and run the
255 `configure' script. `configure' automatically checks for the source
256 code in the directory that `configure' is in and in `..'.
258 If you have to use a `make' that does not supports the `VPATH'
259 variable, you have to compile LyX for one architecture at a time in
260 the source code directory. After you have installed LyX for one
261 architecture, use `make distclean' before reconfiguring for another
264 Preparing a binary distribution for the use of others
265 ------------------------------------------------------
267 o Compile LyX with the right compiler switches for your
268 architecture. In particular you might want to ensure that
269 libraries like xforms and xpm are statically linked. To this end,
270 you can use a command like
272 make LYX_LIBS='/foo/libforms.a /bar/libXpm.a'
274 Moreover, make sure you use the --without-latex-config switch
275 of configure, since others might not be interested by your
278 o Create a file README.bin describing your distribution and
279 referring to *you* if problems arise. As a model, you can use the
280 file development/tools/README.bin.example, which can be a good
283 o Type `make bindist'. This will create a file
284 lyx-1.xx.yy-bin.tar.gz. Rename it to reflect you architecture
285 and the peculiarities of your build (e.g. static vs. dynamic).
287 o Check that everything is correct by unpacking the distribution
288 in some private place and running it. In particular, check the
289 output of `ldd lyx' to know which libraries are really needed.
291 o Upload your binary file to ftp.devel.lyx.org:/pub/incoming, and
292 notify larsbj@lyx.org.
298 This section provides several hints that have been submitted by LyX
299 team member or users to help compiling on some particular
300 architectures. If you find that some of this hints are wrong, please
303 o If you have problems indicating that configure cannot find a part of
304 the xforms or Xpm library, use the --with-extra-lib and --with-extra-inc
305 options of configure to specify where these libraries reside.
307 o Configure will seemingly fail to find xpm.h and forms.h on linux
308 if the kernel headers are not available. Two cases are possible:
310 - you have not installed the kernel sources. Then you should
311 install them or at least the kernel-headers package (or
312 whatever it is called in your distribution).
314 - you have the sources, but you did a 'make mrproper' in the
315 kernel directory (this this removes some symbolic links that
316 are needed for compilation). A 'make symlinks' in linux kernel
319 o if you are using RedHat Linux 7.x, you must make sure you have the
320 latest updated gcc and related packages installed (at least -85),
321 or LyX will not compile or will be mis-compiled.
323 o if you get an error message when compiling LyX that looks like this :
325 ../../src/minibuffer.h:17: using directive `Object' introduced
326 ambiguous type `_ObjectRec *'
328 then you need to upgrade the version of the xforms library you have
331 o It is possible to compile lyx with Tru64 Unix cxx compiler
332 version 6.2, provided one uses
333 CXX='cxx -std strict_ansi'
334 CXXFLAGS='-ptr /tmp/lyx_cxx_repository -g'
337 Note that this will not work when compiling directly from the cvs
338 repository, due to the tricks used by automake for dependencies. Ask
339 Jean-Marc.Lasgouttes@inria.fr for a workaround.
341 o On Tru64 Unix, you may have to compile with
342 --with-included-string to work around a Tru64 linker limitation
343 (the STL string template creates names which may be too long). We
344 also had reports that it helps with gcc 2.95.2 on solaris 2.6.
346 o On Tru64 Unix with cxx, you may have a compilation error in
347 lyx_main.C if you have GNU gettext installed. This is due to a bug
348 in gettext. To solve this, you can either (1) configure with
349 --with-included-gettext or (2) add -D__STDC__ to cxx flags.
351 o According to John Collins <collins@phys.psu.edu>, on SunOS 4.1.3 you may
352 find two sets of X libraries, and they are of course incompatible :-)
353 One is the set provided as part of OpenWindows, and one is the standard
354 X distribution (e.g., X11R5). If you encounter problems (or if, for
355 some obscure reasons configure cannot find your X libraries) you can
356 use the following options:
358 o --x-libraries=DIRECTORY that indicates where the X libraries reside.
360 o --x-includes=DIRECTORY that indicate where the X include files reside.
362 The standard X11R5 libraries should work when the OpenWindows ones
365 o Some systems lack functions that LyX needs. To fix this, configure
366 tries to link against the -liberty library, if it is available.
367 If you experience problems with missing symbols at link time, you
368 could try to install libiberty.a, which comes with several GNU
369 packages (in particular libg++). In any case, please report your
370 problems to lyx-devel@lists.lyx.org.
372 The option --without-liberty disable the detection of -liberty. It
373 is meant for debugging purpose only.
375 o According to David Sundqvist <David_Sundqvist@vd.volvo.se>, some
376 changes are needed to compile with aCC on HP-UX 10.20. These are the
377 relevant changes in the makefile (with comments tagged on):
379 CXX = /opt/aCC/bin/aCC
380 CXXFLAGS = -O +inst_none # The aCC compiler tries to run instantiations
381 # which currently break.
383 LIBS = -lforms -lXpm -lSM -lICE -lc -lm -lX11 -lCsup # must link with Csup
384 LDFLAGS = -L/opt/aCC/lib # perhaps not needed.
387 o On Digital Unix with gcc, you can get warnings like
389 warning, LyXFamilyNames not found in original or external symbol tables, value defaults to 0
391 These concern symbols beginning with an uppercase letter and seems
392 to be harmless. Similarly, the compilation can end with the
396 Warning: Linking some objects which contain exception information sections
397 and some which do not. This may cause fatal runtime exception handling
398 problems (last obj encountered without exceptions was ../intl/libintl.a).
401 You can safely ignore it.