Structural Informatics Group (SIG) logo
Home | Projects | Demos | Downloads | Publications | Local Info | About Us | New site
Go to the first, previous, next, last section, table of contents.

Entry Format

Each entry is a symbol of some variety that the XLISP system will recognize. The parts of each reference entry include:

Name
This top line gives the name or symbol of the entry. The reference has the entries in alphabetical order.
Type
The entry type may be one of the following:
- function (subr) 
- predicate function (subr) 
- special form (fsubr) 
- reader expansion 
- defined function (closure) 
- defined macro (closure) 
- system variable 
- system constant 
- keyword 
- object 
- message selector 
Location
This line specifies if the entry is built-in to the system or an extension.
Source file
This line specifies the source file where the routine or code associated with the entry resides. If the entry is an extension, it specifies the source file (usually "init.lsp").
Common LISP compatible
This line specifies whether the entry is compatible with the defintion of Common LISP. There are four levels:
yes     - compatible with Common LISP.
similar - compatible, some differences.
related - related, major differences. 
no      - not compatible. 
Supported on
This line specifies machine dependencies. A few features are available only on PCs or on Macintoshes. (Note that I have not included the Macintosh specific graphics commands.)
Syntax
This area defines the syntax or usage of the entry. It is also used to specify the arguments. Items that are enclosed between a < and a > are arguments. Items enclosed between [ and ] are optional entries. Items that have ... (ellipses) indicate that there can be one or many of the item. Items enclosed between { and } which are separated by | indicate that one of the items should be included.
Description
This defines the entry, necessary conditions, results, defaults, etc.
Examples
This area shows example uses of the entry.
Comments
This area includes additional information such as compatibility notes, bugs, usage notes, potential problems, keystroke equivalences, etc.

Go to the first, previous, next, last section, table of contents.