[ViewVC] Diff of: cvs/App-Staticperl/staticperl.pod

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.23 by root, Mon Dec 13 18:08:01 2010 UTC vs.
Revision 1.35 by root, Thu Feb 10 22:44:29 2011 UTC

…		…
147		147
148	The command	148	The command
149		149
150	staticperl install	150	staticperl install
151		151
152	Is normally all you need: It installs the perl interpreter in	152	is normally all you need: It installs the perl interpreter in
153	F<~/.staticperl/perl>. It downloads, configures, builds and installs the	153	F<~/.staticperl/perl>. It downloads, configures, builds and installs the
154	perl interpreter if required.	154	perl interpreter if required.
155		155
156	Most of the following commands simply run one or more steps of this	156	Most of the following F<staticperl> subcommands simply run one or more
157	sequence.	157	steps of this sequence.
		158
		159	If it fails, then most commonly because the compiler options I selected
		160	are not supported by your compiler - either edit the F<staticperl> script
		161	yourself or create F<~/.staticperl> shell script where your set working
		162	C<PERL_CCFLAGS> etc. variables.
158		163
159	To force recompilation or reinstallation, you need to run F<staticperl	164	To force recompilation or reinstallation, you need to run F<staticperl
160	distclean> first.	165	distclean> first.
161		166
162	=over 4	167	=over 4
…		…
209		214
210	=item F<staticperl clean>	215	=item F<staticperl clean>
211		216
212	Deletes the perl source directory (and potentially cleans up other	217	Deletes the perl source directory (and potentially cleans up other
213	intermediate files). This can be used to clean up files only needed for	218	intermediate files). This can be used to clean up files only needed for
214	building perl, without removing the installed perl interpreter, or to	219	building perl, without removing the installed perl interpreter.
215	force a re-build from scratch.
216		220
217	At the moment, it doesn't delete downloaded tarballs.	221	At the moment, it doesn't delete downloaded tarballs.
		222
		223	The exact semantics of this command will probably change.
218		224
219	=item F<staticperl distclean>	225	=item F<staticperl distclean>
220		226
221	This wipes your complete F<~/.staticperl> directory. Be careful with this,	227	This wipes your complete F<~/.staticperl> directory. Be careful with this,
222	it nukes your perl download, perl sources, perl distribution and any	228	it nukes your perl download, perl sources, perl distribution and any
…		…
272	-MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI::http	278	-MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI::http
273		279
274	# run it	280	# run it
275	./app	281	./app
276		282
		283	Here are the three phase 2 commands:
		284
		285	=over 4
		286
		287	=item F<staticperl mkbundle> args...
		288
		289	The "default" bundle command - it interprets the given bundle options and
		290	writes out F<bundle.h>, F<bundle.c>, F<bundle.ccopts> and F<bundle.ldopts>
		291	files, useful for embedding.
		292
		293	=item F<staticperl mkperl> args...
		294
		295	Creates a bundle just like F<staticperl mkbundle> (in fact, it's the same
		296	as invoking F<staticperl mkbundle --perl> args...), but then compiles and
		297	links a new perl interpreter that embeds the created bundle, then deletes
		298	all intermediate files.
		299
		300	=item F<staticperl mkapp> filename args...
		301
		302	Does the same as F<staticperl mkbundle> (in fact, it's the same as
		303	invoking F<staticperl mkbundle --app> filename args...), but then compiles
		304	and links a new standalone application that simply initialises the perl
		305	interpreter.
		306
		307	The difference to F<staticperl mkperl> is that the standalone application
		308	does not act like a perl interpreter would - in fact, by default it would
		309	just do nothing and exit immediately, so you should specify some code to
		310	be executed via the F<--boot> option.
		311
		312	=back
		313
277	=head3 OPTION PROCESSING	314	=head3 OPTION PROCESSING
278		315
279	All options can be given as arguments on the command line (typically	316	All options can be given as arguments on the command line (typically
280	using long (e.g. C<--verbose>) or short option (e.g. C<-v>) style). Since	317	using long (e.g. C<--verbose>) or short option (e.g. C<-v>) style). Since
281	specifying a lot of modules can make the command line very cumbersome,	318	specifying a lot of options can make the command line very long and
282	you can put all long options into a "bundle specification file" (with or	319	unwieldy, you can put all long options into a "bundle specification file"
283	without C<--> prefix) and specify this bundle file instead.	320	(one option per line, with or without C<--> prefix) and specify this
		321	bundle file instead.
284		322
285	For example, the command given earlier could also look like this:	323	For example, the command given earlier to link a new F<perl> could also
		324	look like this:
286		325
287	staticperl mkperl httpd.bundle	326	staticperl mkperl httpd.bundle
288		327
289	And all options could be in F<httpd.bundle>:	328	With all options stored in the F<httpd.bundle> file (one option per line,
290		329	everything after the option is an argument):
		330
