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

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.18 by root, Fri Dec 10 02:35:54 2010 UTC vs.
Revision 1.36 by root, Fri Feb 11 01:05:37 2011 UTC

…		…
40		40
41	With F<uClibc> and F<upx> on x86, you can create a single 500kb binary	41	With F<uClibc> and F<upx> on x86, you can create a single 500kb binary
42	that contains perl and 100 modules such as POSIX, AnyEvent, EV, IO::AIO,	42	that contains perl and 100 modules such as POSIX, AnyEvent, EV, IO::AIO,
43	Coro and so on. Or any other choice of modules.	43	Coro and so on. Or any other choice of modules.
44		44
		45	To see how this turns out, you can try out smallperl and bigperl, two
		46	pre-built static and compressed perl binaries with many and even more
		47	modules: just follow the links at L<http://staticperl.schmorp.de/>.
		48
45	The created files do not need write access to the file system (like PAR	49	The created files do not need write access to the file system (like PAR
46	does). In fact, since this script is in many ways similar to PAR::Packer,	50	does). In fact, since this script is in many ways similar to PAR::Packer,
47	here are the differences:	51	here are the differences:
48		52
49	=over 4	53	=over 4
…		…
118	often as necessary.	122	often as necessary.
119		123
120	=head1 THE F<STATICPERL> SCRIPT	124	=head1 THE F<STATICPERL> SCRIPT
121		125
122	This module installs a script called F<staticperl> into your perl	126	This module installs a script called F<staticperl> into your perl
123	binary directory. The script is fully self-contained, and can be used	127	binary directory. The script is fully self-contained, and can be
124	without perl (for example, in an uClibc chroot environment). In fact,	128	used without perl (for example, in an uClibc chroot environment). In
125	it can be extracted from the C<App::Staticperl> distribution tarball as	129	fact, it can be extracted from the C<App::Staticperl> distribution
126	F<bin/staticperl>, without any installation.	130	tarball as F<bin/staticperl>, without any installation. The
		131	newest (possibly alpha) version can also be downloaded from
		132	L<http://staticperl.schmorp.de/staticperl>.
127		133
128	F<staticperl> interprets the first argument as a command to execute,	134	F<staticperl> interprets the first argument as a command to execute,
129	optionally followed by any parameters.	135	optionally followed by any parameters.
130		136
131	There are two command categories: the "phase 1" commands which deal with	137	There are two command categories: the "phase 1" commands which deal with
…		…
133	with creating binaries and bundle files.	139	with creating binaries and bundle files.
134		140
135	=head2 PHASE 1 COMMANDS: INSTALLING PERL	141	=head2 PHASE 1 COMMANDS: INSTALLING PERL
136		142
137	The most important command is F<install>, which does basically	143	The most important command is F<install>, which does basically
138	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
139	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
140	changed - see L<CONFIGURATION>, below.	146	changed - see L<CONFIGURATION>, below.
141		147
142	The command	148	The command
143		149
144	staticperl install	150	staticperl install
145		151
146	Is normally all you need: It installs the perl interpreter in	152	is normally all you need: It installs the perl interpreter in
147	F<~/.staticperl/perl>. It downloads, configures, builds and installs the	153	F<~/.staticperl/perl>. It downloads, configures, builds and installs the
148	perl interpreter if required.	154	perl interpreter if required.
149		155
150	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
151	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.
152		163
153	To force recompilation or reinstallation, you need to run F<staticperl	164	To force recompilation or reinstallation, you need to run F<staticperl
154	distclean> first.	165	distclean> first.
155		166
156	=over 4	167	=over 4
		168
		169	=item F<staticperl version>
		170
		171	Prints some info about the version of the F<staticperl> script you are using.
