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

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.26 by root, Tue Dec 21 19:14:56 2010 UTC vs.
Revision 1.43 by root, Sun Jun 26 17:26:52 2011 UTC

…		…
9	staticperl configure # fetch and then configure perl	9	staticperl configure # fetch and then configure perl
10	staticperl build # configure and then build perl	10	staticperl build # configure and then build perl
11	staticperl install # build and then install perl	11	staticperl install # build and then install perl
12	staticperl clean # clean most intermediate files (restart at configure)	12	staticperl clean # clean most intermediate files (restart at configure)
13	staticperl distclean # delete everything installed by this script	13	staticperl distclean # delete everything installed by this script
		14	staticperl perl ... # invoke the perlinterpreter
14	staticperl cpan # invoke CPAN shell	15	staticperl cpan # invoke CPAN shell
15	staticperl instmod path... # install unpacked modules	16	staticperl instmod path... # install unpacked modules
16	staticperl instcpan modulename... # install modules from CPAN	17	staticperl instcpan modulename... # install modules from CPAN
17	staticperl mkbundle <bundle-args...> # see documentation	18	staticperl mkbundle <bundle-args...> # see documentation
18	staticperl mkperl <bundle-args...> # see documentation	19	staticperl mkperl <bundle-args...> # see documentation
…		…
20		21
21	Typical Examples:	22	Typical Examples:
22		23
23	staticperl install # fetch, configure, build and install perl	24	staticperl install # fetch, configure, build and install perl
24	staticperl cpan # run interactive cpan shell	25	staticperl cpan # run interactive cpan shell
25	staticperl mkperl -M '"Config_heavy.pl"' # build a perl that supports -V	26	staticperl mkperl -MConfig_heavy.pl # build a perl that supports -V
26	staticperl mkperl -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI -MURI::http	27	staticperl mkperl -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI -MURI::http
27	# build a perl with the above modules linked in	28	# build a perl with the above modules linked in
28	staticperl mkapp myapp --boot mainprog mymodules	29	staticperl mkapp myapp --boot mainprog mymodules
29	# build a binary "myapp" from mainprog and mymodules	30	# build a binary "myapp" from mainprog and mymodules
30		31
…		…
38	file that contains perl interpreter, libc, all the modules you need, all	39	file that contains perl interpreter, libc, all the modules you need, all
39	the libraries you need and of course your actual program.	40	the libraries you need and of course your actual program.
40		41
41	With F<uClibc> and F<upx> on x86, you can create a single 500kb binary	42	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,	43	that contains perl and 100 modules such as POSIX, AnyEvent, EV, IO::AIO,
43	Coro and so on. Or any other choice of modules.	44	Coro and so on. Or any other choice of modules (and some other size :).
44		45
45	To see how this turns out, you can try out smallperl and bigperl, two	46	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	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	modules: just follow the links at L<http://staticperl.schmorp.de/>.
48		49
…		…
139	with creating binaries and bundle files.	140	with creating binaries and bundle files.
140		141
141	=head2 PHASE 1 COMMANDS: INSTALLING PERL	142	=head2 PHASE 1 COMMANDS: INSTALLING PERL
142		143
143	The most important command is F<install>, which does basically	144	The most important command is F<install>, which does basically
144	everything. The default is to download and install perl 5.12.2 and a few	145	everything. The default is to download and install perl 5.12.3 and a few
145	modules required by F<staticperl> itself, but all this can (and should) be	146	modules required by F<staticperl> itself, but all this can (and should) be
146	changed - see L<CONFIGURATION>, below.	147	changed - see L<CONFIGURATION>, below.
147		148
148	The command	149	The command
149		150
…		…
185		186
186	=item F<staticperl install>	187	=item F<staticperl install>
187		188
188	Wipes the perl installation directory (usually F<~/.staticperl/perl>) and	189	Wipes the perl installation directory (usually F<~/.staticperl/perl>) and
189	installs the perl distribution, potentially after building it first.	190	installs the perl distribution, potentially after building it first.
		191
		192	=item F<staticperl perl> [args...]
		193
		194	Invokes the compiled perl interpreter with the given args. Basically the
		195	same as starting perl directly (usually via F<~/.staticperl/bin/perl>),
		196	but beats typing the path sometimes.
		197
		198	Example: check that the Gtk2 module is installed and loadable.
		199
		200	staticperl perl -MGtk2 -e0
190		201
191	=item F<staticperl cpan> [args...]	202	=item F<staticperl cpan> [args...]
192		203
193	Starts an interactive CPAN shell that you can use to install further	204	Starts an interactive CPAN shell that you can use to install further
194	modules. Installs the perl first if necessary, but apart from that,	205	modules. Installs the perl first if necessary, but apart from that,
…		…
252		263
253	# first make sure we have perl and the required modules	264	# first make sure we have perl and the required modules
254	staticperl instcpan AnyEvent::HTTPD	265	staticperl instcpan AnyEvent::HTTPD
255		266
256	# now build the perl	267	# now build the perl
257	staticperl mkperl -M'"Config_heavy.pl"' -MAnyEvent::Impl::Perl \	268	staticperl mkperl -MConfig_heavy.pl -MAnyEvent::Impl::Perl \
258	-MAnyEvent::HTTPD -MURI::http \	269	-MAnyEvent::HTTPD -MURI::http \
259	--add 'eg/httpd httpd.pm'	270	--add 'eg/httpd httpd.pm'
260		271
261	# finally, invoke it	272	# finally, invoke it
262	./perl -Mhttpd	273	./perl -Mhttpd
…		…
313		324
314	=head3 OPTION PROCESSING	325	=head3 OPTION PROCESSING
315		326
316	All options can be given as arguments on the command line (typically	327	All options can be given as arguments on the command line (typically
317	using long (e.g. C<--verbose>) or short option (e.g. C<-v>) style). Since	328	using long (e.g. C<--verbose>) or short option (e.g. C<-v>) style). Since
318	specifying a lot of modules can make the command line very cumbersome, you	329	specifying a lot of options can make the command line very long and
319	can put all long options into a "bundle specification file" (one option	330	unwieldy, you can put all long options into a "bundle specification file"
320	per line, with or without C<--> prefix) and specify this bundle file	331	(one option per line, with or without C<--> prefix) and specify this
321	instead.	332	bundle file instead.
322		333
323	For example, the command given earlier could also look like this:	334	For example, the command given earlier to link a new F<perl> could also
		335	look like this:
