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

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.23 by root, Mon Dec 13 18:08:01 2010 UTC vs.
Revision 1.27 by root, Tue Dec 21 19:32:34 2010 UTC

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

Diff Legend

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

Comparing App-Staticperl/staticperl.pod (file contents): Revision 1.23 by root, Mon Dec 13 18:08:01 2010 UTC vs. Revision 1.27 by root, Tue Dec 21 19:32:34 2010 UTC

Diff Legend

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.23 by root, Mon Dec 13 18:08:01 2010 UTC vs.
Revision 1.27 by root, Tue Dec 21 19:32:34 2010 UTC