l3gui/INSTALL

   1 Updated instructions are found at
   2
   3     http://l3lang.sourceforge.net/
   4
   5 in the "Installation" section.  Below is the text version.
   6
   7
   8
   9 5 Installation
  10 ===============
  11 The raw files are available from the sourceforge [project] page, but
  12 read the following before installing.
  13
  14 l3lang and l3gui are separate packages, with different prerequisites.
  15
  16 l3lang only requires Python (2.4 or newer) and is  therefore trivial
  17 to install.
  18
  19 l3gui requires l3lang, Python, pygtk (2.4 or newer), libgnomecanvas,
  20 and the canvas part of the gnome-python binding.
  21 In recent linux distributions, these are available via the package
  22 handling system; follow the [system] installation steps.
  23
  24 For older or customized systems, use the self-contained [alternate installation] method.
  25
  26 (INVISIBLE)
  27
  28 5.1 Using system libraries
  29 --------------------------
  30
  31 * Prerequisites
  32   Newer releases of linux and FreeBSD make the prequisites available via
  33   simple commands.  First install these prerequisites, then install L3.
  34
  35   - Fedora core
  36
  37       yum install  gnome-python2-canvas
  38
  39   - Ubuntu / Debian
  40
  41      apt-get install  python-gnomecanvas
  42
  43
  44
  45 * Download L3
  46   To install l3 proper, download [l3lang-0.3.1.tar.gz] and [l3gui-0.3.1.tar.gz], extract
  47   them, and run setup.py.  The download steps using the shell are:
  48       cd /tmp
  49       wget http://cci.lbl.gov/~hohn/l3lang-0.3.1.tar.gz
  50       wget http://cci.lbl.gov/~hohn/l3gui-0.3.1.tar.gz
  51       tar zxf l3lang-0.3.1.tar.gz
  52       tar zxf l3gui-0.3.1.tar.gz
  53
  54
  55 * Install L3
  56   Installation can be to system directories, a local directory, or l3
  57   can be run from the distribution directory without installation.
  58   Choose *one*    of the following.
  59
  60   + System installation
  61     System installation is done via
  62         cd l3lang-0.3.1
  63         python setup.py install --record INSTALLED-FILES
  64         cd ../l3gui
  65         python setup.py install --record INSTALLED-FILES
  66     but requires root access.
  67
  68   + Installation to prefix
  69     Installation to a local directory is supported; the minimal
  70     shell setup for bash/ksh for using a local directory
  71     =$HOME/linux-local= with Python 2.4 is:
  72        export PYVERSION=2.4
  73        export MYPREFIX=$HOME/linux-local
  74        export PATH=$MYPREFIX/bin:$PATH
  75        export PYTHONPATH=$MYPREFIX/lib/python${PYVERSION}/site-packages:$PYTHONPATH
  76        export MANPATH=$MYPREFIX/man:$MYPREFIX/share/man:$MANPATH
  77
  78     followed by installation via
  79        cd l3lang-0.3.1
  80        python setup.py  install --prefix=$MYPREFIX --record INSTALLED-FILES
  81        cd ../l3gui-0.3.1
  82        python setup.py  install --prefix=$MYPREFIX --record INSTALLED-FILES
  83
  84     (INVISIBLE)
  85   + Use without installation
  86     The minimalistic adjustments are to ignore the installation step and only set
  87     the PATH, PYTHONPATH, and MANPATH:
  88        export PYTHONPATH=`pwd`/l3gui:`pwd`/l3lang:$PYTHONPATH
  89        export PATH=`pwd`/l3gui/bin:`pwd`/l3lang/bin:$PATH
  90        export MANPATH=`pwd`/l3gui/doc/man:`pwd`/l3lang/doc/man:$MANPATH
  91     This requires removing the version number:
  92        mv l3lang-0.3.1 l3lang
  93        mv l3gui-0.3.1 l3gui
  94        chmod a+x l3lang/bin/*    l3gui/bin/*
  95
  96 * Quick test
  97   Once installed, a quick installation check can be done by reading the
  98   documentation and running the toplevel:
  99      man l3
 100      man l3gui
 101      l3
 102   Or run the gui via
 103      l3gui
 104
 105   (INVISIBLE)
 106
 107 5.2 Self-contained installation
 108 -------------------------------
 109 An installer based on [GARNOME] (itself based on the [linux-bbc] gar build
 110 setup) is available.  This provides a local environment for using /
 111 incorporating other packages outside the system's package handler
 112 (rpm/dpkg/pkg_add), which is particularly useful for
 113 -   older linux/UNIX versions lacking the gtk/gnome canvas;
 114 -   a self-contained installation to a local directory, including
 115     environment-setting scripts and other niceties;
 116 -   multiple independent development trees.
 117
 118 This installer is used for the [sparx] project that l3 is part of and
 119 contains rules for many more packages, but
 120 installation of the L3 subset is simple.
 121
 122 Installation from source can be done as follows.
 123
 124 First:
 125
 126     mkdir /your/installer/path
 127     cd /your/installer/path
 128
 129 Then, preferably:
 130
 131     svn co svn://cci.lbl.gov/sparx-installer/trunk \
 132         sparx-installer
 133
 134 If you do not have subversion, and don't mind reinstalling everything
 135 occasionally, you can instead use this:
 136
 137     wget http://cci.lbl.gov/~hohn/sparx-installer.tar.gz
 138     tar zxvf sparx-installer.tar.gz
 139
 140 If you don't have wget, try curl instead:
 141
 142     curl http://cci.lbl.gov/~hohn/sparx-installer.tar.gz -o sparx-installer.tar.gz
 143
 144 Then:
 145     cd sparx-installer
 146     ./configure /your/sparxroot
 147
 148 The last step (./configure) will print a summary. If there are any
 149 errors, your system is missing the listed prerequisite(s).
 150
 151 The install is done via
 152     cd sparx/l3gui
 153     make install
 154
 155 When run successfully, this takes between 1.5 and 2.5 hours,
 156 depending on the machine used.
 157
 158
 159