157		172
158	=item F<staticperl fetch>	173	=item F<staticperl fetch>
159		174
160	Runs only the download and unpack phase, unless this has already happened.	175	Runs only the download and unpack phase, unless this has already happened.
161		176
…		…
199		214
200	=item F<staticperl clean>	215	=item F<staticperl clean>
201		216
202	Deletes the perl source directory (and potentially cleans up other	217	Deletes the perl source directory (and potentially cleans up other
203	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
204	building perl, without removing the installed perl interpreter, or to	219	building perl, without removing the installed perl interpreter.
205	force a re-build from scratch.
206		220
207	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.
208		224
209	=item F<staticperl distclean>	225	=item F<staticperl distclean>
210		226
211	This wipes your complete F<~/.staticperl> directory. Be careful with this,	227	This wipes your complete F<~/.staticperl> directory. Be careful with this,
212	it nukes your perl download, perl sources, perl distribution and any	228	it nukes your perl download, perl sources, perl distribution and any
…		…
262	-MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI::http	278	-MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI::http
263		279
264	# run it	280	# run it
265	./app	281	./app
266		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
267	=head3 OPTION PROCESSING	314	=head3 OPTION PROCESSING
268		315
269	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
270	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
271	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
272	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"
273	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.
274		322
275	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:
276		325
277	staticperl mkperl httpd.bundle	326	staticperl mkperl httpd.bundle
278		327
279	And all options could be in F<httpd.bundle>:	328	With all options stored in the F<httpd.bundle> file (one option per line,
280		329	everything after the option is an argument):
		330
281	use "Config_heavy.pl"	331	use "Config_heavy.pl"
282	use AnyEvent::Impl::Perl	332	use AnyEvent::Impl::Perl
283	use AnyEvent::HTTPD	333	use AnyEvent::HTTPD
284	use URI::http	334	use URI::http
285	add eg/httpd httpd.pm	335	add eg/httpd httpd.pm
286		336
287	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
288	order given on the command line (that affects the C<--use> and C<--eval>	338	order given on the command line.
289	options at the moment).
290		339
291	=head3 MKBUNDLE OPTIONS	340	=head3 BUNDLE CREATION WORKFLOW / STATICPELR MKBUNDLE OPTIONS
292		341
293	=over 4	342	F<staticperl mkbundle> works by first assembling a list of candidate
		343	files and modules to include, then filtering them by include/exclude
		344	patterns. The remaining modules (together with their direct dependencies,
		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.
294		348
		349	=over 4
		350
		351	=item Step 0: Generic argument processing.
		352
		353	The following options influence F<staticperl mkbundle> itself.
		354
		355	=over 4
		356
295	=item --verbose \| -v	357	=item C<--verbose> \| C<-v>
296		358
297	Increases the verbosity level by one (the default is C<1>).	359	Increases the verbosity level by one (the default is C<1>).
298		360
299	=item --quiet \| -q	361	=item C<--quiet> \| C<-q>
300		362
301	Decreases the verbosity level by one.	363	Decreases the verbosity level by one.
302		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
303	=item --strip none\|pod\|ppi	627	=item C<--strip> C<none>\|C<pod>\|C<ppi>
304		628
305	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
306	sources included.	630	sources included.
307		631
308	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
…		…
319	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,
320	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
321	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
322	any way.	646	any way.
323		647
324	=item --perl	648	=item C<--perl>
325		649
326	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
327	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
328	directory. The bundle files will be removed.	652	directory. The bundle files will be removed.
329		653
330	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
331	C<mkperl> command (instead of C<mkbundle>):	655	C<mkperl> command instead of C<mkbundle>.
332		656
333	# 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
334	staticperl mkperl -Mcommon::sense	661	staticperl mkperl -Mcommon::sense
335		662
336	=item --app name	663	=item C<--app> F<name>
337		664
338	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
339	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
340	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>.
341		671
342	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
343	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 -
344	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
345	exit.	675	exit.
346		676
347	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
348	C<mkapp> command (instead of C<mkbundle>):
349
350	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
351	the C<--boot> option.	679	the C<--boot> option.
352		680
353	Example: create a standalone perl binary that will execute F<appfile> when	681	Example: create a standalone perl binary called F<./myexe> that will
354	it is started.	682	execute F<appfile> when it is started.
355		683
356	staticperl mkbundle --app myexe --boot appfile	684	staticperl mkbundle --app myexe --boot appfile
357		685
358	=item --use module \| -Mmodule
359
360	Include the named module and all direct dependencies. This is done by
361	C<require>'ing the module in a subprocess and tracing which other modules
362	and files it actually loads. If the module uses L<AutoLoader>, then all
363	splitfiles will be included as well.
364
365	Example: include AnyEvent and AnyEvent::Impl::Perl.
366
367	staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl
368
369	Sometimes you want to load old-style "perl libraries" (F<.pl> files), or
370	maybe other weirdly named files. To do that, you need to quote the name in
371	single or double quotes. When given on the command line, you probably need
372	to quote once more to avoid your shell interpreting it. Common cases that
373	need this are F<Config_heavy.pl> and F<utf8_heavy.pl>.
374
375	Example: include the required files for F<perl -V> to work in all its
376	glory (F<Config.pm> is included automatically by this).
377
378	# bourne shell
379	staticperl mkbundle --use '"Config_heavy.pl"'
380
381	# bundle specification file
382	use "Config_heavy.pl"
383
384	The C<-Mmodule> syntax is included as an alias that might be easier to
385	remember than C<use>. Or maybe it confuses people. Time will tell. Or
386	maybe not. Argh.
387
388	=item --eval "perl code" \| -e "perl code"
389
390	Sometimes it is easier (or necessary) to specify dependencies using perl
391	code, or maybe one of the modules you use need a special use statement. In
392	that case, you can use C<eval> to execute some perl snippet or set some
393	variables or whatever you need. All files C<require>'d or C<use>'d in the
394	script are included in the final bundle.
395
396	Keep in mind that F<mkbundle> will only C<require> the modules named
397	by the C<--use> option, so do not expect the symbols from modules you
398	C<--use>'d earlier on the command line to be available.
399
400	Example: force L<AnyEvent> to detect a backend and therefore include it
401	in the final bundle.
402
403	staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect'
404
405	# or like this
406	staticperl mkbundle -MAnyEvent --eval 'use AnyEvent; AnyEvent::detect'
407
408	Example: use a separate "bootstrap" script that C<use>'s lots of modules
409	and include this in the final bundle, to be executed automatically.
410
411	staticperl mkbundle --eval 'do "bootstrap"' --boot bootstrap
412
413	=item --boot filename
414
415	Include the given file in the bundle and arrange for it to be executed
416	(using a C<require>) before anything else when the new perl is
417	initialised. This can be used to modify C<@INC> or anything else before
418	the perl interpreter executes scripts given on the command line (or via
419	C<-e>). This works even in an embedded interpreter.
420
421	=item --incglob pattern
422
423	This goes through all library directories and tries to match any F<.pm>
424	and F<.pl> files against the extended glob pattern (see below). If a file
425	matches, it is added. This switch will automatically detect L<AutoLoader>
426	files and the required link libraries for XS modules, but it will I<not>
427	scan the file for dependencies (at the moment).
428
429	This is mainly useful to include "everything":
430
431	--incglob '*'
432
433	Or to include perl libraries, or trees of those, such as the unicode
434	database files needed by many other modules:
435
436	--incglob '/unicore/**.pl'
437
438	=item --add file \| --add "file alias"
439
440	Adds the given (perl) file into the bundle (and optionally call it
441	"alias"). This is useful to include any custom files into the bundle.
442
443	Example: embed the file F<httpd> as F<httpd.pm> when creating the bundle.
444
445	staticperl mkperl --add "httpd httpd.pm"
446
447	It is also a great way to add any custom modules:
448
449	# specification file
450	add file1 myfiles/file1
451	add file2 myfiles/file2
452	add file3 myfiles/file3
453
454	=item --binadd file \| --add "file alias"
455
456	Just like C<--add>, except that it treats the file as binary and adds it
457	without any processing.
458
459	You should probably add a C</> prefix to avoid clashing with embedded
460	perl files (whose paths do not start with C</>), and/or use a special
461	directory, such as C</res/name>.
462
463	You can later get a copy of these files by calling C<staticperl::find
464	"alias">.
465
466	=item --include pattern \| -i pattern \| --exclude pattern \| -x pattern
467
468	These two options define an include/exclude filter that is used after all
469	files selected by the other options have been found. Each include/exclude
470	is applied to all files found so far - an include makes sure that the
471	given files will be part of the resulting file set, an exclude will
472	exclude files. The patterns are "extended glob patterns" (see below).
473
474	For example, to include everything, except C<Devel> modules, but still
475	include F<Devel::PPPort>, you could use this:
476
477	--incglob '' -i '/Devel/PPPort.pm' -x '/Devel/*'
478
479	=item --static	686	=item C<--static>
480		687
481	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
482	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
483	perl modules are linked statically, but all external libraries are still	694	modules are linked statically, but all external libraries are still
484	referenced dynamically).	695	referenced dynamically).
485		696
486	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
487	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
488	either. Try uClibc if you want to create fully statically linked	699	fashion either. Try uClibc if you want to create fully statically linked
489	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
490	statically.	701	statically.
491		702
492	=item --staticlib libname	703	=item C<--staticlib> libname
493		704
494	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
495	libraries statically. What it does is simply replace all occurances of	706	libraries statically. What it does is simply replace all occurrences of
496	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>
497	option.	708	option.
498		709
499	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,
500	specifically, C<--staticlib> will not link against the named library	711	specifically, C<--staticlib> will not link against the named library
501	unless it would be linked against anyway.	712	unless it would be linked against anyway.
502		713
503	Example: link libcrypt statically into the binary.	714	Example: link libcrypt statically into the final binary.
504		715
505	staticperl mkperl -MIO::AIO --staticlib crypt	716	staticperl mkperl -MIO::AIO --staticlib crypt
506		717
507	# ldopts might nwo contain:	718	# ldopts might now contain:
508	# -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread	719	# -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread
509		720
510	=item any other argument	721	=back
511
512	Any other argument is interpreted as a bundle specification file, which
513	supports most long options (without extra quoting), one option per line.
514		722
515	=back	723	=back
516		724
517	=head3 EXTENDED GLOB PATTERNS	725	=head3 EXTENDED GLOB PATTERNS
518		726
…		…
532	=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.
533		741
534	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
535	hierarchy, but not any directories of the same name.	743	hierarchy, but not any directories of the same name.
536		744
537	=item A F<*> matches any single component.	745	=item A F<*> matches anything within a single path component.
538		746
539	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
540	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<*>
541	will not match slashes.	749	will not match slashes.
542		750
…		…
552		760
553	=back	761	=back
554		762
555	=head2 F<STATICPERL> CONFIGURATION AND HOOKS	763	=head2 F<STATICPERL> CONFIGURATION AND HOOKS
556		764
557	During (each) startup, F<staticperl> tries to source the following shell	765	During (each) startup, F<staticperl> tries to source some shell files to
		766	allow you to fine-tune/override configuration settings.
		767
		768	In them you can override shell variables, or define shell functions
		769	("hooks") to be called at specific phases during installation. For
		770	example, you could define a C<postinstall> hook to install additional
		771	modules from CPAN each time you start from scratch.
		772
		773	If the env variable C<$STATICPERLRC> is set, then F<staticperl> will try
		774	to source the file named with it only. Otherwise, it tries the following
558	files in order:	775	shell files in order:
559		776
560	/etc/staticperlrc	777	/etc/staticperlrc
561	~/.staticperlrc	778	~/.staticperlrc
562	$STATICPERL/rc	779	$STATICPERL/rc
563		780
564	They can be used to override shell variables, or define functions to be
565	called at specific phases.
566
567	Note that the last file is erased during F<staticperl distclean>, so	781	Note that the last file is erased during F<staticperl distclean>, so
568	generally should not be used.	782	generally should not be used.
569		783
570	=head3 CONFIGURATION VARIABLES	784	=head3 CONFIGURATION VARIABLES
571		785
…		…
611	installation, you can set any environment variable you want - some modules	825	installation, you can set any environment variable you want - some modules
612	(such as L<Coro> or L<EV>) use environment variables for further tweaking.	826	(such as L<Coro> or L<EV>) use environment variables for further tweaking.
613		827
614	=item C<PERL_VERSION>	828	=item C<PERL_VERSION>
615		829
616	The perl version to install - default is currently C<5.12.2>, but C<5.8.9>	830	The perl version to install - default is currently C<5.12.3>, but C<5.8.9>
617	is also a good choice (5.8.9 is much smaller than 5.12.2, while 5.10.1 is	831	is also a good choice (5.8.9 is much smaller than 5.12.3, while 5.10.1 is
618	about as big as 5.12.2).	832	about as big as 5.12.3).
619		833
620	=item C<PERL_PREFIX>	834	=item C<PERL_PREFIX>
621		835
622	The prefix where perl gets installed (default: F<$STATICPERL/perl>),	836	The prefix where perl gets installed (default: F<$STATICPERL/perl>),
623	i.e. where the F<bin> and F<lib> subdirectories will end up.	837	i.e. where the F<bin> and F<lib> subdirectories will end up.
…		…
632		846
633	More commonly, you would either activate 64 bit integer support	847	More commonly, you would either activate 64 bit integer support
634	(C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to	848	(C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to
635	reduce filesize further.	849	reduce filesize further.
636		850
637	=item 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>
638		852
639	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
640	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
641	contain subtle workarounds around various build issues, changing these	855	contain subtle workarounds around various build issues, changing these
642	usually requires understanding their default values - best look at the top	856	usually requires understanding their default values - best look at
643	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.
644		862
645	=back	863	=back
646		864
647	=head4 Variables you probably I<do not want> to override	865	=head4 Variables you probably I<do not want> to override
648		866
649	=over 4	867	=over 4
		868
		869	=item C<MAKE>
		870
		871	The make command to use - default is C<make>.
650		872
651	=item C<MKBUNDLE>	873	=item C<MKBUNDLE>
652		874
653	Where F<staticperl> writes the C<mkbundle> command to	875	Where F<staticperl> writes the C<mkbundle> command to
654	(default: F<$STATICPERL/mkbundle>).	876	(default: F<$STATICPERL/mkbundle>).
…		…
739	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"
740	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.
741		963
742	=over 4	964	=over 4
743		965
744	=item staticperl_init ()	966	=item staticperl_init (xs_init = 0)
745		967
746	Initialises the perl interpreter. You can use the normal perl functions	968	Initialises the perl interpreter. You can use the normal perl functions
747	after calling this function, for example, to define extra functions or	969	after calling this function, for example, to define extra functions or
748	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
749	program function:	971	program function:
…		…
756	}	978	}
757		979
758	static void	980	static void
759	run_myapp(void)	981	run_myapp(void)
760	{	982	{
761	staticperl_init ();	983	staticperl_init (0);
762	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");	984	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");
763	eval_pv ("require myapp::main", 1); // executes "myapp/main.pm"	985	eval_pv ("require myapp::main", 1); // executes "myapp/main.pm"
764	}	986	}
765		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
766	=item staticperl_xs_init (pTHX)	1010	=item staticperl_xs_init (pTHX)
767		1011
768	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
769	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
770	own.	1014	own.
771		1015
772	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>
773	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
774		1018	own C<xs_init> function.
775	=item staticperl_cleanup ()
776
777	In the unlikely case that you want to destroy the perl interpreter, here
778	is the corresponding function.
779		1019
780	=item PerlInterpreter *staticperl	1020	=item PerlInterpreter *staticperl
781		1021
782	The perl interpreter pointer used by staticperl. Not normally so useful,	1022	The perl interpreter pointer used by staticperl. Not normally so useful,
783	but there it is.	1023	but there it is.
…		…
819		1059
820	Returns the list of all paths embedded in this binary.	1060	Returns the list of all paths embedded in this binary.
821		1061
822	=back	1062	=back
823		1063
824	=head1 FULLY STATIC BINARIES - BUILDROOT	1064	=head1 FULLY STATIC BINARIES - UCLIBC AND BUILDROOT
825		1065
826	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
827	buildroot (L<http://buildroot.uclibc.org/>).	1067	buildroot (L<http://buildroot.uclibc.org/>).
828		1068
829	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
…		…
901	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
902	only might pay off.	1142	only might pay off.
903		1143
904	To simply include the whole unicode database, use:	1144	To simply include the whole unicode database, use:
905		1145
906	--incglob '/unicore/*.pl'	1146	--incglob '/unicore/**.pl'
907		1147
908	=item AnyEvent	1148	=item AnyEvent
909		1149
910	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
911	fashion. The L<AnyEvent::Impl::Perl> backend is the default choice	1151	fashion. The L<AnyEvent::Impl::Perl> backend is the default choice
…		…
916		1156
917	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
918	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
919	C<"AnyEvent/Util/uts46data.pl">.	1159	C<"AnyEvent/Util/uts46data.pl">.
920		1160
		1161	Or you can use C<--usepacklists> and specify C<-MAnyEvent> to include
		1162	everything.
		1163
921	=item Carp	1164	=item Carp
922		1165
923	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
924	perl 5.12.2 (maybe earlier), this dependency no longer exists.	1167	perl 5.12.2 (maybe earlier), this dependency no longer exists.
925		1168
…		…
929	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
930	both.	1173	both.
931		1174
932	=item Term::ReadLine::Perl	1175	=item Term::ReadLine::Perl
933		1176
934	Also needs L<Term::ReadLine::readline>.	1177	Also needs L<Term::ReadLine::readline>, or C<--usepacklists>.
935		1178
936	=item URI	1179	=item URI
937		1180
938	URI implements schemes as separate modules - the generic URL scheme is	1181	URI implements schemes as separate modules - the generic URL scheme is
939	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
940	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,
		1184	or use C<--usepacklists>.
941		1185
942	=back	1186	=back
943		1187
944	=head2 RECIPES	1188	=head2 RECIPES
945		1189
946	=over 4	1190	=over 4
947		1191
948	=item Linking everything in	1192	=item Just link everything in
949		1193
950	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
951	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):
952		1197
953	staticperl mkperl --strip ppi --incglob '*'	1198	staticperl mkperl -v --strip ppi --incglob '*'
954		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
955	=item Getting rid of netdb function	1207	=item Getting rid of netdb functions
956		1208
957	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>
958	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
959	putting the following fragment into a C<preconfigure> hook:	1211	putting the following fragment into a C<preconfigure> hook:
960		1212
…		…
977	do	1229	do
978	PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"	1230	PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"
979	done	1231	done
980	}	1232	}
981		1233
982	This mostly gains space when linking staticaly, as the functions will	1234	This mostly gains space when linking statically, as the functions will
983	liekly not be linked in. The gain for dynamically-linked binaries is	1235	likely not be linked in. The gain for dynamically-linked binaries is
984	smaller.	1236	smaller.
985		1237
986	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
987	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
988	gains little. Why Socket exposes a C function that is in the core already	1240	gains little. Why Socket exposes a C function that is in the core already

Diff Legend

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

Comparing App-Staticperl/staticperl.pod (file contents): Revision 1.18 by root, Fri Dec 10 02:35:54 2010 UTC vs. Revision 1.36 by root, Fri Feb 11 01:05:37 2011 UTC

Diff Legend

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.18 by root, Fri Dec 10 02:35:54 2010 UTC vs.
Revision 1.36 by root, Fri Feb 11 01:05:37 2011 UTC