324		336
325	staticperl mkperl httpd.bundle	337	staticperl mkperl httpd.bundle
326		338
327	And all options could be in F<httpd.bundle>:	339	With all options stored in the F<httpd.bundle> file (one option per line,
328		340	everything after the option is an argument):
		341
329	use "Config_heavy.pl"	342	use "Config_heavy.pl"
330	use AnyEvent::Impl::Perl	343	use AnyEvent::Impl::Perl
331	use AnyEvent::HTTPD	344	use AnyEvent::HTTPD
332	use URI::http	345	use URI::http
333	add eg/httpd httpd.pm	346	add eg/httpd httpd.pm
334		347
335	All options that specify modules or files to be added are processed in the	348	All options that specify modules or files to be added are processed in the
336	order given on the command line.	349	order given on the command line.
337		350
338	=head3 BUNDLE CREATION WORKFLOW	351	=head3 BUNDLE CREATION WORKFLOW / STATICPELR MKBUNDLE OPTIONS
339		352
340	F<staticperl mkbundle> works by first assembling a list of candidate	353	F<staticperl mkbundle> works by first assembling a list of candidate
341	files and modules to include, then filtering them by include/exclude	354	files and modules to include, then filtering them by include/exclude
342	patterns. The remaining modules (together with their direct depdendencies,	355	patterns. The remaining modules (together with their direct dependencies,
343	such as link libraries and AutoLoader files) are then converted into	356	such as link libraries and L<AutoLoader> files) are then converted into
344	bundle files suitable for embedding. Afterwards, F<staticperl mkbundle>	357	bundle files suitable for embedding. F<staticperl mkbundle> can then
345	can optionally build a new perl interpreter or a standalone application.	358	optionally build a new perl interpreter or a standalone application.
346		359
347	=over 4	360	=over 4
348		361
349	=item Step 0: Generic argument processing.	362	=item Step 0: Generic argument processing.
350		363
351	The following options influence F<staticperl mkbundle> itself.	364	The following options influence F<staticperl mkbundle> itself.
352		365
353	=over 4	366	=over 4
354		367
355	=item --verbose \| -v	368	=item C<--verbose> \| C<-v>
356		369
357	Increases the verbosity level by one (the default is C<1>).	370	Increases the verbosity level by one (the default is C<1>).
358		371
359	=item --quiet \| -q	372	=item C<--quiet> \| C<-q>
360		373
361	Decreases the verbosity level by one.	374	Decreases the verbosity level by one.
362		375
363	=item any other argument	376	=item any other argument
364		377
365	Any other argument is interpreted as a bundle specification file, which	378	Any other argument is interpreted as a bundle specification file, which
366	supports most long options (without extra quoting), one option per line.	379	supports all options (without extra quoting), one option per line, in the
		380	format C<option> or C<option argument>. They will effectively be expanded
		381	and processed as if they were directly written on the command line, in
		382	place of the file name.
367		383
368	=back	384	=back
369		385
370	=item Step 1: gather candidate files and modules	386	=item Step 1: gather candidate files and modules
371		387
…		…
376		392
377	=over 4	393	=over 4
378		394
379	=item C<--use> F<module> \| C<-M>F<module>	395	=item C<--use> F<module> \| C<-M>F<module>
380		396
381	Include the named module and trace direct dependencies. This is done by	397	Include the named module or perl library and trace direct
382	C<require>'ing the module in a subprocess and tracing which other modules	398	dependencies. This is done by loading the module in a subprocess and
383	and files it actually loads.	399	tracing which other modules and files it actually loads.
384		400
385	Example: include AnyEvent and AnyEvent::Impl::Perl.	401	Example: include AnyEvent and AnyEvent::Impl::Perl.
386		402
387	staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl	403	staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl
388		404
389	Sometimes you want to load old-style "perl libraries" (F<.pl> files), or	405	Sometimes you want to load old-style "perl libraries" (F<.pl> files), or
390	maybe other weirdly named files. To do that, you need to quote the name in	406	maybe other weirdly named files. To support this, the C<--use> option
391	single or double quotes. When given on the command line, you probably need	407	actually tries to do what you mean, depending on the string you specify:
392	to quote once more to avoid your shell interpreting it. Common cases that	408
393	need this are F<Config_heavy.pl> and F<utf8_heavy.pl>.	409	=over 4
		410
		411	=item a possibly valid module name, e.g. F<common::sense>, F<Carp>,
		412	F<Coro::Mysql>.
		413
		414	If the string contains no quotes, no F</> and no F<.>, then C<--use>
		415	assumes that it is a normal module name. It will create a new package and
		416	evaluate a C<use module> in it, i.e. it will load the package and do a
		417	default import.
		418
		419	The import step is done because many modules trigger more dependencies
		420	when something is imported than without.
		421
		422	=item anything that contains F</> or F<.> characters,
		423	e.g. F<utf8_heavy.pl>, F<Module/private/data.pl>.
		424
		425	The string will be quoted and passed to require, as if you used C<require
		426	$module>. Nothing will be imported.
		427
		428	=item "path" or 'path', e.g. C<"utf8_heavy.pl">.
		429
		430	If you enclose the name into single or double quotes, then the quotes will
		431	be removed and the resulting string will be passed to require. This syntax
		432	is form compatibility with older versions of staticperl and should not be
		433	used anymore.
		434
		435	=back
		436
		437	Example: C<use> AnyEvent::Socket, once using C<use> (importing the
		438	symbols), and once via C<require>, not importing any symbols. The first
		439	form is preferred as many modules load some extra dependencies when asked
		440	to export symbols.
		441
		442	staticperl mkbundle -MAnyEvent::Socket # use + import
		443	staticperl mkbundle -MAnyEvent/Socket.pm # require only
