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-lyx-suffix=STRING adds the given suffix to the names of the
126 LyX binary and scripts, and the library directory. For example,
127 "--with-lyx-suffix=1.1.6" would install a binary "lyx-1.1.6", and
128 create a directory "/usr/share/lyx-1.1.6", install "reLyX-1.1.6" etc.
129 Additionally, LyX will look for the user configuration file in e.g.
130 "$HOME/.lyx-1.1.6". This feature is useful for installing more than
131 one version of LyX on the same machine.
133 There are also flags to control the internationalization support in
136 o --disable-nls suppresses all internationalization support,
137 yielding a somewhat smaller code.
139 o --with-included-gettext forces the use of the included GNU gettext
140 library, although you might have another one installed.
142 o --with-catgets allows to use the catget() functions which can
143 exist on your system. This can cause problems, though. Use with
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.
153 Moreover, the following generic configure flags may be useful:
155 o --prefix=DIRECTORY specifies the root directory to use for
156 installation. [defaults to where lyx has already been installed or
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}]
164 o --bindir=DIRECTORY gives the directory where the lyx binary
165 will be installed. [defaults to ${prefix}/bin]
167 o --mandir=DIRECTORY gives the directory where the man pages will go.
168 [defaults to ${prefix}/man]
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`/".
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:
177 o CXXFLAGS='-O2' (sh, bash)
178 o setenv CXXFLAGS '-O2' (csh, tcsh)
180 Similarly, if you want to force the use of some specific compiler, you can
181 give a value to the CXX variable.
183 If you encounter problems, please read the section 'Problems' at the end of
186 In particular, the following options could be useful in some
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.
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.
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.
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.
207 o --without-liberty suppresses the detection of the -liberty library
208 (see the section 'Problems').
211 Compiling and installing LyX
212 ----------------------------
214 Once you've got the Makefile created, you just have to type:
221 Since the binaries with debug information tend to be huge (although
222 this does not affect the run-time memory footprint), you maight want
223 to strip the lyx binary. In this case replace "make install" with
227 BTW: in the images subdirectory there is also a small icon "lyx.xpm",
228 that can be used to display lyx-documents in filemanagers.
230 If configure fails for some strange reason
231 ------------------------------------------
233 Even when configure fails, it creates a Makefile. You always can check
234 the contents of this file, modify it and run 'make'.
236 Compiling For Multiple Architectures
237 ------------------------------------
239 You can compile LyX for more than one kind of computer at the same
240 time, by placing the object files for each architecture in their own
241 directory. To do this, you must use a version of `make' that supports
242 the `VPATH' variable, such as GNU `make'. `cd' to the directory where
243 you want the object files and executables to go and run the
244 `configure' script. `configure' automatically checks for the source
245 code in the directory that `configure' is in and in `..'.
247 If you have to use a `make' that does not supports the `VPATH'
248 variable, you have to compile LyX for one architecture at a time in
249 the source code directory. After you have installed LyX for one
250 architecture, use `make distclean' before reconfiguring for another
253 Preparing a binary distribution for the use of others
254 ------------------------------------------------------
256 o Compile LyX with the right compiler switches for your
257 architecture. In particular you might want to ensure that
258 libraries like xforms and xpm are statically linked. To this end,
259 you can use a command like
261 make LYX_LIBS='/foo/libforms.a /bar/libXpm.a'
263 Moreover, make sure you use the --without-latex-config switch
264 of configure, since others might not be interested by your
267 o Create a file README.bin describing your distribution and
268 referring to *you* if problems arise. As a model, you can use the
269 file development/tools/README.bin.example, which can be a good
272 o Type `make bindist'. This will create a file
273 lyx-1.xx.yy-bin.tar.gz. Rename it to reflect you architecture
274 and the peculiarities of your build (e.g. static vs. dynamic).
276 o Check that everything is correct by unpacking the distribution
277 in some private place and running it. In particular, check the
278 output of `ldd lyx' to know which libraries are really needed.
280 o Upload your binary file to ftp.devel.lyx.org:/pub/incoming, and
281 notify larsbj@lyx.org.
287 This section provides several hints that have been submitted by LyX
288 team member or users to help compiling on some particular
289 architectures. If you find that some of this hints are wrong, please
292 o If you have problems indicating that configure cannot find a part of
293 the xforms or Xpm library, use the --with-extra-lib and --with-extra-inc
294 options of configure to specify where these libraries reside.
296 o Configure will seemingly fail to find xpm.h and forms.h on linux if
297 you did a 'make mrproper' in the kernel directory, because this
298 removes some symbolic links that are needed for compilation. A 'make
299 symlinks' in linux kernel sources fixes that.
301 o If you have GNU gettext installed on your system (e.g. on linux),
302 you will get tons of warnings like:
304 bullet_forms.C:101: warning: passing `char *' to argument 1 of
305 `__builtin_constant_p(int)' lacks a cast
307 These are in harmless warnings caused by a bug in libintl.h, but
308 will be solved if you use --with-included-gettext when configuring
311 o It is possible to compile lyx with Tru64 Unix cxx compiler
312 version 6.2, provided one uses
314 CXXFLAGS='-ptr /tmp/lyx_cxx_repository -std strict_ansi -g -O'
316 Note that this will not work when compiling directly from the cvs
317 repository, due to the tricks used by automake for dependencies. Ask
318 Jean-Marc.Lasgouttes@inria.fr for a workaround.
320 o On Tru64 Unix, you may have to compile with
321 --with-included-string to work around a Tru64 linker limitation
322 (the STL string template creates names which may be too long). We
323 also had reports that it helps with gcc 2.95.2 on solaris 2.6.
325 o On Tru64 Unix with cxx, you may have a compilation error in
326 lyx_main.C if you have GNU gettext installed. This is due to a bug
327 in gettext. To solve this, you can either (1) configure with
328 --with-included-gettext or (2) add -D__STDC__ to cxx flags.
330 o According to John Collins <collins@phys.psu.edu>, on SunOS 4.1.3 you may
331 find two sets of X libraries, and they are of course incompatible :-)
332 One is the set provided as part of OpenWindows, and one is the standard
333 X distribution (e.g., X11R5). If you encounter problems (or if, for
334 some obscure reasons configure cannot find your X libraries) you can
335 use the following options:
337 o --x-libraries=DIRECTORY that indicates where the X libraries reside.
339 o --x-includes=DIRECTORY that indicate where the X include files reside.
341 The standard X11R5 libraries should work when the OpenWindows ones
344 o Some systems lack functions that LyX needs. To fix this, configure
345 tries to link against the -liberty library, if it is available.
346 If you experience problems with missing symbols at link time, you
347 could try to install libiberty.a, which comes with several GNU
348 packages (in particular libg++). In any case, please report your
349 problems to lyx-devel@lists.lyx.org.
351 The option --without-liberty disable the detection of -liberty. It
352 is meant for debugging purpose only.
354 o According to David Sundqvist <David_Sundqvist@vd.volvo.se>, some
355 changes are needed to compile with aCC on HP-UX 10.20. These are the
356 relevant changes in the makefile (with comments tagged on):
358 CXX = /opt/aCC/bin/aCC
359 CXXFLAGS = -O +inst_none # The aCC compiler tries to run instantiations
360 # which currently break.
362 LIBS = -lforms -lXpm -lSM -lICE -lc -lm -lX11 -lCsup # must link with Csup
363 LDFLAGS = -L/opt/aCC/lib # perhaps not needed.
366 o On Digital Unix with gcc, you can get warnings like
368 warning, LyXFamilyNames not found in original or external symbol tables, value defaults to 0
370 These concern symbols beginning with an uppercase letter and seems
371 to be harmless. Similarly, the compilation can end with the
375 Warning: Linking some objects which contain exception information sections
376 and some which do not. This may cause fatal runtime exception handling
377 problems (last obj encountered without exceptions was ../intl/libintl.a).
380 You can safely ignore it.