291	use "Config_heavy.pl"	331	use "Config_heavy.pl"
292	use AnyEvent::Impl::Perl	332	use AnyEvent::Impl::Perl
293	use AnyEvent::HTTPD	333	use AnyEvent::HTTPD
294	use URI::http	334	use URI::http
295	add eg/httpd httpd.pm	335	add eg/httpd httpd.pm
296		336
297	All options that specify modules or files to be added are processed in the	337	All options that specify modules or files to be added are processed in the
298	order given on the command line (that affects the C<--use> and C<--eval>	338	order given on the command line.
299	options at the moment).
300		339
301	=head3 PACKAGE SELECTION WORKFLOW	340	=head3 BUNDLE CREATION WORKFLOW / STATICPELR MKBUNDLE OPTIONS
302		341
303	F<staticperl mkbundle> has a number of options to control package	342	F<staticperl mkbundle> works by first assembling a list of candidate
304	selection. This section describes how they interact with each other. Also,	343	files and modules to include, then filtering them by include/exclude
305	since I am still a newbie w.r.t. these issues, maybe future versions of	344	patterns. The remaining modules (together with their direct dependencies,
306	F<staticperl> will change this, so watch out :)	345	such as link libraries and L<AutoLoader> files) are then converted into
		346	bundle files suitable for embedding. F<staticperl mkbundle> can then
		347	optionally build a new perl interpreter or a standalone application.
