home *** CD-ROM | disk | FTP | other *** search
/ ARM Club 3 / TheARMClub_PDCD3.iso / hensa / programming / clisp / clispdoc / README < prev    next >
Text File  |  1995-01-03  |  5KB  |  199 lines
  1. This is CLISP, a Common Lisp implementation.
  2.  
  3.  
  4. What is LISP?
  5. -------------
  6.  
  7. LISP is a programming language. It was invented by J. McCarthy in 1959.
  8. There have been many dialects of it, but nowadays LISP has been standardized
  9. and wide-spread due to the industrial standard COMMON LISP. There are
  10. applications in the domains of symbolic knowledge processing (AI), numerical
  11. mathematics (MACLISP yielded numerical code as good as FORTRAN), and
  12. widely used programs like editors (EMACS) and CAD (AUTOCAD).
  13. There is an introduction to the language:
  14.  
  15.   Sheila Hughes: Lisp. Pitman Publishing Limited, London 1986.
  16.   107 pages.
  17.  
  18. After a while wou will need the standard text containing the language
  19. definition:
  20.  
  21.   Guy L. Steele Jr.: Common Lisp - The Language. Digital Press.
  22.   1. edition 1984, 465 pages.
  23.   2. edition 1990, 1032 pages.
  24.  
  25. This book is available in HTML form via FTP from
  26.   ftp.cs.cmu.edu:/user/ai/lang/lisp/doc/cltl/cltl_ht.tgz  and
  27.   ma2s2.mathematik.uni-karlsruhe.de:/pub/lisp/CLtL2/cltl_ht.tgz .
  28.  
  29. LISP is run in an interactive environment. You input forms, and they will be
  30. evaluated at once. Thus you can inspect variables, call functions with given
  31. arguments or define your own functions.
  32.  
  33.  
  34. Contents:
  35. ---------
  36.  
  37. It consists of the following files:
  38.  
  39.       lisp             main program
  40.       lispinit.mem     memory image needed for startup
  41.       clisp.1          manual page in Unix man format
  42.       clisp.man        manual page
  43.       clisp.html       manual page in HTML format
  44.       impnotes.txt     implementation notes
  45.       cltl2.txt        notes about the relation of CLISP to CLtL2
  46.       CLOS-guide.txt   brief guide to CLOS
  47.       LISP-tutor.txt   Common LISP hints
  48.       README           this text
  49.       SUMMARY          short description of CLISP
  50.       ANNOUNCE         announcement
  51.       NEWS             list of modifications since the last version
  52.       COPYRIGHT        copyright notice
  53.       GNU-GPL          free software license
  54.       !Run             run file for CLISP
  55.       !Sprites         !clisp icon sprite
  56.       config.lsp       site-dependent configuration
  57.       timezone.lsp     site-dependent time zone
  58.  
  59. and - to your convenience, if you like reading source -
  60.  
  61.       *.lsp            the source of lispinit.mem
  62.       *.fas            the same files, already compiled
  63.  
  64.  
  65. Hardware requirements:
  66. ----------------------
  67.  
  68. This RISC OS version of CLISP requires at least 4MB RAM and RISC OS 3.0 or
  69. higher. A version of CLISP can probably be made that will work on 2MB
  70. Archimedes machines by cutting out some of the optional parts of the Lisp
  71. languages, notably some parts of CLtL2, CLtL2/dpANS-LOOP, CLOS, Conditions
  72. and generic streams. Anyone in need of a cut down system should email me and
  73. I'll make a cutdown version available on ma2s2.mathematik.uni-karlsruhe.de.
  74.  
  75.  
  76. Software requirements:
  77. ----------------------
  78.  
  79. CLISP can be run outside the desktop or from within a task window.
  80.  
  81. Installation:
  82. -------------
  83.  
  84. Edit the contents of config.lsp appropriately for your site,
  85. especially the definitions of short-site-name and long-site-name.
  86. You may also want to edit the time zone definition at the end of
  87. timezone.lsp.
  88. Then start
  89.  
  90.          lisp -M mem.lispinit
  91.  
  92.          or double click on the !Clisp directory.
  93.  
  94. When the LISP prompt
  95.  
  96.       > _
  97.  
  98. appears, type
  99.  
  100.         (cd "<clisp$path>")
  101.  
  102. to make sure the !Clisp directory is the currently selected directory. Then
  103. type
  104.  
  105.         (compile-file "config")
  106.         (load "config")
  107.  
  108. and - in case you modified timezone.lsp -
  109.  
  110.         (compile-file "timezone")
  111.         (load "timezone")
  112.  
  113. and then
  114.  
  115.         (saveinitmem)
  116.  
  117. to overwrite the file lispinit.mem with your configuration. Then
  118.  
  119.         (exit)
  120.  
  121.  
  122.  
  123.  
  124. When you encounter problems:
  125. ----------------------------
  126.  
  127. After errors, you are in the debugger:
  128.  
  129.      1. Break> _
  130.  
  131. You can evaluate forms, as usual. Furthermore:
  132.  
  133.      Help
  134.                calles help
  135.      Abort     or
  136.      Unwind
  137.                climbs up to next higher input loop
  138.      Backtrace
  139.                shows the contents of the stack, helpful for debugging
  140.  
  141. And you can look at the values of the variables of the functions where the
  142. error occurred.
  143.  
  144. On bigger problems, e.g. stack dumps, please send a description of the error
  145. and how to produce it reliably to the authors or the maintainer. Please
  146. accompany it with the CLISP version, which you get by calling
  147. (lisp-implementation-version).
  148.  
  149.  
  150. Mailing List:
  151. -------------
  152.  
  153. There is a mailing list for users of CLISP. It is the proper forum for
  154. questions about CLISP, installation problems, bug reports, application
  155. packages etc.
  156.  
  157. For information about the list and how to subscribe it, send mail to
  158. listserv@ma2s2.mathematik.uni-karlsruhe.de, with the two lines
  159.           help
  160.           information clisp-list
  161. in the message body.
  162.  
  163.  
  164. Acknowledgement:
  165. ----------------
  166.  
  167. We are indebted to
  168.   * Guy L. Steele and many others for the Common Lisp specification.
  169.  
  170.  
  171. Authors:
  172. --------
  173.  
  174.         Bruno Haible                    Michael Stoll
  175.         Augartenstraße 40               Gallierweg 39
  176.     D - 76137 Karlsruhe             D - 53117 Bonn
  177.         Germany                         Germany
  178.  
  179. Email: haible@ma2s2.mathematik.uni-karlsruhe.de
  180.  
  181. Acorn RISC OS Port by:
  182. ----------------------
  183.  
  184.         Peter Burwood
  185.         205 Masons Avenue
  186.         Harrow
  187.         Middlesex
  188.         HA3 5AZ
  189.         England
  190.  
  191. Email: clisp@arcangel.demon.co.uk
  192.  
  193. Maintainer:
  194. -----------
  195.  
  196.         Marcus Daniels
  197.  
  198. Email: marcus@ee.pdx.edu
  199.