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

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.4 by root, Mon Dec 6 21:12:21 2010 UTC vs.
Revision 1.24 by root, Wed Dec 15 00:17:47 2010 UTC

…		…
1	=head1 NAME	1	=head1 NAME
2		2
3	staticperl - perl, libc, 50 modules all in one 500kb file	3	staticperl - perl, libc, 100 modules, all in one 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
14	staticperl cpan # invoke CPAN shell	14	staticperl cpan # invoke CPAN shell
15	staticperl instmod path... # install unpacked modules	15	staticperl instmod path... # install unpacked modules
16	staticperl instcpan modulename... # install modules from CPAN	16	staticperl instcpan modulename... # install modules from CPAN
17	staticperl mkbundle <bundle-args...> # see documentation	17	staticperl mkbundle <bundle-args...> # see documentation
18	staticperl mkperl <bundle-args...> # see documentation	18	staticperl mkperl <bundle-args...> # see documentation
		19	staticperl mkapp appname <bundle-args...> # see documentation
19		20
20	Typical Examples:	21	Typical Examples:
21		22
22	staticperl install # fetch, configure, build and install perl	23	staticperl install # fetch, configure, build and install perl
23	staticperl cpan # run interactive cpan shell	24	staticperl cpan # run interactive cpan shell
24	staticperl mkperl -M '"Config_heavy.pl"' # build a perl that supports -V	25	staticperl mkperl -M '"Config_heavy.pl"' # build a perl that supports -V
25	staticperl mkperl -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI -MURI::http	26	staticperl mkperl -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI -MURI::http
26	# build a perl with the above modules linked in	27	# build a perl with the above modules linked in
		28	staticperl mkapp myapp --boot mainprog mymodules
		29	# build a binary "myapp" from mainprog and mymodules
27		30
28	=head1 DESCRIPTION	31	=head1 DESCRIPTION
29		32
30	This script helps you creating single-file perl interpreters, or embedding	33	This script helps you to create single-file perl interpreters
31	a perl interpreter in your applications. Single-file means that it is	34	or applications, or embedding a perl interpreter in your
32	fully self-contained - no separate shared objects, no autoload fragments,	35	applications. Single-file means that it is fully self-contained - no
33	no .pm or .pl files are needed. And when linking statically, you can	36	separate shared objects, no autoload fragments, no .pm or .pl files are
34	create (or embed) a single file that contains perl interpreter, libc, all	37	needed. And when linking statically, you can create (or embed) a single
35	the modules you need and all the libraries you need.	38	file that contains perl interpreter, libc, all the modules you need, all
		39	the libraries you need and of course your actual program.
36		40
37	With F<uClibc> and F<upx> on x86, you can create a single 500kb binary that	41	With F<uClibc> and F<upx> on x86, you can create a single 500kb binary
38	contains perl and 50 modules such as AnyEvent, EV, IO::AIO, Coro and so	42	that contains perl and 100 modules such as POSIX, AnyEvent, EV, IO::AIO,
39	on. Or any other choice of modules.	43	Coro and so on. Or any other choice of modules.
		44
		45	To see how this turns out, you can try out smallperl and bigperl, two
		46	pre-built static and compressed perl binaries with many and even more
		47	modules: just follow the links at L<http://staticperl.schmorp.de/>.
40		48
41	The created files do not need write access to the file system (like PAR	49	The created files do not need write access to the file system (like PAR
42	does). In fact, since this script is in many ways similar to PAR::Packer,	50	does). In fact, since this script is in many ways similar to PAR::Packer,
43	here are the differences:	51	here are the differences:
44		52
…		…
63	=item * The generated executables don't need a writable filesystem.	71	=item * The generated executables don't need a writable filesystem.
64		72
65	F<staticperl> loads all required files directly from memory. There is no	73	F<staticperl> loads all required files directly from memory. There is no
66	need to unpack files into a temporary directory.	74	need to unpack files into a temporary directory.
67		75
68	=item * More control over included files.	76	=item * More control over included files, more burden.
69		77
70	PAR tries to be maintenance and hassle-free - it tries to include more	78	PAR tries to be maintenance and hassle-free - it tries to include more
71	files than necessary to make sure everything works out of the box. The	79	files than necessary to make sure everything works out of the box. It
72	extra files (such as the unicode database) can take substantial amounts of	80	mostly succeeds at this, but he extra files (such as the unicode database)
73	memory and file size.	81	can take substantial amounts of memory and file size.
74		82
75	With F<staticperl>, the burden is mostly with the developer - only direct	83	With F<staticperl>, the burden is mostly with the developer - only direct
76	compile-time dependencies and L<AutoLoader> are handled automatically.	84	compile-time dependencies and L<AutoLoader> are handled automatically.
77	This means the modules to include often need to be tweaked manually.	85	This means the modules to include often need to be tweaked manually.
		86
		87	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	manually.
78		90
79	=item * PAR works out of the box, F<staticperl> does not.	91	=item * PAR works out of the box, F<staticperl> does not.
80		92
81	Maintaining your own custom perl build can be a pain in the ass, and while	93	Maintaining your own custom perl build can be a pain in the ass, and while
82	F<staticperl> tries to make this easy, it still requires a custom perl	94	F<staticperl> tries to make this easy, it still requires a custom perl
83	build and possibly fiddling with some modules. PAR is likely to produce	95	build and possibly fiddling with some modules. PAR is likely to produce
84	results faster.	96	results faster.
		97
		98	Ok, PAR never has worked for me out of the box, and for some people,
		99	F<staticperl> does work out of the box, as they don't count "fiddling with
		100	module use lists" against it, but nevertheless, F<staticperl> is certainly
		101	a bit more difficult to use.
