… | |
… | |
40 | |
40 | |
41 | 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 |
42 | 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, |
43 | Coro and so on. Or any other choice of modules. |
43 | Coro and so on. Or any other choice of modules. |
44 | |
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 | |
45 | 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 |
46 | 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, |
47 | here are the differences: |
51 | here are the differences: |
48 | |
52 | |
49 | =over 4 |
53 | =over 4 |
… | |
… | |
67 | =item * The generated executables don't need a writable filesystem. |
71 | =item * The generated executables don't need a writable filesystem. |
68 | |
72 | |
69 | 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 |
70 | need to unpack files into a temporary directory. |
74 | need to unpack files into a temporary directory. |
71 | |
75 | |
72 | =item * More control over included files. |
76 | =item * More control over included files, more burden. |
73 | |
77 | |
74 | 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 |
75 | 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 |
76 | 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) |
77 | memory and file size. |
81 | can take substantial amounts of memory and file size. |
78 | |
82 | |
79 | 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 |
80 | compile-time dependencies and L<AutoLoader> are handled automatically. |
84 | compile-time dependencies and L<AutoLoader> are handled automatically. |
81 | 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. |
82 | |
90 | |
83 | =item * PAR works out of the box, F<staticperl> does not. |
91 | =item * PAR works out of the box, F<staticperl> does not. |
84 | |
92 | |
85 | 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 |
86 | 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 |
… | |
… | |
107 | 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, |
108 | 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 |
109 | 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 |
110 | sources you can use to embed all files into your project). |
118 | sources you can use to embed all files into your project). |
111 | |
119 | |
112 | 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 |
113 | 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 |
114 | repeated as often as necessary. |
122 | often as necessary. |
115 | |
123 | |
116 | =head1 THE F<STATICPERL> SCRIPT |
124 | =head1 THE F<STATICPERL> SCRIPT |
117 | |
125 | |
118 | This module installs a script called F<staticperl> into your perl |
126 | This module installs a script called F<staticperl> into your perl |
119 | binary directory. The script is fully self-contained, and can be used |
127 | binary directory. The script is fully self-contained, and can be |
120 | without perl (for example, in an uClibc chroot environment). In fact, |
128 | used without perl (for example, in an uClibc chroot environment). In |
121 | it can be extracted from the C<App::Staticperl> distribution tarball as |
129 | fact, it can be extracted from the C<App::Staticperl> distribution |
122 | F<bin/staticperl>, without any installation. |
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>. |
123 | |
133 | |
124 | F<staticperl> interprets the first argument as a command to execute, |
134 | F<staticperl> interprets the first argument as a command to execute, |
125 | optionally followed by any parameters. |
135 | optionally followed by any parameters. |
126 | |
136 | |
127 | There are two command categories: the "phase 1" commands which deal with |
137 | There are two command categories: the "phase 1" commands which deal with |
… | |
… | |
137 | |
147 | |
138 | The command |
148 | The command |
139 | |
149 | |
140 | staticperl install |
150 | staticperl install |
141 | |
151 | |
142 | Is normally all you need: It installs the perl interpreter in |
152 | is normally all you need: It installs the perl interpreter in |
143 | F<~/.staticperl/perl>. It downloads, configures, builds and installs the |
153 | F<~/.staticperl/perl>. It downloads, configures, builds and installs the |
144 | perl interpreter if required. |
154 | perl interpreter if required. |
145 | |
155 | |
146 | Most of the following commands simply run one or more steps of this |
156 | Most of the following F<staticperl> subcommands simply run one or more |
147 | sequence. |
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. |
148 | |
163 | |
149 | To force recompilation or reinstallation, you need to run F<staticperl |
164 | To force recompilation or reinstallation, you need to run F<staticperl |
150 | distclean> first. |
165 | distclean> first. |
151 | |
166 | |
152 | =over 4 |
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. |
153 | |
172 | |
154 | =item F<staticperl fetch> |
173 | =item F<staticperl fetch> |
155 | |
174 | |
156 | Runs only the download and unpack phase, unless this has already happened. |
175 | Runs only the download and unpack phase, unless this has already happened. |
157 | |
176 | |
… | |
… | |
195 | |
214 | |
196 | =item F<staticperl clean> |
215 | =item F<staticperl clean> |
197 | |
216 | |
198 | Deletes the perl source directory (and potentially cleans up other |
217 | Deletes the perl source directory (and potentially cleans up other |
199 | intermediate files). This can be used to clean up files only needed for |
218 | intermediate files). This can be used to clean up files only needed for |
200 | building perl, without removing the installed perl interpreter, or to |
219 | building perl, without removing the installed perl interpreter. |
201 | force a re-build from scratch. |
|
|
202 | |
220 | |
203 | At the moment, it doesn't delete downloaded tarballs. |
221 | At the moment, it doesn't delete downloaded tarballs. |
|
|
222 | |
|
|
223 | The exact semantics of this command will probably change. |
204 | |
224 | |
205 | =item F<staticperl distclean> |
225 | =item F<staticperl distclean> |
206 | |
226 | |
207 | This wipes your complete F<~/.staticperl> directory. Be careful with this, |
227 | This wipes your complete F<~/.staticperl> directory. Be careful with this, |
208 | it nukes your perl download, perl sources, perl distribution and any |
228 | it nukes your perl download, perl sources, perl distribution and any |
… | |
… | |
282 | |
302 | |
283 | All options that specify modules or files to be added are processed in the |
303 | All options that specify modules or files to be added are processed in the |
284 | order given on the command line (that affects the C<--use> and C<--eval> |
304 | order given on the command line (that affects the C<--use> and C<--eval> |
285 | options at the moment). |
305 | options at the moment). |
286 | |
306 | |
|
|
307 | =head3 PACKAGE SELECTION WORKFLOW |
|
|
308 | |
|
|
309 | F<staticperl mkbundle> has a number of options to control package |
|
|
310 | selection. This section describes how they interact with each other. Also, |
|
|
311 | since I am still a newbie w.r.t. these issues, maybe future versions of |
|
|
312 | F<staticperl> will change this, so watch out :) |
|
|
313 | |
|
|
314 | The idiom "in order" means "in order that they are specified on the |
|
|
315 | commandline". If you use a bundle specification file, then the options |
|
|
316 | will 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 |
|
|
321 | C<--incglob> options, in order. |
|
|
322 | |
|
|
323 | In addition, C<--use> and C<--eval> dependencies will be added when the |
|
|
324 | options are processed. |
|
|
325 | |
|
|
326 | =item 2. apply all C<--include> and C<--exclude> options, in order. |
|
|
327 | |
|
|
328 | All this step does is potentially reduce the number of files already |
|
|
329 | selected 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 |
|
|
333 | extra libraries they need for linking (F<extralibs.ld>) and optionally |
|
|
334 | evaluate any F<.packlist> files. |
|
|
335 | |
|
|
336 | This step is required to link against XS extensions and also adds files |
|
|
337 | required for L<AutoLoader> to do it's job. |
|
|
338 | |
|
|
339 | =back |
|
|
340 | |
|
|
341 | After 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> |
|
|
343 | or application binary will be linked. |
|
|
344 | |
287 | =head3 MKBUNDLE OPTIONS |
345 | =head3 MKBUNDLE OPTIONS |
288 | |
346 | |
289 | =over 4 |
347 | =over 4 |
290 | |
348 | |
291 | =item --verbose | -v |
349 | =item --verbose | -v |
… | |
… | |
303 | |
361 | |
304 | The default is C<pod>, which uses the L<Pod::Strip> module to remove all |
362 | The default is C<pod>, which uses the L<Pod::Strip> module to remove all |
305 | pod documentation, which is very fast and reduces file size a lot. |
363 | pod documentation, which is very fast and reduces file size a lot. |
306 | |
364 | |
307 | The C<ppi> method uses L<PPI> to parse and condense the perl sources. This |
365 | The C<ppi> method uses L<PPI> to parse and condense the perl sources. This |
308 | saves a lot more than just L<Pod::Strip>, and is generally safer, but |
366 | saves a lot more than just L<Pod::Strip>, and is generally safer, |
309 | is also a lot slower, so is best used for production builds. Note that |
367 | but is also a lot slower (some files take almost a minute to strip - |
310 | this method doesn't optimise for raw file size, but for best compression |
368 | F<staticperl> maintains a cache of stripped files to speed up subsequent |
311 | (that means that the uncompressed file size is a bit larger, but the files |
369 | runs for this reason). Note that this method doesn't optimise for raw file |
312 | compress better, e.g. with F<upx>). |
370 | size, but for best compression (that means that the uncompressed file size |
|
|
371 | is a bit larger, but the files compress better, e.g. with F<upx>). |
313 | |
372 | |
314 | Last not least, if you need accurate line numbers in error messages, |
373 | Last not least, if you need accurate line numbers in error messages, |
315 | or in the unlikely case where C<pod> is too slow, or some module gets |
374 | or in the unlikely case where C<pod> is too slow, or some module gets |
316 | mistreated, you can specify C<none> to not mangle included perl sources in |
375 | mistreated, you can specify C<none> to not mangle included perl sources in |
317 | any way. |
376 | any way. |
… | |
… | |
411 | (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 |
412 | initialised. This can be used to modify C<@INC> or anything else before |
471 | initialised. This can be used to modify C<@INC> or anything else before |
413 | the perl interpreter executes scripts given on the command line (or via |
472 | the perl interpreter executes scripts given on the command line (or via |
414 | C<-e>). This works even in an embedded interpreter. |
473 | C<-e>). This works even in an embedded interpreter. |
415 | |
474 | |
416 | =item --add "file" | --add "file alias" |
475 | =item --usepacklist |
|
|
476 | |
|
|
477 | Read F<.packlist> files for each distribution that happens to match a |
|
|
478 | module name you specified. Sounds weird, and it is, so expect semantics to |
|
|
479 | change somehow in the future. |
|
|
480 | |
|
|
481 | The idea is that most CPAN distributions have a F<.pm> file that matches |
|
|
482 | the name of the distribution (which is rather reasonable after all). |
|
|
483 | |
|
|
484 | If this switch is enabled, then if any of the F<.pm> files that have been |
|
|
485 | selected match an install distribution, then all F<.pm>, F<.pl>, F<.al> |
|
|
486 | and F<.ix> files installed by this distribution are also included. |
|
|
487 | |
|
|
488 | For example, using this switch, when the L<URI> module is specified, then |
|
|
489 | all L<URI> submodules that have been installed via the CPAN distribution |
|
|
490 | are included as well, so you don't have to manually specify them. |
|
|
491 | |
|
|
492 | =item --incglob pattern |
|
|
493 | |
|
|
494 | This goes through all library directories and tries to match any F<.pm> |
|
|
495 | and F<.pl> files against the extended glob pattern (see below). If a file |
|
|
496 | matches, it is added. This switch will automatically detect L<AutoLoader> |
|
|
497 | files and the required link libraries for XS modules, but it will I<not> |
|
|
498 | scan the file for dependencies (at the moment). |
|
|
499 | |
|
|
500 | This is mainly useful to include "everything": |
|
|
501 | |
|
|
502 | --incglob '*' |
|
|
503 | |
|
|
504 | Or to include perl libraries, or trees of those, such as the unicode |
|
|
505 | database files needed by many other modules: |
|
|
506 | |
|
|
507 | --incglob '/unicore/**.pl' |
|
|
508 | |
|
|
509 | =item --add file | --add "file alias" |
417 | |
510 | |
418 | Adds the given (perl) file into the bundle (and optionally call it |
511 | Adds the given (perl) file into the bundle (and optionally call it |
419 | "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. |
420 | |
513 | |
421 | Example: embed the file F<httpd> as F<httpd.pm> when creating the bundle. |
514 | Example: embed the file F<httpd> as F<httpd.pm> when creating the bundle. |
… | |
… | |
427 | # specification file |
520 | # specification file |
428 | add file1 myfiles/file1 |
521 | add file1 myfiles/file1 |
429 | add file2 myfiles/file2 |
522 | add file2 myfiles/file2 |
430 | add file3 myfiles/file3 |
523 | add file3 myfiles/file3 |
431 | |
524 | |
432 | =item --binadd "file" | --add "file alias" |
525 | =item --binadd file | --add "file alias" |
433 | |
526 | |
434 | Just like C<--add>, except that it treats the file as binary and adds it |
527 | Just like C<--add>, except that it treats the file as binary and adds it |
435 | without any processing. |
528 | without any processing. |
436 | |
529 | |
437 | You should probably add a C</> prefix to avoid clashing with embedded |
530 | You should probably add a C</> prefix to avoid clashing with embedded |
438 | perl files (whose paths do not start with C</>), and/or use a special |
531 | perl files (whose paths do not start with C</>), and/or use a special |
439 | directory, such as C</res/name>. |
532 | directory, such as C</res/name>. |
440 | |
533 | |
441 | You can later get a copy of these files by calling C<staticperl::find |
534 | You can later get a copy of these files by calling C<staticperl::find |
442 | "alias">. |
535 | "alias">. |
|
|
536 | |
|
|
537 | =item --include pattern | -i pattern | --exclude pattern | -x pattern |
|
|
538 | |
|
|
539 | These two options define an include/exclude filter that is used after all |
|
|
540 | files selected by the other options have been found. Each include/exclude |
|
|
541 | is applied to all files found so far - an include makes sure that the |
|
|
542 | given files will be part of the resulting file set, an exclude will |
|
|
543 | exclude files. The patterns are "extended glob patterns" (see below). |
|
|
544 | |
|
|
545 | For example, to include everything, except C<Devel> modules, but still |
|
|
546 | include F<Devel::PPPort>, you could use this: |
|
|
547 | |
|
|
548 | --incglob '*' -i '/Devel/PPPort.pm' -x '/Devel/**' |
443 | |
549 | |
444 | =item --static |
550 | =item --static |
445 | |
551 | |
446 | When C<--perl> is also given, link statically instead of dynamically. The |
552 | When C<--perl> is also given, link statically instead of dynamically. The |
447 | default is to link the new perl interpreter fully dynamic (that means all |
553 | default is to link the new perl interpreter fully dynamic (that means all |
… | |
… | |
452 | systems based on GNU libc don't really support it in a usable fashion |
558 | systems based on GNU libc don't really support it in a usable fashion |
453 | either. Try uClibc if you want to create fully statically linked |
559 | either. Try uClibc if you want to create fully statically linked |
454 | executables, or try the C<--staticlibs> option to link only some libraries |
560 | executables, or try the C<--staticlibs> option to link only some libraries |
455 | statically. |
561 | statically. |
456 | |
562 | |
|
|
563 | =item --staticlib libname |
|
|
564 | |
|
|
565 | When not linking fully statically, this option allows you to link specific |
|
|
566 | libraries statically. What it does is simply replace all occurances of |
|
|
567 | C<-llibname> with the GCC-specific C<-Wl,-Bstatic -llibname -Wl,-Bdynamic> |
|
|
568 | option. |
|
|
569 | |
|
|
570 | This will have no effect unless the library is actually linked against, |
|
|
571 | specifically, C<--staticlib> will not link against the named library |
|
|
572 | unless it would be linked against anyway. |
|
|
573 | |
|
|
574 | Example: 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 | |
457 | =item any other argument |
581 | =item any other argument |
458 | |
582 | |
459 | Any other argument is interpreted as a bundle specification file, which |
583 | Any other argument is interpreted as a bundle specification file, which |
460 | supports most long options (without extra quoting), one option per line. |
584 | supports most long options (without extra quoting), one option per line. |
461 | |
585 | |
462 | =back |
586 | =back |
463 | |
587 | |
|
|
588 | =head3 EXTENDED GLOB PATTERNS |
|
|
589 | |
|
|
590 | Some options of F<staticperl mkbundle> expect an I<extended glob |
|
|
591 | pattern>. This is neither a normal shell glob nor a regex, but something |
|
|
592 | in between. The idea has been copied from rsync, and there are the current |
|
|
593 | matching rules: |
|
|
594 | |
|
|
595 | =over 4 |
|
|
596 | |
|
|
597 | =item Patterns starting with F</> will be a anchored at the root of the library tree. |
|
|
598 | |
|
|
599 | That is, F</unicore> will match the F<unicore> directory in C<@INC>, but |
|
|
600 | nothing inside, and neither any other file or directory called F<unicore> |
|
|
601 | anywhere else in the hierarchy. |
|
|
602 | |
|
|
603 | =item Patterns not starting with F</> will be anchored at the end of the path. |
|
|
604 | |
|
|
605 | That is, F<idna.pl> will match any file called F<idna.pl> anywhere in the |
|
|
606 | hierarchy, but not any directories of the same name. |
|
|
607 | |
|
|
608 | =item A F<*> matches any single component. |
|
|
609 | |
|
|
610 | That is, F</unicore/*.pl> would match all F<.pl> files directly inside |
|
|
611 | C</unicore>, not any deeper level F<.pl> files. Or in other words, F<*> |
|
|
612 | will not match slashes. |
|
|
613 | |
|
|
614 | =item A F<**> matches anything. |
|
|
615 | |
|
|
616 | That is, F</unicore/**.pl> would match all F<.pl> files under F</unicore>, |
|
|
617 | no matter how deeply nested they are inside subdirectories. |
|
|
618 | |
|
|
619 | =item A F<?> matches a single character within a component. |
|
|
620 | |
|
|
621 | That is, F</Encode/??.pm> matches F</Encode/JP.pm>, but not the |
|
|
622 | hypothetical F</Encode/J/.pm>, as F<?> does not match F</>. |
|
|
623 | |
|
|
624 | =back |
|
|
625 | |
464 | =head2 F<STATICPERL> CONFIGURATION AND HOOKS |
626 | =head2 F<STATICPERL> CONFIGURATION AND HOOKS |
465 | |
627 | |
466 | During (each) startup, F<staticperl> tries to source the following shell |
628 | During (each) startup, F<staticperl> tries to source some shell files to |
|
|
629 | allow you to fine-tune/override configuration settings. |
|
|
630 | |
|
|
631 | In them you can override shell variables, or define shell functions |
|
|
632 | ("hooks") to be called at specific phases during installation. For |
|
|
633 | example, you could define a C<postinstall> hook to install additional |
|
|
634 | modules from CPAN each time you start from scratch. |
|
|
635 | |
|
|
636 | If the env variable C<$STATICPERLRC> is set, then F<staticperl> will try |
|
|
637 | to source the file named with it only. Otherwise, it tries the following |
467 | files in order: |
638 | shell files in order: |
468 | |
639 | |
469 | /etc/staticperlrc |
640 | /etc/staticperlrc |
470 | ~/.staticperlrc |
641 | ~/.staticperlrc |
471 | $STATICPERL/rc |
642 | $STATICPERL/rc |
472 | |
|
|
473 | They can be used to override shell variables, or define functions to be |
|
|
474 | called at specific phases. |
|
|
475 | |
643 | |
476 | Note that the last file is erased during F<staticperl distclean>, so |
644 | Note that the last file is erased during F<staticperl distclean>, so |
477 | generally should not be used. |
645 | generally should not be used. |
478 | |
646 | |
479 | =head3 CONFIGURATION VARIABLES |
647 | =head3 CONFIGURATION VARIABLES |
… | |
… | |
541 | |
709 | |
542 | More commonly, you would either activate 64 bit integer support |
710 | More commonly, you would either activate 64 bit integer support |
543 | (C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to |
711 | (C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to |
544 | reduce filesize further. |
712 | reduce filesize further. |
545 | |
713 | |
546 | =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> |
547 | |
715 | |
548 | These flags are passed to perl's F<Configure> script, and are generally |
716 | These flags are passed to perl's F<Configure> script, and are generally |
549 | optimised for small size (at the cost of performance). Since they also |
717 | optimised for small size (at the cost of performance). Since they also |
550 | contain subtle workarounds around various build issues, changing these |
718 | contain subtle workarounds around various build issues, changing these |
551 | usually requires understanding their default values - best look at the top |
719 | usually requires understanding their default values - best look at |
552 | of the F<staticperl> script for more info on these. |
720 | the top of the F<staticperl> script for more info on these, and use a |
|
|
721 | F<~/.staticperlrc> to override them. |
|
|
722 | |
|
|
723 | Most of the variables override (or modify) the corresponding F<Configure> |
|
|
724 | variable, except C<PERL_CCFLAGS>, which gets appended. |
553 | |
725 | |
554 | =back |
726 | =back |
555 | |
727 | |
556 | =head4 Variables you probably I<do not want> to override |
728 | =head4 Variables you probably I<do not want> to override |
557 | |
729 | |
558 | =over 4 |
730 | =over 4 |
|
|
731 | |
|
|
732 | =item C<MAKE> |
|
|
733 | |
|
|
734 | The make command to use - default is C<make>. |
559 | |
735 | |
560 | =item C<MKBUNDLE> |
736 | =item C<MKBUNDLE> |
561 | |
737 | |
562 | Where F<staticperl> writes the C<mkbundle> command to |
738 | Where F<staticperl> writes the C<mkbundle> command to |
563 | (default: F<$STATICPERL/mkbundle>). |
739 | (default: F<$STATICPERL/mkbundle>). |
… | |
… | |
783 | After you have compiled and set up your buildroot target, you can copy |
959 | After you have compiled and set up your buildroot target, you can copy |
784 | F<staticperl> from the C<App::Staticperl> distribution or from your |
960 | F<staticperl> from the C<App::Staticperl> distribution or from your |
785 | perl f<bin> directory (if you installed it) into the F<output/target> |
961 | perl f<bin> directory (if you installed it) into the F<output/target> |
786 | filesystem, chroot inside and run it. |
962 | filesystem, chroot inside and run it. |
787 | |
963 | |
|
|
964 | =head1 RECIPES / SPECIFIC MODULES |
|
|
965 | |
|
|
966 | This section contains some common(?) recipes and information about |
|
|
967 | problems with some common modules or perl constructs that require extra |
|
|
968 | files to be included. |
|
|
969 | |
|
|
970 | =head2 MODULES |
|
|
971 | |
|
|
972 | =over 4 |
|
|
973 | |
|
|
974 | =item utf8 |
|
|
975 | |
|
|
976 | Some functionality in the utf8 module, such as swash handling (used |
|
|
977 | for unicode character ranges in regexes) is implemented in the |
|
|
978 | C<"utf8_heavy.pl"> library: |
|
|
979 | |
|
|
980 | -M'"utf8_heavy.pl"' |
|
|
981 | |
|
|
982 | Many Unicode properties in turn are defined in separate modules, |
|
|
983 | such as C<"unicore/Heavy.pl"> and more specific data tables such as |
|
|
984 | C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables |
|
|
985 | are big (7MB uncompressed, although F<staticperl> contains special |
|
|
986 | handling for those files), so including them on demand by your application |
|
|
987 | only might pay off. |
|
|
988 | |
|
|
989 | To simply include the whole unicode database, use: |
|
|
990 | |
|
|
991 | --incglob '/unicore/*.pl' |
|
|
992 | |
|
|
993 | =item AnyEvent |
|
|
994 | |
|
|
995 | AnyEvent needs a backend implementation that it will load in a delayed |
|
|
996 | fashion. The L<AnyEvent::Impl::Perl> backend is the default choice |
|
|
997 | for AnyEvent if it can't find anything else, and is usually a safe |
|
|
998 | fallback. If you plan to use e.g. L<EV> (L<POE>...), then you need to |
|
|
999 | include the L<AnyEvent::Impl::EV> (L<AnyEvent::Impl::POE>...) backend as |
|
|
1000 | well. |
|
|
1001 | |
|
|
1002 | If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn |
|
|
1003 | functions), you also need to include C<"AnyEvent/Util/idna.pl"> and |
|
|
1004 | C<"AnyEvent/Util/uts46data.pl">. |
|
|
1005 | |
|
|
1006 | Or you can use C<--usepacklist> and specify C<-MAnyEvent> to include |
|
|
1007 | everything. |
|
|
1008 | |
|
|
1009 | =item Carp |
|
|
1010 | |
|
|
1011 | Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of |
|
|
1012 | perl 5.12.2 (maybe earlier), this dependency no longer exists. |
|
|
1013 | |
|
|
1014 | =item Config |
|
|
1015 | |
|
|
1016 | The F<perl -V> switch (as well as many modules) needs L<Config>, which in |
|
|
1017 | turn might need L<"Config_heavy.pl">. Including the latter gives you |
|
|
1018 | both. |
|
|
1019 | |
|
|
1020 | =item Term::ReadLine::Perl |
|
|
1021 | |
|
|
1022 | Also needs L<Term::ReadLine::readline>, or C<--usepacklist>. |
|
|
1023 | |
|
|
1024 | =item URI |
|
|
1025 | |
|
|
1026 | URI implements schemes as separate modules - the generic URL scheme is |
|
|
1027 | implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If |
|
|
1028 | you need to use any of these schemes, you should include these manually, |
|
|
1029 | or use C<--usepacklist>. |
|
|
1030 | |
|
|
1031 | =back |
|
|
1032 | |
|
|
1033 | =head2 RECIPES |
|
|
1034 | |
|
|
1035 | =over 4 |
|
|
1036 | |
|
|
1037 | =item Linking everything in |
|
|
1038 | |
|
|
1039 | To link just about everything installed in the perl library into a new |
|
|
1040 | perl, try this: |
|
|
1041 | |
|
|
1042 | staticperl mkperl --strip ppi --incglob '*' |
|
|
1043 | |
|
|
1044 | =item Getting rid of netdb function |
|
|
1045 | |
|
|
1046 | The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent> |
|
|
1047 | and so on) that few applications use. You can avoid compiling them in by |
|
|
1048 | putting 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 | |
|
|
1071 | This mostly gains space when linking staticaly, as the functions will |
|
|
1072 | likely not be linked in. The gain for dynamically-linked binaries is |
|
|
1073 | smaller. |
|
|
1074 | |
|
|
1075 | Also, this leaves C<gethostbyname> in - not only is it actually used |
|
|
1076 | often, the L<Socket> module also exposes it, so leaving it out usually |
|
|
1077 | gains little. Why Socket exposes a C function that is in the core already |
|
|
1078 | is anybody's guess. |
|
|
1079 | |
|
|
1080 | =back |
|
|
1081 | |
788 | =head1 AUTHOR |
1082 | =head1 AUTHOR |
789 | |
1083 | |
790 | Marc Lehmann <schmorp@schmorp.de> |
1084 | Marc Lehmann <schmorp@schmorp.de> |
791 | http://software.schmorp.de/pkg/staticperl.html |
1085 | http://software.schmorp.de/pkg/staticperl.html |