X-Git-Url: http://git.kpe.io/?a=blobdiff_plain;f=doc%2Freadme.lml;h=8a54a53bbb036fe8f7ae9947276d07bc4f1c2e32;hb=3cd1fc37754064befbc4e5e9050ed8849da3ce09;hp=555c8f9c730549c191d01fa044315c73dfaed9bd;hpb=63692ebce9ef563cc6f04422399397b5d796efe8;p=cl-modlisp.git diff --git a/doc/readme.lml b/doc/readme.lml index 555c8f9..8a54a53 100644 --- a/doc/readme.lml +++ b/doc/readme.lml @@ -2,7 +2,7 @@ (in-package #:lml2) -(page ("readme") +(html-file-page ("readme") (html (:head (:title "cl-modlisp readme") @@ -20,66 +20,72 @@ ((:a :href "http://www.fractalconcept.com") "http://www.fractalconcept.com") ").") (:h2 "Features") - (ul - (li "support of AllegroCL, CMUCL, SBCL with sb-thread, and Lispworks.") - (li "listener and worker socket/process management so that shutting down the listener closes all related open sockets and terminates all related proceses.") - (li "support for running multiple command processors on multiple ports.") - (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 " + (:ul + (:li "support of AllegroCL, CMUCL, SBCL with sb-thread, and Lispworks.") + (:li "listener and worker socket/process management so that shutting down the listener closes all related open sockets and terminates all related proceses.") + (:li "support for running multiple command processors on multiple ports.") + (: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 " (:tt "with-ml-page") ".") - (li "Demonstration processor included")) + (:li "Demonstration processor included")) (:h2 "Prerequisites") - -REREQUISITES ------------- + (:ul + (:li "Apache 1.3.x") + (:li "mod_lisp apache module (" + ((:a :href "http://www.fractalconcept.com") + "http://www.fractalconcept.com") + ").") + (:li "kmrcl library (" + ((:a :href "http://files.b9.com/kmrcl") + "http://files.b9.com/kmrcl") + ").") + (:li "asdf (" + ((:a :href "http://www.sf.net/projects/cclan") + "http://www.sf.net/projects/cclan") + ").")) + + (:h2 "Supported Platforms") + (:ul + (:li "Allegro v6.2") + (:li "CMUCL 18e") + (:li "Lispworks v4.2") + (:li "SBCL 0.8.1 with sb-thread (multi-threading)")) + + (:h2 "Quickstart") + (:ul + (: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:" + (:p + "apt-get install libapache-mod-lisp cl-modlisp cl-kmrcl") + (:p + "If you are not using Debian, you will need to download and install +mod_lisp, cl-modlisp, and cl-kmrcl manually.")) + (:li + "Add something like the below to httpd.conf and then restart apache" + (:br) + "LispServer 127.0.0.1 20123 \"localhost\"" + (:br) + "AddHandler lisp-handler .lsp") + (:li + "Start your Lisp implementation and load cl-modlisp with" + (:br) + "(asdf:operate 'asdf:load-op 'modlisp)") + (:li + "Start the server with" + (:br) + "(ml:modlisp-start :port 20123)") + (:li "Try some demostration pages" + (:br) + "links http://localhost/fixed.lsp" + (:br) + "links http://localhost/debug.lsp") + (:li "Shutdown the all cl-modlisp servers with" + (:br) + "(ml:modlisp-stop-all)")) + + (:h2 "Usage") + (:p "The demo.lisp file for some examples of using cl-modlisp.") + ))) -1. Apache 1.3.x -2. mod_lisp apache module (http://www.fractalconcept.com) -3. kmrcl library (http://files.b9.com/kmrcl) -4. asdf (http://www.sf.net/projects/cclan) - - -SUPPORTED PLATFORMS -------------------- - Allegro v6.2 - Lispworks v4.2 - SBCL 0.8.1 with sb-thread (multitasking) - CMUCL 18e - - -QUICKSTART ----------- - -1. 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: - apt-get install libapache-mod-lisp cl-modlisp cl-kmrcl - -If you are not using Debian, you will need to download and install -mod_lisp, cl-modlisp, and cl-kmrcl manually. - -2. Add something like the below to httpd.conf and then restart apache - LispServer 127.0.0.1 20123 "localhost" - AddHandler lisp-handler .lsp - -3. Start your Lisp implementation and load cl-modlisp with - (asdf:operate 'asdf:load-op 'modlisp) - -4. Start the server with - (ml:modlisp-start :port 20123)) - -5. Try some demostration pages - lynx http://localhost/fixed.lsp - lynx http://localhost/debug.lsp - -6. Shutdown the all cl-modlisp servers with - (ml:modlisp-stop-all) - - -USAGE ------ - -Return to the demo.lisp file for some examples of using cl-modlisp.