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 You will also probably need GNU m4 (perhaps installed as gm4).
59 libXpm can be found at:
60 http://www.funet.fi/pub/Linux/sunsite/X11/libs/!INDEX.html
61 (or similar locations at other sunsites like sunsite.unc.edu)
63 You will also need a recent C++ compiler, where recent means that the
64 compilers are close to C++ standard conforming. Compilers that are
65 known to compile LyX are gcc 2.8.1 and 2.95.x, the various versions of
66 egcs and Digital C++ version 6.1. Please tell us your experience with
67 other compilers. It is _not_ possible to compile LyX with gcc 2.7.x,
68 and this is not likely to change in the future.
70 Note that, contrary to LyX 1.0.x, LyX 1.1.x makes great use of C++
71 Standard Template Library (STL); this means that gcc users will have
72 to install the relevant libstdc++ library to be able to compile this
75 If you make modifications to files in src/ (for example by applying a
76 patch), you will need to have the GNU gettext package installed, due to
77 some dependencies in the makefiles. You can find the latest (alpha)
80 ftp://alpha.gnu.org/gnu/gettext-0.10.xx.tar.gz.
82 LyX contains a hack to work around this, but you should not rely too
86 Finally, the two following programs should be available at
89 o Perl (at least 5.002) is needed for the reLyX script. reLyX will
90 not be installed if perl is not found. If the environment
91 variable PERL is set to point to some program, this value will be
92 used, even if the program does no exist (this can be useful if
93 the machine on which LyX is built is not the one where it will
96 o LaTeX2e should be correctly setup for the user you are logged
97 as. Otherwise, LyX will not be able to run a number of tests. Note
98 that users can run these tests manually with Option->Configure.
101 Creating the Makefile
102 ---------------------
104 LyX can be configured using GNU autoconf utility which attempts to guess
105 the configuration needed to suit your system. The standard way to use it
106 is described in the file INSTALL.autoconf. In most cases you will be able
107 to create the Makefile by typing
111 For more complicated cases, LyX configure takes the following specific
114 o --with-extra-lib=DIRECTORY that specifies the path where LyX will find
115 extra libraries (Xpm, xforms) it needs. Defaults to NONE (i.e. search
116 in standard places). You can specify several directories, separated
119 o --with-extra-inc=DIRECTORY that gives the place where LyX will find
120 xforms headers. Defaults to NONE (i.e. search in standard places).
121 You can specify several directories, separated by colons.
123 o --with-extra-prefix[=DIRECTORY] that is equivalent to
124 --with-extra-lib=DIRECTORY/lib --with-extra-inc=DIRECTORY/include
125 If DIRECTORY is not specified, the current prefix is used.
127 o --with-version-suffix will install LyX as lyx-<version>, e.g. lyx-1.2.0
128 The LyX data directory will be something like <whatever>/lyx-1.2.0/.
129 Additionally your user configuration files will be found in e.g.
132 You can use this feature to install more than one version of LyX on
133 the same system. You can optionally specify a "version" of your own,
134 by doing something like : ./configure --with-version-suffix=-latestcvs
136 There are also flags to control the internationalization support in
139 o --disable-nls suppresses all internationalization support,
140 yielding a somewhat smaller code.
142 o --with-included-gettext forces the use of the included GNU gettext
143 library, although you might have another one installed.
145 o --with-catgets allows to use the catget() functions which can
146 exist on your system. This can cause problems, though. Use with
149 o You can also set the environment variable LINGUAS to a list of
150 language in case ou do not want to install all the translation
151 files. For example, if you are only interested in German and
152 Finnish, you can type (with sh or bash)
153 export LINGUAS='de fi'
154 before running configure.
156 Moreover, the following generic configure flags may be useful:
158 o --prefix=DIRECTORY specifies the root directory to use for
159 installation. [defaults to where lyx has already been installed or
162 o --datadir=DIRECTORY gives the directory where all extra LyX
163 files (lyxrc example, documentation, templates and layouts
164 definitions) will be installed.
165 [defaults to ${prefix}/share/lyx${program_suffix}]
167 o --bindir=DIRECTORY gives the directory where the lyx binary
168 will be installed. [defaults to ${prefix}/bin]
170 o --mandir=DIRECTORY gives the directory where the man pages will go.
171 [defaults to ${prefix}/man]
173 Note that the --with-extra-* commands are not really robust when it
174 comes to use of relative paths. If you really want to use a relative path
175 here, you can prepend it with "`pwd`/".
177 If you do not like the default compile flags used (-g -O2 on gcc), you can
178 set CXXFLAGS variable to other values as follows:
180 o CXXFLAGS='-O2' (sh, bash)
181 o setenv CXXFLAGS '-O2' (csh, tcsh)
183 Similarly, if you want to force the use of some specific compiler, you can
184 give a value to the CXX variable.
186 If you encounter problems, please read the section 'Problems' at the end of
189 In particular, the following options could be useful in some
192 o --with-warnings that make the compiler output more warnings during
193 the compilation of LyX. Opposite is --without-warnings. By default,
194 this flag is on for development versions only.
196 o --enable-assertions that make the compilier generater run-time
197 code which checks that some variables have sane values. Opposite
198 is --disable-assertions. By default, this flag is on for
199 development versions only.
201 o --with-broken-headers that provides prototypes to replace functions
202 not correctly defined in SunOS4 and SCO header files. Its only effect is
203 to suppress a few warnings. It is autodetected by default.
205 o --without-latex-config that disables the automatic detection of your
206 latex configuration. This detection is automatically disabled if
207 latex cannot be found. If you find that you have to use this
208 flag, please report it as a bug.
210 o --without-liberty suppresses the detection of the -liberty library
211 (see the section 'Problems').
214 Compiling and installing LyX
215 ----------------------------
217 Once you've got the Makefile created, you just have to type:
224 Since the binaries with debug information tend to be huge (although
225 this does not affect the run-time memory footprint), you maight want
226 to strip the lyx binary. In this case replace "make install" with
230 BTW: in the images subdirectory there is also a small icon "lyx.xpm",
231 that can be used to display lyx-documents in filemanagers.
233 If configure fails for some strange reason
234 ------------------------------------------
236 Even when configure fails, it creates a Makefile. You always can check
237 the contents of this file, modify it and run 'make'.
239 Compiling For Multiple Architectures
240 ------------------------------------
242 You can compile LyX for more than one kind of computer at the same
243 time, by placing the object files for each architecture in their own
244 directory. To do this, you must use a version of `make' that supports
245 the `VPATH' variable, such as GNU `make'. `cd' to the directory where
246 you want the object files and executables to go and run the
247 `configure' script. `configure' automatically checks for the source
248 code in the directory that `configure' is in and in `..'.
250 If you have to use a `make' that does not supports the `VPATH'
251 variable, you have to compile LyX for one architecture at a time in
252 the source code directory. After you have installed LyX for one
253 architecture, use `make distclean' before reconfiguring for another
256 Preparing a binary distribution for the use of others
257 ------------------------------------------------------
259 o Compile LyX with the right compiler switches for your
260 architecture. In particular you might want to ensure that
261 libraries like xforms and xpm are statically linked. To this end,
262 you can use a command like
264 make LYX_LIBS='/foo/libforms.a /bar/libXpm.a'
266 Moreover, make sure you use the --without-latex-config switch
267 of configure, since others might not be interested by your
270 o Create a file README.bin describing your distribution and
271 referring to *you* if problems arise. As a model, you can use the
272 file development/tools/README.bin.example, which can be a good
275 o Type `make bindist'. This will create a file
276 lyx-1.xx.yy-bin.tar.gz. Rename it to reflect you architecture
277 and the peculiarities of your build (e.g. static vs. dynamic).
279 o Check that everything is correct by unpacking the distribution
280 in some private place and running it. In particular, check the
281 output of `ldd lyx' to know which libraries are really needed.
283 o Upload your binary file to ftp.devel.lyx.org:/pub/incoming, and
284 notify larsbj@lyx.org.
290 This section provides several hints that have been submitted by LyX
291 team member or users to help compiling on some particular
292 architectures. If you find that some of this hints are wrong, please
295 o If you have problems indicating that configure cannot find a part of
296 the xforms or Xpm library, use the --with-extra-lib and --with-extra-inc
297 options of configure to specify where these libraries reside.
299 o Configure will seemingly fail to find xpm.h and forms.h on linux
300 if the kernel headers are not available. Two cases are possible:
302 - you have not installed the kernel sources. Then you should
303 install them or at least the kernel-headers package (or
304 whatever it is called in your distribution).
306 - you have the sources, but you did a 'make mrproper' in the
307 kernel directory (this this removes some symbolic links that
308 are needed for compilation). A 'make symlinks' in linux kernel
311 o if you are using RedHat Linux 7.x, you must make sure you have the
312 latest updated gcc and related packages installed (at least -85),
313 or LyX will not compile or will be mis-compiled.
315 o if you get an error message when compiling LyX that looks like this :
317 ../../src/minibuffer.h:17: using directive `Object' introduced
318 ambiguous type `_ObjectRec *'
320 then you need to upgrade the version of the xforms library you have
323 o It is possible to compile lyx with Tru64 Unix cxx compiler
324 version 6.2, provided one uses
325 CXX='cxx -std strict_ansi'
326 CXXFLAGS='-ptr /tmp/lyx_cxx_repository -g'
329 Note that this will not work when compiling directly from the cvs
330 repository, due to the tricks used by automake for dependencies. Ask
331 Jean-Marc.Lasgouttes@inria.fr for a workaround.
333 o On Tru64 Unix, you may have to compile with
334 --with-included-string to work around a Tru64 linker limitation
335 (the STL string template creates names which may be too long). We
336 also had reports that it helps with gcc 2.95.2 on solaris 2.6.
338 o On Tru64 Unix with cxx, you may have a compilation error in
339 lyx_main.C if you have GNU gettext installed. This is due to a bug
340 in gettext. To solve this, you can either (1) configure with
341 --with-included-gettext or (2) add -D__STDC__ to cxx flags.
343 o According to John Collins <collins@phys.psu.edu>, on SunOS 4.1.3 you may
344 find two sets of X libraries, and they are of course incompatible :-)
345 One is the set provided as part of OpenWindows, and one is the standard
346 X distribution (e.g., X11R5). If you encounter problems (or if, for
347 some obscure reasons configure cannot find your X libraries) you can
348 use the following options:
350 o --x-libraries=DIRECTORY that indicates where the X libraries reside.
352 o --x-includes=DIRECTORY that indicate where the X include files reside.
354 The standard X11R5 libraries should work when the OpenWindows ones
357 o Some systems lack functions that LyX needs. To fix this, configure
358 tries to link against the -liberty library, if it is available.
359 If you experience problems with missing symbols at link time, you
360 could try to install libiberty.a, which comes with several GNU
361 packages (in particular libg++). In any case, please report your
362 problems to lyx-devel@lists.lyx.org.
364 The option --without-liberty disable the detection of -liberty. It
365 is meant for debugging purpose only.
367 o According to David Sundqvist <David_Sundqvist@vd.volvo.se>, some
368 changes are needed to compile with aCC on HP-UX 10.20. These are the
369 relevant changes in the makefile (with comments tagged on):
371 CXX = /opt/aCC/bin/aCC
372 CXXFLAGS = -O +inst_none # The aCC compiler tries to run instantiations
373 # which currently break.
375 LIBS = -lforms -lXpm -lSM -lICE -lc -lm -lX11 -lCsup # must link with Csup
376 LDFLAGS = -L/opt/aCC/lib # perhaps not needed.
379 o On Digital Unix with gcc, you can get warnings like
381 warning, LyXFamilyNames not found in original or external symbol tables, value defaults to 0
383 These concern symbols beginning with an uppercase letter and seems
384 to be harmless. Similarly, the compilation can end with the
388 Warning: Linking some objects which contain exception information sections
389 and some which do not. This may cause fatal runtime exception handling
390 problems (last obj encountered without exceptions was ../intl/libintl.a).
393 You can safely ignore it.