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

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.32 by root, Thu Jan 20 21:32:47 2011 UTC vs.
Revision 1.55 by root, Mon Mar 12 21:45:10 2012 UTC

…		…
1	=head1 NAME	1	=head1 NAME
2		2
3	staticperl - perl, libc, 100 modules, all in one 500kb file	3	staticperl - perl, libc, 100 modules, all in one standalone 500kb file
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	staticperl help # print the embedded documentation	7	staticperl help # print the embedded documentation
8	staticperl fetch # fetch and unpack perl sources	8	staticperl fetch # fetch and unpack perl sources
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 instsrc 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
19	staticperl mkapp appname <bundle-args...> # see documentation	20	staticperl mkapp appname <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
…		…
83	With F<staticperl>, the burden is mostly with the developer - only direct	84	With F<staticperl>, the burden is mostly with the developer - only direct
84	compile-time dependencies and L<AutoLoader> are handled automatically.	85	compile-time dependencies and L<AutoLoader> are handled automatically.
85	This means the modules to include often need to be tweaked manually.	86	This means the modules to include often need to be tweaked manually.
86		87
87	All this does not preclude more permissive modes to be implemented in	88	All this does not preclude more permissive modes to be implemented in
88	the future, but right now, you have to resolve state hidden dependencies	89	the future, but right now, you have to resolve hidden dependencies
89	manually.	90	manually.
90		91
91	=item * PAR works out of the box, F<staticperl> does not.	92	=item * PAR works out of the box, F<staticperl> does not.
92		93
93	Maintaining your own custom perl build can be a pain in the ass, and while	94	Maintaining your own custom perl build can be a pain in the ass, and while
…		…
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
…		…
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.
190		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
		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,
195	no magic is involved: you could just as well run it manually via	206	no magic is involved: you could just as well run it manually via
196	F<~/.staticperl/perl/bin/cpan>.	207	F<~/.staticperl/perl/bin/cpan>, except that F<staticperl> additionally
		208	sets the environment variable C<$PERL> to the path of the perl
		209	interpreter, which is handy in subshells.
