INSTALL

   1                                                              -*- outline -*-
   2
   3 * Anatomy of the tarball
   4
   5 The Clon distribution has the following shape:
   6
   7 ./src/          ;; source directory
   8 ./sbcl/         ;; SBCL grovel module
   9 ./share/        ;; data files
  10 ./doc/          ;; documentation
  11 ./demo/         ;; demo program
  12
  13
  14 * Configuration
  15 You may need to edit Makefile.cnf, demo/demo.lisp and doc/generate.sh in order
  16 to tweak some installation parameters.
  17
  18
  19 * Building and installing
  20
  21 Typing "make" will compile the documentation (end-user and user manuals). By
  22 default, the documentation is built in info, PDF and HTML formats. If you want
  23 other formats (DVI and PostScript are available), type "make all-formats". You
  24 can also type individually "make dvi" and/or "make ps" in order to get the
  25 corresponding format.
  26
  27 Typing "make install" will install both the documentation and the data files.
  28 If you're using ASDF 1, you will want to "make install-system" in order to
  29 create the system file symlink where appropriate.
  30
  31 If you want to compile the demo program, type "make demo". This program is not
  32 installed anywhere.
  33
  34
  35 * Building and installing the reference manual
  36 In addition to the end-user and user manuals, you can generate a reference
  37 manual for Clon. In order to do that, you need to have Declt installed (see
  38 http://www.lrde.epita.fr/~didier/software/lisp/misc.php#declt).
  39
  40 If you're using ASDF 1, you need to have typed "make install-system" first
  41 (that is why the reference manual is not built by default).
  42
  43 To generate the reference manual, type "make ref".
  44 To install it, type "make install-ref".
  45
  46 As for the rest of the documentation, "make ref" compiles the reference manual
  47 in info, PDF and HTML formats. If you want other formats (DVI and PostScript
  48 are available), type "make all-formats-ref". You can also individually type
  49 "make dvi-ref" and/or "make ps-ref" in order to get the corresponding format
  50 only.
  51
  52 You may also generate a "web", unlinked version of the reference manual (see
  53 the variable *link-files* for an explanation) by typing "make webref" or "make
  54 pdf-webref" and "make html-webref" individually.
  55
  56
  57 * Uninstalling
  58
  59 Type "make uninstall".