394		444
395	Example: include the required files for F<perl -V> to work in all its	445	Example: include the required files for F<perl -V> to work in all its
396	glory (F<Config.pm> is included automatically by this).	446	glory (F<Config.pm> is included automatically by the dependency tracker).
397		447
398	# bourne shell	448	# shell command
399	staticperl mkbundle --use '"Config_heavy.pl"'	449	staticperl mkbundle -MConfig_heavy.pl
400		450
401	# bundle specification file	451	# bundle specification file
402	use "Config_heavy.pl"	452	use Config_heavy.pl
403		453
404	The C<-M>module syntax is included as an alias that might be easier to	454	The C<-M>module syntax is included as a convenience that might be easier
405	remember than C<--use>. Or maybe it confuses people. Time will tell. Or	455	to remember than C<--use> - it's the same switch as perl itself uses
		456	to load modules. Or maybe it confuses people. Time will tell. Or maybe
406	maybe not. Sigh.	457	not. Sigh.
407		458
408	=item C<--eval> "perl code" \| C<-e> "perl code"	459	=item C<--eval> "perl code" \| C<-e> "perl code"
409		460
410	Sometimes it is easier (or necessary) to specify dependencies using perl	461	Sometimes it is easier (or necessary) to specify dependencies using perl
411	code, or maybe one of the modules you use need a special use statement. In	462	code, or maybe one of the modules you use need a special use statement. In
412	that case, you can use C<--eval> to execute some perl snippet or set some	463	that case, you can use C<--eval> to execute some perl snippet or set some
413	variables or whatever you need. All files C<require>'d or C<use>'d while	464	variables or whatever you need. All files C<require>'d or C<use>'d while
414	executing the snippet are included in the final bundle.	465	executing the snippet are included in the final bundle.
415		466
416	Keep in mind that F<mkbundle> will only C<require> the modules named	467	Keep in mind that F<mkbundle> will not import any symbols from the modules
417	by the C<--use> option, so do not expect the symbols from modules you	468	named by the C<--use> option, so do not expect the symbols from modules
418	C<--use>'d earlier on the command line to be available.	469	you C<--use>'d earlier on the command line to be available.
419		470
420	Example: force L<AnyEvent> to detect a backend and therefore include it	471	Example: force L<AnyEvent> to detect a backend and therefore include it
421	in the final bundle.	472	in the final bundle.
422		473
423	staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect'	474	staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect'
…		…
450	This is very useful to include "everything":	501	This is very useful to include "everything":
451		502
452	--incglob '*'	503	--incglob '*'
453		504
454	It is also useful for including perl libraries, or trees of those, such as	505	It is also useful for including perl libraries, or trees of those, such as
455	the unicode database files needed by some perl builtins, the regex engine	506	the unicode database files needed by some perl built-ins, the regex engine
456	and other modules.	507	and other modules.
457		508
458	--incglob '/unicore/**.pl'	509	--incglob '/unicore/**.pl'
459		510
460	=item C<--add> F<file> \| C<--add> "F<file> alias"	511	=item C<--add> F<file> \| C<--add> "F<file> alias"
461		512
462	Adds the given (perl) file into the bundle (and optionally call it	513	Adds the given (perl) file into the bundle (and optionally call it
463	"alias"). The F<file> is either an absolute path or a path relative to	514	"alias"). The F<file> is either an absolute path or a path relative to the
464	the current directory. If an alias is specified, then this is the name it	515	current directory. If an alias is specified, then this is the name it will
465	will use for C<@INC> searches, otherfile the F<file> will be used as the	516	use for C<@INC> searches, otherwise the path F<file> will be used as the
466	internal name.	517	internal name.
467		518
468	This switch is used to include extra files into the bundle.	519	This switch is used to include extra files into the bundle.
469		520
470	Example: embed the file F<httpd> in the current directory as F<httpd.pm>	521	Example: embed the file F<httpd> in the current directory as F<httpd.pm>
471	when creating the bundle.	522	when creating the bundle.
472		523
473	staticperl mkperl --add "httpd httpd.pm"	524	staticperl mkperl --add "httpd httpd.pm"
		525
		526	# can be accessed via "use httpd"
		527
		528	Example: add a file F<initcode> from the current directory.
		529
		530	staticperl mkperl --add 'initcode &initcode'
		531
		532	# can be accessed via "do '&initcode'"
