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

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.35 by root, Thu Feb 10 22:44:29 2011 UTC vs.
Revision 1.59 by root, Mon Jul 6 23:33:15 2015 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.
…		…
499	# then later, in perl, use	543	# then later, in perl, use
500	use myfiles::file1;	544	use myfiles::file1;
501	require myfiles::file2;	545	require myfiles::file2;
502	my $res = do "myfiles/file3.pl";	546	my $res = do "myfiles/file3.pl";
503		547
504	=item C<--binadd> F<file> \| C<--add> "F<file> alias"	548	=item C<--addbin> F<file> \| C<--addbin> "F<file> alias"
505		549
506	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
507	without any postprocessing (perl files might get stripped to reduce their	551	without any postprocessing (perl files might get stripped to reduce their
508	size).	552	size).
509		553
510	If you specify an alias you should probably add a C<&> prefix to avoid	554	If you specify an alias you should probably add a C</> prefix to avoid
511	clashing with embedded perl files (whose paths never start with C<&>),	555	clashing with embedded perl files (whose paths never start with C</>),
512	and/or use a special directory prefix, such as C<&res/name>.	556	and/or use a special directory prefix, such as C</res/name>.
513		557
514	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
515	"alias">.	559	"alias">.
516		560
517	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
518	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
519	both inside and outside of a staticperl bundle:	563	both inside and outside of a staticperl bundle, without extra ado:
520		564
521	# a "binary" file, call it "bindata.pl"	565	# a "binary" file, call it "bindata.pl"
522	<<'SOME_MARKER'	566	<<'SOME_MARKER'
523	binary data NOT containing SOME_MARKER	567	binary data NOT containing SOME_MARKER
524	SOME_MARKER	568	SOME_MARKER
525		569
526	# load the binary	570	# load the binary
527	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
528		589
529	=back	590	=back
530		591
531	=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.
532		593
…		…
681	Example: create a standalone perl binary called F<./myexe> that will	742	Example: create a standalone perl binary called F<./myexe> that will
682	execute F<appfile> when it is started.	743	execute F<appfile> when it is started.
683		744
684	staticperl mkbundle --app myexe --boot appfile	745	staticperl mkbundle --app myexe --boot appfile
685		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.
		769
