diff --git a/s48/binary-parse/README b/s48/binary-parse/README index b00b886..75b044e 100644 --- a/s48/binary-parse/README +++ b/s48/binary-parse/README @@ -5,6 +5,19 @@ ] +The structure BINARY-PARSE provides a procedure to read bits from a +byte-stream. + +================================================================================ + +After installation, use the switch + +-lel binary-parse/load.scm + +to load this library. + +================================================================================ + (make-bit-reader byte-reader) -> bit-reader Given a BYTE-READER (a thunk), construct and return a function diff --git a/s48/cml/README b/s48/cml/README index 0c3f416..e1d6f41 100644 --- a/s48/cml/README +++ b/s48/cml/README @@ -5,6 +5,16 @@ This is an implementation of the Concurrent ML event algebra (called rendezvous here) and some of higher-level synchronization abstractions. +================================================================================ + +After installation, use the switch + +-lel cml/load.scm + +to load this library. + +================================================================================ + Currently, you need to check the Concurrent ML docs for more information. diff --git a/s48/concurrency/README b/s48/concurrency/README index 033c42b..9c7b6b6 100644 --- a/s48/concurrency/README +++ b/s48/concurrency/README @@ -1,4 +1,21 @@ -The package semaphores defines semaphores to be used this +This library provides two structures to ease concurrent programming: + +* SEMAPHORES + +* WITH-LOCk + +================================================================================ + +After installation, use the switch + +-lel concurrency/load.scm + +to load this library. + +================================================================================ + + +The structure SEMAPHORES defines semaphores to be used this threads. Semaphores are usually used to control access to a resource by using a counter for the free slots of the resource. diff --git a/s48/continuation-data-type/README b/s48/continuation-data-type/README index 6c183c5..26ba0b9 100644 --- a/s48/continuation-data-type/README +++ b/s48/continuation-data-type/README @@ -1,6 +1,17 @@ -The structure continuation-data-type encapsulates continuations into a +The structure CONTINUATION-DATA-TYPE encapsulates continuations into a data type as proposed by Marc Feeley on the Scheme Workshop 2001. +================================================================================ + +After installation, use the switch + +-lel continuation-data-type/load.scm + +to load this library. + +================================================================================ + + (continuation-capture receiver) -> continuation Captures the current continuation of the expression and applies diff --git a/s48/heap-images/README b/s48/heap-images/README index 45888bf..77a52d4 100644 --- a/s48/heap-images/README +++ b/s48/heap-images/README @@ -2,6 +2,17 @@ The package REINITIALIZERS allows the user to specify code that is executed on every start of scsh, provided a heap image containing the reinitializer is used. +================================================================================ + +After installation, use the switch + +-lel heap-images/load.scm + +to load this library. + +================================================================================ + + Procedures: (make-reinitializer thunk) -> reinitializer diff --git a/s48/module-system/README b/s48/module-system/README index 65c94e3..8edd53e 100644 --- a/s48/module-system/README +++ b/s48/module-system/README @@ -1,3 +1,19 @@ +This library provides two structures that slightly extend Scheme 48's module system: + +* OVERLAPPING-IMPORTS adds checking for duplicate imports. + +* RT-MODULES provides run-time access to the module system. + +================================================================================ + +After installation, use the switch + +-lel module-system/load.scm + +to load this library. + +================================================================================ + The structure OVERLAPPING-IMPORTS extends the module system with a facility to check for duplicates entries within the imported names of a module. After loading the package you can add the form diff --git a/scsh/afs/README b/scsh/afs/README index 4ab2d2f..9b321bb 100644 --- a/scsh/afs/README +++ b/scsh/afs/README @@ -1,6 +1,16 @@ The structure afs-fs calls the fs command to obtain and manipulate access control lists in AFS. +================================================================================ + +After installation, use the switch + +-lel afs/load.scm + +to load this library. + +================================================================================ + The access control list of a directory is represented as an alist of username and the enumerated set afs-permissions. diff --git a/scsh/dir-streams/README b/scsh/dir-streams/README index e2a0eb0..1ddb95c 100644 --- a/scsh/dir-streams/README +++ b/scsh/dir-streams/README @@ -10,6 +10,15 @@ processing but we intend to replace this library with SRFI-40 soon. This is also the reason for the lack of documentation for the STREAM package. +================================================================================ + +After installation, use the switch + +-lel dir-streams/load.scm + +to load this library. + +================================================================================ (dir-stream-from-dir-name dir-name [chase?] [parent]) -> dir-stream diff --git a/scsh/file-mode/README b/scsh/file-mode/README index 78107a9..30a0a4e 100644 --- a/scsh/file-mode/README +++ b/scsh/file-mode/README @@ -1,6 +1,15 @@ The structure FILE-MODE implements a data type for file modes. The code is copied verbatim from Scheme 48 0.57. +================================================================================ + +After installation, use the switch + +-lel file-mode/load.scm + +to load this library. + +================================================================================ A file mode is a boxed integer representing a file protection mask. diff --git a/scsh/interaction/README b/scsh/interaction/README index 0c55dea..2fb2f7c 100644 --- a/scsh/interaction/README +++ b/scsh/interaction/README @@ -9,6 +9,16 @@ a programmatic interface to Scheme 48's debugging facilities: * GC provides a small run-time interface to the garbage collector. +================================================================================ + +After installation, use the switches + +-lel module-system/load.scm -lel interaction/load.scm + +to load this library. + +================================================================================ + The structure REPLS offers procedures to start up the read-eval-print-loop (REPL) from a script. diff --git a/scsh/pps/README b/scsh/pps/README index 3abdd9d..129eb37 100644 --- a/scsh/pps/README +++ b/scsh/pps/README @@ -6,6 +6,17 @@ the version of your system differs from the one I tested. Please report incompatible versions and, if possible, provide an adapted version. +================================================================================ + +After installation, use the switch + +-lel pps/load.scm + +to load this library. + +================================================================================ + + (pps) -> process-info list Calls the ps command and parses the output into a list of process-info diff --git a/scsh/treaps/README b/scsh/treaps/README index 8da39c0..733db8d 100644 --- a/scsh/treaps/README +++ b/scsh/treaps/README @@ -51,6 +51,17 @@ a balanced tree: the expected length of an average search path is roughly 1.4log2(n)-1, and the expected length of the longest search path is about 4.3log2(n). See the Stefan Nilsson's article for more details. +================================================================================ + +After installation, use the switch + +-lel treaps/load.scm + +to load this library. + +================================================================================ + +The structure TREAPS provides the following procedures: (make-treap key-compare) -> treap