summaryrefslogtreecommitdiff
path: root/third-party/s-sysdeps/doc
diff options
context:
space:
mode:
Diffstat (limited to 'third-party/s-sysdeps/doc')
-rw-r--r--third-party/s-sysdeps/doc/API.html19
-rw-r--r--third-party/s-sysdeps/doc/index.html203
2 files changed, 222 insertions, 0 deletions
diff --git a/third-party/s-sysdeps/doc/API.html b/third-party/s-sysdeps/doc/API.html
new file mode 100644
index 0000000..1e0581e
--- /dev/null
+++ b/third-party/s-sysdeps/doc/API.html
@@ -0,0 +1,19 @@
+<html><head><title>S-SYSDEPS</title></head><body><h3>API for package S-SYSDEPS</h3>
+<blockquote>S-SYSDEPS is an abstraction layer over platform dependent functionality</blockquote>
+<p>(<b>all-processes</b>)&nbsp;&nbsp;&nbsp;<i>function</i></p>
+<blockquote>Return a list of all processes currently running</blockquote>
+<p>(<b>current-process</b>)&nbsp;&nbsp;&nbsp;<i>function</i></p>
+<blockquote>Return the object representing the current process</blockquote>
+<p>(<b>kill-process</b> process)&nbsp;&nbsp;&nbsp;<i>function</i></p>
+<blockquote>Kill the process represented by the object process</blockquote>
+<p>(<b>make-process-lock</b> name)&nbsp;&nbsp;&nbsp;<i>function</i></p>
+<blockquote>Create a named process lock object</blockquote>
+<p>(<b>open-socket-stream</b> host port)&nbsp;&nbsp;&nbsp;<i>function</i></p>
+<blockquote>Create and open a bidirectional client TCP/IP socket stream to host:port</blockquote>
+<p>(<b>run-process</b> name function &rest arguments)&nbsp;&nbsp;&nbsp;<i>function</i></p>
+<blockquote>Create and run a new process with name, executing function on arguments</blockquote>
+<p>(<b>start-standard-server</b> &key port name connection-handler)&nbsp;&nbsp;&nbsp;<i>function</i></p>
+<blockquote>Start a server process with name, listening on port, delegating to connection-handler with stream as argument</blockquote>
+<p>(<b>with-process-lock</b> (lock) &body body)&nbsp;&nbsp;&nbsp;<i>function</i></p>
+<blockquote>Execute body wih the process lock grabbed, wait otherwise</blockquote>
+<font size=-1><p>Documentation generated by <a href="http://homepage.mac.com/svc/lispdoc/">lispdoc</a> running on LispWorks</p></font></body></html> \ No newline at end of file
diff --git a/third-party/s-sysdeps/doc/index.html b/third-party/s-sysdeps/doc/index.html
new file mode 100644
index 0000000..b7109b2
--- /dev/null
+++ b/third-party/s-sysdeps/doc/index.html
@@ -0,0 +1,203 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<title>S-SYSDEPS</title>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+<meta name="description" content="S-SYSDEPS is an abstraction layer over implementation dependent functionality" />
+<meta name="keywords" content="sysdeps, common lisp, lisp, portability" />
+<meta name="author" content="Sven Van Caekenberghe" />
+<meta name="Copyright" content="Copyright (c) 2004-2005 Sven Van Caekenberghe, Beta Nine BVBA" />
+<style type="text/css">
+body {
+ background: white;
+ width: 900px;
+ font-family: Verdana, Arial, Helvetica, sans-serif;
+ font-size: 13px;
+}
+p {
+ width: 600px;
+ padding: 0 20px 10px 50px;
+}
+ul {
+ width: 600px;
+ padding: 0 5px 5px 70px;
+}
+.author {
+ padding: 0 20px 5px 50px;
+ font-style: italic;
+}
+.figure {
+ margin-top: 0;
+ margin-bottom: 0;
+ background: black;
+ color: white;
+ text-align: center;
+ padding: 20px 0 10px 0;
+}
+.listing {
+ background: #eee;
+ font-size: 12px;
+ padding-left: 10px;
+}
+.caption {
+ margin-top: 5px;
+ text-align: center;
+ font-size: 10px;
+ font-style: bold;
+}
+.footer {
+ font-size: 10px;
+ font-style: italic;
+}
+</style>
+</head>
+<body>
+<h3>Open Source Common Lisp Software</h3>
+<h1>S-SYSDEPS</h1>
+<h2>An Abstraction Layer Over Platform Dependent Functionality</h2>
+<p>
+<a href="http://homepage.mac.com/svc/temaplte/index.html">S-SYSDEPS</a>
+is an abstraction layer over platform dependent functionality.
+This simple package is used as a building block in a number of other open source projects,
+as can be seen from this description of some
+<a href="http://homepage.mac.com/svc/oscl.html">other Open Source Common Lisp packages</a>.
+</p>
+<h3>Contents</h3>
+<ul>
+<li><a href="#features">Features</a></li>
+<li><a href="#status">Status</a></li>
+<li><a href="#news">News</a></li>
+<li><a href="#platforms">Platforms</a></li>
+<li><a href="#downloading">Downloading</a></li>
+<li><a href="#installation">Installation</a></li>
+<li><a href="#usage">Usage</a></li>
+<li><a href="#api">API Reference</a></li>
+<li><a href="#mailinglist">Mailinglist</a></li>
+<li><a href="#changelog">Changelog</a></li>
+<li><a href="#tod">TODO</a></li>
+<li><a href="#faq">FAQ</a></li>
+<li><a href="#bugs">Bugs</a></li>
+<li><a href="#authors">Authors</a></li>
+<li><a href="#maintainers">Maintainers</a></li>
+<li><a href="#license">License</a></li>
+<li><a href="#history">History</a></li>
+<li><a href="#references">References</a></li>
+</ul>
+<h3 id="features">Features</h3>
+<p>
+S-SYSDEPS abstracts:
+</p>
+<ul>
+<li>managing processes</li>
+<li>implementing a standard TCP/IP server</li>
+<li>opening a client TCP/IP socket stream</li>
+<li>working with process locks</li>
+</ul>
+<h3 id="status">Status</h3>
+<p>
+S-SYSDEPS is considered stable code.
+</p>
+<h3 id="news">News</h3>
+<p>
+<em>November 2005</em> - Created as a seperate project.
+</p>
+<h3 id="platforms">Platforms</h3>
+<p>
+S-SYSDEPS is, by definition, written in ANSI standard Common Lisp
+but implemented using non-standard extensions.
+At the moment, ports for LispWorks (reference), OpenMCL, CMUCL and SBCL exist.
+Some other CL implementations are partially supported.
+</p>
+<h3 id="downloading">Downloading</h3>
+<p>
+You can download the latested released tarball of the S-SYSDEPS package from
+<a href="http://homepage.mac.com/svc/s-sysdeps/s-sysdeps.tar.gz">http://homepage.mac.com/svc/s-sysdeps/s-sysdeps.tar.gz</a>.
+This archive is signed on release by <a href="http://homepage.mac.com/svc">Sven Van Caekenberghe</a>,
+whose public key is published at
+<a href="http://homepage.mac.com/svc/sven-public-ascii.gpg">http://homepage.mac.com/svc/sven-public-ascii.gpg</a>,
+the signature is in
+<a href="http://homepage.mac.com/svc/s-sysdeps/s-sysdeps.tar.gz.asc">http://homepage.mac.com/svc/s-sysdeps/s-sysdeps.tar.gz.asc</a>.
+</p>
+<p>
+Alternatively you can access the <a href="http://abridgegame.org/darcs/">DARCS</a> repository at
+<a href="http://www.beta9.be/darcs/s-base64">http://www.beta9.be/darcs/s-base64</a>.
+For a good description on how to use DARCS see
+<a href="http://dirkgerrits.com/programming/erlisp/download/">http://dirkgerrits.com/programming/erlisp/download/</a>.
+</p>
+<div class="listing">
+<pre>$ darcs get http://www.beta9.be/darcs/s-sysdeps</pre>
+</div>
+<div class="caption">Example of basic darcs usage, get everything once and keep up to date by pulling in changes</div>
+<h3 id="installation">Installation</h3>
+<p>
+The S-SYSDEPS package is loaded using <a href="http://www.cliki.net/asdf">ASDF</a>.
+There is an excellent <a href="http://constantly.at/lisp/asdf/">tutorial on ASDF</a> to get you started.
+Alternatively you can use <a href="http://www.cliki.net/asdf-install">ASDF-INSTALL</a>.
+There is an great <a href="http://weitz.de/asdf-install/">tutorial on ASDF-INSTALL</a> to get you on the way.
+</p>
+<div class="listing">
+<pre>CL-USER 1 > (asdf:oos 'asdf:load-op :s-sysdeps)</pre>
+</div>
+<div class="caption">Example of setting up and using ASDF to compile and load the package</div>
+<h3 id="usage">Usage</h3>
+<p>
+For usage examples please have a look at the package using S-SYSDEPS.
+</p>
+<h3 id="api">API Reference</h3>
+<p>
+There is automatically generated <a href="API.html">API Reference</a> documentation available for the S-SYSDEPS package.
+</p>
+<h3 id="mailinglist">Mailinglist</h3>
+<p>
+There is no mailing list for this project.
+</p>
+<h3 id="changelog">Changelog</h3>
+<p>
+Release Notes:
+</p>
+<ul>
+<li>release 1: moved S-SYSDEPS into a seperate project under a new structure</li>
+</ul>
+<h3 id="todo">TODO</h3>
+<p>
+Port to even more platforms. Add some unit or functional tests, as well as some examples.
+</p>
+<h3 id="faq">FAQ</h3>
+<p>
+Nothing appropriate.
+</p>
+<h3 id="bugs">Bugs</h3>
+<p>
+There are no known bugs.
+</p>
+<h3 id="authors">Authors</h3>
+<p>
+S-SYSDEPS was written by <a href="http://homepage.mac.com/svc">Sven Van Caekenberghe</a>.
+Ports to CMUCL and SBCL were contributed.
+</p>
+<h3 id="maintainers">Maintainers</h3>
+<p>
+S-SYSDEPS is being maintained by <a href="http://homepage.mac.com/svc">Sven Van Caekenberghe</a>.
+</p>
+<h3 id="license">License</h3>
+<p>
+You are granted the rights to distribute and use this software
+as governed by the terms of the Lisp Lesser General Public License
+(<a href="http://opensource.franz.com/preamble.html">http://opensource.franz.com/preamble.html</a>),
+also known as the LLGPL.
+</p>
+<h3 id="history">History</h3>
+<p>
+This file was part of S-XML-RPC and (N)KPAX.
+</p>
+<h3 id="references">References</h3>
+<p>
+Thera are no references.
+</p>
+<div class="footer">
+Copyright &copy; 2004-2005 Sven Van Caekenberghe, Beta Nine BVBA. All Right Reserved. -
+<a href="http://validator.w3.org/check/referer">This page is W3C Valid XHTML 1.0 Strict</a> -
+<a href="http://www.anybrowser.org/campaign/">Viewable With Any Browser</a>
+</div>
+</body>
+</html>