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