307		348
308	The idiom "in order" means "in order that they are specified on the
309	commandline". If you use a bundle specification file, then the options
310	will be processed as if they were given in place of the bundle file name.
311
312	=over 4	349	=over 4
313		350
314	=item 1. apply all C<--use>, C<--eval>, C<--add>, C<--addbin> and	351	=item Step 0: Generic argument processing.
315	C<--incglob> options, in order.
316		352
317	In addition, C<--use> and C<--eval> dependencies will be added when the	353	The following options influence F<staticperl mkbundle> itself.
318	options are processed.
319		354
320	=item 2. apply all C<--include> and C<--exclude> options, in order.
321
322	All this step does is potentially reduce the number of files already
323	selected or found in phase 1.
324
325	=item 3. find all modules (== F<.pm> files), gather their static archives
326	(F<.a>) and AutoLoader splitfiles (F<.ix> and F<.al> files), find any
327	extra libraries they need for linking (F<extralibs.ld>) and optionally
328	evaluate any F<.packlist> files.
329
330	This step is required to link against XS extensions and also adds files
331	required for L<AutoLoader> to do it's job.
332
333	=back
334
335	After this, all the files selected for bundling will be read and processed
336	(stripped), the bundle files will be written, and optionally a new F<perl>
337	or application binary will be linked.
338
339	=head3 MKBUNDLE OPTIONS
340
341	=over 4	355	=over 4
342		356
343	=item --verbose \| -v	357	=item C<--verbose> \| C<-v>
344		358
345	Increases the verbosity level by one (the default is C<1>).	359	Increases the verbosity level by one (the default is C<1>).
346		360
347	=item --quiet \| -q	361	=item C<--quiet> \| C<-q>
348		362
349	Decreases the verbosity level by one.	363	Decreases the verbosity level by one.
350		364
		365	=item any other argument
		366
		367	Any other argument is interpreted as a bundle specification file, which
		368	supports all options (without extra quoting), one option per line, in the
		369	format C<option> or C<option argument>. They will effectively be expanded
		370	and processed as if they were directly written on the command line, in
		371	place of the file name.
		372
		373	=back
		374
		375	=item Step 1: gather candidate files and modules
		376
		377	In this step, modules, perl libraries (F<.pl> files) and other files are
		378	selected for inclusion in the bundle. The relevant options are executed
		379	in order (this makes a difference mostly for C<--eval>, which can rely on
		380	earlier C<--use> options to have been executed).
		381
		382	=over 4
		383
		384	=item C<--use> F<module> \| C<-M>F<module>
		385
		386	Include the named module and trace direct dependencies. This is done by
		387	C<use>'ing the module from a fresh package in a subprocess and tracing
		388	which other modules and files it actually loads.
		389
		390	Example: include AnyEvent and AnyEvent::Impl::Perl.
		391
		392	staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl
		393
		394	Sometimes you want to load old-style "perl libraries" (F<.pl> files),
		395	or maybe other weirdly named files. To do that, you need to quote
		396	the name in single or double quotes (this is because F<staticperl>
		397	I<literally> just adds the string after the C<require> - which acts
		398	different when confronted with quoted vs. unquoted strings). When given on
		399	the command line, you probably need to quote once more to avoid your shell
		400	interpreting it. Common cases that need this are F<Config_heavy.pl> and
		401	F<utf8_heavy.pl>.
		402
		403	Example: include the required files for F<perl -V> to work in all its
		404	glory (F<Config.pm> is included automatically by this).
		405
		406	# bourne shell
		407	staticperl mkbundle --use '"Config_heavy.pl"'
		408
		409	# bundle specification file
		410	use "Config_heavy.pl"
		411
		412	The C<-M>module syntax is included as a convenience that might be easier
		413	to remember than C<--use> - it's the same switch as perl itself uses
		414	to load modules. Or maybe it confuses people. Time will tell. Or maybe
		415	not. Sigh.
		416
		417	=item C<--eval> "perl code" \| C<-e> "perl code"
		418
		419	Sometimes it is easier (or necessary) to specify dependencies using perl
		420	code, or maybe one of the modules you use need a special use statement. In
		421	that case, you can use C<--eval> to execute some perl snippet or set some
		422	variables or whatever you need. All files C<require>'d or C<use>'d while
		423	executing the snippet are included in the final bundle.
		424
		425	Keep in mind that F<mkbundle> will not import any symbols from the modules
		426	named by the C<--use> option, so do not expect the symbols from modules
		427	you C<--use>'d earlier on the command line to be available.
		428
		429	Example: force L<AnyEvent> to detect a backend and therefore include it
		430	in the final bundle.
		431
		432	staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect'
		433
		434	# or like this
		435	staticperl mkbundle -MAnyEvent --eval 'AnyEvent::detect'
		436
		437	Example: use a separate "bootstrap" script that C<use>'s lots of modules
		438	and also include this in the final bundle, to be executed automatically
		439	when the interpreter is initialised.
		440
		441	staticperl mkbundle --eval 'do "bootstrap"' --boot bootstrap
		442
		443	=item C<--boot> F<filename>
		444
		445	Include the given file in the bundle and arrange for it to be
		446	executed (using C<require>) before the main program when the new perl
		447	is initialised. This can be used to modify C<@INC> or do similar
		448	modifications before the perl interpreter executes scripts given on the
		449	command line (or via C<-e>). This works even in an embedded interpreter -
		450	the file will be executed during interpreter initialisation in that case.
		451
		452	=item C<--incglob> pattern
		453
		454	This goes through all standard library directories and tries to match any
		455	F<.pm> and F<.pl> files against the extended glob pattern (see below). If
		456	a file matches, it is added. The pattern is matched against the full path
		457	of the file (sans the library directory prefix), e.g. F<Sys/Syslog.pm>.
		458
		459	This is very useful to include "everything":
		460
		461	--incglob '*'
		462
		463	It is also useful for including perl libraries, or trees of those, such as
		464	the unicode database files needed by some perl built-ins, the regex engine
		465	and other modules.
		466
		467	--incglob '/unicore/**.pl'
		468
		469	=item C<--add> F<file> \| C<--add> "F<file> alias"
		470
		471	Adds the given (perl) file into the bundle (and optionally call it
		472	"alias"). The F<file> is either an absolute path or a path relative to the
		473	current directory. If an alias is specified, then this is the name it will
		474	use for C<@INC> searches, otherwise the path F<file> will be used as the
		475	internal name.
		476
		477	This switch is used to include extra files into the bundle.
		478
		479	Example: embed the file F<httpd> in the current directory as F<httpd.pm>
		480	when creating the bundle.
		481
		482	staticperl mkperl --add "httpd httpd.pm"
		483
		484	# can be accessed via "use httpd"
		485
		486	Example: add a file F<initcode> from the current directory.
		487
		488	staticperl mkperl --add 'initcode &initcode'
		489
		490	# can be accessed via "do '&initcode'"
		491
		492	Example: add local files as extra modules in the bundle.
		493
		494	# specification file
		495	add file1 myfiles/file1.pm
		496	add file2 myfiles/file2.pm
		497	add file3 myfiles/file3.pl
		498
		499	# then later, in perl, use
		500	use myfiles::file1;
		501	require myfiles::file2;
		502	my $res = do "myfiles/file3.pl";
		503
		504	=item C<--binadd> F<file> \| C<--add> "F<file> alias"
		505
		506	Just like C<--add>, except that it treats the file as binary and adds it
		507	without any postprocessing (perl files might get stripped to reduce their
		508	size).
		509
		510	If you specify an alias you should probably add a C<&> prefix to avoid
		511	clashing with embedded perl files (whose paths never start with C<&>),
		512	and/or use a special directory prefix, such as C<&res/name>.
		513
		514	You can later get a copy of these files by calling C<staticperl::find
		515	"alias">.
		516
		517	An alternative way to embed binary files is to convert them to perl and
		518	use C<do> to get the contents - this method is a bit cumbersome, but works
		519	both inside and outside of a staticperl bundle:
		520
		521	# a "binary" file, call it "bindata.pl"
		522	<<'SOME_MARKER'
		523	binary data NOT containing SOME_MARKER
		524	SOME_MARKER
		525
		526	# load the binary
		527	chomp (my $data = do "bindata.pl");
		528
		529	=back
		530
		531	=item Step 2: filter all files using C<--include> and C<--exclude> options.
		532
		533	After all candidate files and modules are added, they are I<filtered>
		534	by a combination of C<--include> and C<--exclude> patterns (there is an
		535	implicit C<--include *> at the end, so if no filters are specified, all
		536	files are included).
		537
		538	All that this step does is potentially reduce the number of files that are
		539	to be included - no new files are added during this step.
		540
		541	=over 4
		542
		543	=item C<--include> pattern \| C<-i> pattern \| C<--exclude> pattern \| C<-x> pattern
		544
		545	These specify an include or exclude pattern to be applied to the candidate
		546	file list. An include makes sure that the given files will be part of the
		547	resulting file set, an exclude will exclude remaining files. The patterns
		548	are "extended glob patterns" (see below).
		549
		550	The patterns are applied "in order" - files included via earlier
		551	C<--include> specifications cannot be removed by any following
		552	C<--exclude>, and likewise, and file excluded by an earlier C<--exclude>
		553	cannot be added by any following C<--include>.
		554
		555	For example, to include everything except C<Devel> modules, but still
		556	include F<Devel::PPPort>, you could use this:
		557
		558	--incglob '' -i '/Devel/PPPort.pm' -x '/Devel/*'
		559
		560	=back
		561
		562	=item Step 3: add any extra or "hidden" dependencies.
		563
		564	F<staticperl> currently knows about three extra types of depdendencies
		565	that are added automatically. Only one (F<.packlist> files) is currently
		566	optional and can be influenced, the others are always included:
		567
		568	=over 4
		569
		570	=item C<--usepacklists>
		571
		572	Read F<.packlist> files for each distribution that happens to match a
		573	module name you specified. Sounds weird, and it is, so expect semantics to
		574	change somehow in the future.
		575
		576	The idea is that most CPAN distributions have a F<.pm> file that matches
		577	the name of the distribution (which is rather reasonable after all).
		578
		579	If this switch is enabled, then if any of the F<.pm> files that have been
		580	selected match an install distribution, then all F<.pm>, F<.pl>, F<.al>
		581	and F<.ix> files installed by this distribution are also included.
		582
		583	For example, using this switch, when the L<URI> module is specified, then
		584	all L<URI> submodules that have been installed via the CPAN distribution
		585	are included as well, so you don't have to manually specify them.
		586
		587	=item L<AutoLoader> splitfiles
		588
		589	Some modules use L<AutoLoader> - less commonly (hopefully) used functions
		590	are split into separate F<.al> files, and an index (F<.ix>) file contains
		591	the prototypes.
		592
		593	Both F<.ix> and F<.al> files will be detected automatically and added to
		594	the bundle.
		595
		596	=item link libraries (F<.a> files)
		597
		598	Modules using XS (or any other non-perl language extension compiled at
		599	installation time) will have a static archive (typically F<.a>). These
		600	will automatically be added to the linker options in F<bundle.ldopts>.
		601
		602	Should F<staticperl> find a dynamic link library (typically F<.so>) it
		603	will warn about it - obviously this shouldn't happen unless you use
		604	F<staticperl> on the wrong perl, or one (probably wrongly) configured to
		605	use dynamic loading.
		606
		607	=item extra libraries (F<extralibs.ld>)
		608
		609	Some modules need linking against external libraries - these are found in
		610	F<extralibs.ld> and added to F<bundle.ldopts>.
		611
		612	=back
		613
		614	=item Step 4: write bundle files and optionally link a program
		615
		616	At this point, the select files will be read, processed (stripped) and
		617	finally the bundle files get written to disk, and F<staticperl mkbundle>
		618	is normally finished. Optionally, it can go a step further and either link
		619	a new F<perl> binary with all selected modules and files inside, or build
		620	a standalone application.
		621
		622	Both the contents of the bundle files and any extra linking is controlled
		623	by these options:
		624
		625	=over 4
		626
