CLISP SOURCE(1)                                   CLISP SOURCE(1)



AABBOOUUTT
       The source files for CLISP.



FFIILLEE TTYYPPEESS
       **..dd    The source files for unpreprocessed C code.


       **..cc    The C code after preprocessing by ansidecl.


       **..lliisspp The source files for lisp code.


       **..ffaass  Compiled lisp code (platform-independent).



FFIILLEESS
       Unpreprocessed C code:


           Includes:


               lliissppbbiibbll..dd     main include file

               ffssuubbrr..dd        list of all built-in special forms

               ssuubbrr..dd         list of all built-in functions

               ppsseeuuddooffuunn..dd    list of all "pseudo functions"

               ccoonnssttppaacckk..dd    list of packages accessed by C code

               ccoonnssttssyymm..dd     list of symbols accessed by C code

               ccoonnssttoobbjj..dd     list   of   miscellaneous   objects
                              accessed by C code

               uunniixx..dd         include  file  for unix implementa-
                              tions

               aammiiggaa..dd        include file for Amiga/AmigaOS ver-
                              sion

               aammiiggaa22..dd       second  include file for Amiga/Ami-
                              gaOS version

               mmssddooss..dd        include file for  OS/2  based  ver-
                              sions

               wwiinn3322..dd        include  file  for Win32 based ver-
                              sions

               xxtthhrreeaadd..dd      include file for thread support

               ppoossiixxmmaatthh..dd    POSIX math functions

               ppoossiixxmmiisscc..dd    misc POSIX (system information etc)

               mmoodduulleess..hh      list of foreign modules

               vveerrssiioonn..hh      version of CLISP


           Modules:

               ssppvvww..dd         Memory  management (garbage collec-
                              tion), startup. some OS  interface.

                   aavvll..dd          An implementation of AVL (Adel-
                                  son-Velskii and Landis)  trees.

                   ssoorrtt..dd         A sorting routine.

                   ssuubbrrkkww..dd       list  of all built-in functions
                                  with keywords

               ssppvvwwttaabbff..dd     Table of built-in special forms and
                              functions.

               ssppvvwwttaabbss..dd     Table  of  symbols  accessed  by  C
                              code.

               ssppvvwwttaabboo..dd     Table  of   miscellaneous   objects
                              accessed by C code.

               eevvaall..dd         Evaluator  (form  interpreter)  and
                              bytecode interpreter.

                   bbyytteeccooddee..dd     List of bytecodes.

               ccoonnttrrooll..dd      Special forms (form interpreter).

               ppaatthhnnaammee..dd     Pathnames,  file-  and   directory-
                              related functions.

               ssttrreeaamm..dd       Streams of all kinds: file streams,
                              terminal  stream,  string   streams
                              etc.

               ssoocckkeett..dd       Opening sockets for TCP/IP and CLX.

               iioo..dd           The  lisp   reader   (parser)   and
                              printer (also pretty printer).

               aarrrraayy..dd        Functions  dealing  with arrays and
                              vectors.

               hhaasshhttaabbll..dd     Functions dealing with hash tables.

               lliisstt..dd         Functions dealing with lists.

               ppaacckkaaggee..dd      Functions dealing with packages.

               rreeccoorrdd..dd       Functions   dealing   with  records
                              (structures, closures, etc.)

               sseeqquueennccee..dd     The generic sequence functions.

               cchhaarrssttrrgg..dd     Functions dealing  with  characters
                              and strings.

               ddeebbuugg..dd        Support for debugging and the read-
                              eval-print loop.

               eerrrroorr..dd        Error handling and signalling.

                   eerrrraammiiggaa..dd     AMIGAOS  specific  error   mes-
                                  sages.

                   eerrrruunniixx..dd      Unix specific error messages.

                   eerrrrwwiinn3322..dd     Win32  specific error messages.

               mmiisscc..dd         Miscellaneous functions.

               ttiimmee..dd         Timing functions.

               pprreeddttyyppee..dd     Predicates, type tests.

               ssyymmbbooll..dd       Functions dealing with symbols.

               uunniixxaauuxx..dd      Auxiliary functions  (UNIX  version
                              only).

               wwiinn3322aauuxx..dd     Auxiliary  functions (Win32 version
                              only).

               aammiiggaaaauuxx..dd     Auxiliary functions (Amiga  version
                              only).

               aaccoorrnnaauuxx..dd     Auxiliary  functions  (Acorn/RiscOS
                              version only).

               rreexxxx..dd         Low-level  Rexx  interface   (Amiga
                              version only).

               ggrraapphh..dd        Low-level graphics functions.

               ffoorreeiiggnn..dd      Foreign function interface support.

               lliissppaarriitt..dd     Functions  dealing   with   numbers
                              (arithmetic), see below.

               nnoorreeaaddlliinnee..dd   Replacement    for   GNU   readline
                              library.


           Number system (arithmetic):

               lliissppaarriitt..dd     initialization,   input/output   of
                              numbers, lisp functions

               aarriiddeeccll..dd      declarations

               aarriilleevv00..dd      arithmetic at the machine level

               aarriilleevv11..dd      digit sequences

               aarriilleevv11cc..dd     operations   on   digit  sequences,
                              written in C

               aarriilleevv11ii..dd     operations on digit  sequences,  as
                              inline functions

               aarriilleevv11ee..dd     operations   on   digit  sequences,
                              bindings to external routines

               iinntteelleemm..dd      integers: elementary operations

               iinnttlloogg..dd       integers: logical connectives

               iinnttpplluuss..dd      integers: addition and subtraction

               iinnttccoommpp..dd      integers: comparison

               iinnttbbyyttee..dd      integers:  byte   operations   _l_d_b,
                              _l_o_a_d_-_b_y_t_e, ...

               iinnttmmaall..dd       integers: multiplication

               iinnttddiivv..dd       integers: division

               iinnttggccdd..dd       integers: gcd and lcm

               iinntt22aaddiicc..dd     integers:   operations   on  2-adic
                              integers

               iinnttssqqrrtt..dd      integers: square root, n-th root

               iinnttpprriinntt..dd     subroutines for integer output

               iinnttrreeaadd..dd      subroutines for integer input

               rraattiioonnaall..dd     rational numbers

               ssffllooaatt..dd       elementary  operations  for   short
                              floats

               ffffllooaatt..dd       elementary  operations  for  single
                              floats

               ddffllooaatt..dd       elementary  operations  for  double
                              floats

               llffllooaatt..dd       elementary   operations   for  long
                              floats

               fflloo__kkoonnvv..dd     conversions between floats

               fflloo__rreesstt..dd     general float operations

               rreeaalleelleemm..dd     elementary functions for real  num-
                              bers

               rreeaallrraanndd..dd     random numbers

               rreeaallttrraann..dd     transcendental  functions  for real
                              numbers

               ccoommppeelleemm..dd     elementary  functions  for  complex
                              numbers

               ccoommppttrraann..dd     transcendental  functions  for com-
                              plex numbers


           External routines for the arithmetic  system,  written
           in assembly language:

               aarrii6688000000..dd          written  in  68000  assembler,
                                   MIT syntax

               aarrii6688002200..dd          written  in  68020  assembler,
                                   MIT syntax

               aarriissppaarrcc..dd          written in SPARC assembler

               aarriissppaarrcc6644..dd        written in 64-bit SPARC assem-
                                   bler

               aarrii8800338866..dd          written in i386/i486 assembler

               aarriimmiippss..dd           written in MIPS assembler

               aarriimmiippss6644..dd         written in 64-bit MIPS  assem-
                                   bler

               aarriihhppppaa..dd           written in HPPA-1.0 assembler

               aarriivvaaxxuunniixx..dd        written in VAX assembler, Unix
                                   assembler syntax

               aarriiaarrmm..dd            written in ARM assembler


           External routines for accessing the stack, written  in
           assembly language:

               sspp6688000000..dd           written  in  68000  assembler,
                                   MIT syntax

               ssppssppaarrcc..dd           written in SPARC assembler

               ssppssppaarrcc6644..dd         written in 64-bit SPARC assem-
                                   bler

               sspp8800338866..dd           written in i386/i486 assembler

               ssppmmiippss..dd            written in MIPS assembler



       Other assembly language stuff:

           aassmmii338866..sshh
                  converts  i386  assembler  from MIT syntax to a
                  macro syntax

           aassmmii338866..hhhh
                  expands  i386  assembler  in  macro  syntax  to
                  either MIT or Intel syntax


       Lisp source files:


           iinniitt..lliisspp
                  first file to be loaded, loads everything else

           ddeeffsseeqq..lliisspp
                  defines   the  usual  sequence  types  for  the
                  generic sequence functions

           bbaacckkqquuoottee..lliisspp
                  implements the backquote read macro

           ddeeffmmaaccrroo..lliisspp
                  implements _d_e_f_m_a_c_r_o

           mmaaccrrooss11..lliisspp
                  the most important macros

           mmaaccrrooss22..lliisspp
                  some other macros

           ddeeffss11..lliisspp
                  miscellaneous definitions

           ttiimmeezzoonnee..lliisspp
                  site-dependent definition of time zone,  except
                  for Unix

           ppllaacceess..lliisspp
                  macros using places, definitions of most places

           ffllooaattpprriinntt..lliisspp
                  printing floating point numbers in base 10

           ttyyppee..lliisspp
                  functions working with type specifiers:  _t_y_p_e_p,
                  _s_u_b_t_y_p_e_p

           ddeeffssttrruucctt..lliisspp
                  implements the _d_e_f_s_t_r_u_c_t macro

           ffoorrmmaatt..lliisspp
                  implements _f_o_r_m_a_t

           uusseerr11..lliisspp
                  user interface, from the system's point of view

           uusseerr22..lliisspp
                  user interface, from the user's point of view

           ttrraaccee..lliisspp
                  tracer

           mmaaccrrooss33..lliisspp
                  (optional) the macros _l_e_t_f, _l_e_t_f_* and _e_t_h_e.

           ccoonnffiigg..lliisspp
                  (user  written)  site-dependent  configuration,
                  may be a link to one of the following:

                  ccffggssuunnuuxx..lliisspp  for Unix, using SunOS

                  ccffgguunniixx..lliisspp   for any other Unix

                  ccffggaammiiggaa..lliisspp  for Amiga

                  ccffggddooss..lliisspp    for OS/2 version

                  ccffggwwiinn3322..lliisspp  for WinNT/Win95 version

                  ccffggaaccoorrnn..lliisspp  for Acorn, using RiscOS

           ccoommppiilleerr..lliisspp
                  compiles lisp code to bytecode

           ddiissaasssseemm..lliisspp
                  disassembles machine code

           ddeeffss22..lliisspp
                  miscellaneous CLtL2 compatible definitions

           lloooopp..lliisspp
                  implements a CLtL2/dpANS compatible LOOP macro

           ccllooss..lliisspp
                  implements  a  subset of the Common Lisp Object
                  System

           ccoonnddiittiioonn..lliisspp
                  implements the Common Lisp Condition System

           ddeeffss33..lliisspp
                  more CLtL2 compatible definitions

           ggssttrreeaamm..lliisspp
                  generic stream default methods

           ffoorreeiiggnn11..lliisspp
                  foreign language interface

           ssccrreeeenn..lliisspp
                  the screen access package

           rreexxxx11..lliisspp
                  for Amiga, an interface to Rexx

           eeddiitt..lliisspp
                  (optional) the screen editor

           ppoossiixx..lliisspp
                  export POSIX calls

           tthhrreeaaddss..lliisspp
                  MT interface

           ssppaanniisshh..lliisspp, ggeerrmmaann..lliisspp, ffrreenncchh..lliisspp,  rruussssiiaann..lliisspp,
           dduuttcchh..lliisspp
                  i18n user messages


       Documentation:


           FFIILLEESS  lists the source files

           FFIILLEESS..11
                  nroff master for _F_I_L_E_S

           NNEEWWSS   lists the user visible changes

           __RREEAADDMMEE
                  master for the distribution's README

           __RREEAADDMMEE..eenn, __RREEAADDMMEE..ddee, __RREEAADDMMEE..eess
                  translations of ___R_E_A_D_M_E

           __cclliisspp..11
                  master for the distribution's manual page

           __cclliisspp..hhttmmll
                  master for the distribution's  manual  page  in
                  HTML format

           iimmppnnootteess..hhttmmll
                  the implementation notes



       Internationalization:


           ppoo//**..ppoott
                  list    of   translatable   messages
                  ("portable object template")

           ppoo//**..ppoo
                  translated    messages    ("portable
                  objects")

           ppoo//**..ggmmoo
                  translated   messages  ("GNU  format
                  message objects")


       Automatic configuration on Unix:


           ccoonnffiigguurree..iinn
                  lists the features to be checked

           aauuttooccoonnff//aauuttooccoonnff..mm44
                  _a_u_t_o_c_o_n_f's driver macros.   Part  of
                  GNU autoconf-2.13

           aauuttooccoonnff//aaccllooccaall..mm44
                  a  repertoire of features.  Use with
                  GNU autoconf-2.13

           ccoonnffiigguurree
                  configuration  script,  checks   for
                  dozens of features

           iinnttppaarraamm..dd
                  figures  out some machine parameters
                  (word size, endianness etc.)

           iinnttppaarraamm..cc
                  preprocessed version of _i_n_t_p_a_r_a_m_._d

           uunniixxccoonnff..hh..iinn
                  header file master. unixconf.h  con-
                  tains  the  values  of  the features
                  found out by configure.

           mmaakkeemmaakkee..iinn
                  makefile construction script master

           __cclliisspp..cc
                  master for the distribution's driver
                  program

           __ddiissttmmaakkeeffiillee
                  master  for the distribution's Make-
                  file



                            2002-08-28            CLISP SOURCE(1)
