]> git.lyx.org Git - lyx.git/blob - INSTALL
refer to latex-xft-fonts
[lyx.git] / INSTALL
1 Compiling and installing LyX
2 ============================
3
4 Quick compilation guide
5 -----------------------
6
7 These four steps will compile, test and install LyX:
8
9         0) Linux users beware: if compiling the Qt frontend, you need
10            qt and qt-devel packages of the same version to compile LyX. 
11
12         1) ./configure
13            configures LyX to your system. By default, LyX configures
14            the xforms frontend, use --with-frontend=qt to build a Qt
15            version. You may have to set 
16            --with-qt-dir=<path-to-your-qt-installation> to succeed.
17
18         2) make
19            compiles the program.
20
21         3) src/lyx
22            runs the program so you can check it out.
23
24         4) make install
25            will install it. You can use "make install-strip" instead
26            if you want a smaller binary.
27
28
29 Note for CVS checkouts
30 ----------------------
31
32 If you have checked this out from CVS, you need to have
33 automake, autoconf, and gettext installed.  Then,
34 type "./autogen.sh" to build the needed configuration
35 files and proceed as stated below.
36
37 You will also probably need GNU m4 (perhaps installed as gm4).
38
39 Requirements
40 ------------
41
42 First of all, you will also need a recent C++ compiler, where recent
43 means that the compilers are close to C++ standard conforming.
44 Compilers that are known to compile LyX are egcs 1.1.x, gcc 2.95.x and
45 later, and Digital C++ version 6.1 and later. Please tell us your
46 experience with other compilers. It is _not_ possible to compile LyX
47 with gcc 2.7.x and 2.8.x, and this is not likely to change in the
48 future.
49
50 Note that, contrary to LyX 1.0.x, LyX 1.3.x makes great use of C++
51 Standard Template Library (STL); this means that gcc users will have
52 to install the relevant libstdc++ library to be able to compile this
53 version.
54
55 * xforms frontend
56
57 Both an Xforms and Xpm libraries should be installed to compile LyX.
58 It is imperative that you have the correct versions of these
59 libraries, and their associated header files.
60
61 The xforms library has been very recently updated to version 1.0.
62 This version has been released under the LGPL (Lesser General Public
63 License), and the availability of the source means that many bugs that
64 have been plaguing LyX have been fixed in xforms. You are advised to
65 upgrade to xforms 1.0 to enjoy all these new fixes.
66 In fact, LyX 1.3.x no longer supports versions of xforms older than 0.89.5.
67
68 You can get the source from
69         http://world.std.com/~xforms/
70         ftp://ncmir.ucsd.edu/pub/xforms/OpenSource/xforms-1.0-release.tgz
71         ftp://ftp.lyx.org/pub/xforms/OpenSource/xforms-1.0-release.tgz
72
73 If you use a rpm-based linux distribution, such as RedHat or Mandrake,
74 we recommend that you grab a version of xforms from
75         ftp://ftp.lyx.org/pub/lyx/contrib
76 Look for the xforms-1.0-release.src.rpm or the binary libforms*.i386.rpm.
77
78 In addition, you must have libXpm version 4.7 or newer.
79
80 * Qt frontend
81
82 LyX has been tested with both Qt 2.x and 3.x libraries. The only special
83 point to make is that you must ensure that both LyX and the Qt libraries
84 are compiled with the same C++ compiler.
85
86 Note that if Qt is using Xft2/fontconfig, you may need to install the
87 latex-xft-fonts package (at ftp://ftp.lyx.org/pub/lyx/contrib/) to get
88 maths symbols displayed properly. To find out, type:
89
90         ldd `which lyx` | grep fontconfig
91
92 at the console. Both RH8 and Debian unstable distributions are known
93 to use fontconfig.
94
95 If, however, your version of Qt does not use fontconfig, then the
96 /usr/local/share/lyx/xfonts directory (or equivalent) should be added to
97 the font path. This is done automatically by LyX if LyX is run on
98 the local machine, and the X server supports Postscript fonts. If, however,
99 you're running LyX remotely, then you'll have to do this step yourself.
100 'man xset' is your friend.
101
102 * Other things to note
103
104 If you make modifications to files in src/ (for example by applying a
105 patch), you will need to have the GNU gettext package installed, due
106 to some dependencies in the makefiles. You can get the latest version
107 from:
108         ftp://ftp.gnu.org/gnu/gettext/gettext-0.11.4.tar.gz
109
110 LyX contains a hack to work around this, but you should not rely too
111 much on it.
112
113 To use the thesaurus, you will need to install libAikSaurus, available
114 from:
115         http://aiksaurus.sourceforge.net/
116
117 The two following programs should be available at configuration time:
118
119   o Perl (at least 5.002) is needed for the reLyX script. reLyX will
120     not be installed if perl is not found.  If the environment
121     variable PERL is set to point to some program, this value will be
122     used, even if the program does no exist (this can be useful if
123     the machine on which LyX is built is not the one where it will
124     run).
125
126   o LaTeX2e should be correctly setup for the user you are logged in
127     as. Otherwise, LyX will not be able to run a number of tests. Note
128     that users can run these tests manually with Edit>Reconfigure.
129
130 Finally, you will need to have python 1.5.2 or newer installed to be
131 able to import older LyX files with the lyx2lyx script (this script is
132 called automatically when opening a file).
133
134
135 Creating the Makefile
136 ---------------------
137
138 LyX can be configured using GNU autoconf utility which attempts to guess
139 the configuration needed to suit your system.  The standard way to use it
140 is described in the file INSTALL.autoconf.  In most cases you will be able
141 to create the Makefile by typing
142
143   ./configure
144
145 For more complicated cases, LyX configure takes the following specific
146 flags:
147
148   o --with-frontend=FRONTEND that allows to specify which frontend you
149     want to use. Default is "xforms", and the other possible value is
150     "qt".
151
152   o --with-extra-lib=DIRECTORY that specifies the path where LyX will
153     find extra libraries (Xpm, xforms, qt) it needs. Defaults to NONE
154     (i.e. search in standard places). You can specify several
155     directories, separated by colons.
156
157   o --with-extra-inc=DIRECTORY that gives the place where LyX will find
158     xforms headers.  Defaults to NONE (i.e.  search in standard places).
159     You can specify several directories, separated by colons.
160
161   o --with-extra-prefix[=DIRECTORY] that is equivalent to
162        --with-extra-lib=DIRECTORY/lib --with-extra-inc=DIRECTORY/include
163     If DIRECTORY is not specified, the current prefix is used.
164
165   o --with-version-suffix will install LyX as lyx-<version>, e.g. lyx-1.3.1
166     The LyX data directory will be something like <whatever>/lyx-1.3.1/.
167     Additionally your user configuration files will be found in e.g.
168     $HOME/.lyx-1.3.1
169
170     You can use this feature to install more than one version of LyX
171     on the same system. You can optionally specify a "version" of your
172     own, by doing something like : 
173        ./configure --with-version-suffix=-latestcvs
174
175     Note that the standard configure options --program-prefix,
176     --program-suffix and the others will not affect the shared LyX
177     directory etc. so it is recommended that you use --with-version-suffix
178     (or --prefix) instead.
179
180   o --enable-optimization=VALUE enables you to set optimization to a
181     higher level as the default (-O), for example --enable-optimization=-O3.
182
183   o --disable-optimization - you can use this to disable compiler
184     optimization of LyX. The compile may be much quicker with some
185     compilers, but LyX will run more slowly.
186
187   o --enable-debug will add debug information to your binary. This
188     requires a lot more disk space, but is a must if you want to try to
189     debug problems in LyX. The default is to have debug information
190     for development versions and prereleases only.
191
192 There are also flags to control the internationalization support in
193 LyX:
194
195   o --disable-nls suppresses all internationalization support,
196     yielding a somewhat smaller code.
197
198   o --with-included-gettext forces the use of the included GNU gettext
199     library, although you might have another one installed.
200
201   o --with-catgets allows to use the catget() functions which can
202     exist on your system.  This can cause problems, though. Use with
203     care.
204
205   o You can also set the environment variable LINGUAS to a list of
206     language in case you do not want to install all the translation
207     files. For example, if you are only interested in German and
208     Finnish, you can type (with sh or bash)
209         export LINGUAS='de fi'
210     before running configure.
211
212 Moreover, the following generic configure flags may be useful:
213
214   o --prefix=DIRECTORY specifies the root directory to use for
215     installation. [defaults to /usr/local]
216
217   o --datadir=DIRECTORY gives the directory where all extra LyX
218     files (lyxrc example, documentation, templates and layouts
219     definitions) will be installed.
220     [defaults to ${prefix}/share/lyx${program_suffix}]
221
222   o --bindir=DIRECTORY gives the directory where the lyx binary
223     will be installed. [defaults to ${prefix}/bin]
224
225   o --mandir=DIRECTORY gives the directory where the man pages will go.
226     [defaults to ${prefix}/man]
227
228   o --enable-mainainer-mode enables some code that automatically
229     rebuilds the configure script, makefiles templates and other useful
230     files when needed. This is off by default, to avoid surprises.
231
232 Note that the --with-extra-* commands are not really robust when it
233 comes to use of relative paths.  If you really want to use a relative path
234 here, you can prepend it with "`pwd`/".
235
236 If you do not like the default compile flags used (-g -O2 on gcc), you can
237 set CXXFLAGS variable to other values as follows:
238
239   o CXXFLAGS='-O2' (sh, bash)
240   o setenv CXXFLAGS '-O2' (csh, tcsh)
241
242 Similarly, if you want to force the use of some specific compiler, you can
243 give a value to the CXX variable.
244
245 If you encounter problems, please read the section 'Problems' at the end of
246 this file.
247
248 In particular, the following options could be useful in some desperate
249 cases:
250
251   o --enable-warnings that make the compiler output more warnings during
252     the compilation of LyX.  Opposite is --disable-warnings.  By default,
253     this flag is on for development versions only.
254
255   o --enable-assertions that make the compiler generate run-time
256     code which checks that some variables have sane values. Opposite
257     is --disable-assertions.  By default, this flag is on for
258     development versions only.
259
260   o --without-latex-config that disables the automatic detection of your
261     latex configuration.  This detection is automatically disabled if
262     latex cannot be found.  If you find that you have to use this
263     flag, please report it as a bug.
264
265
266 Compiling and installing LyX
267 ----------------------------
268
269 Once you've got the Makefile created, you just have to type:
270
271   make all
272   make install
273
274 All should be OK ;)
275
276 Since the binaries with debug information tend to be huge (although
277 this does not affect the run-time memory footprint), you might want
278 to strip the lyx binary. In this case replace "make install" with
279
280   make install-strip
281
282 BTW: in the images subdirectory there is also a small icon "lyx.xpm",
283 that can be used to display lyx-documents in filemanagers.
284
285 If configure fails for some strange reason
286 ------------------------------------------
287
288 Even when configure fails, it creates a Makefile.  You always can check
289 the contents of this file, modify it and run 'make'.
290
291 Compiling For Multiple Architectures
292 ------------------------------------
293
294 You can compile LyX for more than one kind of computer at the same
295 time, by placing the object files for each architecture in their own
296 directory.  To do this, you must use a version of `make' that supports
297 the `VPATH' variable, such as GNU `make'.  `cd' to the directory where
298 you want the object files and executables to go and run the
299 `configure' script.  `configure' automatically checks for the source
300 code in the directory that `configure' is in and in `..'.
301
302 If you have to use a `make' that does not supports the `VPATH'
303 variable, you have to compile LyX for one architecture at a time in
304 the source code directory.  After you have installed LyX for one
305 architecture, use `make distclean' before reconfiguring for another
306 architecture.
307
308 Preparing a binary distribution for the use of others
309 ------------------------------------------------------
310
311   o Compile LyX with the right compiler switches for your
312     architecture. Make sure you use the --without-latex-config switch
313     of configure, since others might not be interested by your
314     configuration :-)
315
316   o Create a file README.bin describing your distribution and
317     referring to *you* if problems arise. As a model, you can use the
318     file development/tools/README.bin.example, which can be a good
319     starting point.
320
321   o Type `make bindist'. This will create a file
322     lyx-1.xx.yy-bin.tar.gz. Rename it to reflect you architecture
323     and the peculiarities of your build (e.g. static vs. dynamic).
324
325   o Check that everything is correct by unpacking the distribution
326     in some private place and running it. In particular, check the
327     output of `ldd lyx' to know which libraries are really needed.
328
329   o Upload your binary file to ftp.devel.lyx.org:/pub/incoming, and
330     notify larsbj@lyx.org.
331
332
333 Problems
334 --------
335
336 This section provides several hints that have been submitted by LyX
337 team member or users to help compiling on some particular
338 architectures. If you find that some of this hints are wrong, please
339 notify us.
340
341   o If you have problems indicating that configure cannot find a part of
342     the xforms or Xpm library, use the --with-extra-lib and --with-extra-inc
343     options of configure to specify where these libraries reside.
344
345   o Configure will seemingly fail to find xpm.h and forms.h on linux
346     if the kernel headers are not available. Two cases are possible:
347
348       - you have not installed the kernel sources. Then you should
349         install them or at least the kernel-headers package (or
350         whatever it is called in your distribution).
351
352       - you have the sources, but you did a 'make mrproper' in the
353         kernel directory (this  this removes some symbolic links that
354         are needed for compilation). A 'make symlinks' in linux kernel
355         sources fixes that.
356
357   o if you are using RedHat Linux 7.x, you must make sure you have the
358     latest updated gcc and related packages installed (at least -85),
359     or LyX will not compile or will be mis-compiled.
360
361   o if you get an error message when compiling LyX that looks like this :
362
363     ../../src/minibuffer.h:17: using directive `Object' introduced
364     ambiguous type `_ObjectRec *'
365
366     then you need to upgrade the version of the xforms library you have
367     installed.
368
369   o On solaris 2.6, you may have to compile with --with-included-string
370     if compiling with gcc 2.95.2.
371
372   o LyX can be compiled on Tru64 Unix with either GNU's gcc or the default
373     Compaq cxx compiler.
374
375     There are no Alpha-specific problems with gcc.
376
377     The following notes all refer to compilation with the Compaq cxx compiler.
378
379     LyX cannot be compiled on Tru64 Unix 4.0d or 4.0e with the default cxx
380     compiler. You should upgrade to at least cxx V6.2, to be found at
381     ftp::/ftp.compaq.com/pub/products/C-CXX/tru64/cxx/CXX622V40.tar. Users
382     running Tru64 Unix 4.0f and greater should have no real problems compiling
383     LyX.
384
385     cxx V6.2 will compile LyX out of the box.
386     cxx V6.3-020 is also known to work, although there is a bug in
387     /usr/include/cxx/deque that will break compilation in FormPreferences.C.
388     Compaq are investigating, but a patch that works /now/ is:
389
390 --- /usr/include/cxx/deque_safe Mon Mar  4 21:09:50 2002
391 +++ /usr/include/cxx/deque      Mon Mar  4 21:09:00 2002
392 @@ -570,9 +570,11 @@
393        {
394          if (size() >= x.size())
395            erase(copy(x.begin(), x.end(), begin()), end());
396 -        else
397 -          copy(x.begin() + size(), x.end(),
398 -               inserter(*this,copy(x.begin(),x.begin()+size(),begin())));
399 +        else {
400 +         const_iterator mid = x.begin() + difference_type(size());
401 +         copy(x.begin(), mid, begin());
402 +         insert(end(), mid, x.end());
403 +       }
404        }
405        return *this;
406      }
407
408     At the time of writing, cxx V6.5-026 is the latest cxx compiler. It is
409     /not/ recommended. The compiler itself appears to be both buggy and
410     extremely bloated (trebling the size of the stripped LyX binary).
411
412     In order to compile LyX with the cxx compiler, you should run configure
413     with the following flags:
414         CXX='cxx -std strict_ansi'
415         CXXFLAGS='-nopure_cname -nocleanup -ptr /tmp/lyx_cxx_repository -O2'
416         CC='cc -std1'
417     The -nopure_cname flag is needed for compilers V6.3 and above because
418     LyX makes use of functions like popen, pclose that are defined in the
419     c version of <stdio.h> but are not formally part of any c/c++ standard.
420     They are not, therefore, included in the <cstdio> header file.