85		102
86	=back	103	=back
87		104
88	=head1 HOW DOES IT WORK?	105	=head1 HOW DOES IT WORK?
89		106
…		…
98	Afterwards, you create a list of files and modules you want to include,	115	Afterwards, you create a list of files and modules you want to include,
99	and then either build a new perl binary (that acts just like a normal perl	116	and then either build a new perl binary (that acts just like a normal perl
100	except everything is compiled in), or you create bundle files (basically C	117	except everything is compiled in), or you create bundle files (basically C
101	sources you can use to embed all files into your project).	118	sources you can use to embed all files into your project).
102		119
103	This step is very fast (a few seconds if PPI is not used for stripping,	120	This step is very fast (a few seconds if PPI is not used for stripping, or
104	more seconds otherwise, as PPI is very slow), and can be tweaked and	121	the stripped files are in the cache), and can be tweaked and repeated as
105	repeated as often as necessary.	122	often as necessary.
106		123
107	=head1 THE F<STATICPERL> SCRIPT	124	=head1 THE F<STATICPERL> SCRIPT
108		125
109	This module installs a script called F<staticperl> into your perl	126	This module installs a script called F<staticperl> into your perl
110	binary directory. The script is fully self-contained, and can be used	127	binary directory. The script is fully self-contained, and can be
111	without perl (for example, in an uClibc chroot environment). In fact,	128	used without perl (for example, in an uClibc chroot environment). In
112	it can be extracted from the C<App::Staticperl> distribution tarball as	129	fact, it can be extracted from the C<App::Staticperl> distribution
113	F<bin/staticperl>, without any installation.	130	tarball as F<bin/staticperl>, without any installation. The
		131	newest (possibly alpha) version can also be downloaded from
		132	L<http://staticperl.schmorp.de/staticperl>.
114		133
115	F<staticperl> interprets the first argument as a command to execute,	134	F<staticperl> interprets the first argument as a command to execute,
116	optionally followed by any parameters.	135	optionally followed by any parameters.
117		136
118	There are two command categories: the "phase 1" commands which deal with	137	There are two command categories: the "phase 1" commands which deal with
…		…
128		147
129	The command	148	The command
130		149
131	staticperl install	150	staticperl install
132		151
133	Is normally all you need: It installs the perl interpreter in	152	is normally all you need: It installs the perl interpreter in
134	F<~/.staticperl/perl>. It downloads, configures, builds and installs the	153	F<~/.staticperl/perl>. It downloads, configures, builds and installs the
135	perl interpreter if required.	154	perl interpreter if required.
136		155
137	Most of the following commands simply run one or more steps of this	156	Most of the following F<staticperl> subcommands simply run one or more
138	sequence.	157	steps of this sequence.
		158
		159	If it fails, then most commonly because the compiler options I selected
		160	are not supported by your compiler - either edit the F<staticperl> script
		161	yourself or create F<~/.staticperl> shell script where your set working
		162	C<PERL_CCFLAGS> etc. variables.
139		163
140	To force recompilation or reinstallation, you need to run F<staticperl	164	To force recompilation or reinstallation, you need to run F<staticperl
141	distclean> first.	165	distclean> first.
142		166
143	=over 4	167	=over 4
		168
		169	=item F<staticperl version>
		170
		171	Prints some info about the version of the F<staticperl> script you are using.
144		172
145	=item F<staticperl fetch>	173	=item F<staticperl fetch>
146		174
147	Runs only the download and unpack phase, unless this has already happened.	175	Runs only the download and unpack phase, unless this has already happened.
148		176
…		…
184	command by specifying all the directories with modules in them that you	212	command by specifying all the directories with modules in them that you
185	want to have built.	213	want to have built.
186		214
187	=item F<staticperl clean>	215	=item F<staticperl clean>
188		216
189	Runs F<make distclean> in the perl source directory (and potentially	217	Deletes the perl source directory (and potentially cleans up other
190	cleans up other intermediate files). This can be used to clean up	218	intermediate files). This can be used to clean up files only needed for
191	intermediate files without removing the installed perl interpreter.	219	building perl, without removing the installed perl interpreter.
		220
		221	At the moment, it doesn't delete downloaded tarballs.
		222
		223	The exact semantics of this command will probably change.
192		224
193	=item F<staticperl distclean>	225	=item F<staticperl distclean>
194		226
195	This wipes your complete F<~/.staticperl> directory. Be careful with this,	227	This wipes your complete F<~/.staticperl> directory. Be careful with this,
196	it nukes your perl download, perl sources, perl distribution and any	228	it nukes your perl download, perl sources, perl distribution and any
…		…
236	(required by L<AnyEvent::HTTPD>) implements various URI schemes as extra	268	(required by L<AnyEvent::HTTPD>) implements various URI schemes as extra
237	modules - since L<AnyEvent::HTTPD> only needs C<http> URIs, we only need	269	modules - since L<AnyEvent::HTTPD> only needs C<http> URIs, we only need
238	to include that module. I found out about these dependencies by carefully	270	to include that module. I found out about these dependencies by carefully
239	watching any error messages about missing modules...	271	watching any error messages about missing modules...
240		272
		273	Instead of building a new perl binary, you can also build a standalone
		274	application:
		275
		276	# build the app
		277	staticperl mkapp app --boot eg/httpd \
		278	-MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI::http
		279
		280	# run it
		281	./app
		282
