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.
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.
37 As of LyX version 1.0.0, 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.
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
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/
53 In addition, you must have libXpm version 4.7 (or newer; 4.8 rumoured
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)
60 If you compile LyX with gcc, you should not need to have libg++ installed
61 on most systems. However, see the note in the section `Problems'.
63 If you make modifications to files in src/ (for example by applying a
64 patch), you will need to have the GNU gettext package installed, due to
65 some dependencies in the makefiles. You can find the latest (alpha)
68 ftp://alpha.gnu.org/gnu/gettext-0.10.xx.tar.gz.
70 LyX contains a hack to work around this, but you should not rely too
74 Finally, the two following programs should be available at
77 o Perl (at least 5.002) is needed for the reLyX script. reLyX will
78 not be installed if perl is not found. If the environment
79 variable PERL is set to point to some program, this value will be
80 used, even if the program does no exist (this can be useful if
81 the machine on which LyX is built is not the one where it will
84 o LaTeX2e should be correctly setup for the user you are logged
85 as. Otherwise, LyX will not be able to run a number of tests. Note
86 that users can run these tests manually with Option->Configure.
92 LyX can be configured using GNU autoconf utility which attempts to guess
93 the configuration needed to suit your system. The standard way to use it
94 is described in the file INSTALL.autoconf. In most cases you will be able
95 to create the Makefile by typing
99 For more complicated cases, LyX configure takes the following specific
102 o --with-extra-lib=DIRECTORY that specifies the path where LyX will find
103 extra libraries (Xpm, xforms) it needs. Defaults to NONE (i.e. search
104 in standard places). You can specify several directories, separated
107 o --with-extra-inc=DIRECTORY that gives the place where LyX will find
108 xforms headers. Defaults to NONE (i.e. search in standard places).
109 You can specify several directories, separated by colons.
111 o --with-extra-prefix[=DIRECTORY] that is equivalent to
112 --with-extra-lib=DIRECTORY/lib --with-extra-inc=DIRECTORY/include
113 If DIRECTORY is not specified, the current prefix is used.
115 o --with-two-colors=[yes|no] that forces LyX to use two colors pixmaps
116 (bitmaps) instead of the full-colored standard ones. Defaults to no.
119 There are also flags to control the internationalization support in
122 o --disable-nls suppresses all internationalization support,
123 yielding a somewhat smaller code.
125 o --with-included-gettext forces the use of the included GNU gettext
126 library, although you might have another one installed.
128 o --with-catgets allows to use the catget() functions which can
129 exist on your system. This can cause problems, though. Use with
132 o You can also set the environment variable LINGUAS to a list of
133 language in case ou do not want to install all the translation
134 files. For example, if you are only interested in German and
135 Finnish, you can type (with sh or bash)
136 export LINGUAS='de fi'
137 before running configure.
139 Moreover, the following generic configure flags may be useful:
141 o --prefix=DIRECTORY specifies the root directory to use for
142 installation. [defaults to where lyx has already been installed or
145 o --program-suffix=STRING sets the name of the installed LyX binary and
146 of the LyX library directory to lyxSTRING. This may be used to
147 compile lyx as lyx-1.0.0 and avoid clashes with earlier/later versions.
149 o --datadir=DIRECTORY gives the directory where all extra LyX
150 files (lyxrc example, documentation, templates and layouts
151 definitions) will be installed.
152 [defaults to ${prefix}/share/lyx${program_suffix}]
154 o --bindir=DIRECTORY gives the directory where the lyx binary
155 will be installed. [defaults to ${prefix}/bin]
157 o --mandir=DIRECTORY gives the directory where the man pages will go.
158 [defaults to ${prefix}/man]
160 Note that the --with-extra-* commands are not really robust when it
161 comes to use of relative paths. If you really want to use a relative path
162 here, you can prepend it with "`pwd`/".
164 If you do not like the default compile flags used (-g -O2 on gcc), you can
165 set CXXFLAGS variable to other values as follows:
167 o CXXFLAGS='-O2' (sh, bash)
168 o setenv CXXFLAGS '-O2' (csh, tcsh)
170 Similarly, if you want to force the use of some specific compiler, you can
171 give a value to the CXX variable.
173 If you encounter problems, please read the section 'Problems' at the end of
176 In particular, the following options could be useful in some
179 o --with-debug that specifies whether you want to have debug information
180 by default on standard error. Default is no.
182 o --with-warnings that make the compiler output more warnings during
183 the compilation of LyX. Opposite is --without-warnings. By default,
184 this flag is on for development versions only.
186 o --with-broken-headers that provides prototypes to replace functions
187 not correctly defined in SunOS4 and SCO header files. Its only effect is
188 to suppress a few warnings. It is autodetected by default.
190 o --without-latex-config that disables the automatic detection of your
191 latex. This detection is automatically disabled if latex cannot be found.
192 If you find that you have to use this flag, please report it as a bug.
194 o --with-broken-const attempts to fix a bug in gcc 2.7.[012] (see the
197 o ---with-gcc-hack which provide a wrapper around gcc that tries to
198 compile without optimization after a compilation failed (see the
201 o --without-liberty suppresses the detection of the -liberty library
202 (see the section 'Problems').
205 Compiling and installing LyX
206 ----------------------------
208 Once you've got the Makefile created, you just have to type:
215 BTW: in the images subdirectory there is also a small icon "lyx.xpm",
216 that can be used to display lyx-documents in filemanagers.
218 If configure fails for some strange reason
219 ------------------------------------------
221 Even when configure fails, it creates a Makefile. You always can check
222 the contents of this file, modify it and run 'make'.
224 Compiling For Multiple Architectures
225 ------------------------------------
227 You can compile LyX for more than one kind of computer at the same
228 time, by placing the object files for each architecture in their own
229 directory. To do this, you must use a version of `make' that supports
230 the `VPATH' variable, such as GNU `make'. `cd' to the directory where
231 you want the object files and executables to go and run the
232 `configure' script. `configure' automatically checks for the source
233 code in the directory that `configure' is in and in `..'.
235 If you have to use a `make' that does not supports the `VPATH'
236 variable, you have to compile LyX for one architecture at a time in
237 the source code directory. After you have installed LyX for one
238 architecture, use `make distclean' before reconfiguring for another
244 A LyX binary for linux is about 1M when compiled without debug-information
245 and with dynamic libraries. If yours is much bigger you probably compiled
246 it with debug-informations (-g). If you don't want to debug LyX just enter
250 before installing. Note that this is done automatically for public
257 This section provides several hints that have been submitted by LyX
258 team member or users to help compiling on some particular
259 architectures. If you find that some of this hints are wrong, please
262 o If you have problems indicating that configure cannot find a part of
263 the xforms or Xpm library, use the --with-extra-lib and --with-extra-inc
264 options of configure to specify where these libraries reside.
266 o Configure will seemingly fail to find xpm.h and forms.h on linux if
267 you did a 'make mrproper' in the kernel directory, because this
268 removes some symbolic links that are needed for compilation. A 'make
269 symlinks' in linux kernel sources fixes that.
271 o If you have GNU gettext installed on your system (e.g. on linux),
272 you will get tons of warnings like:
274 bullet_forms.C:101: warning: passing `char *' to argument 1 of
275 `__builtin_constant_p(int)' lacks a cast
277 These are in harmless warnings caused by a bug in libintl.h, but
278 will be solved if you use --with-included-gettext when configuring
281 o On Digital Unix with cxx, you may have a compilation error in
282 lyx_main.C if you have GNU gettext installed. This is due to a bug
283 in gettext. To solve this, you can either (1) configure with
284 --with-included-gettext or (2) add -D__STDC__ to cxx flags.
286 o The configure script seems to hang while it is checking the LaTeX setup.
287 We think that this is not a real problem, but rather a symptom of the
288 fact that the ec-fonts are being rendered. This process can take quite
289 some time, so the remedy is simply to have patience. (The fonts need to
290 be rendered at some point to be usable anyways.)
292 o According to John Collins <collins@phys.psu.edu>, on SunOS 4.1.3 you may
293 find two sets of X libraries, and they are of course incompatible :-)
294 One is the set provided as part of OpenWindows, and one is the standard
295 X distribution (e.g., X11R5). If you encounter problems (or if, for
296 some obscure reasons configure cannot find your X libraries) you can
297 use the following options:
299 o --x-libraries=DIRECTORY that indicates where the X libraries reside.
301 o --x-includes=DIRECTORY that indicate where the X include files reside.
303 The standard X11R5 libraries should work when the OpenWindows ones
306 o Some systems lack functions that LyX needs. To fix this, configure
307 tries to link against the -liberty library, if it is available.
308 If you experience problems with missing symbols at link time, you
309 could try to install libiberty.a, which comes with several GNU
310 packages (in particular libg++). In any case, please report your
311 problems to lyx-devel@lists.lyx.org.
313 The option --without-liberty disable the detection of -liberty. It
314 is meant for debugging purpose only.
316 o There are several known bugs in gcc 2.7.xx that cause compiler
317 errors. This is in particular the case in spellchecker.C under
318 HP-UX 9.05 (ask Bernhard Iselborn <biselbor@rhrk.uni-kl.de> for
319 more comments) and in lyxrc.C under Linux/Alpha or DEC OSF/1. In
320 both cases, the solution is to recompile the offending file
321 without optimization and resume the compilation process with
322 'make'. To make things simpler, you can use the option
323 --with-gcc-hack of configure that will do that for you
326 o According to David Sundqvist <David_Sundqvist@vd.volvo.se>, some
327 changes are needed to compile with aCC on HP-UX 10.20. These are the
328 relevant changes in the makefile (with comments tagged on):
330 CXX = /opt/aCC/bin/aCC
331 CXXFLAGS = -O +inst_none # The aCC compiler tries to run instantiations
332 # which currently break.
334 LIBS = -lforms -lXpm -lSM -lICE -lc -lm -lX11 -lCsup # must link with Csup
335 LDFLAGS = -L/opt/aCC/lib # perhaps not needed.
337 o There is a bug in gcc 2.7.[012] in the handling of const which can
338 cause various unpredictable problems. If you experience weird
339 crashes with a LyX compiled by gcc 2.7.[012], try to configure
340 with the --with-broken-const flag and recompile. If this improves
341 things, please report it to the mailing list. Note that this
342 compiler bug is fixed in gcc 2.7.2.1 and in several Linux
343 distributions of gcc 2.7.[012].
345 This bug is currently not autodetected, but any code to do so
346 would be welcome. A patch for gcc 2.7.2 is as follows:
348 *** clean-ss-951203/expr.c Sun Nov 26 08:18:07 1995
349 --- ss-951203/expr.c Mon Dec 4 11:41:18 1995
350 *************** expand_expr (exp, target, tmode, modifie
352 through a pointer to const does not mean that the value there can
353 never change. Languages where it can never change should
354 also set TREE_STATIC. */
355 ! RTX_UNCHANGING_P (temp) = TREE_READONLY (exp) | TREE_STATIC (exp);
359 through a pointer to const does not mean that the value there can
360 never change. Languages where it can never change should
361 also set TREE_STATIC. */
362 ! RTX_UNCHANGING_P (temp) = TREE_READONLY (exp) & TREE_STATIC (exp);
367 o On Digital Unix with gcc, you can get warnings like
369 warning, LyXFamilyNames not found in original or external symbol tables, value defaults to 0
370 warning, LyXSeriesNames not found in original or external symbol tables, value de
372 These concern symbols beginning with an uppercase letter and seems
373 to be harmless. Similarly, the compilation can end with the
377 Warning: Linking some objects which contain exception information sections
378 and some which do not. This may cause fatal runtime exception handling
379 problems (last obj encountered without exceptions was ../intl/libintl.a).
382 You can safely ignore it.
384 o Configure fails to work with cxx V5.0-3 on Digital Unix
385 V3.2c. This is due to a bug in this particular version of cxx.
386 Contact Achim Bohnet <ach@rosat.mpe-garching.mpg.de> for more
387 details concerning this problem.