351	=item --strip none\|pod\|ppi	627	=item C<--strip> C<none>\|C<pod>\|C<ppi>
352		628
353	Specify the stripping method applied to reduce the file of the perl	629	Specify the stripping method applied to reduce the file of the perl
354	sources included.	630	sources included.
355		631
356	The default is C<pod>, which uses the L<Pod::Strip> module to remove all	632	The default is C<pod>, which uses the L<Pod::Strip> module to remove all
…		…
367	Last not least, if you need accurate line numbers in error messages,	643	Last not least, if you need accurate line numbers in error messages,
368	or in the unlikely case where C<pod> is too slow, or some module gets	644	or in the unlikely case where C<pod> is too slow, or some module gets
369	mistreated, you can specify C<none> to not mangle included perl sources in	645	mistreated, you can specify C<none> to not mangle included perl sources in
370	any way.	646	any way.
371		647
372	=item --perl	648	=item C<--perl>
373		649
374	After writing out the bundle files, try to link a new perl interpreter. It	650	After writing out the bundle files, try to link a new perl interpreter. It
375	will be called F<perl> and will be left in the current working	651	will be called F<perl> and will be left in the current working
376	directory. The bundle files will be removed.	652	directory. The bundle files will be removed.
377		653
378	This switch is automatically used when F<staticperl> is invoked with the	654	This switch is automatically used when F<staticperl> is invoked with the
379	C<mkperl> command (instead of C<mkbundle>):	655	C<mkperl> command instead of C<mkbundle>.
380		656
381	# build a new ./perl with only common::sense in it - very small :)	657	Example: build a new F<./perl> binary with only L<common::sense> inside -
		658	it will be even smaller than the standard perl interpreter as none of the
		659	modules of the base distribution (such as L<Fcntl>) will be included.
		660