474		533
475	Example: add local files as extra modules in the bundle.	534	Example: add local files as extra modules in the bundle.
476		535
477	# specification file	536	# specification file
478	add file1 myfiles/file1.pm	537	add file1 myfiles/file1.pm
…		…
488		547
489	Just like C<--add>, except that it treats the file as binary and adds it	548	Just like C<--add>, except that it treats the file as binary and adds it
490	without any postprocessing (perl files might get stripped to reduce their	549	without any postprocessing (perl files might get stripped to reduce their
491	size).	550	size).
492		551
493	You should probably add a C</> prefix to avoid clashing with embedded perl	552	If you specify an alias you should probably add a C<&> prefix to avoid
494	files (whose paths do not start with C</>), and/or use a special directory	553	clashing with embedded perl files (whose paths never start with C<&>),
495	prefix, such as C</res/name>.	554	and/or use a special directory prefix, such as C<&res/name>.
496		555
497	You can later get a copy of these files by calling C<staticperl::find	556	You can later get a copy of these files by calling C<staticperl::find
498	"alias">.	557	"alias">.
499		558
500	An alternative way to embed binary files is to convert them to perl and	559	An alternative way to embed binary files is to convert them to perl and
…		…
513		572
514	=item Step 2: filter all files using C<--include> and C<--exclude> options.	573	=item Step 2: filter all files using C<--include> and C<--exclude> options.
515		574
516	After all candidate files and modules are added, they are I<filtered>	575	After all candidate files and modules are added, they are I<filtered>
517	by a combination of C<--include> and C<--exclude> patterns (there is an	576	by a combination of C<--include> and C<--exclude> patterns (there is an
518	implicit C<--include **> at the end, so if no filters are specified, all	577	implicit C<--include *> at the end, so if no filters are specified, all
519	files are included).	578	files are included).
520		579
521	All that this step does is potentially reduce the number of files that are	580	All that this step does is potentially reduce the number of files that are
522	to be included - no new files are added during this step.	581	to be included - no new files are added during this step.
523		582
…		…
548	that are added automatically. Only one (F<.packlist> files) is currently	607	that are added automatically. Only one (F<.packlist> files) is currently
549	optional and can be influenced, the others are always included:	608	optional and can be influenced, the others are always included:
550		609
551	=over 4	610	=over 4
552		611
553	=item C<--usepacklist>	612	=item C<--usepacklists>
554		613
555	Read F<.packlist> files for each distribution that happens to match a	614	Read F<.packlist> files for each distribution that happens to match a
556	module name you specified. Sounds weird, and it is, so expect semantics to	615	module name you specified. Sounds weird, and it is, so expect semantics to
557	change somehow in the future.	616	change somehow in the future.
558		617
…		…
626	Last not least, if you need accurate line numbers in error messages,	685	Last not least, if you need accurate line numbers in error messages,
627	or in the unlikely case where C<pod> is too slow, or some module gets	686	or in the unlikely case where C<pod> is too slow, or some module gets
628	mistreated, you can specify C<none> to not mangle included perl sources in	687	mistreated, you can specify C<none> to not mangle included perl sources in
629	any way.	688	any way.
630		689
631	=item --perl	690	=item C<--perl>
632		691
633	After writing out the bundle files, try to link a new perl interpreter. It	692	After writing out the bundle files, try to link a new perl interpreter. It
634	will be called F<perl> and will be left in the current working	693	will be called F<perl> and will be left in the current working
635	directory. The bundle files will be removed.	694	directory. The bundle files will be removed.
636		695
…		…
641	it will be even smaller than the standard perl interpreter as none of the	700	it will be even smaller than the standard perl interpreter as none of the
642	modules of the base distribution (such as L<Fcntl>) will be included.	701	modules of the base distribution (such as L<Fcntl>) will be included.
643		702
644	staticperl mkperl -Mcommon::sense	703	staticperl mkperl -Mcommon::sense
645		704
646	=item --app name	705	=item C<--app> F<name>
647		706
648	After writing out the bundle files, try to link a new standalone	707	After writing out the bundle files, try to link a new standalone
649	program. It will be called C<name>, and the bundle files get removed after	708	program. It will be called C<name>, and the bundle files get removed after
650	linking it.	709	linking it.
651		710
…		…
655	The difference to the (mutually exclusive) C<--perl> option is that the	714	The difference to the (mutually exclusive) C<--perl> option is that the
656	binary created by this option will not try to act as a perl interpreter -	715	binary created by this option will not try to act as a perl interpreter -
657	instead it will simply initialise the perl interpreter, clean it up and	716	instead it will simply initialise the perl interpreter, clean it up and
658	exit.	717	exit.
659		718
660	This means that, by default, it will do nothing but burna few CPU cycles	719	This means that, by default, it will do nothing but burn a few CPU cycles
661	- for it to do something useful you I<must> add some boot code, e.g. with	720	- for it to do something useful you I<must> add some boot code, e.g. with
662	the C<--boot> option.	721	the C<--boot> option.
663		722
664	Example: create a standalone perl binary called F<./myexe> that will	723	Example: create a standalone perl binary called F<./myexe> that will
665	execute F<appfile> when it is started.	724	execute F<appfile> when it is started.
666		725
667	staticperl mkbundle --app myexe --boot appfile	726	staticperl mkbundle --app myexe --boot appfile
668		727
		728	=item C<--ignore-env>
		729
		730	Generates extra code to unset some environment variables before
		731	initialising/running perl. Perl supports a lot of environment variables
		732	that might alter execution in ways that might be undesirablre for
		733	standalone applications, and this option removes those known to cause
		734	trouble.
		735
		736	Specifically, these are removed:
		737
		738	C<PERL_HASH_SEED_DEBUG> and C<PERL_DEBUG_MSTATS> can cause underaible
		739	output, C<PERL5OPT>, C<PERL_DESTRUCT_LEVEL>, C<PERL_HASH_SEED> and
		740	C<PERL_SIGNALS> can alter execution significantly, and C<PERL_UNICODE>,
		741	C<PERLIO_DEBUG> and C<PERLIO> can affect input and output.
		742
		743	The variables C<PERL_LIB> and C<PERL5_LIB> are always ignored because the
		744	startup code used by F<staticperl> overrides C<@INC> in all cases.
		745
		746	This option will not make your program more secure (unless you are
		747	running with elevated privileges), but it will reduce the surprise effect
		748	when a user has these environment variables set and doesn't expect your
		749	standalone program to act like a perl interpreter.
		750
