doc/readme.lml

   1 ;;; -*- Mode: Lisp -*-
   2
   3 (in-package #:lml2)
   4
   5 (html-file-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     (:ul
  33      (:li "Apache 1.3.x")
  34      (:li "mod_lisp apache module ("
  35          ((:a :href "http://www.fractalconcept.com")
  36            "http://www.fractalconcept.com")
  37          ").")
  38      (:li "kmrcl library ("
  39          ((:a :href "http://files.b9.com/kmrcl")
  40            "http://files.b9.com/kmrcl")
  41          ").")
  42      (:li "asdf ("
  43          ((:a :href "http://www.sf.net/projects/cclan")
  44            "http://www.sf.net/projects/cclan")
  45          ")."))
  46
  47     (:h2 "Supported Platforms")
  48     (:ul
  49      (:li "Allegro v6.2")
  50      (:li "CMUCL 18e")
  51      (:li "Lispworks v4.2")
  52      (:li "SBCL 0.8.1 with sb-thread (multi-threading)"))
  53
  54     (:h2 "Quickstart")
  55     (:ul
  56      (:li "The easiest way to install is to use the Debian GNU/Linux operating system. Using the testing or unstable distributions, you can give the command:"
  57      (:p
  58       "apt-get install libapache-mod-lisp cl-modlisp cl-kmrcl")
  59      (:p
  60       "If you are not using Debian, you will need to download and install
  61 mod_lisp, cl-modlisp, and cl-kmrcl manually."))
  62      (:li
  63       "Add something like the below to httpd.conf and then restart apache"
  64       (:br)
  65       "LispServer 127.0.0.1 20123 \"localhost\""
  66       (:br)
  67       "AddHandler lisp-handler .lsp")
  68      (:li
  69       "Start your Lisp implementation and load cl-modlisp with"
  70       (:br)
  71       "(asdf:operate 'asdf:load-op 'modlisp)")
  72      (:li
  73       "Start the server with"
  74       (:br)
  75       "(ml:modlisp-start :port 20123)")
  76      (:li "Try some demostration pages"
  77           (:br)
  78           "links http://localhost/fixed.lsp"
  79           (:br)
  80           "links http://localhost/debug.lsp")
  81      (:li "Shutdown the all cl-modlisp servers with"
  82           (:br)
  83           "(ml:modlisp-stop-all)"))
  84
  85     (:h2 "Usage")
  86     (:p "The demo.lisp file for some examples of using cl-modlisp.")
  87     )))
  88
  89
  90
  91
  92