197		210
198	Any additional arguments are simply passed to the F<cpan> command.	211	Any additional arguments are simply passed to the F<cpan> command.
199		212
200	=item F<staticperl instcpan> module...	213	=item F<staticperl instcpan> module...
201		214
…		…
252		265
253	# first make sure we have perl and the required modules	266	# first make sure we have perl and the required modules
254	staticperl instcpan AnyEvent::HTTPD	267	staticperl instcpan AnyEvent::HTTPD
255		268
256	# now build the perl	269	# now build the perl
257	staticperl mkperl -M'"Config_heavy.pl"' -MAnyEvent::Impl::Perl \	270	staticperl mkperl -MConfig_heavy.pl -MAnyEvent::Impl::Perl \
258	-MAnyEvent::HTTPD -MURI::http \	271	-MAnyEvent::HTTPD -MURI::http \
259	--add 'eg/httpd httpd.pm'	272	--add 'eg/httpd httpd.pm'
260		273
261	# finally, invoke it	274	# finally, invoke it
262	./perl -Mhttpd	275	./perl -Mhttpd
…		…
335	add eg/httpd httpd.pm	348	add eg/httpd httpd.pm
336		349
337	All options that specify modules or files to be added are processed in the	350	All options that specify modules or files to be added are processed in the
338	order given on the command line.	351	order given on the command line.
339		352
340	=head3 BUNDLE CREATION WORKFLOW / STATICPELR MKBUNDLE OPTIONS	353	=head3 BUNDLE CREATION WORKFLOW / STATICPERL MKBUNDLE OPTIONS
341		354
342	F<staticperl mkbundle> works by first assembling a list of candidate	355	F<staticperl mkbundle> works by first assembling a list of candidate
343	files and modules to include, then filtering them by include/exclude	356	files and modules to include, then filtering them by include/exclude
344	patterns. The remaining modules (together with their direct dependencies,	357	patterns. The remaining modules (together with their direct dependencies,
345	such as link libraries and L<AutoLoader> files) are then converted into	358	such as link libraries and L<AutoLoader> files) are then converted into
…		…
381		394
382	=over 4	395	=over 4
383		396
384	=item C<--use> F<module> \| C<-M>F<module>	397	=item C<--use> F<module> \| C<-M>F<module>
385		398
386	Include the named module and trace direct dependencies. This is done by	399	Include the named module or perl library and trace direct
387	C<use>'ing the module from a fresh package in a subprocess and tracing	400	dependencies. This is done by loading the module in a subprocess and
388	which other modules and files it actually loads.	401	tracing which other modules and files it actually loads.
389		402
390	Example: include AnyEvent and AnyEvent::Impl::Perl.	403	Example: include AnyEvent and AnyEvent::Impl::Perl.
391		404
392	staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl	405	staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl
393		406
394	Sometimes you want to load old-style "perl libraries" (F<.pl> files),	407	Sometimes you want to load old-style "perl libraries" (F<.pl> files), or
395	or maybe other weirdly named files. To do that, you need to quote	408	maybe other weirdly named files. To support this, the C<--use> option
396	the name in single or double quotes (this is because F<staticperl>	409	actually tries to do what you mean, depending on the string you specify:
397	I<literally> just adds the string after the C<require> - which acts	410
398	different when confronted with quoted vs. unquoted strings). When given on	411	=over 4
399	the command line, you probably need to quote once more to avoid your shell	412
400	interpreting it. Common cases that need this are F<Config_heavy.pl> and	413	=item a possibly valid module name, e.g. F<common::sense>, F<Carp>,
401	F<utf8_heavy.pl>.	414	F<Coro::Mysql>.
		415
		416	If the string contains no quotes, no F</> and no F<.>, then C<--use>
		417	assumes that it is a normal module name. It will create a new package and
		418	evaluate a C<use module> in it, i.e. it will load the package and do a
		419	default import.
		420
		421	The import step is done because many modules trigger more dependencies
		422	when something is imported than without.
		423
		424	=item anything that contains F</> or F<.> characters,
		425	e.g. F<utf8_heavy.pl>, F<Module/private/data.pl>.
		426
		427	The string will be quoted and passed to require, as if you used C<require
		428	$module>. Nothing will be imported.
		429
		430	=item "path" or 'path', e.g. C<"utf8_heavy.pl">.
		431
		432	If you enclose the name into single or double quotes, then the quotes will
		433	be removed and the resulting string will be passed to require. This syntax
		434	is form compatibility with older versions of staticperl and should not be
		435	used anymore.
		436
		437	=back
		438
		439	Example: C<use> AnyEvent::Socket, once using C<use> (importing the
		440	symbols), and once via C<require>, not importing any symbols. The first
		441	form is preferred as many modules load some extra dependencies when asked
		442	to export symbols.
		443
		444	staticperl mkbundle -MAnyEvent::Socket # use + import
		445	staticperl mkbundle -MAnyEvent/Socket.pm # require only
402		446
403	Example: include the required files for F<perl -V> to work in all its	447	Example: include the required files for F<perl -V> to work in all its
404	glory (F<Config.pm> is included automatically by this).	448	glory (F<Config.pm> is included automatically by the dependency tracker).
405		449
406	# bourne shell	450	# shell command
407	staticperl mkbundle --use '"Config_heavy.pl"'	451	staticperl mkbundle -MConfig_heavy.pl
408		452
409	# bundle specification file	453	# bundle specification file
410	use "Config_heavy.pl"	454	use Config_heavy.pl
411		455
412	The C<-M>module syntax is included as a convenience that might be easier	456	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	457	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	458	to load modules. Or maybe it confuses people. Time will tell. Or maybe
415	not. Sigh.	459	not. Sigh.
…		…
467	--incglob '/unicore/**.pl'	511	--incglob '/unicore/**.pl'
468		512
469	=item C<--add> F<file> \| C<--add> "F<file> alias"	513	=item C<--add> F<file> \| C<--add> "F<file> alias"
470		514
471	Adds the given (perl) file into the bundle (and optionally call it	515	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	516	"alias"). The F<file> is either an absolute path or a path relative to the
473	the current directory. If an alias is specified, then this is the name it	517	current directory. If an alias is specified, then this is the name it will
474	will use for C<@INC> searches, otherwise the F<file> will be used as the	518	use for C<@INC> searches, otherwise the path F<file> will be used as the
475	internal name.	519	internal name.
476		520
477	This switch is used to include extra files into the bundle.	521	This switch is used to include extra files into the bundle.
478		522
479	Example: embed the file F<httpd> in the current directory as F<httpd.pm>	523	Example: embed the file F<httpd> in the current directory as F<httpd.pm>
480	when creating the bundle.	524	when creating the bundle.
481		525
482	staticperl mkperl --add "httpd httpd.pm"	526	staticperl mkperl --add "httpd httpd.pm"
		527
		528	# can be accessed via "use httpd"
		529
		530	Example: add a file F<initcode> from the current directory.
		531
		532	staticperl mkperl --add 'initcode &initcode'
		533
		534	# can be accessed via "do '&initcode'"
