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

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.41 by root, Thu May 19 18:58:19 2011 UTC vs.
Revision 1.60 by root, Fri Oct 16 01:52:08 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
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 perl ... # invoke the perlinterpreter
15	staticperl cpan # invoke CPAN shell	15	staticperl cpan # invoke CPAN shell
16	staticperl instmod path... # install unpacked modules	16	staticperl instsrc path... # install unpacked modules
17	staticperl instcpan modulename... # install modules from CPAN	17	staticperl instcpan modulename... # install modules from CPAN
18	staticperl mkbundle <bundle-args...> # see documentation	18	staticperl mkbundle <bundle-args...> # see documentation
19	staticperl mkperl <bundle-args...> # see documentation	19	staticperl mkperl <bundle-args...> # see documentation
20	staticperl mkapp appname <bundle-args...> # see documentation	20	staticperl mkapp appname <bundle-args...> # see documentation
21		21
…		…
84	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
85	compile-time dependencies and L<AutoLoader> are handled automatically.	85	compile-time dependencies and L<AutoLoader> are handled automatically.
86	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.
87		87
88	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
89	the future, but right now, you have to resolve state hidden dependencies	89	the future, but right now, you have to resolve hidden dependencies
90	manually.	90	manually.
91		91
92	=item * PAR works out of the box, F<staticperl> does not.	92	=item * PAR works out of the box, F<staticperl> does not.
93		93
94	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
…		…
202	=item F<staticperl cpan> [args...]	202	=item F<staticperl cpan> [args...]
203		203
204	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
205	modules. Installs the perl first if necessary, but apart from that,	205	modules. Installs the perl first if necessary, but apart from that,
206	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
207	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.
208		210
209	Any additional arguments are simply passed to the F<cpan> command.	211	Any additional arguments are simply passed to the F<cpan> command.
210		212
211	=item F<staticperl instcpan> module...	213	=item F<staticperl instcpan> module...
212		214
…		…
346	add eg/httpd httpd.pm	348	add eg/httpd httpd.pm
347		349
348	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
349	order given on the command line.	351	order given on the command line.
350		352
351	=head3 BUNDLE CREATION WORKFLOW / STATICPELR MKBUNDLE OPTIONS	353	=head3 BUNDLE CREATION WORKFLOW / STATICPERL MKBUNDLE OPTIONS
352		354
353	F<staticperl mkbundle> works by first assembling a list of candidate	355	F<staticperl mkbundle> works by first assembling a list of candidate
354	files and modules to include, then filtering them by include/exclude	356	files and modules to include, then filtering them by include/exclude
355	patterns. The remaining modules (together with their direct dependencies,	357	patterns. The remaining modules (together with their direct dependencies,
356	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
…		…
541	# then later, in perl, use	543	# then later, in perl, use
542	use myfiles::file1;	544	use myfiles::file1;
543	require myfiles::file2;	545	require myfiles::file2;
544	my $res = do "myfiles/file3.pl";	546	my $res = do "myfiles/file3.pl";
545		547
546	=item C<--binadd> F<file> \| C<--add> "F<file> alias"	548	=item C<--addbin> F<file> \| C<--addbin> "F<file> alias"
547		549
548	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
549	without any postprocessing (perl files might get stripped to reduce their	551	without any postprocessing (perl files might get stripped to reduce their
550	size).	552	size).
551		553
552	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
553	clashing with embedded perl files (whose paths never start with C<&>),	555	clashing with embedded perl files (whose paths never start with C</>),
554	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>.
555		557
556	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
557	"alias">.	559	"alias">.
558		560
559	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
560	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
561	both inside and outside of a staticperl bundle:	563	both inside and outside of a staticperl bundle, without extra ado:
562		564
563	# a "binary" file, call it "bindata.pl"	565	# a "binary" file, call it "bindata.pl"
564	<<'SOME_MARKER'	566	<<'SOME_MARKER'
565	binary data NOT containing SOME_MARKER	567	binary data NOT containing SOME_MARKER
566	SOME_MARKER	568	SOME_MARKER
567		569
568	# load the binary	570	# load the binary
569	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
570		589
571	=back	590	=back
572		591
573	=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.
574		593
…		…
733	standalone applications, and this option removes those known to cause	752	standalone applications, and this option removes those known to cause
734	trouble.	753	trouble.
735		754
736	Specifically, these are removed:	755	Specifically, these are removed:
737		756
738	C<PERL_HASH_SEED_DEBUG> and C<PERL_DEBUG_MSTATS> can cause underaible	757	C<PERL_HASH_SEED_DEBUG> and C<PERL_DEBUG_MSTATS> can cause undesirable
739	output, C<PERL5OPT>, C<PERL_DESTRUCT_LEVEL>, C<PERL_HASH_SEED> and	758	output, C<PERL5OPT>, C<PERL_DESTRUCT_LEVEL>, C<PERL_HASH_SEED> and
740	C<PERL_SIGNALS> can alter execution significantly, and C<PERL_UNICODE>,	759	C<PERL_SIGNALS> can alter execution significantly, and C<PERL_UNICODE>,
741	C<PERLIO_DEBUG> and C<PERLIO> can affect input and output.	760	C<PERLIO_DEBUG> and C<PERLIO> can affect input and output.
742		761
743	The variables C<PERL_LIB> and C<PERL5_LIB> are always ignored because the	762	The variables C<PERL_LIB> and C<PERL5_LIB> are always ignored because the
…		…
882	=item C<STATICPERL>	901	=item C<STATICPERL>
883		902
884	The directory where staticperl stores all its files	903	The directory where staticperl stores all its files
885	(default: F<~/.staticperl>).	904	(default: F<~/.staticperl>).
886		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 - C<5.12.5> is a good choice for small builds,
		915	but C<5.8.9> is also a good choice (5.8.9 is much smaller than 5.12.5), if
		916	it builds on your system.
		917
		918	You can also set this variable to the full URL of a tarball (F<.tar>,
		919	F<.tar.gz>, F<.tar.bz2>, F<.tar.lzma> or F<.tar.xz>).
		920
		921	The default is currently
		922	F<http://stableperl.schmorp.de/dist/latest.tar.gz>, i.e. the latest
		923	stableperl release.
		924
887	=item C<PERL_MM_USE_DEFAULT>, C<EV_EXTRA_DEFS>, ...	925	=item C<PERL_MM_USE_DEFAULT>, C<EV_EXTRA_DEFS>, ...
888		926
889	Usually set to C<1> to make modules "less inquisitive" during their	927	Usually set to C<1> to make modules "less inquisitive" during their
890	installation, you can set any environment variable you want - some modules	928	installation. You can set (and export!) any environment variable you want
891	(such as L<Coro> or L<EV>) use environment variables for further tweaking.	929	- some modules (such as L<Coro> or L<EV>) use environment variables for
892		930	further tweaking.
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		931
899	=item C<PERL_PREFIX>	932	=item C<PERL_PREFIX>
900		933
901	The prefix where perl gets installed (default: F<$STATICPERL/perl>),	934	The directory where perl gets installed (default: F<$STATICPERL/perl>),
902	i.e. where the F<bin> and F<lib> subdirectories will end up.	935	i.e. where the F<bin> and F<lib> subdirectories will end up. Previous
		936	contents will be removed on installation.
903		937
904	=item C<PERL_CONFIGURE>	938	=item C<PERL_CONFIGURE>
905		939
906	Additional Configure options - these are simply passed to the perl	940	Additional Configure options - these are simply passed to the perl
907	Configure script. For example, if you wanted to enable dynamic loading,	941	Configure script. For example, if you wanted to enable dynamic loading,
…		…
923	F<~/.staticperlrc> to override them.	957	F<~/.staticperlrc> to override them.
924		958
925	Most of the variables override (or modify) the corresponding F<Configure>	959	Most of the variables override (or modify) the corresponding F<Configure>
926	variable, except C<PERL_CCFLAGS>, which gets appended.	960	variable, except C<PERL_CCFLAGS>, which gets appended.
927		961
928	You should have a look near the beginning of the F<staticperl> script -	962	The default for C<PERL_OPTIMIZE> is C<-Os> (assuming gcc), and for
929	staticperl tries to default C<PERL_OPTIMIZE> to some psace-saving options	963	C<PERL_LIBS> is C<-lm -lcrypt>, which should be good for most (but not
930	suitable for newer gcc versions. For other compilers or older versions you	964	all) systems.
		965
		966	For other compilers or more customised optimisation settings, you need to
931	need to adjust these, for example, in your F<~/.staticperlrc>.	967	adjust these, e.g. in your F<~/.staticperlrc>.
		968
		969	With gcc on x86 and amd64, you can get more space-savings by using:
		970
		971	-Os -ffunction-sections -fdata-sections -finline-limit=8 -mpush-args
		972	-mno-inline-stringops-dynamically -mno-align-stringops
		973
		974	And on x86 and pentium3 and newer (basically everything you might ever
		975	want to run on), adding these is even better for space-savings (use
		976	-mtune=core2 or something newer for much faster code, too):
		977
		978	-fomit-frame-pointer -march=pentium3 -mtune=i386
932		979
933	=back	980	=back
934		981
935	=head4 Variables you probably I<do not want> to override	982	=head4 Variables you probably I<do not want> to override
936		983
…		…
1115		1162
1116	=back	1163	=back
1117		1164
1118	=head1 RUNTIME FUNCTIONALITY	1165	=head1 RUNTIME FUNCTIONALITY
1119		1166
1120	Binaries created with C<mkbundle>/C<mkperl> contain extra functions, which	1167	Binaries created with C<mkbundle>/C<mkperl> contain extra functionality,
1121	are required to access the bundled perl sources, but might be useful for	1168	mostly related to the extra files bundled in the binary (the virtual
1122	other purposes.	1169	filesystem). All of this data is statically compiled into the binary, and
		1170	accessing means copying it from a read-only section of your binary. Data
		1171	pages in this way is usually freed by the operating system, as it isn't
		1172	use more the onace.
		1173
		1174	=head2 VIRTUAL FILESYSTEM
		1175
		1176	Every bundle has a virtual filesystem. The only information stored in it
		1177	is the path and contents of each file that was bundled.
		1178
		1179	=head3 LAYOUT
		1180
		1181	Any path starting with an ampersand (F<&>) or exclamation mark (F<!>) are
		1182	reserved by F<staticperl>. They must only be used as described in this
		1183	section.
		1184
		1185	=over 4
		1186
		1187	=item !
		1188
		1189	All files that typically cannot be loaded from memory (such as dynamic
		1190	objects or shared libraries), but have to reside in the filesystem, are
		1191	prefixed with F<!>. Typically these files get written out to some
		1192	(semi-)temporary directory shortly after program startup, or before being
		1193	used.
		1194
		1195	=item !boot
		1196
		1197	The bootstrap file, if specified during bundling.
		1198
		1199	=item !auto/
		1200
		1201	Shared objects or dlls corresponding to dynamically-linked perl extensions
		1202	are stored with an F<!auto/> prefix.
		1203
		1204	=item !lib/
		1205
		1206	External shared libraries are stored in this directory.
		1207
		1208	=item any letter
		1209
		1210	Any path starting with a letter is a perl library file. For example,
		1211	F<Coro/AIO.pm> corresponds to the file loaded by C<use Coro::AIO>, and
		1212	F<Coro/jit.pl> corresponds to C<require "Coro/jit.pl">.
		1213
		1214	Obviously, module names shouldn't start with any other characters than
		1215	letters :)
		1216
		1217	=back
		1218
		1219	=head3 FUNCTIONS
		1220
		1221	=over 4
		1222
		1223	=item $file = static::find $path
		1224
		1225	Returns the data associated with the given C<$path>
		1226	(e.g. C<Digest/MD5.pm>, C<auto/POSIX/autosplit.ix>).
		1227
		1228	Returns C<undef> if the file isn't embedded.
		1229
		1230	=item @paths = static::list
		1231
		1232	Returns the list of all paths embedded in this binary.
		1233
		1234	=back
		1235
		1236	=head2 EXTRA FEATURES
1123		1237
1124	In addition, for the embedded loading of perl files to work, F<staticperl>	1238	In addition, for the embedded loading of perl files to work, F<staticperl>
1125	overrides the C<@INC> array.	1239	overrides the C<@INC> array.
1126		1240
1127	=over 4	1241	=head1 FULLY STATIC BINARIES - ALPINE LINUX
1128		1242
1129	=item $file = staticperl::find $path	1243	This section once contained a way to build fully static (including
		1244	uClibc) binaries with buildroot. Unfortunately, buildroot no longer
		1245	supports a compiler, so I recommend using alpine linux instead
		1246	(L<http://alpinelinux.org/>). Get yourself a VM (e.g. with qemu), run an
		1247	older alpine linux verison in it (e.g. 2.4), copy staticperl inside and
		1248	use it.
1130		1249
1131	Returns the data associated with the given C<$path>	1250	The reason you might want an older alpine linux is that uClibc can be
1132	(e.g. C<Digest/MD5.pm>, C<auto/POSIX/autosplit.ix>), which is basically	1251	quite dependent on kernel versions, so the newest version of alpine linux
1133	the UNIX path relative to the perl library directory.	1252	might need a newer kernel then you might want for, if you plan to run your
1134		1253	binaries on on other kernels.
1135	Returns C<undef> if the file isn't embedded.
1136
1137	=item @paths = staticperl::list
1138
1139	Returns the list of all paths embedded in this binary.
1140
1141	=back
1142
1143	=head1 FULLY STATIC BINARIES - UCLIBC AND BUILDROOT
1144
1145	To make truly static (Linux-) libraries, you might want to have a look at
1146	buildroot (L<http://buildroot.uclibc.org/>).
1147
1148	Buildroot is primarily meant to set up a cross-compile environment (which
1149	is not so useful as perl doesn't quite like cross compiles), but it can also compile
1150	a chroot environment where you can use F<staticperl>.
1151
1152	To do so, download buildroot, and enable "Build options => development
1153	files in target filesystem" and optionally "Build options => gcc
1154	optimization level (optimize for size)". At the time of writing, I had
1155	good experiences with GCC 4.4.x but not GCC 4.5.
1156
1157	To minimise code size, I used C<-pipe -ffunction-sections -fdata-sections
1158	-finline-limit=8 -fno-builtin-strlen -mtune=i386>. The C<-mtune=i386>
1159	doesn't decrease codesize much, but it makes the file much more
1160	compressible (and the execution a lot slower...).
1161
1162	If you don't need Coro or threads, you can go with "linuxthreads.old" (or
1163	no thread support). For Coro, it is highly recommended to switch to a
1164	uClibc newer than 0.9.31 (at the time of this writing, I used the 20101201
1165	snapshot) and enable NPTL, otherwise Coro needs to be configured with the
1166	ultra-slow pthreads backend to work around linuxthreads bugs (it also uses
1167	twice the address space needed for stacks).
1168
1169	If you use C<linuxthreads.old>, then you should also be aware that
1170	uClibc shares C<errno> between all threads when statically linking. See
1171	L<http://lists.uclibc.org/pipermail/uclibc/2010-June/044157.html> for a
1172	workaround (And L<https://bugs.uclibc.org/2089> for discussion).
1173
1174	C<ccache> support is also recommended, especially if you want
1175	to play around with buildroot options. Enabling the C<miniperl>
1176	package will probably enable all options required for a successful
1177	perl build. F<staticperl> itself additionally needs either C<wget>
1178	(recommended, for CPAN) or C<curl>.
1179
1180	As for shells, busybox should provide all that is needed, but the default
1181	busybox configuration doesn't include F<comm> which is needed by perl -
1182	either make a custom busybox config, or compile coreutils.
1183
1184	For the latter route, you might find that bash has some bugs that keep
1185	it from working properly in a chroot - either use dash (and link it to
1186	F</bin/sh> inside the chroot) or link busybox to F</bin/sh>, using it's
1187	built-in ash shell.
1188
1189	Finally, you need F</dev/null> inside the chroot for many scripts to work
1190	- F<cp /dev/null output/target/dev> or bind-mounting your F</dev> will
1191	both provide this.
1192
1193	After you have compiled and set up your buildroot target, you can copy
1194	F<staticperl> from the C<App::Staticperl> distribution or from your
1195	perl f<bin> directory (if you installed it) into the F<output/target>
1196	filesystem, chroot inside and run it.
1197		1254
1198	=head1 RECIPES / SPECIFIC MODULES	1255	=head1 RECIPES / SPECIFIC MODULES
1199		1256
1200	This section contains some common(?) recipes and information about	1257	This section contains some common(?) recipes and information about
1201	problems with some common modules or perl constructs that require extra	1258	problems with some common modules or perl constructs that require extra
…		…
1263	C<MAN3PODS> to be empty via the C<PERL_MM_OPT> environment variable.	1320	C<MAN3PODS> to be empty via the C<PERL_MM_OPT> environment variable.
1264		1321
1265	=item Gtk2	1322	=item Gtk2
1266		1323
1267	See Pango, same problems, same solution.	1324	See Pango, same problems, same solution.
		1325
		1326	=item Net::SSLeay
		1327
		1328	This module hasn't been significantly updated since OpenSSL is called
		1329	OpenSSL, and fails to properly link against dependent libraries, most
		1330	commonly, it forgets to specify -ldl when linking.
		1331
		1332	On GNU/Linux systems this usually goes undetected, as perl usually links
		1333	against -ldl itself and OpenSSL just happens to pick it up that way, by
		1334	chance.
		1335
		1336	For static builds, you either have to configure -ldl manually, or you
		1337	cna use the following snippet in your C<postinstall> hook which patches
		1338	Net::SSLeay after installation, which happens to work most of the time:
		1339
		1340	postinstall() {
		1341	# first install it
		1342	instcpan Net::SSLeay
		1343	# then add -ldl for future linking
		1344	chmod u+w "$PERL_PREFIX"/lib/auto/Net/SSLeay/extralibs.ld
		1345	echo " -ldl" >>"$PERL_PREFIX"/lib/auto/Net/SSLeay/extralibs.ld
		1346	}
1268		1347
1269	=item Pango	1348	=item Pango
1270		1349
1271	In addition to the C<MAN3PODS> problem in Glib, Pango also routes around	1350	In addition to the C<MAN3PODS> problem in Glib, Pango also routes around
1272	L<ExtUtils::MakeMaker> by compiling its files on its own. F<staticperl>	1351	L<ExtUtils::MakeMaker> by compiling its files on its own. F<staticperl>
…		…
1340	gains little. Why Socket exposes a C function that is in the core already	1419	gains little. Why Socket exposes a C function that is in the core already
1341	is anybody's guess.	1420	is anybody's guess.
1342		1421
1343	=back	1422	=back
1344		1423
		1424	=head1 ADDITIONAL RESOURCES
		1425
		1426	Some guy has made a repository on github
		1427	(L<https://github.com/gh0stwizard/staticperl-modules>) with some modules
		1428	patched to build with staticperl.
		1429
1345	=head1 AUTHOR	1430	=head1 AUTHOR
1346		1431
1347	Marc Lehmann <schmorp@schmorp.de>	1432	Marc Lehmann <schmorp@schmorp.de>
1348	http://software.schmorp.de/pkg/staticperl.html	1433	http://software.schmorp.de/pkg/staticperl.html
		1434

Diff Legend

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

Comparing App-Staticperl/staticperl.pod (file contents): Revision 1.41 by root, Thu May 19 18:58:19 2011 UTC vs. Revision 1.60 by root, Fri Oct 16 01:52:08 2015 UTC

Diff Legend

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.41 by root, Thu May 19 18:58:19 2011 UTC vs.
Revision 1.60 by root, Fri Oct 16 01:52:08 2015 UTC