scsh-install-lib/README

                      scsh installation library

Introduction
------------

This is the scsh installation library, which aims at making it easy to
install extension libraries for scsh.

The complete documentation for this library can be found in
doc/install-lib.pdf. Apart from describing the library itself, this
document also explains how to install and use scsh packages in
general. Reading this document at least once before proceeding further
is strongly recommended.

Notice that this library needs scsh v0.6.6 or newer, and will not
work at all with older versions.


Installation
------------

This library must be installed before any attempt at installing scsh
packages is made.

Since version 1.1, this library installs itself as a scsh package
called "install-lib", and additonally installs a small wrapper script
called "scsh-install-pkg", to install other packages later.

Installation is performed by running the "install.scm" script found in
the same directory as the present file. This script must at least be
provided with the following two parameters:

  --prefix <dir>   prefix directory for the "install-lib" package

  --bindir <dir>   directory in which to install the wrapper script

Other parameters can also be supplied (--help, --layout, --verbose,
--dest-dir, etc.), as explained in the documentation.

The following files are installed:

  <bindir>/scsh-install-pkg

    The script to run in order to install scsh packages. Its use is
    explained in the documentation.

  <prefix>/<scheme_location>/install-lib.scm
  <prefix>/<scheme_location>/install-lib-version.scm
  <prefix>/<scheme_location>/install-lib-module.scm
  <prefix>/<base_location>/load.scm

    The Scheme code for the installation library.

  <prefix>/<doc_location>/pdf/install-lib.pdf

    The documentation describing the installation library, and how to
    manage scsh packages in general.