483		535
484	Example: add local files as extra modules in the bundle.	536	Example: add local files as extra modules in the bundle.
485		537
486	# specification file	538	# specification file
487	add file1 myfiles/file1.pm	539	add file1 myfiles/file1.pm
…		…
491	# then later, in perl, use	543	# then later, in perl, use
492	use myfiles::file1;	544	use myfiles::file1;
493	require myfiles::file2;	545	require myfiles::file2;
494	my $res = do "myfiles/file3.pl";	546	my $res = do "myfiles/file3.pl";
495		547
496	=item C<--binadd> F<file> \| C<--add> "F<file> alias"	548	=item C<--binadd> F<file> \| C<--binadd> "F<file> alias"
497		549
498	Just like C<--add>, except that it treats the file as binary and adds it	550	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	551	without any postprocessing (perl files might get stripped to reduce their
500	size).	552	size).
501		553
502	You should probably add a C</> prefix to avoid clashing with embedded perl	554	If you specify an alias you should probably add a C</> prefix to avoid
503	files (whose paths do not start with C</>), and/or use a special directory	555	clashing with embedded perl files (whose paths never start with C</>),
504	prefix, such as C</res/name>.	556	and/or use a special directory prefix, such as C</res/name>.
505		557
506	You can later get a copy of these files by calling C<staticperl::find	558	You can later get a copy of these files by calling C<static::find
507	"alias">.	559	"alias">.
508		560
509	An alternative way to embed binary files is to convert them to perl and	561	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	562	use C<do> to get the contents - this method is a bit cumbersome, but works
511	both inside and outside of a staticperl bundle:	563	both inside and outside of a staticperl bundle, without extra ado:
512		564
513	# a "binary" file, call it "bindata.pl"	565	# a "binary" file, call it "bindata.pl"
514	<<'SOME_MARKER'	566	<<'SOME_MARKER'
515	binary data NOT containing SOME_MARKER	567	binary data NOT containing SOME_MARKER
516	SOME_MARKER	568	SOME_MARKER
517		569
518	# load the binary	570	# load the binary
519	chomp (my $data = do "bindata.pl");	571	chomp (my $data = do "bindata.pl");
		572
		573	=item C<--allow-dynamic>
		574
		575	By default, when F<mkbundle> hits a dynamic perl extension (e.g. a F<.so>
		576	or F<.dll> file), it will stop with a fatal error.
		577
		578	When this option is enabled, F<mkbundle> packages the shared
		579	object into the bundle instead, with a prefix of F<!>
		580	(e.g. F<!auto/List/Util/Util.so>). What you do with that is currently up
		581	to you, F<staticperl> has no special support for this at the moment, apart
		582	from working around the lack of availability of F<PerlIO::scalar> while
		583	bootstrapping, at a speed cost.
		584
		585	One way to deal with this is to write all files starting with F<!> into
		586	some directory and then C<unshift> that path onto C<@INC>.
		587
		588	#TODO: example
520		589
521	=back	590	=back
522		591
523	=item Step 2: filter all files using C<--include> and C<--exclude> options.	592	=item Step 2: filter all files using C<--include> and C<--exclude> options.
524		593
…		…
664	The difference to the (mutually exclusive) C<--perl> option is that the	733	The difference to the (mutually exclusive) C<--perl> option is that the
665	binary created by this option will not try to act as a perl interpreter -	734	binary created by this option will not try to act as a perl interpreter -
666	instead it will simply initialise the perl interpreter, clean it up and	735	instead it will simply initialise the perl interpreter, clean it up and
667	exit.	736	exit.
668		737
669	This means that, by default, it will do nothing but burna few CPU cycles	738	This means that, by default, it will do nothing but burn a few CPU cycles
670	- for it to do something useful you I<must> add some boot code, e.g. with	739	- for it to do something useful you I<must> add some boot code, e.g. with
671	the C<--boot> option.	740	the C<--boot> option.
672		741
673	Example: create a standalone perl binary called F<./myexe> that will	742	Example: create a standalone perl binary called F<./myexe> that will
674	execute F<appfile> when it is started.	743	execute F<appfile> when it is started.
675		744
676	staticperl mkbundle --app myexe --boot appfile	745	staticperl mkbundle --app myexe --boot appfile
		746
		747	=item C<--ignore-env>
		748
		749	Generates extra code to unset some environment variables before
		750	initialising/running perl. Perl supports a lot of environment variables
		751	that might alter execution in ways that might be undesirablre for
		752	standalone applications, and this option removes those known to cause
		753	trouble.
		754
		755	Specifically, these are removed:
		756
		757	C<PERL_HASH_SEED_DEBUG> and C<PERL_DEBUG_MSTATS> can cause undesirable
		758	output, C<PERL5OPT>, C<PERL_DESTRUCT_LEVEL>, C<PERL_HASH_SEED> and
		759	C<PERL_SIGNALS> can alter execution significantly, and C<PERL_UNICODE>,
		760	C<PERLIO_DEBUG> and C<PERLIO> can affect input and output.
		761
		762	The variables C<PERL_LIB> and C<PERL5_LIB> are always ignored because the
		763	startup code used by F<staticperl> overrides C<@INC> in all cases.
		764
		765	This option will not make your program more secure (unless you are
		766	running with elevated privileges), but it will reduce the surprise effect
		767	when a user has these environment variables set and doesn't expect your
		768	standalone program to act like a perl interpreter.
677		769
678	=item C<--static>	770	=item C<--static>
679		771
680	Add C<-static> to F<bundle.ldopts>, which means a fully static (if	772	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	773	supported by the OS) executable will be created. This is not immensely
…		…
809	=item C<STATICPERL>	901	=item C<STATICPERL>
810		902
811	The directory where staticperl stores all its files	903	The directory where staticperl stores all its files
812	(default: F<~/.staticperl>).	904	(default: F<~/.staticperl>).
813		905
		906	=item C<DLCACHE>
		907
		908	The path to a directory (will be created if it doesn't exist) where
		909	downloaded perl sources are being cached, to avoid downloading them
		910	again. The default is empty, which means there is no cache.
		911
		912	=item C<PERL_VERSION>
		913
		914	The perl version to install - default is currently C<5.12.3>, but C<5.8.9>
		915	is also a good choice (5.8.9 is much smaller than 5.12.3, while 5.10.1 is
		916	about as big as 5.12.3).
		917
814	=item C<PERL_MM_USE_DEFAULT>, C<EV_EXTRA_DEFS>, ...	918	=item C<PERL_MM_USE_DEFAULT>, C<EV_EXTRA_DEFS>, ...
815		919
816	Usually set to C<1> to make modules "less inquisitive" during their	920	Usually set to C<1> to make modules "less inquisitive" during their
817	installation, you can set any environment variable you want - some modules	921	installation. You can set (and export!) any environment variable you want
818	(such as L<Coro> or L<EV>) use environment variables for further tweaking.	922	- some modules (such as L<Coro> or L<EV>) use environment variables for
819		923	further tweaking.
820	=item C<PERL_VERSION>
821
822	The perl version to install - default is currently C<5.12.2>, but C<5.8.9>
823	is also a good choice (5.8.9 is much smaller than 5.12.2, while 5.10.1 is
824	about as big as 5.12.2).
825		924
826	=item C<PERL_PREFIX>	925	=item C<PERL_PREFIX>
827		926
828	The prefix where perl gets installed (default: F<$STATICPERL/perl>),	927	The prefix where perl gets installed (default: F<$STATICPERL/perl>),
829	i.e. where the F<bin> and F<lib> subdirectories will end up.	928	i.e. where the F<bin> and F<lib> subdirectories will end up.
…		…
850	F<~/.staticperlrc> to override them.	949	F<~/.staticperlrc> to override them.
851		950
852	Most of the variables override (or modify) the corresponding F<Configure>	951	Most of the variables override (or modify) the corresponding F<Configure>
853	variable, except C<PERL_CCFLAGS>, which gets appended.	952	variable, except C<PERL_CCFLAGS>, which gets appended.
854		953
		954	The default for C<PERL_OPTIMIZE> is C<-Os> (assuming gcc), and for
		955	C<PERL_LIBS> is C<-lm -lcrypt>, which should be good for most (but not
		956	all) systems.
		957
		958	For other compilers or more customised optimisation settings, you need to
		959	adjust these, e.g. in your F<~/.staticperlrc>.
		960
		961	With gcc on x86 and amd64, you can get more space-savings by using:
		962
		963	-Os -ffunction-sections -fdata-sections -finline-limit=8 -mpush-args
		964	-mno-inline-stringops-dynamically -mno-align-stringops
		965
		966	And on x86 and pentium3 and newer (basically everything you might ever
		967	want to run on), adding these is even better for space-savings (use
		968	-mtune=core2 or something newer for much faster code, too):
		969
		970	-fomit-frame-pointer -march=pentium3 -mtune=i386
		971
855	=back	972	=back
856		973
857	=head4 Variables you probably I<do not want> to override	974	=head4 Variables you probably I<do not want> to override
858		975
859	=over 4	976	=over 4
…		…
877	=head3 OVERRIDABLE HOOKS	994	=head3 OVERRIDABLE HOOKS
878		995
879	In addition to environment variables, it is possible to provide some	996	In addition to environment variables, it is possible to provide some
880	shell functions that are called at specific times. To provide your own	997	shell functions that are called at specific times. To provide your own
881	commands, just define the corresponding function.	998	commands, just define the corresponding function.
		999
		1000	The actual order in which hooks are invoked during a full install
		1001	from scratch is C<preconfigure>, C<patchconfig>, C<postconfigure>,
		1002	C<postbuild>, C<postinstall>.
882		1003
883	Example: install extra modules from CPAN and from some directories	1004	Example: install extra modules from CPAN and from some directories
884	at F<staticperl install> time.	1005	at F<staticperl install> time.
885		1006
886	postinstall() {	1007	postinstall() {
…		…
893		1014
894	=over 4	1015	=over 4
895		1016
896	=item preconfigure	1017	=item preconfigure
897		1018
898	Called just before running F<./Configur> in the perl source	1019	Called just before running F<./Configure> in the perl source
899	directory. Current working directory is the perl source directory.	1020	directory. Current working directory is the perl source directory.
900		1021
901	This can be used to set any C<PERL_xxx> variables, which might be costly	1022	This can be used to set any C<PERL_xxx> variables, which might be costly
902	to compute.	1023	to compute.
903		1024
		1025	=item patchconfig
		1026
		1027	Called after running F<./Configure> in the perl source directory to create
		1028	F<./config.sh>, but before running F<./Configure -S> to actually apply the
		1029	config. Current working directory is the perl source directory.
		1030
		1031	Can be used to tailor/patch F<config.sh> or do any other modifications.
		1032
904	=item postconfigure	1033	=item postconfigure
905		1034
906	Called after configuring, but before building perl. Current working	1035	Called after configuring, but before building perl. Current working
907	directory is the perl source directory.	1036	directory is the perl source directory.
908
909	Could be used to tailor/patch config.sh (followed by F<sh Configure -S>)
910	or do any other modifications.
911		1037
912	=item postbuild	1038	=item postbuild
913		1039
914	Called after building, but before installing perl. Current working	1040	Called after building, but before installing perl. Current working
915	directory is the perl source directory.	1041	directory is the perl source directory.
…		…
953	A header file that contains the prototypes of the few symbols "exported"	1079	A header file that contains the prototypes of the few symbols "exported"
954	by bundle.c, and also exposes the perl headers to the application.	1080	by bundle.c, and also exposes the perl headers to the application.
955		1081
956	=over 4	1082	=over 4
957		1083
958	=item staticperl_init ()	1084	=item staticperl_init (xs_init = 0)
959		1085
960	Initialises the perl interpreter. You can use the normal perl functions	1086	Initialises the perl interpreter. You can use the normal perl functions
961	after calling this function, for example, to define extra functions or	1087	after calling this function, for example, to define extra functions or
962	to load a .pm file that contains some initialisation code, or the main	1088	to load a .pm file that contains some initialisation code, or the main
963	program function:	1089	program function:
…		…
970	}	1096	}
971		1097
972	static void	1098	static void
973	run_myapp(void)	1099	run_myapp(void)
974	{	1100	{
975	staticperl_init ();	1101	staticperl_init (0);
976	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");	1102	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");
977	eval_pv ("require myapp::main", 1); // executes "myapp/main.pm"	1103	eval_pv ("require myapp::main", 1); // executes "myapp/main.pm"
978	}	1104	}
979		1105
		1106	When your bootcode already wants to access some XS functions at
		1107	compiletime, then you need to supply an C<xs_init> function pointer that
		1108	is called as soon as perl is initialised enough to define XS functions,
		1109	but before the preamble code is executed:
		1110
		1111	static void
		1112	xs_init (pTHX)
		1113	{
		1114	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");
		1115	}
		1116
		1117	static void
		1118	run_myapp(void)
		1119	{
		1120	staticperl_init (xs_init);
		1121	}
		1122
		1123	=item staticperl_cleanup ()
		1124
		1125	In the unlikely case that you want to destroy the perl interpreter, here
		1126	is the corresponding function.
		1127
