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

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.20 by root, Fri Dec 10 20:29:17 2010 UTC vs.
Revision 1.28 by root, Tue Dec 21 19:44:43 2010 UTC

…		…
122	often as necessary.	122	often as necessary.
123		123
124	=head1 THE F<STATICPERL> SCRIPT	124	=head1 THE F<STATICPERL> SCRIPT
125		125
126	This module installs a script called F<staticperl> into your perl	126	This module installs a script called F<staticperl> into your perl
127	binary directory. The script is fully self-contained, and can be used	127	binary directory. The script is fully self-contained, and can be
128	without perl (for example, in an uClibc chroot environment). In fact,	128	used without perl (for example, in an uClibc chroot environment). In
129	it can be extracted from the C<App::Staticperl> distribution tarball as	129	fact, it can be extracted from the C<App::Staticperl> distribution
130	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>.
131		133
132	F<staticperl> interprets the first argument as a command to execute,	134	F<staticperl> interprets the first argument as a command to execute,
133	optionally followed by any parameters.	135	optionally followed by any parameters.
134		136
135	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
…		…
145		147
146	The command	148	The command
147		149
148	staticperl install	150	staticperl install
149		151
150	Is normally all you need: It installs the perl interpreter in	152	is normally all you need: It installs the perl interpreter in
151	F<~/.staticperl/perl>. It downloads, configures, builds and installs the	153	F<~/.staticperl/perl>. It downloads, configures, builds and installs the
152	perl interpreter if required.	154	perl interpreter if required.
153		155
154	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
155	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.
156		163
157	To force recompilation or reinstallation, you need to run F<staticperl	164	To force recompilation or reinstallation, you need to run F<staticperl
158	distclean> first.	165	distclean> first.
159		166
160	=over 4	167	=over 4
…		…
207		214
208	=item F<staticperl clean>	215	=item F<staticperl clean>
209		216
210	Deletes the perl source directory (and potentially cleans up other	217	Deletes the perl source directory (and potentially cleans up other
211	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
212	building perl, without removing the installed perl interpreter, or to	219	building perl, without removing the installed perl interpreter.
213	force a re-build from scratch.
214		220
215	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.
216		224
217	=item F<staticperl distclean>	225	=item F<staticperl distclean>
218		226
219	This wipes your complete F<~/.staticperl> directory. Be careful with this,	227	This wipes your complete F<~/.staticperl> directory. Be careful with this,
220	it nukes your perl download, perl sources, perl distribution and any	228	it nukes your perl download, perl sources, perl distribution and any
…		…
270	-MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI::http	278	-MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI::http
271		279
272	# run it	280	# run it
273	./app	281	./app
274		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
275	=head3 OPTION PROCESSING	314	=head3 OPTION PROCESSING
276		315
277	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
278	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
279	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
280	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"
281	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.
282		322
283	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:
284		325
285	staticperl mkperl httpd.bundle	326	staticperl mkperl httpd.bundle
286		327
287	And all options could be in F<httpd.bundle>:	328	With all options stored in the F<httpd.bundle> file (one option per line,
288		329	everything after the option is an argument):
		330
289	use "Config_heavy.pl"	331	use "Config_heavy.pl"
290	use AnyEvent::Impl::Perl	332	use AnyEvent::Impl::Perl
291	use AnyEvent::HTTPD	333	use AnyEvent::HTTPD
292	use URI::http	334	use URI::http
293	add eg/httpd httpd.pm	335	add eg/httpd httpd.pm
294		336
295	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
296	order given on the command line (that affects the C<--use> and C<--eval>	338	order given on the command line.
297	options at the moment).
298		339
299	=head3 PACKAGE SELECTION WORKFLOW	340	=head3 BUNDLE CREATION WORKFLOW / STATICPELR MKBUNDLE OPTIONS
300		341
301	F<staticperl mkbundle> has a number of options to control package	342	F<staticperl mkbundle> works by first assembling a list of candidate
302	selection. This section describes how they interact with each other. Also,	343	files and modules to include, then filtering them by include/exclude
303	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,
304	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.
305		348
306	The idiom "in order" means "in order that they are specified on the
307	commandline". If you use a bundle specification file, then the options
308	will be processed as if they were given in place of the bundle file name.
309
310	=over 4	349	=over 4
311		350
312	=item 1. apply all C<--use>, C<--eval>, C<--add>, C<--addbin> and	351	=item Step 0: Generic argument processing.
313	C<--incglob> options, in order.
314		352
315	In addition, C<--use> and C<--eval> dependencies will be added when the	353	The following options influence F<staticperl mkbundle> itself.
316	options are processed.
317		354
318	=item 2. apply all C<--include> and C<--exclude> options, in order.
319
320	All this step does is potentially reduce the number of files already
321	selected or found in phase 1.
322
323	=item 3. find all modules (== F<.pm> files), gather their static archives
324	(F<.a>) and AutoLoader splitfiles (F<.ix> and F<.al> files), find any
325	extra libraries they need for linking (F<extralibs.ld>) and optionally
326	evaluate any F<.packlist> files.
327
328	This step is required to link against XS extensions and also adds files
329	required for L<AutoLoader> to do it's job.
330
331	=back
332
333	After this, all the files selected for bundling will be read and processed
334	(stripped), the bundle files will be written, and optionally a new F<perl>
335	or application binary will be linked.
336
337	=head3 MKBUNDLE OPTIONS
338
339	=over 4	355	=over 4
340		356
341	=item --verbose \| -v	357	=item C<--verbose> \| C<-v>
342		358
343	Increases the verbosity level by one (the default is C<1>).	359	Increases the verbosity level by one (the default is C<1>).
344		360
345	=item --quiet \| -q	361	=item C<--quiet> \| C<-q>
346		362
347	Decreases the verbosity level by one.	363	Decreases the verbosity level by one.
348		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<require>'ing the module in a subprocess and tracing which other modules
		388	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 only C<require> the modules named
		426	by the C<--use> option, so do not expect the symbols from modules you
		427	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
		473	the current directory. If an alias is specified, then this is the name it
		474	will use for C<@INC> searches, otherwise the 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	Example: add local files as extra modules in the bundle.
		485
		486	# specification file
		487	add file1 myfiles/file1.pm
		488	add file2 myfiles/file2.pm
		489	add file3 myfiles/file3.pl
		490
		491	# then later, in perl, use
		492	use myfiles::file1;
		493	require myfiles::file2;
		494	my $res = do "myfiles/file3.pl";
		495
		496	=item C<--binadd> F<file> \| C<--add> "F<file> alias"
		497
		498	Just like C<--add>, except that it treats the file as binary and adds it
		499	without any postprocessing (perl files might get stripped to reduce their
		500	size).
		501
		502	You should probably add a C</> prefix to avoid clashing with embedded perl
		503	files (whose paths do not start with C</>), and/or use a special directory
		504	prefix, such as C</res/name>.
		505
		506	You can later get a copy of these files by calling C<staticperl::find
		507	"alias">.
		508
		509	An alternative way to embed binary files is to convert them to perl and
		510	use C<do> to get the contents - this method is a bit cumbersome, but works
		511	both inside and outside of a staticperl bundle:
		512
		513	# a "binary" file, call it "bindata.pl"
		514	<<'SOME_MARKER'
		515	binary data NOT containing SOME_MARKER
		516	SOME_MARKER
		517
		518	# load the binary
		519	chomp (my $data = do "bindata.pl");
		520
		521	=back
		522
		523	=item Step 2: filter all files using C<--include> and C<--exclude> options.
		524
		525	After all candidate files and modules are added, they are I<filtered>
		526	by a combination of C<--include> and C<--exclude> patterns (there is an
		527	implicit C<--include *> at the end, so if no filters are specified, all
		528	files are included).
		529
		530	All that this step does is potentially reduce the number of files that are
		531	to be included - no new files are added during this step.
		532
		533	=over 4
		534
		535	=item C<--include> pattern \| C<-i> pattern \| C<--exclude> pattern \| C<-x> pattern
		536
		537	These specify an include or exclude pattern to be applied to the candidate
		538	file list. An include makes sure that the given files will be part of the
		539	resulting file set, an exclude will exclude remaining files. The patterns
		540	are "extended glob patterns" (see below).
		541
		542	The patterns are applied "in order" - files included via earlier
		543	C<--include> specifications cannot be removed by any following
		544	C<--exclude>, and likewise, and file excluded by an earlier C<--exclude>
		545	cannot be added by any following C<--include>.
		546
		547	For example, to include everything except C<Devel> modules, but still
		548	include F<Devel::PPPort>, you could use this:
		549
		550	--incglob '' -i '/Devel/PPPort.pm' -x '/Devel/*'
		551
		552	=back
		553
		554	=item Step 3: add any extra or "hidden" dependencies.
		555
		556	F<staticperl> currently knows about three extra types of depdendencies
		557	that are added automatically. Only one (F<.packlist> files) is currently
		558	optional and can be influenced, the others are always included:
		559
		560	=over 4
		561
		562	=item C<--usepacklist>
		563
		564	Read F<.packlist> files for each distribution that happens to match a
		565	module name you specified. Sounds weird, and it is, so expect semantics to
		566	change somehow in the future.
		567
		568	The idea is that most CPAN distributions have a F<.pm> file that matches
		569	the name of the distribution (which is rather reasonable after all).
		570
		571	If this switch is enabled, then if any of the F<.pm> files that have been
		572	selected match an install distribution, then all F<.pm>, F<.pl>, F<.al>
		573	and F<.ix> files installed by this distribution are also included.
		574
		575	For example, using this switch, when the L<URI> module is specified, then
		576	all L<URI> submodules that have been installed via the CPAN distribution
		577	are included as well, so you don't have to manually specify them.
		578
		579	=item L<AutoLoader> splitfiles
		580
		581	Some modules use L<AutoLoader> - less commonly (hopefully) used functions
		582	are split into separate F<.al> files, and an index (F<.ix>) file contains
		583	the prototypes.
		584
		585	Both F<.ix> and F<.al> files will be detected automatically and added to
		586	the bundle.
		587
		588	=item link libraries (F<.a> files)
		589
		590	Modules using XS (or any other non-perl language extension compiled at
		591	installation time) will have a static archive (typically F<.a>). These
		592	will automatically be added to the linker options in F<bundle.ldopts>.
		593
		594	Should F<staticperl> find a dynamic link library (typically F<.so>) it
		595	will warn about it - obviously this shouldn't happen unless you use
		596	F<staticperl> on the wrong perl, or one (probably wrongly) configured to
		597	use dynamic loading.
		598
		599	=item extra libraries (F<extralibs.ld>)
		600
		601	Some modules need linking against external libraries - these are found in
		602	F<extralibs.ld> and added to F<bundle.ldopts>.
		603
		604	=back
		605
		606	=item Step 4: write bundle files and optionally link a program
		607
		608	At this point, the select files will be read, processed (stripped) and
		609	finally the bundle files get written to disk, and F<staticperl mkbundle>
		610	is normally finished. Optionally, it can go a step further and either link
		611	a new F<perl> binary with all selected modules and files inside, or build
		612	a standalone application.
		613
		614	Both the contents of the bundle files and any extra linking is controlled
		615	by these options:
		616
		617	=over 4
		618
349	=item --strip none\|pod\|ppi	619	=item C<--strip> C<none>\|C<pod>\|C<ppi>
350		620
351	Specify the stripping method applied to reduce the file of the perl	621	Specify the stripping method applied to reduce the file of the perl
352	sources included.	622	sources included.
353		623
354	The default is C<pod>, which uses the L<Pod::Strip> module to remove all	624	The default is C<pod>, which uses the L<Pod::Strip> module to remove all
…		…
365	Last not least, if you need accurate line numbers in error messages,	635	Last not least, if you need accurate line numbers in error messages,
366	or in the unlikely case where C<pod> is too slow, or some module gets	636	or in the unlikely case where C<pod> is too slow, or some module gets
367	mistreated, you can specify C<none> to not mangle included perl sources in	637	mistreated, you can specify C<none> to not mangle included perl sources in
368	any way.	638	any way.
369		639
370	=item --perl	640	=item C<--perl>
371		641
372	After writing out the bundle files, try to link a new perl interpreter. It	642	After writing out the bundle files, try to link a new perl interpreter. It
373	will be called F<perl> and will be left in the current working	643	will be called F<perl> and will be left in the current working
374	directory. The bundle files will be removed.	644	directory. The bundle files will be removed.
375		645
376	This switch is automatically used when F<staticperl> is invoked with the	646	This switch is automatically used when F<staticperl> is invoked with the
377	C<mkperl> command (instead of C<mkbundle>):	647	C<mkperl> command instead of C<mkbundle>.
378		648
379	# build a new ./perl with only common::sense in it - very small :)	649	Example: build a new F<./perl> binary with only L<common::sense> inside -
		650	it will be even smaller than the standard perl interpreter as none of the
		651	modules of the base distribution (such as L<Fcntl>) will be included.
		652
380	staticperl mkperl -Mcommon::sense	653	staticperl mkperl -Mcommon::sense
381		654
382	=item --app name	655	=item C<--app> F<name>
383		656
384	After writing out the bundle files, try to link a new standalone	657	After writing out the bundle files, try to link a new standalone
385	program. It will be called C<name>, and the bundle files get removed after	658	program. It will be called C<name>, and the bundle files get removed after
386	linking it.	659	linking it.
		660
		661	This switch is automatically used when F<staticperl> is invoked with the
		662	C<mkapp> command instead of C<mkbundle>.
387		663
388	The difference to the (mutually exclusive) C<--perl> option is that the	664	The difference to the (mutually exclusive) C<--perl> option is that the
389	binary created by this option will not try to act as a perl interpreter -	665	binary created by this option will not try to act as a perl interpreter -
390	instead it will simply initialise the perl interpreter, clean it up and	666	instead it will simply initialise the perl interpreter, clean it up and
391	exit.	667	exit.
392		668
393	This switch is automatically used when F<staticperl> is invoked with the	669	This means that, by default, it will do nothing but burna few CPU cycles
394	C<mkapp> command (instead of C<mkbundle>):
395
396	To let it do something useful you I<must> add some boot code, e.g. with	670	- for it to do something useful you I<must> add some boot code, e.g. with
397	the C<--boot> option.	671	the C<--boot> option.
398		672
399	Example: create a standalone perl binary that will execute F<appfile> when	673	Example: create a standalone perl binary called F<./myexe> that will
400	it is started.	674	execute F<appfile> when it is started.
401		675
402	staticperl mkbundle --app myexe --boot appfile	676	staticperl mkbundle --app myexe --boot appfile
403		677
404	=item --use module \| -Mmodule
405
406	Include the named module and all direct dependencies. This is done by
407	C<require>'ing the module in a subprocess and tracing which other modules
408	and files it actually loads. If the module uses L<AutoLoader>, then all
409	splitfiles will be included as well.
410
411	Example: include AnyEvent and AnyEvent::Impl::Perl.
412
413	staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl
414
415	Sometimes you want to load old-style "perl libraries" (F<.pl> files), or
416	maybe other weirdly named files. To do that, you need to quote the name in
417	single or double quotes. When given on the command line, you probably need
418	to quote once more to avoid your shell interpreting it. Common cases that
419	need this are F<Config_heavy.pl> and F<utf8_heavy.pl>.
420
421	Example: include the required files for F<perl -V> to work in all its
422	glory (F<Config.pm> is included automatically by this).
423
424	# bourne shell
425	staticperl mkbundle --use '"Config_heavy.pl"'
426
427	# bundle specification file
428	use "Config_heavy.pl"
429
430	The C<-Mmodule> syntax is included as an alias that might be easier to
431	remember than C<use>. Or maybe it confuses people. Time will tell. Or
432	maybe not. Argh.
433
434	=item --eval "perl code" \| -e "perl code"
435
436	Sometimes it is easier (or necessary) to specify dependencies using perl
437	code, or maybe one of the modules you use need a special use statement. In
438	that case, you can use C<eval> to execute some perl snippet or set some
439	variables or whatever you need. All files C<require>'d or C<use>'d in the
440	script are included in the final bundle.
441
442	Keep in mind that F<mkbundle> will only C<require> the modules named
443	by the C<--use> option, so do not expect the symbols from modules you
444	C<--use>'d earlier on the command line to be available.
445
446	Example: force L<AnyEvent> to detect a backend and therefore include it
447	in the final bundle.
448
449	staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect'
450
451	# or like this
452	staticperl mkbundle -MAnyEvent --eval 'use AnyEvent; AnyEvent::detect'
453
454	Example: use a separate "bootstrap" script that C<use>'s lots of modules
455	and include this in the final bundle, to be executed automatically.
456
457	staticperl mkbundle --eval 'do "bootstrap"' --boot bootstrap
458
459	=item --boot filename
460
461	Include the given file in the bundle and arrange for it to be executed
462	(using a C<require>) before anything else when the new perl is
463	initialised. This can be used to modify C<@INC> or anything else before
464	the perl interpreter executes scripts given on the command line (or via
465	C<-e>). This works even in an embedded interpreter.
466
467	=item --usepacklist
468
469	Read F<.packlist> files for each distribution that happens to match a
470	module name you specified. Sounds weird, and it is, so expect semantics to
471	change somehow in the future.
472
473	The idea is that most CPAN distributions have a F<.pm> file that matches
474	the name of the distribution (which is rather reasonable after all).
475
476	If this switch is enabled, then if any of the F<.pm> files that have been
477	selected match an install distribution, then all F<.pm>, F<.pl>, F<.al>
478	and F<.ix> files installed by this distribution are also included.
479
480	For example, using this switch, when the L<URI> module is specified, then
481	all L<URI> submodules that have been installed via the CPAN distribution
482	are included as well, so you don't have to manually specify them.
483
484	=item --incglob pattern
485
486	This goes through all library directories and tries to match any F<.pm>
487	and F<.pl> files against the extended glob pattern (see below). If a file
488	matches, it is added. This switch will automatically detect L<AutoLoader>
489	files and the required link libraries for XS modules, but it will I<not>
490	scan the file for dependencies (at the moment).
491
492	This is mainly useful to include "everything":
493
494	--incglob '*'
495
496	Or to include perl libraries, or trees of those, such as the unicode
497	database files needed by many other modules:
498
499	--incglob '/unicore/**.pl'
500
501	=item --add file \| --add "file alias"
502
503	Adds the given (perl) file into the bundle (and optionally call it
504	"alias"). This is useful to include any custom files into the bundle.
505
506	Example: embed the file F<httpd> as F<httpd.pm> when creating the bundle.
507
508	staticperl mkperl --add "httpd httpd.pm"
509
510	It is also a great way to add any custom modules:
511
512	# specification file
513	add file1 myfiles/file1
514	add file2 myfiles/file2
515	add file3 myfiles/file3
516
517	=item --binadd file \| --add "file alias"
518
519	Just like C<--add>, except that it treats the file as binary and adds it
520	without any processing.
521
522	You should probably add a C</> prefix to avoid clashing with embedded
523	perl files (whose paths do not start with C</>), and/or use a special
524	directory, such as C</res/name>.
525
526	You can later get a copy of these files by calling C<staticperl::find
527	"alias">.
528
529	=item --include pattern \| -i pattern \| --exclude pattern \| -x pattern
530
531	These two options define an include/exclude filter that is used after all
532	files selected by the other options have been found. Each include/exclude
533	is applied to all files found so far - an include makes sure that the
534	given files will be part of the resulting file set, an exclude will
535	exclude files. The patterns are "extended glob patterns" (see below).
536
537	For example, to include everything, except C<Devel> modules, but still
538	include F<Devel::PPPort>, you could use this:
539
540	--incglob '' -i '/Devel/PPPort.pm' -x '/Devel/*'
541
542	=item --static	678	=item C<--static>
543		679
544	When C<--perl> is also given, link statically instead of dynamically. The	680	Add C<-static> to F<bundle.ldopts>, which means a fully static (if
		681	supported by the OS) executable will be created. This is not immensely
		682	useful when just creating the bundle files, but is most useful when
		683	linking a binary with the C<--perl> or C<--app> options.
		684
545	default is to link the new perl interpreter fully dynamic (that means all	685	The default is to link the new binary dynamically (that means all perl
546	perl modules are linked statically, but all external libraries are still	686	modules are linked statically, but all external libraries are still
547	referenced dynamically).	687	referenced dynamically).
548		688
549	Keep in mind that Solaris doesn't support static linking at all, and	689	Keep in mind that Solaris doesn't support static linking at all, and
550	systems based on GNU libc don't really support it in a usable fashion	690	systems based on GNU libc don't really support it in a very usable
551	either. Try uClibc if you want to create fully statically linked	691	fashion either. Try uClibc if you want to create fully statically linked
552	executables, or try the C<--staticlibs> option to link only some libraries	692	executables, or try the C<--staticlib> option to link only some libraries
553	statically.	693	statically.
554		694
555	=item --staticlib libname	695	=item C<--staticlib> libname
556		696
557	When not linking fully statically, this option allows you to link specific	697	When not linking fully statically, this option allows you to link specific
558	libraries statically. What it does is simply replace all occurances of	698	libraries statically. What it does is simply replace all occurrences of
559	C<-llibname> with the GCC-specific C<-Wl,-Bstatic -llibname -Wl,-Bdynamic>	699	C<-llibname> with the GCC-specific C<-Wl,-Bstatic -llibname -Wl,-Bdynamic>
560	option.	700	option.
561		701
562	This will have no effect unless the library is actually linked against,	702	This will have no effect unless the library is actually linked against,
563	specifically, C<--staticlib> will not link against the named library	703	specifically, C<--staticlib> will not link against the named library
564	unless it would be linked against anyway.	704	unless it would be linked against anyway.
565		705
566	Example: link libcrypt statically into the binary.	706	Example: link libcrypt statically into the final binary.
567		707
568	staticperl mkperl -MIO::AIO --staticlib crypt	708	staticperl mkperl -MIO::AIO --staticlib crypt
569		709
570	# ldopts might nwo contain:	710	# ldopts might now contain:
571	# -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread	711	# -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread
572		712
573	=item any other argument	713	=back
574
575	Any other argument is interpreted as a bundle specification file, which
576	supports most long options (without extra quoting), one option per line.
577		714
578	=back	715	=back
579		716
580	=head3 EXTENDED GLOB PATTERNS	717	=head3 EXTENDED GLOB PATTERNS
581		718
…		…
701		838
702	More commonly, you would either activate 64 bit integer support	839	More commonly, you would either activate 64 bit integer support
703	(C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to	840	(C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to
704	reduce filesize further.	841	reduce filesize further.
705		842
706	=item C<PERL_CPPFLAGS>, C<PERL_OPTIMIZE>, C<PERL_LDFLAGS>, C<PERL_LIBS>	843	=item C<PERL_CC>, C<PERL_CCFLAGS>, C<PERL_OPTIMIZE>, C<PERL_LDFLAGS>, C<PERL_LIBS>
707		844
708	These flags are passed to perl's F<Configure> script, and are generally	845	These flags are passed to perl's F<Configure> script, and are generally
709	optimised for small size (at the cost of performance). Since they also	846	optimised for small size (at the cost of performance). Since they also
710	contain subtle workarounds around various build issues, changing these	847	contain subtle workarounds around various build issues, changing these
711	usually requires understanding their default values - best look at the top	848	usually requires understanding their default values - best look at
712	of the F<staticperl> script for more info on these.	849	the top of the F<staticperl> script for more info on these, and use a
		850	F<~/.staticperlrc> to override them.
		851
		852	Most of the variables override (or modify) the corresponding F<Configure>
		853	variable, except C<PERL_CCFLAGS>, which gets appended.
713		854
714	=back	855	=back
715		856
716	=head4 Variables you probably I<do not want> to override	857	=head4 Variables you probably I<do not want> to override
717		858
718	=over 4	859	=over 4
		860
		861	=item C<MAKE>
		862
		863	The make command to use - default is C<make>.
719		864
720	=item C<MKBUNDLE>	865	=item C<MKBUNDLE>
721		866
722	Where F<staticperl> writes the C<mkbundle> command to	867	Where F<staticperl> writes the C<mkbundle> command to
723	(default: F<$STATICPERL/mkbundle>).	868	(default: F<$STATICPERL/mkbundle>).
…		…
1051	PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"	1196	PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"
1052	done	1197	done
1053	}	1198	}
1054		1199
1055	This mostly gains space when linking staticaly, as the functions will	1200	This mostly gains space when linking staticaly, as the functions will
1056	liekly not be linked in. The gain for dynamically-linked binaries is	1201	likely not be linked in. The gain for dynamically-linked binaries is
1057	smaller.	1202	smaller.
1058		1203
1059	Also, this leaves C<gethostbyname> in - not only is it actually used	1204	Also, this leaves C<gethostbyname> in - not only is it actually used
1060	often, the L<Socket> module also exposes it, so leaving it out usually	1205	often, the L<Socket> module also exposes it, so leaving it out usually
1061	gains little. Why Socket exposes a C function that is in the core already	1206	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.20 by root, Fri Dec 10 20:29:17 2010 UTC vs. Revision 1.28 by root, Tue Dec 21 19:44:43 2010 UTC

Diff Legend

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.20 by root, Fri Dec 10 20:29:17 2010 UTC vs.
Revision 1.28 by root, Tue Dec 21 19:44:43 2010 UTC