X-Git-Url: https://git.rrq.au/?a=blobdiff_plain;f=packnl.8.adoc;h=16f62ffbca3489ebd0c45c2b44853259cd4245d8;hb=c6d3a0b36a69445ab93993b92ec73b090ed8c156;hp=22abdc8a0e1681c10fcdba101017bac445deb084;hpb=d40252c1ef27f119e9878e45d114f6e424cf069e;p=rrq%2Fnewlisp%2Fpacknl.git diff --git a/packnl.8.adoc b/packnl.8.adoc index 22abdc8..16f62ff 100644 --- a/packnl.8.adoc +++ b/packnl.8.adoc @@ -1,31 +1,27 @@ -packnl(8) -========= += packnl(8) :doctype: manpage :revdate: {sys:date "+%Y-%m-%d %H:%M:%S"} :COLON: : :EQUALS: = :NEWLINE: \n -NAME ----- -packnl - Pack newlisp scripts into an embedded binary. - -SYNOPSIS --------- +== NAME -*packnl* -w _binary_ _member-option_* +packnl - Pack newlisp scripts into an embedded binary. -*packnl* -u _binary_ _path_ +== SYNOPSIS -*packnl* -t _binary_ +*packnl* *-w* _binary_ _main.lsp_ _member-option_* + +*packnl* *-u* _binary_ _path_ + +*packnl* *-t* _binary_ -DESCRIPTION ------------ +== DESCRIPTION -*packnl* is a utility to pack a newlisp application into a binary -using the embedding feature of newlisp. Such a packed binary will have -the special +incore.lsp+ as embedded script, and it is then extended -with the given application files in a "simple archive" format. +*packnl* is a utility to package up a newlisp application into a +binary using the embedding feature of newlisp. Such a packed binary +will have the special +incore.lsp+ as embedded script, and it is then +extended with the given application files in a "simple archive" +format. The first application script is "main script" and it is loaded automatically. Additional application scripts and files are set up to @@ -37,11 +33,9 @@ _file_ is first looked up as being an embedded member (script), and only secondarily looked up in the filesystem. -OPTIONS -------- +== OPTIONS -Command Options -~~~~~~~~~~~~~~~ +=== Command Options *-w* _binary_ _members_:: @@ -62,12 +56,11 @@ the nominated directory. The *-t* command option is used for enlisting then names of the included members of an embedded binary. -Member Otions -~~~~~~~~~~~~~ +=== Member Otions -*_member_*:: +_member_:: -All member arguments other than the options below are undestood to +Member arguments other than the options below are undestood to nominate scripts to embed with file names as given. *-a* _library_:: @@ -87,12 +80,16 @@ The *-C* option changes the working directory for the program so that subsequent relative pathnames (file members and libraries) are found relative that working directory. -SEE ALSO --------- +== NOTES + +Note that _ar_ typically adds members using their basenames. With ++packnl+ packaging the added modules would thus be loaded by +basenames. + +== SEE ALSO *newlisp*, *ar* -AUTHOR ------- +== AUTHOR Ralph Ronnquist