980	=item staticperl_xs_init (pTHX)	1128	=item staticperl_xs_init (pTHX)
981		1129
982	Sometimes you need direct control over C<perl_parse> and C<perl_run>, in	1130	Sometimes you need direct control over C<perl_parse> and C<perl_run>, in
983	which case you do not want to use C<staticperl_init> but call them on your	1131	which case you do not want to use C<staticperl_init> but call them on your
984	own.	1132	own.
985		1133
986	Then you need this function - either pass it directly as the C<xs_init>	1134	Then you need this function - either pass it directly as the C<xs_init>
987	function to C<perl_parse>, or call it from your own C<xs_init> function.	1135	function to C<perl_parse>, or call it as one of the first things from your
988		1136	own C<xs_init> function.
989	=item staticperl_cleanup ()
990
991	In the unlikely case that you want to destroy the perl interpreter, here
992	is the corresponding function.
993		1137
994	=item PerlInterpreter *staticperl	1138	=item PerlInterpreter *staticperl
995		1139
996	The perl interpreter pointer used by staticperl. Not normally so useful,	1140	The perl interpreter pointer used by staticperl. Not normally so useful,
997	but there it is.	1141	but there it is.
…		…
1010		1154
1011	=back	1155	=back
1012		1156
1013	=head1 RUNTIME FUNCTIONALITY	1157	=head1 RUNTIME FUNCTIONALITY
1014		1158
1015	Binaries created with C<mkbundle>/C<mkperl> contain extra functions, which	1159	Binaries created with C<mkbundle>/C<mkperl> contain extra functionality,
1016	are required to access the bundled perl sources, but might be useful for	1160	mostly related to the extra files bundled in the binary (the virtual
1017	other purposes.	1161	filesystem). All of this data is statically compiled into the binary, and
		1162	accessing means copying it from a read-only section of your binary. Data
		1163	pages in this way is usually freed by the operating system, as it isn't
		1164	use more the onace.
		1165
		1166	=head2 VIRTUAL FILESYSTEM
		1167
		1168	Every bundle has a virtual filesystem. The only information stored in it
		1169	is the path and contents of each file that was bundled.
		1170
		1171	=head3 LAYOUT
		1172
		1173	Any path starting with an ampersand (F<&>) or exclamation mark (F<!>) are
		1174	reserved by F<staticperl>. They must only be used as described in this
		1175	section.
		1176
		1177	=over 4
		1178
		1179	=item !
		1180
		1181	All files that typically cannot be loaded from memory (such as dynamic
		1182	objects or shared libraries), but have to reside in the filesystem, are
		1183	prefixed with F<!>. Typically these files get written out to some
		1184	(semi-)temporary directory shortly after program startup, or before being
		1185	used.
		1186
		1187	=item !boot
		1188
		1189	The bootstrap file, if specified during bundling.
		1190
		1191	=item !auto/
		1192
		1193	Shared objects or dlls corresponding to dynamically-linked perl extensions
		1194	are stored with an F<!auto/> prefix.
		1195
		1196	=item !lib/
		1197
		1198	External shared libraries are stored in this directory.
		1199
		1200	=item any letter
		1201
		1202	Any path starting with a letter is a perl library file. For example,
		1203	F<Coro/AIO.pm> corresponds to the file loaded by C<use Coro::AIO>, and
		1204	F<Coro/jit.pl> corresponds to C<require "Coro/jit.pl">.
		1205
		1206	Obviously, module names shouldn't start with any other characters than
		1207	letters :)
		1208
		1209	=back
		1210
		1211	=head3 FUNCTIONS
		1212
		1213	=over 4
		1214
		1215	=item $file = static::find $path
		1216
		1217	Returns the data associated with the given C<$path>
		1218	(e.g. C<Digest/MD5.pm>, C<auto/POSIX/autosplit.ix>).
		1219
		1220	Returns C<undef> if the file isn't embedded.
		1221
		1222	=item @paths = static::list
		1223
		1224	Returns the list of all paths embedded in this binary.
		1225
		1226	=back
		1227
		1228	=head2 EXTRA FEATURES
