home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: Science / Science.zip / schem742.zip / readme
Text File  |  1996-04-16  |  12KB  |  289 lines
  1. MIT Scheme 7.4.2 for OS/2
  2.  
  3. MIT Scheme is an implementation of the Scheme programming language.
  4. This implementation is compliant with the "Revised^4 Report on the
  5. Programming Language Scheme" and (with one small exception) the "IEEE
  6. Standard for the Programming Language Scheme".  It supplies a large
  7. runtime library, a native-code compiler with source-level debugging
  8. tools, and an extensible integrated text editor which looks very much
  9. like GNU Emacs.
  10.  
  11. MIT Scheme is free software.  Source code for the entire
  12. implementation is available from our ftp server:
  13.  
  14.     swiss-ftp.ai.mit.edu:/pub/scheme-7.4/
  15.  
  16. See the file "doc\user.inf" for more information about using MIT Scheme.
  17. You can read that file using the OS/2 "view" command.
  18.  
  19. If you discover any bugs, we'd like to hear about them.  Please send
  20. bug reports to
  21.  
  22.    bug-cscheme@zurich.ai.mit.edu
  23.  
  24. OS/2 Installation
  25. =================
  26.  
  27.    This section describes how to install MIT Scheme on a machine running
  28. OS/2 2.1 or OS/2 Warp 3.0.
  29.  
  30.  
  31. Prerequisites
  32. -------------
  33.  
  34.    The Scheme files use about 20 megabytes of disk space when installed.
  35. An additional 5 megabytes of disk space is required during installation.
  36. After installation, you can reduce the amount of disk space required by
  37. deleting some files (*note Image Files for OS/2 Installation::.).
  38.  
  39.    MIT Scheme requires a fair amount of RAM to run well.  We haven't
  40. tried running this on any machine with less than 36 megabytes, so we
  41. don't have any hard data on what the smallest practical amount of RAM
  42. is.  However, for running Scheme under OS/2 Warp, 8 megabytes is
  43. probably the least you should consider, and 12 megabytes is probably
  44. comfortable.  If you want to use the Scheme compiler or the Edwin text
  45. editor, you should have at least 16 megabytes of RAM.
  46.  
  47.    MIT Scheme has been tested only on OS/2 Warp 3.0, but it should also
  48. run under OS/2 versions 2.1 and 2.11.  It was compiled using IBM Visual
  49. Age C++ version 3.0 and the OS/2 Toolkit version 3.0.
  50.  
  51.  
  52. OS/2 Installation Procedure
  53. ---------------------------
  54.  
  55.    After unpacking the ZIP file, `os2.zip', you will have these
  56. directories containing the following files:
  57.  
  58. `readme'
  59.      This file.
  60.  
  61. `bin\'
  62.      The executable programs `scheme.exe' and `bchschem.exe'.
  63.  
  64. `doc\'
  65.      Documentation files.  Two files, the `MIT Scheme User's Manual' and
  66.      the `MIT Scheme Reference Manual', are provided in `.inf' format;
  67.      these files can be read with the OS/2 `view' command.
  68.  
  69. `etc\'
  70.      Installation command files.  These are scripts that will be used
  71.      during the installation procedure.
  72.  
  73. `icons\'
  74.      A directory containing some useful icons.
  75.  
  76. `lib\'
  77.      A directory containing the data files needed by Scheme when it is
  78.      running.
  79.  
  80.    Perform the following steps to install Scheme:
  81.  
  82.   1. Run the command file `etc\mkbands.cmd'.  This creates the image
  83.      files `compiler.com', `edwin.com', and `all.com', and deletes the
  84.      files `compdel.com' and `eddel.com'.
  85.  
  86.   2. Move the executable files `scheme.exe' and `bchschem.exe' from
  87.      `bin\' to any directory that appears in your `PATH' environment
  88.      variable.  Depending on your needs, you may want to keep only one
  89.      of these files; each of these files is about 450 kilobytes and
  90.      chances are you'll only be using one of them.  If you keep only
  91.      `bchschem.exe' we recommend you rename it to `scheme.exe'.  Of
  92.      course, you can also keep both programs around if you think you
  93.      might use them both.
  94.  
  95.      The only difference between these two programs is in how they
  96.      handle garbage collection.  `scheme.exe' allocates two memory
  97.      heaps, and copies objects between the heaps to preserve them.
  98.      This means that most of the time the other heap is occupying
  99.      valuable memory but doesn't hold any interesting data.
  100.      `bchschem.exe' allocates only one memory heap, creates a disk file
  101.      during garbage collection, copies objects into the file, then
  102.      copies them back into memory.(1)
  103.  
  104.      These programs provide you with some important performance
  105.      trade-offs.  If you have plenty of memory and want the best
  106.      performance, use `scheme.exe'.  If you don't have enough memory,
  107.      or if you want to use less memory and will accept slower
  108.      performance, use `bchschem.exe'.  One way to tell that you don't
  109.      have enough memory is to run `scheme.exe' for a while and see if
  110.      your machine is paging during garbage collection.
  111.  
  112.      You might consider trying to use `scheme.exe' and letting the
  113.      operating system's paging handle the lack of RAM.  But usually you
  114.      will find that using `bchschem.exe' without paging is much faster
  115.      than using `scheme.exe' with paging.  Of course, if you are using
  116.      `bchschem.exe' and you're still paging, there's nothing you can do
  117.      to win.
  118.  
  119.   3. You may move the `lib\' directory anywhere you like.  You may
  120.      rename it to anything you like.  (Here at MIT, we use
  121.      `c:\scheme\lib'.)  After you have chosen where it will be located,
  122.      set the `MITSCHEME_LIBRARY_PATH' environment variable in
  123.      `config.sys' to be that location.
  124.  
  125.      For example, if you decide to store the directory as `c:\schdata',
  126.      you would add the following to `config.sys':
  127.  
  128.           SET MITSCHEME_LIBRARY_PATH=C:\SCHDATA
  129.  
  130.      (Remember that you must reboot OS/2 after editing `config.sys' in
  131.      order for the changes to take effect.)
  132.  
  133.      You can override the setting of this environment variable with the
  134.      `-library' command-line option to Scheme, for example:
  135.  
  136.           scheme -library d:\scheme\lib
  137.  
  138.      If you supply a `-library' option, it is not necessary to have the
  139.      environment variable defined.  For example, instead of editing
  140.      `config.sys', you might create a `.cmd' file to invoke Scheme and
  141.      pass it the `-library' option automatically.
  142.  
  143.   4. *Optional:* Move the `doc\' directory anywhere you like, or delete
  144.      it if you do not want to keep the documentation.
  145.  
  146.   5. *Optional:* Run the command file `etc\mkfolder.cmd' to create a
  147.      folder containing icons to invoke Scheme.  You must give this
  148.      command file a single argument, which is the full path name of the
  149.      executable file that you will use.  For example, if you stored the
  150.      file `scheme.exe' as `c:\scheme\bin\scheme.exe', then you would
  151.      invoke this command file as follows:
  152.  
  153.           etc\mkfolder c:\scheme\bin\scheme.exe
  154.  
  155.      This will create a folder containing four icons, called `Scheme',
  156.      `Edwin', `Liar', and `All', which correspond to the image files
  157.      `runtime.com', `edwin.com', `compiler.com', and `all.com'.  If you
  158.      decide to delete any of the image files, you can delete the
  159.      corresponding icons as well.
  160.  
  161.   6. *Optional:* The `icons\' directory contains some Scheme-ish icon
  162.      files.  If you don't like the icons created by the `etc\mkfolder'
  163.      command, you can use these icon files to change their appearance.
  164.  
  165.   7. *Optional:* Consider setting some of other environment variables
  166.      described below.
  167.  
  168.    ---------- Footnotes ----------
  169.  
  170.    (1)  *Note Memory Usage::, for more detail about this topic.
  171.  
  172.  
  173. Image Files
  174. -----------
  175.  
  176.    Scheme stores its runtime environment in a binary "image" file,
  177. which is directly loaded into the Scheme process.  An image file is a
  178. snapshot of Scheme's memory taken at a particular time (you can create
  179. your own image files using the `disk-save' procedure; *note World
  180. Images::.).  This distribution comes with four different image files,
  181. each of which contains different mixes of programs.  These image files
  182. are stored in the `lib\' directory.
  183.  
  184.   1. `runtime.com' is the basic runtime environment with no other
  185.      programs loaded.  This is the smallest image file.  All other image
  186.      files are supersets of this file.  This is the default image file
  187.      that is used when Scheme starts up, unless it is overridden by a
  188.      command-line option.
  189.  
  190.   2. `compiler.com' contains the basic runtime environment and the Liar
  191.      native-code compiler.  This is the image file that is loaded when
  192.      Scheme is started with the `-compiler' command-line option.
  193.  
  194.   3. `edwin.com' contains the basic runtime environment and the Edwin
  195.      text editor.  This is the image file that is loaded when Scheme is
  196.      started with the `-edwin' command-line option.
  197.  
  198.   4. `all.com' contains the basic runtime environment, the Liar
  199.      compiler, and the Edwin editor.  This is the largest of the image
  200.      files.  There is no command-line option corresponding to this
  201.      image file, but the following options can be used to load this
  202.      file:
  203.  
  204.           -large -constant 1600 -band all.com
  205.  
  206.    You can delete any of these files that you aren't going to use (these
  207. image files take up a *lot* of disk space!).  However, keep in mind
  208. that you need at least one image file to run Scheme at all.
  209.  
  210.  
  211. Documentation
  212. -------------
  213.  
  214.    Documentation for Scheme is included with this release, in the
  215. directory `doc\'.  It consists of the following files:
  216.  
  217.    * `user.inf' is the `MIT Scheme User's Manual', which describes how
  218.      to run and use Scheme.  It describes all of the environment
  219.      variables and command-line options, how to run the compiler and
  220.      editor, etc.
  221.  
  222.    * `scheme.inf' is the `MIT Scheme Reference Manual', which documents
  223.      the programming language and the runtime library.  This is a large
  224.      and detailed document for writing programs.
  225.  
  226.    * `console.txt' describes the procedures that can be used to control
  227.      the appearance of the console window (i.e. Scheme's main window).
  228.  
  229. Note: the User's Manual and Reference Manual are available in other
  230. forms, specifically: as PostScript files and as GNU Info files.  These
  231. alternate forms of documentation may be obtained from our FTP site,
  232. `swiss-ftp.ai.mit.edu'.
  233.  
  234.  
  235. Environment Variables
  236. ---------------------
  237.  
  238.    This section documents several of the environment variables that
  239. Scheme uses, and gives an example for each one.  These are the
  240. environment variables that must usually be defined when installing
  241. Scheme under OS/2.  For complete documentation of all of the
  242. environment variables used by Scheme, see *Note Environment Variables::.
  243.  
  244.    Note that environment variables are usually defined in the OS/2
  245. `config.sys' file.  After editing the `config.sys' file, it is
  246. necessary to reboot OS/2 before the changes will take effect.
  247.  
  248. `MITSCHEME_LIBRARY_PATH'
  249.      says where to find Scheme's data files.  This is the only required
  250.      environment variable (but is not required when Scheme is invoked
  251.      with the `-library' command-line option).
  252.  
  253.           SET MITSCHEME_LIBRARY_PATH=C:\SCHEME\LIB
  254.  
  255. `MITSCHEME_INF_DIRECTORY'
  256.      tells Scheme where to find debugging information for the runtime
  257.      system.  The default value for this environment variable is a
  258.      subdirectory `src\' located in the directory specified by
  259.      `MITSCHEME_LIBRARY_PATH'.
  260.  
  261.           SET MITSCHEME_INF_DIRECTORY=C:\SCHEME\LIB\SRC
  262.  
  263. `TEMP'
  264.      tells Scheme the name of a directory where it can store temporary
  265.      files.
  266.  
  267.           SET TEMP=C:\TMP
  268.  
  269. `HOME'
  270.      tells Scheme where your "home" directory is located.  This is where
  271.      Scheme looks for init files, and it is also what the `~/' (or
  272.      `~\\') filename prefix expands to.  If not specified, Scheme uses
  273.      the root directory of the current drive.
  274.  
  275.           SET HOME=C:\CPH
  276.  
  277. `USER'
  278.      tells Scheme your user name.  This is used for several purposes,
  279.      including the name that will be used as your email address.
  280.  
  281.           SET USER=cph
  282.  
  283. `SHELL'
  284.      tells Edwin what shell program to use in shell buffers and for
  285.      running shell commands.  If not specified, this defaults to the
  286.      standard OS/2 shell, `cmd.exe'.
  287.  
  288.           SET SHELL=C:\LOCAL\PROG\4OS2251\4OS2.EXE
  289.