archive/share/share.usg

   1
   2      The SHARE, SHARE1, and SHARE2 directories contain programs,
   3 information files, etc. which are considered to be of interest to the
   4 MACSYMA community.  (The SHARE1; and SHARE2; directories are overflow
   5 directories for the SHARE; directory which in general hold less frequently
   6 used files.  From now on, references to the SHARE; directory should be
   7 taken to mean all of the SHARE;, SHARE1;, and SHARE2; directories.)
   8 Some files on SHARE; are not part of the MACSYMA system per se and must
   9 be loaded individually by the user, e.g. LOADFILE(CGAMMA,FASL,SHARE);.
  10 Many files on SHARE; were contributed by MACSYMA users, and all MACSYMA
  11 users are encouraged to contribute.
  12
  13      Names for files on SHARE; should be chosen as appropriate.
  14 However, the contributor will probably want to follow the conventions
  15 discussed here.  A contributor will probably create some but not all
  16 of the following files.  Examples may be seen on the SHARE directory.
  17
  18    1)  NAME > is the file name of the MACSYMA BATCHable programs.
  19 The > sign indicates a numeric second filename which is increased
  20 whenever a new version is created.
  21
  22    2)  NAME LISP is the file name of the LISP code for the programs
  23 contained in the file NAME >.  This file is loaded into MACSYMA using
  24 LOADFILE.  It was obtained by using the TRANSLATE command or was
  25 written directly in LISP by the contributor.  (LISP files may also be
  26 created by the SAVE command.)
  27
  28    3)  NAME FASL is the file name of the FASL (fast-loadable) version
  29 of NAME LISP, and was produced from NAME LISP by using the LISP
  30 compiler.  (FASL files may also be created by the FASSAVE command.)
  31 It is loaded into MACSYMA using the LOADFILE command.
  32
  33    4)  NAME USAGE is the name of the documentation file for the
  34 programs in NAME >.  It describes how the programs are used, inputs,
  35 outputs, options, warnings, error messages, etc.  It may mention the
  36 algorithms behind the programs, references, and whatever else the
  37 user should know.  It should certainly indicate who programmed the
  38 routines, especially his login name.  If the NAME USAGE file does
  39 not exist, this information should be given in NAME > or elsewhere.
  40
  41    5)  NAME DEMO is the name of the demonstration file which may be
  42 used in DEMOing NAME > or NAME LISP.
  43
  44    6)  NAME OUTPUT may be used to store sample output obtained from
  45 running NAME > on some examples or from DEMOing the NAME DEMO file.
  46
  47    7)  Other file names may be used for information files providing
  48 some information on some aspect of the MACSYMA system or for
  49 describing some MACSYMA utility or for notes on some MACSYMA issues,
  50 etc.
  51
  52      The SHARE > file is an index to the SHARE directory and is
  53 intended to contain a short note on each of the programs on the SHARE
  54 directory.  It should be updated by the SHARE; contributor as
  55 appropriate.
  56
  57      Any comments or questions as to the use of the SHARE directory
  58 should be sent to JPG.
  59