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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines