spuds

persistent, user code inclusive, documentation server for linux

This library creates, uses and manages a persistent documentation server on a single port.
In addition to serving all Prolog library code as per doc_server/1, spuds/1 also serves installed packs and all user code declared as such, on the same server.

highlights

• manage the server from within Prolog
• provides facilities for loading comments from user's code
• includes documentation for installed packs
• single predicate (spuds/1) can be used as a entry point
• since 0.1.0, spuds works with SWI's server facilities- library(http/http_unix_daemon)

This library has been developed and (only) tested on linux systems.
It is likely it will work on MacOS with small modifications.

installation

It is highly recommended that you install from within SWI using its package manager.
To install simply do:

?- pack_install(spuds).

And then load by :
?- [library(spuds)].

A unix process server can be set to start at boot time, (see spuds(server/swipl-spuds)).

This library depends for some of its functionality on: os_sub

materials

module documentation: spuds.html
sources: spuds

author

Nicos Angelopoulos
---
London
November, 2013