doc/readme.lml

   1 ;;; -*- Mode: Lisp -*-
   2
   3 (in-package #:lml2)
   4
   5 (page ("readme")
   6   (html
   7    (:head
   8     (:title "cl-modlisp readme")
   9     ((:meta :http-equiv "Content-Type" :content "text/html; charset=iso-8859-1"))
  10     ((:meta :name "Copyright" :content "Kevin Rosenberg 2002 <kevin@rosenberg.net>"))
  11     ((:meta :name "description" :content "cl-modlisp documentation"))
  12     ((:meta :name "author" :content "Kevin Rosenberg"))
  13     ((:meta :name "keywords" :content "Common Lisp, mod_lisp, cl-modlisp, apache")))
  14
  15    (:body
  16     (:h1 "cl-modlisp Documentation")
  17     (:h2 "Overview")
  18     (:p
  19      "cl-modlisp provides the Lisp side of the interface to Marc Battyani's mod_lisp apache module ("
  20      ((:a :href "http://www.fractalconcept.com") "http://www.fractalconcept.com")
  21      ").")
  22     (:h2 "Features")
  23     (ul
  24      (li "support of AllegroCL, CMUCL, SBCL with sb-thread, and Lispworks.")
  25      (li "listener and worker socket/process management so that shutting down the listener closes all related open sockets and terminates all related proceses.")
  26      (li "support for running multiple command processors on multiple ports.")
  27      (li "transparent support for precomputing the HTML or XML response to take advantage of HTTP/1.1's Keep-Alive feature. This is switchable with a single keyword argument to the macro "
  28          (:tt "with-ml-page")
  29          ".")
  30      (li "Demonstration processor included"))
  31     (:h2 "Prerequisites")
  32
  33 REREQUISITES
  34 ------------
  35
  36 1. Apache 1.3.x
  37 2. mod_lisp apache module (http://www.fractalconcept.com)
  38 3. kmrcl library (http://files.b9.com/kmrcl)
  39 4. asdf (http://www.sf.net/projects/cclan)
  40
  41
  42 SUPPORTED PLATFORMS
  43 -------------------
  44   Allegro v6.2
  45   Lispworks v4.2
  46   SBCL 0.8.1 with sb-thread (multitasking)
  47   CMUCL 18e
  48
  49
  50 QUICKSTART
  51 ----------
  52
  53 1. The easiest way to install is to use the Debian GNU/Linux operating
  54 system. Using the testing or unstable distributions, you can give the
  55 command:
  56    apt-get install libapache-mod-lisp cl-modlisp cl-kmrcl
  57
  58 If you are not using Debian, you will need to download and install
  59 mod_lisp, cl-modlisp, and cl-kmrcl manually.
  60
  61 2. Add something like the below to httpd.conf and then restart apache
  62       LispServer 127.0.0.1 20123 "localhost"
  63       AddHandler lisp-handler .lsp
  64
  65 3. Start your Lisp implementation and load cl-modlisp with
  66    (asdf:operate 'asdf:load-op 'modlisp)
  67
  68 4. Start the server with
  69       (ml:modlisp-start :port 20123))
  70
  71 5. Try some demostration pages
  72       lynx http://localhost/fixed.lsp
  73       lynx http://localhost/debug.lsp
  74
  75 6. Shutdown the all cl-modlisp servers with
  76      (ml:modlisp-stop-all)
  77
  78
  79 USAGE
  80 -----
  81
  82 Return to the demo.lisp file for some examples of using cl-modlisp.
  83
  84
  85
  86