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