ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/App-Staticperl/staticperl.pod
(Generate patch)

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.2 by root, Mon Dec 6 20:53:44 2010 UTC vs.
Revision 1.24 by root, Wed Dec 15 00:17:47 2010 UTC

1=head1 NAME 1=head1 NAME
2 2
3staticperl - perl, libc, 50 modules all in one 500kb file 3staticperl - perl, libc, 100 modules, all in one 500kb file
4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 staticperl help # print the embedded documentation 7 staticperl help # print the embedded documentation
8 staticperl fetch # fetch and unpack perl sources 8 staticperl fetch # fetch and unpack perl sources
14 staticperl cpan # invoke CPAN shell 14 staticperl cpan # invoke CPAN shell
15 staticperl instmod path... # install unpacked modules 15 staticperl instmod path... # install unpacked modules
16 staticperl instcpan modulename... # install modules from CPAN 16 staticperl instcpan modulename... # install modules from CPAN
17 staticperl mkbundle <bundle-args...> # see documentation 17 staticperl mkbundle <bundle-args...> # see documentation
18 staticperl mkperl <bundle-args...> # see documentation 18 staticperl mkperl <bundle-args...> # see documentation
19 staticperl mkapp appname <bundle-args...> # see documentation
19 20
20Typical Examples: 21Typical Examples:
21 22
22 staticperl install # fetch, configure, build and install perl 23 staticperl install # fetch, configure, build and install perl
23 staticperl cpan # run interactive cpan shell 24 staticperl cpan # run interactive cpan shell
24 staticperl mkperl -M '"Config_heavy.pl"' # build a perl that supports -V 25 staticperl mkperl -M '"Config_heavy.pl"' # build a perl that supports -V
25 staticperl mkperl -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI -MURI::http 26 staticperl mkperl -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI -MURI::http
26 # build a perl with the above modules linked in 27 # build a perl with the above modules linked in
28 staticperl mkapp myapp --boot mainprog mymodules
29 # build a binary "myapp" from mainprog and mymodules
27 30
28=head1 DESCRIPTION 31=head1 DESCRIPTION
29 32
30This script helps you creating single-file perl interpreters, or embedding 33This script helps you to create single-file perl interpreters
31a pelr interpreter in your apps. Single-file means that it is fully 34or applications, or embedding a perl interpreter in your
32self-contained - no separate shared objects, no autoload fragments, no .pm 35applications. Single-file means that it is fully self-contained - no
36separate shared objects, no autoload fragments, no .pm or .pl files are
33or .pl files are needed. And when linking statically, you can create (or 37needed. And when linking statically, you can create (or embed) a single
34embed) a single file that contains perl interpreter, libc, all the modules 38file that contains perl interpreter, libc, all the modules you need, all
35you need and all the libraries you need. 39the libraries you need and of course your actual program.
36 40
37With uclibc and upx on x86, you can create a single 500kb binary that 41With F<uClibc> and F<upx> on x86, you can create a single 500kb binary
38contains perl and 50 modules such as AnyEvent, EV, IO::AIO, Coro and so 42that contains perl and 100 modules such as POSIX, AnyEvent, EV, IO::AIO,
39on. Or any other choice of modules. 43Coro and so on. Or any other choice of modules.
40 44
45To see how this turns out, you can try out smallperl and bigperl, two
46pre-built static and compressed perl binaries with many and even more
47modules: just follow the links at L<http://staticperl.schmorp.de/>.
48
41The created files do not need write access to the filesystem (like PAR 49The created files do not need write access to the file system (like PAR
42does). In fact, since this script is in many ways similar to PAR::Packer, 50does). In fact, since this script is in many ways similar to PAR::Packer,
43here are the differences: 51here are the differences:
44 52
45=over 4 53=over 4
46 54
63=item * The generated executables don't need a writable filesystem. 71=item * The generated executables don't need a writable filesystem.
64 72
65F<staticperl> loads all required files directly from memory. There is no 73F<staticperl> loads all required files directly from memory. There is no
66need to unpack files into a temporary directory. 74need to unpack files into a temporary directory.
67 75
68=item * More control over included files. 76=item * More control over included files, more burden.
69 77
70PAR tries to be maintainance and hassle-free - it tries to include more files 78PAR tries to be maintenance and hassle-free - it tries to include more
71than necessary to make sure everything works out of the box. The extra files 79files than necessary to make sure everything works out of the box. It
80mostly succeeds at this, but he extra files (such as the unicode database)
72(such as the unicode database) can take substantial amounts of memory and filesize. 81can take substantial amounts of memory and file size.
73 82
74With F<staticperl>, the burden is mostly with the developer - only direct 83With F<staticperl>, the burden is mostly with the developer - only direct
75compile-time dependencies and L<AutoLoader> are handled automatically. 84compile-time dependencies and L<AutoLoader> are handled automatically.
76This means the modules to include often need to be tweaked manually. 85This means the modules to include often need to be tweaked manually.
86
87All this does not preclude more permissive modes to be implemented in
88the future, but right now, you have to resolve state hidden dependencies
89manually.
77 90
78=item * PAR works out of the box, F<staticperl> does not. 91=item * PAR works out of the box, F<staticperl> does not.
79 92
80Maintaining your own custom perl build can be a pain in the ass, and while 93Maintaining your own custom perl build can be a pain in the ass, and while
81F<staticperl> tries to make this easy, it still requires a custom perl 94F<staticperl> tries to make this easy, it still requires a custom perl
82build and possibly fiddling with some modules. PAR is likely to produce 95build and possibly fiddling with some modules. PAR is likely to produce
83results faster. 96results faster.
84 97
98Ok, PAR never has worked for me out of the box, and for some people,
99F<staticperl> does work out of the box, as they don't count "fiddling with
100module use lists" against it, but nevertheless, F<staticperl> is certainly
101a bit more difficult to use.
102
85=back 103=back
86 104
87=head1 HOW DOES IT WORK? 105=head1 HOW DOES IT WORK?
88 106
89Simple: F<staticperl> downloads, compile and installs a perl version of 107Simple: F<staticperl> downloads, compile and installs a perl version of
90your choice in F<~/.staticperl>. You can add extra modules either by 108your choice in F<~/.staticperl>. You can add extra modules either by
91letting F<staticperl> install them for you automatically, or by using CPAN 109letting F<staticperl> install them for you automatically, or by using CPAN
92and doing it interactively. This usually takes 5-10 minutes, depending on 110and doing it interactively. This usually takes 5-10 minutes, depending on
93the speed of your computer and your internet conenction. 111the speed of your computer and your internet connection.
94 112
95It is possible to do program development at this stage, too. 113It is possible to do program development at this stage, too.
96 114
97Afterwards, you create a list of files and modules you want to include, 115Afterwards, you create a list of files and modules you want to include,
98and then either build a new perl binary (that acts just like a normla perl 116and then either build a new perl binary (that acts just like a normal perl
99except everything is compiled in), or you create bundle files (basically C 117except everything is compiled in), or you create bundle files (basically C
100sources you can use to embed all files into your project). 118sources you can use to embed all files into your project).
101 119
102This step is very fast (a few seconds if PPI is not used for stripping, 120This step is very fast (a few seconds if PPI is not used for stripping, or
103more seconds otherwise, as PPI is very slow), and can be tweaked and 121the stripped files are in the cache), and can be tweaked and repeated as
104repeated as often as necessary. 122often as necessary.
105 123
106=head1 THE F<STATICPERL> SCRIPT 124=head1 THE F<STATICPERL> SCRIPT
107 125
108This module installs a script called F<staticperl> into your perl 126This module installs a script called F<staticperl> into your perl
109binary directory. The script is fully self-contained, and can be used 127binary directory. The script is fully self-contained, and can be
110without perl (for example, in an uClibc chroot environment). In fact, 128used without perl (for example, in an uClibc chroot environment). In
111it can be extracted from the C<App::Staticperl> distribution tarball as 129fact, it can be extracted from the C<App::Staticperl> distribution
112F<bin/staticperl>, without any installation. 130tarball as F<bin/staticperl>, without any installation. The
131newest (possibly alpha) version can also be downloaded from
132L<http://staticperl.schmorp.de/staticperl>.
113 133
114F<staticperl> interprets the first argument as a command to execute, 134F<staticperl> interprets the first argument as a command to execute,
115optionally followed by any parameters. 135optionally followed by any parameters.
116 136
117There are two command categories: the "phase 1" commands which deal with 137There are two command categories: the "phase 1" commands which deal with
127 147
128The command 148The command
129 149
130 staticperl install 150 staticperl install
131 151
132Is normally all you need: It installs the perl interpreter in 152is normally all you need: It installs the perl interpreter in
133F<~/.staticperl/perl>. It downloads, configures, builds and installs the 153F<~/.staticperl/perl>. It downloads, configures, builds and installs the
134perl interpreter if required. 154perl interpreter if required.
135 155
136Most of the following commands simply run one or more steps of this 156Most of the following F<staticperl> subcommands simply run one or more
137sequence. 157steps of this sequence.
138 158
159If it fails, then most commonly because the compiler options I selected
160are not supported by your compiler - either edit the F<staticperl> script
161yourself or create F<~/.staticperl> shell script where your set working
162C<PERL_CCFLAGS> etc. variables.
163
139To force recompilation or reinstalaltion, you need to run F<staticperl 164To force recompilation or reinstallation, you need to run F<staticperl
140distclean> first. 165distclean> first.
141 166
142=over 4 167=over 4
168
169=item F<staticperl version>
170
171Prints some info about the version of the F<staticperl> script you are using.
143 172
144=item F<staticperl fetch> 173=item F<staticperl fetch>
145 174
146Runs only the download and unpack phase, unless this has already happened. 175Runs only the download and unpack phase, unless this has already happened.
147 176
154Builds the configured perl sources, potentially after automatically 183Builds the configured perl sources, potentially after automatically
155configuring them. 184configuring them.
156 185
157=item F<staticperl install> 186=item F<staticperl install>
158 187
159Wipes the perl installation directory (usually F<~/.staticperl/perl>) and installs 188Wipes the perl installation directory (usually F<~/.staticperl/perl>) and
160the perl distribution, potentially aftering building it first. 189installs the perl distribution, potentially after building it first.
161 190
162=item F<staticperl cpan> [args...] 191=item F<staticperl cpan> [args...]
163 192
164Starts an interactive CPAN shell that you cna use to install further 193Starts an interactive CPAN shell that you can use to install further
165modules. Installs the perl first if neccessary, but apart from that, 194modules. Installs the perl first if necessary, but apart from that,
166no magic is involved: you could just as well run it manually via 195no magic is involved: you could just as well run it manually via
167F<~/.staticperl/perl/bin/cpan>. 196F<~/.staticperl/perl/bin/cpan>.
168 197
169Any additional arguments are simply passed to the F<cpan> command. 198Any additional arguments are simply passed to the F<cpan> command.
170 199
177 staticperl instcpan EV AnyEvent::HTTPD Coro 206 staticperl instcpan EV AnyEvent::HTTPD Coro
178 207
179=item F<staticperl instsrc> directory... 208=item F<staticperl instsrc> directory...
180 209
181In the unlikely case that you have unpacked perl modules around and want 210In the unlikely case that you have unpacked perl modules around and want
182to install from these instead of from CPAN, you cna do this using this 211to install from these instead of from CPAN, you can do this using this
183command by specifying all the directories with modules in them that you 212command by specifying all the directories with modules in them that you
184want to have built. 213want to have built.
185 214
186=item F<staticperl clean> 215=item F<staticperl clean>
187 216
188Runs F<make distclean> in the perl source directory (and potentially 217Deletes the perl source directory (and potentially cleans up other
189cleans up other intermediate files). This can be used to clean up 218intermediate files). This can be used to clean up files only needed for
190intermediate files without removing the installed perl interpreter. 219building perl, without removing the installed perl interpreter.
220
221At the moment, it doesn't delete downloaded tarballs.
222
223The exact semantics of this command will probably change.
191 224
192=item F<staticperl distclean> 225=item F<staticperl distclean>
193 226
194This wipes your complete F<~/.staticperl> directory. Be careful with this, 227This wipes your complete F<~/.staticperl> directory. Be careful with this,
195it nukes your perl download, perl sources, perl distribution and any 228it nukes your perl download, perl sources, perl distribution and any
210In the oh so unlikely case of something not working here, you 243In the oh so unlikely case of something not working here, you
211can run the script manually as well (by default it is written to 244can run the script manually as well (by default it is written to
212F<~/.staticperl/mkbundle>). 245F<~/.staticperl/mkbundle>).
213 246
214F<mkbundle> is a more conventional command and expect the argument 247F<mkbundle> is a more conventional command and expect the argument
215syntax commonly used on unix clones. For example, this command builds 248syntax commonly used on UNIX clones. For example, this command builds
216a new F<perl> binary and includes F<Config.pm> (for F<perl -V>), 249a new F<perl> binary and includes F<Config.pm> (for F<perl -V>),
217F<AnyEvent::HTTPD>, F<URI> and a custom F<httpd> script (from F<eg/httpd> 250F<AnyEvent::HTTPD>, F<URI> and a custom F<httpd> script (from F<eg/httpd>
218in this distribution): 251in this distribution):
219 252
220 # first make sure we have perl and the required modules 253 # first make sure we have perl and the required modules
229 ./perl -Mhttpd 262 ./perl -Mhttpd
230 263
231As you can see, things are not quite as trivial: the L<Config> module has 264As you can see, things are not quite as trivial: the L<Config> module has
232a hidden dependency which is not even a perl module (F<Config_heavy.pl>), 265a hidden dependency which is not even a perl module (F<Config_heavy.pl>),
233L<AnyEvent> needs at least one event loop backend that we have to 266L<AnyEvent> needs at least one event loop backend that we have to
234specifymanually (here L<AnyEvent::Impl::Perl>), and the F<URI> module 267specify manually (here L<AnyEvent::Impl::Perl>), and the F<URI> module
235(required by L<AnyEvent::HTTPD>) implements various URI schemes as extra 268(required by L<AnyEvent::HTTPD>) implements various URI schemes as extra
236modules - since L<AnyEvent::HTTPD> only needs C<http> URIs, we only need 269modules - since L<AnyEvent::HTTPD> only needs C<http> URIs, we only need
237to include that module. 270to include that module. I found out about these dependencies by carefully
271watching any error messages about missing modules...
272
273Instead of building a new perl binary, you can also build a standalone
274application:
275
276 # build the app
277 staticperl mkapp app --boot eg/httpd \
278 -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI::http
279
280 # run it
281 ./app
238 282
239=head3 OPTION PROCESSING 283=head3 OPTION PROCESSING
240 284
241All options can be given as arguments on the commandline (typically using 285All options can be given as arguments on the command line (typically
242long (e.g. C<--verbose>) or short option (e.g. C<-v>) style). Since 286using long (e.g. C<--verbose>) or short option (e.g. C<-v>) style). Since
243specifying a lot of modules can make the commandlien very cumbersome, 287specifying a lot of modules can make the command line very cumbersome,
244you can put all long options into a "bundle specification file" (with or 288you can put all long options into a "bundle specification file" (with or
245without C<--> prefix) and specify this bundle file instead. 289without C<--> prefix) and specify this bundle file instead.
246 290
247For example, the command given earlier could also look like this: 291For example, the command given earlier could also look like this:
248 292
255 use AnyEvent::HTTPD 299 use AnyEvent::HTTPD
256 use URI::http 300 use URI::http
257 add eg/httpd httpd.pm 301 add eg/httpd httpd.pm
258 302
259All options that specify modules or files to be added are processed in the 303All options that specify modules or files to be added are processed in the
260order given on the commandline (that affects the C<--use> and C<--eval> 304order given on the command line (that affects the C<--use> and C<--eval>
261options at the moment). 305options at the moment).
306
307=head3 PACKAGE SELECTION WORKFLOW
308
309F<staticperl mkbundle> has a number of options to control package
310selection. This section describes how they interact with each other. Also,
311since I am still a newbie w.r.t. these issues, maybe future versions of
312F<staticperl> will change this, so watch out :)
313
314The idiom "in order" means "in order that they are specified on the
315commandline". If you use a bundle specification file, then the options
316will be processed as if they were given in place of the bundle file name.
317
318=over 4
319
320=item 1. apply all C<--use>, C<--eval>, C<--add>, C<--addbin> and
321C<--incglob> options, in order.
322
323In addition, C<--use> and C<--eval> dependencies will be added when the
324options are processed.
325
326=item 2. apply all C<--include> and C<--exclude> options, in order.
327
328All this step does is potentially reduce the number of files already
329selected or found in phase 1.
330
331=item 3. find all modules (== F<.pm> files), gather their static archives
332(F<.a>) and AutoLoader splitfiles (F<.ix> and F<.al> files), find any
333extra libraries they need for linking (F<extralibs.ld>) and optionally
334evaluate any F<.packlist> files.
335
336This step is required to link against XS extensions and also adds files
337required for L<AutoLoader> to do it's job.
338
339=back
340
341After this, all the files selected for bundling will be read and processed
342(stripped), the bundle files will be written, and optionally a new F<perl>
343or application binary will be linked.
262 344
263=head3 MKBUNDLE OPTIONS 345=head3 MKBUNDLE OPTIONS
264 346
265=over 4 347=over 4
266 348
276 358
277Specify the stripping method applied to reduce the file of the perl 359Specify the stripping method applied to reduce the file of the perl
278sources included. 360sources included.
279 361
280The default is C<pod>, which uses the L<Pod::Strip> module to remove all 362The default is C<pod>, which uses the L<Pod::Strip> module to remove all
281pod documenatiton, which is very fast and reduces filesize a lot. 363pod documentation, which is very fast and reduces file size a lot.
282 364
283The C<ppi> method uses L<PPI> to parse and condense the perl sources. This 365The C<ppi> method uses L<PPI> to parse and condense the perl sources. This
284saves a lot more than just L<Pod::Strip>, and is generally safer, but is 366saves a lot more than just L<Pod::Strip>, and is generally safer,
285also a lot slower, so is best used for production builds. 367but is also a lot slower (some files take almost a minute to strip -
368F<staticperl> maintains a cache of stripped files to speed up subsequent
369runs for this reason). Note that this method doesn't optimise for raw file
370size, but for best compression (that means that the uncompressed file size
371is a bit larger, but the files compress better, e.g. with F<upx>).
286 372
373Last not least, if you need accurate line numbers in error messages,
287Last not least, in the unlikely case where C<pod> is too slow, or some 374or in the unlikely case where C<pod> is too slow, or some module gets
288module gets mistreated, you can specify C<none> to not mangle included 375mistreated, you can specify C<none> to not mangle included perl sources in
289perl sources in any way. 376any way.
290 377
291=item --perl 378=item --perl
292 379
293After writing out the bundle files, try to link a new perl interpreter. It 380After writing out the bundle files, try to link a new perl interpreter. It
294will be called F<perl> and will be left in the current working 381will be called F<perl> and will be left in the current working
295directory. The bundle files will be removed. 382directory. The bundle files will be removed.
296 383
297This switch is automatically ued when F<staticperl> is invoked with the 384This switch is automatically used when F<staticperl> is invoked with the
298C<mkperl> command (instead of C<mkbundle>): 385C<mkperl> command (instead of C<mkbundle>):
299 386
300 # build a new ./perl with only common::sense in it - very small :) 387 # build a new ./perl with only common::sense in it - very small :)
301 staticperl mkperl -Mcommon::sense 388 staticperl mkperl -Mcommon::sense
389
390=item --app name
391
392After writing out the bundle files, try to link a new standalone
393program. It will be called C<name>, and the bundle files get removed after
394linking it.
395
396The difference to the (mutually exclusive) C<--perl> option is that the
397binary created by this option will not try to act as a perl interpreter -
398instead it will simply initialise the perl interpreter, clean it up and
399exit.
400
401This switch is automatically used when F<staticperl> is invoked with the
402C<mkapp> command (instead of C<mkbundle>):
403
404To let it do something useful you I<must> add some boot code, e.g. with
405the C<--boot> option.
406
407Example: create a standalone perl binary that will execute F<appfile> when
408it is started.
409
410 staticperl mkbundle --app myexe --boot appfile
302 411
303=item --use module | -Mmodule 412=item --use module | -Mmodule
304 413
305Include the named module and all direct dependencies. This is done by 414Include the named module and all direct dependencies. This is done by
306C<require>'ing the module in a subprocess and tracing which other modules 415C<require>'ing the module in a subprocess and tracing which other modules
311 420
312 staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl 421 staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl
313 422
314Sometimes you want to load old-style "perl libraries" (F<.pl> files), or 423Sometimes you want to load old-style "perl libraries" (F<.pl> files), or
315maybe other weirdly named files. To do that, you need to quote the name in 424maybe other weirdly named files. To do that, you need to quote the name in
316single or double quoutes. When given on the commandline, you probably need 425single or double quotes. When given on the command line, you probably need
317to quote once more to avoid your shell interpreting it. Common cases that 426to quote once more to avoid your shell interpreting it. Common cases that
318need this are F<Config_heavy.pl> and F<utf8_heavy.pl>. 427need this are F<Config_heavy.pl> and F<utf8_heavy.pl>.
319 428
320Example: include the required files for F<perl -V> to work in all its 429Example: include the required files for F<perl -V> to work in all its
321glory (F<Config.pm> is included automatically by this). 430glory (F<Config.pm> is included automatically by this).
338variables or whatever you need. All files C<require>'d or C<use>'d in the 447variables or whatever you need. All files C<require>'d or C<use>'d in the
339script are included in the final bundle. 448script are included in the final bundle.
340 449
341Keep in mind that F<mkbundle> will only C<require> the modules named 450Keep in mind that F<mkbundle> will only C<require> the modules named
342by the C<--use> option, so do not expect the symbols from modules you 451by the C<--use> option, so do not expect the symbols from modules you
343C<--use>'d earlier on the commandlien to be available. 452C<--use>'d earlier on the command line to be available.
344 453
345Example: force L<AnyEvent> to detect a backend and therefore include it 454Example: force L<AnyEvent> to detect a backend and therefore include it
346in the final bundle. 455in the final bundle.
347 456
348 staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect' 457 staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect'
358=item --boot filename 467=item --boot filename
359 468
360Include the given file in the bundle and arrange for it to be executed 469Include the given file in the bundle and arrange for it to be executed
361(using a C<require>) before anything else when the new perl is 470(using a C<require>) before anything else when the new perl is
362initialised. This can be used to modify C<@INC> or anything else before 471initialised. This can be used to modify C<@INC> or anything else before
363the perl interpreter executes scripts given on the commandline (or via 472the perl interpreter executes scripts given on the command line (or via
364C<-e>). This works even in an embedded interpreter. 473C<-e>). This works even in an embedded interpreter.
365 474
366=item --add "file" | --add "file alias" 475=item --usepacklist
476
477Read F<.packlist> files for each distribution that happens to match a
478module name you specified. Sounds weird, and it is, so expect semantics to
479change somehow in the future.
480
481The idea is that most CPAN distributions have a F<.pm> file that matches
482the name of the distribution (which is rather reasonable after all).
483
484If this switch is enabled, then if any of the F<.pm> files that have been
485selected match an install distribution, then all F<.pm>, F<.pl>, F<.al>
486and F<.ix> files installed by this distribution are also included.
487
488For example, using this switch, when the L<URI> module is specified, then
489all L<URI> submodules that have been installed via the CPAN distribution
490are included as well, so you don't have to manually specify them.
491
492=item --incglob pattern
493
494This goes through all library directories and tries to match any F<.pm>
495and F<.pl> files against the extended glob pattern (see below). If a file
496matches, it is added. This switch will automatically detect L<AutoLoader>
497files and the required link libraries for XS modules, but it will I<not>
498scan the file for dependencies (at the moment).
499
500This is mainly useful to include "everything":
501
502 --incglob '*'
503
504Or to include perl libraries, or trees of those, such as the unicode
505database files needed by many other modules:
506
507 --incglob '/unicore/**.pl'
508
509=item --add file | --add "file alias"
367 510
368Adds the given (perl) file into the bundle (and optionally call it 511Adds the given (perl) file into the bundle (and optionally call it
369"alias"). This is useful to include any custom files into the bundle. 512"alias"). This is useful to include any custom files into the bundle.
370 513
371Example: embed the file F<httpd> as F<httpd.pm> when creating the bundle. 514Example: embed the file F<httpd> as F<httpd.pm> when creating the bundle.
376 519
377 # specification file 520 # specification file
378 add file1 myfiles/file1 521 add file1 myfiles/file1
379 add file2 myfiles/file2 522 add file2 myfiles/file2
380 add file3 myfiles/file3 523 add file3 myfiles/file3
524
525=item --binadd file | --add "file alias"
526
527Just like C<--add>, except that it treats the file as binary and adds it
528without any processing.
529
530You should probably add a C</> prefix to avoid clashing with embedded
531perl files (whose paths do not start with C</>), and/or use a special
532directory, such as C</res/name>.
533
534You can later get a copy of these files by calling C<staticperl::find
535"alias">.
536
537=item --include pattern | -i pattern | --exclude pattern | -x pattern
538
539These two options define an include/exclude filter that is used after all
540files selected by the other options have been found. Each include/exclude
541is applied to all files found so far - an include makes sure that the
542given files will be part of the resulting file set, an exclude will
543exclude files. The patterns are "extended glob patterns" (see below).
544
545For example, to include everything, except C<Devel> modules, but still
546include F<Devel::PPPort>, you could use this:
547
548 --incglob '*' -i '/Devel/PPPort.pm' -x '/Devel/**'
381 549
382=item --static 550=item --static
383 551
384When C<--perl> is also given, link statically instead of dynamically. The 552When C<--perl> is also given, link statically instead of dynamically. The
385default is to link the new perl interpreter fully dynamic (that means all 553default is to link the new perl interpreter fully dynamic (that means all
390systems based on GNU libc don't really support it in a usable fashion 558systems based on GNU libc don't really support it in a usable fashion
391either. Try uClibc if you want to create fully statically linked 559either. Try uClibc if you want to create fully statically linked
392executables, or try the C<--staticlibs> option to link only some libraries 560executables, or try the C<--staticlibs> option to link only some libraries
393statically. 561statically.
394 562
563=item --staticlib libname
564
565When not linking fully statically, this option allows you to link specific
566libraries statically. What it does is simply replace all occurances of
567C<-llibname> with the GCC-specific C<-Wl,-Bstatic -llibname -Wl,-Bdynamic>
568option.
569
570This will have no effect unless the library is actually linked against,
571specifically, C<--staticlib> will not link against the named library
572unless it would be linked against anyway.
573
574Example: link libcrypt statically into the binary.
575
576 staticperl mkperl -MIO::AIO --staticlib crypt
577
578 # ldopts might nwo contain:
579 # -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread
580
395=item any other argument 581=item any other argument
396 582
397Any other argument is interpreted as a bundle specification file, which 583Any other argument is interpreted as a bundle specification file, which
398supports most long options (without extra quoting), one option per line. 584supports most long options (without extra quoting), one option per line.
399 585
400=back 586=back
401 587
588=head3 EXTENDED GLOB PATTERNS
589
590Some options of F<staticperl mkbundle> expect an I<extended glob
591pattern>. This is neither a normal shell glob nor a regex, but something
592in between. The idea has been copied from rsync, and there are the current
593matching rules:
594
595=over 4
596
597=item Patterns starting with F</> will be a anchored at the root of the library tree.
598
599That is, F</unicore> will match the F<unicore> directory in C<@INC>, but
600nothing inside, and neither any other file or directory called F<unicore>
601anywhere else in the hierarchy.
602
603=item Patterns not starting with F</> will be anchored at the end of the path.
604
605That is, F<idna.pl> will match any file called F<idna.pl> anywhere in the
606hierarchy, but not any directories of the same name.
607
608=item A F<*> matches any single component.
609
610That is, F</unicore/*.pl> would match all F<.pl> files directly inside
611C</unicore>, not any deeper level F<.pl> files. Or in other words, F<*>
612will not match slashes.
613
614=item A F<**> matches anything.
615
616That is, F</unicore/**.pl> would match all F<.pl> files under F</unicore>,
617no matter how deeply nested they are inside subdirectories.
618
619=item A F<?> matches a single character within a component.
620
621That is, F</Encode/??.pm> matches F</Encode/JP.pm>, but not the
622hypothetical F</Encode/J/.pm>, as F<?> does not match F</>.
623
624=back
625
402=head2 F<STATCPERL> CONFIGURATION AND HOOKS 626=head2 F<STATICPERL> CONFIGURATION AND HOOKS
403 627
404During (each) startup, F<staticperl> tries to source the following shell 628During (each) startup, F<staticperl> tries to source some shell files to
629allow you to fine-tune/override configuration settings.
630
631In them you can override shell variables, or define shell functions
632("hooks") to be called at specific phases during installation. For
633example, you could define a C<postinstall> hook to install additional
634modules from CPAN each time you start from scratch.
635
636If the env variable C<$STATICPERLRC> is set, then F<staticperl> will try
637to source the file named with it only. Otherwise, it tries the following
405files in order: 638shell files in order:
406 639
407 /etc/staticperlrc 640 /etc/staticperlrc
408 ~/.staticperlrc 641 ~/.staticperlrc
409 $STATICPERL/rc 642 $STATICPERL/rc
410 643
411They can be used to override shell variables, or define functions to be
412called at specific phases.
413
414Note that the last file is erased during F<staticperl distclean>, so 644Note that the last file is erased during F<staticperl distclean>, so
415generally should not be used. 645generally should not be used.
416 646
417=head3 CONFIGURATION VARIABLES 647=head3 CONFIGURATION VARIABLES
418 648
423=item C<EMAIL> 653=item C<EMAIL>
424 654
425The e-mail address of the person who built this binary. Has no good 655The e-mail address of the person who built this binary. Has no good
426default, so should be specified by you. 656default, so should be specified by you.
427 657
428=back 658=item C<CPAN>
429 659
660The URL of the CPAN mirror to use (e.g. L<http://mirror.netcologne.de/cpan/>).
661
662=item C<EXTRA_MODULES>
663
664Additional modules installed during F<staticperl install>. Here you can
665set which modules you want have to installed from CPAN.
666
667Example: I really really need EV, AnyEvent, Coro and AnyEvent::AIO.
668
669 EXTRA_MODULES="EV AnyEvent Coro AnyEvent::AIO"
670
671Note that you can also use a C<postinstall> hook to achieve this, and
672more.
673
674=back
675
430=head4 Variables you I<might want> to override 676=head4 Variables you might I<want> to override
431 677
432=over 4 678=over 4
433 679
680=item C<STATICPERL>
681
682The directory where staticperl stores all its files
683(default: F<~/.staticperl>).
684
685=item C<PERL_MM_USE_DEFAULT>, C<EV_EXTRA_DEFS>, ...
686
687Usually set to C<1> to make modules "less inquisitive" during their
688installation, you can set any environment variable you want - some modules
689(such as L<Coro> or L<EV>) use environment variables for further tweaking.
690
434=item C<PERLVER> 691=item C<PERL_VERSION>
435 692
436The perl version to install - default is currently C<5.12.2>, but C<5.8.9> 693The perl version to install - default is currently C<5.12.2>, but C<5.8.9>
437is also a good choice (5.8.9 is much smaller than 5.12.2, while 5.10.1 is 694is also a good choice (5.8.9 is much smaller than 5.12.2, while 5.10.1 is
438about as big as 5.12.2). 695about as big as 5.12.2).
439 696
440=item C<CPAN> 697=item C<PERL_PREFIX>
441 698
442The URL of the CPAN mirror to use (e.g. L<http://mirror.netcologne.de/cpan/>). 699The prefix where perl gets installed (default: F<$STATICPERL/perl>),
700i.e. where the F<bin> and F<lib> subdirectories will end up.
443 701
702=item C<PERL_CONFIGURE>
703
704Additional Configure options - these are simply passed to the perl
705Configure script. For example, if you wanted to enable dynamic loading,
706you could pass C<-Dusedl>. To enable ithreads (Why would you want that
707insanity? Don't! Use L<forks> instead!) you would pass C<-Duseithreads>
708and so on.
709
710More commonly, you would either activate 64 bit integer support
711(C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to
712reduce filesize further.
713
444=item C<PERL_CPPFLAGS>, C<PERL_OPTIMIZE>, C<PERL_LDFLAGS>, C<PERL_LIBS> 714=item C<PERL_CC>, C<PERL_CCFLAGS>, C<PERL_OPTIMIZE>, C<PERL_LDFLAGS>, C<PERL_LIBS>
445 715
446These flags are passed to perl's F<Configure> script, and are generally 716These flags are passed to perl's F<Configure> script, and are generally
447optimised for small size (at the cost of performance). Since they also 717optimised for small size (at the cost of performance). Since they also
448contain subtle workarounds around various build issues, changing these 718contain subtle workarounds around various build issues, changing these
449usually requires understanding their default values - best look at the top 719usually requires understanding their default values - best look at
450of the F<staticperl> script for more info on these. 720the top of the F<staticperl> script for more info on these, and use a
721F<~/.staticperlrc> to override them.
451 722
452=item C<STATICPERL> 723Most of the variables override (or modify) the corresponding F<Configure>
724variable, except C<PERL_CCFLAGS>, which gets appended.
453 725
454The directory where staticperl stores all its files
455(default: F<~/.staticperl>).
456
457=item C<PREFIX>
458
459The prefix where perl get's installed (default: F<$STATICPERL/perl>),
460i.e. where the F<bin> and F<lib> subdirectories will end up.
461
462=item C<PERL_MM_USE_DEFAULT>, C<EV_EXTRA_DEFS>, others
463
464Usually set to C<1> to make modules "less inquisitive" during their
465installation, you can set any environment variable you want - some modules
466(such as L<Coro> or L<EV>) use environment variables for further tweaking.
467
468=item C<EXTRA_MODULES>
469
470Additional modules installed during F<staticperl install>. Here you can
471set which modules you want have to installed from CPAN.
472
473Example: I really really need EV, AnyEvent, Coro and IO::AIO.
474
475 EXTRA_MODULES="EV AnyEvent Coro IO::AIO"
476
477Note that you cna also use a C<postinstall> hook to achieve this, and
478more.
479
480=back 726=back
481 727
482=head4 Variables you I<probably do not want> to override 728=head4 Variables you probably I<do not want> to override
483 729
484=over 4 730=over 4
731
732=item C<MAKE>
733
734The make command to use - default is C<make>.
485 735
486=item C<MKBUNDLE> 736=item C<MKBUNDLE>
487 737
488Where F<staticperl> writes the C<mkbundle> command to 738Where F<staticperl> writes the C<mkbundle> command to
489(default: F<$STATICPERL/mkbundle>). 739(default: F<$STATICPERL/mkbundle>).
497 747
498=head3 OVERRIDABLE HOOKS 748=head3 OVERRIDABLE HOOKS
499 749
500In addition to environment variables, it is possible to provide some 750In addition to environment variables, it is possible to provide some
501shell functions that are called at specific times. To provide your own 751shell functions that are called at specific times. To provide your own
502commands, justd efine the corresponding function. 752commands, just define the corresponding function.
503 753
504Example: install extra modules from CPAN and from some directories 754Example: install extra modules from CPAN and from some directories
505at F<staticperl install> time. 755at F<staticperl install> time.
506 756
507 postinstall() { 757 postinstall() {
508 rm -rf lib/threads.* # weg mit Schaden 758 rm -rf lib/threads* # weg mit Schaden
509 instcpan IO::AIO EV 759 instcpan IO::AIO EV
510 instsrc ~/src/AnyEvent 760 instsrc ~/src/AnyEvent
511 instsrc ~/src/XML-Sablotron-1.0100001 761 instsrc ~/src/XML-Sablotron-1.0100001
512 instcpan AnyEvent::HTTPD 762 instcpan Anyevent::AIO AnyEvent::HTTPD
513 } 763 }
514 764
515=over 4 765=over 4
766
767=item preconfigure
768
769Called just before running F<./Configur> in the perl source
770directory. Current working directory is the perl source directory.
771
772This can be used to set any C<PERL_xxx> variables, which might be costly
773to compute.
516 774
517=item postconfigure 775=item postconfigure
518 776
519Called after configuring, but before building perl. Current working 777Called after configuring, but before building perl. Current working
520directory is the perl source directory. 778directory is the perl source directory.
521 779
522Could be used to tailor/patch config.sh (followed by F<./Configure -S>) or 780Could be used to tailor/patch config.sh (followed by F<sh Configure -S>)
523do any other modifications. 781or do any other modifications.
524 782
525=item postbuild 783=item postbuild
526 784
527Called after building, but before installing perl. Current working 785Called after building, but before installing perl. Current working
528directory is the perl source directory. 786directory is the perl source directory.
543The script must return with a zero exit status, or the installation will 801The script must return with a zero exit status, or the installation will
544fail. 802fail.
545 803
546=back 804=back
547 805
806=head1 ANATOMY OF A BUNDLE
807
808When not building a new perl binary, C<mkbundle> will leave a number of
809files in the current working directory, which can be used to embed a perl
810interpreter in your program.
811
812Intimate knowledge of L<perlembed> and preferably some experience with
813embedding perl is highly recommended.
814
815C<mkperl> (or the C<--perl> option) basically does this to link the new
816interpreter (it also adds a main program to F<bundle.>):
817
818 $Config{cc} $(cat bundle.ccopts) -o perl bundle.c $(cat bundle.ldopts)
819
820=over 4
821
822=item bundle.h
823
824A header file that contains the prototypes of the few symbols "exported"
825by bundle.c, and also exposes the perl headers to the application.
826
827=over 4
828
829=item staticperl_init ()
830
831Initialises the perl interpreter. You can use the normal perl functions
832after calling this function, for example, to define extra functions or
833to load a .pm file that contains some initialisation code, or the main
834program function:
835
836 XS (xsfunction)
837 {
838 dXSARGS;
839
840 // now we have items, ST(i) etc.
841 }
842
843 static void
844 run_myapp(void)
845 {
846 staticperl_init ();
847 newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");
848 eval_pv ("require myapp::main", 1); // executes "myapp/main.pm"
849 }
850
851=item staticperl_xs_init (pTHX)
852
853Sometimes you need direct control over C<perl_parse> and C<perl_run>, in
854which case you do not want to use C<staticperl_init> but call them on your
855own.
856
857Then you need this function - either pass it directly as the C<xs_init>
858function to C<perl_parse>, or call it from your own C<xs_init> function.
859
860=item staticperl_cleanup ()
861
862In the unlikely case that you want to destroy the perl interpreter, here
863is the corresponding function.
864
865=item PerlInterpreter *staticperl
866
867The perl interpreter pointer used by staticperl. Not normally so useful,
868but there it is.
869
870=back
871
872=item bundle.ccopts
873
874Contains the compiler options required to compile at least F<bundle.c> and
875any file that includes F<bundle.h> - you should probably use it in your
876C<CFLAGS>.
877
878=item bundle.ldopts
879
880The linker options needed to link the final program.
881
882=back
883
884=head1 RUNTIME FUNCTIONALITY
885
886Binaries created with C<mkbundle>/C<mkperl> contain extra functions, which
887are required to access the bundled perl sources, but might be useful for
888other purposes.
889
890In addition, for the embedded loading of perl files to work, F<staticperl>
891overrides the C<@INC> array.
892
893=over 4
894
895=item $file = staticperl::find $path
896
897Returns the data associated with the given C<$path>
898(e.g. C<Digest/MD5.pm>, C<auto/POSIX/autosplit.ix>), which is basically
899the UNIX path relative to the perl library directory.
900
901Returns C<undef> if the file isn't embedded.
902
903=item @paths = staticperl::list
904
905Returns the list of all paths embedded in this binary.
906
907=back
908
909=head1 FULLY STATIC BINARIES - BUILDROOT
910
911To make truly static (Linux-) libraries, you might want to have a look at
912buildroot (L<http://buildroot.uclibc.org/>).
913
914Buildroot is primarily meant to set up a cross-compile environment (which
915is not so useful as perl doesn't quite like cross compiles), but it can also compile
916a chroot environment where you can use F<staticperl>.
917
918To do so, download buildroot, and enable "Build options => development
919files in target filesystem" and optionally "Build options => gcc
920optimization level (optimize for size)". At the time of writing, I had
921good experiences with GCC 4.4.x but not GCC 4.5.
922
923To minimise code size, I used C<-pipe -ffunction-sections -fdata-sections
924-finline-limit=8 -fno-builtin-strlen -mtune=i386>. The C<-mtune=i386>
925doesn't decrease codesize much, but it makes the file much more
926compressible.
927
928If you don't need Coro or threads, you can go with "linuxthreads.old" (or
929no thread support). For Coro, it is highly recommended to switch to a
930uClibc newer than 0.9.31 (at the time of this writing, I used the 20101201
931snapshot) and enable NPTL, otherwise Coro needs to be configured with the
932ultra-slow pthreads backend to work around linuxthreads bugs (it also uses
933twice the address space needed for stacks).
934
935If you use C<linuxthreads.old>, then you should also be aware that
936uClibc shares C<errno> between all threads when statically linking. See
937L<http://lists.uclibc.org/pipermail/uclibc/2010-June/044157.html> for a
938workaround (And L<https://bugs.uclibc.org/2089> for discussion).
939
940C<ccache> support is also recommended, especially if you want
941to play around with buildroot options. Enabling the C<miniperl>
942package will probably enable all options required for a successful
943perl build. F<staticperl> itself additionally needs either C<wget>
944(recommended, for CPAN) or C<curl>.
945
946As for shells, busybox should provide all that is needed, but the default
947busybox configuration doesn't include F<comm> which is needed by perl -
948either make a custom busybox config, or compile coreutils.
949
950For the latter route, you might find that bash has some bugs that keep
951it from working properly in a chroot - either use dash (and link it to
952F</bin/sh> inside the chroot) or link busybox to F</bin/sh>, using it's
953built-in ash shell.
954
955Finally, you need F</dev/null> inside the chroot for many scripts to work
956- F<cp /dev/null output/target/dev> or bind-mounting your F</dev> will
957both provide this.
958
959After you have compiled and set up your buildroot target, you can copy
960F<staticperl> from the C<App::Staticperl> distribution or from your
961perl f<bin> directory (if you installed it) into the F<output/target>
962filesystem, chroot inside and run it.
963
964=head1 RECIPES / SPECIFIC MODULES
965
966This section contains some common(?) recipes and information about
967problems with some common modules or perl constructs that require extra
968files to be included.
969
970=head2 MODULES
971
972=over 4
973
974=item utf8
975
976Some functionality in the utf8 module, such as swash handling (used
977for unicode character ranges in regexes) is implemented in the
978C<"utf8_heavy.pl"> library:
979
980 -M'"utf8_heavy.pl"'
981
982Many Unicode properties in turn are defined in separate modules,
983such as C<"unicore/Heavy.pl"> and more specific data tables such as
984C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables
985are big (7MB uncompressed, although F<staticperl> contains special
986handling for those files), so including them on demand by your application
987only might pay off.
988
989To simply include the whole unicode database, use:
990
991 --incglob '/unicore/*.pl'
992
993=item AnyEvent
994
995AnyEvent needs a backend implementation that it will load in a delayed
996fashion. The L<AnyEvent::Impl::Perl> backend is the default choice
997for AnyEvent if it can't find anything else, and is usually a safe
998fallback. If you plan to use e.g. L<EV> (L<POE>...), then you need to
999include the L<AnyEvent::Impl::EV> (L<AnyEvent::Impl::POE>...) backend as
1000well.
1001
1002If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn
1003functions), you also need to include C<"AnyEvent/Util/idna.pl"> and
1004C<"AnyEvent/Util/uts46data.pl">.
1005
1006Or you can use C<--usepacklist> and specify C<-MAnyEvent> to include
1007everything.
1008
1009=item Carp
1010
1011Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of
1012perl 5.12.2 (maybe earlier), this dependency no longer exists.
1013
1014=item Config
1015
1016The F<perl -V> switch (as well as many modules) needs L<Config>, which in
1017turn might need L<"Config_heavy.pl">. Including the latter gives you
1018both.
1019
1020=item Term::ReadLine::Perl
1021
1022Also needs L<Term::ReadLine::readline>, or C<--usepacklist>.
1023
1024=item URI
1025
1026URI implements schemes as separate modules - the generic URL scheme is
1027implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If
1028you need to use any of these schemes, you should include these manually,
1029or use C<--usepacklist>.
1030
1031=back
1032
1033=head2 RECIPES
1034
1035=over 4
1036
1037=item Linking everything in
1038
1039To link just about everything installed in the perl library into a new
1040perl, try this:
1041
1042 staticperl mkperl --strip ppi --incglob '*'
1043
1044=item Getting rid of netdb function
1045
1046The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent>
1047and so on) that few applications use. You can avoid compiling them in by
1048putting the following fragment into a C<preconfigure> hook:
1049
1050 preconfigure() {
1051 for sym in \
1052 d_getgrnam_r d_endgrent d_endgrent_r d_endhent \
1053 d_endhostent_r d_endnent d_endnetent_r d_endpent \
1054 d_endprotoent_r d_endpwent d_endpwent_r d_endsent \
1055 d_endservent_r d_getgrent d_getgrent_r d_getgrgid_r \
1056 d_getgrnam_r d_gethbyaddr d_gethent d_getsbyport \
1057 d_gethostbyaddr_r d_gethostbyname_r d_gethostent_r \
1058 d_getlogin_r d_getnbyaddr d_getnbyname d_getnent \
1059 d_getnetbyaddr_r d_getnetbyname_r d_getnetent_r \
1060 d_getpent d_getpbyname d_getpbynumber d_getprotobyname_r \
1061 d_getprotobynumber_r d_getprotoent_r d_getpwent \
1062 d_getpwent_r d_getpwnam_r d_getpwuid_r d_getsent \
1063 d_getservbyname_r d_getservbyport_r d_getservent_r \
1064 d_getspnam_r d_getsbyname
1065 # d_gethbyname
1066 do
1067 PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"
1068 done
1069 }
1070
1071This mostly gains space when linking staticaly, as the functions will
1072likely not be linked in. The gain for dynamically-linked binaries is
1073smaller.
1074
1075Also, this leaves C<gethostbyname> in - not only is it actually used
1076often, the L<Socket> module also exposes it, so leaving it out usually
1077gains little. Why Socket exposes a C function that is in the core already
1078is anybody's guess.
1079
1080=back
1081
548=head1 AUTHOR 1082=head1 AUTHOR
549 1083
550 Marc Lehmann <schmorp@schmorp.de> 1084 Marc Lehmann <schmorp@schmorp.de>
551 http://software.schmorp.de/pkg/staticperl.html 1085 http://software.schmorp.de/pkg/staticperl.html

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines