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

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.21 by root, Sat Dec 11 23:28:22 2010 UTC vs.
Revision 1.37 by root, Thu Feb 24 07:01:46 2011 UTC

…		…
20		20
21	Typical Examples:	21	Typical Examples:
22		22
23	staticperl install # fetch, configure, build and install perl	23	staticperl install # fetch, configure, build and install perl
24	staticperl cpan # run interactive cpan shell	24	staticperl cpan # run interactive cpan shell
25	staticperl mkperl -M '"Config_heavy.pl"' # build a perl that supports -V	25	staticperl mkperl -MConfig_heavy.pl # build a perl that supports -V
26	staticperl mkperl -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI -MURI::http	26	staticperl mkperl -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI -MURI::http
27	# build a perl with the above modules linked in	27	# build a perl with the above modules linked in
28	staticperl mkapp myapp --boot mainprog mymodules	28	staticperl mkapp myapp --boot mainprog mymodules
29	# build a binary "myapp" from mainprog and mymodules	29	# build a binary "myapp" from mainprog and mymodules
30		30
…		…
139	with creating binaries and bundle files.	139	with creating binaries and bundle files.
140		140
141	=head2 PHASE 1 COMMANDS: INSTALLING PERL	141	=head2 PHASE 1 COMMANDS: INSTALLING PERL
142		142
143	The most important command is F<install>, which does basically	143	The most important command is F<install>, which does basically
144	everything. The default is to download and install perl 5.12.2 and a few	144	everything. The default is to download and install perl 5.12.3 and a few
145	modules required by F<staticperl> itself, but all this can (and should) be	145	modules required by F<staticperl> itself, but all this can (and should) be
146	changed - see L<CONFIGURATION>, below.	146	changed - see L<CONFIGURATION>, below.
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
…		…
246		252
247	# first make sure we have perl and the required modules	253	# first make sure we have perl and the required modules
248	staticperl instcpan AnyEvent::HTTPD	254	staticperl instcpan AnyEvent::HTTPD
249		255
250	# now build the perl	256	# now build the perl
251	staticperl mkperl -M'"Config_heavy.pl"' -MAnyEvent::Impl::Perl \	257	staticperl mkperl -MConfig_heavy.pl -MAnyEvent::Impl::Perl \
252	-MAnyEvent::HTTPD -MURI::http \	258	-MAnyEvent::HTTPD -MURI::http \
253	--add 'eg/httpd httpd.pm'	259	--add 'eg/httpd httpd.pm'
254		260
255	# finally, invoke it	261	# finally, invoke it
256	./perl -Mhttpd	262	./perl -Mhttpd
…		…
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 or perl library and trace direct
		387	dependencies. This is done by loading the module in a subprocess and
		388	tracing which other modules and files it actually loads.
		389
		390	Example: include AnyEvent and AnyEvent::Impl::Perl.
		391
		392	staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl
		393
		394	Sometimes you want to load old-style "perl libraries" (F<.pl> files), or
		395	maybe other weirdly named files. To support this, the C<--use> option
		396	actually tries to do what you mean, depending on the string you specify:
		397
		398	=over 4
		399
		400	=item a possibly valid module name, e.g. F<common::sense>, F<Carp>,
		401	F<Coro::Mysql>.
		402
		403	If the string contains no quotes, no F</> and no F<.>, then C<--use>
		404	assumes that it is a normal module name. It will create a new package and
		405	evaluate a C<use module> in it, i.e. it will load the package and do a
		406	default import.
		407
		408	The import step is done because many modules trigger more dependencies
		409	when something is imported than without.
		410
		411	=item anything that contains F</> or F<.> characters,
		412	e.g. F<utf8_heavy.pl>, F<Module/private/data.pl>.
		413
		414	The string will be quoted and passed to require, as if you used C<require
		415	$module>. Nothing will be imported.
		416
		417	=item "path" or 'path', e.g. C<"utf8_heavy.pl">.
		418
		419	If you enclose the name into single or double quotes, then the quotes will
		420	be removed and the resulting string will be passed to require. This syntax
		421	is form compatibility with older versions of staticperl and should not be
		422	used anymore.
		423
		424	=back
		425
		426	Example: C<use> AnyEvent::Socket, once using C<use> (importing the
		427	symbols), and once via C<require>, not importing any symbols. The first
		428	form is preferred as many modules load some extra dependencies when asked
		429	to export symbols.
		430
		431	staticperl mkbundle -MAnyEvent::Socket # use + import
		432	staticperl mkbundle -MAnyEvent/Socket.pm # require only
		433
		434	Example: include the required files for F<perl -V> to work in all its
		435	glory (F<Config.pm> is included automatically by the dependency tracker).
		436
		437	# shell command
		438	staticperl mkbundle -MConfig_heavy.pl
		439
		440	# bundle specification file
		441	use Config_heavy.pl
		442
		443	The C<-M>module syntax is included as a convenience that might be easier
		444	to remember than C<--use> - it's the same switch as perl itself uses
		445	to load modules. Or maybe it confuses people. Time will tell. Or maybe
		446	not. Sigh.
		447
		448	=item C<--eval> "perl code" \| C<-e> "perl code"
		449
		450	Sometimes it is easier (or necessary) to specify dependencies using perl
		451	code, or maybe one of the modules you use need a special use statement. In
		452	that case, you can use C<--eval> to execute some perl snippet or set some
		453	variables or whatever you need. All files C<require>'d or C<use>'d while
		454	executing the snippet are included in the final bundle.
		455
		456	Keep in mind that F<mkbundle> will not import any symbols from the modules
		457	named by the C<--use> option, so do not expect the symbols from modules
		458	you C<--use>'d earlier on the command line to be available.
		459
		460	Example: force L<AnyEvent> to detect a backend and therefore include it
		461	in the final bundle.
		462
		463	staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect'
		464
		465	# or like this
		466	staticperl mkbundle -MAnyEvent --eval 'AnyEvent::detect'
		467
		468	Example: use a separate "bootstrap" script that C<use>'s lots of modules
		469	and also include this in the final bundle, to be executed automatically
		470	when the interpreter is initialised.
		471
		472	staticperl mkbundle --eval 'do "bootstrap"' --boot bootstrap
		473
		474	=item C<--boot> F<filename>
		475
		476	Include the given file in the bundle and arrange for it to be
		477	executed (using C<require>) before the main program when the new perl
		478	is initialised. This can be used to modify C<@INC> or do similar
		479	modifications before the perl interpreter executes scripts given on the
		480	command line (or via C<-e>). This works even in an embedded interpreter -
		481	the file will be executed during interpreter initialisation in that case.
		482
		483	=item C<--incglob> pattern
		484
		485	This goes through all standard library directories and tries to match any
		486	F<.pm> and F<.pl> files against the extended glob pattern (see below). If
		487	a file matches, it is added. The pattern is matched against the full path
		488	of the file (sans the library directory prefix), e.g. F<Sys/Syslog.pm>.
		489
		490	This is very useful to include "everything":
		491
		492	--incglob '*'
		493
		494	It is also useful for including perl libraries, or trees of those, such as
		495	the unicode database files needed by some perl built-ins, the regex engine
		496	and other modules.
		497
		498	--incglob '/unicore/**.pl'
		499
		500	=item C<--add> F<file> \| C<--add> "F<file> alias"
		501
		502	Adds the given (perl) file into the bundle (and optionally call it
		503	"alias"). The F<file> is either an absolute path or a path relative to the
		504	current directory. If an alias is specified, then this is the name it will
		505	use for C<@INC> searches, otherwise the path F<file> will be used as the
		506	internal name.
		507
		508	This switch is used to include extra files into the bundle.
		509
		510	Example: embed the file F<httpd> in the current directory as F<httpd.pm>
		511	when creating the bundle.
		512
		513	staticperl mkperl --add "httpd httpd.pm"
		514
		515	# can be accessed via "use httpd"
		516
		517	Example: add a file F<initcode> from the current directory.
		518
		519	staticperl mkperl --add 'initcode &initcode'
		520
		521	# can be accessed via "do '&initcode'"
		522
		523	Example: add local files as extra modules in the bundle.
		524
		525	# specification file
		526	add file1 myfiles/file1.pm
		527	add file2 myfiles/file2.pm
		528	add file3 myfiles/file3.pl
		529
		530	# then later, in perl, use
		531	use myfiles::file1;
		532	require myfiles::file2;
		533	my $res = do "myfiles/file3.pl";
		534
		535	=item C<--binadd> F<file> \| C<--add> "F<file> alias"
		536
		537	Just like C<--add>, except that it treats the file as binary and adds it
		538	without any postprocessing (perl files might get stripped to reduce their
		539	size).
		540
		541	If you specify an alias you should probably add a C<&> prefix to avoid
		542	clashing with embedded perl files (whose paths never start with C<&>),
		543	and/or use a special directory prefix, such as C<&res/name>.
		544
		545	You can later get a copy of these files by calling C<staticperl::find
		546	"alias">.
		547
		548	An alternative way to embed binary files is to convert them to perl and
		549	use C<do> to get the contents - this method is a bit cumbersome, but works
		550	both inside and outside of a staticperl bundle:
		551
		552	# a "binary" file, call it "bindata.pl"
		553	<<'SOME_MARKER'
		554	binary data NOT containing SOME_MARKER
		555	SOME_MARKER
		556
		557	# load the binary
		558	chomp (my $data = do "bindata.pl");
		559
		560	=back
		561
		562	=item Step 2: filter all files using C<--include> and C<--exclude> options.
		563
		564	After all candidate files and modules are added, they are I<filtered>
		565	by a combination of C<--include> and C<--exclude> patterns (there is an
		566	implicit C<--include *> at the end, so if no filters are specified, all
		567	files are included).
		568
		569	All that this step does is potentially reduce the number of files that are
		570	to be included - no new files are added during this step.
		571
		572	=over 4
		573
		574	=item C<--include> pattern \| C<-i> pattern \| C<--exclude> pattern \| C<-x> pattern
		575
		576	These specify an include or exclude pattern to be applied to the candidate
		577	file list. An include makes sure that the given files will be part of the
		578	resulting file set, an exclude will exclude remaining files. The patterns
		579	are "extended glob patterns" (see below).
		580
		581	The patterns are applied "in order" - files included via earlier
		582	C<--include> specifications cannot be removed by any following
		583	C<--exclude>, and likewise, and file excluded by an earlier C<--exclude>
		584	cannot be added by any following C<--include>.
		585
		586	For example, to include everything except C<Devel> modules, but still
		587	include F<Devel::PPPort>, you could use this:
		588
		589	--incglob '' -i '/Devel/PPPort.pm' -x '/Devel/*'
		590
		591	=back
		592
		593	=item Step 3: add any extra or "hidden" dependencies.
		594
		595	F<staticperl> currently knows about three extra types of depdendencies
		596	that are added automatically. Only one (F<.packlist> files) is currently
		597	optional and can be influenced, the others are always included:
		598
		599	=over 4
		600
		601	=item C<--usepacklists>
		602
		603	Read F<.packlist> files for each distribution that happens to match a
		604	module name you specified. Sounds weird, and it is, so expect semantics to
		605	change somehow in the future.
		606
		607	The idea is that most CPAN distributions have a F<.pm> file that matches
		608	the name of the distribution (which is rather reasonable after all).
		609
		610	If this switch is enabled, then if any of the F<.pm> files that have been
		611	selected match an install distribution, then all F<.pm>, F<.pl>, F<.al>
		612	and F<.ix> files installed by this distribution are also included.
		613
		614	For example, using this switch, when the L<URI> module is specified, then
		615	all L<URI> submodules that have been installed via the CPAN distribution
		616	are included as well, so you don't have to manually specify them.
		617
		618	=item L<AutoLoader> splitfiles
		619
		620	Some modules use L<AutoLoader> - less commonly (hopefully) used functions
		621	are split into separate F<.al> files, and an index (F<.ix>) file contains
		622	the prototypes.
		623
		624	Both F<.ix> and F<.al> files will be detected automatically and added to
		625	the bundle.
		626
		627	=item link libraries (F<.a> files)
		628
		629	Modules using XS (or any other non-perl language extension compiled at
		630	installation time) will have a static archive (typically F<.a>). These
		631	will automatically be added to the linker options in F<bundle.ldopts>.
		632
		633	Should F<staticperl> find a dynamic link library (typically F<.so>) it
		634	will warn about it - obviously this shouldn't happen unless you use
		635	F<staticperl> on the wrong perl, or one (probably wrongly) configured to
		636	use dynamic loading.
		637
		638	=item extra libraries (F<extralibs.ld>)
		639
		640	Some modules need linking against external libraries - these are found in
		641	F<extralibs.ld> and added to F<bundle.ldopts>.
		642
		643	=back
		644
		645	=item Step 4: write bundle files and optionally link a program
		646
		647	At this point, the select files will be read, processed (stripped) and
		648	finally the bundle files get written to disk, and F<staticperl mkbundle>
		649	is normally finished. Optionally, it can go a step further and either link
		650	a new F<perl> binary with all selected modules and files inside, or build
		651	a standalone application.
		652
		653	Both the contents of the bundle files and any extra linking is controlled
		654	by these options:
		655
		656	=over 4
		657
351	=item --strip none\|pod\|ppi	658	=item C<--strip> C<none>\|C<pod>\|C<ppi>
352		659
353	Specify the stripping method applied to reduce the file of the perl	660	Specify the stripping method applied to reduce the file of the perl
354	sources included.	661	sources included.
355		662
356	The default is C<pod>, which uses the L<Pod::Strip> module to remove all	663	The default is C<pod>, which uses the L<Pod::Strip> module to remove all
…		…
367	Last not least, if you need accurate line numbers in error messages,	674	Last not least, if you need accurate line numbers in error messages,
368	or in the unlikely case where C<pod> is too slow, or some module gets	675	or in the unlikely case where C<pod> is too slow, or some module gets
369	mistreated, you can specify C<none> to not mangle included perl sources in	676	mistreated, you can specify C<none> to not mangle included perl sources in
370	any way.	677	any way.
371		678
372	=item --perl	679	=item C<--perl>
373		680
374	After writing out the bundle files, try to link a new perl interpreter. It	681	After writing out the bundle files, try to link a new perl interpreter. It
375	will be called F<perl> and will be left in the current working	682	will be called F<perl> and will be left in the current working
376	directory. The bundle files will be removed.	683	directory. The bundle files will be removed.
377		684
378	This switch is automatically used when F<staticperl> is invoked with the	685	This switch is automatically used when F<staticperl> is invoked with the
379	C<mkperl> command (instead of C<mkbundle>):	686	C<mkperl> command instead of C<mkbundle>.
380		687
381	# build a new ./perl with only common::sense in it - very small :)	688	Example: build a new F<./perl> binary with only L<common::sense> inside -
		689	it will be even smaller than the standard perl interpreter as none of the
		690	modules of the base distribution (such as L<Fcntl>) will be included.
		691