382	staticperl mkperl -Mcommon::sense	661	staticperl mkperl -Mcommon::sense
383		662
384	=item --app name	663	=item C<--app> F<name>
385		664
386	After writing out the bundle files, try to link a new standalone	665	After writing out the bundle files, try to link a new standalone
387	program. It will be called C<name>, and the bundle files get removed after	666	program. It will be called C<name>, and the bundle files get removed after
388	linking it.	667	linking it.
		668
		669	This switch is automatically used when F<staticperl> is invoked with the
		670	C<mkapp> command instead of C<mkbundle>.
389		671
390	The difference to the (mutually exclusive) C<--perl> option is that the	672	The difference to the (mutually exclusive) C<--perl> option is that the
391	binary created by this option will not try to act as a perl interpreter -	673	binary created by this option will not try to act as a perl interpreter -
392	instead it will simply initialise the perl interpreter, clean it up and	674	instead it will simply initialise the perl interpreter, clean it up and
393	exit.	675	exit.
394		676
395	This switch is automatically used when F<staticperl> is invoked with the	677	This means that, by default, it will do nothing but burn a few CPU cycles
396	C<mkapp> command (instead of C<mkbundle>):
397
398	To let it do something useful you I<must> add some boot code, e.g. with	678	- for it to do something useful you I<must> add some boot code, e.g. with
399	the C<--boot> option.	679	the C<--boot> option.
400		680
401	Example: create a standalone perl binary that will execute F<appfile> when	681	Example: create a standalone perl binary called F<./myexe> that will
402	it is started.	682	execute F<appfile> when it is started.
403		683
404	staticperl mkbundle --app myexe --boot appfile	684	staticperl mkbundle --app myexe --boot appfile
405		685
406	=item --use module \| -Mmodule
407
408	Include the named module and all direct dependencies. This is done by
409	C<require>'ing the module in a subprocess and tracing which other modules
410	and files it actually loads. If the module uses L<AutoLoader>, then all
411	splitfiles will be included as well.
412
413	Example: include AnyEvent and AnyEvent::Impl::Perl.
414
415	staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl
416
417	Sometimes you want to load old-style "perl libraries" (F<.pl> files), or
418	maybe other weirdly named files. To do that, you need to quote the name in
419	single or double quotes. When given on the command line, you probably need
420	to quote once more to avoid your shell interpreting it. Common cases that
421	need this are F<Config_heavy.pl> and F<utf8_heavy.pl>.
422
423	Example: include the required files for F<perl -V> to work in all its
424	glory (F<Config.pm> is included automatically by this).
425
426	# bourne shell
427	staticperl mkbundle --use '"Config_heavy.pl"'
428
429	# bundle specification file
430	use "Config_heavy.pl"
431
432	The C<-Mmodule> syntax is included as an alias that might be easier to
433	remember than C<use>. Or maybe it confuses people. Time will tell. Or
434	maybe not. Argh.
435
436	=item --eval "perl code" \| -e "perl code"
437
438	Sometimes it is easier (or necessary) to specify dependencies using perl
439	code, or maybe one of the modules you use need a special use statement. In
440	that case, you can use C<eval> to execute some perl snippet or set some
441	variables or whatever you need. All files C<require>'d or C<use>'d in the
442	script are included in the final bundle.
443
444	Keep in mind that F<mkbundle> will only C<require> the modules named
445	by the C<--use> option, so do not expect the symbols from modules you
446	C<--use>'d earlier on the command line to be available.
447
448	Example: force L<AnyEvent> to detect a backend and therefore include it
449	in the final bundle.
450
451	staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect'
452
453	# or like this
454	staticperl mkbundle -MAnyEvent --eval 'use AnyEvent; AnyEvent::detect'
455
456	Example: use a separate "bootstrap" script that C<use>'s lots of modules
457	and include this in the final bundle, to be executed automatically.
458
459	staticperl mkbundle --eval 'do "bootstrap"' --boot bootstrap
460
461	=item --boot filename
462
463	Include the given file in the bundle and arrange for it to be executed
464	(using a C<require>) before anything else when the new perl is
465	initialised. This can be used to modify C<@INC> or anything else before
466	the perl interpreter executes scripts given on the command line (or via
467	C<-e>). This works even in an embedded interpreter.
468
469	=item --usepacklist
470
471	Read F<.packlist> files for each distribution that happens to match a
472	module name you specified. Sounds weird, and it is, so expect semantics to
473	change somehow in the future.
474
475	The idea is that most CPAN distributions have a F<.pm> file that matches
476	the name of the distribution (which is rather reasonable after all).
477
478	If this switch is enabled, then if any of the F<.pm> files that have been
479	selected match an install distribution, then all F<.pm>, F<.pl>, F<.al>
480	and F<.ix> files installed by this distribution are also included.
481
482	For example, using this switch, when the L<URI> module is specified, then
483	all L<URI> submodules that have been installed via the CPAN distribution
484	are included as well, so you don't have to manually specify them.
485
486	=item --incglob pattern
487
488	This goes through all library directories and tries to match any F<.pm>
489	and F<.pl> files against the extended glob pattern (see below). If a file
490	matches, it is added. This switch will automatically detect L<AutoLoader>
491	files and the required link libraries for XS modules, but it will I<not>
492	scan the file for dependencies (at the moment).
493
494	This is mainly useful to include "everything":
495
496	--incglob '*'
497
498	Or to include perl libraries, or trees of those, such as the unicode
499	database files needed by many other modules:
500
501	--incglob '/unicore/**.pl'
502
503	=item --add file \| --add "file alias"
504
505	Adds the given (perl) file into the bundle (and optionally call it
506	"alias"). This is useful to include any custom files into the bundle.
507
508	Example: embed the file F<httpd> as F<httpd.pm> when creating the bundle.
509
510	staticperl mkperl --add "httpd httpd.pm"
511
512	It is also a great way to add any custom modules:
513
514	# specification file
515	add file1 myfiles/file1
516	add file2 myfiles/file2
517	add file3 myfiles/file3
518
519	=item --binadd file \| --add "file alias"
520
521	Just like C<--add>, except that it treats the file as binary and adds it
522	without any processing.
523
524	You should probably add a C</> prefix to avoid clashing with embedded
525	perl files (whose paths do not start with C</>), and/or use a special
526	directory, such as C</res/name>.
527
528	You can later get a copy of these files by calling C<staticperl::find
529	"alias">.
530
531	=item --include pattern \| -i pattern \| --exclude pattern \| -x pattern
532
533	These two options define an include/exclude filter that is used after all
534	files selected by the other options have been found. Each include/exclude
535	is applied to all files found so far - an include makes sure that the
536	given files will be part of the resulting file set, an exclude will
537	exclude files. The patterns are "extended glob patterns" (see below).
538
539	For example, to include everything, except C<Devel> modules, but still
540	include F<Devel::PPPort>, you could use this:
541
542	--incglob '' -i '/Devel/PPPort.pm' -x '/Devel/*'
543
544	=item --static	686	=item C<--static>
545		687
546	When C<--perl> is also given, link statically instead of dynamically. The	688	Add C<-static> to F<bundle.ldopts>, which means a fully static (if
		689	supported by the OS) executable will be created. This is not immensely
		690	useful when just creating the bundle files, but is most useful when
		691	linking a binary with the C<--perl> or C<--app> options.
		692
