2 Installation

First of all, see Clon’s homepage for tarballs, Git repository and online documentation. Clon is an ASDF 3 library. If you download a Clon tarball, or clone the repository, you need to unpack somewhere in the ASDF source registry. Otherwise, Clon is also available via Quicklisp. See Supported Platforms, for more information on portability and dependencies.

Clon’s main system is called ‘net.didierverna.clon’. Depending on your installation, you may thus either asdf:load-system, or ql:quickload it in your Lisp image. If you encounter grovel or ffi related problems, you may need to set the ‘CC’ environment variable to a working compiler before loading.

Alternatively, if you just want to use the core library without all the platform-dependent bells and whistles (see Non-ANSI Features), you may also just load the ‘net.didierverna.clon.core’ system.

In addition to the library itself, the Clon distribution offers documentation in the form of 3 different manuals, some data files like sample themes (see Theme Creation in The Clon End-User Manual), and a couple of demonstration programs. If you want to benefit from all these wonders, some bits of manual installation are needed. After unpacking, please perform the following steps, in order.

  1. Edit make/config.make to your specific needs.
  2. Type make to compile the documentation (end-user manual, user manual and reference manual). By default, the documentation is built in Info, PDF, and HTML formats. If you want other formats (DVI and PostScript are available), type make all-formats. You can also type individually make dvi and/or make ps in order to get the corresponding format.
  3. Type make install to install both the documentation and the data files. If you have compiled the documentation in DVI and PostScript format, those will be installed as well.

The reference manual’s Texinfo source is included in the distribution (and in the repository), although it is generated automatically by Declt. Before compiling, it is possible to regenerate a local version of it with hyperlinks to your installation by typing make localref. For this to work, you need SBCL and Declt though. If you ever need to regenerate the regular version, you can also type make generate.

Type make uninstall to uninstall the library.

Finally, if you want to play with the demo programs, cd to the demo/ directory, and type either make asdf-dump or make clon-dump. These are two different methods for producing standalone executables, via ASDF or via Clon itself. See Dumping Executables for more information. make install does not do anything with the demo programs.