1018		1229
1019	In addition, for the embedded loading of perl files to work, F<staticperl>	1230	In addition, for the embedded loading of perl files to work, F<staticperl>
1020	overrides the C<@INC> array.	1231	overrides the C<@INC> array.
1021
1022	=over 4
1023
1024	=item $file = staticperl::find $path
1025
1026	Returns the data associated with the given C<$path>
1027	(e.g. C<Digest/MD5.pm>, C<auto/POSIX/autosplit.ix>), which is basically
1028	the UNIX path relative to the perl library directory.
1029
1030	Returns C<undef> if the file isn't embedded.
1031
1032	=item @paths = staticperl::list
1033
1034	Returns the list of all paths embedded in this binary.
1035
1036	=back
1037		1232
1038	=head1 FULLY STATIC BINARIES - UCLIBC AND BUILDROOT	1233	=head1 FULLY STATIC BINARIES - UCLIBC AND BUILDROOT
1039		1234
1040	To make truly static (Linux-) libraries, you might want to have a look at	1235	To make truly static (Linux-) libraries, you might want to have a look at
1041	buildroot (L<http://buildroot.uclibc.org/>).	1236	buildroot (L<http://buildroot.uclibc.org/>).
…		…
1050	good experiences with GCC 4.4.x but not GCC 4.5.	1245	good experiences with GCC 4.4.x but not GCC 4.5.
1051		1246
1052	To minimise code size, I used C<-pipe -ffunction-sections -fdata-sections	1247	To minimise code size, I used C<-pipe -ffunction-sections -fdata-sections
1053	-finline-limit=8 -fno-builtin-strlen -mtune=i386>. The C<-mtune=i386>	1248	-finline-limit=8 -fno-builtin-strlen -mtune=i386>. The C<-mtune=i386>
1054	doesn't decrease codesize much, but it makes the file much more	1249	doesn't decrease codesize much, but it makes the file much more
1055	compressible.	1250	compressible (and the execution a lot slower...).
1056		1251
1057	If you don't need Coro or threads, you can go with "linuxthreads.old" (or	1252	If you don't need Coro or threads, you can go with "linuxthreads.old" (or
1058	no thread support). For Coro, it is highly recommended to switch to a	1253	no thread support). For Coro, it is highly recommended to switch to a
1059	uClibc newer than 0.9.31 (at the time of this writing, I used the 20101201	1254	uClibc newer than 0.9.31 (at the time of this writing, I used the 20101201
1060	snapshot) and enable NPTL, otherwise Coro needs to be configured with the	1255	snapshot) and enable NPTL, otherwise Coro needs to be configured with the
…		…
1062	twice the address space needed for stacks).	1257	twice the address space needed for stacks).
1063		1258
1064	If you use C<linuxthreads.old>, then you should also be aware that	1259	If you use C<linuxthreads.old>, then you should also be aware that
1065	uClibc shares C<errno> between all threads when statically linking. See	1260	uClibc shares C<errno> between all threads when statically linking. See
1066	L<http://lists.uclibc.org/pipermail/uclibc/2010-June/044157.html> for a	1261	L<http://lists.uclibc.org/pipermail/uclibc/2010-June/044157.html> for a
1067	workaround (And L<https://bugs.uclibc.org/2089> for discussion).	1262	workaround (and L<https://bugs.uclibc.org/2089> for discussion).
1068		1263
1069	C<ccache> support is also recommended, especially if you want	1264	C<ccache> support is also recommended, especially if you want
1070	to play around with buildroot options. Enabling the C<miniperl>	1265	to play around with buildroot options. Enabling the C<miniperl>
1071	package will probably enable all options required for a successful	1266	package will probably enable all options required for a successful
1072	perl build. F<staticperl> itself additionally needs either C<wget>	1267	perl build. F<staticperl> itself additionally needs either C<wget>
…		…
1080	it from working properly in a chroot - either use dash (and link it to	1275	it from working properly in a chroot - either use dash (and link it to
1081	F</bin/sh> inside the chroot) or link busybox to F</bin/sh>, using it's	1276	F</bin/sh> inside the chroot) or link busybox to F</bin/sh>, using it's
1082	built-in ash shell.	1277	built-in ash shell.
1083		1278
1084	Finally, you need F</dev/null> inside the chroot for many scripts to work	1279	Finally, you need F</dev/null> inside the chroot for many scripts to work
1085	- F<cp /dev/null output/target/dev> or bind-mounting your F</dev> will	1280	- either F<cp /dev/null output/target/dev> or bind-mounting your F</dev>
1086	both provide this.	1281	will provide this.
1087		1282
1088	After you have compiled and set up your buildroot target, you can copy	1283	After you have compiled and set up your buildroot target, you can copy
1089	F<staticperl> from the C<App::Staticperl> distribution or from your	1284	F<staticperl> from the C<App::Staticperl> distribution or from your
1090	perl f<bin> directory (if you installed it) into the F<output/target>	1285	perl F<bin> directory (if you installed it) into the F<output/target>
1091	filesystem, chroot inside and run it.	1286	filesystem, chroot inside and run it.
1092		1287
1093	=head1 RECIPES / SPECIFIC MODULES	1288	=head1 RECIPES / SPECIFIC MODULES
1094		1289
1095	This section contains some common(?) recipes and information about	1290	This section contains some common(?) recipes and information about
…		…
1104		1299
1105	Some functionality in the utf8 module, such as swash handling (used	1300	Some functionality in the utf8 module, such as swash handling (used
1106	for unicode character ranges in regexes) is implemented in the	1301	for unicode character ranges in regexes) is implemented in the
1107	C<"utf8_heavy.pl"> library:	1302	C<"utf8_heavy.pl"> library:
1108		1303
1109	-M'"utf8_heavy.pl"'	1304	-Mutf8_heavy.pl
1110		1305
1111	Many Unicode properties in turn are defined in separate modules,	1306	Many Unicode properties in turn are defined in separate modules,
1112	such as C<"unicore/Heavy.pl"> and more specific data tables such as	1307	such as C<"unicore/Heavy.pl"> and more specific data tables such as
1113	C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables	1308	C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables
1114	are big (7MB uncompressed, although F<staticperl> contains special	1309	are big (7MB uncompressed, although F<staticperl> contains special
…		…
1133	C<"AnyEvent/Util/uts46data.pl">.	1328	C<"AnyEvent/Util/uts46data.pl">.
1134		1329
1135	Or you can use C<--usepacklists> and specify C<-MAnyEvent> to include	1330	Or you can use C<--usepacklists> and specify C<-MAnyEvent> to include
1136	everything.	1331	everything.
1137		1332
		1333	=item Cairo
		1334
		1335	See Glib, same problem, same solution.
		1336
1138	=item Carp	1337	=item Carp
1139		1338
1140	Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of	1339	Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of
1141	perl 5.12.2 (maybe earlier), this dependency no longer exists.	1340	perl 5.12.2 (maybe earlier), this dependency no longer exists.
1142		1341
1143	=item Config	1342	=item Config
1144		1343
1145	The F<perl -V> switch (as well as many modules) needs L<Config>, which in	1344	The F<perl -V> switch (as well as many modules) needs L<Config>, which in
1146	turn might need L<"Config_heavy.pl">. Including the latter gives you	1345	turn might need L<"Config_heavy.pl">. Including the latter gives you
1147	both.	1346	both.
		1347
		1348	=item Glib
		1349
		1350	Glib literally requires Glib to be installed already to build - it tries
		1351	to fake this by running Glib out of the build directory before being
		1352	built. F<staticperl> tries to work around this by forcing C<MAN1PODS> and
		1353	C<MAN3PODS> to be empty via the C<PERL_MM_OPT> environment variable.
		1354
		1355	=item Gtk2
		1356
		1357	See Pango, same problems, same solution.
		1358
		1359	=item Pango
		1360
		1361	In addition to the C<MAN3PODS> problem in Glib, Pango also routes around
		1362	L<ExtUtils::MakeMaker> by compiling its files on its own. F<staticperl>
		1363	tries to patch L<ExtUtils::MM_Unix> to route around Pango.
1148		1364
1149	=item Term::ReadLine::Perl	1365	=item Term::ReadLine::Perl
1150		1366
1151	Also needs L<Term::ReadLine::readline>, or C<--usepacklists>.	1367	Also needs L<Term::ReadLine::readline>, or C<--usepacklists>.
1152		1368

Diff Legend

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

Comparing App-Staticperl/staticperl.pod (file contents): Revision 1.32 by root, Thu Jan 20 21:32:47 2011 UTC vs. Revision 1.55 by root, Mon Mar 12 21:45:10 2012 UTC

Diff Legend

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.32 by root, Thu Jan 20 21:32:47 2011 UTC vs.
Revision 1.55 by root, Mon Mar 12 21:45:10 2012 UTC