… | |
… | |
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 | |
20 | Typical Examples: |
21 | Typical 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 | |
30 | This script helps you creating single-file perl interpreters, or embedding |
33 | This script helps you to create single-file perl interpreters |
31 | a perl interpreter in your applications. Single-file means that it is |
34 | or applications, or embedding a perl interpreter in your |
32 | fully self-contained - no separate shared objects, no autoload fragments, |
35 | applications. Single-file means that it is fully self-contained - no |
33 | no .pm or .pl files are needed. And when linking statically, you can |
36 | separate shared objects, no autoload fragments, no .pm or .pl files are |
34 | create (or embed) a single file that contains perl interpreter, libc, all |
37 | needed. And when linking statically, you can create (or embed) a single |
35 | the modules you need and all the libraries you need. |
38 | file that contains perl interpreter, libc, all the modules you need, all |
|
|
39 | the libraries you need and of course your actual program. |
36 | |
40 | |
37 | With F<uClibc> and F<upx> on x86, you can create a single 500kb binary |
41 | With F<uClibc> and F<upx> on x86, you can create a single 500kb binary |
38 | that contains perl and 100 modules such as POSIX, AnyEvent, EV, IO::AIO, |
42 | that contains perl and 100 modules such as POSIX, AnyEvent, EV, IO::AIO, |
39 | Coro and so on. Or any other choice of modules. |
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/>. |
40 | |
48 | |
41 | The created files do not need write access to the file system (like PAR |
49 | The created files do not need write access to the file system (like PAR |
42 | does). In fact, since this script is in many ways similar to PAR::Packer, |
50 | does). In fact, since this script is in many ways similar to PAR::Packer, |
43 | here are the differences: |
51 | here are the differences: |
44 | |
52 | |
… | |
… | |
63 | =item * The generated executables don't need a writable filesystem. |
71 | =item * The generated executables don't need a writable filesystem. |
64 | |
72 | |
65 | F<staticperl> loads all required files directly from memory. There is no |
73 | F<staticperl> loads all required files directly from memory. There is no |
66 | need to unpack files into a temporary directory. |
74 | need 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 | |
70 | PAR tries to be maintenance and hassle-free - it tries to include more |
78 | PAR tries to be maintenance and hassle-free - it tries to include more |
71 | files than necessary to make sure everything works out of the box. The |
79 | files than necessary to make sure everything works out of the box. It |
72 | extra files (such as the unicode database) can take substantial amounts of |
80 | mostly succeeds at this, but he extra files (such as the unicode database) |
73 | memory and file size. |
81 | can take substantial amounts of memory and file size. |
74 | |
82 | |
75 | With F<staticperl>, the burden is mostly with the developer - only direct |
83 | With F<staticperl>, the burden is mostly with the developer - only direct |
76 | compile-time dependencies and L<AutoLoader> are handled automatically. |
84 | compile-time dependencies and L<AutoLoader> are handled automatically. |
77 | This means the modules to include often need to be tweaked manually. |
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. |
78 | |
90 | |
79 | =item * PAR works out of the box, F<staticperl> does not. |
91 | =item * PAR works out of the box, F<staticperl> does not. |
80 | |
92 | |
81 | Maintaining your own custom perl build can be a pain in the ass, and while |
93 | Maintaining your own custom perl build can be a pain in the ass, and while |
82 | F<staticperl> tries to make this easy, it still requires a custom perl |
94 | F<staticperl> tries to make this easy, it still requires a custom perl |
… | |
… | |
103 | Afterwards, you create a list of files and modules you want to include, |
115 | Afterwards, you create a list of files and modules you want to include, |
104 | and then either build a new perl binary (that acts just like a normal perl |
116 | and then either build a new perl binary (that acts just like a normal perl |
105 | except everything is compiled in), or you create bundle files (basically C |
117 | except everything is compiled in), or you create bundle files (basically C |
106 | sources you can use to embed all files into your project). |
118 | sources you can use to embed all files into your project). |
107 | |
119 | |
108 | This step is very fast (a few seconds if PPI is not used for stripping, |
120 | This step is very fast (a few seconds if PPI is not used for stripping, or |
109 | more seconds otherwise, as PPI is very slow), and can be tweaked and |
121 | the stripped files are in the cache), and can be tweaked and repeated as |
110 | repeated as often as necessary. |
122 | often as necessary. |
111 | |
123 | |
112 | =head1 THE F<STATICPERL> SCRIPT |
124 | =head1 THE F<STATICPERL> SCRIPT |
113 | |
125 | |
114 | This module installs a script called F<staticperl> into your perl |
126 | This module installs a script called F<staticperl> into your perl |
115 | binary directory. The script is fully self-contained, and can be used |
127 | binary directory. The script is fully self-contained, and can be used |
… | |
… | |
144 | |
156 | |
145 | To force recompilation or reinstallation, you need to run F<staticperl |
157 | To force recompilation or reinstallation, you need to run F<staticperl |
146 | distclean> first. |
158 | distclean> first. |
147 | |
159 | |
148 | =over 4 |
160 | =over 4 |
|
|
161 | |
|
|
162 | =item F<staticperl version> |
|
|
163 | |
|
|
164 | Prints some info about the version of the F<staticperl> script you are using. |
149 | |
165 | |
150 | =item F<staticperl fetch> |
166 | =item F<staticperl fetch> |
151 | |
167 | |
152 | Runs only the download and unpack phase, unless this has already happened. |
168 | Runs only the download and unpack phase, unless this has already happened. |
153 | |
169 | |
… | |
… | |
244 | (required by L<AnyEvent::HTTPD>) implements various URI schemes as extra |
260 | (required by L<AnyEvent::HTTPD>) implements various URI schemes as extra |
245 | modules - since L<AnyEvent::HTTPD> only needs C<http> URIs, we only need |
261 | modules - since L<AnyEvent::HTTPD> only needs C<http> URIs, we only need |
246 | to include that module. I found out about these dependencies by carefully |
262 | to include that module. I found out about these dependencies by carefully |
247 | watching any error messages about missing modules... |
263 | watching any error messages about missing modules... |
248 | |
264 | |
|
|
265 | Instead of building a new perl binary, you can also build a standalone |
|
|
266 | application: |
|
|
267 | |
|
|
268 | # build the app |
|
|
269 | staticperl mkapp app --boot eg/httpd \ |
|
|
270 | -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI::http |
|
|
271 | |
|
|
272 | # run it |
|
|
273 | ./app |
|
|
274 | |
249 | =head3 OPTION PROCESSING |
275 | =head3 OPTION PROCESSING |
250 | |
276 | |
251 | All options can be given as arguments on the command line (typically |
277 | All options can be given as arguments on the command line (typically |
252 | using long (e.g. C<--verbose>) or short option (e.g. C<-v>) style). Since |
278 | using long (e.g. C<--verbose>) or short option (e.g. C<-v>) style). Since |
253 | specifying a lot of modules can make the command line very cumbersome, |
279 | specifying a lot of modules can make the command line very cumbersome, |
… | |
… | |
268 | |
294 | |
269 | All options that specify modules or files to be added are processed in the |
295 | All options that specify modules or files to be added are processed in the |
270 | order given on the command line (that affects the C<--use> and C<--eval> |
296 | order given on the command line (that affects the C<--use> and C<--eval> |
271 | options at the moment). |
297 | options at the moment). |
272 | |
298 | |
|
|
299 | =head3 PACKAGE SELECTION WORKFLOW |
|
|
300 | |
|
|
301 | F<staticperl mkbundle> has a number of options to control package |
|
|
302 | selection. This section describes how they interact with each other. Also, |
|
|
303 | since I am still a newbie w.r.t. these issues, maybe future versions of |
|
|
304 | F<staticperl> will change this, so watch out :) |
|
|
305 | |
|
|
306 | The idiom "in order" means "in order that they are specified on the |
|
|
307 | commandline". If you use a bundle specification file, then the options |
|
|
308 | will be processed as if they were given in place of the bundle file name. |
|
|
309 | |
|
|
310 | =over 4 |
|
|
311 | |
|
|
312 | =item 1. apply all C<--use>, C<--eval>, C<--add>, C<--addbin> and |
|
|
313 | C<--incglob> options, in order. |
|
|
314 | |
|
|
315 | In addition, C<--use> and C<--eval> dependencies will be added when the |
|
|
316 | options are processed. |
|
|
317 | |
|
|
318 | =item 2. apply all C<--include> and C<--exclude> options, in order. |
|
|
319 | |
|
|
320 | All this step does is potentially reduce the number of files already |
|
|
321 | selected or found in phase 1. |
|
|
322 | |
|
|
323 | =item 3. find all modules (== F<.pm> files), gather their static archives |
|
|
324 | (F<.a>) and AutoLoader splitfiles (F<.ix> and F<.al> files), find any |
|
|
325 | extra libraries they need for linking (F<extralibs.ld>) and optionally |
|
|
326 | evaluate any F<.packlist> files. |
|
|
327 | |
|
|
328 | This step is required to link against XS extensions and also adds files |
|
|
329 | required for L<AutoLoader> to do it's job. |
|
|
330 | |
|
|
331 | =back |
|
|
332 | |
|
|
333 | After this, all the files selected for bundling will be read and processed |
|
|
334 | (stripped), the bundle files will be written, and optionally a new F<perl> |
|
|
335 | or application binary will be linked. |
|
|
336 | |
273 | =head3 MKBUNDLE OPTIONS |
337 | =head3 MKBUNDLE OPTIONS |
274 | |
338 | |
275 | =over 4 |
339 | =over 4 |
276 | |
340 | |
277 | =item --verbose | -v |
341 | =item --verbose | -v |
… | |
… | |
289 | |
353 | |
290 | The default is C<pod>, which uses the L<Pod::Strip> module to remove all |
354 | The default is C<pod>, which uses the L<Pod::Strip> module to remove all |
291 | pod documentation, which is very fast and reduces file size a lot. |
355 | pod documentation, which is very fast and reduces file size a lot. |
292 | |
356 | |
293 | The C<ppi> method uses L<PPI> to parse and condense the perl sources. This |
357 | The C<ppi> method uses L<PPI> to parse and condense the perl sources. This |
294 | saves a lot more than just L<Pod::Strip>, and is generally safer, but |
358 | saves a lot more than just L<Pod::Strip>, and is generally safer, |
295 | is also a lot slower, so is best used for production builds. Note that |
359 | but is also a lot slower (some files take almost a minute to strip - |
296 | this method doesn't optimise for raw file size, but for best compression |
360 | F<staticperl> maintains a cache of stripped files to speed up subsequent |
297 | (that means that the uncompressed file size is a bit larger, but the files |
361 | runs for this reason). Note that this method doesn't optimise for raw file |
298 | compress better, e.g. with F<upx>). |
362 | size, but for best compression (that means that the uncompressed file size |
|
|
363 | is a bit larger, but the files compress better, e.g. with F<upx>). |
299 | |
364 | |
300 | Last not least, if you need accurate line numbers in error messages, |
365 | Last not least, if you need accurate line numbers in error messages, |
301 | or in the unlikely case where C<pod> is too slow, or some module gets |
366 | or in the unlikely case where C<pod> is too slow, or some module gets |
302 | mistreated, you can specify C<none> to not mangle included perl sources in |
367 | mistreated, you can specify C<none> to not mangle included perl sources in |
303 | any way. |
368 | any way. |
… | |
… | |
311 | This switch is automatically used when F<staticperl> is invoked with the |
376 | This switch is automatically used when F<staticperl> is invoked with the |
312 | C<mkperl> command (instead of C<mkbundle>): |
377 | C<mkperl> command (instead of C<mkbundle>): |
313 | |
378 | |
314 | # build a new ./perl with only common::sense in it - very small :) |
379 | # build a new ./perl with only common::sense in it - very small :) |
315 | staticperl mkperl -Mcommon::sense |
380 | staticperl mkperl -Mcommon::sense |
|
|
381 | |
|
|
382 | =item --app name |
|
|
383 | |
|
|
384 | After writing out the bundle files, try to link a new standalone |
|
|
385 | program. It will be called C<name>, and the bundle files get removed after |
|
|
386 | linking it. |
|
|
387 | |
|
|
388 | The difference to the (mutually exclusive) C<--perl> option is that the |
|
|
389 | binary created by this option will not try to act as a perl interpreter - |
|
|
390 | instead it will simply initialise the perl interpreter, clean it up and |
|
|
391 | exit. |
|
|
392 | |
|
|
393 | This switch is automatically used when F<staticperl> is invoked with the |
|
|
394 | C<mkapp> command (instead of C<mkbundle>): |
|
|
395 | |
|
|
396 | To let it do something useful you I<must> add some boot code, e.g. with |
|
|
397 | the C<--boot> option. |
|
|
398 | |
|
|
399 | Example: create a standalone perl binary that will execute F<appfile> when |
|
|
400 | it is started. |
|
|
401 | |
|
|
402 | staticperl mkbundle --app myexe --boot appfile |
316 | |
403 | |
317 | =item --use module | -Mmodule |
404 | =item --use module | -Mmodule |
318 | |
405 | |
319 | Include the named module and all direct dependencies. This is done by |
406 | Include the named module and all direct dependencies. This is done by |
320 | C<require>'ing the module in a subprocess and tracing which other modules |
407 | C<require>'ing the module in a subprocess and tracing which other modules |
… | |
… | |
375 | (using a C<require>) before anything else when the new perl is |
462 | (using a C<require>) before anything else when the new perl is |
376 | initialised. This can be used to modify C<@INC> or anything else before |
463 | initialised. This can be used to modify C<@INC> or anything else before |
377 | the perl interpreter executes scripts given on the command line (or via |
464 | the perl interpreter executes scripts given on the command line (or via |
378 | C<-e>). This works even in an embedded interpreter. |
465 | C<-e>). This works even in an embedded interpreter. |
379 | |
466 | |
380 | =item --add "file" | --add "file alias" |
467 | =item --usepacklist |
|
|
468 | |
|
|
469 | Read F<.packlist> files for each distribution that happens to match a |
|
|
470 | module name you specified. Sounds weird, and it is, so expect semantics to |
|
|
471 | change somehow in the future. |
|
|
472 | |
|
|
473 | The idea is that most CPAN distributions have a F<.pm> file that matches |
|
|
474 | the name of the distribution (which is rather reasonable after all). |
|
|
475 | |
|
|
476 | If this switch is enabled, then if any of the F<.pm> files that have been |
|
|
477 | selected match an install distribution, then all F<.pm>, F<.pl>, F<.al> |
|
|
478 | and F<.ix> files installed by this distribution are also included. |
|
|
479 | |
|
|
480 | For example, using this switch, when the L<URI> module is specified, then |
|
|
481 | all L<URI> submodules that have been installed via the CPAN distribution |
|
|
482 | are included as well, so you don't have to manually specify them. |
|
|
483 | |
|
|
484 | =item --incglob pattern |
|
|
485 | |
|
|
486 | This goes through all library directories and tries to match any F<.pm> |
|
|
487 | and F<.pl> files against the extended glob pattern (see below). If a file |
|
|
488 | matches, it is added. This switch will automatically detect L<AutoLoader> |
|
|
489 | files and the required link libraries for XS modules, but it will I<not> |
|
|
490 | scan the file for dependencies (at the moment). |
|
|
491 | |
|
|
492 | This is mainly useful to include "everything": |
|
|
493 | |
|
|
494 | --incglob '*' |
|
|
495 | |
|
|
496 | Or to include perl libraries, or trees of those, such as the unicode |
|
|
497 | database files needed by many other modules: |
|
|
498 | |
|
|
499 | --incglob '/unicore/**.pl' |
|
|
500 | |
|
|
501 | =item --add file | --add "file alias" |
381 | |
502 | |
382 | Adds the given (perl) file into the bundle (and optionally call it |
503 | Adds the given (perl) file into the bundle (and optionally call it |
383 | "alias"). This is useful to include any custom files into the bundle. |
504 | "alias"). This is useful to include any custom files into the bundle. |
384 | |
505 | |
385 | Example: embed the file F<httpd> as F<httpd.pm> when creating the bundle. |
506 | Example: embed the file F<httpd> as F<httpd.pm> when creating the bundle. |
… | |
… | |
391 | # specification file |
512 | # specification file |
392 | add file1 myfiles/file1 |
513 | add file1 myfiles/file1 |
393 | add file2 myfiles/file2 |
514 | add file2 myfiles/file2 |
394 | add file3 myfiles/file3 |
515 | add file3 myfiles/file3 |
395 | |
516 | |
396 | =item --binadd "file" | --add "file alias" |
517 | =item --binadd file | --add "file alias" |
397 | |
518 | |
398 | Just like C<--add>, except that it treats the file as binary and adds it |
519 | Just like C<--add>, except that it treats the file as binary and adds it |
399 | without any processing. |
520 | without any processing. |
400 | |
521 | |
401 | You should probably add a C</> prefix to avoid clashing with embedded |
522 | You should probably add a C</> prefix to avoid clashing with embedded |
402 | perl files (whose paths do not start with C</>), and/or use a special |
523 | perl files (whose paths do not start with C</>), and/or use a special |
403 | directory, such as C</res/name>. |
524 | directory, such as C</res/name>. |
404 | |
525 | |
405 | You can later get a copy of these files by calling C<staticperl::find |
526 | You can later get a copy of these files by calling C<staticperl::find |
406 | "alias">. |
527 | "alias">. |
|
|
528 | |
|
|
529 | =item --include pattern | -i pattern | --exclude pattern | -x pattern |
|
|
530 | |
|
|
531 | These two options define an include/exclude filter that is used after all |
|
|
532 | files selected by the other options have been found. Each include/exclude |
|
|
533 | is applied to all files found so far - an include makes sure that the |
|
|
534 | given files will be part of the resulting file set, an exclude will |
|
|
535 | exclude files. The patterns are "extended glob patterns" (see below). |
|
|
536 | |
|
|
537 | For example, to include everything, except C<Devel> modules, but still |
|
|
538 | include F<Devel::PPPort>, you could use this: |
|
|
539 | |
|
|
540 | --incglob '*' -i '/Devel/PPPort.pm' -x '/Devel/**' |
407 | |
541 | |
408 | =item --static |
542 | =item --static |
409 | |
543 | |
410 | When C<--perl> is also given, link statically instead of dynamically. The |
544 | When C<--perl> is also given, link statically instead of dynamically. The |
411 | default is to link the new perl interpreter fully dynamic (that means all |
545 | default is to link the new perl interpreter fully dynamic (that means all |
… | |
… | |
416 | systems based on GNU libc don't really support it in a usable fashion |
550 | systems based on GNU libc don't really support it in a usable fashion |
417 | either. Try uClibc if you want to create fully statically linked |
551 | either. Try uClibc if you want to create fully statically linked |
418 | executables, or try the C<--staticlibs> option to link only some libraries |
552 | executables, or try the C<--staticlibs> option to link only some libraries |
419 | statically. |
553 | statically. |
420 | |
554 | |
|
|
555 | =item --staticlib libname |
|
|
556 | |
|
|
557 | When not linking fully statically, this option allows you to link specific |
|
|
558 | libraries statically. What it does is simply replace all occurances of |
|
|
559 | C<-llibname> with the GCC-specific C<-Wl,-Bstatic -llibname -Wl,-Bdynamic> |
|
|
560 | option. |
|
|
561 | |
|
|
562 | This will have no effect unless the library is actually linked against, |
|
|
563 | specifically, C<--staticlib> will not link against the named library |
|
|
564 | unless it would be linked against anyway. |
|
|
565 | |
|
|
566 | Example: link libcrypt statically into the binary. |
|
|
567 | |
|
|
568 | staticperl mkperl -MIO::AIO --staticlib crypt |
|
|
569 | |
|
|
570 | # ldopts might nwo contain: |
|
|
571 | # -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread |
|
|
572 | |
421 | =item any other argument |
573 | =item any other argument |
422 | |
574 | |
423 | Any other argument is interpreted as a bundle specification file, which |
575 | Any other argument is interpreted as a bundle specification file, which |
424 | supports most long options (without extra quoting), one option per line. |
576 | supports most long options (without extra quoting), one option per line. |
425 | |
577 | |
426 | =back |
578 | =back |
427 | |
579 | |
|
|
580 | =head3 EXTENDED GLOB PATTERNS |
|
|
581 | |
|
|
582 | Some options of F<staticperl mkbundle> expect an I<extended glob |
|
|
583 | pattern>. This is neither a normal shell glob nor a regex, but something |
|
|
584 | in between. The idea has been copied from rsync, and there are the current |
|
|
585 | matching rules: |
|
|
586 | |
|
|
587 | =over 4 |
|
|
588 | |
|
|
589 | =item Patterns starting with F</> will be a anchored at the root of the library tree. |
|
|
590 | |
|
|
591 | That is, F</unicore> will match the F<unicore> directory in C<@INC>, but |
|
|
592 | nothing inside, and neither any other file or directory called F<unicore> |
|
|
593 | anywhere else in the hierarchy. |
|
|
594 | |
|
|
595 | =item Patterns not starting with F</> will be anchored at the end of the path. |
|
|
596 | |
|
|
597 | That is, F<idna.pl> will match any file called F<idna.pl> anywhere in the |
|
|
598 | hierarchy, but not any directories of the same name. |
|
|
599 | |
|
|
600 | =item A F<*> matches any single component. |
|
|
601 | |
|
|
602 | That is, F</unicore/*.pl> would match all F<.pl> files directly inside |
|
|
603 | C</unicore>, not any deeper level F<.pl> files. Or in other words, F<*> |
|
|
604 | will not match slashes. |
|
|
605 | |
|
|
606 | =item A F<**> matches anything. |
|
|
607 | |
|
|
608 | That is, F</unicore/**.pl> would match all F<.pl> files under F</unicore>, |
|
|
609 | no matter how deeply nested they are inside subdirectories. |
|
|
610 | |
|
|
611 | =item A F<?> matches a single character within a component. |
|
|
612 | |
|
|
613 | That is, F</Encode/??.pm> matches F</Encode/JP.pm>, but not the |
|
|
614 | hypothetical F</Encode/J/.pm>, as F<?> does not match F</>. |
|
|
615 | |
|
|
616 | =back |
|
|
617 | |
428 | =head2 F<STATCPERL> CONFIGURATION AND HOOKS |
618 | =head2 F<STATICPERL> CONFIGURATION AND HOOKS |
429 | |
619 | |
430 | During (each) startup, F<staticperl> tries to source the following shell |
620 | During (each) startup, F<staticperl> tries to source some shell files to |
|
|
621 | allow you to fine-tune/override configuration settings. |
|
|
622 | |
|
|
623 | In them you can override shell variables, or define shell functions |
|
|
624 | ("hooks") to be called at specific phases during installation. For |
|
|
625 | example, you could define a C<postinstall> hook to install additional |
|
|
626 | modules from CPAN each time you start from scratch. |
|
|
627 | |
|
|
628 | If the env variable C<$STATICPERLRC> is set, then F<staticperl> will try |
|
|
629 | to source the file named with it only. Otherwise, it tries the following |
431 | files in order: |
630 | shell files in order: |
432 | |
631 | |
433 | /etc/staticperlrc |
632 | /etc/staticperlrc |
434 | ~/.staticperlrc |
633 | ~/.staticperlrc |
435 | $STATICPERL/rc |
634 | $STATICPERL/rc |
436 | |
|
|
437 | They can be used to override shell variables, or define functions to be |
|
|
438 | called at specific phases. |
|
|
439 | |
635 | |
440 | Note that the last file is erased during F<staticperl distclean>, so |
636 | Note that the last file is erased during F<staticperl distclean>, so |
441 | generally should not be used. |
637 | generally should not be used. |
442 | |
638 | |
443 | =head3 CONFIGURATION VARIABLES |
639 | =head3 CONFIGURATION VARIABLES |
… | |
… | |
747 | After you have compiled and set up your buildroot target, you can copy |
943 | After you have compiled and set up your buildroot target, you can copy |
748 | F<staticperl> from the C<App::Staticperl> distribution or from your |
944 | F<staticperl> from the C<App::Staticperl> distribution or from your |
749 | perl f<bin> directory (if you installed it) into the F<output/target> |
945 | perl f<bin> directory (if you installed it) into the F<output/target> |
750 | filesystem, chroot inside and run it. |
946 | filesystem, chroot inside and run it. |
751 | |
947 | |
|
|
948 | =head1 RECIPES / SPECIFIC MODULES |
|
|
949 | |
|
|
950 | This section contains some common(?) recipes and information about |
|
|
951 | problems with some common modules or perl constructs that require extra |
|
|
952 | files to be included. |
|
|
953 | |
|
|
954 | =head2 MODULES |
|
|
955 | |
|
|
956 | =over 4 |
|
|
957 | |
|
|
958 | =item utf8 |
|
|
959 | |
|
|
960 | Some functionality in the utf8 module, such as swash handling (used |
|
|
961 | for unicode character ranges in regexes) is implemented in the |
|
|
962 | C<"utf8_heavy.pl"> library: |
|
|
963 | |
|
|
964 | -M'"utf8_heavy.pl"' |
|
|
965 | |
|
|
966 | Many Unicode properties in turn are defined in separate modules, |
|
|
967 | such as C<"unicore/Heavy.pl"> and more specific data tables such as |
|
|
968 | C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables |
|
|
969 | are big (7MB uncompressed, although F<staticperl> contains special |
|
|
970 | handling for those files), so including them on demand by your application |
|
|
971 | only might pay off. |
|
|
972 | |
|
|
973 | To simply include the whole unicode database, use: |
|
|
974 | |
|
|
975 | --incglob '/unicore/*.pl' |
|
|
976 | |
|
|
977 | =item AnyEvent |
|
|
978 | |
|
|
979 | AnyEvent needs a backend implementation that it will load in a delayed |
|
|
980 | fashion. The L<AnyEvent::Impl::Perl> backend is the default choice |
|
|
981 | for AnyEvent if it can't find anything else, and is usually a safe |
|
|
982 | fallback. If you plan to use e.g. L<EV> (L<POE>...), then you need to |
|
|
983 | include the L<AnyEvent::Impl::EV> (L<AnyEvent::Impl::POE>...) backend as |
|
|
984 | well. |
|
|
985 | |
|
|
986 | If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn |
|
|
987 | functions), you also need to include C<"AnyEvent/Util/idna.pl"> and |
|
|
988 | C<"AnyEvent/Util/uts46data.pl">. |
|
|
989 | |
|
|
990 | Or you can use C<--usepacklist> and specify C<-MAnyEvent> to include |
|
|
991 | everything. |
|
|
992 | |
|
|
993 | =item Carp |
|
|
994 | |
|
|
995 | Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of |
|
|
996 | perl 5.12.2 (maybe earlier), this dependency no longer exists. |
|
|
997 | |
|
|
998 | =item Config |
|
|
999 | |
|
|
1000 | The F<perl -V> switch (as well as many modules) needs L<Config>, which in |
|
|
1001 | turn might need L<"Config_heavy.pl">. Including the latter gives you |
|
|
1002 | both. |
|
|
1003 | |
|
|
1004 | =item Term::ReadLine::Perl |
|
|
1005 | |
|
|
1006 | Also needs L<Term::ReadLine::readline>, or C<--usepacklist>. |
|
|
1007 | |
|
|
1008 | =item URI |
|
|
1009 | |
|
|
1010 | URI implements schemes as separate modules - the generic URL scheme is |
|
|
1011 | implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If |
|
|
1012 | you need to use any of these schemes, you should include these manually, |
|
|
1013 | or use C<--usepacklist>. |
|
|
1014 | |
|
|
1015 | =back |
|
|
1016 | |
|
|
1017 | =head2 RECIPES |
|
|
1018 | |
|
|
1019 | =over 4 |
|
|
1020 | |
|
|
1021 | =item Linking everything in |
|
|
1022 | |
|
|
1023 | To link just about everything installed in the perl library into a new |
|
|
1024 | perl, try this: |
|
|
1025 | |
|
|
1026 | staticperl mkperl --strip ppi --incglob '*' |
|
|
1027 | |
|
|
1028 | =item Getting rid of netdb function |
|
|
1029 | |
|
|
1030 | The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent> |
|
|
1031 | and so on) that few applications use. You can avoid compiling them in by |
|
|
1032 | putting the following fragment into a C<preconfigure> hook: |
|
|
1033 | |
|
|
1034 | preconfigure() { |
|
|
1035 | for sym in \ |
|
|
1036 | d_getgrnam_r d_endgrent d_endgrent_r d_endhent \ |
|
|
1037 | d_endhostent_r d_endnent d_endnetent_r d_endpent \ |
|
|
1038 | d_endprotoent_r d_endpwent d_endpwent_r d_endsent \ |
|
|
1039 | d_endservent_r d_getgrent d_getgrent_r d_getgrgid_r \ |
|
|
1040 | d_getgrnam_r d_gethbyaddr d_gethent d_getsbyport \ |
|
|
1041 | d_gethostbyaddr_r d_gethostbyname_r d_gethostent_r \ |
|
|
1042 | d_getlogin_r d_getnbyaddr d_getnbyname d_getnent \ |
|
|
1043 | d_getnetbyaddr_r d_getnetbyname_r d_getnetent_r \ |
|
|
1044 | d_getpent d_getpbyname d_getpbynumber d_getprotobyname_r \ |
|
|
1045 | d_getprotobynumber_r d_getprotoent_r d_getpwent \ |
|
|
1046 | d_getpwent_r d_getpwnam_r d_getpwuid_r d_getsent \ |
|
|
1047 | d_getservbyname_r d_getservbyport_r d_getservent_r \ |
|
|
1048 | d_getspnam_r d_getsbyname |
|
|
1049 | # d_gethbyname |
|
|
1050 | do |
|
|
1051 | PERL_CONFIGURE="$PERL_CONFIGURE -U$sym" |
|
|
1052 | done |
|
|
1053 | } |
|
|
1054 | |
|
|
1055 | This mostly gains space when linking staticaly, as the functions will |
|
|
1056 | liekly not be linked in. The gain for dynamically-linked binaries is |
|
|
1057 | smaller. |
|
|
1058 | |
|
|
1059 | Also, this leaves C<gethostbyname> in - not only is it actually used |
|
|
1060 | often, the L<Socket> module also exposes it, so leaving it out usually |
|
|
1061 | gains little. Why Socket exposes a C function that is in the core already |
|
|
1062 | is anybody's guess. |
|
|
1063 | |
|
|
1064 | =back |
|
|
1065 | |
752 | =head1 AUTHOR |
1066 | =head1 AUTHOR |
753 | |
1067 | |
754 | Marc Lehmann <schmorp@schmorp.de> |
1068 | Marc Lehmann <schmorp@schmorp.de> |
755 | http://software.schmorp.de/pkg/staticperl.html |
1069 | http://software.schmorp.de/pkg/staticperl.html |