547	default is to link the new perl interpreter fully dynamic (that means all	693	The default is to link the new binary dynamically (that means all perl
548	perl modules are linked statically, but all external libraries are still	694	modules are linked statically, but all external libraries are still
549	referenced dynamically).	695	referenced dynamically).
550		696
551	Keep in mind that Solaris doesn't support static linking at all, and	697	Keep in mind that Solaris doesn't support static linking at all, and
552	systems based on GNU libc don't really support it in a usable fashion	698	systems based on GNU libc don't really support it in a very usable
553	either. Try uClibc if you want to create fully statically linked	699	fashion either. Try uClibc if you want to create fully statically linked
554	executables, or try the C<--staticlibs> option to link only some libraries	700	executables, or try the C<--staticlib> option to link only some libraries
555	statically.	701	statically.
556		702
557	=item --staticlib libname	703	=item C<--staticlib> libname
558		704
559	When not linking fully statically, this option allows you to link specific	705	When not linking fully statically, this option allows you to link specific
560	libraries statically. What it does is simply replace all occurances of	706	libraries statically. What it does is simply replace all occurrences of
561	C<-llibname> with the GCC-specific C<-Wl,-Bstatic -llibname -Wl,-Bdynamic>	707	C<-llibname> with the GCC-specific C<-Wl,-Bstatic -llibname -Wl,-Bdynamic>
562	option.	708	option.
563		709
564	This will have no effect unless the library is actually linked against,	710	This will have no effect unless the library is actually linked against,
565	specifically, C<--staticlib> will not link against the named library	711	specifically, C<--staticlib> will not link against the named library
566	unless it would be linked against anyway.	712	unless it would be linked against anyway.
567		713
568	Example: link libcrypt statically into the binary.	714	Example: link libcrypt statically into the final binary.
569		715
570	staticperl mkperl -MIO::AIO --staticlib crypt	716	staticperl mkperl -MIO::AIO --staticlib crypt
571		717
572	# ldopts might nwo contain:	718	# ldopts might now contain:
573	# -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread	719	# -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread
574		720
575	=item any other argument	721	=back
576
577	Any other argument is interpreted as a bundle specification file, which
578	supports most long options (without extra quoting), one option per line.
579		722
580	=back	723	=back
581		724
582	=head3 EXTENDED GLOB PATTERNS	725	=head3 EXTENDED GLOB PATTERNS
583		726
…		…
597	=item Patterns not starting with F</> will be anchored at the end of the path.	740	=item Patterns not starting with F</> will be anchored at the end of the path.
598		741
599	That is, F<idna.pl> will match any file called F<idna.pl> anywhere in the	742	That is, F<idna.pl> will match any file called F<idna.pl> anywhere in the
600	hierarchy, but not any directories of the same name.	743	hierarchy, but not any directories of the same name.
601		744
602	=item A F<*> matches any single component.	745	=item A F<*> matches anything within a single path component.
603		746
604	That is, F</unicore/*.pl> would match all F<.pl> files directly inside	747	That is, F</unicore/*.pl> would match all F<.pl> files directly inside
605	C</unicore>, not any deeper level F<.pl> files. Or in other words, F<*>	748	C</unicore>, not any deeper level F<.pl> files. Or in other words, F<*>
606	will not match slashes.	749	will not match slashes.
607		750
…		…
703		846
704	More commonly, you would either activate 64 bit integer support	847	More commonly, you would either activate 64 bit integer support
705	(C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to	848	(C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to
706	reduce filesize further.	849	reduce filesize further.
707		850
708	=item C<PERL_CC>, C<PERL_CPPFLAGS>, C<PERL_OPTIMIZE>, C<PERL_LDFLAGS>, C<PERL_LIBS>	851	=item C<PERL_CC>, C<PERL_CCFLAGS>, C<PERL_OPTIMIZE>, C<PERL_LDFLAGS>, C<PERL_LIBS>
709		852
710	These flags are passed to perl's F<Configure> script, and are generally	853	These flags are passed to perl's F<Configure> script, and are generally
711	optimised for small size (at the cost of performance). Since they also	854	optimised for small size (at the cost of performance). Since they also
712	contain subtle workarounds around various build issues, changing these	855	contain subtle workarounds around various build issues, changing these
713	usually requires understanding their default values - best look at the top	856	usually requires understanding their default values - best look at
714	of the F<staticperl> script for more info on these.	857	the top of the F<staticperl> script for more info on these, and use a
		858	F<~/.staticperlrc> to override them.
		859
		860	Most of the variables override (or modify) the corresponding F<Configure>
		861	variable, except C<PERL_CCFLAGS>, which gets appended.
715		862
716	=back	863	=back
717		864
718	=head4 Variables you probably I<do not want> to override	865	=head4 Variables you probably I<do not want> to override
719		866
…		…
814	A header file that contains the prototypes of the few symbols "exported"	961	A header file that contains the prototypes of the few symbols "exported"
815	by bundle.c, and also exposes the perl headers to the application.	962	by bundle.c, and also exposes the perl headers to the application.
816		963
817	=over 4	964	=over 4
818		965
819	=item staticperl_init ()	966	=item staticperl_init (xs_init = 0)
820		967
821	Initialises the perl interpreter. You can use the normal perl functions	968	Initialises the perl interpreter. You can use the normal perl functions
822	after calling this function, for example, to define extra functions or	969	after calling this function, for example, to define extra functions or
823	to load a .pm file that contains some initialisation code, or the main	970	to load a .pm file that contains some initialisation code, or the main
824	program function:	971	program function:
…		…
831	}	978	}
832		979
833	static void	980	static void
834	run_myapp(void)	981	run_myapp(void)
835	{	982	{
836	staticperl_init ();	983	staticperl_init (0);
837	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");	984	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");
838	eval_pv ("require myapp::main", 1); // executes "myapp/main.pm"	985	eval_pv ("require myapp::main", 1); // executes "myapp/main.pm"
839	}	986	}
840		987
		988	When your bootcode already wants to access some XS functions at
		989	compiletime, then you need to supply an C<xs_init> function pointer that
		990	is called as soon as perl is initialised enough to define XS functions,
		991	but before the preamble code is executed:
		992
		993	static void
		994	xs_init (pTHX)
		995	{
		996	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");
		997	}
		998
		999	static void
		1000	run_myapp(void)
		1001	{
		1002	staticperl_init (xs_init);
		1003	}
		1004
		1005	=item staticperl_cleanup ()
		1006
		1007	In the unlikely case that you want to destroy the perl interpreter, here
		1008	is the corresponding function.
		1009
841	=item staticperl_xs_init (pTHX)	1010	=item staticperl_xs_init (pTHX)
842		1011
843	Sometimes you need direct control over C<perl_parse> and C<perl_run>, in	1012	Sometimes you need direct control over C<perl_parse> and C<perl_run>, in
844	which case you do not want to use C<staticperl_init> but call them on your	1013	which case you do not want to use C<staticperl_init> but call them on your
845	own.	1014	own.
846		1015
847	Then you need this function - either pass it directly as the C<xs_init>	1016	Then you need this function - either pass it directly as the C<xs_init>
848	function to C<perl_parse>, or call it from your own C<xs_init> function.	1017	function to C<perl_parse>, or call it as one of the first things from your
849		1018	own C<xs_init> function.
850	=item staticperl_cleanup ()
851
852	In the unlikely case that you want to destroy the perl interpreter, here
853	is the corresponding function.
854		1019
855	=item PerlInterpreter *staticperl	1020	=item PerlInterpreter *staticperl
856		1021
857	The perl interpreter pointer used by staticperl. Not normally so useful,	1022	The perl interpreter pointer used by staticperl. Not normally so useful,
858	but there it is.	1023	but there it is.
…		…
894		1059
895	Returns the list of all paths embedded in this binary.	1060	Returns the list of all paths embedded in this binary.
896		1061
897	=back	1062	=back
898		1063
899	=head1 FULLY STATIC BINARIES - BUILDROOT	1064	=head1 FULLY STATIC BINARIES - UCLIBC AND BUILDROOT
900		1065
901	To make truly static (Linux-) libraries, you might want to have a look at	1066	To make truly static (Linux-) libraries, you might want to have a look at
902	buildroot (L<http://buildroot.uclibc.org/>).	1067	buildroot (L<http://buildroot.uclibc.org/>).
903		1068
904	Buildroot is primarily meant to set up a cross-compile environment (which	1069	Buildroot is primarily meant to set up a cross-compile environment (which
…		…
976	handling for those files), so including them on demand by your application	1141	handling for those files), so including them on demand by your application
977	only might pay off.	1142	only might pay off.
978		1143
979	To simply include the whole unicode database, use:	1144	To simply include the whole unicode database, use:
980		1145
981	--incglob '/unicore/*.pl'	1146	--incglob '/unicore/**.pl'
982		1147
983	=item AnyEvent	1148	=item AnyEvent
984		1149
985	AnyEvent needs a backend implementation that it will load in a delayed	1150	AnyEvent needs a backend implementation that it will load in a delayed
986	fashion. The L<AnyEvent::Impl::Perl> backend is the default choice	1151	fashion. The L<AnyEvent::Impl::Perl> backend is the default choice
…		…
991		1156
992	If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn	1157	If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn
993	functions), you also need to include C<"AnyEvent/Util/idna.pl"> and	1158	functions), you also need to include C<"AnyEvent/Util/idna.pl"> and
994	C<"AnyEvent/Util/uts46data.pl">.	1159	C<"AnyEvent/Util/uts46data.pl">.
995		1160
996	Or you can use C<--usepacklist> and specify C<-MAnyEvent> to include	1161	Or you can use C<--usepacklists> and specify C<-MAnyEvent> to include
997	everything.	1162	everything.
998		1163
999	=item Carp	1164	=item Carp
1000		1165
1001	Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of	1166	Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of
…		…
1007	turn might need L<"Config_heavy.pl">. Including the latter gives you	1172	turn might need L<"Config_heavy.pl">. Including the latter gives you
1008	both.	1173	both.
1009		1174
1010	=item Term::ReadLine::Perl	1175	=item Term::ReadLine::Perl
1011		1176
1012	Also needs L<Term::ReadLine::readline>, or C<--usepacklist>.	1177	Also needs L<Term::ReadLine::readline>, or C<--usepacklists>.
1013		1178
1014	=item URI	1179	=item URI
1015		1180
1016	URI implements schemes as separate modules - the generic URL scheme is	1181	URI implements schemes as separate modules - the generic URL scheme is
1017	implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If	1182	implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If
1018	you need to use any of these schemes, you should include these manually,	1183	you need to use any of these schemes, you should include these manually,
1019	or use C<--usepacklist>.	1184	or use C<--usepacklists>.
1020		1185
1021	=back	1186	=back
1022		1187
1023	=head2 RECIPES	1188	=head2 RECIPES
1024		1189
1025	=over 4	1190	=over 4
1026		1191
1027	=item Linking everything in	1192	=item Just link everything in
1028		1193
1029	To link just about everything installed in the perl library into a new	1194	To link just about everything installed in the perl library into a new
1030	perl, try this:	1195	perl, try this (the first time this runs it will take a long time, as a
		1196	lot of files need to be parsed):
1031		1197
1032	staticperl mkperl --strip ppi --incglob '*'	1198	staticperl mkperl -v --strip ppi --incglob '*'
1033		1199
		1200	If you don't mind the extra megabytes, this can be a very effective way of
		1201	creating bundles without having to worry about forgetting any modules.
		1202
		1203	You get even more useful variants of this method by first selecting
		1204	everything, and then excluding stuff you are reasonable sure not to need -
		1205	L<bigperl\|http://staticperl.schmorp.de/bigperl.html> uses this approach.
		1206
1034	=item Getting rid of netdb function	1207	=item Getting rid of netdb functions
1035		1208
1036	The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent>	1209	The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent>
1037	and so on) that few applications use. You can avoid compiling them in by	1210	and so on) that few applications use. You can avoid compiling them in by
1038	putting the following fragment into a C<preconfigure> hook:	1211	putting the following fragment into a C<preconfigure> hook:
1039		1212
…		…
1056	do	1229	do
1057	PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"	1230	PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"
1058	done	1231	done
1059	}	1232	}
1060		1233
1061	This mostly gains space when linking staticaly, as the functions will	1234	This mostly gains space when linking statically, as the functions will
1062	likely not be linked in. The gain for dynamically-linked binaries is	1235	likely not be linked in. The gain for dynamically-linked binaries is
1063	smaller.	1236	smaller.
1064		1237
1065	Also, this leaves C<gethostbyname> in - not only is it actually used	1238	Also, this leaves C<gethostbyname> in - not only is it actually used
1066	often, the L<Socket> module also exposes it, so leaving it out usually	1239	often, the L<Socket> module also exposes it, so leaving it out usually

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing App-Staticperl/staticperl.pod (file contents): Revision 1.23 by root, Mon Dec 13 18:08:01 2010 UTC vs. Revision 1.35 by root, Thu Feb 10 22:44:29 2011 UTC

Diff Legend

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.23 by root, Mon Dec 13 18:08:01 2010 UTC vs.
Revision 1.35 by root, Thu Feb 10 22:44:29 2011 UTC