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