… | |
… | |
20 | |
20 | |
21 | Typical Examples: |
21 | Typical Examples: |
22 | |
22 | |
23 | staticperl install # fetch, configure, build and install perl |
23 | staticperl install # fetch, configure, build and install perl |
24 | staticperl cpan # run interactive cpan shell |
24 | staticperl cpan # run interactive cpan shell |
25 | staticperl mkperl -M '"Config_heavy.pl"' # build a perl that supports -V |
25 | staticperl mkperl -MConfig_heavy.pl # build a perl that supports -V |
26 | staticperl mkperl -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI -MURI::http |
26 | staticperl mkperl -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI -MURI::http |
27 | # 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 |
28 | staticperl mkapp myapp --boot mainprog mymodules |
29 | # build a binary "myapp" from mainprog and mymodules |
29 | # build a binary "myapp" from mainprog and mymodules |
30 | |
30 | |
31 | =head1 DESCRIPTION |
31 | =head1 DESCRIPTION |
32 | |
32 | |
33 | This script helps you creating single-file perl interpreters, or embedding |
33 | This script helps you to create single-file perl interpreters |
34 | a perl interpreter in your applications. Single-file means that it is |
34 | or applications, or embedding a perl interpreter in your |
35 | fully self-contained - no separate shared objects, no autoload fragments, |
35 | applications. Single-file means that it is fully self-contained - no |
36 | 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 |
37 | 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 |
38 | 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. |
39 | |
40 | |
40 | 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 |
41 | 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, |
42 | 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/>. |
43 | |
48 | |
44 | 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 |
45 | 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, |
46 | here are the differences: |
51 | here are the differences: |
47 | |
52 | |
… | |
… | |
66 | =item * The generated executables don't need a writable filesystem. |
71 | =item * The generated executables don't need a writable filesystem. |
67 | |
72 | |
68 | 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 |
69 | need to unpack files into a temporary directory. |
74 | need to unpack files into a temporary directory. |
70 | |
75 | |
71 | =item * More control over included files. |
76 | =item * More control over included files, more burden. |
72 | |
77 | |
73 | 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 |
74 | 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 |
75 | 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) |
76 | memory and file size. |
81 | can take substantial amounts of memory and file size. |
77 | |
82 | |
78 | 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 |
79 | compile-time dependencies and L<AutoLoader> are handled automatically. |
84 | compile-time dependencies and L<AutoLoader> are handled automatically. |
80 | 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. |
81 | |
90 | |
82 | =item * PAR works out of the box, F<staticperl> does not. |
91 | =item * PAR works out of the box, F<staticperl> does not. |
83 | |
92 | |
84 | 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 |
85 | 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 |
… | |
… | |
106 | 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, |
107 | 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 |
108 | 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 |
109 | sources you can use to embed all files into your project). |
118 | sources you can use to embed all files into your project). |
110 | |
119 | |
111 | 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 |
112 | 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 |
113 | repeated as often as necessary. |
122 | often as necessary. |
114 | |
123 | |
115 | =head1 THE F<STATICPERL> SCRIPT |
124 | =head1 THE F<STATICPERL> SCRIPT |
116 | |
125 | |
117 | This module installs a script called F<staticperl> into your perl |
126 | This module installs a script called F<staticperl> into your perl |
118 | binary directory. The script is fully self-contained, and can be used |
127 | binary directory. The script is fully self-contained, and can be |
119 | without perl (for example, in an uClibc chroot environment). In fact, |
128 | used without perl (for example, in an uClibc chroot environment). In |
120 | it can be extracted from the C<App::Staticperl> distribution tarball as |
129 | fact, it can be extracted from the C<App::Staticperl> distribution |
121 | 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>. |
122 | |
133 | |
123 | F<staticperl> interprets the first argument as a command to execute, |
134 | F<staticperl> interprets the first argument as a command to execute, |
124 | optionally followed by any parameters. |
135 | optionally followed by any parameters. |
125 | |
136 | |
126 | 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 |
… | |
… | |
128 | with creating binaries and bundle files. |
139 | with creating binaries and bundle files. |
129 | |
140 | |
130 | =head2 PHASE 1 COMMANDS: INSTALLING PERL |
141 | =head2 PHASE 1 COMMANDS: INSTALLING PERL |
131 | |
142 | |
132 | The most important command is F<install>, which does basically |
143 | The most important command is F<install>, which does basically |
133 | everything. The default is to download and install perl 5.12.2 and a few |
144 | everything. The default is to download and install perl 5.12.3 and a few |
134 | modules required by F<staticperl> itself, but all this can (and should) be |
145 | modules required by F<staticperl> itself, but all this can (and should) be |
135 | changed - see L<CONFIGURATION>, below. |
146 | changed - see L<CONFIGURATION>, below. |
136 | |
147 | |
137 | The command |
148 | The command |
138 | |
149 | |
139 | staticperl install |
150 | staticperl install |
140 | |
151 | |
141 | Is normally all you need: It installs the perl interpreter in |
152 | is normally all you need: It installs the perl interpreter in |
142 | F<~/.staticperl/perl>. It downloads, configures, builds and installs the |
153 | F<~/.staticperl/perl>. It downloads, configures, builds and installs the |
143 | perl interpreter if required. |
154 | perl interpreter if required. |
144 | |
155 | |
145 | 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 |
146 | 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. |
147 | |
163 | |
148 | To force recompilation or reinstallation, you need to run F<staticperl |
164 | To force recompilation or reinstallation, you need to run F<staticperl |
149 | distclean> first. |
165 | distclean> first. |
150 | |
166 | |
151 | =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. |
152 | |
172 | |
153 | =item F<staticperl fetch> |
173 | =item F<staticperl fetch> |
154 | |
174 | |
155 | 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. |
156 | |
176 | |
… | |
… | |
194 | |
214 | |
195 | =item F<staticperl clean> |
215 | =item F<staticperl clean> |
196 | |
216 | |
197 | Deletes the perl source directory (and potentially cleans up other |
217 | Deletes the perl source directory (and potentially cleans up other |
198 | 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 |
199 | building perl, without removing the installed perl interpreter, or to |
219 | building perl, without removing the installed perl interpreter. |
200 | force a re-build from scratch. |
|
|
201 | |
220 | |
202 | 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. |
203 | |
224 | |
204 | =item F<staticperl distclean> |
225 | =item F<staticperl distclean> |
205 | |
226 | |
206 | This wipes your complete F<~/.staticperl> directory. Be careful with this, |
227 | This wipes your complete F<~/.staticperl> directory. Be careful with this, |
207 | it nukes your perl download, perl sources, perl distribution and any |
228 | it nukes your perl download, perl sources, perl distribution and any |
… | |
… | |
231 | |
252 | |
232 | # first make sure we have perl and the required modules |
253 | # first make sure we have perl and the required modules |
233 | staticperl instcpan AnyEvent::HTTPD |
254 | staticperl instcpan AnyEvent::HTTPD |
234 | |
255 | |
235 | # now build the perl |
256 | # now build the perl |
236 | staticperl mkperl -M'"Config_heavy.pl"' -MAnyEvent::Impl::Perl \ |
257 | staticperl mkperl -MConfig_heavy.pl -MAnyEvent::Impl::Perl \ |
237 | -MAnyEvent::HTTPD -MURI::http \ |
258 | -MAnyEvent::HTTPD -MURI::http \ |
238 | --add 'eg/httpd httpd.pm' |
259 | --add 'eg/httpd httpd.pm' |
239 | |
260 | |
240 | # finally, invoke it |
261 | # finally, invoke it |
241 | ./perl -Mhttpd |
262 | ./perl -Mhttpd |
… | |
… | |
257 | -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI::http |
278 | -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI::http |
258 | |
279 | |
259 | # run it |
280 | # run it |
260 | ./app |
281 | ./app |
261 | |
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 | |
262 | =head3 OPTION PROCESSING |
314 | =head3 OPTION PROCESSING |
263 | |
315 | |
264 | All options can be given as arguments on the command line (typically |
316 | All options can be given as arguments on the command line (typically |
265 | using long (e.g. C<--verbose>) or short option (e.g. C<-v>) style). Since |
317 | using long (e.g. C<--verbose>) or short option (e.g. C<-v>) style). Since |
266 | specifying a lot of modules can make the command line very cumbersome, |
318 | specifying a lot of options can make the command line very long and |
267 | you can put all long options into a "bundle specification file" (with or |
319 | unwieldy, you can put all long options into a "bundle specification file" |
268 | without C<--> prefix) and specify this bundle file instead. |
320 | (one option per line, with or without C<--> prefix) and specify this |
|
|
321 | bundle file instead. |
269 | |
322 | |
270 | For example, the command given earlier could also look like this: |
323 | For example, the command given earlier to link a new F<perl> could also |
|
|
324 | look like this: |
271 | |
325 | |
272 | staticperl mkperl httpd.bundle |
326 | staticperl mkperl httpd.bundle |
273 | |
327 | |
274 | And all options could be in F<httpd.bundle>: |
328 | With all options stored in the F<httpd.bundle> file (one option per line, |
275 | |
329 | everything after the option is an argument): |
|
|
330 | |
276 | use "Config_heavy.pl" |
331 | use "Config_heavy.pl" |
277 | use AnyEvent::Impl::Perl |
332 | use AnyEvent::Impl::Perl |
278 | use AnyEvent::HTTPD |
333 | use AnyEvent::HTTPD |
279 | use URI::http |
334 | use URI::http |
280 | add eg/httpd httpd.pm |
335 | add eg/httpd httpd.pm |
281 | |
336 | |
282 | All options that specify modules or files to be added are processed in the |
337 | All options that specify modules or files to be added are processed in the |
283 | order given on the command line (that affects the C<--use> and C<--eval> |
338 | order given on the command line. |
284 | options at the moment). |
|
|
285 | |
339 | |
286 | =head3 MKBUNDLE OPTIONS |
340 | =head3 BUNDLE CREATION WORKFLOW / STATICPELR MKBUNDLE OPTIONS |
287 | |
341 | |
288 | =over 4 |
342 | F<staticperl mkbundle> works by first assembling a list of candidate |
|
|
343 | files and modules to include, then filtering them by include/exclude |
|
|
344 | patterns. The remaining modules (together with their direct dependencies, |
|
|
345 | such as link libraries and L<AutoLoader> files) are then converted into |
|
|
346 | bundle files suitable for embedding. F<staticperl mkbundle> can then |
|
|
347 | optionally build a new perl interpreter or a standalone application. |
289 | |
348 | |
|
|
349 | =over 4 |
|
|
350 | |
|
|
351 | =item Step 0: Generic argument processing. |
|
|
352 | |
|
|
353 | The following options influence F<staticperl mkbundle> itself. |
|
|
354 | |
|
|
355 | =over 4 |
|
|
356 | |
290 | =item --verbose | -v |
357 | =item C<--verbose> | C<-v> |
291 | |
358 | |
292 | Increases the verbosity level by one (the default is C<1>). |
359 | Increases the verbosity level by one (the default is C<1>). |
293 | |
360 | |
294 | =item --quiet | -q |
361 | =item C<--quiet> | C<-q> |
295 | |
362 | |
296 | Decreases the verbosity level by one. |
363 | Decreases the verbosity level by one. |
297 | |
364 | |
|
|
365 | =item any other argument |
|
|
366 | |
|
|
367 | Any other argument is interpreted as a bundle specification file, which |
|
|
368 | supports all options (without extra quoting), one option per line, in the |
|
|
369 | format C<option> or C<option argument>. They will effectively be expanded |
|
|
370 | and processed as if they were directly written on the command line, in |
|
|
371 | place of the file name. |
|
|
372 | |
|
|
373 | =back |
|
|
374 | |
|
|
375 | =item Step 1: gather candidate files and modules |
|
|
376 | |
|
|
377 | In this step, modules, perl libraries (F<.pl> files) and other files are |
|
|
378 | selected for inclusion in the bundle. The relevant options are executed |
|
|
379 | in order (this makes a difference mostly for C<--eval>, which can rely on |
|
|
380 | earlier C<--use> options to have been executed). |
|
|
381 | |
|
|
382 | =over 4 |
|
|
383 | |
|
|
384 | =item C<--use> F<module> | C<-M>F<module> |
|
|
385 | |
|
|
386 | Include the named module or perl library and trace direct |
|
|
387 | dependencies. This is done by loading the module in a subprocess and |
|
|
388 | tracing which other modules and files it actually loads. |
|
|
389 | |
|
|
390 | Example: include AnyEvent and AnyEvent::Impl::Perl. |
|
|
391 | |
|
|
392 | staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl |
|
|
393 | |
|
|
394 | Sometimes you want to load old-style "perl libraries" (F<.pl> files), or |
|
|
395 | maybe other weirdly named files. To support this, the C<--use> option |
|
|
396 | actually tries to do what you mean, depending on the string you specify: |
|
|
397 | |
|
|
398 | =over 4 |
|
|
399 | |
|
|
400 | =item a possibly valid module name, e.g. F<common::sense>, F<Carp>, |
|
|
401 | F<Coro::Mysql>. |
|
|
402 | |
|
|
403 | If the string contains no quotes, no F</> and no F<.>, then C<--use> |
|
|
404 | assumes that it is a normal module name. It will create a new package and |
|
|
405 | evaluate a C<use module> in it, i.e. it will load the package and do a |
|
|
406 | default import. |
|
|
407 | |
|
|
408 | The import step is done because many modules trigger more dependencies |
|
|
409 | when something is imported than without. |
|
|
410 | |
|
|
411 | =item anything that contains F</> or F<.> characters, |
|
|
412 | e.g. F<utf8_heavy.pl>, F<Module/private/data.pl>. |
|
|
413 | |
|
|
414 | The string will be quoted and passed to require, as if you used C<require |
|
|
415 | $module>. Nothing will be imported. |
|
|
416 | |
|
|
417 | =item "path" or 'path', e.g. C<"utf8_heavy.pl">. |
|
|
418 | |
|
|
419 | If you enclose the name into single or double quotes, then the quotes will |
|
|
420 | be removed and the resulting string will be passed to require. This syntax |
|
|
421 | is form compatibility with older versions of staticperl and should not be |
|
|
422 | used anymore. |
|
|
423 | |
|
|
424 | =back |
|
|
425 | |
|
|
426 | Example: C<use> AnyEvent::Socket, once using C<use> (importing the |
|
|
427 | symbols), and once via C<require>, not importing any symbols. The first |
|
|
428 | form is preferred as many modules load some extra dependencies when asked |
|
|
429 | to export symbols. |
|
|
430 | |
|
|
431 | staticperl mkbundle -MAnyEvent::Socket # use + import |
|
|
432 | staticperl mkbundle -MAnyEvent/Socket.pm # require only |
|
|
433 | |
|
|
434 | Example: include the required files for F<perl -V> to work in all its |
|
|
435 | glory (F<Config.pm> is included automatically by the dependency tracker). |
|
|
436 | |
|
|
437 | # shell command |
|
|
438 | staticperl mkbundle -MConfig_heavy.pl |
|
|
439 | |
|
|
440 | # bundle specification file |
|
|
441 | use Config_heavy.pl |
|
|
442 | |
|
|
443 | The C<-M>module syntax is included as a convenience that might be easier |
|
|
444 | to remember than C<--use> - it's the same switch as perl itself uses |
|
|
445 | to load modules. Or maybe it confuses people. Time will tell. Or maybe |
|
|
446 | not. Sigh. |
|
|
447 | |
|
|
448 | =item C<--eval> "perl code" | C<-e> "perl code" |
|
|
449 | |
|
|
450 | Sometimes it is easier (or necessary) to specify dependencies using perl |
|
|
451 | code, or maybe one of the modules you use need a special use statement. In |
|
|
452 | that case, you can use C<--eval> to execute some perl snippet or set some |
|
|
453 | variables or whatever you need. All files C<require>'d or C<use>'d while |
|
|
454 | executing the snippet are included in the final bundle. |
|
|
455 | |
|
|
456 | Keep in mind that F<mkbundle> will not import any symbols from the modules |
|
|
457 | named by the C<--use> option, so do not expect the symbols from modules |
|
|
458 | you C<--use>'d earlier on the command line to be available. |
|
|
459 | |
|
|
460 | Example: force L<AnyEvent> to detect a backend and therefore include it |
|
|
461 | in the final bundle. |
|
|
462 | |
|
|
463 | staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect' |
|
|
464 | |
|
|
465 | # or like this |
|
|
466 | staticperl mkbundle -MAnyEvent --eval 'AnyEvent::detect' |
|
|
467 | |
|
|
468 | Example: use a separate "bootstrap" script that C<use>'s lots of modules |
|
|
469 | and also include this in the final bundle, to be executed automatically |
|
|
470 | when the interpreter is initialised. |
|
|
471 | |
|
|
472 | staticperl mkbundle --eval 'do "bootstrap"' --boot bootstrap |
|
|
473 | |
|
|
474 | =item C<--boot> F<filename> |
|
|
475 | |
|
|
476 | Include the given file in the bundle and arrange for it to be |
|
|
477 | executed (using C<require>) before the main program when the new perl |
|
|
478 | is initialised. This can be used to modify C<@INC> or do similar |
|
|
479 | modifications before the perl interpreter executes scripts given on the |
|
|
480 | command line (or via C<-e>). This works even in an embedded interpreter - |
|
|
481 | the file will be executed during interpreter initialisation in that case. |
|
|
482 | |
|
|
483 | =item C<--incglob> pattern |
|
|
484 | |
|
|
485 | This goes through all standard library directories and tries to match any |
|
|
486 | F<.pm> and F<.pl> files against the extended glob pattern (see below). If |
|
|
487 | a file matches, it is added. The pattern is matched against the full path |
|
|
488 | of the file (sans the library directory prefix), e.g. F<Sys/Syslog.pm>. |
|
|
489 | |
|
|
490 | This is very useful to include "everything": |
|
|
491 | |
|
|
492 | --incglob '*' |
|
|
493 | |
|
|
494 | It is also useful for including perl libraries, or trees of those, such as |
|
|
495 | the unicode database files needed by some perl built-ins, the regex engine |
|
|
496 | and other modules. |
|
|
497 | |
|
|
498 | --incglob '/unicore/**.pl' |
|
|
499 | |
|
|
500 | =item C<--add> F<file> | C<--add> "F<file> alias" |
|
|
501 | |
|
|
502 | Adds the given (perl) file into the bundle (and optionally call it |
|
|
503 | "alias"). The F<file> is either an absolute path or a path relative to the |
|
|
504 | current directory. If an alias is specified, then this is the name it will |
|
|
505 | use for C<@INC> searches, otherwise the path F<file> will be used as the |
|
|
506 | internal name. |
|
|
507 | |
|
|
508 | This switch is used to include extra files into the bundle. |
|
|
509 | |
|
|
510 | Example: embed the file F<httpd> in the current directory as F<httpd.pm> |
|
|
511 | when creating the bundle. |
|
|
512 | |
|
|
513 | staticperl mkperl --add "httpd httpd.pm" |
|
|
514 | |
|
|
515 | # can be accessed via "use httpd" |
|
|
516 | |
|
|
517 | Example: add a file F<initcode> from the current directory. |
|
|
518 | |
|
|
519 | staticperl mkperl --add 'initcode &initcode' |
|
|
520 | |
|
|
521 | # can be accessed via "do '&initcode'" |
|
|
522 | |
|
|
523 | Example: add local files as extra modules in the bundle. |
|
|
524 | |
|
|
525 | # specification file |
|
|
526 | add file1 myfiles/file1.pm |
|
|
527 | add file2 myfiles/file2.pm |
|
|
528 | add file3 myfiles/file3.pl |
|
|
529 | |
|
|
530 | # then later, in perl, use |
|
|
531 | use myfiles::file1; |
|
|
532 | require myfiles::file2; |
|
|
533 | my $res = do "myfiles/file3.pl"; |
|
|
534 | |
|
|
535 | =item C<--binadd> F<file> | C<--add> "F<file> alias" |
|
|
536 | |
|
|
537 | Just like C<--add>, except that it treats the file as binary and adds it |
|
|
538 | without any postprocessing (perl files might get stripped to reduce their |
|
|
539 | size). |
|
|
540 | |
|
|
541 | If you specify an alias you should probably add a C<&> prefix to avoid |
|
|
542 | clashing with embedded perl files (whose paths never start with C<&>), |
|
|
543 | and/or use a special directory prefix, such as C<&res/name>. |
|
|
544 | |
|
|
545 | You can later get a copy of these files by calling C<staticperl::find |
|
|
546 | "alias">. |
|
|
547 | |
|
|
548 | An alternative way to embed binary files is to convert them to perl and |
|
|
549 | use C<do> to get the contents - this method is a bit cumbersome, but works |
|
|
550 | both inside and outside of a staticperl bundle: |
|
|
551 | |
|
|
552 | # a "binary" file, call it "bindata.pl" |
|
|
553 | <<'SOME_MARKER' |
|
|
554 | binary data NOT containing SOME_MARKER |
|
|
555 | SOME_MARKER |
|
|
556 | |
|
|
557 | # load the binary |
|
|
558 | chomp (my $data = do "bindata.pl"); |
|
|
559 | |
|
|
560 | =back |
|
|
561 | |
|
|
562 | =item Step 2: filter all files using C<--include> and C<--exclude> options. |
|
|
563 | |
|
|
564 | After all candidate files and modules are added, they are I<filtered> |
|
|
565 | by a combination of C<--include> and C<--exclude> patterns (there is an |
|
|
566 | implicit C<--include *> at the end, so if no filters are specified, all |
|
|
567 | files are included). |
|
|
568 | |
|
|
569 | All that this step does is potentially reduce the number of files that are |
|
|
570 | to be included - no new files are added during this step. |
|
|
571 | |
|
|
572 | =over 4 |
|
|
573 | |
|
|
574 | =item C<--include> pattern | C<-i> pattern | C<--exclude> pattern | C<-x> pattern |
|
|
575 | |
|
|
576 | These specify an include or exclude pattern to be applied to the candidate |
|
|
577 | file list. An include makes sure that the given files will be part of the |
|
|
578 | resulting file set, an exclude will exclude remaining files. The patterns |
|
|
579 | are "extended glob patterns" (see below). |
|
|
580 | |
|
|
581 | The patterns are applied "in order" - files included via earlier |
|
|
582 | C<--include> specifications cannot be removed by any following |
|
|
583 | C<--exclude>, and likewise, and file excluded by an earlier C<--exclude> |
|
|
584 | cannot be added by any following C<--include>. |
|
|
585 | |
|
|
586 | For example, to include everything except C<Devel> modules, but still |
|
|
587 | include F<Devel::PPPort>, you could use this: |
|
|
588 | |
|
|
589 | --incglob '*' -i '/Devel/PPPort.pm' -x '/Devel/**' |
|
|
590 | |
|
|
591 | =back |
|
|
592 | |
|
|
593 | =item Step 3: add any extra or "hidden" dependencies. |
|
|
594 | |
|
|
595 | F<staticperl> currently knows about three extra types of depdendencies |
|
|
596 | that are added automatically. Only one (F<.packlist> files) is currently |
|
|
597 | optional and can be influenced, the others are always included: |
|
|
598 | |
|
|
599 | =over 4 |
|
|
600 | |
|
|
601 | =item C<--usepacklists> |
|
|
602 | |
|
|
603 | Read F<.packlist> files for each distribution that happens to match a |
|
|
604 | module name you specified. Sounds weird, and it is, so expect semantics to |
|
|
605 | change somehow in the future. |
|
|
606 | |
|
|
607 | The idea is that most CPAN distributions have a F<.pm> file that matches |
|
|
608 | the name of the distribution (which is rather reasonable after all). |
|
|
609 | |
|
|
610 | If this switch is enabled, then if any of the F<.pm> files that have been |
|
|
611 | selected match an install distribution, then all F<.pm>, F<.pl>, F<.al> |
|
|
612 | and F<.ix> files installed by this distribution are also included. |
|
|
613 | |
|
|
614 | For example, using this switch, when the L<URI> module is specified, then |
|
|
615 | all L<URI> submodules that have been installed via the CPAN distribution |
|
|
616 | are included as well, so you don't have to manually specify them. |
|
|
617 | |
|
|
618 | =item L<AutoLoader> splitfiles |
|
|
619 | |
|
|
620 | Some modules use L<AutoLoader> - less commonly (hopefully) used functions |
|
|
621 | are split into separate F<.al> files, and an index (F<.ix>) file contains |
|
|
622 | the prototypes. |
|
|
623 | |
|
|
624 | Both F<.ix> and F<.al> files will be detected automatically and added to |
|
|
625 | the bundle. |
|
|
626 | |
|
|
627 | =item link libraries (F<.a> files) |
|
|
628 | |
|
|
629 | Modules using XS (or any other non-perl language extension compiled at |
|
|
630 | installation time) will have a static archive (typically F<.a>). These |
|
|
631 | will automatically be added to the linker options in F<bundle.ldopts>. |
|
|
632 | |
|
|
633 | Should F<staticperl> find a dynamic link library (typically F<.so>) it |
|
|
634 | will warn about it - obviously this shouldn't happen unless you use |
|
|
635 | F<staticperl> on the wrong perl, or one (probably wrongly) configured to |
|
|
636 | use dynamic loading. |
|
|
637 | |
|
|
638 | =item extra libraries (F<extralibs.ld>) |
|
|
639 | |
|
|
640 | Some modules need linking against external libraries - these are found in |
|
|
641 | F<extralibs.ld> and added to F<bundle.ldopts>. |
|
|
642 | |
|
|
643 | =back |
|
|
644 | |
|
|
645 | =item Step 4: write bundle files and optionally link a program |
|
|
646 | |
|
|
647 | At this point, the select files will be read, processed (stripped) and |
|
|
648 | finally the bundle files get written to disk, and F<staticperl mkbundle> |
|
|
649 | is normally finished. Optionally, it can go a step further and either link |
|
|
650 | a new F<perl> binary with all selected modules and files inside, or build |
|
|
651 | a standalone application. |
|
|
652 | |
|
|
653 | Both the contents of the bundle files and any extra linking is controlled |
|
|
654 | by these options: |
|
|
655 | |
|
|
656 | =over 4 |
|
|
657 | |
298 | =item --strip none|pod|ppi |
658 | =item C<--strip> C<none>|C<pod>|C<ppi> |
299 | |
659 | |
300 | Specify the stripping method applied to reduce the file of the perl |
660 | Specify the stripping method applied to reduce the file of the perl |
301 | sources included. |
661 | sources included. |
302 | |
662 | |
303 | The default is C<pod>, which uses the L<Pod::Strip> module to remove all |
663 | The default is C<pod>, which uses the L<Pod::Strip> module to remove all |
304 | pod documentation, which is very fast and reduces file size a lot. |
664 | pod documentation, which is very fast and reduces file size a lot. |
305 | |
665 | |
306 | The C<ppi> method uses L<PPI> to parse and condense the perl sources. This |
666 | The C<ppi> method uses L<PPI> to parse and condense the perl sources. This |
307 | saves a lot more than just L<Pod::Strip>, and is generally safer, but |
667 | saves a lot more than just L<Pod::Strip>, and is generally safer, |
308 | is also a lot slower, so is best used for production builds. Note that |
668 | but is also a lot slower (some files take almost a minute to strip - |
309 | this method doesn't optimise for raw file size, but for best compression |
669 | F<staticperl> maintains a cache of stripped files to speed up subsequent |
310 | (that means that the uncompressed file size is a bit larger, but the files |
670 | runs for this reason). Note that this method doesn't optimise for raw file |
311 | compress better, e.g. with F<upx>). |
671 | size, but for best compression (that means that the uncompressed file size |
|
|
672 | is a bit larger, but the files compress better, e.g. with F<upx>). |
312 | |
673 | |
313 | Last not least, if you need accurate line numbers in error messages, |
674 | Last not least, if you need accurate line numbers in error messages, |
314 | or in the unlikely case where C<pod> is too slow, or some module gets |
675 | or in the unlikely case where C<pod> is too slow, or some module gets |
315 | mistreated, you can specify C<none> to not mangle included perl sources in |
676 | mistreated, you can specify C<none> to not mangle included perl sources in |
316 | any way. |
677 | any way. |
317 | |
678 | |
318 | =item --perl |
679 | =item C<--perl> |
319 | |
680 | |
320 | After writing out the bundle files, try to link a new perl interpreter. It |
681 | After writing out the bundle files, try to link a new perl interpreter. It |
321 | will be called F<perl> and will be left in the current working |
682 | will be called F<perl> and will be left in the current working |
322 | directory. The bundle files will be removed. |
683 | directory. The bundle files will be removed. |
323 | |
684 | |
324 | This switch is automatically used when F<staticperl> is invoked with the |
685 | This switch is automatically used when F<staticperl> is invoked with the |
325 | C<mkperl> command (instead of C<mkbundle>): |
686 | C<mkperl> command instead of C<mkbundle>. |
326 | |
687 | |
327 | # build a new ./perl with only common::sense in it - very small :) |
688 | Example: build a new F<./perl> binary with only L<common::sense> inside - |
|
|
689 | it will be even smaller than the standard perl interpreter as none of the |
|
|
690 | modules of the base distribution (such as L<Fcntl>) will be included. |
|
|
691 | |
328 | staticperl mkperl -Mcommon::sense |
692 | staticperl mkperl -Mcommon::sense |
329 | |
693 | |
330 | =item --app name |
694 | =item C<--app> F<name> |
331 | |
695 | |
332 | After writing out the bundle files, try to link a new standalone |
696 | After writing out the bundle files, try to link a new standalone |
333 | program. It will be called C<name>, and the bundle files get removed after |
697 | program. It will be called C<name>, and the bundle files get removed after |
334 | linking it. |
698 | linking it. |
|
|
699 | |
|
|
700 | This switch is automatically used when F<staticperl> is invoked with the |
|
|
701 | C<mkapp> command instead of C<mkbundle>. |
335 | |
702 | |
336 | The difference to the (mutually exclusive) C<--perl> option is that the |
703 | The difference to the (mutually exclusive) C<--perl> option is that the |
337 | binary created by this option will not try to act as a perl interpreter - |
704 | binary created by this option will not try to act as a perl interpreter - |
338 | instead it will simply initialise the perl interpreter, clean it up and |
705 | instead it will simply initialise the perl interpreter, clean it up and |
339 | exit. |
706 | exit. |
340 | |
707 | |
341 | This switch is automatically used when F<staticperl> is invoked with the |
708 | This means that, by default, it will do nothing but burn a few CPU cycles |
342 | C<mkapp> command (instead of C<mkbundle>): |
|
|
343 | |
|
|
344 | To let it do something useful you I<must> add some boot code, e.g. with |
709 | - for it to do something useful you I<must> add some boot code, e.g. with |
345 | the C<--boot> option. |
710 | the C<--boot> option. |
346 | |
711 | |
347 | Example: create a standalone perl binary that will execute F<appfile> when |
712 | Example: create a standalone perl binary called F<./myexe> that will |
348 | it is started. |
713 | execute F<appfile> when it is started. |
349 | |
714 | |
350 | staticperl mkbundle --app myexe --boot appfile |
715 | staticperl mkbundle --app myexe --boot appfile |
351 | |
716 | |
352 | =item --use module | -Mmodule |
717 | =item C<--ignore-env> |
353 | |
718 | |
354 | Include the named module and all direct dependencies. This is done by |
719 | Generates extra code to unset some environment variables before |
355 | C<require>'ing the module in a subprocess and tracing which other modules |
720 | initialising/running perl. Perl supports a lot of environment variables |
356 | and files it actually loads. If the module uses L<AutoLoader>, then all |
721 | that might alter execution in ways that might be undesirablre for |
357 | splitfiles will be included as well. |
722 | standalone applications, and this option removes those known to cause |
|
|
723 | trouble. |
358 | |
724 | |
359 | Example: include AnyEvent and AnyEvent::Impl::Perl. |
725 | Specifically, these are removed: |
360 | |
726 | |
361 | staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl |
727 | C<PERL_HASH_SEED_DEBUG> and C<PERL_DEBUG_MSTATS> can cause underaible |
|
|
728 | output, C<PERL5OPT>, C<PERL_DESTRUCT_LEVEL>, C<PERL_HASH_SEED> and |
|
|
729 | C<PERL_SIGNALS> can alter execution significantly, and C<PERL_UNICODE>, |
|
|
730 | C<PERLIO_DEBUG> and C<PERLIO> can affect input and output. |
362 | |
731 | |
363 | Sometimes you want to load old-style "perl libraries" (F<.pl> files), or |
732 | The variables C<PERL_LIB> and C<PERL5_LIB> are always ignored because the |
364 | maybe other weirdly named files. To do that, you need to quote the name in |
733 | startup code used by F<staticperl> overrides C<@INC> in all cases. |
365 | single or double quotes. When given on the command line, you probably need |
|
|
366 | to quote once more to avoid your shell interpreting it. Common cases that |
|
|
367 | need this are F<Config_heavy.pl> and F<utf8_heavy.pl>. |
|
|
368 | |
734 | |
369 | Example: include the required files for F<perl -V> to work in all its |
735 | This option will not make your program more secure (unless you are |
370 | glory (F<Config.pm> is included automatically by this). |
736 | running with elevated privileges), but it will reduce the surprise effect |
|
|
737 | when a user has these environment variables set and doesn't expect your |
|
|
738 | standalone program to act like a perl interpreter. |
371 | |
739 | |
372 | # bourne shell |
|
|
373 | staticperl mkbundle --use '"Config_heavy.pl"' |
|
|
374 | |
|
|
375 | # bundle specification file |
|
|
376 | use "Config_heavy.pl" |
|
|
377 | |
|
|
378 | The C<-Mmodule> syntax is included as an alias that might be easier to |
|
|
379 | remember than C<use>. Or maybe it confuses people. Time will tell. Or |
|
|
380 | maybe not. Argh. |
|
|
381 | |
|
|
382 | =item --eval "perl code" | -e "perl code" |
|
|
383 | |
|
|
384 | Sometimes it is easier (or necessary) to specify dependencies using perl |
|
|
385 | code, or maybe one of the modules you use need a special use statement. In |
|
|
386 | that case, you can use C<eval> to execute some perl snippet or set some |
|
|
387 | variables or whatever you need. All files C<require>'d or C<use>'d in the |
|
|
388 | script are included in the final bundle. |
|
|
389 | |
|
|
390 | Keep in mind that F<mkbundle> will only C<require> the modules named |
|
|
391 | by the C<--use> option, so do not expect the symbols from modules you |
|
|
392 | C<--use>'d earlier on the command line to be available. |
|
|
393 | |
|
|
394 | Example: force L<AnyEvent> to detect a backend and therefore include it |
|
|
395 | in the final bundle. |
|
|
396 | |
|
|
397 | staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect' |
|
|
398 | |
|
|
399 | # or like this |
|
|
400 | staticperl mkbundle -MAnyEvent --eval 'use AnyEvent; AnyEvent::detect' |
|
|
401 | |
|
|
402 | Example: use a separate "bootstrap" script that C<use>'s lots of modules |
|
|
403 | and include this in the final bundle, to be executed automatically. |
|
|
404 | |
|
|
405 | staticperl mkbundle --eval 'do "bootstrap"' --boot bootstrap |
|
|
406 | |
|
|
407 | =item --boot filename |
|
|
408 | |
|
|
409 | Include the given file in the bundle and arrange for it to be executed |
|
|
410 | (using a C<require>) before anything else when the new perl is |
|
|
411 | initialised. This can be used to modify C<@INC> or anything else before |
|
|
412 | the perl interpreter executes scripts given on the command line (or via |
|
|
413 | C<-e>). This works even in an embedded interpreter. |
|
|
414 | |
|
|
415 | =item --add "file" | --add "file alias" |
|
|
416 | |
|
|
417 | Adds the given (perl) file into the bundle (and optionally call it |
|
|
418 | "alias"). This is useful to include any custom files into the bundle. |
|
|
419 | |
|
|
420 | Example: embed the file F<httpd> as F<httpd.pm> when creating the bundle. |
|
|
421 | |
|
|
422 | staticperl mkperl --add "httpd httpd.pm" |
|
|
423 | |
|
|
424 | It is also a great way to add any custom modules: |
|
|
425 | |
|
|
426 | # specification file |
|
|
427 | add file1 myfiles/file1 |
|
|
428 | add file2 myfiles/file2 |
|
|
429 | add file3 myfiles/file3 |
|
|
430 | |
|
|
431 | =item --binadd "file" | --add "file alias" |
|
|
432 | |
|
|
433 | Just like C<--add>, except that it treats the file as binary and adds it |
|
|
434 | without any processing. |
|
|
435 | |
|
|
436 | You should probably add a C</> prefix to avoid clashing with embedded |
|
|
437 | perl files (whose paths do not start with C</>), and/or use a special |
|
|
438 | directory, such as C</res/name>. |
|
|
439 | |
|
|
440 | You can later get a copy of these files by calling C<staticperl::find |
|
|
441 | "alias">. |
|
|
442 | |
|
|
443 | =item --static |
740 | =item C<--static> |
444 | |
741 | |
445 | When C<--perl> is also given, link statically instead of dynamically. The |
742 | Add C<-static> to F<bundle.ldopts>, which means a fully static (if |
|
|
743 | supported by the OS) executable will be created. This is not immensely |
|
|
744 | useful when just creating the bundle files, but is most useful when |
|
|
745 | linking a binary with the C<--perl> or C<--app> options. |
|
|
746 | |
446 | default is to link the new perl interpreter fully dynamic (that means all |
747 | The default is to link the new binary dynamically (that means all perl |
447 | perl modules are linked statically, but all external libraries are still |
748 | modules are linked statically, but all external libraries are still |
448 | referenced dynamically). |
749 | referenced dynamically). |
449 | |
750 | |
450 | Keep in mind that Solaris doesn't support static linking at all, and |
751 | Keep in mind that Solaris doesn't support static linking at all, and |
451 | systems based on GNU libc don't really support it in a usable fashion |
752 | systems based on GNU libc don't really support it in a very usable |
452 | either. Try uClibc if you want to create fully statically linked |
753 | fashion either. Try uClibc if you want to create fully statically linked |
453 | executables, or try the C<--staticlibs> option to link only some libraries |
754 | executables, or try the C<--staticlib> option to link only some libraries |
454 | statically. |
755 | statically. |
455 | |
756 | |
456 | =item any other argument |
757 | =item C<--staticlib> libname |
457 | |
758 | |
458 | Any other argument is interpreted as a bundle specification file, which |
759 | When not linking fully statically, this option allows you to link specific |
459 | supports most long options (without extra quoting), one option per line. |
760 | libraries statically. What it does is simply replace all occurrences of |
|
|
761 | C<-llibname> with the GCC-specific C<-Wl,-Bstatic -llibname -Wl,-Bdynamic> |
|
|
762 | option. |
|
|
763 | |
|
|
764 | This will have no effect unless the library is actually linked against, |
|
|
765 | specifically, C<--staticlib> will not link against the named library |
|
|
766 | unless it would be linked against anyway. |
|
|
767 | |
|
|
768 | Example: link libcrypt statically into the final binary. |
|
|
769 | |
|
|
770 | staticperl mkperl -MIO::AIO --staticlib crypt |
|
|
771 | |
|
|
772 | # ldopts might now contain: |
|
|
773 | # -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread |
|
|
774 | |
|
|
775 | =back |
|
|
776 | |
|
|
777 | =back |
|
|
778 | |
|
|
779 | =head3 EXTENDED GLOB PATTERNS |
|
|
780 | |
|
|
781 | Some options of F<staticperl mkbundle> expect an I<extended glob |
|
|
782 | pattern>. This is neither a normal shell glob nor a regex, but something |
|
|
783 | in between. The idea has been copied from rsync, and there are the current |
|
|
784 | matching rules: |
|
|
785 | |
|
|
786 | =over 4 |
|
|
787 | |
|
|
788 | =item Patterns starting with F</> will be a anchored at the root of the library tree. |
|
|
789 | |
|
|
790 | That is, F</unicore> will match the F<unicore> directory in C<@INC>, but |
|
|
791 | nothing inside, and neither any other file or directory called F<unicore> |
|
|
792 | anywhere else in the hierarchy. |
|
|
793 | |
|
|
794 | =item Patterns not starting with F</> will be anchored at the end of the path. |
|
|
795 | |
|
|
796 | That is, F<idna.pl> will match any file called F<idna.pl> anywhere in the |
|
|
797 | hierarchy, but not any directories of the same name. |
|
|
798 | |
|
|
799 | =item A F<*> matches anything within a single path component. |
|
|
800 | |
|
|
801 | That is, F</unicore/*.pl> would match all F<.pl> files directly inside |
|
|
802 | C</unicore>, not any deeper level F<.pl> files. Or in other words, F<*> |
|
|
803 | will not match slashes. |
|
|
804 | |
|
|
805 | =item A F<**> matches anything. |
|
|
806 | |
|
|
807 | That is, F</unicore/**.pl> would match all F<.pl> files under F</unicore>, |
|
|
808 | no matter how deeply nested they are inside subdirectories. |
|
|
809 | |
|
|
810 | =item A F<?> matches a single character within a component. |
|
|
811 | |
|
|
812 | That is, F</Encode/??.pm> matches F</Encode/JP.pm>, but not the |
|
|
813 | hypothetical F</Encode/J/.pm>, as F<?> does not match F</>. |
460 | |
814 | |
461 | =back |
815 | =back |
462 | |
816 | |
463 | =head2 F<STATICPERL> CONFIGURATION AND HOOKS |
817 | =head2 F<STATICPERL> CONFIGURATION AND HOOKS |
464 | |
818 | |
465 | During (each) startup, F<staticperl> tries to source the following shell |
819 | During (each) startup, F<staticperl> tries to source some shell files to |
|
|
820 | allow you to fine-tune/override configuration settings. |
|
|
821 | |
|
|
822 | In them you can override shell variables, or define shell functions |
|
|
823 | ("hooks") to be called at specific phases during installation. For |
|
|
824 | example, you could define a C<postinstall> hook to install additional |
|
|
825 | modules from CPAN each time you start from scratch. |
|
|
826 | |
|
|
827 | If the env variable C<$STATICPERLRC> is set, then F<staticperl> will try |
|
|
828 | to source the file named with it only. Otherwise, it tries the following |
466 | files in order: |
829 | shell files in order: |
467 | |
830 | |
468 | /etc/staticperlrc |
831 | /etc/staticperlrc |
469 | ~/.staticperlrc |
832 | ~/.staticperlrc |
470 | $STATICPERL/rc |
833 | $STATICPERL/rc |
471 | |
834 | |
472 | They can be used to override shell variables, or define functions to be |
|
|
473 | called at specific phases. |
|
|
474 | |
|
|
475 | Note that the last file is erased during F<staticperl distclean>, so |
835 | Note that the last file is erased during F<staticperl distclean>, so |
476 | generally should not be used. |
836 | generally should not be used. |
477 | |
837 | |
478 | =head3 CONFIGURATION VARIABLES |
838 | =head3 CONFIGURATION VARIABLES |
479 | |
839 | |
… | |
… | |
519 | installation, you can set any environment variable you want - some modules |
879 | installation, you can set any environment variable you want - some modules |
520 | (such as L<Coro> or L<EV>) use environment variables for further tweaking. |
880 | (such as L<Coro> or L<EV>) use environment variables for further tweaking. |
521 | |
881 | |
522 | =item C<PERL_VERSION> |
882 | =item C<PERL_VERSION> |
523 | |
883 | |
524 | The perl version to install - default is currently C<5.12.2>, but C<5.8.9> |
884 | The perl version to install - default is currently C<5.12.3>, but C<5.8.9> |
525 | is also a good choice (5.8.9 is much smaller than 5.12.2, while 5.10.1 is |
885 | is also a good choice (5.8.9 is much smaller than 5.12.3, while 5.10.1 is |
526 | about as big as 5.12.2). |
886 | about as big as 5.12.3). |
527 | |
887 | |
528 | =item C<PERL_PREFIX> |
888 | =item C<PERL_PREFIX> |
529 | |
889 | |
530 | The prefix where perl gets installed (default: F<$STATICPERL/perl>), |
890 | The prefix where perl gets installed (default: F<$STATICPERL/perl>), |
531 | i.e. where the F<bin> and F<lib> subdirectories will end up. |
891 | i.e. where the F<bin> and F<lib> subdirectories will end up. |
… | |
… | |
540 | |
900 | |
541 | More commonly, you would either activate 64 bit integer support |
901 | More commonly, you would either activate 64 bit integer support |
542 | (C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to |
902 | (C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to |
543 | reduce filesize further. |
903 | reduce filesize further. |
544 | |
904 | |
545 | =item C<PERL_CPPFLAGS>, C<PERL_OPTIMIZE>, C<PERL_LDFLAGS>, C<PERL_LIBS> |
905 | =item C<PERL_CC>, C<PERL_CCFLAGS>, C<PERL_OPTIMIZE>, C<PERL_LDFLAGS>, C<PERL_LIBS> |
546 | |
906 | |
547 | These flags are passed to perl's F<Configure> script, and are generally |
907 | These flags are passed to perl's F<Configure> script, and are generally |
548 | optimised for small size (at the cost of performance). Since they also |
908 | optimised for small size (at the cost of performance). Since they also |
549 | contain subtle workarounds around various build issues, changing these |
909 | contain subtle workarounds around various build issues, changing these |
550 | usually requires understanding their default values - best look at the top |
910 | usually requires understanding their default values - best look at |
551 | of the F<staticperl> script for more info on these. |
911 | the top of the F<staticperl> script for more info on these, and use a |
|
|
912 | F<~/.staticperlrc> to override them. |
|
|
913 | |
|
|
914 | Most of the variables override (or modify) the corresponding F<Configure> |
|
|
915 | variable, except C<PERL_CCFLAGS>, which gets appended. |
552 | |
916 | |
553 | =back |
917 | =back |
554 | |
918 | |
555 | =head4 Variables you probably I<do not want> to override |
919 | =head4 Variables you probably I<do not want> to override |
556 | |
920 | |
557 | =over 4 |
921 | =over 4 |
|
|
922 | |
|
|
923 | =item C<MAKE> |
|
|
924 | |
|
|
925 | The make command to use - default is C<make>. |
558 | |
926 | |
559 | =item C<MKBUNDLE> |
927 | =item C<MKBUNDLE> |
560 | |
928 | |
561 | Where F<staticperl> writes the C<mkbundle> command to |
929 | Where F<staticperl> writes the C<mkbundle> command to |
562 | (default: F<$STATICPERL/mkbundle>). |
930 | (default: F<$STATICPERL/mkbundle>). |
… | |
… | |
647 | A header file that contains the prototypes of the few symbols "exported" |
1015 | A header file that contains the prototypes of the few symbols "exported" |
648 | by bundle.c, and also exposes the perl headers to the application. |
1016 | by bundle.c, and also exposes the perl headers to the application. |
649 | |
1017 | |
650 | =over 4 |
1018 | =over 4 |
651 | |
1019 | |
652 | =item staticperl_init () |
1020 | =item staticperl_init (xs_init = 0) |
653 | |
1021 | |
654 | Initialises the perl interpreter. You can use the normal perl functions |
1022 | Initialises the perl interpreter. You can use the normal perl functions |
655 | after calling this function, for example, to define extra functions or |
1023 | after calling this function, for example, to define extra functions or |
656 | to load a .pm file that contains some initialisation code, or the main |
1024 | to load a .pm file that contains some initialisation code, or the main |
657 | program function: |
1025 | program function: |
… | |
… | |
664 | } |
1032 | } |
665 | |
1033 | |
666 | static void |
1034 | static void |
667 | run_myapp(void) |
1035 | run_myapp(void) |
668 | { |
1036 | { |
669 | staticperl_init (); |
1037 | staticperl_init (0); |
670 | newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$"); |
1038 | newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$"); |
671 | eval_pv ("require myapp::main", 1); // executes "myapp/main.pm" |
1039 | eval_pv ("require myapp::main", 1); // executes "myapp/main.pm" |
672 | } |
1040 | } |
673 | |
1041 | |
|
|
1042 | When your bootcode already wants to access some XS functions at |
|
|
1043 | compiletime, then you need to supply an C<xs_init> function pointer that |
|
|
1044 | is called as soon as perl is initialised enough to define XS functions, |
|
|
1045 | but before the preamble code is executed: |
|
|
1046 | |
|
|
1047 | static void |
|
|
1048 | xs_init (pTHX) |
|
|
1049 | { |
|
|
1050 | newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$"); |
|
|
1051 | } |
|
|
1052 | |
|
|
1053 | static void |
|
|
1054 | run_myapp(void) |
|
|
1055 | { |
|
|
1056 | staticperl_init (xs_init); |
|
|
1057 | } |
|
|
1058 | |
|
|
1059 | =item staticperl_cleanup () |
|
|
1060 | |
|
|
1061 | In the unlikely case that you want to destroy the perl interpreter, here |
|
|
1062 | is the corresponding function. |
|
|
1063 | |
674 | =item staticperl_xs_init (pTHX) |
1064 | =item staticperl_xs_init (pTHX) |
675 | |
1065 | |
676 | Sometimes you need direct control over C<perl_parse> and C<perl_run>, in |
1066 | Sometimes you need direct control over C<perl_parse> and C<perl_run>, in |
677 | which case you do not want to use C<staticperl_init> but call them on your |
1067 | which case you do not want to use C<staticperl_init> but call them on your |
678 | own. |
1068 | own. |
679 | |
1069 | |
680 | Then you need this function - either pass it directly as the C<xs_init> |
1070 | Then you need this function - either pass it directly as the C<xs_init> |
681 | function to C<perl_parse>, or call it from your own C<xs_init> function. |
1071 | function to C<perl_parse>, or call it as one of the first things from your |
682 | |
1072 | own C<xs_init> function. |
683 | =item staticperl_cleanup () |
|
|
684 | |
|
|
685 | In the unlikely case that you want to destroy the perl interpreter, here |
|
|
686 | is the corresponding function. |
|
|
687 | |
1073 | |
688 | =item PerlInterpreter *staticperl |
1074 | =item PerlInterpreter *staticperl |
689 | |
1075 | |
690 | The perl interpreter pointer used by staticperl. Not normally so useful, |
1076 | The perl interpreter pointer used by staticperl. Not normally so useful, |
691 | but there it is. |
1077 | but there it is. |
… | |
… | |
727 | |
1113 | |
728 | Returns the list of all paths embedded in this binary. |
1114 | Returns the list of all paths embedded in this binary. |
729 | |
1115 | |
730 | =back |
1116 | =back |
731 | |
1117 | |
732 | =head1 FULLY STATIC BINARIES - BUILDROOT |
1118 | =head1 FULLY STATIC BINARIES - UCLIBC AND BUILDROOT |
733 | |
1119 | |
734 | To make truly static (Linux-) libraries, you might want to have a look at |
1120 | To make truly static (Linux-) libraries, you might want to have a look at |
735 | buildroot (L<http://buildroot.uclibc.org/>). |
1121 | buildroot (L<http://buildroot.uclibc.org/>). |
736 | |
1122 | |
737 | Buildroot is primarily meant to set up a cross-compile environment (which |
1123 | Buildroot is primarily meant to set up a cross-compile environment (which |
… | |
… | |
782 | After you have compiled and set up your buildroot target, you can copy |
1168 | After you have compiled and set up your buildroot target, you can copy |
783 | F<staticperl> from the C<App::Staticperl> distribution or from your |
1169 | F<staticperl> from the C<App::Staticperl> distribution or from your |
784 | perl f<bin> directory (if you installed it) into the F<output/target> |
1170 | perl f<bin> directory (if you installed it) into the F<output/target> |
785 | filesystem, chroot inside and run it. |
1171 | filesystem, chroot inside and run it. |
786 | |
1172 | |
|
|
1173 | =head1 RECIPES / SPECIFIC MODULES |
|
|
1174 | |
|
|
1175 | This section contains some common(?) recipes and information about |
|
|
1176 | problems with some common modules or perl constructs that require extra |
|
|
1177 | files to be included. |
|
|
1178 | |
|
|
1179 | =head2 MODULES |
|
|
1180 | |
|
|
1181 | =over 4 |
|
|
1182 | |
|
|
1183 | =item utf8 |
|
|
1184 | |
|
|
1185 | Some functionality in the utf8 module, such as swash handling (used |
|
|
1186 | for unicode character ranges in regexes) is implemented in the |
|
|
1187 | C<"utf8_heavy.pl"> library: |
|
|
1188 | |
|
|
1189 | -Mutf8_heavy.pl |
|
|
1190 | |
|
|
1191 | Many Unicode properties in turn are defined in separate modules, |
|
|
1192 | such as C<"unicore/Heavy.pl"> and more specific data tables such as |
|
|
1193 | C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables |
|
|
1194 | are big (7MB uncompressed, although F<staticperl> contains special |
|
|
1195 | handling for those files), so including them on demand by your application |
|
|
1196 | only might pay off. |
|
|
1197 | |
|
|
1198 | To simply include the whole unicode database, use: |
|
|
1199 | |
|
|
1200 | --incglob '/unicore/**.pl' |
|
|
1201 | |
|
|
1202 | =item AnyEvent |
|
|
1203 | |
|
|
1204 | AnyEvent needs a backend implementation that it will load in a delayed |
|
|
1205 | fashion. The L<AnyEvent::Impl::Perl> backend is the default choice |
|
|
1206 | for AnyEvent if it can't find anything else, and is usually a safe |
|
|
1207 | fallback. If you plan to use e.g. L<EV> (L<POE>...), then you need to |
|
|
1208 | include the L<AnyEvent::Impl::EV> (L<AnyEvent::Impl::POE>...) backend as |
|
|
1209 | well. |
|
|
1210 | |
|
|
1211 | If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn |
|
|
1212 | functions), you also need to include C<"AnyEvent/Util/idna.pl"> and |
|
|
1213 | C<"AnyEvent/Util/uts46data.pl">. |
|
|
1214 | |
|
|
1215 | Or you can use C<--usepacklists> and specify C<-MAnyEvent> to include |
|
|
1216 | everything. |
|
|
1217 | |
|
|
1218 | =item Carp |
|
|
1219 | |
|
|
1220 | Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of |
|
|
1221 | perl 5.12.2 (maybe earlier), this dependency no longer exists. |
|
|
1222 | |
|
|
1223 | =item Config |
|
|
1224 | |
|
|
1225 | The F<perl -V> switch (as well as many modules) needs L<Config>, which in |
|
|
1226 | turn might need L<"Config_heavy.pl">. Including the latter gives you |
|
|
1227 | both. |
|
|
1228 | |
|
|
1229 | =item Term::ReadLine::Perl |
|
|
1230 | |
|
|
1231 | Also needs L<Term::ReadLine::readline>, or C<--usepacklists>. |
|
|
1232 | |
|
|
1233 | =item URI |
|
|
1234 | |
|
|
1235 | URI implements schemes as separate modules - the generic URL scheme is |
|
|
1236 | implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If |
|
|
1237 | you need to use any of these schemes, you should include these manually, |
|
|
1238 | or use C<--usepacklists>. |
|
|
1239 | |
|
|
1240 | =back |
|
|
1241 | |
|
|
1242 | =head2 RECIPES |
|
|
1243 | |
|
|
1244 | =over 4 |
|
|
1245 | |
|
|
1246 | =item Just link everything in |
|
|
1247 | |
|
|
1248 | To link just about everything installed in the perl library into a new |
|
|
1249 | perl, try this (the first time this runs it will take a long time, as a |
|
|
1250 | lot of files need to be parsed): |
|
|
1251 | |
|
|
1252 | staticperl mkperl -v --strip ppi --incglob '*' |
|
|
1253 | |
|
|
1254 | If you don't mind the extra megabytes, this can be a very effective way of |
|
|
1255 | creating bundles without having to worry about forgetting any modules. |
|
|
1256 | |
|
|
1257 | You get even more useful variants of this method by first selecting |
|
|
1258 | everything, and then excluding stuff you are reasonable sure not to need - |
|
|
1259 | L<bigperl|http://staticperl.schmorp.de/bigperl.html> uses this approach. |
|
|
1260 | |
|
|
1261 | =item Getting rid of netdb functions |
|
|
1262 | |
|
|
1263 | The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent> |
|
|
1264 | and so on) that few applications use. You can avoid compiling them in by |
|
|
1265 | putting the following fragment into a C<preconfigure> hook: |
|
|
1266 | |
|
|
1267 | preconfigure() { |
|
|
1268 | for sym in \ |
|
|
1269 | d_getgrnam_r d_endgrent d_endgrent_r d_endhent \ |
|
|
1270 | d_endhostent_r d_endnent d_endnetent_r d_endpent \ |
|
|
1271 | d_endprotoent_r d_endpwent d_endpwent_r d_endsent \ |
|
|
1272 | d_endservent_r d_getgrent d_getgrent_r d_getgrgid_r \ |
|
|
1273 | d_getgrnam_r d_gethbyaddr d_gethent d_getsbyport \ |
|
|
1274 | d_gethostbyaddr_r d_gethostbyname_r d_gethostent_r \ |
|
|
1275 | d_getlogin_r d_getnbyaddr d_getnbyname d_getnent \ |
|
|
1276 | d_getnetbyaddr_r d_getnetbyname_r d_getnetent_r \ |
|
|
1277 | d_getpent d_getpbyname d_getpbynumber d_getprotobyname_r \ |
|
|
1278 | d_getprotobynumber_r d_getprotoent_r d_getpwent \ |
|
|
1279 | d_getpwent_r d_getpwnam_r d_getpwuid_r d_getsent \ |
|
|
1280 | d_getservbyname_r d_getservbyport_r d_getservent_r \ |
|
|
1281 | d_getspnam_r d_getsbyname |
|
|
1282 | # d_gethbyname |
|
|
1283 | do |
|
|
1284 | PERL_CONFIGURE="$PERL_CONFIGURE -U$sym" |
|
|
1285 | done |
|
|
1286 | } |
|
|
1287 | |
|
|
1288 | This mostly gains space when linking statically, as the functions will |
|
|
1289 | likely not be linked in. The gain for dynamically-linked binaries is |
|
|
1290 | smaller. |
|
|
1291 | |
|
|
1292 | Also, this leaves C<gethostbyname> in - not only is it actually used |
|
|
1293 | often, the L<Socket> module also exposes it, so leaving it out usually |
|
|
1294 | gains little. Why Socket exposes a C function that is in the core already |
|
|
1295 | is anybody's guess. |
|
|
1296 | |
|
|
1297 | =back |
|
|
1298 | |
787 | =head1 AUTHOR |
1299 | =head1 AUTHOR |
788 | |
1300 | |
789 | Marc Lehmann <schmorp@schmorp.de> |
1301 | Marc Lehmann <schmorp@schmorp.de> |
790 | http://software.schmorp.de/pkg/staticperl.html |
1302 | http://software.schmorp.de/pkg/staticperl.html |