ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/App-Staticperl/staticperl.pod
(Generate patch)

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.2 by root, Mon Dec 6 20:53:44 2010 UTC vs.
Revision 1.23 by root, Mon Dec 13 18:08:01 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines