source: trunk/abcl/contrib/asdf-jar/README.markdown

Last change on this file was 15074, checked in by mevenson, 23 months ago

Release as 1.5.0

File size: 2.3 KB
Line 
1ASDF-JAR
2========
3
4ASDF-JAR provides a system for packaging ASDF systems into jar
5archives for ABCL.  Given a running ABCL image with loadable ASDF
6systems the code in this package will recursively package all the
7required source and fasls in a jar archive .
8
9To install ASDF systems, [Quicklisp]() is probably the best
10contemporary solution.  The QUICKLISP-ABCL <file:../quicklisp-abcl>
11may be used to install Quicklisp at runtime from within ABCL.
12
13[Quicklisp]: http://www.quicklisp.org
14
15Once the requisite ASDF systems have been installed, ensure that this
16contrib is loaded via
17
18    CL-USER) (require :abcl-contrib)
19    CL-USER> (require :asdf-jar)
20
21Then, to say package the Perl regular expression system ("CL-PPCRE"),
22one uses the ASDF-JAR:PACKAGE as follows:
23
24    CL-USER> (asdf-jar:package :cl-ppcre)
25    ;  Loading #P"/home/evenson/quicklisp/dists/quicklisp/software/cl-ppcre-2.0.3/cl-ppcre.asd" ...
26    ;  Loaded #P"/home/evenson/quicklisp/dists/quicklisp/software/cl-ppcre-2.0.3/cl-ppcre.asd" (0.029 seconds)
27    Packaging ASDF definition of #<ASDF:SYSTEM "cl-ppcre">
28     as /var/tmp/cl-ppcre-all-2.0.3.jar.
29    Packaging contents in /var/tmp/cl-ppcre-all-2.0.3.jar
30     with recursive dependencies.
31    #P"/var/tmp/cl-ppcre-all-2.0.3.jar"
32
33The resulting jar contains all source and fasls required to run the
34ASDF system including any transitive ASDF dependencies.  Each asdf
35system is packaged under its own top level directory within the jar
36archive.  The jar archive itself is numbered with the version of the
37system that was specified in the packaging.
38
39To load the system from the jar one needs to add the ASDF file
40locations to the ASDF *CENTRAL-REGISTRY*.  If one wishes to load the
41fasls from the jar alone, one needs to tell ASDF not to override its
42output translation rules.  The function ASDF-JAR:ADD-TO-JAR does both
43of these options serving as the basis for customized load strategies
44tailored to end-user deployment needs.  So, after
45
46    CL-USER> (asdf-jar:add-to-asdf "/var/tmp/cl-ppcre-all-2.0.3.jar")
47
48a subsequent
49
50    CL-USER> (asdf:load-system :cl-ppcre)
51
52should load the ASDF system from the jar.
53
54Setting CL:*LOAD-VERBOSE* will allow one to verify that the subsequent
55load is indeed coming from the jar.
56
57# Colophon
58
59     Mark Evenson
60     Created: 20-JUN-2011
61     Revised: 11-JUN-2017
Note: See TracBrowser for help on using the repository browser.