241	=head3 OPTION PROCESSING	283	=head3 OPTION PROCESSING
242		284
243	All options can be given as arguments on the command line (typically	285	All options can be given as arguments on the command line (typically
244	using long (e.g. C<--verbose>) or short option (e.g. C<-v>) style). Since	286	using long (e.g. C<--verbose>) or short option (e.g. C<-v>) style). Since
245	specifying a lot of modules can make the command line very cumbersome,	287	specifying a lot of modules can make the command line very cumbersome,
…		…
260		302
261	All options that specify modules or files to be added are processed in the	303	All options that specify modules or files to be added are processed in the
262	order given on the command line (that affects the C<--use> and C<--eval>	304	order given on the command line (that affects the C<--use> and C<--eval>
263	options at the moment).	305	options at the moment).
264		306
		307	=head3 PACKAGE SELECTION WORKFLOW
		308
		309	F<staticperl mkbundle> has a number of options to control package
		310	selection. This section describes how they interact with each other. Also,
		311	since I am still a newbie w.r.t. these issues, maybe future versions of
		312	F<staticperl> will change this, so watch out :)
		313
		314	The idiom "in order" means "in order that they are specified on the
		315	commandline". If you use a bundle specification file, then the options
		316	will be processed as if they were given in place of the bundle file name.
		317
		318	=over 4
		319
		320	=item 1. apply all C<--use>, C<--eval>, C<--add>, C<--addbin> and
		321	C<--incglob> options, in order.
		322
		323	In addition, C<--use> and C<--eval> dependencies will be added when the
		324	options are processed.
		325
		326	=item 2. apply all C<--include> and C<--exclude> options, in order.
		327
		328	All this step does is potentially reduce the number of files already
		329	selected or found in phase 1.
		330
		331	=item 3. find all modules (== F<.pm> files), gather their static archives
		332	(F<.a>) and AutoLoader splitfiles (F<.ix> and F<.al> files), find any
		333	extra libraries they need for linking (F<extralibs.ld>) and optionally
		334	evaluate any F<.packlist> files.
		335
		336	This step is required to link against XS extensions and also adds files
		337	required for L<AutoLoader> to do it's job.
		338
		339	=back
		340
		341	After this, all the files selected for bundling will be read and processed
		342	(stripped), the bundle files will be written, and optionally a new F<perl>
		343	or application binary will be linked.
		344
265	=head3 MKBUNDLE OPTIONS	345	=head3 MKBUNDLE OPTIONS
266		346
267	=over 4	347	=over 4
268		348
269	=item --verbose \| -v	349	=item --verbose \| -v
…		…
281		361
282	The default is C<pod>, which uses the L<Pod::Strip> module to remove all	362	The default is C<pod>, which uses the L<Pod::Strip> module to remove all
283	pod documentation, which is very fast and reduces file size a lot.	363	pod documentation, which is very fast and reduces file size a lot.
284		364
285	The C<ppi> method uses L<PPI> to parse and condense the perl sources. This	365	The C<ppi> method uses L<PPI> to parse and condense the perl sources. This
286	saves a lot more than just L<Pod::Strip>, and is generally safer, but	366	saves a lot more than just L<Pod::Strip>, and is generally safer,
287	is also a lot slower, so is best used for production builds. Note that	367	but is also a lot slower (some files take almost a minute to strip -
288	this method doesn't optimise for raw file size, but for best compression	368	F<staticperl> maintains a cache of stripped files to speed up subsequent
289	(that means that the uncompressed file size is a bit larger, but the files	369	runs for this reason). Note that this method doesn't optimise for raw file
290	compress better, e.g. with F<upx>).	370	size, but for best compression (that means that the uncompressed file size
		371	is a bit larger, but the files compress better, e.g. with F<upx>).
291		372
		373	Last not least, if you need accurate line numbers in error messages,
292	Last not least, in the unlikely case where C<pod> is too slow, or some	374	or in the unlikely case where C<pod> is too slow, or some module gets
293	module gets mistreated, you can specify C<none> to not mangle included	375	mistreated, you can specify C<none> to not mangle included perl sources in
294	perl sources in any way.	376	any way.
295		377
296	=item --perl	378	=item --perl
297		379
298	After writing out the bundle files, try to link a new perl interpreter. It	380	After writing out the bundle files, try to link a new perl interpreter. It
299	will be called F<perl> and will be left in the current working	381	will be called F<perl> and will be left in the current working
…		…
302	This switch is automatically used when F<staticperl> is invoked with the	384	This switch is automatically used when F<staticperl> is invoked with the
303	C<mkperl> command (instead of C<mkbundle>):	385	C<mkperl> command (instead of C<mkbundle>):
304		386
305	# build a new ./perl with only common::sense in it - very small :)	387	# build a new ./perl with only common::sense in it - very small :)
306	staticperl mkperl -Mcommon::sense	388	staticperl mkperl -Mcommon::sense
		389
		390	=item --app name
		391
		392	After writing out the bundle files, try to link a new standalone
		393	program. It will be called C<name>, and the bundle files get removed after
		394	linking it.
		395
		396	The difference to the (mutually exclusive) C<--perl> option is that the
		397	binary created by this option will not try to act as a perl interpreter -
		398	instead it will simply initialise the perl interpreter, clean it up and
		399	exit.
		400
		401	This switch is automatically used when F<staticperl> is invoked with the
		402	C<mkapp> command (instead of C<mkbundle>):
		403
		404	To let it do something useful you I<must> add some boot code, e.g. with
		405	the C<--boot> option.
		406
		407	Example: create a standalone perl binary that will execute F<appfile> when
		408	it is started.
		409
		410	staticperl mkbundle --app myexe --boot appfile
