-Note for CVS checkouts
-----------------------
-
-If you have checked this out from CVS, you need to have
-automake, autoconf, and gettext installed. Then,
-type "./autogen.sh" to build the needed configuration
-files and proceed as stated below.
-
Compiling and installing LyX
============================
These four steps will compile, test and install LyX:
+ 0) Linux users beware: if compiling the Qt frontend, you need
+ qt and qt-devel packages of the same version to compile LyX.
+
1) ./configure
- configures LyX to your system.
+ configures LyX to your system. By default, LyX configures
+ the xforms frontend, use --with-frontend=qt to build a Qt
+ version. You may have to set
+ --with-qt-dir=<path-to-your-qt-installation>
+ if the environment variable QTDIR is not set.
2) make
compiles the program.
runs the program so you can check it out.
4) make install
- will install it.
+ will install it. You can use "make install-strip" instead
+ if you want a smaller binary.
+
+
+Note for CVS checkouts
+----------------------
+
+If you have checked this out from CVS, you need to have:
+* automake >= 1.5
+* autoconf >= 2.52
+* gettext >= 0.12
+Then type "./autogen.sh" to build the needed configuration
+files and proceed as stated below.
+You will also probably need GNU m4 (perhaps installed as gm4).
Requirements
------------
-You will need to have both an Xforms library and Xpm library to compile
-LyX. It is imperative that you have the correct versions of these
+First of all, you will also need a recent C++ compiler, where recent
+means that the compilers are close to C++ standard conforming.
+Compilers that are known to compile LyX are gcc 2.95.x and later
+and Digital C++ version 6.1 and later. Please tell us your experience
+with other compilers.
+
+It is _not_ possible to compile LyX with gcc 2.7.x and 2.8.x.
+
+LyX 1.4.x makes great use of C++ Standard Template Library (STL).
+This means that gcc users will have to install the relevant libstdc++
+library to be able to compile this version of LyX. Users of gcc 2.95.x
+will have to install the STLPort version of these libraries as the
+ones that come with gcc 2.95.x are too broken for us to use.
+
+* xforms frontend
+
+Both an Xforms and Xpm libraries should be installed to compile LyX.
+It is imperative that you have the correct versions of these
libraries, and their associated header files.
-As of LyX version 1.1.5, you will need to have Xforms library and header
-version 0.88 or 0.89. Version 0.88 is a stable release and the
-recommended version. On some systems, such as linux ELF, there are shared
-library versions of the Xforms library, which require an installation step
-to configure the system.
+The xforms library has been very recently updated to version 1.0.
+This version has been released under the LGPL (Lesser General Public
+License), and the availability of the source means that many bugs that
+have been plaguing LyX have been fixed in xforms. You are advised to
+upgrade to xforms 1.0 to enjoy all these new fixes.
+In fact, LyX 1.3.x no longer supports versions of xforms older than 0.89.5.
+
+You can get the source from
+ http://world.std.com/~xforms/
+ ftp://ncmir.ucsd.edu/pub/xforms/OpenSource/xforms-1.0-release.tgz
+ ftp://ftp.lyx.org/pub/xforms/OpenSource/xforms-1.0-release.tgz
+
+If you use a rpm-based linux distribution, such as RedHat or Mandrake,
+we recommend that you grab a version of xforms from
+ ftp://ftp.lyx.org/pub/lyx/contrib
+Look for the xforms-1.0-release.src.rpm or the binary libforms*.i386.rpm.
-Xforms is available (free) only in binary format, source code is not
-available. If it is not available for your machine, contact the Xforms
-developers to request a version for your system. You can get it from
+In addition, you must have libXpm version 4.7 or newer.
- http://world.std.com/~xforms/
- ftp://ncmir.ucsd.edu/pub/xforms/
- ftp://ftp.lyx.org/pub/xforms/
- ftp://ftp.fu-berlin.de/unix/X11/gui/xforms
- ftp://ftp.cs.ruu.nl/pub/XFORMS/
+* Qt frontend
-In addition, you must have libXpm version 4.7 (or newer; 4.8 rumoured
-to work).
+LyX has been tested with both Qt 2.x and 3.x libraries. The only special
+point to make is that you must ensure that both LyX and the Qt libraries
+are compiled with the same C++ compiler.
-libXpm can be found at:
- http://www.funet.fi/pub/Linux/sunsite/X11/libs/!INDEX.html
- (or similar locations at other sunsites like sunsite.unc.edu)
+Note that if Qt is using Xft2/fontconfig, you may need to install the
+latex-xft-fonts package (at ftp://ftp.lyx.org/pub/lyx/contrib/) to get
+maths symbols displayed properly. To find out, type:
-You will also need a recent C++ compiler, where recent means that the
-compilers are close to C++ standard conforming. Compilers that are known
-to compile LyX are gcc 2.8.1 and 2.95.x, the various versions of egcs
-and Digital C++ version 6.1. Please tell us your experience with other
-compilers. It is _not_ possible to compile LyX with gcc
-2.7.x, and this is not likely to change in the future.
+ ldd `which lyx` | grep fontconfig
-Note that, contrary to LyX 1.0.x, LyX 1.1.x makes great use of C++
-Standard Template Library (STL); this means that gcc users will have
-to install the relevant libstdc++ library to be able to compile this
-version.
+at the console. Both RH8 and Debian unstable distributions are known
+to use fontconfig.
-If you make modifications to files in src/ (for example by applying a
-patch), you will need to have the GNU gettext package installed, due to
-some dependencies in the makefiles. You can find the latest (alpha)
-version from:
+If, however, your version of Qt does not use fontconfig, then the
+/usr/local/share/lyx/xfonts directory (or equivalent) should be added to
+the font path. This is done automatically by LyX if LyX is run on
+the local machine, and the X server supports Postscript fonts. If, however,
+you're running LyX remotely, then you'll have to do this step yourself.
+'man xset' is your friend.
- ftp://alpha.gnu.org/gnu/gettext-0.10.xx.tar.gz.
+* Other things to note
+
+If you make modifications to files in src/ (for example by applying a
+patch), you will need to have the GNU gettext package installed, due
+to some dependencies in the makefiles. You can get the latest version
+from:
+ ftp://ftp.gnu.org/gnu/gettext/gettext-0.11.4.tar.gz
LyX contains a hack to work around this, but you should not rely too
much on it.
+To use the thesaurus, you will need to install libAikSaurus, available
+from:
+ http://aiksaurus.sourceforge.net/
-Finally, the two following programs should be available at
-configuration time:
+The two following programs should be available at configuration time:
o Perl (at least 5.002) is needed for the reLyX script. reLyX will
not be installed if perl is not found. If the environment
variable PERL is set to point to some program, this value will be
used, even if the program does no exist (this can be useful if
the machine on which LyX is built is not the one where it will
- run).
+ run).
- o LaTeX2e should be correctly setup for the user you are logged
+ o LaTeX2e should be correctly setup for the user you are logged in
as. Otherwise, LyX will not be able to run a number of tests. Note
- that users can run these tests manually with Option->Configure.
+ that users can run these tests manually with Edit>Reconfigure.
+
+Finally, you will need to have python 1.5.2 or newer installed to be
+able to import older LyX files with the lyx2lyx script (this script is
+called automatically when opening a file).
Creating the Makefile
---------------------
-LyX can be configured using GNU autoconf utility which attempts to guess
-the configuration needed to suit your system. The standard way to use it
-is described in the file INSTALL.autoconf. In most cases you will be able
+LyX can be configured using GNU autoconf utility which attempts to guess
+the configuration needed to suit your system. The standard way to use it
+is described in the file INSTALL.autoconf. In most cases you will be able
to create the Makefile by typing
./configure
For more complicated cases, LyX configure takes the following specific
flags:
- o --with-extra-lib=DIRECTORY that specifies the path where LyX will find
- extra libraries (Xpm, xforms) it needs. Defaults to NONE (i.e. search
- in standard places). You can specify several directories, separated
- by colons.
+ o --with-frontend=FRONTEND that allows to specify which frontend you
+ want to use. Default is "xforms", and the other possible value is
+ "qt".
+
+ o --with-extra-lib=DIRECTORY that specifies the path where LyX will
+ find extra libraries (Xpm, xforms, qt) it needs. Defaults to NONE
+ (i.e. search in standard places). You can specify several
+ directories, separated by colons.
o --with-extra-inc=DIRECTORY that gives the place where LyX will find
xforms headers. Defaults to NONE (i.e. search in standard places).
--with-extra-lib=DIRECTORY/lib --with-extra-inc=DIRECTORY/include
If DIRECTORY is not specified, the current prefix is used.
- o --with-lyxname=STRING sets the name of the installed LyX binary and
- of the LyX library directory to STRING. This may be used to
- compile lyx as lyx-1.1 and avoid clashes with earlier/later
- versions. Default is "lyx".
+ o --with-version-suffix will install LyX as lyx-<version>, e.g. lyx-1.3.1
+ The LyX data directory will be something like <whatever>/lyx-1.3.1/.
+ Additionally your user configuration files will be found in e.g.
+ $HOME/.lyx-1.3.1
+
+ You can use this feature to install more than one version of LyX
+ on the same system. You can optionally specify a "version" of your
+ own, by doing something like :
+ ./configure --with-version-suffix=-latestcvs
+
+ Note that the standard configure options --program-prefix,
+ --program-suffix and the others will not affect the shared LyX
+ directory etc. so it is recommended that you use --with-version-suffix
+ (or --prefix) instead.
- o --with-two-colors=[yes|no] that forces LyX to use two colors pixmaps
- (bitmaps) instead of the full-colored standard ones. Defaults to no.
+ o --enable-optimization=VALUE enables you to set optimization to a
+ higher level as the default (-O), for example --enable-optimization=-O3.
+ o --disable-optimization - you can use this to disable compiler
+ optimization of LyX. The compile may be much quicker with some
+ compilers, but LyX will run more slowly.
+
+ o --enable-debug will add debug information to your binary. This
+ requires a lot more disk space, but is a must if you want to try to
+ debug problems in LyX. The default is to have debug information
+ for development versions and prereleases only.
There are also flags to control the internationalization support in
LyX:
o --disable-nls suppresses all internationalization support,
- yielding a somewhat smaller code.
+ yielding a somewhat smaller code.
o --with-included-gettext forces the use of the included GNU gettext
library, although you might have another one installed.
care.
o You can also set the environment variable LINGUAS to a list of
- language in case ou do not want to install all the translation
+ language in case you do not want to install all the translation
files. For example, if you are only interested in German and
Finnish, you can type (with sh or bash)
export LINGUAS='de fi'
Moreover, the following generic configure flags may be useful:
o --prefix=DIRECTORY specifies the root directory to use for
- installation. [defaults to where lyx has already been installed or
- /usr/local]
+ installation. [defaults to /usr/local]
- o --datadir=DIRECTORY gives the directory where all extra LyX
+ o --datadir=DIRECTORY gives the directory where all extra LyX
files (lyxrc example, documentation, templates and layouts
- definitions) will be installed.
+ definitions) will be installed.
[defaults to ${prefix}/share/lyx${program_suffix}]
o --bindir=DIRECTORY gives the directory where the lyx binary
o --mandir=DIRECTORY gives the directory where the man pages will go.
[defaults to ${prefix}/man]
+ o --enable-maintainer-mode enables some code that automatically
+ rebuilds the configure script, makefiles templates and other useful
+ files when needed. This is off by default on releases, to avoid
+ surprises.
+
Note that the --with-extra-* commands are not really robust when it
comes to use of relative paths. If you really want to use a relative path
-here, you can prepend it with "`pwd`/".
+here, you can prepend it with "`pwd`/".
-If you do not like the default compile flags used (-g -O2 on gcc), you can
+If you do not like the default compile flags used (-g -O2 on gcc), you can
set CXXFLAGS variable to other values as follows:
o CXXFLAGS='-O2' (sh, bash)
o setenv CXXFLAGS '-O2' (csh, tcsh)
-Similarly, if you want to force the use of some specific compiler, you can
+Similarly, if you want to force the use of some specific compiler, you can
give a value to the CXX variable.
-If you encounter problems, please read the section 'Problems' at the end of
-this file.
+If you encounter problems, please read the section 'Problems' at the end of
+this file.
-In particular, the following options could be useful in some
-desperate cases:
+In particular, the following options could be useful in some desperate
+cases:
- o --with-warnings that make the compiler output more warnings during
- the compilation of LyX. Opposite is --without-warnings. By default,
+ o --enable-warnings that make the compiler output more warnings during
+ the compilation of LyX. Opposite is --disable-warnings. By default,
this flag is on for development versions only.
- o --enable-assertions that make the compilier generater run-time
- code which checks that some variables have sane values. Opposite
+ o --enable-assertions that make the compiler generate run-time
+ code which checks that some variables have sane values. Opposite
is --disable-assertions. By default, this flag is on for
- development versions only.
-
- o --with-broken-headers that provides prototypes to replace functions
- not correctly defined in SunOS4 and SCO header files. Its only effect is
- to suppress a few warnings. It is autodetected by default.
+ development versions only.
o --without-latex-config that disables the automatic detection of your
latex configuration. This detection is automatically disabled if
latex cannot be found. If you find that you have to use this
- flag, please report it as a bug.
-
- o --without-liberty suppresses the detection of the -liberty library
- (see the section 'Problems').
+ flag, please report it as a bug.
Compiling and installing LyX
All should be OK ;)
+Since the binaries with debug information tend to be huge (although
+this does not affect the run-time memory footprint), you might want
+to strip the lyx binary. In this case replace "make install" with
+
+ make install-strip
+
BTW: in the images subdirectory there is also a small icon "lyx.xpm",
that can be used to display lyx-documents in filemanagers.
architecture, use `make distclean' before reconfiguring for another
architecture.
-Stripping LyX
--------------
+Preparing a binary distribution for the use of others
+------------------------------------------------------
-A LyX binary for linux is about 1M when compiled without debug-information
-and with dynamic libraries. If yours is much bigger you probably compiled
-it with debug-informations (-g). If you don't want to debug LyX just enter
+ o Compile LyX with the right compiler switches for your
+ architecture. Make sure you use the --without-latex-config switch
+ of configure, since others might not be interested by your
+ configuration :-)
- strip src/lyx
+ o Create a file README.bin describing your distribution and
+ referring to *you* if problems arise. As a model, you can use the
+ file development/tools/README.bin.example, which can be a good
+ starting point.
-before installing. Note that this is done automatically for public
-versions.
+ o Type `make bindist'. This will create a file
+ lyx-1.xx.yy-bin.tar.gz. Rename it to reflect you architecture
+ and the peculiarities of your build (e.g. static vs. dynamic).
+
+ o Check that everything is correct by unpacking the distribution
+ in some private place and running it. In particular, check the
+ output of `ldd lyx' to know which libraries are really needed.
+
+ o Upload your binary file to ftp.devel.lyx.org:/pub/incoming, and
+ notify larsbj@lyx.org.
Problems
notify us.
o If you have problems indicating that configure cannot find a part of
- the xforms or Xpm library, use the --with-extra-lib and --with-extra-inc
- options of configure to specify where these libraries reside.
-
- o Configure will seemingly fail to find xpm.h and forms.h on linux if
- you did a 'make mrproper' in the kernel directory, because this
- removes some symbolic links that are needed for compilation. A 'make
- symlinks' in linux kernel sources fixes that.
-
- o If you have GNU gettext installed on your system (e.g. on linux),
- you will get tons of warnings like:
-
- bullet_forms.C:101: warning: passing `char *' to argument 1 of
- `__builtin_constant_p(int)' lacks a cast
+ the xforms or Xpm library, use the --with-extra-lib and --with-extra-inc
+ options of configure to specify where these libraries reside.
- These are in harmless warnings caused by a bug in libintl.h, but
- will be solved if you use --with-included-gettext when configuring
- LyX.
-
- o It is possible to compile lyx with Digital Unix cxx compiler
- version 6.1 (and presumably compaq C++ 6.2 on both Tru64 unix and
- linux/alpha, when this will be available), provided one uses
- CXX=cxx
- CXXFLAGS='-ptr /tmp/lyx_cxx_repository -std strict_ansi -g -O'
-
- Note that this will not work when compiling directly from the cvs
- repository, due to the tricks used by automake for dependencies. Ask
- Jean-Marc.Lasgouttes@inria.fr for a workaround.
-
- o On Digital Unix with cxx, you may have a compilation error in
- lyx_main.C if you have GNU gettext installed. This is due to a bug
- in gettext. To solve this, you can either (1) configure with
- --with-included-gettext or (2) add -D__STDC__ to cxx flags.
-
- o The configure script seems to hang while it is checking the LaTeX setup.
- We think that this is not a real problem, but rather a symptom of the
- fact that the ec-fonts are being rendered. This process can take quite
- some time, so the remedy is simply to have patience. (The fonts need to
- be rendered at some point to be usable anyways.)
-
- o According to John Collins <collins@phys.psu.edu>, on SunOS 4.1.3 you may
- find two sets of X libraries, and they are of course incompatible :-)
- One is the set provided as part of OpenWindows, and one is the standard
- X distribution (e.g., X11R5). If you encounter problems (or if, for
- some obscure reasons configure cannot find your X libraries) you can
- use the following options:
+ o Configure will seemingly fail to find xpm.h and forms.h on linux
+ if the kernel headers are not available. Two cases are possible:
- o --x-libraries=DIRECTORY that indicates where the X libraries reside.
+ - you have not installed the kernel sources. Then you should
+ install them or at least the kernel-headers package (or
+ whatever it is called in your distribution).
- o --x-includes=DIRECTORY that indicate where the X include files reside.
+ - you have the sources, but you did a 'make mrproper' in the
+ kernel directory (this this removes some symbolic links that
+ are needed for compilation). A 'make symlinks' in linux kernel
+ sources fixes that.
- The standard X11R5 libraries should work when the OpenWindows ones
- don't.
+ o if you are using RedHat Linux 7.x, you must make sure you have the
+ latest updated gcc and related packages installed (at least -85),
+ or LyX will not compile or will be mis-compiled.
- o Some systems lack functions that LyX needs. To fix this, configure
- tries to link against the -liberty library, if it is available.
- If you experience problems with missing symbols at link time, you
- could try to install libiberty.a, which comes with several GNU
- packages (in particular libg++). In any case, please report your
- problems to lyx-devel@lists.lyx.org.
+ o if you get an error message when compiling LyX that looks like this :
- The option --without-liberty disable the detection of -liberty. It
- is meant for debugging purpose only.
+ ../../src/minibuffer.h:17: using directive `Object' introduced
+ ambiguous type `_ObjectRec *'
- o There are several known bugs in gcc 2.7.xx that cause compiler
- errors. This is in particular the case in spellchecker.C under
- HP-UX 9.05 (ask Bernhard Iselborn <biselbor@rhrk.uni-kl.de> for
- more comments) and in lyxrc.C under Linux/Alpha or DEC OSF/1. In
- both cases, the solution is to recompile the offending file
- without optimization and resume the compilation process with
- 'make'.
+ then you need to upgrade the version of the xforms library you have
+ installed.
- o According to David Sundqvist <David_Sundqvist@vd.volvo.se>, some
- changes are needed to compile with aCC on HP-UX 10.20. These are the
- relevant changes in the makefile (with comments tagged on):
+ o On SUN Sparc Solaris 8, you need gnumake. The LyX makefiles do not
+ work with Solaris make.
- CXX = /opt/aCC/bin/aCC
- CXXFLAGS = -O +inst_none # The aCC compiler tries to run instantiations
- # which currently break.
+ The Solaris ar seg-faults trying to build the insets library. You
+ will need to use the ar from the GNU binutils for this subdirectory.
- LIBS = -lforms -lXpm -lSM -lICE -lc -lm -lX11 -lCsup # must link with Csup
- LDFLAGS = -L/opt/aCC/lib # perhaps not needed.
+ o LyX can be compiled on Tru64 Unix with either GNU's gcc or the default
+ Compaq cxx compiler.
+ There are no Alpha-specific problems with gcc.
- o On Digital Unix with gcc, you can get warnings like
+ The following notes all refer to compilation with the Compaq cxx compiler.
-warning, LyXFamilyNames not found in original or external symbol tables, value defaults to 0
-
- These concern symbols beginning with an uppercase letter and seems
- to be harmless. Similarly, the compilation can end with the
- following warning:
-
-/bin/ld:
-Warning: Linking some objects which contain exception information sections
- and some which do not. This may cause fatal runtime exception handling
- problems (last obj encountered without exceptions was ../intl/libintl.a).
-
-
- You can safely ignore it.
+ LyX cannot be compiled on Tru64 Unix 4.0d or 4.0e with the default cxx
+ compiler. You should upgrade to at least cxx V6.2, to be found at
+ ftp::/ftp.compaq.com/pub/products/C-CXX/tru64/cxx/CXX622V40.tar. Users
+ running Tru64 Unix 4.0f and greater should have no real problems compiling
+ LyX.
+ cxx V6.2 will compile LyX out of the box.
+ cxx V6.3-020 is also known to work, although there is a bug in
+ /usr/include/cxx/deque that will break compilation in FormPreferences.C.
+ Compaq are investigating, but a patch that works /now/ is:
+
+--- /usr/include/cxx/deque_safe Mon Mar 4 21:09:50 2002
++++ /usr/include/cxx/deque Mon Mar 4 21:09:00 2002
+@@ -570,9 +570,11 @@
+ {
+ if (size() >= x.size())
+ erase(copy(x.begin(), x.end(), begin()), end());
+- else
+- copy(x.begin() + size(), x.end(),
+- inserter(*this,copy(x.begin(),x.begin()+size(),begin())));
++ else {
++ const_iterator mid = x.begin() + difference_type(size());
++ copy(x.begin(), mid, begin());
++ insert(end(), mid, x.end());
++ }
+ }
+ return *this;
+ }
+
+ At the time of writing, cxx V6.5-026 is the latest cxx compiler. It is
+ /not/ recommended. The compiler itself appears to be both buggy and
+ extremely bloated (trebling the size of the stripped LyX binary).
+
+ In order to compile LyX with the cxx compiler, you should run configure
+ with the following flags:
+ CXX='cxx -std strict_ansi'
+ CXXFLAGS='-nopure_cname -nocleanup -ptr /tmp/lyx_cxx_repository -O2'
+ CC='cc -std1'
+ The -nopure_cname flag is needed for compilers V6.3 and above because
+ LyX makes use of functions like popen, pclose that are defined in the
+ c version of <stdio.h> but are not formally part of any c/c++ standard.
+ They are not, therefore, included in the <cstdio> header file.
projects / lyx.git / blobdiff