fix load override to admit cotext argument
[rrq/newlisp/packnl.git] / README.adoc
1 The packnl Project
2 ==================
3
4 *packnl* is a command to pack a newlisp application into a binary
5 using the embedding feature of newlisp. Such a packed binary will have
6 +incore.lsp+ as embedded script, and then extended with the
7 application files in a "simple archive" format. The first application
8 file is used as "main script" that is loaded automatically. The
9 remaining application files are set up to be available as overriding
10 members for the +load+, +read-file+ and +file?+ functions.
11
12 .packnl -w binary ( file | -a name | -A name | -C path )*
13 ====
14 This commandline form is used for preparing a binary with the given
15 files. The nominated files will be appended to the binary in the given
16 order.
17
18 * The *-a* option is used for registering the members of an +ar+ style
19 archive to subseqently be selectively nominated for inclusion into the
20 binary.
21
22 * The *-A* option is used for including all members of an +ar+ style
23 archive.
24
25 * The *-C* option is used for changing (input) directory as given.
26 ====
27
28 .packnl -t binary
29 ====
30 This commandline form is used for reviewing a packed binary as a list
31 of its included members.
32 ====
33
34 .packnl -u binary directory
35 ====
36 This commandline form is used for unpacking a packed binary into a
37 given target directory.
38 ====