307		411
308	=item --use module \| -Mmodule	412	=item --use module \| -Mmodule
309		413
310	Include the named module and all direct dependencies. This is done by	414	Include the named module and all direct dependencies. This is done by
311	C<require>'ing the module in a subprocess and tracing which other modules	415	C<require>'ing the module in a subprocess and tracing which other modules
…		…
366	(using a C<require>) before anything else when the new perl is	470	(using a C<require>) before anything else when the new perl is
367	initialised. This can be used to modify C<@INC> or anything else before	471	initialised. This can be used to modify C<@INC> or anything else before
368	the perl interpreter executes scripts given on the command line (or via	472	the perl interpreter executes scripts given on the command line (or via
369	C<-e>). This works even in an embedded interpreter.	473	C<-e>). This works even in an embedded interpreter.
370		474
371	=item --add "file" \| --add "file alias"	475	=item --usepacklist
		476
		477	Read F<.packlist> files for each distribution that happens to match a
		478	module name you specified. Sounds weird, and it is, so expect semantics to
		479	change somehow in the future.
		480
		481	The idea is that most CPAN distributions have a F<.pm> file that matches
		482	the name of the distribution (which is rather reasonable after all).
		483
		484	If this switch is enabled, then if any of the F<.pm> files that have been
		485	selected match an install distribution, then all F<.pm>, F<.pl>, F<.al>
		486	and F<.ix> files installed by this distribution are also included.
		487
		488	For example, using this switch, when the L<URI> module is specified, then
		489	all L<URI> submodules that have been installed via the CPAN distribution
		490	are included as well, so you don't have to manually specify them.
		491
		492	=item --incglob pattern
		493
		494	This goes through all library directories and tries to match any F<.pm>
		495	and F<.pl> files against the extended glob pattern (see below). If a file
		496	matches, it is added. This switch will automatically detect L<AutoLoader>
		497	files and the required link libraries for XS modules, but it will I<not>
		498	scan the file for dependencies (at the moment).
		499
		500	This is mainly useful to include "everything":
		501
		502	--incglob '*'
		503
		504	Or to include perl libraries, or trees of those, such as the unicode
		505	database files needed by many other modules:
		506
		507	--incglob '/unicore/**.pl'
		508
		509	=item --add file \| --add "file alias"
372		510
373	Adds the given (perl) file into the bundle (and optionally call it	511	Adds the given (perl) file into the bundle (and optionally call it
374	"alias"). This is useful to include any custom files into the bundle.	512	"alias"). This is useful to include any custom files into the bundle.
375		513
376	Example: embed the file F<httpd> as F<httpd.pm> when creating the bundle.	514	Example: embed the file F<httpd> as F<httpd.pm> when creating the bundle.
…		…
381		519
382	# specification file	520	# specification file
383	add file1 myfiles/file1	521	add file1 myfiles/file1
384	add file2 myfiles/file2	522	add file2 myfiles/file2
385	add file3 myfiles/file3	523	add file3 myfiles/file3
		524
		525	=item --binadd file \| --add "file alias"
		526
		527	Just like C<--add>, except that it treats the file as binary and adds it
		528	without any processing.
		529
		530	You should probably add a C</> prefix to avoid clashing with embedded
		531	perl files (whose paths do not start with C</>), and/or use a special
		532	directory, such as C</res/name>.
		533
		534	You can later get a copy of these files by calling C<staticperl::find
		535	"alias">.
		536
		537	=item --include pattern \| -i pattern \| --exclude pattern \| -x pattern
		538
		539	These two options define an include/exclude filter that is used after all
		540	files selected by the other options have been found. Each include/exclude
		541	is applied to all files found so far - an include makes sure that the
		542	given files will be part of the resulting file set, an exclude will
		543	exclude files. The patterns are "extended glob patterns" (see below).
		544
		545	For example, to include everything, except C<Devel> modules, but still
		546	include F<Devel::PPPort>, you could use this:
		547
		548	--incglob '' -i '/Devel/PPPort.pm' -x '/Devel/*'
