		       INSTALLATION GUIDE TO MALAGA 4.3
		       Bjrn Beutel, September 17th, 1998

Malaga has been developed on Unix workstations of the HP 9000 Series 700 using
a GNU-C-Compiler, but it should be easily portable on every other Unix computer
on which an ANSI/ISO-C-Compiler is running. Malaga also runs on Intel 80x86 PCs
running Linux, and on Sun workstations.

We have developed an additional interface to the editor Emacs, written in Emacs
Lisp. We recommend to use Malaga together with Emacs, because this makes
working with Malaga much easier.

For presentation of analysis data, we have developed programs in TCL/Tk (a
script language). These programs are needed for the visualisation of the
analysis data. Please install TCL, version 7.5 or 7.6, and Tk, version 4.1 or
4.2, on your computer system.


= Directories and Files of the Malaga Package =================================

The Malaga package currently consists of the following files and
directories:

 "CHANGES.txt": Information about changes in the recent version of the Malaga
   package.

 "INSTALL.txt": This installation guide.

 "LICENSE.txt": The GNU General Public License.
  
 "Makefile": A file for the command "make" to create the executable files of
   Malaga automatically.

 "configure.in", "configure", "config.sub", "config.guess", "install-sh":
   Files needed for the automatic configuration process. "configure.in" is
   an input file for "autoconf" (by Cygnus), "configure" is the related output
   file, a shell script which detects the configuration of your computer.

 "bin": This directory takes the executable files "malaga", "mallex", "malrul",
   "malmake" and "malsym". The executables are not included in the package, you
   must compile the source files to get them. The source files are in the 
   directory "source".
  
 "doc": This directory contains the LaTeX documentation file for Malaga, namely
   "malaga.tex".
  
 "grammars": Some Malaga sample grammars. Each Grammar has a project file 
   (ending in ".pro"). If you want to test a grammar, change to the 
   corresponding directory, enter the command "malmake <project_file" to
   translate the grammar's source files into executables and finally start 
   malaga by entering "malaga <project_file>".
   Do not forget to add the ending ".pro" to the project file name.
   If you are working with Emacs, you can translate a grammar by typing 
   "M-x malmake" (then you'll be asked for the project file name), and you
   can test it by entering "M-x malaga" (enter the project file name again).
  
   There are several subdirectories for the sample grammars:
  
   "grammars/formal": Some formal grammars that only differ in their
     morphology rule files (the files ending in ".mor"). They are:

     "formal1.pro": A grammar for all words that consist of n "a"s and n "b"s
       behind and any number of "c"s spread in anywhere in the word.

     "formal2.pro": A grammar for all words that consists of
       k "a"s, followed by l "b"s, followed by m "c"s, where m = k or m = l.

     "formal3.pro: A grammar for all non-empty words that consist of as many 
        "a"s as "b"s.

     "formal4.pro": A grammar for all words that consists of k "a"s, followed
       by l "b"s, followed by m "c"s, where m = max{k, l}.

     "formal5.pro": A grammar for all non-empty palindromes built of the 
       letters "a" and "b".

     "formal6.pro": A grammar for all words that consist of alternating blocks
       of "a"s and "b"s, where each block must be as least as long as the one
       before.

     "formal7.pro": A grammar for all words that consists of n*n "a"s, where
       n may be any cardinal number.

     "formal8.pro": A grammar for all words that consist of a letter sequence
       built of "a", "b", "c", "d" and "e", which is written twice.
    
  "grammars/german": A syntax grammar named "german.pro" that recognises a 
    small subset of German sentences. It uses a small full form lexicon.
    The directory also contains a file "sentences", which is a list of German
    sentences that are recognised by the grammar. The Grammar also returns
    information about the sentence structure.
    The Grammar can handle alternative valency frames, separate verb prefixes,
    perfekt forms, adverbial subclauses and some other features.
    
  "grammars/numeral": The grammar "numeral.pro" recognises English numerals. 
    It returns the numbers they stand for.

 "lib": This is the place where the library "libmalaga" will be kept 
   (the source text is in "malaga/source").
  
 "malaga.el": An Emacs Lisp file which supports working with Malaga from Emacs.
  
 "source": The source text for the library "libmalaga", for the programs 
   "malaga", "malrul", "mallex", "malmake", and "malsym", and for the dynamic
   TCL/Tk library "libmatrix". A Makefile is also included here.
  
 "tcl": Contains the TCL/Tk program "display.tcl" that can display analysis
   trees, analysis results and Malaga variables.
   Furthermore, the TCL/Tk package "libmatrix", which can display Malaga
   values in a two-dimensional format, will be put in this directory.  The
   source files for "libmatrix" are located in "source".

  
= Installing Malaga, Step by Step =============================================

1. All the files you need to install Malaga are stored in a file called
   "malaga-4.3.tar.gz". Move to the directory where you want tho create the
   Malaga directory, copy the file "malaga-4.3.tar.gz" to this directory and
   enter the following commands to unpack the original files:

     gunzip malaga-4.3.tar.gz
     tar xf malaga-4.3.tar

   You will now discover a new directory "malaga-4.3" which contains all 
   directories and files you need.
 
2. Enter the command "./configure". Your system will be checked and the 
   Makefile for compilation will be adapted accordingly.
 
3. Enter the command "make". The Malaga source files will be translated and the
   executables will be linked.
  
4. Edit your startup-script (".profile" or ".login" in your home directory):
   Add an environment variable $(MALAGA) which contains the path of the
   directory of the Malaga package.
   Add the directory "$(MALAGA)/bin" to your path variable, so the
   executable Malaga files will be found.

5. If you want to use the TCL/Tk program to display variables and analysis
   trees, create a file ".malaga" in your home directory that contains the
   following line:

   malaga: set display "wish $(MALAGA)/tcl/display.tcl"

6. If you are using Emacs, add the line

   (require 'malaga (concat (getenv "MALAGA") "/malaga.el"))

   to the file ".emacs" in your home directory, so the Malaga extensions will
   be loaded automatically if you are starting Emacs.

= end of file =================================================================
