This directory tree contains the documentation for Elk as troff source
and PostScript hardcopy files.

You need a troff and the ms macro package to build the documentation
from the troff source (see the Makefile in each subdirectory).  The
files ending in .ps are pre-generated PostScript files; you can send
them directly to a PostScript printer or browse them with a PostScript
previewer.  The PostScript file have been generated with GNU groff.

As a courtesy to our US audience, the PostScript files are in US
letter format.  If you don't like this (and your groff default is A4),
deactivate the ".pl 11i" directives in tmac/tmac.scheme,
paper/paper.tr, and man/elk.1 (i.e. insert a comment token before it)
and rebuild the document(s).


kernel/    The Elk Reference Manual.  It documents the functionality
	   of the interpreter kernel.

paper/     A paper about Elk that has been accepted for publication in
	   USENIX Computing Systems.

man/       In this directory you find a small manual page for the
           interpreter to be installed in the `/usr/man' directory on
	   your system.  The manual page essentially describes the
	   command line options of the interpreter.

xlib/      The reference manual for the Xlib extension to Elk.

xt/        The reference manual for the Xt (X11 Toolkit Intrinsics)
	   extension to Elk.

unix/      The reference manual for the UNIX extension.

record/    The reference manual for the record extension.

bitstring/ The reference manual for the bit string extension.

oops/      A manual for the simple object oriented programming tool
	   that is available as `oops.scm'.

ex/        Here you find a tutorial that explains the steps necessary
	   in integrating an application with Elk or in writing an
	   extension to Elk.  It covers subjects such as the definition
	   of new Scheme data types and procedures, garbage collection,
	   and mapping of C types to Scheme types and vice versa.
	   Parts of this document are somewhat outdated and may no longer
	   reflect all the details of the current release of Elk; see
	   `paper' for up-to-date information.

tmac/      A collection of troff macro files and other utilities needed
	   to typeset the documentation in the above directories.