382	staticperl mkperl -Mcommon::sense	692	staticperl mkperl -Mcommon::sense
383		693
384	=item --app name	694	=item C<--app> F<name>
385		695
386	After writing out the bundle files, try to link a new standalone	696	After writing out the bundle files, try to link a new standalone
387	program. It will be called C<name>, and the bundle files get removed after	697	program. It will be called C<name>, and the bundle files get removed after
388	linking it.	698	linking it.
		699
		700	This switch is automatically used when F<staticperl> is invoked with the
		701	C<mkapp> command instead of C<mkbundle>.
389		702
390	The difference to the (mutually exclusive) C<--perl> option is that the	703	The difference to the (mutually exclusive) C<--perl> option is that the
391	binary created by this option will not try to act as a perl interpreter -	704	binary created by this option will not try to act as a perl interpreter -
392	instead it will simply initialise the perl interpreter, clean it up and	705	instead it will simply initialise the perl interpreter, clean it up and
393	exit.	706	exit.
394		707
395	This switch is automatically used when F<staticperl> is invoked with the	708	This means that, by default, it will do nothing but burn a few CPU cycles
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	709	- for it to do something useful you I<must> add some boot code, e.g. with
399	the C<--boot> option.	710	the C<--boot> option.
400		711
401	Example: create a standalone perl binary that will execute F<appfile> when	712	Example: create a standalone perl binary called F<./myexe> that will
402	it is started.	713	execute F<appfile> when it is started.
403		714
404	staticperl mkbundle --app myexe --boot appfile	715	staticperl mkbundle --app myexe --boot appfile
405		716
406	=item --use module \| -Mmodule	717	=item C<--ignore-env>
407		718
408	Include the named module and all direct dependencies. This is done by	719	Generates extra code to unset some environment variables before
409	C<require>'ing the module in a subprocess and tracing which other modules	720	initialising/running perl. Perl supports a lot of environment variables
410	and files it actually loads. If the module uses L<AutoLoader>, then all	721	that might alter execution in ways that might be undesirablre for
411	splitfiles will be included as well.	722	standalone applications, and this option removes those known to cause
		723	trouble.
412		724
413	Example: include AnyEvent and AnyEvent::Impl::Perl.	725	Specifically, these are removed:
414		726
415	staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl	727	C<PERL_HASH_SEED_DEBUG> and C<PERL_DEBUG_MSTATS> can cause underaible
		728	output, C<PERL5OPT>, C<PERL_DESTRUCT_LEVEL>, C<PERL_HASH_SEED> and
		729	C<PERL_SIGNALS> can alter execution significantly, and C<PERL_UNICODE>,
		730	C<PERLIO_DEBUG> and C<PERLIO> can affect input and output.
416		731
417	Sometimes you want to load old-style "perl libraries" (F<.pl> files), or	732	The variables C<PERL_LIB> and C<PERL5_LIB> are always ignored because the
418	maybe other weirdly named files. To do that, you need to quote the name in	733	startup code used by F<staticperl> overrides C<@INC> in all cases.
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		734
423	Example: include the required files for F<perl -V> to work in all its	735	This option will not make your program more secure (unless you are
424	glory (F<Config.pm> is included automatically by this).	736	running with elevated privileges), but it will reduce the surprise effect
		737	when a user has these environment variables set and doesn't expect your
		738	standalone program to act like a perl interpreter.
425		739
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	740	=item C<--static>
545		741
546	When C<--perl> is also given, link statically instead of dynamically. The	742	Add C<-static> to F<bundle.ldopts>, which means a fully static (if
		743	supported by the OS) executable will be created. This is not immensely
		744	useful when just creating the bundle files, but is most useful when
		745	linking a binary with the C<--perl> or C<--app> options.
		746
547	default is to link the new perl interpreter fully dynamic (that means all	747	The default is to link the new binary dynamically (that means all perl
548	perl modules are linked statically, but all external libraries are still	748	modules are linked statically, but all external libraries are still
549	referenced dynamically).	749	referenced dynamically).
550		750
551	Keep in mind that Solaris doesn't support static linking at all, and	751	Keep in mind that Solaris doesn't support static linking at all, and
552	systems based on GNU libc don't really support it in a usable fashion	752	systems based on GNU libc don't really support it in a very usable
553	either. Try uClibc if you want to create fully statically linked	753	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	754	executables, or try the C<--staticlib> option to link only some libraries
555	statically.	755	statically.
556		756
557	=item --staticlib libname	757	=item C<--staticlib> libname
558		758
559	When not linking fully statically, this option allows you to link specific	759	When not linking fully statically, this option allows you to link specific
560	libraries statically. What it does is simply replace all occurances of	760	libraries statically. What it does is simply replace all occurrences of
561	C<-llibname> with the GCC-specific C<-Wl,-Bstatic -llibname -Wl,-Bdynamic>	761	C<-llibname> with the GCC-specific C<-Wl,-Bstatic -llibname -Wl,-Bdynamic>
562	option.	762	option.
563		763
564	This will have no effect unless the library is actually linked against,	764	This will have no effect unless the library is actually linked against,
565	specifically, C<--staticlib> will not link against the named library	765	specifically, C<--staticlib> will not link against the named library
566	unless it would be linked against anyway.	766	unless it would be linked against anyway.
567		767
568	Example: link libcrypt statically into the binary.	768	Example: link libcrypt statically into the final binary.
569		769
570	staticperl mkperl -MIO::AIO --staticlib crypt	770	staticperl mkperl -MIO::AIO --staticlib crypt
571		771
572	# ldopts might nwo contain:	772	# ldopts might now contain:
573	# -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread	773	# -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread
574		774
575	=item any other argument	775	=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		776
580	=back	777	=back
581		778
582	=head3 EXTENDED GLOB PATTERNS	779	=head3 EXTENDED GLOB PATTERNS
583		780
…		…
597	=item Patterns not starting with F</> will be anchored at the end of the path.	794	=item Patterns not starting with F</> will be anchored at the end of the path.
598		795
599	That is, F<idna.pl> will match any file called F<idna.pl> anywhere in the	796	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.	797	hierarchy, but not any directories of the same name.
601		798
602	=item A F<*> matches any single component.	799	=item A F<*> matches anything within a single path component.
603		800
604	That is, F</unicore/*.pl> would match all F<.pl> files directly inside	801	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<*>	802	C</unicore>, not any deeper level F<.pl> files. Or in other words, F<*>
606	will not match slashes.	803	will not match slashes.
607		804
…		…
682	installation, you can set any environment variable you want - some modules	879	installation, you can set any environment variable you want - some modules
683	(such as L<Coro> or L<EV>) use environment variables for further tweaking.	880	(such as L<Coro> or L<EV>) use environment variables for further tweaking.
684		881
685	=item C<PERL_VERSION>	882	=item C<PERL_VERSION>
686		883
687	The perl version to install - default is currently C<5.12.2>, but C<5.8.9>	884	The perl version to install - default is currently C<5.12.3>, but C<5.8.9>
688	is also a good choice (5.8.9 is much smaller than 5.12.2, while 5.10.1 is	885	is also a good choice (5.8.9 is much smaller than 5.12.3, while 5.10.1 is
689	about as big as 5.12.2).	886	about as big as 5.12.3).
690		887
691	=item C<PERL_PREFIX>	888	=item C<PERL_PREFIX>
692		889
693	The prefix where perl gets installed (default: F<$STATICPERL/perl>),	890	The prefix where perl gets installed (default: F<$STATICPERL/perl>),
694	i.e. where the F<bin> and F<lib> subdirectories will end up.	891	i.e. where the F<bin> and F<lib> subdirectories will end up.
…		…
703		900
704	More commonly, you would either activate 64 bit integer support	901	More commonly, you would either activate 64 bit integer support
705	(C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to	902	(C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to
706	reduce filesize further.	903	reduce filesize further.
707		904
708	=item C<PERL_CPPFLAGS>, C<PERL_OPTIMIZE>, C<PERL_LDFLAGS>, C<PERL_LIBS>	905	=item C<PERL_CC>, C<PERL_CCFLAGS>, C<PERL_OPTIMIZE>, C<PERL_LDFLAGS>, C<PERL_LIBS>
709		906
710	These flags are passed to perl's F<Configure> script, and are generally	907	These flags are passed to perl's F<Configure> script, and are generally
711	optimised for small size (at the cost of performance). Since they also	908	optimised for small size (at the cost of performance). Since they also
712	contain subtle workarounds around various build issues, changing these	909	contain subtle workarounds around various build issues, changing these
713	usually requires understanding their default values - best look at the top	910	usually requires understanding their default values - best look at
714	of the F<staticperl> script for more info on these.	911	the top of the F<staticperl> script for more info on these, and use a
		912	F<~/.staticperlrc> to override them.
		913
		914	Most of the variables override (or modify) the corresponding F<Configure>
		915	variable, except C<PERL_CCFLAGS>, which gets appended.
715		916
716	=back	917	=back
717		918
718	=head4 Variables you probably I<do not want> to override	919	=head4 Variables you probably I<do not want> to override
719		920
720	=over 4	921	=over 4
		922
		923	=item C<MAKE>
		924
		925	The make command to use - default is C<make>.
721		926
722	=item C<MKBUNDLE>	927	=item C<MKBUNDLE>
723		928
724	Where F<staticperl> writes the C<mkbundle> command to	929	Where F<staticperl> writes the C<mkbundle> command to
725	(default: F<$STATICPERL/mkbundle>).	930	(default: F<$STATICPERL/mkbundle>).
…		…
810	A header file that contains the prototypes of the few symbols "exported"	1015	A header file that contains the prototypes of the few symbols "exported"
811	by bundle.c, and also exposes the perl headers to the application.	1016	by bundle.c, and also exposes the perl headers to the application.
812		1017
813	=over 4	1018	=over 4
814		1019
815	=item staticperl_init ()	1020	=item staticperl_init (xs_init = 0)
816		1021
817	Initialises the perl interpreter. You can use the normal perl functions	1022	Initialises the perl interpreter. You can use the normal perl functions
818	after calling this function, for example, to define extra functions or	1023	after calling this function, for example, to define extra functions or
819	to load a .pm file that contains some initialisation code, or the main	1024	to load a .pm file that contains some initialisation code, or the main
820	program function:	1025	program function:
…		…
827	}	1032	}
828		1033
829	static void	1034	static void
830	run_myapp(void)	1035	run_myapp(void)
831	{	1036	{
832	staticperl_init ();	1037	staticperl_init (0);
833	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");	1038	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");
834	eval_pv ("require myapp::main", 1); // executes "myapp/main.pm"	1039	eval_pv ("require myapp::main", 1); // executes "myapp/main.pm"
835	}	1040	}
836		1041
		1042	When your bootcode already wants to access some XS functions at
		1043	compiletime, then you need to supply an C<xs_init> function pointer that
		1044	is called as soon as perl is initialised enough to define XS functions,
		1045	but before the preamble code is executed:
		1046
		1047	static void
		1048	xs_init (pTHX)
		1049	{
		1050	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");
		1051	}
		1052
		1053	static void
		1054	run_myapp(void)
		1055	{
		1056	staticperl_init (xs_init);
		1057	}
		1058
		1059	=item staticperl_cleanup ()
		1060
		1061	In the unlikely case that you want to destroy the perl interpreter, here
		1062	is the corresponding function.
		1063
837	=item staticperl_xs_init (pTHX)	1064	=item staticperl_xs_init (pTHX)
838		1065
839	Sometimes you need direct control over C<perl_parse> and C<perl_run>, in	1066	Sometimes you need direct control over C<perl_parse> and C<perl_run>, in
840	which case you do not want to use C<staticperl_init> but call them on your	1067	which case you do not want to use C<staticperl_init> but call them on your
841	own.	1068	own.
842		1069
843	Then you need this function - either pass it directly as the C<xs_init>	1070	Then you need this function - either pass it directly as the C<xs_init>
844	function to C<perl_parse>, or call it from your own C<xs_init> function.	1071	function to C<perl_parse>, or call it as one of the first things from your
845		1072	own C<xs_init> function.
846	=item staticperl_cleanup ()
847
848	In the unlikely case that you want to destroy the perl interpreter, here
849	is the corresponding function.
850		1073
851	=item PerlInterpreter *staticperl	1074	=item PerlInterpreter *staticperl
852		1075
853	The perl interpreter pointer used by staticperl. Not normally so useful,	1076	The perl interpreter pointer used by staticperl. Not normally so useful,
854	but there it is.	1077	but there it is.
…		…
890		1113
891	Returns the list of all paths embedded in this binary.	1114	Returns the list of all paths embedded in this binary.
892		1115
893	=back	1116	=back
894		1117
895	=head1 FULLY STATIC BINARIES - BUILDROOT	1118	=head1 FULLY STATIC BINARIES - UCLIBC AND BUILDROOT
896		1119
897	To make truly static (Linux-) libraries, you might want to have a look at	1120	To make truly static (Linux-) libraries, you might want to have a look at
898	buildroot (L<http://buildroot.uclibc.org/>).	1121	buildroot (L<http://buildroot.uclibc.org/>).
899		1122
900	Buildroot is primarily meant to set up a cross-compile environment (which	1123	Buildroot is primarily meant to set up a cross-compile environment (which
…		…
961		1184
962	Some functionality in the utf8 module, such as swash handling (used	1185	Some functionality in the utf8 module, such as swash handling (used
963	for unicode character ranges in regexes) is implemented in the	1186	for unicode character ranges in regexes) is implemented in the
964	C<"utf8_heavy.pl"> library:	1187	C<"utf8_heavy.pl"> library:
965		1188
966	-M'"utf8_heavy.pl"'	1189	-Mutf8_heavy.pl
967		1190
968	Many Unicode properties in turn are defined in separate modules,	1191	Many Unicode properties in turn are defined in separate modules,
969	such as C<"unicore/Heavy.pl"> and more specific data tables such as	1192	such as C<"unicore/Heavy.pl"> and more specific data tables such as
970	C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables	1193	C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables
971	are big (7MB uncompressed, although F<staticperl> contains special	1194	are big (7MB uncompressed, although F<staticperl> contains special
972	handling for those files), so including them on demand by your application	1195	handling for those files), so including them on demand by your application
973	only might pay off.	1196	only might pay off.
974		1197
975	To simply include the whole unicode database, use:	1198	To simply include the whole unicode database, use:
976		1199
977	--incglob '/unicore/*.pl'	1200	--incglob '/unicore/**.pl'
978		1201
979	=item AnyEvent	1202	=item AnyEvent
980		1203
981	AnyEvent needs a backend implementation that it will load in a delayed	1204	AnyEvent needs a backend implementation that it will load in a delayed
982	fashion. The L<AnyEvent::Impl::Perl> backend is the default choice	1205	fashion. The L<AnyEvent::Impl::Perl> backend is the default choice
…		…
987		1210
988	If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn	1211	If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn
989	functions), you also need to include C<"AnyEvent/Util/idna.pl"> and	1212	functions), you also need to include C<"AnyEvent/Util/idna.pl"> and
990	C<"AnyEvent/Util/uts46data.pl">.	1213	C<"AnyEvent/Util/uts46data.pl">.
991		1214
992	Or you can use C<--usepacklist> and specify C<-MAnyEvent> to include	1215	Or you can use C<--usepacklists> and specify C<-MAnyEvent> to include
993	everything.	1216	everything.
994		1217
995	=item Carp	1218	=item Carp
996		1219
997	Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of	1220	Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of
…		…
1003	turn might need L<"Config_heavy.pl">. Including the latter gives you	1226	turn might need L<"Config_heavy.pl">. Including the latter gives you
1004	both.	1227	both.
1005		1228
1006	=item Term::ReadLine::Perl	1229	=item Term::ReadLine::Perl
1007		1230
1008	Also needs L<Term::ReadLine::readline>, or C<--usepacklist>.	1231	Also needs L<Term::ReadLine::readline>, or C<--usepacklists>.
1009		1232
1010	=item URI	1233	=item URI
1011		1234
1012	URI implements schemes as separate modules - the generic URL scheme is	1235	URI implements schemes as separate modules - the generic URL scheme is
1013	implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If	1236	implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If
1014	you need to use any of these schemes, you should include these manually,	1237	you need to use any of these schemes, you should include these manually,
1015	or use C<--usepacklist>.	1238	or use C<--usepacklists>.
1016		1239
1017	=back	1240	=back
1018		1241
1019	=head2 RECIPES	1242	=head2 RECIPES
1020		1243
1021	=over 4	1244	=over 4
1022		1245
1023	=item Linking everything in	1246	=item Just link everything in
1024		1247
1025	To link just about everything installed in the perl library into a new	1248	To link just about everything installed in the perl library into a new
1026	perl, try this:	1249	perl, try this (the first time this runs it will take a long time, as a
		1250	lot of files need to be parsed):
1027		1251
1028	staticperl mkperl --strip ppi --incglob '*'	1252	staticperl mkperl -v --strip ppi --incglob '*'
1029		1253
		1254	If you don't mind the extra megabytes, this can be a very effective way of
		1255	creating bundles without having to worry about forgetting any modules.
		1256
		1257	You get even more useful variants of this method by first selecting
		1258	everything, and then excluding stuff you are reasonable sure not to need -
		1259	L<bigperl\|http://staticperl.schmorp.de/bigperl.html> uses this approach.
		1260
1030	=item Getting rid of netdb function	1261	=item Getting rid of netdb functions
1031		1262
1032	The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent>	1263	The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent>
1033	and so on) that few applications use. You can avoid compiling them in by	1264	and so on) that few applications use. You can avoid compiling them in by
1034	putting the following fragment into a C<preconfigure> hook:	1265	putting the following fragment into a C<preconfigure> hook:
1035		1266
…		…
1052	do	1283	do
1053	PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"	1284	PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"
1054	done	1285	done
1055	}	1286	}
1056		1287
1057	This mostly gains space when linking staticaly, as the functions will	1288	This mostly gains space when linking statically, as the functions will
1058	likely not be linked in. The gain for dynamically-linked binaries is	1289	likely not be linked in. The gain for dynamically-linked binaries is
1059	smaller.	1290	smaller.
1060		1291
1061	Also, this leaves C<gethostbyname> in - not only is it actually used	1292	Also, this leaves C<gethostbyname> in - not only is it actually used
1062	often, the L<Socket> module also exposes it, so leaving it out usually	1293	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.21 by root, Sat Dec 11 23:28:22 2010 UTC vs. Revision 1.37 by root, Thu Feb 24 07:01:46 2011 UTC

Diff Legend

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.21 by root, Sat Dec 11 23:28:22 2010 UTC vs.
Revision 1.37 by root, Thu Feb 24 07:01:46 2011 UTC