home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / plbin.zip / pl / README < prev    next >
Text File  |  1993-02-17  |  4KB  |  142 lines
  1.             SWI-Prolog Distribution Directory
  2.  
  3. ** Last update: Fri Dec 18 13:57:18 1992 (1.6.7)
  4.  
  5. AUTHOR
  6. ======
  7.     Jan Wielemaker
  8.     SWI
  9.     University of Amsterdam
  10.     Roetersstraat 15
  11.     1018 WB  Amsterdam
  12.     The Netherlands
  13.     E-mail: jan@swi.psy.uva.nl
  14.  
  15. DIRECTORIES
  16. ===========
  17.  
  18. The SWI-Prolog source tree consists of the following directories:
  19.  
  20. ./src        C sources
  21. ./src/gnu    GNU-Emacs unexec() sources (MODIFIED VERSION)
  22. ./boot        Prolog system predicates defined in Prolog
  23. ./library    Prolog user's library
  24. ./include    Include files.  Mostly for handling foreign-code
  25. ./man        Manual (LaTeX)
  26. ./lisp        GNU-Emacs Lisp sources for a better Prolog-mode
  27. ./dld-3.2    Wilson Ho's `dynamic link editor' (SUN and VAX only)
  28.         (MODIFIED VERSION)
  29.  
  30.  
  31. BUILDING SWI-Prolog
  32. ===================
  33.  
  34. Using gcc
  35.  
  36. The C-compiler used for some architecture is defined in md-<machine.h>
  37. using the macro M_CC
  38.  
  39. When available, please use  the GNU-C  compiler gcc.    SWI-Prolog has
  40. been developed with this  compiler.  Do not use  version 2.0,  as this
  41. compiler crashes on pl-wam.c. Version 2.1 is ok.  SWI-Prolog makes use
  42. of  GCC-2's  facilities    to deal with   label   addresses, improving
  43. performance with about 10%.
  44.  
  45.  
  46. Building
  47.  
  48. First,  make a  directory for  the  specified machine  using the SETUP
  49. script.  The argument to SETUP describes the machine you  are running.
  50. This machine is described in the file src/md-MACHINE.h.  To get a list
  51. of architectures run SETUP without arguments.
  52.  
  53. Next, edit config.h:
  54.  
  55. M_SYSTEMHOME    absolute path pointing to this directory
  56. M_DEFSTARTUP    Personal startup file base-name
  57. M_BINDIR    Installation directory for executables
  58. M_PROLOG    Name of the resulting program
  59.  
  60. Next, check src/md-MACHINE.h for things specific to your machine.
  61.  
  62. Next:
  63.     1) cd ./MACHINE
  64.     2) make
  65.  
  66. Installation:
  67.  
  68.     1) cd ./MACHINE
  69.     2) make install
  70.  
  71. Cleanup
  72.  
  73.     1) cd ./MACHINE
  74.     2) make clean
  75.  
  76. Automount filesystems; symbolic links
  77.  
  78. When  the  installation directory is  on  an   automount filesystem or
  79. symbolic  links  provide     multiple  absolute  pathnames   for   the
  80. installation directory, the Unix  environment variable CANONICAL_PATHS
  81. may be set to a ':' separated list of `canonical paths.   For example,
  82. Prolog is installed   in /home/languages/pl.   Typing  'pwd'   in this
  83. directory yields /tmp_mnt/home/languages/pl.  Correct installation may
  84. be achieved by typing
  85.  
  86.     % setenv CANONICAL_PATHS /home/languages/pl
  87.  
  88.  
  89. Prepare for static loading (runtime environment, PCE)
  90.  
  91. When Prolog is to be mixed with  C-code using static  loading (such as
  92. for the graphical environment XPCE), the runtime environment has to be
  93. created.  After the installation, do
  94.  
  95.     1) cd ./MACHINE
  96.     2) make runtime
  97.  
  98.  
  99. GNU-EMACS INTERFACE
  100. ===================
  101.  
  102. In the directory ./lisp, you'll find  an interface to  GNU-EMACS.  The
  103. file README.SWI provides installation directives.  In  consists of the
  104. Quintus  Prolog  gnu-emacs  interface    with   an   additional   file
  105. swi-prolog.el that redefines and adds some things.
  106.  
  107.  
  108. NOTES
  109. =====
  110.  
  111. SunOs 3.x
  112.  
  113. Ancient  users of   SunOs 3.x  should set  the  corresponding  flag in
  114. md-sun3.h. Dynamic stacks are not provided under SunOs 3.x.
  115.  
  116.  
  117. MODIFYING SWI-Prolog
  118.  
  119. You are free to modify SWI-Prolog under the licence terms specified in
  120. the  file LICENCE.  You  may  wish the  other    users can share  your
  121. improvements.  For code   to be  accepted   as part of  the   official
  122. distribution, it should be  written in the same  style as  the rest of
  123. the SWI-Prolog  sources.  I do  not claim  this style  to be  the best
  124. available, but I  want  the entire source to  have a consistent style.
  125. Please document the modifications and  if reasonably possible indicate
  126. them using #if ... #endif.  Please do  not send `diff' files  to me, I
  127. probably do  not have  the same version   of  the sources, so complete
  128. files, with the changes  indicated with #if ...  #endif are  easier to
  129. incorporate.
  130.  
  131. If your change is accepted, you  will be appropriately acknowledged in
  132. the distribution.
  133.  
  134. PROLOG PROGRAMS
  135.  
  136. Additions to the library and   other stand alone Prolog programs  have
  137. less strick   conditions.   Add  comments such  that   other users can
  138. understand the program or library module  and ensure the files provide
  139. sufficient  documentation on its   origin,  waranty and   distribution
  140. conditions.  Such contributions are copied verbatim and not maintained
  141. by me.
  142.