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

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.19 by root, Fri Dec 10 15:25:24 2010 UTC vs.
Revision 1.31 by root, Thu Dec 23 14:16:25 2010 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
…		…
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 PACKAGE SELECTION WORKFLOW	340	=head3 BUNDLE CREATION WORKFLOW / STATICPELR MKBUNDLE OPTIONS
292		341
293	F<staticperl mkbundle> has a number of options to control package	342	F<staticperl mkbundle> works by first assembling a list of candidate
294	selection. This section describes how they interact with each other. Also,	343	files and modules to include, then filtering them by include/exclude
295	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,
296	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.
297		348
298	The idiom "in order" means "in order that they are specified on the
299	commandline". If you use a bundle specification file, then the options
300	will be processed as if they were given in place of the bundle file name.
301
302	=over 4	349	=over 4
303		350
304	=item 1. apply all C<--use>, C<--eval>, C<--add>, C<--addbin> and	351	=item Step 0: Generic argument processing.
305	C<--incglob> options, in order.
306		352
307	In addition, C<--use> and C<--eval> dependencies will be added when the	353	The following options influence F<staticperl mkbundle> itself.
308	options are processed.
309		354
310	=item 2. apply all C<--include> and C<--exclude> options, in order.
311
312	All this step does is potentially reduce the number of files already
313	selected or found in phase 1.
314
315	=item 3. find all modules (== F<.pm> files), gather their static archives
316	(F<.a>) and AutoLoader splitfiles (F<.ix> and F<.al> files) and find any
317	extra libraries they need for linking (F<extralibs.ld>).
318
319	This step is required to link against XS extensions and also adds files
320	required for L<AutoLoader> to do it's job.
321
322	=back
323
324	After this, all the files selected for bundling will be read and processed
325	(stripped), the bundle files will be written, and optionally a new F<perl>
326	or application binary will be linked.
327
328	=head3 MKBUNDLE OPTIONS
329
330	=over 4	355	=over 4
331		356
332	=item --verbose \| -v	357	=item C<--verbose> \| C<-v>
333		358
334	Increases the verbosity level by one (the default is C<1>).	359	Increases the verbosity level by one (the default is C<1>).
335		360
336	=item --quiet \| -q	361	=item C<--quiet> \| C<-q>
337		362
338	Decreases the verbosity level by one.	363	Decreases the verbosity level by one.
339		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<--usepacklists>
		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