686	=item C<--static>	770	=item C<--static>
687		771
688	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
689	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
690	useful when just creating the bundle files, but is most useful when	774	useful when just creating the bundle files, but is most useful when
…		…
817	=item C<STATICPERL>	901	=item C<STATICPERL>
818		902
819	The directory where staticperl stores all its files	903	The directory where staticperl stores all its files
820	(default: F<~/.staticperl>).	904	(default: F<~/.staticperl>).
821		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
822	=item C<PERL_MM_USE_DEFAULT>, C<EV_EXTRA_DEFS>, ...	918	=item C<PERL_MM_USE_DEFAULT>, C<EV_EXTRA_DEFS>, ...
823		919
824	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
825	installation, you can set any environment variable you want - some modules	921	installation. You can set (and export!) any environment variable you want
826	(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
827		923	further tweaking.
828	=item C<PERL_VERSION>
829
830	The perl version to install - default is currently C<5.12.2>, but C<5.8.9>
831	is also a good choice (5.8.9 is much smaller than 5.12.2, while 5.10.1 is
832	about as big as 5.12.2).
833		924
834	=item C<PERL_PREFIX>	925	=item C<PERL_PREFIX>
835		926
836	The prefix where perl gets installed (default: F<$STATICPERL/perl>),	927	The directory where perl gets installed (default: F<$STATICPERL/perl>),
837	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. Previous
		929	contents will be removed on installation.
838		930
839	=item C<PERL_CONFIGURE>	931	=item C<PERL_CONFIGURE>
840		932
841	Additional Configure options - these are simply passed to the perl	933	Additional Configure options - these are simply passed to the perl
842	Configure script. For example, if you wanted to enable dynamic loading,	934	Configure script. For example, if you wanted to enable dynamic loading,
…		…
858	F<~/.staticperlrc> to override them.	950	F<~/.staticperlrc> to override them.
859		951
860	Most of the variables override (or modify) the corresponding F<Configure>	952	Most of the variables override (or modify) the corresponding F<Configure>
861	variable, except C<PERL_CCFLAGS>, which gets appended.	953	variable, except C<PERL_CCFLAGS>, which gets appended.
862		954
		955	The default for C<PERL_OPTIMIZE> is C<-Os> (assuming gcc), and for
		956	C<PERL_LIBS> is C<-lm -lcrypt>, which should be good for most (but not
		957	all) systems.
		958
		959	For other compilers or more customised optimisation settings, you need to
		960	adjust these, e.g. in your F<~/.staticperlrc>.
		961
		962	With gcc on x86 and amd64, you can get more space-savings by using:
		963
		964	-Os -ffunction-sections -fdata-sections -finline-limit=8 -mpush-args
		965	-mno-inline-stringops-dynamically -mno-align-stringops
		966
		967	And on x86 and pentium3 and newer (basically everything you might ever
		968	want to run on), adding these is even better for space-savings (use
		969	-mtune=core2 or something newer for much faster code, too):
		970
		971	-fomit-frame-pointer -march=pentium3 -mtune=i386
		972
863	=back	973	=back
864		974
865	=head4 Variables you probably I<do not want> to override	975	=head4 Variables you probably I<do not want> to override
866		976
867	=over 4	977	=over 4
…		…
885	=head3 OVERRIDABLE HOOKS	995	=head3 OVERRIDABLE HOOKS
886		996
887	In addition to environment variables, it is possible to provide some	997	In addition to environment variables, it is possible to provide some
888	shell functions that are called at specific times. To provide your own	998	shell functions that are called at specific times. To provide your own
889	commands, just define the corresponding function.	999	commands, just define the corresponding function.
		1000
		1001	The actual order in which hooks are invoked during a full install
		1002	from scratch is C<preconfigure>, C<patchconfig>, C<postconfigure>,
		1003	C<postbuild>, C<postinstall>.
890		1004
891	Example: install extra modules from CPAN and from some directories	1005	Example: install extra modules from CPAN and from some directories
892	at F<staticperl install> time.	1006	at F<staticperl install> time.
893		1007
894	postinstall() {	1008	postinstall() {
…		…
901		1015
902	=over 4	1016	=over 4
903		1017
904	=item preconfigure	1018	=item preconfigure
905		1019
906	Called just before running F<./Configur> in the perl source	1020	Called just before running F<./Configure> in the perl source
907	directory. Current working directory is the perl source directory.	1021	directory. Current working directory is the perl source directory.
908		1022
909	This can be used to set any C<PERL_xxx> variables, which might be costly	1023	This can be used to set any C<PERL_xxx> variables, which might be costly
910	to compute.	1024	to compute.
911		1025
		1026	=item patchconfig
		1027
		1028	Called after running F<./Configure> in the perl source directory to create
		1029	F<./config.sh>, but before running F<./Configure -S> to actually apply the
		1030	config. Current working directory is the perl source directory.
		1031
		1032	Can be used to tailor/patch F<config.sh> or do any other modifications.
		1033
912	=item postconfigure	1034	=item postconfigure
913		1035
914	Called after configuring, but before building perl. Current working	1036	Called after configuring, but before building perl. Current working
915	directory is the perl source directory.	1037	directory is the perl source directory.
916
917	Could be used to tailor/patch config.sh (followed by F<sh Configure -S>)
918	or do any other modifications.
919		1038
920	=item postbuild	1039	=item postbuild
921		1040
922	Called after building, but before installing perl. Current working	1041	Called after building, but before installing perl. Current working
923	directory is the perl source directory.	1042	directory is the perl source directory.
…		…
1036		1155
1037	=back	1156	=back
1038		1157
1039	=head1 RUNTIME FUNCTIONALITY	1158	=head1 RUNTIME FUNCTIONALITY
1040		1159
1041	Binaries created with C<mkbundle>/C<mkperl> contain extra functions, which	1160	Binaries created with C<mkbundle>/C<mkperl> contain extra functionality,
1042	are required to access the bundled perl sources, but might be useful for	1161	mostly related to the extra files bundled in the binary (the virtual
1043	other purposes.	1162	filesystem). All of this data is statically compiled into the binary, and
		1163	accessing means copying it from a read-only section of your binary. Data
		1164	pages in this way is usually freed by the operating system, as it isn't
		1165	use more the onace.
		1166
		1167	=head2 VIRTUAL FILESYSTEM
		1168
		1169	Every bundle has a virtual filesystem. The only information stored in it
		1170	is the path and contents of each file that was bundled.
		1171
		1172	=head3 LAYOUT
		1173
		1174	Any path starting with an ampersand (F<&>) or exclamation mark (F<!>) are
		1175	reserved by F<staticperl>. They must only be used as described in this
		1176	section.
		1177
		1178	=over 4
		1179
		1180	=item !
		1181
		1182	All files that typically cannot be loaded from memory (such as dynamic
		1183	objects or shared libraries), but have to reside in the filesystem, are
		1184	prefixed with F<!>. Typically these files get written out to some
		1185	(semi-)temporary directory shortly after program startup, or before being
		1186	used.
		1187
		1188	=item !boot
		1189
		1190	The bootstrap file, if specified during bundling.
		1191
		1192	=item !auto/
		1193
		1194	Shared objects or dlls corresponding to dynamically-linked perl extensions
		1195	are stored with an F<!auto/> prefix.
		1196
		1197	=item !lib/
		1198
		1199	External shared libraries are stored in this directory.
		1200
		1201	=item any letter
		1202
		1203	Any path starting with a letter is a perl library file. For example,
		1204	F<Coro/AIO.pm> corresponds to the file loaded by C<use Coro::AIO>, and
		1205	F<Coro/jit.pl> corresponds to C<require "Coro/jit.pl">.
		1206
		1207	Obviously, module names shouldn't start with any other characters than
		1208	letters :)
		1209
		1210	=back
		1211
		1212	=head3 FUNCTIONS
		1213
		1214	=over 4
		1215
		1216	=item $file = static::find $path
		1217
		1218	Returns the data associated with the given C<$path>
		1219	(e.g. C<Digest/MD5.pm>, C<auto/POSIX/autosplit.ix>).
		1220
		1221	Returns C<undef> if the file isn't embedded.
		1222
		1223	=item @paths = static::list
		1224
		1225	Returns the list of all paths embedded in this binary.
		1226
		1227	=back
		1228
		1229	=head2 EXTRA FEATURES
1044		1230
1045	In addition, for the embedded loading of perl files to work, F<staticperl>	1231	In addition, for the embedded loading of perl files to work, F<staticperl>
1046	overrides the C<@INC> array.	1232	overrides the C<@INC> array.
1047		1233
1048	=over 4	1234	=head1 FULLY STATIC BINARIES - ALPINE LINUX
1049		1235
1050	=item $file = staticperl::find $path	1236	This section once contained a way to build fully static (including
		1237	uClibc) binaries with buildroot. Unfortunately, buildroot no longer
		1238	supports a compiler, so I recommend using alpine linux instead
		1239	(L<http://alpinelinux.org/>). Get yourself a VM (e.g. with qemu), run an
		1240	older alpine linux verison in it (e.g. 2.4), copy staticperl inside and
		1241	use it.
1051		1242
1052	Returns the data associated with the given C<$path>	1243	The reason you might want an older alpine linux is that uClibc can be
1053	(e.g. C<Digest/MD5.pm>, C<auto/POSIX/autosplit.ix>), which is basically	1244	quite dependent on kernel versions, so the newest version of alpine linux
1054	the UNIX path relative to the perl library directory.	1245	might need a newer kernel then you might want for, if you plan to run your
1055		1246	binaries on on other kernels.
1056	Returns C<undef> if the file isn't embedded.
1057
1058	=item @paths = staticperl::list
1059
1060	Returns the list of all paths embedded in this binary.
1061
1062	=back
1063
1064	=head1 FULLY STATIC BINARIES - UCLIBC AND BUILDROOT
1065
1066	To make truly static (Linux-) libraries, you might want to have a look at
1067	buildroot (L<http://buildroot.uclibc.org/>).
1068
1069	Buildroot is primarily meant to set up a cross-compile environment (which
1070	is not so useful as perl doesn't quite like cross compiles), but it can also compile
1071	a chroot environment where you can use F<staticperl>.
1072
1073	To do so, download buildroot, and enable "Build options => development
1074	files in target filesystem" and optionally "Build options => gcc
1075	optimization level (optimize for size)". At the time of writing, I had
1076	good experiences with GCC 4.4.x but not GCC 4.5.
1077
1078	To minimise code size, I used C<-pipe -ffunction-sections -fdata-sections
1079	-finline-limit=8 -fno-builtin-strlen -mtune=i386>. The C<-mtune=i386>
1080	doesn't decrease codesize much, but it makes the file much more
1081	compressible.
1082
1083	If you don't need Coro or threads, you can go with "linuxthreads.old" (or
1084	no thread support). For Coro, it is highly recommended to switch to a
1085	uClibc newer than 0.9.31 (at the time of this writing, I used the 20101201
1086	snapshot) and enable NPTL, otherwise Coro needs to be configured with the
1087	ultra-slow pthreads backend to work around linuxthreads bugs (it also uses
1088	twice the address space needed for stacks).
1089
1090	If you use C<linuxthreads.old>, then you should also be aware that
1091	uClibc shares C<errno> between all threads when statically linking. See
1092	L<http://lists.uclibc.org/pipermail/uclibc/2010-June/044157.html> for a
1093	workaround (And L<https://bugs.uclibc.org/2089> for discussion).
1094
1095	C<ccache> support is also recommended, especially if you want
1096	to play around with buildroot options. Enabling the C<miniperl>
1097	package will probably enable all options required for a successful
1098	perl build. F<staticperl> itself additionally needs either C<wget>
1099	(recommended, for CPAN) or C<curl>.
1100
1101	As for shells, busybox should provide all that is needed, but the default
1102	busybox configuration doesn't include F<comm> which is needed by perl -
1103	either make a custom busybox config, or compile coreutils.
1104
1105	For the latter route, you might find that bash has some bugs that keep
1106	it from working properly in a chroot - either use dash (and link it to
1107	F</bin/sh> inside the chroot) or link busybox to F</bin/sh>, using it's
1108	built-in ash shell.
1109
1110	Finally, you need F</dev/null> inside the chroot for many scripts to work
1111	- F<cp /dev/null output/target/dev> or bind-mounting your F</dev> will
1112	both provide this.
1113
1114	After you have compiled and set up your buildroot target, you can copy
1115	F<staticperl> from the C<App::Staticperl> distribution or from your
1116	perl f<bin> directory (if you installed it) into the F<output/target>
1117	filesystem, chroot inside and run it.
1118		1247
1119	=head1 RECIPES / SPECIFIC MODULES	1248	=head1 RECIPES / SPECIFIC MODULES
1120		1249
1121	This section contains some common(?) recipes and information about	1250	This section contains some common(?) recipes and information about
1122	problems with some common modules or perl constructs that require extra	1251	problems with some common modules or perl constructs that require extra
…		…
1130		1259
1131	Some functionality in the utf8 module, such as swash handling (used	1260	Some functionality in the utf8 module, such as swash handling (used
1132	for unicode character ranges in regexes) is implemented in the	1261	for unicode character ranges in regexes) is implemented in the
1133	C<"utf8_heavy.pl"> library:	1262	C<"utf8_heavy.pl"> library:
1134		1263
1135	-M'"utf8_heavy.pl"'	1264	-Mutf8_heavy.pl
1136		1265
1137	Many Unicode properties in turn are defined in separate modules,	1266	Many Unicode properties in turn are defined in separate modules,
1138	such as C<"unicore/Heavy.pl"> and more specific data tables such as	1267	such as C<"unicore/Heavy.pl"> and more specific data tables such as
1139	C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables	1268	C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables
1140	are big (7MB uncompressed, although F<staticperl> contains special	1269	are big (7MB uncompressed, although F<staticperl> contains special
…		…
1159	C<"AnyEvent/Util/uts46data.pl">.	1288	C<"AnyEvent/Util/uts46data.pl">.
1160		1289
1161	Or you can use C<--usepacklists> and specify C<-MAnyEvent> to include	1290	Or you can use C<--usepacklists> and specify C<-MAnyEvent> to include
1162	everything.	1291	everything.
1163		1292
		1293	=item Cairo
		1294
		1295	See Glib, same problem, same solution.
		1296
1164	=item Carp	1297	=item Carp
1165		1298
1166	Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of	1299	Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of
1167	perl 5.12.2 (maybe earlier), this dependency no longer exists.	1300	perl 5.12.2 (maybe earlier), this dependency no longer exists.
1168		1301
1169	=item Config	1302	=item Config
1170		1303
1171	The F<perl -V> switch (as well as many modules) needs L<Config>, which in	1304	The F<perl -V> switch (as well as many modules) needs L<Config>, which in
1172	turn might need L<"Config_heavy.pl">. Including the latter gives you	1305	turn might need L<"Config_heavy.pl">. Including the latter gives you
1173	both.	1306	both.
		1307
		1308	=item Glib
		1309
		1310	Glib literally requires Glib to be installed already to build - it tries
		1311	to fake this by running Glib out of the build directory before being
		1312	built. F<staticperl> tries to work around this by forcing C<MAN1PODS> and
		1313	C<MAN3PODS> to be empty via the C<PERL_MM_OPT> environment variable.
		1314
		1315	=item Gtk2
		1316
		1317	See Pango, same problems, same solution.
		1318
		1319	=item Net::SSLeay
		1320
		1321	This module hasn't been significantly updated since OpenSSL is called
		1322	OpenSSL, and fails to properly link against dependent libraries, most
		1323	commonly, it forgets to specify -ldl when linking.
		1324
		1325	On GNU/Linux systems this usually goes undetected, as perl usually links
		1326	against -ldl itself and OpenSSL just happens to pick it up that way, by
		1327	chance.
		1328
		1329	For static builds, you either have to configure -ldl manually, or you
		1330	cna use the following snippet in your C<postinstall> hook which patches
		1331	Net::SSLeay after installation, which happens to work most of the time:
		1332
		1333	postinstall() {
		1334	# first install it
		1335	instcpan Net::SSLeay
		1336	# then add -ldl for future linking
		1337	chmod u+w "$PERL_PREFIX"/lib/auto/Net/SSLeay/extralibs.ld
		1338	echo " -ldl" >>"$PERL_PREFIX"/lib/auto/Net/SSLeay/extralibs.ld
		1339	}
		1340
		1341	=item Pango
		1342
		1343	In addition to the C<MAN3PODS> problem in Glib, Pango also routes around
		1344	L<ExtUtils::MakeMaker> by compiling its files on its own. F<staticperl>
		1345	tries to patch L<ExtUtils::MM_Unix> to route around Pango.
1174		1346
1175	=item Term::ReadLine::Perl	1347	=item Term::ReadLine::Perl
1176		1348
1177	Also needs L<Term::ReadLine::readline>, or C<--usepacklists>.	1349	Also needs L<Term::ReadLine::readline>, or C<--usepacklists>.
1178		1350
…		…
1240	gains little. Why Socket exposes a C function that is in the core already	1412	gains little. Why Socket exposes a C function that is in the core already
1241	is anybody's guess.	1413	is anybody's guess.
1242		1414
1243	=back	1415	=back
1244		1416
		1417	=head1 ADDITIONAL RESOURCES
		1418
		1419	Some guy has made a repository on github
		1420	(L<https://github.com/gh0stwizard/staticperl-modules>) with some modules
		1421	patched to build with staticperl.
		1422
1245	=head1 AUTHOR	1423	=head1 AUTHOR
1246		1424
1247	Marc Lehmann <schmorp@schmorp.de>	1425	Marc Lehmann <schmorp@schmorp.de>
1248	http://software.schmorp.de/pkg/staticperl.html	1426	http://software.schmorp.de/pkg/staticperl.html
		1427

Diff Legend

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

Comparing App-Staticperl/staticperl.pod (file contents): Revision 1.35 by root, Thu Feb 10 22:44:29 2011 UTC vs. Revision 1.59 by root, Mon Jul 6 23:33:15 2015 UTC

Diff Legend

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.35 by root, Thu Feb 10 22:44:29 2011 UTC vs.
Revision 1.59 by root, Mon Jul 6 23:33:15 2015 UTC