r5272: *** empty log message ***
[cl-modlisp.git] / doc / readme.html
1 <?xml version="1.0" encoding="iso-8859-1" standalone="yes"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml"><head><title>cl-modlisp readme</title><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /><meta name="Copyright" content="Kevin Rosenberg 2002 &lt;kevin@rosenberg.net&gt;" /><meta name="description" content="cl-modlisp documentation" /><meta name="author" content="Kevin Rosenberg" /><meta name="keywords" content="Common Lisp, mod_lisp, cl-modlisp, apache" /></head><body><h1>cl-modlisp Documentation</h1><h2>Overview</h2><p>cl-modlisp provides the Lisp side of the interface to Marc Battyani's mod_lisp apache module (<a href="http://www.fractalconcept.com">http://www.fractalconcept.com</a>).</p><h2>Features</h2><ul><li>support of AllegroCL, CMUCL, SBCL with sb-thread, and Lispworks.</li><li>listener and worker socket/process management so that shutting down the listener closes all related open sockets and terminates all related proceses.</li><li>support for running multiple command processors on multiple ports.</li><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</tt>.</li><li>Demonstration processor included</li></ul><h2>Prerequisites</h2><ul><li>Apache 1.3.x</li><li>mod_lisp apache module (<a href="http://www.fractalconcept.com">http://www.fractalconcept.com</a>).</li><li>kmrcl library (<a href="http://files.b9.com/kmrcl">http://files.b9.com/kmrcl</a>).</li><li>asdf (<a href="http://www.sf.net/projects/cclan">http://www.sf.net/projects/cclan</a>).</li></ul><h2>Supported Platforms</h2><ul><li>Allegro v6.2</li><li>CMUCL 18e</li><li>Lispworks v4.2</li><li>SBCL 0.8.1 with sb-thread (multi-threading)</li></ul><h2>Quickstart</h2><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><p>If you are not using Debian, you will need to download and install
4 mod_lisp, cl-modlisp, and cl-kmrcl manually.</p></li><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><li>Start your Lisp implementation and load cl-modlisp with<br />(asdf:operate 'asdf:load-op 'modlisp)</li><li>Start the server with<br />(ml:modlisp-start :port 20123)</li><li>Try some demostration pages<br />links http://localhost/fixed.lsp<br />links http://localhost/debug.lsp</li><li>Shutdown the all cl-modlisp servers with<br />(ml:modlisp-stop-all)</li></ul><h2>Usage</h2><p>The demo.lisp file for some examples of using cl-modlisp.</p></body></html>