340	=item --strip none\|pod\|ppi	619	=item C<--strip> C<none>\|C<pod>\|C<ppi>
341		620
342	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
343	sources included.	622	sources included.
344		623
345	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
…		…
356	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,
357	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
358	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
359	any way.	638	any way.
360		639
361	=item --perl	640	=item C<--perl>
362		641
363	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
364	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
365	directory. The bundle files will be removed.	644	directory. The bundle files will be removed.
366		645
367	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
368	C<mkperl> command (instead of C<mkbundle>):	647	C<mkperl> command instead of C<mkbundle>.
369		648
370	# 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
371	staticperl mkperl -Mcommon::sense	653	staticperl mkperl -Mcommon::sense
372		654
373	=item --app name	655	=item C<--app> F<name>
374		656
375	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
376	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
377	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>.
378		663
379	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
380	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 -
381	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
382	exit.	667	exit.
383		668
384	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
385	C<mkapp> command (instead of C<mkbundle>):
386
387	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
388	the C<--boot> option.	671	the C<--boot> option.
389		672
390	Example: create a standalone perl binary that will execute F<appfile> when	673	Example: create a standalone perl binary called F<./myexe> that will
391	it is started.	674	execute F<appfile> when it is started.
392		675
393	staticperl mkbundle --app myexe --boot appfile	676	staticperl mkbundle --app myexe --boot appfile
394		677
395	=item --use module \| -Mmodule
396
397	Include the named module and all direct dependencies. This is done by
398	C<require>'ing the module in a subprocess and tracing which other modules
399	and files it actually loads. If the module uses L<AutoLoader>, then all
400	splitfiles will be included as well.
401
402	Example: include AnyEvent and AnyEvent::Impl::Perl.
403
404	staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl
405
406	Sometimes you want to load old-style "perl libraries" (F<.pl> files), or
407	maybe other weirdly named files. To do that, you need to quote the name in
408	single or double quotes. When given on the command line, you probably need
409	to quote once more to avoid your shell interpreting it. Common cases that
410	need this are F<Config_heavy.pl> and F<utf8_heavy.pl>.
411
412	Example: include the required files for F<perl -V> to work in all its
413	glory (F<Config.pm> is included automatically by this).
414
415	# bourne shell
416	staticperl mkbundle --use '"Config_heavy.pl"'
417
418	# bundle specification file
419	use "Config_heavy.pl"
420
421	The C<-Mmodule> syntax is included as an alias that might be easier to
422	remember than C<use>. Or maybe it confuses people. Time will tell. Or
423	maybe not. Argh.
424
425	=item --eval "perl code" \| -e "perl code"
426
427	Sometimes it is easier (or necessary) to specify dependencies using perl
428	code, or maybe one of the modules you use need a special use statement. In
429	that case, you can use C<eval> to execute some perl snippet or set some
430	variables or whatever you need. All files C<require>'d or C<use>'d in the
431	script are included in the final bundle.
432
433	Keep in mind that F<mkbundle> will only C<require> the modules named
434	by the C<--use> option, so do not expect the symbols from modules you
435	C<--use>'d earlier on the command line to be available.
436
437	Example: force L<AnyEvent> to detect a backend and therefore include it
438	in the final bundle.
439
440	staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect'
441
442	# or like this
443	staticperl mkbundle -MAnyEvent --eval 'use AnyEvent; AnyEvent::detect'
444
445	Example: use a separate "bootstrap" script that C<use>'s lots of modules
446	and include this in the final bundle, to be executed automatically.
447
448	staticperl mkbundle --eval 'do "bootstrap"' --boot bootstrap
449
450	=item --boot filename
451
452	Include the given file in the bundle and arrange for it to be executed
453	(using a C<require>) before anything else when the new perl is
454	initialised. This can be used to modify C<@INC> or anything else before
455	the perl interpreter executes scripts given on the command line (or via
456	C<-e>). This works even in an embedded interpreter.
457
458	=item --incglob pattern
459
460	This goes through all library directories and tries to match any F<.pm>
461	and F<.pl> files against the extended glob pattern (see below). If a file
462	matches, it is added. This switch will automatically detect L<AutoLoader>
463	files and the required link libraries for XS modules, but it will I<not>
464	scan the file for dependencies (at the moment).
465
466	This is mainly useful to include "everything":
467
468	--incglob '*'
469
470	Or to include perl libraries, or trees of those, such as the unicode
471	database files needed by many other modules:
472
473	--incglob '/unicore/**.pl'
474
475	=item --add file \| --add "file alias"
476
477	Adds the given (perl) file into the bundle (and optionally call it
478	"alias"). This is useful to include any custom files into the bundle.
479
480	Example: embed the file F<httpd> as F<httpd.pm> when creating the bundle.
481
482	staticperl mkperl --add "httpd httpd.pm"
483
484	It is also a great way to add any custom modules:
485
486	# specification file
487	add file1 myfiles/file1
488	add file2 myfiles/file2
489	add file3 myfiles/file3
490
491	=item --binadd file \| --add "file alias"
492
493	Just like C<--add>, except that it treats the file as binary and adds it
494	without any processing.
495
496	You should probably add a C</> prefix to avoid clashing with embedded
497	perl files (whose paths do not start with C</>), and/or use a special
498	directory, such as C</res/name>.
499
500	You can later get a copy of these files by calling C<staticperl::find
501	"alias">.
502
503	=item --include pattern \| -i pattern \| --exclude pattern \| -x pattern
504
505	These two options define an include/exclude filter that is used after all
506	files selected by the other options have been found. Each include/exclude
507	is applied to all files found so far - an include makes sure that the
508	given files will be part of the resulting file set, an exclude will
509	exclude files. The patterns are "extended glob patterns" (see below).
510
511	For example, to include everything, except C<Devel> modules, but still
512	include F<Devel::PPPort>, you could use this:
513
514	--incglob '' -i '/Devel/PPPort.pm' -x '/Devel/*'
515
516	=item --static	678	=item C<--static>
517		679
518	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
519	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
520	perl modules are linked statically, but all external libraries are still	686	modules are linked statically, but all external libraries are still
521	referenced dynamically).	687	referenced dynamically).
522		688
523	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
524	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
525	either. Try uClibc if you want to create fully statically linked	691	fashion either. Try uClibc if you want to create fully statically linked
526	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
527	statically.	693	statically.
528		694
529	=item --staticlib libname	695	=item C<--staticlib> libname
530		696
531	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
532	libraries statically. What it does is simply replace all occurances of	698	libraries statically. What it does is simply replace all occurrences of
533	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>
534	option.	700	option.
535		701
536	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,
537	specifically, C<--staticlib> will not link against the named library	703	specifically, C<--staticlib> will not link against the named library
538	unless it would be linked against anyway.	704	unless it would be linked against anyway.
539		705
540	Example: link libcrypt statically into the binary.	706	Example: link libcrypt statically into the final binary.
541		707
542	staticperl mkperl -MIO::AIO --staticlib crypt	708	staticperl mkperl -MIO::AIO --staticlib crypt
543		709
544	# ldopts might nwo contain:	710	# ldopts might now contain:
545	# -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread	711	# -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread
546		712
547	=item any other argument	713	=back
548
549	Any other argument is interpreted as a bundle specification file, which
550	supports most long options (without extra quoting), one option per line.
551		714
552	=back	715	=back
553		716
554	=head3 EXTENDED GLOB PATTERNS	717	=head3 EXTENDED GLOB PATTERNS
555		718
…		…
569	=item Patterns not starting with F</> will be anchored at the end of the path.	732	=item Patterns not starting with F</> will be anchored at the end of the path.
570		733
571	That is, F<idna.pl> will match any file called F<idna.pl> anywhere in the	734	That is, F<idna.pl> will match any file called F<idna.pl> anywhere in the
572	hierarchy, but not any directories of the same name.	735	hierarchy, but not any directories of the same name.
573		736
574	=item A F<*> matches any single component.	737	=item A F<*> matches anything within a single path component.
575		738
576	That is, F</unicore/*.pl> would match all F<.pl> files directly inside	739	That is, F</unicore/*.pl> would match all F<.pl> files directly inside
577	C</unicore>, not any deeper level F<.pl> files. Or in other words, F<*>	740	C</unicore>, not any deeper level F<.pl> files. Or in other words, F<*>
578	will not match slashes.	741	will not match slashes.
579		742
…		…
589		752
590	=back	753	=back
591		754
592	=head2 F<STATICPERL> CONFIGURATION AND HOOKS	755	=head2 F<STATICPERL> CONFIGURATION AND HOOKS
593		756
594	During (each) startup, F<staticperl> tries to source the following shell	757	During (each) startup, F<staticperl> tries to source some shell files to
		758	allow you to fine-tune/override configuration settings.
		759
		760	In them you can override shell variables, or define shell functions
		761	("hooks") to be called at specific phases during installation. For
		762	example, you could define a C<postinstall> hook to install additional
		763	modules from CPAN each time you start from scratch.
		764
		765	If the env variable C<$STATICPERLRC> is set, then F<staticperl> will try
		766	to source the file named with it only. Otherwise, it tries the following
595	files in order:	767	shell files in order:
596		768
597	/etc/staticperlrc	769	/etc/staticperlrc
598	~/.staticperlrc	770	~/.staticperlrc
599	$STATICPERL/rc	771	$STATICPERL/rc
600
601	They can be used to override shell variables, or define functions to be
602	called at specific phases.
603		772
604	Note that the last file is erased during F<staticperl distclean>, so	773	Note that the last file is erased during F<staticperl distclean>, so
605	generally should not be used.	774	generally should not be used.
606		775
607	=head3 CONFIGURATION VARIABLES	776	=head3 CONFIGURATION VARIABLES
…		…
669		838
670	More commonly, you would either activate 64 bit integer support	839	More commonly, you would either activate 64 bit integer support
671	(C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to	840	(C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to
672	reduce filesize further.	841	reduce filesize further.
673		842
674	=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>
675		844
676	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
677	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
678	contain subtle workarounds around various build issues, changing these	847	contain subtle workarounds around various build issues, changing these
679	usually requires understanding their default values - best look at the top	848	usually requires understanding their default values - best look at
680	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.
681		854
682	=back	855	=back
683		856
684	=head4 Variables you probably I<do not want> to override	857	=head4 Variables you probably I<do not want> to override
685		858
686	=over 4	859	=over 4
		860
		861	=item C<MAKE>
		862
		863	The make command to use - default is C<make>.
687		864
688	=item C<MKBUNDLE>	865	=item C<MKBUNDLE>
689		866
690	Where F<staticperl> writes the C<mkbundle> command to	867	Where F<staticperl> writes the C<mkbundle> command to
691	(default: F<$STATICPERL/mkbundle>).	868	(default: F<$STATICPERL/mkbundle>).
…		…
856		1033
857	Returns the list of all paths embedded in this binary.	1034	Returns the list of all paths embedded in this binary.
858		1035
859	=back	1036	=back
860		1037
861	=head1 FULLY STATIC BINARIES - BUILDROOT	1038	=head1 FULLY STATIC BINARIES - UCLIBC AND BUILDROOT
862		1039
863	To make truly static (Linux-) libraries, you might want to have a look at	1040	To make truly static (Linux-) libraries, you might want to have a look at
864	buildroot (L<http://buildroot.uclibc.org/>).	1041	buildroot (L<http://buildroot.uclibc.org/>).
865		1042
866	Buildroot is primarily meant to set up a cross-compile environment (which	1043	Buildroot is primarily meant to set up a cross-compile environment (which
…		…
938	handling for those files), so including them on demand by your application	1115	handling for those files), so including them on demand by your application
939	only might pay off.	1116	only might pay off.
940		1117
941	To simply include the whole unicode database, use:	1118	To simply include the whole unicode database, use:
942		1119
943	--incglob '/unicore/*.pl'	1120	--incglob '/unicore/**.pl'
944		1121
945	=item AnyEvent	1122	=item AnyEvent
946		1123
947	AnyEvent needs a backend implementation that it will load in a delayed	1124	AnyEvent needs a backend implementation that it will load in a delayed
948	fashion. The L<AnyEvent::Impl::Perl> backend is the default choice	1125	fashion. The L<AnyEvent::Impl::Perl> backend is the default choice
…		…
953		1130
954	If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn	1131	If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn
955	functions), you also need to include C<"AnyEvent/Util/idna.pl"> and	1132	functions), you also need to include C<"AnyEvent/Util/idna.pl"> and
956	C<"AnyEvent/Util/uts46data.pl">.	1133	C<"AnyEvent/Util/uts46data.pl">.
957		1134
		1135	Or you can use C<--usepacklists> and specify C<-MAnyEvent> to include
		1136	everything.
		1137
958	=item Carp	1138	=item Carp
959		1139
960	Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of	1140	Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of
961	perl 5.12.2 (maybe earlier), this dependency no longer exists.	1141	perl 5.12.2 (maybe earlier), this dependency no longer exists.
962		1142
…		…
966	turn might need L<"Config_heavy.pl">. Including the latter gives you	1146	turn might need L<"Config_heavy.pl">. Including the latter gives you
967	both.	1147	both.
968		1148
969	=item Term::ReadLine::Perl	1149	=item Term::ReadLine::Perl
970		1150
971	Also needs L<Term::ReadLine::readline>.	1151	Also needs L<Term::ReadLine::readline>, or C<--usepacklists>.
972		1152
973	=item URI	1153	=item URI
974		1154
975	URI implements schemes as separate modules - the generic URL scheme is	1155	URI implements schemes as separate modules - the generic URL scheme is
976	implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If	1156	implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If
977	you need to use any of these schemes, you should include these manually.	1157	you need to use any of these schemes, you should include these manually,
		1158	or use C<--usepacklists>.
978		1159
979	=back	1160	=back
980		1161
981	=head2 RECIPES	1162	=head2 RECIPES
982		1163
983	=over 4	1164	=over 4
984		1165
985	=item Linking everything in	1166	=item Just link everything in
986		1167
987	To link just about everything installed in the perl library into a new	1168	To link just about everything installed in the perl library into a new
988	perl, try this:	1169	perl, try this (the first time this runs it will take a long time, as a
		1170	lot of files need to be parsed):
989		1171
990	staticperl mkperl --strip ppi --incglob '*'	1172	staticperl mkperl -v --strip ppi --incglob '*'
991		1173
		1174	If you don't mind the extra megabytes, this can be a very effective way of
		1175	creating bundles without having to worry about forgetting any modules.
		1176
		1177	You get even more useful variants of this method by first selecting
		1178	everything, and then excluding stuff you are reasonable sure not to need -
		1179	L<bigperl\|http://staticperl.schmorp.de/bigperl.html> uses this approach.
		1180
992	=item Getting rid of netdb function	1181	=item Getting rid of netdb functions
993		1182
994	The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent>	1183	The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent>
995	and so on) that few applications use. You can avoid compiling them in by	1184	and so on) that few applications use. You can avoid compiling them in by
996	putting the following fragment into a C<preconfigure> hook:	1185	putting the following fragment into a C<preconfigure> hook:
997		1186
…		…
1014	do	1203	do
1015	PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"	1204	PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"
1016	done	1205	done
1017	}	1206	}
1018		1207
1019	This mostly gains space when linking staticaly, as the functions will	1208	This mostly gains space when linking statically, as the functions will
1020	liekly not be linked in. The gain for dynamically-linked binaries is	1209	likely not be linked in. The gain for dynamically-linked binaries is
1021	smaller.	1210	smaller.
1022		1211
1023	Also, this leaves C<gethostbyname> in - not only is it actually used	1212	Also, this leaves C<gethostbyname> in - not only is it actually used
1024	often, the L<Socket> module also exposes it, so leaving it out usually	1213	often, the L<Socket> module also exposes it, so leaving it out usually
1025	gains little. Why Socket exposes a C function that is in the core already	1214	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.19 by root, Fri Dec 10 15:25:24 2010 UTC vs. Revision 1.31 by root, Thu Dec 23 14:16:25 2010 UTC

Diff Legend

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.19 by root, Fri Dec 10 15:25:24 2010 UTC vs.
Revision 1.31 by root, Thu Dec 23 14:16:25 2010 UTC