src/COMPILE

   1
   2 -------------------------------------------------------------------------------
   3 Compiling GNU TeXmacs
   4 -------------------------------------------------------------------------------
   5
   6 1. Check dependencies.
   7
   8    Before you compile GNU TeXmacs on your system, you have to make
   9    sure that the other programs on which GNU TeXmacs depends,
  10    namely TeX and Guile Scheme (from the Gnome project)
  11    have been installed correctly. You can do this by checking
  12    whether the latex and guile binaries exists in your path
  13
  14         which latex
  15         which guile
  16
  17    If one of these commands yields an error message,
  18    then look at the webpage doc/html/web/Dependencies.html.
  19
  20 2. Compile, install and run.
  21
  22    GNU TeXmacs supports the standard GNU compilation and
  23    installation procedure. Assuming that you logged yourself
  24    in as root, cd into the installation directory and type
  25
  26         ./configure
  27         make
  28         make install
  29
  30    The first command examines your particular system configuration.
  31    The second command launches the compilation.
  32    The last command installs GNU TeXmacs in /usr/local.
  33
  34    If you get an error when runnig 'make', be sure that you are using
  35    GNU make. You can check the version of make installed on your
  36    system by running 'make -v'. You may freely download GNU make at
  37
  38         ftp://ftp.gnu.org/gnu/make
  39
  40    If everything works fine, then you should be able to run the program by
  41
  42         texmacs &
  43
  44    If this does not work, you should make sure that /usr/local/bin
  45    is in your PATH. Depending on your shell, you can ensure this by typing
  46
  47         export PATH=/usr/local/bin:$PATH
  48    or
  49         setenv PATH /usr/local/bin:$PATH
  50
  51 3. Feedback
  52
  53    Be cool and let us know if you like or dislike the program; see
  54
  55         http://www.texmacs.org
  56
  57    It is very useful for us to have a rough idea about the number of
  58    permanent users and for what applications you are interested in TeXmacs.
  59    Furthermore, we are glad to receive your suggestions and problems,
  60    no matter how silly they may seem to you. If you really like the program,
  61    then please consider donating money or services to us; see
  62
  63         http://www.texmacs.org/Web/Donations.html
  64
  65    Of course, you may also contribute yourself.
  66
  67 -------------------------------------------------------------------------------
  68
  69 Appendix A: Configuration options
  70
  71    If you cannot log yourself in as root, or if you want to install
  72    TeXmacs elsewhere than in /usr/local, then you should use
  73
  74         ./configure --prefix=[target directory]
  75
  76    instead of ./configure. In this case, TeXmacs will be installed in
  77    [target directory] and you will have to set your PATH accordingly,
  78    as to contain [target directory]/bin. You can fine tune the
  79    installation paths with the options
  80
  81    * --bindir=[binary directory]:
  82      sets the directory where the TeXmacs binaries should be installed
  83      ([target directory]/bin, by default).
  84
  85    * --datadir=[data directory]:
  86      sets the directory where other TeXmacs data should be installed
  87      ([target directory]/share, by default).
  88
  89    The configuration script try to pick the best optimization options
  90    for your architecture and compiler. Some versions of g++ have
  91    trouble optimizing TeXmacs and will produce a buggy executable
  92    unless inlining is turned off.
  93
  94    * --disable-optimize
  95      --enable-optimize
  96      --enable-optimize=no-inline
  97      --enable-optimize=[compiler options]:
  98      overrides the (system dependent) default optimization settings.
  99
 100    If you are hacking on TeXmacs, you may want to install an
 101    executable with debugging information.
 102
 103    * --enable-debug
 104      --enable-debug=[compiler options]:
 105      build and install a debugger-enabled executable
 106      (compiler options defaults to -ggdb).
 107
 108    This option specifies a compiler option, disable stripping of the
 109    installed executable and turn optimizations off. The option
 110    --enable-optimization can force optimizations, without a parameter
 111    it will use the architecture dependent default *with inlining*.
 112
 113 Appendix B: Static compilation
 114
 115    By default, we build TeXmacs using dynamically linked libraries.
 116    If you rather want to build the static version, use
 117
 118         make STATIC_TEXMACS
 119
 120 Appendix C: Possible problems
 121
 122    * Everything compiles fine, but you frequently get
 123      a segmentation fault when running the editor.
 124      Solution: This problem may have several causes:
 125      o You don't use a standard version of the GNU C++ compiler.
 126        We use gcc-2.95.3 on a GNU/Linux system on a PC;
 127        the versions 2.95.2 and 1.1.* should also work,
 128        but the optimizer may be bugged in other versions.
 129        Using the --disable-optimize option to ./configure
 130        may produce a more stable, but slower executable.
 131      o You are compiling TeXmacs on a not yet supported system.
 132        Please take a look at configure.in
 133        in order to see whether your system is supported.
 134        If not, please check that the macros WORD_LENGTH,
 135        WORD_LENGTH_INC and WORD_MASK are OK for your system.
 136
 137     * You use Cygwin and you do not manage to get Guile working.
 138       Solution: There may be a problem with the file name
 139       ice-9/and-let*.scm (stars are not allowed in file names),
 140       which should be renamed as ice-9/and-let-star.scm. You should
 141       make the corresponding modifications in ice-9/Makefile.in.
 142       Since you might be unable to extract ice-9/and-let*.scm
 143       from the archive, you can find a copy of it (for guile-1.4)
 144       at http://www.texmacs.org/Data/and-let-star.scm
 145
 146     * You have problems with compiling or linking with X Window.
 147       Solution: modify some of the compilation options in configure.in.
 148
 149     * You have the impression that some of the modifications that you
 150       made in the source are not taken into account when you run make.
 151       Solution: type 'make deps' in order to generate the dependence
 152       files and/or 'rm src/Objects/*' in order to be sure that the
 153       object files are rebuilt.
 154
 155     * You have problems with the font system from TeX when running.
 156       Solution: get a version of TeX with 'kpsepath',
 157       'MakeTeXPK' and 'MakeTeXTFM'.
 158
 159     * TeXmacs runs fine, but certain fonts are not displayed correctly.
 160       Solution: This problem may have several causes:
 161       o You use a recent version (>= 7.3) of RedHat Linux or
 162         one of its clones. On such systems, the installation of
 163         TeTeX is bugged and you need to change some permissions
 164         in order to allow font generation by Metafont.
 165         As root, type
 166           chmod -R a+rw /var/lib/texmf/*
 167       o You do not use a standard TeX/LaTeX distribution, such as TeTeX
 168         (standard distributions come with scripts for generating fonts,
 169         such as 'mktextfm' or 'MakeTeXTFM'). You may either install
 170         a more standard TeX/LaTeX distribution, or download some
 171         pregenerated fonts from texmacs.org.
 172
 173     * If you encounter other problems, or if our fixes don't work, then please
 174       contact us at contact@texmacs.org.