669	=item --static	751	=item C<--static>
670		752
671	Add C<-static> to F<bundle.ldopts>, which means a fully static (if	753	Add C<-static> to F<bundle.ldopts>, which means a fully static (if
672	supported by the OS) executable will be created. This is not immensely	754	supported by the OS) executable will be created. This is not immensely
673	useful when just creating the bundle files, but is most useful when	755	useful when just creating the bundle files, but is most useful when
674	linking a binary with the C<--perl> or C<--app> options.	756	linking a binary with the C<--perl> or C<--app> options.
…		…
681	systems based on GNU libc don't really support it in a very usable	763	systems based on GNU libc don't really support it in a very usable
682	fashion either. Try uClibc if you want to create fully statically linked	764	fashion either. Try uClibc if you want to create fully statically linked
683	executables, or try the C<--staticlib> option to link only some libraries	765	executables, or try the C<--staticlib> option to link only some libraries
684	statically.	766	statically.
685		767
686	=item --staticlib libname	768	=item C<--staticlib> libname
687		769
688	When not linking fully statically, this option allows you to link specific	770	When not linking fully statically, this option allows you to link specific
689	libraries statically. What it does is simply replace all occurances of	771	libraries statically. What it does is simply replace all occurrences of
690	C<-llibname> with the GCC-specific C<-Wl,-Bstatic -llibname -Wl,-Bdynamic>	772	C<-llibname> with the GCC-specific C<-Wl,-Bstatic -llibname -Wl,-Bdynamic>
691	option.	773	option.
692		774
693	This will have no effect unless the library is actually linked against,	775	This will have no effect unless the library is actually linked against,
694	specifically, C<--staticlib> will not link against the named library	776	specifically, C<--staticlib> will not link against the named library
695	unless it would be linked against anyway.	777	unless it would be linked against anyway.
696		778
697	Example: link libcrypt statically into the binary.	779	Example: link libcrypt statically into the final binary.
698		780
699	staticperl mkperl -MIO::AIO --staticlib crypt	781	staticperl mkperl -MIO::AIO --staticlib crypt
700		782
701	# ldopts might now contain:	783	# ldopts might now contain:
702	# -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread	784	# -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread
…		…
723	=item Patterns not starting with F</> will be anchored at the end of the path.	805	=item Patterns not starting with F</> will be anchored at the end of the path.
724		806
725	That is, F<idna.pl> will match any file called F<idna.pl> anywhere in the	807	That is, F<idna.pl> will match any file called F<idna.pl> anywhere in the
726	hierarchy, but not any directories of the same name.	808	hierarchy, but not any directories of the same name.
727		809
728	=item A F<*> matches any single component.	810	=item A F<*> matches anything within a single path component.
729		811
730	That is, F</unicore/*.pl> would match all F<.pl> files directly inside	812	That is, F</unicore/*.pl> would match all F<.pl> files directly inside
731	C</unicore>, not any deeper level F<.pl> files. Or in other words, F<*>	813	C</unicore>, not any deeper level F<.pl> files. Or in other words, F<*>
732	will not match slashes.	814	will not match slashes.
733		815
…		…
800	=item C<STATICPERL>	882	=item C<STATICPERL>
801		883
802	The directory where staticperl stores all its files	884	The directory where staticperl stores all its files
803	(default: F<~/.staticperl>).	885	(default: F<~/.staticperl>).
804		886
		887	=item C<DLCACHE>
		888
		889	The path to a directory (will be created if it doesn't exist) where
		890	downloaded perl sources are being cached, to avoid downloading them
		891	again. The default is empty, which means there is no cache.
		892
		893	=item C<PERL_VERSION>
		894
		895	The perl version to install - default is currently C<5.12.3>, but C<5.8.9>
		896	is also a good choice (5.8.9 is much smaller than 5.12.3, while 5.10.1 is
		897	about as big as 5.12.3).
		898
805	=item C<PERL_MM_USE_DEFAULT>, C<EV_EXTRA_DEFS>, ...	899	=item C<PERL_MM_USE_DEFAULT>, C<EV_EXTRA_DEFS>, ...
806		900
807	Usually set to C<1> to make modules "less inquisitive" during their	901	Usually set to C<1> to make modules "less inquisitive" during their
808	installation, you can set any environment variable you want - some modules	902	installation, you can set any environment variable you want - some modules
809	(such as L<Coro> or L<EV>) use environment variables for further tweaking.	903	(such as L<Coro> or L<EV>) use environment variables for further tweaking.
810
811	=item C<PERL_VERSION>
812
813	The perl version to install - default is currently C<5.12.2>, but C<5.8.9>
814	is also a good choice (5.8.9 is much smaller than 5.12.2, while 5.10.1 is
815	about as big as 5.12.2).
816		904
817	=item C<PERL_PREFIX>	905	=item C<PERL_PREFIX>
818		906
819	The prefix where perl gets installed (default: F<$STATICPERL/perl>),	907	The prefix where perl gets installed (default: F<$STATICPERL/perl>),
820	i.e. where the F<bin> and F<lib> subdirectories will end up.	908	i.e. where the F<bin> and F<lib> subdirectories will end up.
…		…
841	F<~/.staticperlrc> to override them.	929	F<~/.staticperlrc> to override them.
842		930
843	Most of the variables override (or modify) the corresponding F<Configure>	931	Most of the variables override (or modify) the corresponding F<Configure>
844	variable, except C<PERL_CCFLAGS>, which gets appended.	932	variable, except C<PERL_CCFLAGS>, which gets appended.
845		933
		934	You should have a look near the beginning of the F<staticperl> script -
		935	staticperl tries to default C<PERL_OPTIMIZE> to some psace-saving options
		936	suitable for newer gcc versions. For other compilers or older versions you
		937	need to adjust these, for example, in your F<~/.staticperlrc>.
		938
846	=back	939	=back
847		940
848	=head4 Variables you probably I<do not want> to override	941	=head4 Variables you probably I<do not want> to override
849		942
850	=over 4	943	=over 4
…		…
868	=head3 OVERRIDABLE HOOKS	961	=head3 OVERRIDABLE HOOKS
869		962
870	In addition to environment variables, it is possible to provide some	963	In addition to environment variables, it is possible to provide some
871	shell functions that are called at specific times. To provide your own	964	shell functions that are called at specific times. To provide your own
872	commands, just define the corresponding function.	965	commands, just define the corresponding function.
		966
		967	The actual order in which hooks are invoked during a full install
		968	from scratch is C<preconfigure>, C<patchconfig>, C<postconfigure>,
		969	C<postbuild>, C<postinstall>.
873		970
874	Example: install extra modules from CPAN and from some directories	971	Example: install extra modules from CPAN and from some directories
875	at F<staticperl install> time.	972	at F<staticperl install> time.
876		973
877	postinstall() {	974	postinstall() {
…		…
884		981
885	=over 4	982	=over 4
886		983
887	=item preconfigure	984	=item preconfigure
888		985
889	Called just before running F<./Configur> in the perl source	986	Called just before running F<./Configure> in the perl source
890	directory. Current working directory is the perl source directory.	987	directory. Current working directory is the perl source directory.
891		988
892	This can be used to set any C<PERL_xxx> variables, which might be costly	989	This can be used to set any C<PERL_xxx> variables, which might be costly
893	to compute.	990	to compute.
894		991
		992	=item patchconfig
		993
		994	Called after running F<./Configure> in the perl source directory to create
		995	F<./config.sh>, but before running F<./Configure -S> to actually apply the
		996	config. Current working directory is the perl source directory.
		997
		998	Can be used to tailor/patch F<config.sh> or do any other modifications.
		999
895	=item postconfigure	1000	=item postconfigure
896		1001
897	Called after configuring, but before building perl. Current working	1002	Called after configuring, but before building perl. Current working
898	directory is the perl source directory.	1003	directory is the perl source directory.
899
900	Could be used to tailor/patch config.sh (followed by F<sh Configure -S>)
901	or do any other modifications.
902		1004
903	=item postbuild	1005	=item postbuild
904		1006
905	Called after building, but before installing perl. Current working	1007	Called after building, but before installing perl. Current working
906	directory is the perl source directory.	1008	directory is the perl source directory.
…		…
944	A header file that contains the prototypes of the few symbols "exported"	1046	A header file that contains the prototypes of the few symbols "exported"
945	by bundle.c, and also exposes the perl headers to the application.	1047	by bundle.c, and also exposes the perl headers to the application.
946		1048
947	=over 4	1049	=over 4
948		1050
949	=item staticperl_init ()	1051	=item staticperl_init (xs_init = 0)
950		1052
951	Initialises the perl interpreter. You can use the normal perl functions	1053	Initialises the perl interpreter. You can use the normal perl functions
952	after calling this function, for example, to define extra functions or	1054	after calling this function, for example, to define extra functions or
953	to load a .pm file that contains some initialisation code, or the main	1055	to load a .pm file that contains some initialisation code, or the main
954	program function:	1056	program function:
…		…
961	}	1063	}
962		1064
963	static void	1065	static void
964	run_myapp(void)	1066	run_myapp(void)
965	{	1067	{
966	staticperl_init ();	1068	staticperl_init (0);
967	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");	1069	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");
968	eval_pv ("require myapp::main", 1); // executes "myapp/main.pm"	1070	eval_pv ("require myapp::main", 1); // executes "myapp/main.pm"
969	}	1071	}
970		1072
		1073	When your bootcode already wants to access some XS functions at
		1074	compiletime, then you need to supply an C<xs_init> function pointer that
		1075	is called as soon as perl is initialised enough to define XS functions,
		1076	but before the preamble code is executed:
		1077
		1078	static void
		1079	xs_init (pTHX)
		1080	{
		1081	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");
		1082	}
		1083
		1084	static void
		1085	run_myapp(void)
		1086	{
		1087	staticperl_init (xs_init);
		1088	}
		1089
		1090	=item staticperl_cleanup ()
		1091
		1092	In the unlikely case that you want to destroy the perl interpreter, here
		1093	is the corresponding function.
		1094
971	=item staticperl_xs_init (pTHX)	1095	=item staticperl_xs_init (pTHX)
972		1096
973	Sometimes you need direct control over C<perl_parse> and C<perl_run>, in	1097	Sometimes you need direct control over C<perl_parse> and C<perl_run>, in
974	which case you do not want to use C<staticperl_init> but call them on your	1098	which case you do not want to use C<staticperl_init> but call them on your
975	own.	1099	own.
976		1100
977	Then you need this function - either pass it directly as the C<xs_init>	1101	Then you need this function - either pass it directly as the C<xs_init>
978	function to C<perl_parse>, or call it from your own C<xs_init> function.	1102	function to C<perl_parse>, or call it as one of the first things from your
979		1103	own C<xs_init> function.
980	=item staticperl_cleanup ()
981
982	In the unlikely case that you want to destroy the perl interpreter, here
983	is the corresponding function.
984		1104
985	=item PerlInterpreter *staticperl	1105	=item PerlInterpreter *staticperl
986		1106
987	The perl interpreter pointer used by staticperl. Not normally so useful,	1107	The perl interpreter pointer used by staticperl. Not normally so useful,
988	but there it is.	1108	but there it is.
…		…
1024		1144
1025	Returns the list of all paths embedded in this binary.	1145	Returns the list of all paths embedded in this binary.
1026		1146
1027	=back	1147	=back
1028		1148
1029	=head1 FULLY STATIC BINARIES - BUILDROOT	1149	=head1 FULLY STATIC BINARIES - UCLIBC AND BUILDROOT
1030		1150
1031	To make truly static (Linux-) libraries, you might want to have a look at	1151	To make truly static (Linux-) libraries, you might want to have a look at
1032	buildroot (L<http://buildroot.uclibc.org/>).	1152	buildroot (L<http://buildroot.uclibc.org/>).
1033		1153
1034	Buildroot is primarily meant to set up a cross-compile environment (which	1154	Buildroot is primarily meant to set up a cross-compile environment (which
…		…
1041	good experiences with GCC 4.4.x but not GCC 4.5.	1161	good experiences with GCC 4.4.x but not GCC 4.5.
1042		1162
1043	To minimise code size, I used C<-pipe -ffunction-sections -fdata-sections	1163	To minimise code size, I used C<-pipe -ffunction-sections -fdata-sections
1044	-finline-limit=8 -fno-builtin-strlen -mtune=i386>. The C<-mtune=i386>	1164	-finline-limit=8 -fno-builtin-strlen -mtune=i386>. The C<-mtune=i386>
1045	doesn't decrease codesize much, but it makes the file much more	1165	doesn't decrease codesize much, but it makes the file much more
1046	compressible.	1166	compressible (and the execution a lot slower...).
1047		1167
1048	If you don't need Coro or threads, you can go with "linuxthreads.old" (or	1168	If you don't need Coro or threads, you can go with "linuxthreads.old" (or
1049	no thread support). For Coro, it is highly recommended to switch to a	1169	no thread support). For Coro, it is highly recommended to switch to a
1050	uClibc newer than 0.9.31 (at the time of this writing, I used the 20101201	1170	uClibc newer than 0.9.31 (at the time of this writing, I used the 20101201
1051	snapshot) and enable NPTL, otherwise Coro needs to be configured with the	1171	snapshot) and enable NPTL, otherwise Coro needs to be configured with the
…		…
1053	twice the address space needed for stacks).	1173	twice the address space needed for stacks).
1054		1174
1055	If you use C<linuxthreads.old>, then you should also be aware that	1175	If you use C<linuxthreads.old>, then you should also be aware that
1056	uClibc shares C<errno> between all threads when statically linking. See	1176	uClibc shares C<errno> between all threads when statically linking. See
1057	L<http://lists.uclibc.org/pipermail/uclibc/2010-June/044157.html> for a	1177	L<http://lists.uclibc.org/pipermail/uclibc/2010-June/044157.html> for a
1058	workaround (And L<https://bugs.uclibc.org/2089> for discussion).	1178	workaround (and L<https://bugs.uclibc.org/2089> for discussion).
1059		1179
1060	C<ccache> support is also recommended, especially if you want	1180	C<ccache> support is also recommended, especially if you want
1061	to play around with buildroot options. Enabling the C<miniperl>	1181	to play around with buildroot options. Enabling the C<miniperl>
1062	package will probably enable all options required for a successful	1182	package will probably enable all options required for a successful
1063	perl build. F<staticperl> itself additionally needs either C<wget>	1183	perl build. F<staticperl> itself additionally needs either C<wget>
…		…
1071	it from working properly in a chroot - either use dash (and link it to	1191	it from working properly in a chroot - either use dash (and link it to
1072	F</bin/sh> inside the chroot) or link busybox to F</bin/sh>, using it's	1192	F</bin/sh> inside the chroot) or link busybox to F</bin/sh>, using it's
1073	built-in ash shell.	1193	built-in ash shell.
1074		1194
1075	Finally, you need F</dev/null> inside the chroot for many scripts to work	1195	Finally, you need F</dev/null> inside the chroot for many scripts to work
1076	- F<cp /dev/null output/target/dev> or bind-mounting your F</dev> will	1196	- either F<cp /dev/null output/target/dev> or bind-mounting your F</dev>
1077	both provide this.	1197	will provide this.
1078		1198
1079	After you have compiled and set up your buildroot target, you can copy	1199	After you have compiled and set up your buildroot target, you can copy
1080	F<staticperl> from the C<App::Staticperl> distribution or from your	1200	F<staticperl> from the C<App::Staticperl> distribution or from your
1081	perl f<bin> directory (if you installed it) into the F<output/target>	1201	perl F<bin> directory (if you installed it) into the F<output/target>
1082	filesystem, chroot inside and run it.	1202	filesystem, chroot inside and run it.
1083		1203
1084	=head1 RECIPES / SPECIFIC MODULES	1204	=head1 RECIPES / SPECIFIC MODULES
1085		1205
1086	This section contains some common(?) recipes and information about	1206	This section contains some common(?) recipes and information about
…		…
1095		1215
1096	Some functionality in the utf8 module, such as swash handling (used	1216	Some functionality in the utf8 module, such as swash handling (used
1097	for unicode character ranges in regexes) is implemented in the	1217	for unicode character ranges in regexes) is implemented in the
1098	C<"utf8_heavy.pl"> library:	1218	C<"utf8_heavy.pl"> library:
1099		1219
1100	-M'"utf8_heavy.pl"'	1220	-Mutf8_heavy.pl
1101		1221
1102	Many Unicode properties in turn are defined in separate modules,	1222	Many Unicode properties in turn are defined in separate modules,
1103	such as C<"unicore/Heavy.pl"> and more specific data tables such as	1223	such as C<"unicore/Heavy.pl"> and more specific data tables such as
1104	C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables	1224	C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables
1105	are big (7MB uncompressed, although F<staticperl> contains special	1225	are big (7MB uncompressed, although F<staticperl> contains special
1106	handling for those files), so including them on demand by your application	1226	handling for those files), so including them on demand by your application
1107	only might pay off.	1227	only might pay off.
1108		1228
1109	To simply include the whole unicode database, use:	1229	To simply include the whole unicode database, use:
1110		1230
1111	--incglob '/unicore/*.pl'	1231	--incglob '/unicore/**.pl'
1112		1232
1113	=item AnyEvent	1233	=item AnyEvent
1114		1234
1115	AnyEvent needs a backend implementation that it will load in a delayed	1235	AnyEvent needs a backend implementation that it will load in a delayed
1116	fashion. The L<AnyEvent::Impl::Perl> backend is the default choice	1236	fashion. The L<AnyEvent::Impl::Perl> backend is the default choice
…		…
1121		1241
1122	If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn	1242	If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn
1123	functions), you also need to include C<"AnyEvent/Util/idna.pl"> and	1243	functions), you also need to include C<"AnyEvent/Util/idna.pl"> and
1124	C<"AnyEvent/Util/uts46data.pl">.	1244	C<"AnyEvent/Util/uts46data.pl">.
1125		1245
1126	Or you can use C<--usepacklist> and specify C<-MAnyEvent> to include	1246	Or you can use C<--usepacklists> and specify C<-MAnyEvent> to include
1127	everything.	1247	everything.
		1248
		1249	=item Cairo
		1250
		1251	See Glib, same problem, same solution.
1128		1252
1129	=item Carp	1253	=item Carp
1130		1254
1131	Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of	1255	Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of
1132	perl 5.12.2 (maybe earlier), this dependency no longer exists.	1256	perl 5.12.2 (maybe earlier), this dependency no longer exists.
…		…
1135		1259
1136	The F<perl -V> switch (as well as many modules) needs L<Config>, which in	1260	The F<perl -V> switch (as well as many modules) needs L<Config>, which in
1137	turn might need L<"Config_heavy.pl">. Including the latter gives you	1261	turn might need L<"Config_heavy.pl">. Including the latter gives you
1138	both.	1262	both.
1139		1263
		1264	=item Glib
		1265
		1266	Glib literally requires Glib to be installed already to build - it tries
		1267	to fake this by running Glib out of the build directory before being
		1268	built. F<staticperl> tries to work around this by forcing C<MAN1PODS> and
		1269	C<MAN3PODS> to be empty via the C<PERL_MM_OPT> environment variable.
		1270
		1271	=item Gtk2
		1272
		1273	See Pango, same problems, same solution.
		1274
		1275	=item Pango
		1276
		1277	In addition to the C<MAN3PODS> problem in Glib, Pango also routes around
		1278	L<ExtUtils::MakeMaker> by compiling its files on its own. F<staticperl>
		1279	tries to patch L<ExtUtils::MM_Unix> to route around Pango.
		1280
1140	=item Term::ReadLine::Perl	1281	=item Term::ReadLine::Perl
1141		1282
1142	Also needs L<Term::ReadLine::readline>, or C<--usepacklist>.	1283	Also needs L<Term::ReadLine::readline>, or C<--usepacklists>.
1143		1284
1144	=item URI	1285	=item URI
1145		1286
1146	URI implements schemes as separate modules - the generic URL scheme is	1287	URI implements schemes as separate modules - the generic URL scheme is
1147	implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If	1288	implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If
1148	you need to use any of these schemes, you should include these manually,	1289	you need to use any of these schemes, you should include these manually,
1149	or use C<--usepacklist>.	1290	or use C<--usepacklists>.
1150		1291
1151	=back	1292	=back
1152		1293
1153	=head2 RECIPES	1294	=head2 RECIPES
1154		1295
1155	=over 4	1296	=over 4
1156		1297
1157	=item Linking everything in	1298	=item Just link everything in
1158		1299
1159	To link just about everything installed in the perl library into a new	1300	To link just about everything installed in the perl library into a new
1160	perl, try this:	1301	perl, try this (the first time this runs it will take a long time, as a
		1302	lot of files need to be parsed):
1161		1303
1162	staticperl mkperl --strip ppi --incglob '*'	1304	staticperl mkperl -v --strip ppi --incglob '*'
1163		1305
		1306	If you don't mind the extra megabytes, this can be a very effective way of
		1307	creating bundles without having to worry about forgetting any modules.
		1308
		1309	You get even more useful variants of this method by first selecting
		1310	everything, and then excluding stuff you are reasonable sure not to need -
		1311	L<bigperl\|http://staticperl.schmorp.de/bigperl.html> uses this approach.
		1312
1164	=item Getting rid of netdb function	1313	=item Getting rid of netdb functions
1165		1314
1166	The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent>	1315	The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent>
1167	and so on) that few applications use. You can avoid compiling them in by	1316	and so on) that few applications use. You can avoid compiling them in by
1168	putting the following fragment into a C<preconfigure> hook:	1317	putting the following fragment into a C<preconfigure> hook:
1169		1318
…		…
1186	do	1335	do
1187	PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"	1336	PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"
1188	done	1337	done
1189	}	1338	}
1190		1339
1191	This mostly gains space when linking staticaly, as the functions will	1340	This mostly gains space when linking statically, as the functions will
1192	likely not be linked in. The gain for dynamically-linked binaries is	1341	likely not be linked in. The gain for dynamically-linked binaries is
1193	smaller.	1342	smaller.
1194		1343
1195	Also, this leaves C<gethostbyname> in - not only is it actually used	1344	Also, this leaves C<gethostbyname> in - not only is it actually used
1196	often, the L<Socket> module also exposes it, so leaving it out usually	1345	often, the L<Socket> module also exposes it, so leaving it out usually

Diff Legend

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

Comparing App-Staticperl/staticperl.pod (file contents): Revision 1.26 by root, Tue Dec 21 19:14:56 2010 UTC vs. Revision 1.43 by root, Sun Jun 26 17:26:52 2011 UTC

Diff Legend

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.26 by root, Tue Dec 21 19:14:56 2010 UTC vs.
Revision 1.43 by root, Sun Jun 26 17:26:52 2011 UTC