386		549
387	=item --static	550	=item --static
388		551
389	When C<--perl> is also given, link statically instead of dynamically. The	552	When C<--perl> is also given, link statically instead of dynamically. The
390	default is to link the new perl interpreter fully dynamic (that means all	553	default is to link the new perl interpreter fully dynamic (that means all
…		…
395	systems based on GNU libc don't really support it in a usable fashion	558	systems based on GNU libc don't really support it in a usable fashion
396	either. Try uClibc if you want to create fully statically linked	559	either. Try uClibc if you want to create fully statically linked
397	executables, or try the C<--staticlibs> option to link only some libraries	560	executables, or try the C<--staticlibs> option to link only some libraries
398	statically.	561	statically.
399		562
		563	=item --staticlib libname
		564
		565	When not linking fully statically, this option allows you to link specific
		566	libraries statically. What it does is simply replace all occurances of
		567	C<-llibname> with the GCC-specific C<-Wl,-Bstatic -llibname -Wl,-Bdynamic>
		568	option.
		569
		570	This will have no effect unless the library is actually linked against,
		571	specifically, C<--staticlib> will not link against the named library
		572	unless it would be linked against anyway.
		573
		574	Example: link libcrypt statically into the binary.
		575
		576	staticperl mkperl -MIO::AIO --staticlib crypt
		577
		578	# ldopts might nwo contain:
		579	# -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread
		580
400	=item any other argument	581	=item any other argument
401		582
402	Any other argument is interpreted as a bundle specification file, which	583	Any other argument is interpreted as a bundle specification file, which
403	supports most long options (without extra quoting), one option per line.	584	supports most long options (without extra quoting), one option per line.
404		585
405	=back	586	=back
406		587
		588	=head3 EXTENDED GLOB PATTERNS
		589
		590	Some options of F<staticperl mkbundle> expect an I<extended glob
		591	pattern>. This is neither a normal shell glob nor a regex, but something
		592	in between. The idea has been copied from rsync, and there are the current
		593	matching rules:
		594
		595	=over 4
		596
		597	=item Patterns starting with F</> will be a anchored at the root of the library tree.
		598
		599	That is, F</unicore> will match the F<unicore> directory in C<@INC>, but
		600	nothing inside, and neither any other file or directory called F<unicore>
		601	anywhere else in the hierarchy.
		602
		603	=item Patterns not starting with F</> will be anchored at the end of the path.
		604
		605	That is, F<idna.pl> will match any file called F<idna.pl> anywhere in the
		606	hierarchy, but not any directories of the same name.
		607
		608	=item A F<*> matches any single component.
		609
		610	That is, F</unicore/*.pl> would match all F<.pl> files directly inside
		611	C</unicore>, not any deeper level F<.pl> files. Or in other words, F<*>
		612	will not match slashes.
		613
		614	=item A F<**> matches anything.
		615
		616	That is, F</unicore/**.pl> would match all F<.pl> files under F</unicore>,
		617	no matter how deeply nested they are inside subdirectories.
		618
		619	=item A F<?> matches a single character within a component.
		620
		621	That is, F</Encode/??.pm> matches F</Encode/JP.pm>, but not the
		622	hypothetical F</Encode/J/.pm>, as F<?> does not match F</>.
		623
		624	=back
		625
407	=head2 F<STATCPERL> CONFIGURATION AND HOOKS	626	=head2 F<STATICPERL> CONFIGURATION AND HOOKS
408		627
409	During (each) startup, F<staticperl> tries to source the following shell	628	During (each) startup, F<staticperl> tries to source some shell files to
		629	allow you to fine-tune/override configuration settings.
		630
		631	In them you can override shell variables, or define shell functions
		632	("hooks") to be called at specific phases during installation. For
		633	example, you could define a C<postinstall> hook to install additional
		634	modules from CPAN each time you start from scratch.
		635
		636	If the env variable C<$STATICPERLRC> is set, then F<staticperl> will try
		637	to source the file named with it only. Otherwise, it tries the following
410	files in order:	638	shell files in order:
411		639
412	/etc/staticperlrc	640	/etc/staticperlrc
413	~/.staticperlrc	641	~/.staticperlrc
414	$STATICPERL/rc	642	$STATICPERL/rc
415		643
416	They can be used to override shell variables, or define functions to be
417	called at specific phases.
418
419	Note that the last file is erased during F<staticperl distclean>, so	644	Note that the last file is erased during F<staticperl distclean>, so
420	generally should not be used.	645	generally should not be used.
421		646
422	=head3 CONFIGURATION VARIABLES	647	=head3 CONFIGURATION VARIABLES
423		648
…		…
428	=item C<EMAIL>	653	=item C<EMAIL>
429		654
430	The e-mail address of the person who built this binary. Has no good	655	The e-mail address of the person who built this binary. Has no good
431	default, so should be specified by you.	656	default, so should be specified by you.
432		657
433	=back	658	=item C<CPAN>
434		659
		660	The URL of the CPAN mirror to use (e.g. L<http://mirror.netcologne.de/cpan/>).
		661
		662	=item C<EXTRA_MODULES>
		663
		664	Additional modules installed during F<staticperl install>. Here you can
		665	set which modules you want have to installed from CPAN.
		666
		667	Example: I really really need EV, AnyEvent, Coro and AnyEvent::AIO.
		668
		669	EXTRA_MODULES="EV AnyEvent Coro AnyEvent::AIO"
		670
		671	Note that you can also use a C<postinstall> hook to achieve this, and
		672	more.
		673
		674	=back
		675
435	=head4 Variables you I<might want> to override	676	=head4 Variables you might I<want> to override
436		677
437	=over 4	678	=over 4
438		679
		680	=item C<STATICPERL>
		681
		682	The directory where staticperl stores all its files
		683	(default: F<~/.staticperl>).
		684
		685	=item C<PERL_MM_USE_DEFAULT>, C<EV_EXTRA_DEFS>, ...
		686
		687	Usually set to C<1> to make modules "less inquisitive" during their
		688	installation, you can set any environment variable you want - some modules
		689	(such as L<Coro> or L<EV>) use environment variables for further tweaking.
		690
439	=item C<PERLVER>	691	=item C<PERL_VERSION>
440		692
441	The perl version to install - default is currently C<5.12.2>, but C<5.8.9>	693	The perl version to install - default is currently C<5.12.2>, but C<5.8.9>
442	is also a good choice (5.8.9 is much smaller than 5.12.2, while 5.10.1 is	694	is also a good choice (5.8.9 is much smaller than 5.12.2, while 5.10.1 is
443	about as big as 5.12.2).	695	about as big as 5.12.2).
444		696
445	=item C<CPAN>	697	=item C<PERL_PREFIX>
446		698
447	The URL of the CPAN mirror to use (e.g. L<http://mirror.netcologne.de/cpan/>).	699	The prefix where perl gets installed (default: F<$STATICPERL/perl>),
		700	i.e. where the F<bin> and F<lib> subdirectories will end up.
448		701
		702	=item C<PERL_CONFIGURE>
		703
		704	Additional Configure options - these are simply passed to the perl
		705	Configure script. For example, if you wanted to enable dynamic loading,
		706	you could pass C<-Dusedl>. To enable ithreads (Why would you want that
		707	insanity? Don't! Use L<forks> instead!) you would pass C<-Duseithreads>
		708	and so on.
		709
		710	More commonly, you would either activate 64 bit integer support
		711	(C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to
		712	reduce filesize further.
		713
449	=item C<PERL_CPPFLAGS>, C<PERL_OPTIMIZE>, C<PERL_LDFLAGS>, C<PERL_LIBS>	714	=item C<PERL_CC>, C<PERL_CCFLAGS>, C<PERL_OPTIMIZE>, C<PERL_LDFLAGS>, C<PERL_LIBS>
450		715
451	These flags are passed to perl's F<Configure> script, and are generally	716	These flags are passed to perl's F<Configure> script, and are generally
452	optimised for small size (at the cost of performance). Since they also	717	optimised for small size (at the cost of performance). Since they also
453	contain subtle workarounds around various build issues, changing these	718	contain subtle workarounds around various build issues, changing these
454	usually requires understanding their default values - best look at the top	719	usually requires understanding their default values - best look at
455	of the F<staticperl> script for more info on these.	720	the top of the F<staticperl> script for more info on these, and use a
		721	F<~/.staticperlrc> to override them.
456		722
457	=item C<STATICPERL>	723	Most of the variables override (or modify) the corresponding F<Configure>
		724	variable, except C<PERL_CCFLAGS>, which gets appended.
458		725
459	The directory where staticperl stores all its files
460	(default: F<~/.staticperl>).
461
462	=item C<PREFIX>
463
464	The prefix where perl gets installed (default: F<$STATICPERL/perl>),
465	i.e. where the F<bin> and F<lib> subdirectories will end up.
466
467	=item C<PERL_MM_USE_DEFAULT>, C<EV_EXTRA_DEFS>, others
468
469	Usually set to C<1> to make modules "less inquisitive" during their
470	installation, you can set any environment variable you want - some modules
471	(such as L<Coro> or L<EV>) use environment variables for further tweaking.
472
473	=item C<EXTRA_MODULES>
474
475	Additional modules installed during F<staticperl install>. Here you can
476	set which modules you want have to installed from CPAN.
477
478	Example: I really really need EV, AnyEvent, Coro and IO::AIO.
479
480	EXTRA_MODULES="EV AnyEvent Coro IO::AIO"
481
482	Note that you can also use a C<postinstall> hook to achieve this, and
483	more.
484
485	=back	726	=back
486		727
487	=head4 Variables you I<probably do not want> to override	728	=head4 Variables you probably I<do not want> to override
488		729
489	=over 4	730	=over 4
		731
		732	=item C<MAKE>
		733
		734	The make command to use - default is C<make>.
490		735
491	=item C<MKBUNDLE>	736	=item C<MKBUNDLE>
492		737
493	Where F<staticperl> writes the C<mkbundle> command to	738	Where F<staticperl> writes the C<mkbundle> command to
494	(default: F<$STATICPERL/mkbundle>).	739	(default: F<$STATICPERL/mkbundle>).
…		…
517	instcpan Anyevent::AIO AnyEvent::HTTPD	762	instcpan Anyevent::AIO AnyEvent::HTTPD
518	}	763	}
519		764
520	=over 4	765	=over 4
521		766
		767	=item preconfigure
		768
		769	Called just before running F<./Configur> in the perl source
		770	directory. Current working directory is the perl source directory.
		771
		772	This can be used to set any C<PERL_xxx> variables, which might be costly
		773	to compute.
		774
522	=item postconfigure	775	=item postconfigure
523		776
524	Called after configuring, but before building perl. Current working	777	Called after configuring, but before building perl. Current working
525	directory is the perl source directory.	778	directory is the perl source directory.
526		779
527	Could be used to tailor/patch config.sh (followed by F<./Configure -S>) or	780	Could be used to tailor/patch config.sh (followed by F<sh Configure -S>)
528	do any other modifications.	781	or do any other modifications.
529		782
530	=item postbuild	783	=item postbuild
531		784
532	Called after building, but before installing perl. Current working	785	Called after building, but before installing perl. Current working
533	directory is the perl source directory.	786	directory is the perl source directory.
…		…
548	The script must return with a zero exit status, or the installation will	801	The script must return with a zero exit status, or the installation will
549	fail.	802	fail.
550		803
551	=back	804	=back
552		805
		806	=head1 ANATOMY OF A BUNDLE
		807
		808	When not building a new perl binary, C<mkbundle> will leave a number of
		809	files in the current working directory, which can be used to embed a perl
		810	interpreter in your program.
		811
		812	Intimate knowledge of L<perlembed> and preferably some experience with
		813	embedding perl is highly recommended.
		814
		815	C<mkperl> (or the C<--perl> option) basically does this to link the new
		816	interpreter (it also adds a main program to F<bundle.>):
		817
		818	$Config{cc} $(cat bundle.ccopts) -o perl bundle.c $(cat bundle.ldopts)
		819
		820	=over 4
		821
		822	=item bundle.h
		823
		824	A header file that contains the prototypes of the few symbols "exported"
		825	by bundle.c, and also exposes the perl headers to the application.
		826
		827	=over 4
		828
		829	=item staticperl_init ()
		830
		831	Initialises the perl interpreter. You can use the normal perl functions
		832	after calling this function, for example, to define extra functions or
		833	to load a .pm file that contains some initialisation code, or the main
		834	program function:
		835
		836	XS (xsfunction)
		837	{
		838	dXSARGS;
		839
		840	// now we have items, ST(i) etc.
		841	}
		842
		843	static void
		844	run_myapp(void)
		845	{
		846	staticperl_init ();
		847	newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$");
		848	eval_pv ("require myapp::main", 1); // executes "myapp/main.pm"
		849	}
		850
		851	=item staticperl_xs_init (pTHX)
		852
		853	Sometimes you need direct control over C<perl_parse> and C<perl_run>, in
		854	which case you do not want to use C<staticperl_init> but call them on your
		855	own.
		856
		857	Then you need this function - either pass it directly as the C<xs_init>
		858	function to C<perl_parse>, or call it from your own C<xs_init> function.
		859
		860	=item staticperl_cleanup ()
		861
		862	In the unlikely case that you want to destroy the perl interpreter, here
		863	is the corresponding function.
		864
		865	=item PerlInterpreter *staticperl
		866
		867	The perl interpreter pointer used by staticperl. Not normally so useful,
		868	but there it is.
		869
		870	=back
		871
		872	=item bundle.ccopts
		873
		874	Contains the compiler options required to compile at least F<bundle.c> and
		875	any file that includes F<bundle.h> - you should probably use it in your
		876	C<CFLAGS>.
		877
		878	=item bundle.ldopts
		879
		880	The linker options needed to link the final program.
		881
		882	=back
		883
		884	=head1 RUNTIME FUNCTIONALITY
		885
		886	Binaries created with C<mkbundle>/C<mkperl> contain extra functions, which
		887	are required to access the bundled perl sources, but might be useful for
		888	other purposes.
		889
		890	In addition, for the embedded loading of perl files to work, F<staticperl>
		891	overrides the C<@INC> array.
		892
		893	=over 4
		894
		895	=item $file = staticperl::find $path
		896
		897	Returns the data associated with the given C<$path>
		898	(e.g. C<Digest/MD5.pm>, C<auto/POSIX/autosplit.ix>), which is basically
		899	the UNIX path relative to the perl library directory.
		900
		901	Returns C<undef> if the file isn't embedded.
		902
		903	=item @paths = staticperl::list
		904
		905	Returns the list of all paths embedded in this binary.
		906
		907	=back
		908
		909	=head1 FULLY STATIC BINARIES - BUILDROOT
		910
		911	To make truly static (Linux-) libraries, you might want to have a look at
		912	buildroot (L<http://buildroot.uclibc.org/>).
		913
		914	Buildroot is primarily meant to set up a cross-compile environment (which
		915	is not so useful as perl doesn't quite like cross compiles), but it can also compile
		916	a chroot environment where you can use F<staticperl>.
		917
		918	To do so, download buildroot, and enable "Build options => development
		919	files in target filesystem" and optionally "Build options => gcc
		920	optimization level (optimize for size)". At the time of writing, I had
		921	good experiences with GCC 4.4.x but not GCC 4.5.
		922
		923	To minimise code size, I used C<-pipe -ffunction-sections -fdata-sections
		924	-finline-limit=8 -fno-builtin-strlen -mtune=i386>. The C<-mtune=i386>
		925	doesn't decrease codesize much, but it makes the file much more
		926	compressible.
		927
		928	If you don't need Coro or threads, you can go with "linuxthreads.old" (or
		929	no thread support). For Coro, it is highly recommended to switch to a
		930	uClibc newer than 0.9.31 (at the time of this writing, I used the 20101201
		931	snapshot) and enable NPTL, otherwise Coro needs to be configured with the
		932	ultra-slow pthreads backend to work around linuxthreads bugs (it also uses
		933	twice the address space needed for stacks).
		934
		935	If you use C<linuxthreads.old>, then you should also be aware that
		936	uClibc shares C<errno> between all threads when statically linking. See
		937	L<http://lists.uclibc.org/pipermail/uclibc/2010-June/044157.html> for a
		938	workaround (And L<https://bugs.uclibc.org/2089> for discussion).
		939
		940	C<ccache> support is also recommended, especially if you want
		941	to play around with buildroot options. Enabling the C<miniperl>
		942	package will probably enable all options required for a successful
		943	perl build. F<staticperl> itself additionally needs either C<wget>
		944	(recommended, for CPAN) or C<curl>.
		945
		946	As for shells, busybox should provide all that is needed, but the default
		947	busybox configuration doesn't include F<comm> which is needed by perl -
		948	either make a custom busybox config, or compile coreutils.
		949
		950	For the latter route, you might find that bash has some bugs that keep
		951	it from working properly in a chroot - either use dash (and link it to
		952	F</bin/sh> inside the chroot) or link busybox to F</bin/sh>, using it's
		953	built-in ash shell.
		954
		955	Finally, you need F</dev/null> inside the chroot for many scripts to work
		956	- F<cp /dev/null output/target/dev> or bind-mounting your F</dev> will
		957	both provide this.
		958
		959	After you have compiled and set up your buildroot target, you can copy
		960	F<staticperl> from the C<App::Staticperl> distribution or from your
		961	perl f<bin> directory (if you installed it) into the F<output/target>
		962	filesystem, chroot inside and run it.
		963
		964	=head1 RECIPES / SPECIFIC MODULES
		965
		966	This section contains some common(?) recipes and information about
		967	problems with some common modules or perl constructs that require extra
		968	files to be included.
		969
		970	=head2 MODULES
		971
		972	=over 4
		973
		974	=item utf8
		975
		976	Some functionality in the utf8 module, such as swash handling (used
		977	for unicode character ranges in regexes) is implemented in the
		978	C<"utf8_heavy.pl"> library:
		979
		980	-M'"utf8_heavy.pl"'
		981
		982	Many Unicode properties in turn are defined in separate modules,
		983	such as C<"unicore/Heavy.pl"> and more specific data tables such as
		984	C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables
		985	are big (7MB uncompressed, although F<staticperl> contains special
		986	handling for those files), so including them on demand by your application
		987	only might pay off.
		988
		989	To simply include the whole unicode database, use:
		990
		991	--incglob '/unicore/*.pl'
		992
		993	=item AnyEvent
		994
		995	AnyEvent needs a backend implementation that it will load in a delayed
		996	fashion. The L<AnyEvent::Impl::Perl> backend is the default choice
		997	for AnyEvent if it can't find anything else, and is usually a safe
		998	fallback. If you plan to use e.g. L<EV> (L<POE>...), then you need to
		999	include the L<AnyEvent::Impl::EV> (L<AnyEvent::Impl::POE>...) backend as
		1000	well.
		1001
		1002	If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn
		1003	functions), you also need to include C<"AnyEvent/Util/idna.pl"> and
		1004	C<"AnyEvent/Util/uts46data.pl">.
		1005
		1006	Or you can use C<--usepacklist> and specify C<-MAnyEvent> to include
		1007	everything.
		1008
		1009	=item Carp
		1010
		1011	Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of
		1012	perl 5.12.2 (maybe earlier), this dependency no longer exists.
		1013
		1014	=item Config
		1015
		1016	The F<perl -V> switch (as well as many modules) needs L<Config>, which in
		1017	turn might need L<"Config_heavy.pl">. Including the latter gives you
		1018	both.
		1019
		1020	=item Term::ReadLine::Perl
		1021
		1022	Also needs L<Term::ReadLine::readline>, or C<--usepacklist>.
		1023
		1024	=item URI
		1025
		1026	URI implements schemes as separate modules - the generic URL scheme is
		1027	implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If
		1028	you need to use any of these schemes, you should include these manually,
		1029	or use C<--usepacklist>.
		1030
		1031	=back
		1032
		1033	=head2 RECIPES
		1034
		1035	=over 4
		1036
		1037	=item Linking everything in
		1038
		1039	To link just about everything installed in the perl library into a new
		1040	perl, try this:
		1041
		1042	staticperl mkperl --strip ppi --incglob '*'
		1043
		1044	=item Getting rid of netdb function
		1045
		1046	The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent>
		1047	and so on) that few applications use. You can avoid compiling them in by
		1048	putting the following fragment into a C<preconfigure> hook:
		1049
		1050	preconfigure() {
		1051	for sym in \
		1052	d_getgrnam_r d_endgrent d_endgrent_r d_endhent \
		1053	d_endhostent_r d_endnent d_endnetent_r d_endpent \
		1054	d_endprotoent_r d_endpwent d_endpwent_r d_endsent \
		1055	d_endservent_r d_getgrent d_getgrent_r d_getgrgid_r \
		1056	d_getgrnam_r d_gethbyaddr d_gethent d_getsbyport \
		1057	d_gethostbyaddr_r d_gethostbyname_r d_gethostent_r \
		1058	d_getlogin_r d_getnbyaddr d_getnbyname d_getnent \
		1059	d_getnetbyaddr_r d_getnetbyname_r d_getnetent_r \
		1060	d_getpent d_getpbyname d_getpbynumber d_getprotobyname_r \
		1061	d_getprotobynumber_r d_getprotoent_r d_getpwent \
		1062	d_getpwent_r d_getpwnam_r d_getpwuid_r d_getsent \
		1063	d_getservbyname_r d_getservbyport_r d_getservent_r \
		1064	d_getspnam_r d_getsbyname
		1065	# d_gethbyname
		1066	do
		1067	PERL_CONFIGURE="$PERL_CONFIGURE -U$sym"
		1068	done
		1069	}
		1070
		1071	This mostly gains space when linking staticaly, as the functions will
		1072	likely not be linked in. The gain for dynamically-linked binaries is
		1073	smaller.
		1074
		1075	Also, this leaves C<gethostbyname> in - not only is it actually used
		1076	often, the L<Socket> module also exposes it, so leaving it out usually
		1077	gains little. Why Socket exposes a C function that is in the core already
		1078	is anybody's guess.
		1079
		1080	=back
		1081
553	=head1 AUTHOR	1082	=head1 AUTHOR
554		1083
555	Marc Lehmann <schmorp@schmorp.de>	1084	Marc Lehmann <schmorp@schmorp.de>
556	http://software.schmorp.de/pkg/staticperl.html	1085	http://software.schmorp.de/pkg/staticperl.html

Diff Legend

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

Comparing App-Staticperl/staticperl.pod (file contents): Revision 1.4 by root, Mon Dec 6 21:12:21 2010 UTC vs. Revision 1.24 by root, Wed Dec 15 00:17:47 2010 UTC

Diff Legend

Comparing App-Staticperl/staticperl.pod (file contents):
Revision 1.4 by root, Mon Dec 6 21:12:21 2010 UTC vs.
Revision 1.24 by root, Wed Dec 15 00:17:47 2010 UTC