1 |
root |
1.1 |
=head1 NAME |
2 |
|
|
|
3 |
root |
1.8 |
staticperl - perl, libc, 100 modules, all in one 500kb file |
4 |
root |
1.1 |
|
5 |
|
|
=head1 SYNOPSIS |
6 |
|
|
|
7 |
|
|
staticperl help # print the embedded documentation |
8 |
|
|
staticperl fetch # fetch and unpack perl sources |
9 |
|
|
staticperl configure # fetch and then configure perl |
10 |
|
|
staticperl build # configure and then build perl |
11 |
|
|
staticperl install # build and then install perl |
12 |
|
|
staticperl clean # clean most intermediate files (restart at configure) |
13 |
|
|
staticperl distclean # delete everything installed by this script |
14 |
root |
1.39 |
staticperl perl ... # invoke the perlinterpreter |
15 |
root |
1.1 |
staticperl cpan # invoke CPAN shell |
16 |
|
|
staticperl instmod path... # install unpacked modules |
17 |
|
|
staticperl instcpan modulename... # install modules from CPAN |
18 |
|
|
staticperl mkbundle <bundle-args...> # see documentation |
19 |
|
|
staticperl mkperl <bundle-args...> # see documentation |
20 |
root |
1.14 |
staticperl mkapp appname <bundle-args...> # see documentation |
21 |
root |
1.1 |
|
22 |
|
|
Typical Examples: |
23 |
|
|
|
24 |
|
|
staticperl install # fetch, configure, build and install perl |
25 |
|
|
staticperl cpan # run interactive cpan shell |
26 |
root |
1.37 |
staticperl mkperl -MConfig_heavy.pl # build a perl that supports -V |
27 |
root |
1.1 |
staticperl mkperl -MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI -MURI::http |
28 |
|
|
# build a perl with the above modules linked in |
29 |
root |
1.14 |
staticperl mkapp myapp --boot mainprog mymodules |
30 |
|
|
# build a binary "myapp" from mainprog and mymodules |
31 |
root |
1.1 |
|
32 |
|
|
=head1 DESCRIPTION |
33 |
|
|
|
34 |
root |
1.16 |
This script helps you to create single-file perl interpreters |
35 |
|
|
or applications, or embedding a perl interpreter in your |
36 |
|
|
applications. Single-file means that it is fully self-contained - no |
37 |
|
|
separate shared objects, no autoload fragments, no .pm or .pl files are |
38 |
|
|
needed. And when linking statically, you can create (or embed) a single |
39 |
|
|
file that contains perl interpreter, libc, all the modules you need, all |
40 |
|
|
the libraries you need and of course your actual program. |
41 |
root |
1.1 |
|
42 |
root |
1.8 |
With F<uClibc> and F<upx> on x86, you can create a single 500kb binary |
43 |
|
|
that contains perl and 100 modules such as POSIX, AnyEvent, EV, IO::AIO, |
44 |
root |
1.41 |
Coro and so on. Or any other choice of modules (and some other size :). |
45 |
root |
1.1 |
|
46 |
root |
1.20 |
To see how this turns out, you can try out smallperl and bigperl, two |
47 |
|
|
pre-built static and compressed perl binaries with many and even more |
48 |
|
|
modules: just follow the links at L<http://staticperl.schmorp.de/>. |
49 |
|
|
|
50 |
root |
1.3 |
The created files do not need write access to the file system (like PAR |
51 |
root |
1.1 |
does). In fact, since this script is in many ways similar to PAR::Packer, |
52 |
|
|
here are the differences: |
53 |
|
|
|
54 |
|
|
=over 4 |
55 |
|
|
|
56 |
|
|
=item * The generated executables are much smaller than PAR created ones. |
57 |
|
|
|
58 |
|
|
Shared objects and the perl binary contain a lot of extra info, while |
59 |
|
|
the static nature of F<staticperl> allows the linker to remove all |
60 |
|
|
functionality and meta-info not required by the final executable. Even |
61 |
|
|
extensions statically compiled into perl at build time will only be |
62 |
|
|
present in the final executable when needed. |
63 |
|
|
|
64 |
|
|
In addition, F<staticperl> can strip perl sources much more effectively |
65 |
|
|
than PAR. |
66 |
|
|
|
67 |
|
|
=item * The generated executables start much faster. |
68 |
|
|
|
69 |
|
|
There is no need to unpack files, or even to parse Zip archives (which is |
70 |
|
|
slow and memory-consuming business). |
71 |
|
|
|
72 |
|
|
=item * The generated executables don't need a writable filesystem. |
73 |
|
|
|
74 |
|
|
F<staticperl> loads all required files directly from memory. There is no |
75 |
|
|
need to unpack files into a temporary directory. |
76 |
|
|
|
77 |
root |
1.17 |
=item * More control over included files, more burden. |
78 |
root |
1.1 |
|
79 |
root |
1.3 |
PAR tries to be maintenance and hassle-free - it tries to include more |
80 |
root |
1.17 |
files than necessary to make sure everything works out of the box. It |
81 |
|
|
mostly succeeds at this, but he extra files (such as the unicode database) |
82 |
|
|
can take substantial amounts of memory and file size. |
83 |
root |
1.1 |
|
84 |
|
|
With F<staticperl>, the burden is mostly with the developer - only direct |
85 |
|
|
compile-time dependencies and L<AutoLoader> are handled automatically. |
86 |
|
|
This means the modules to include often need to be tweaked manually. |
87 |
|
|
|
88 |
root |
1.17 |
All this does not preclude more permissive modes to be implemented in |
89 |
root |
1.46 |
the future, but right now, you have to resolve hidden dependencies |
90 |
root |
1.17 |
manually. |
91 |
|
|
|
92 |
root |
1.1 |
=item * PAR works out of the box, F<staticperl> does not. |
93 |
|
|
|
94 |
|
|
Maintaining your own custom perl build can be a pain in the ass, and while |
95 |
|
|
F<staticperl> tries to make this easy, it still requires a custom perl |
96 |
|
|
build and possibly fiddling with some modules. PAR is likely to produce |
97 |
|
|
results faster. |
98 |
|
|
|
99 |
root |
1.13 |
Ok, PAR never has worked for me out of the box, and for some people, |
100 |
|
|
F<staticperl> does work out of the box, as they don't count "fiddling with |
101 |
|
|
module use lists" against it, but nevertheless, F<staticperl> is certainly |
102 |
|
|
a bit more difficult to use. |
103 |
|
|
|
104 |
root |
1.1 |
=back |
105 |
|
|
|
106 |
|
|
=head1 HOW DOES IT WORK? |
107 |
|
|
|
108 |
|
|
Simple: F<staticperl> downloads, compile and installs a perl version of |
109 |
|
|
your choice in F<~/.staticperl>. You can add extra modules either by |
110 |
|
|
letting F<staticperl> install them for you automatically, or by using CPAN |
111 |
|
|
and doing it interactively. This usually takes 5-10 minutes, depending on |
112 |
root |
1.3 |
the speed of your computer and your internet connection. |
113 |
root |
1.1 |
|
114 |
|
|
It is possible to do program development at this stage, too. |
115 |
|
|
|
116 |
|
|
Afterwards, you create a list of files and modules you want to include, |
117 |
root |
1.3 |
and then either build a new perl binary (that acts just like a normal perl |
118 |
root |
1.1 |
except everything is compiled in), or you create bundle files (basically C |
119 |
|
|
sources you can use to embed all files into your project). |
120 |
|
|
|
121 |
root |
1.18 |
This step is very fast (a few seconds if PPI is not used for stripping, or |
122 |
|
|
the stripped files are in the cache), and can be tweaked and repeated as |
123 |
|
|
often as necessary. |
124 |
root |
1.1 |
|
125 |
|
|
=head1 THE F<STATICPERL> SCRIPT |
126 |
|
|
|
127 |
|
|
This module installs a script called F<staticperl> into your perl |
128 |
root |
1.21 |
binary directory. The script is fully self-contained, and can be |
129 |
|
|
used without perl (for example, in an uClibc chroot environment). In |
130 |
|
|
fact, it can be extracted from the C<App::Staticperl> distribution |
131 |
|
|
tarball as F<bin/staticperl>, without any installation. The |
132 |
|
|
newest (possibly alpha) version can also be downloaded from |
133 |
|
|
L<http://staticperl.schmorp.de/staticperl>. |
134 |
root |
1.1 |
|
135 |
|
|
F<staticperl> interprets the first argument as a command to execute, |
136 |
|
|
optionally followed by any parameters. |
137 |
|
|
|
138 |
|
|
There are two command categories: the "phase 1" commands which deal with |
139 |
|
|
installing perl and perl modules, and the "phase 2" commands, which deal |
140 |
|
|
with creating binaries and bundle files. |
141 |
|
|
|
142 |
|
|
=head2 PHASE 1 COMMANDS: INSTALLING PERL |
143 |
|
|
|
144 |
|
|
The most important command is F<install>, which does basically |
145 |
root |
1.36 |
everything. The default is to download and install perl 5.12.3 and a few |
146 |
root |
1.1 |
modules required by F<staticperl> itself, but all this can (and should) be |
147 |
|
|
changed - see L<CONFIGURATION>, below. |
148 |
|
|
|
149 |
|
|
The command |
150 |
|
|
|
151 |
|
|
staticperl install |
152 |
|
|
|
153 |
root |
1.24 |
is normally all you need: It installs the perl interpreter in |
154 |
root |
1.1 |
F<~/.staticperl/perl>. It downloads, configures, builds and installs the |
155 |
|
|
perl interpreter if required. |
156 |
|
|
|
157 |
root |
1.24 |
Most of the following F<staticperl> subcommands simply run one or more |
158 |
|
|
steps of this sequence. |
159 |
|
|
|
160 |
|
|
If it fails, then most commonly because the compiler options I selected |
161 |
|
|
are not supported by your compiler - either edit the F<staticperl> script |
162 |
|
|
yourself or create F<~/.staticperl> shell script where your set working |
163 |
|
|
C<PERL_CCFLAGS> etc. variables. |
164 |
root |
1.1 |
|
165 |
root |
1.3 |
To force recompilation or reinstallation, you need to run F<staticperl |
166 |
root |
1.1 |
distclean> first. |
167 |
|
|
|
168 |
|
|
=over 4 |
169 |
|
|
|
170 |
root |
1.20 |
=item F<staticperl version> |
171 |
|
|
|
172 |
|
|
Prints some info about the version of the F<staticperl> script you are using. |
173 |
|
|
|
174 |
root |
1.1 |
=item F<staticperl fetch> |
175 |
|
|
|
176 |
|
|
Runs only the download and unpack phase, unless this has already happened. |
177 |
|
|
|
178 |
|
|
=item F<staticperl configure> |
179 |
|
|
|
180 |
|
|
Configures the unpacked perl sources, potentially after downloading them first. |
181 |
|
|
|
182 |
|
|
=item F<staticperl build> |
183 |
|
|
|
184 |
|
|
Builds the configured perl sources, potentially after automatically |
185 |
|
|
configuring them. |
186 |
|
|
|
187 |
|
|
=item F<staticperl install> |
188 |
|
|
|
189 |
root |
1.3 |
Wipes the perl installation directory (usually F<~/.staticperl/perl>) and |
190 |
|
|
installs the perl distribution, potentially after building it first. |
191 |
root |
1.1 |
|
192 |
root |
1.39 |
=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 |
|
|
|
202 |
root |
1.1 |
=item F<staticperl cpan> [args...] |
203 |
|
|
|
204 |
root |
1.3 |
Starts an interactive CPAN shell that you can use to install further |
205 |
|
|
modules. Installs the perl first if necessary, but apart from that, |
206 |
root |
1.1 |
no magic is involved: you could just as well run it manually via |
207 |
root |
1.47 |
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. |
210 |
root |
1.1 |
|
211 |
|
|
Any additional arguments are simply passed to the F<cpan> command. |
212 |
|
|
|
213 |
|
|
=item F<staticperl instcpan> module... |
214 |
|
|
|
215 |
|
|
Tries to install all the modules given and their dependencies, using CPAN. |
216 |
|
|
|
217 |
|
|
Example: |
218 |
|
|
|
219 |
|
|
staticperl instcpan EV AnyEvent::HTTPD Coro |
220 |
|
|
|
221 |
|
|
=item F<staticperl instsrc> directory... |
222 |
|
|
|
223 |
|
|
In the unlikely case that you have unpacked perl modules around and want |
224 |
root |
1.3 |
to install from these instead of from CPAN, you can do this using this |
225 |
root |
1.1 |
command by specifying all the directories with modules in them that you |
226 |
|
|
want to have built. |
227 |
|
|
|
228 |
|
|
=item F<staticperl clean> |
229 |
|
|
|
230 |
root |
1.12 |
Deletes the perl source directory (and potentially cleans up other |
231 |
|
|
intermediate files). This can be used to clean up files only needed for |
232 |
root |
1.24 |
building perl, without removing the installed perl interpreter. |
233 |
root |
1.12 |
|
234 |
|
|
At the moment, it doesn't delete downloaded tarballs. |
235 |
root |
1.1 |
|
236 |
root |
1.24 |
The exact semantics of this command will probably change. |
237 |
|
|
|
238 |
root |
1.1 |
=item F<staticperl distclean> |
239 |
|
|
|
240 |
|
|
This wipes your complete F<~/.staticperl> directory. Be careful with this, |
241 |
|
|
it nukes your perl download, perl sources, perl distribution and any |
242 |
|
|
installed modules. It is useful if you wish to start over "from scratch" |
243 |
|
|
or when you want to uninstall F<staticperl>. |
244 |
|
|
|
245 |
|
|
=back |
246 |
|
|
|
247 |
|
|
=head2 PHASE 2 COMMANDS: BUILDING PERL BUNDLES |
248 |
|
|
|
249 |
|
|
Building (linking) a new F<perl> binary is handled by a separate |
250 |
|
|
script. To make it easy to use F<staticperl> from a F<chroot>, the script |
251 |
|
|
is embedded into F<staticperl>, which will write it out and call for you |
252 |
|
|
with any arguments you pass: |
253 |
|
|
|
254 |
|
|
staticperl mkbundle mkbundle-args... |
255 |
|
|
|
256 |
|
|
In the oh so unlikely case of something not working here, you |
257 |
root |
1.2 |
can run the script manually as well (by default it is written to |
258 |
root |
1.1 |
F<~/.staticperl/mkbundle>). |
259 |
|
|
|
260 |
|
|
F<mkbundle> is a more conventional command and expect the argument |
261 |
root |
1.3 |
syntax commonly used on UNIX clones. For example, this command builds |
262 |
root |
1.1 |
a new F<perl> binary and includes F<Config.pm> (for F<perl -V>), |
263 |
|
|
F<AnyEvent::HTTPD>, F<URI> and a custom F<httpd> script (from F<eg/httpd> |
264 |
|
|
in this distribution): |
265 |
|
|
|
266 |
|
|
# first make sure we have perl and the required modules |
267 |
|
|
staticperl instcpan AnyEvent::HTTPD |
268 |
|
|
|
269 |
|
|
# now build the perl |
270 |
root |
1.37 |
staticperl mkperl -MConfig_heavy.pl -MAnyEvent::Impl::Perl \ |
271 |
root |
1.1 |
-MAnyEvent::HTTPD -MURI::http \ |
272 |
|
|
--add 'eg/httpd httpd.pm' |
273 |
|
|
|
274 |
|
|
# finally, invoke it |
275 |
|
|
./perl -Mhttpd |
276 |
|
|
|
277 |
|
|
As you can see, things are not quite as trivial: the L<Config> module has |
278 |
|
|
a hidden dependency which is not even a perl module (F<Config_heavy.pl>), |
279 |
|
|
L<AnyEvent> needs at least one event loop backend that we have to |
280 |
root |
1.3 |
specify manually (here L<AnyEvent::Impl::Perl>), and the F<URI> module |
281 |
root |
1.1 |
(required by L<AnyEvent::HTTPD>) implements various URI schemes as extra |
282 |
|
|
modules - since L<AnyEvent::HTTPD> only needs C<http> URIs, we only need |
283 |
root |
1.3 |
to include that module. I found out about these dependencies by carefully |
284 |
|
|
watching any error messages about missing modules... |
285 |
root |
1.1 |
|
286 |
root |
1.14 |
Instead of building a new perl binary, you can also build a standalone |
287 |
|
|
application: |
288 |
|
|
|
289 |
|
|
# build the app |
290 |
|
|
staticperl mkapp app --boot eg/httpd \ |
291 |
|
|
-MAnyEvent::Impl::Perl -MAnyEvent::HTTPD -MURI::http |
292 |
|
|
|
293 |
|
|
# run it |
294 |
|
|
./app |
295 |
|
|
|
296 |
root |
1.25 |
Here are the three phase 2 commands: |
297 |
|
|
|
298 |
|
|
=over 4 |
299 |
|
|
|
300 |
|
|
=item F<staticperl mkbundle> args... |
301 |
|
|
|
302 |
|
|
The "default" bundle command - it interprets the given bundle options and |
303 |
|
|
writes out F<bundle.h>, F<bundle.c>, F<bundle.ccopts> and F<bundle.ldopts> |
304 |
|
|
files, useful for embedding. |
305 |
|
|
|
306 |
|
|
=item F<staticperl mkperl> args... |
307 |
|
|
|
308 |
|
|
Creates a bundle just like F<staticperl mkbundle> (in fact, it's the same |
309 |
|
|
as invoking F<staticperl mkbundle --perl> args...), but then compiles and |
310 |
|
|
links a new perl interpreter that embeds the created bundle, then deletes |
311 |
|
|
all intermediate files. |
312 |
|
|
|
313 |
|
|
=item F<staticperl mkapp> filename args... |
314 |
|
|
|
315 |
|
|
Does the same as F<staticperl mkbundle> (in fact, it's the same as |
316 |
|
|
invoking F<staticperl mkbundle --app> filename args...), but then compiles |
317 |
|
|
and links a new standalone application that simply initialises the perl |
318 |
|
|
interpreter. |
319 |
|
|
|
320 |
|
|
The difference to F<staticperl mkperl> is that the standalone application |
321 |
|
|
does not act like a perl interpreter would - in fact, by default it would |
322 |
|
|
just do nothing and exit immediately, so you should specify some code to |
323 |
|
|
be executed via the F<--boot> option. |
324 |
|
|
|
325 |
|
|
=back |
326 |
|
|
|
327 |
root |
1.1 |
=head3 OPTION PROCESSING |
328 |
|
|
|
329 |
root |
1.3 |
All options can be given as arguments on the command line (typically |
330 |
|
|
using long (e.g. C<--verbose>) or short option (e.g. C<-v>) style). Since |
331 |
root |
1.27 |
specifying a lot of options can make the command line very long and |
332 |
|
|
unwieldy, you can put all long options into a "bundle specification file" |
333 |
|
|
(one option per line, with or without C<--> prefix) and specify this |
334 |
|
|
bundle file instead. |
335 |
root |
1.1 |
|
336 |
root |
1.27 |
For example, the command given earlier to link a new F<perl> could also |
337 |
|
|
look like this: |
338 |
root |
1.1 |
|
339 |
|
|
staticperl mkperl httpd.bundle |
340 |
|
|
|
341 |
root |
1.27 |
With all options stored in the F<httpd.bundle> file (one option per line, |
342 |
|
|
everything after the option is an argument): |
343 |
|
|
|
344 |
root |
1.1 |
use "Config_heavy.pl" |
345 |
|
|
use AnyEvent::Impl::Perl |
346 |
|
|
use AnyEvent::HTTPD |
347 |
|
|
use URI::http |
348 |
|
|
add eg/httpd httpd.pm |
349 |
|
|
|
350 |
root |
1.2 |
All options that specify modules or files to be added are processed in the |
351 |
root |
1.25 |
order given on the command line. |
352 |
root |
1.2 |
|
353 |
root |
1.27 |
=head3 BUNDLE CREATION WORKFLOW / STATICPELR MKBUNDLE OPTIONS |
354 |
root |
1.19 |
|
355 |
root |
1.26 |
F<staticperl mkbundle> works by first assembling a list of candidate |
356 |
|
|
files and modules to include, then filtering them by include/exclude |
357 |
root |
1.27 |
patterns. The remaining modules (together with their direct dependencies, |
358 |
|
|
such as link libraries and L<AutoLoader> files) are then converted into |
359 |
|
|
bundle files suitable for embedding. F<staticperl mkbundle> can then |
360 |
|
|
optionally build a new perl interpreter or a standalone application. |
361 |
root |
1.19 |
|
362 |
|
|
=over 4 |
363 |
|
|
|
364 |
root |
1.26 |
=item Step 0: Generic argument processing. |
365 |
root |
1.19 |
|
366 |
root |
1.26 |
The following options influence F<staticperl mkbundle> itself. |
367 |
root |
1.1 |
|
368 |
|
|
=over 4 |
369 |
|
|
|
370 |
root |
1.27 |
=item C<--verbose> | C<-v> |
371 |
root |
1.2 |
|
372 |
|
|
Increases the verbosity level by one (the default is C<1>). |
373 |
|
|
|
374 |
root |
1.27 |
=item C<--quiet> | C<-q> |
375 |
root |
1.2 |
|
376 |
|
|
Decreases the verbosity level by one. |
377 |
|
|
|
378 |
root |
1.26 |
=item any other argument |
379 |
root |
1.2 |
|
380 |
root |
1.26 |
Any other argument is interpreted as a bundle specification file, which |
381 |
root |
1.27 |
supports all options (without extra quoting), one option per line, in the |
382 |
|
|
format C<option> or C<option argument>. They will effectively be expanded |
383 |
|
|
and processed as if they were directly written on the command line, in |
384 |
|
|
place of the file name. |
385 |
root |
1.2 |
|
386 |
root |
1.26 |
=back |
387 |
root |
1.2 |
|
388 |
root |
1.26 |
=item Step 1: gather candidate files and modules |
389 |
root |
1.2 |
|
390 |
root |
1.26 |
In this step, modules, perl libraries (F<.pl> files) and other files are |
391 |
|
|
selected for inclusion in the bundle. The relevant options are executed |
392 |
|
|
in order (this makes a difference mostly for C<--eval>, which can rely on |
393 |
|
|
earlier C<--use> options to have been executed). |
394 |
root |
1.2 |
|
395 |
root |
1.26 |
=over 4 |
396 |
root |
1.2 |
|
397 |
root |
1.26 |
=item C<--use> F<module> | C<-M>F<module> |
398 |
root |
1.14 |
|
399 |
root |
1.37 |
Include the named module or perl library and trace direct |
400 |
|
|
dependencies. This is done by loading the module in a subprocess and |
401 |
|
|
tracing which other modules and files it actually loads. |
402 |
root |
1.2 |
|
403 |
|
|
Example: include AnyEvent and AnyEvent::Impl::Perl. |
404 |
|
|
|
405 |
|
|
staticperl mkbundle --use AnyEvent --use AnyEvent::Impl::Perl |
406 |
|
|
|
407 |
root |
1.37 |
Sometimes you want to load old-style "perl libraries" (F<.pl> files), or |
408 |
|
|
maybe other weirdly named files. To support this, the C<--use> option |
409 |
|
|
actually tries to do what you mean, depending on the string you specify: |
410 |
|
|
|
411 |
|
|
=over 4 |
412 |
|
|
|
413 |
|
|
=item a possibly valid module name, e.g. F<common::sense>, F<Carp>, |
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 |
446 |
root |
1.2 |
|
447 |
|
|
Example: include the required files for F<perl -V> to work in all its |
448 |
root |
1.37 |
glory (F<Config.pm> is included automatically by the dependency tracker). |
449 |
root |
1.2 |
|
450 |
root |
1.37 |
# shell command |
451 |
|
|
staticperl mkbundle -MConfig_heavy.pl |
452 |
root |
1.2 |
|
453 |
|
|
# bundle specification file |
454 |
root |
1.37 |
use Config_heavy.pl |
455 |
root |
1.2 |
|
456 |
root |
1.28 |
The C<-M>module syntax is included as a convenience that might be easier |
457 |
|
|
to remember than C<--use> - it's the same switch as perl itself uses |
458 |
|
|
to load modules. Or maybe it confuses people. Time will tell. Or maybe |
459 |
|
|
not. Sigh. |
460 |
root |
1.2 |
|
461 |
root |
1.26 |
=item C<--eval> "perl code" | C<-e> "perl code" |
462 |
root |
1.2 |
|
463 |
|
|
Sometimes it is easier (or necessary) to specify dependencies using perl |
464 |
|
|
code, or maybe one of the modules you use need a special use statement. In |
465 |
root |
1.26 |
that case, you can use C<--eval> to execute some perl snippet or set some |
466 |
|
|
variables or whatever you need. All files C<require>'d or C<use>'d while |
467 |
|
|
executing the snippet are included in the final bundle. |
468 |
root |
1.2 |
|
469 |
root |
1.32 |
Keep in mind that F<mkbundle> will not import any symbols from the modules |
470 |
|
|
named by the C<--use> option, so do not expect the symbols from modules |
471 |
|
|
you C<--use>'d earlier on the command line to be available. |
472 |
root |
1.2 |
|
473 |
|
|
Example: force L<AnyEvent> to detect a backend and therefore include it |
474 |
|
|
in the final bundle. |
475 |
|
|
|
476 |
|
|
staticperl mkbundle --eval 'use AnyEvent; AnyEvent::detect' |
477 |
|
|
|
478 |
|
|
# or like this |
479 |
root |
1.26 |
staticperl mkbundle -MAnyEvent --eval 'AnyEvent::detect' |
480 |
root |
1.2 |
|
481 |
|
|
Example: use a separate "bootstrap" script that C<use>'s lots of modules |
482 |
root |
1.26 |
and also include this in the final bundle, to be executed automatically |
483 |
|
|
when the interpreter is initialised. |
484 |
root |
1.2 |
|
485 |
|
|
staticperl mkbundle --eval 'do "bootstrap"' --boot bootstrap |
486 |
|
|
|
487 |
root |
1.26 |
=item C<--boot> F<filename> |
488 |
|
|
|
489 |
|
|
Include the given file in the bundle and arrange for it to be |
490 |
|
|
executed (using C<require>) before the main program when the new perl |
491 |
|
|
is initialised. This can be used to modify C<@INC> or do similar |
492 |
|
|
modifications before the perl interpreter executes scripts given on the |
493 |
|
|
command line (or via C<-e>). This works even in an embedded interpreter - |
494 |
|
|
the file will be executed during interpreter initialisation in that case. |
495 |
|
|
|
496 |
|
|
=item C<--incglob> pattern |
497 |
|
|
|
498 |
|
|
This goes through all standard library directories and tries to match any |
499 |
|
|
F<.pm> and F<.pl> files against the extended glob pattern (see below). If |
500 |
|
|
a file matches, it is added. The pattern is matched against the full path |
501 |
|
|
of the file (sans the library directory prefix), e.g. F<Sys/Syslog.pm>. |
502 |
|
|
|
503 |
|
|
This is very useful to include "everything": |
504 |
|
|
|
505 |
|
|
--incglob '*' |
506 |
|
|
|
507 |
|
|
It is also useful for including perl libraries, or trees of those, such as |
508 |
root |
1.28 |
the unicode database files needed by some perl built-ins, the regex engine |
509 |
root |
1.26 |
and other modules. |
510 |
|
|
|
511 |
|
|
--incglob '/unicore/**.pl' |
512 |
|
|
|
513 |
|
|
=item C<--add> F<file> | C<--add> "F<file> alias" |
514 |
|
|
|
515 |
|
|
Adds the given (perl) file into the bundle (and optionally call it |
516 |
root |
1.34 |
"alias"). The F<file> is either an absolute path or a path relative to the |
517 |
|
|
current directory. If an alias is specified, then this is the name it will |
518 |
root |
1.35 |
use for C<@INC> searches, otherwise the path F<file> will be used as the |
519 |
root |
1.26 |
internal name. |
520 |
|
|
|
521 |
|
|
This switch is used to include extra files into the bundle. |
522 |
|
|
|
523 |
|
|
Example: embed the file F<httpd> in the current directory as F<httpd.pm> |
524 |
|
|
when creating the bundle. |
525 |
|
|
|
526 |
|
|
staticperl mkperl --add "httpd httpd.pm" |
527 |
|
|
|
528 |
root |
1.34 |
# can be accessed via "use httpd" |
529 |
|
|
|
530 |
|
|
Example: add a file F<initcode> from the current directory. |
531 |
|
|
|
532 |
root |
1.35 |
staticperl mkperl --add 'initcode &initcode' |
533 |
root |
1.34 |
|
534 |
|
|
# can be accessed via "do '&initcode'" |
535 |
|
|
|
536 |
root |
1.26 |
Example: add local files as extra modules in the bundle. |
537 |
|
|
|
538 |
|
|
# specification file |
539 |
|
|
add file1 myfiles/file1.pm |
540 |
|
|
add file2 myfiles/file2.pm |
541 |
|
|
add file3 myfiles/file3.pl |
542 |
|
|
|
543 |
|
|
# then later, in perl, use |
544 |
|
|
use myfiles::file1; |
545 |
|
|
require myfiles::file2; |
546 |
|
|
my $res = do "myfiles/file3.pl"; |
547 |
|
|
|
548 |
|
|
=item C<--binadd> F<file> | C<--add> "F<file> alias" |
549 |
|
|
|
550 |
|
|
Just like C<--add>, except that it treats the file as binary and adds it |
551 |
|
|
without any postprocessing (perl files might get stripped to reduce their |
552 |
|
|
size). |
553 |
|
|
|
554 |
root |
1.48 |
If you specify an alias you should probably add a C</> prefix to avoid |
555 |
|
|
clashing with embedded perl files (whose paths never start with C</>), |
556 |
|
|
and/or use a special directory prefix, such as C</res/name>. |
557 |
root |
1.26 |
|
558 |
|
|
You can later get a copy of these files by calling C<staticperl::find |
559 |
|
|
"alias">. |
560 |
|
|
|
561 |
|
|
An alternative way to embed binary files is to convert them to perl and |
562 |
|
|
use C<do> to get the contents - this method is a bit cumbersome, but works |
563 |
root |
1.48 |
both inside and outside of a staticperl bundle, without extra ado: |
564 |
root |
1.2 |
|
565 |
root |
1.26 |
# a "binary" file, call it "bindata.pl" |
566 |
|
|
<<'SOME_MARKER' |
567 |
|
|
binary data NOT containing SOME_MARKER |
568 |
|
|
SOME_MARKER |
569 |
root |
1.2 |
|
570 |
root |
1.26 |
# load the binary |
571 |
|
|
chomp (my $data = do "bindata.pl"); |
572 |
|
|
|
573 |
root |
1.48 |
=item C<--allow-dynamic> |
574 |
root |
1.47 |
|
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 |
root |
1.48 |
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 |
root |
1.47 |
|
588 |
|
|
#TODO: example |
589 |
|
|
|
590 |
root |
1.26 |
=back |
591 |
|
|
|
592 |
|
|
=item Step 2: filter all files using C<--include> and C<--exclude> options. |
593 |
|
|
|
594 |
|
|
After all candidate files and modules are added, they are I<filtered> |
595 |
|
|
by a combination of C<--include> and C<--exclude> patterns (there is an |
596 |
root |
1.28 |
implicit C<--include *> at the end, so if no filters are specified, all |
597 |
root |
1.26 |
files are included). |
598 |
|
|
|
599 |
|
|
All that this step does is potentially reduce the number of files that are |
600 |
|
|
to be included - no new files are added during this step. |
601 |
|
|
|
602 |
|
|
=over 4 |
603 |
|
|
|
604 |
|
|
=item C<--include> pattern | C<-i> pattern | C<--exclude> pattern | C<-x> pattern |
605 |
|
|
|
606 |
|
|
These specify an include or exclude pattern to be applied to the candidate |
607 |
|
|
file list. An include makes sure that the given files will be part of the |
608 |
|
|
resulting file set, an exclude will exclude remaining files. The patterns |
609 |
|
|
are "extended glob patterns" (see below). |
610 |
|
|
|
611 |
|
|
The patterns are applied "in order" - files included via earlier |
612 |
|
|
C<--include> specifications cannot be removed by any following |
613 |
|
|
C<--exclude>, and likewise, and file excluded by an earlier C<--exclude> |
614 |
|
|
cannot be added by any following C<--include>. |
615 |
|
|
|
616 |
|
|
For example, to include everything except C<Devel> modules, but still |
617 |
|
|
include F<Devel::PPPort>, you could use this: |
618 |
|
|
|
619 |
|
|
--incglob '*' -i '/Devel/PPPort.pm' -x '/Devel/**' |
620 |
|
|
|
621 |
|
|
=back |
622 |
|
|
|
623 |
|
|
=item Step 3: add any extra or "hidden" dependencies. |
624 |
|
|
|
625 |
|
|
F<staticperl> currently knows about three extra types of depdendencies |
626 |
|
|
that are added automatically. Only one (F<.packlist> files) is currently |
627 |
|
|
optional and can be influenced, the others are always included: |
628 |
|
|
|
629 |
|
|
=over 4 |
630 |
|
|
|
631 |
root |
1.29 |
=item C<--usepacklists> |
632 |
root |
1.20 |
|
633 |
|
|
Read F<.packlist> files for each distribution that happens to match a |
634 |
|
|
module name you specified. Sounds weird, and it is, so expect semantics to |
635 |
|
|
change somehow in the future. |
636 |
|
|
|
637 |
|
|
The idea is that most CPAN distributions have a F<.pm> file that matches |
638 |
|
|
the name of the distribution (which is rather reasonable after all). |
639 |
|
|
|
640 |
|
|
If this switch is enabled, then if any of the F<.pm> files that have been |
641 |
|
|
selected match an install distribution, then all F<.pm>, F<.pl>, F<.al> |
642 |
|
|
and F<.ix> files installed by this distribution are also included. |
643 |
|
|
|
644 |
|
|
For example, using this switch, when the L<URI> module is specified, then |
645 |
|
|
all L<URI> submodules that have been installed via the CPAN distribution |
646 |
|
|
are included as well, so you don't have to manually specify them. |
647 |
|
|
|
648 |
root |
1.26 |
=item L<AutoLoader> splitfiles |
649 |
root |
1.18 |
|
650 |
root |
1.26 |
Some modules use L<AutoLoader> - less commonly (hopefully) used functions |
651 |
|
|
are split into separate F<.al> files, and an index (F<.ix>) file contains |
652 |
|
|
the prototypes. |
653 |
root |
1.18 |
|
654 |
root |
1.26 |
Both F<.ix> and F<.al> files will be detected automatically and added to |
655 |
|
|
the bundle. |
656 |
root |
1.18 |
|
657 |
root |
1.26 |
=item link libraries (F<.a> files) |
658 |
|
|
|
659 |
|
|
Modules using XS (or any other non-perl language extension compiled at |
660 |
|
|
installation time) will have a static archive (typically F<.a>). These |
661 |
|
|
will automatically be added to the linker options in F<bundle.ldopts>. |
662 |
|
|
|
663 |
|
|
Should F<staticperl> find a dynamic link library (typically F<.so>) it |
664 |
|
|
will warn about it - obviously this shouldn't happen unless you use |
665 |
|
|
F<staticperl> on the wrong perl, or one (probably wrongly) configured to |
666 |
|
|
use dynamic loading. |
667 |
|
|
|
668 |
|
|
=item extra libraries (F<extralibs.ld>) |
669 |
|
|
|
670 |
|
|
Some modules need linking against external libraries - these are found in |
671 |
|
|
F<extralibs.ld> and added to F<bundle.ldopts>. |
672 |
|
|
|
673 |
|
|
=back |
674 |
|
|
|
675 |
|
|
=item Step 4: write bundle files and optionally link a program |
676 |
|
|
|
677 |
|
|
At this point, the select files will be read, processed (stripped) and |
678 |
|
|
finally the bundle files get written to disk, and F<staticperl mkbundle> |
679 |
|
|
is normally finished. Optionally, it can go a step further and either link |
680 |
|
|
a new F<perl> binary with all selected modules and files inside, or build |
681 |
|
|
a standalone application. |
682 |
|
|
|
683 |
|
|
Both the contents of the bundle files and any extra linking is controlled |
684 |
|
|
by these options: |
685 |
|
|
|
686 |
|
|
=over 4 |
687 |
root |
1.18 |
|
688 |
root |
1.26 |
=item C<--strip> C<none>|C<pod>|C<ppi> |
689 |
root |
1.18 |
|
690 |
root |
1.26 |
Specify the stripping method applied to reduce the file of the perl |
691 |
|
|
sources included. |
692 |
root |
1.18 |
|
693 |
root |
1.26 |
The default is C<pod>, which uses the L<Pod::Strip> module to remove all |
694 |
|
|
pod documentation, which is very fast and reduces file size a lot. |
695 |
root |
1.2 |
|
696 |
root |
1.26 |
The C<ppi> method uses L<PPI> to parse and condense the perl sources. This |
697 |
|
|
saves a lot more than just L<Pod::Strip>, and is generally safer, |
698 |
|
|
but is also a lot slower (some files take almost a minute to strip - |
699 |
|
|
F<staticperl> maintains a cache of stripped files to speed up subsequent |
700 |
|
|
runs for this reason). Note that this method doesn't optimise for raw file |
701 |
|
|
size, but for best compression (that means that the uncompressed file size |
702 |
|
|
is a bit larger, but the files compress better, e.g. with F<upx>). |
703 |
|
|
|
704 |
|
|
Last not least, if you need accurate line numbers in error messages, |
705 |
|
|
or in the unlikely case where C<pod> is too slow, or some module gets |
706 |
|
|
mistreated, you can specify C<none> to not mangle included perl sources in |
707 |
|
|
any way. |
708 |
root |
1.2 |
|
709 |
root |
1.28 |
=item C<--perl> |
710 |
root |
1.2 |
|
711 |
root |
1.26 |
After writing out the bundle files, try to link a new perl interpreter. It |
712 |
|
|
will be called F<perl> and will be left in the current working |
713 |
|
|
directory. The bundle files will be removed. |
714 |
root |
1.2 |
|
715 |
root |
1.26 |
This switch is automatically used when F<staticperl> is invoked with the |
716 |
|
|
C<mkperl> command instead of C<mkbundle>. |
717 |
root |
1.2 |
|
718 |
root |
1.26 |
Example: build a new F<./perl> binary with only L<common::sense> inside - |
719 |
|
|
it will be even smaller than the standard perl interpreter as none of the |
720 |
|
|
modules of the base distribution (such as L<Fcntl>) will be included. |
721 |
root |
1.2 |
|
722 |
root |
1.26 |
staticperl mkperl -Mcommon::sense |
723 |
root |
1.10 |
|
724 |
root |
1.28 |
=item C<--app> F<name> |
725 |
root |
1.10 |
|
726 |
root |
1.26 |
After writing out the bundle files, try to link a new standalone |
727 |
|
|
program. It will be called C<name>, and the bundle files get removed after |
728 |
|
|
linking it. |
729 |
root |
1.10 |
|
730 |
root |
1.26 |
This switch is automatically used when F<staticperl> is invoked with the |
731 |
|
|
C<mkapp> command instead of C<mkbundle>. |
732 |
root |
1.10 |
|
733 |
root |
1.26 |
The difference to the (mutually exclusive) C<--perl> option is that the |
734 |
|
|
binary created by this option will not try to act as a perl interpreter - |
735 |
|
|
instead it will simply initialise the perl interpreter, clean it up and |
736 |
|
|
exit. |
737 |
root |
1.18 |
|
738 |
root |
1.34 |
This means that, by default, it will do nothing but burn a few CPU cycles |
739 |
root |
1.26 |
- for it to do something useful you I<must> add some boot code, e.g. with |
740 |
|
|
the C<--boot> option. |
741 |
root |
1.18 |
|
742 |
root |
1.26 |
Example: create a standalone perl binary called F<./myexe> that will |
743 |
|
|
execute F<appfile> when it is started. |
744 |
root |
1.18 |
|
745 |
root |
1.26 |
staticperl mkbundle --app myexe --boot appfile |
746 |
root |
1.18 |
|
747 |
root |
1.37 |
=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 underaible |
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 |
|
|
|
770 |
root |
1.28 |
=item C<--static> |
771 |
root |
1.2 |
|
772 |
root |
1.26 |
Add C<-static> to F<bundle.ldopts>, which means a fully static (if |
773 |
|
|
supported by the OS) executable will be created. This is not immensely |
774 |
|
|
useful when just creating the bundle files, but is most useful when |
775 |
|
|
linking a binary with the C<--perl> or C<--app> options. |
776 |
|
|
|
777 |
|
|
The default is to link the new binary dynamically (that means all perl |
778 |
|
|
modules are linked statically, but all external libraries are still |
779 |
root |
1.2 |
referenced dynamically). |
780 |
|
|
|
781 |
|
|
Keep in mind that Solaris doesn't support static linking at all, and |
782 |
root |
1.26 |
systems based on GNU libc don't really support it in a very usable |
783 |
|
|
fashion either. Try uClibc if you want to create fully statically linked |
784 |
|
|
executables, or try the C<--staticlib> option to link only some libraries |
785 |
root |
1.2 |
statically. |
786 |
|
|
|
787 |
root |
1.28 |
=item C<--staticlib> libname |
788 |
root |
1.18 |
|
789 |
|
|
When not linking fully statically, this option allows you to link specific |
790 |
root |
1.28 |
libraries statically. What it does is simply replace all occurrences of |
791 |
root |
1.18 |
C<-llibname> with the GCC-specific C<-Wl,-Bstatic -llibname -Wl,-Bdynamic> |
792 |
|
|
option. |
793 |
|
|
|
794 |
|
|
This will have no effect unless the library is actually linked against, |
795 |
|
|
specifically, C<--staticlib> will not link against the named library |
796 |
|
|
unless it would be linked against anyway. |
797 |
|
|
|
798 |
root |
1.28 |
Example: link libcrypt statically into the final binary. |
799 |
root |
1.18 |
|
800 |
|
|
staticperl mkperl -MIO::AIO --staticlib crypt |
801 |
|
|
|
802 |
root |
1.26 |
# ldopts might now contain: |
803 |
root |
1.18 |
# -lm -Wl,-Bstatic -lcrypt -Wl,-Bdynamic -lpthread |
804 |
|
|
|
805 |
root |
1.26 |
=back |
806 |
root |
1.1 |
|
807 |
|
|
=back |
808 |
|
|
|
809 |
root |
1.18 |
=head3 EXTENDED GLOB PATTERNS |
810 |
|
|
|
811 |
|
|
Some options of F<staticperl mkbundle> expect an I<extended glob |
812 |
|
|
pattern>. This is neither a normal shell glob nor a regex, but something |
813 |
|
|
in between. The idea has been copied from rsync, and there are the current |
814 |
|
|
matching rules: |
815 |
|
|
|
816 |
|
|
=over 4 |
817 |
|
|
|
818 |
|
|
=item Patterns starting with F</> will be a anchored at the root of the library tree. |
819 |
|
|
|
820 |
|
|
That is, F</unicore> will match the F<unicore> directory in C<@INC>, but |
821 |
|
|
nothing inside, and neither any other file or directory called F<unicore> |
822 |
|
|
anywhere else in the hierarchy. |
823 |
|
|
|
824 |
|
|
=item Patterns not starting with F</> will be anchored at the end of the path. |
825 |
|
|
|
826 |
|
|
That is, F<idna.pl> will match any file called F<idna.pl> anywhere in the |
827 |
|
|
hierarchy, but not any directories of the same name. |
828 |
|
|
|
829 |
root |
1.29 |
=item A F<*> matches anything within a single path component. |
830 |
root |
1.18 |
|
831 |
|
|
That is, F</unicore/*.pl> would match all F<.pl> files directly inside |
832 |
|
|
C</unicore>, not any deeper level F<.pl> files. Or in other words, F<*> |
833 |
|
|
will not match slashes. |
834 |
|
|
|
835 |
|
|
=item A F<**> matches anything. |
836 |
|
|
|
837 |
|
|
That is, F</unicore/**.pl> would match all F<.pl> files under F</unicore>, |
838 |
|
|
no matter how deeply nested they are inside subdirectories. |
839 |
|
|
|
840 |
|
|
=item A F<?> matches a single character within a component. |
841 |
|
|
|
842 |
|
|
That is, F</Encode/??.pm> matches F</Encode/JP.pm>, but not the |
843 |
|
|
hypothetical F</Encode/J/.pm>, as F<?> does not match F</>. |
844 |
|
|
|
845 |
|
|
=back |
846 |
|
|
|
847 |
root |
1.15 |
=head2 F<STATICPERL> CONFIGURATION AND HOOKS |
848 |
root |
1.1 |
|
849 |
root |
1.20 |
During (each) startup, F<staticperl> tries to source some shell files to |
850 |
|
|
allow you to fine-tune/override configuration settings. |
851 |
|
|
|
852 |
|
|
In them you can override shell variables, or define shell functions |
853 |
|
|
("hooks") to be called at specific phases during installation. For |
854 |
|
|
example, you could define a C<postinstall> hook to install additional |
855 |
|
|
modules from CPAN each time you start from scratch. |
856 |
|
|
|
857 |
|
|
If the env variable C<$STATICPERLRC> is set, then F<staticperl> will try |
858 |
|
|
to source the file named with it only. Otherwise, it tries the following |
859 |
|
|
shell files in order: |
860 |
root |
1.2 |
|
861 |
|
|
/etc/staticperlrc |
862 |
|
|
~/.staticperlrc |
863 |
|
|
$STATICPERL/rc |
864 |
|
|
|
865 |
|
|
Note that the last file is erased during F<staticperl distclean>, so |
866 |
|
|
generally should not be used. |
867 |
|
|
|
868 |
|
|
=head3 CONFIGURATION VARIABLES |
869 |
|
|
|
870 |
|
|
=head4 Variables you I<should> override |
871 |
|
|
|
872 |
|
|
=over 4 |
873 |
|
|
|
874 |
|
|
=item C<EMAIL> |
875 |
|
|
|
876 |
|
|
The e-mail address of the person who built this binary. Has no good |
877 |
|
|
default, so should be specified by you. |
878 |
|
|
|
879 |
|
|
=item C<CPAN> |
880 |
|
|
|
881 |
|
|
The URL of the CPAN mirror to use (e.g. L<http://mirror.netcologne.de/cpan/>). |
882 |
|
|
|
883 |
root |
1.6 |
=item C<EXTRA_MODULES> |
884 |
root |
1.2 |
|
885 |
root |
1.6 |
Additional modules installed during F<staticperl install>. Here you can |
886 |
|
|
set which modules you want have to installed from CPAN. |
887 |
root |
1.2 |
|
888 |
root |
1.11 |
Example: I really really need EV, AnyEvent, Coro and AnyEvent::AIO. |
889 |
root |
1.2 |
|
890 |
root |
1.11 |
EXTRA_MODULES="EV AnyEvent Coro AnyEvent::AIO" |
891 |
root |
1.2 |
|
892 |
root |
1.6 |
Note that you can also use a C<postinstall> hook to achieve this, and |
893 |
|
|
more. |
894 |
root |
1.2 |
|
895 |
root |
1.11 |
=back |
896 |
|
|
|
897 |
|
|
=head4 Variables you might I<want> to override |
898 |
|
|
|
899 |
|
|
=over 4 |
900 |
|
|
|
901 |
|
|
=item C<STATICPERL> |
902 |
|
|
|
903 |
|
|
The directory where staticperl stores all its files |
904 |
|
|
(default: F<~/.staticperl>). |
905 |
|
|
|
906 |
root |
1.43 |
=item C<DLCACHE> |
907 |
root |
1.2 |
|
908 |
root |
1.43 |
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 |
root |
1.2 |
|
912 |
root |
1.11 |
=item C<PERL_VERSION> |
913 |
root |
1.6 |
|
914 |
root |
1.36 |
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 |
root |
1.2 |
|
918 |
root |
1.43 |
=item C<PERL_MM_USE_DEFAULT>, C<EV_EXTRA_DEFS>, ... |
919 |
|
|
|
920 |
|
|
Usually set to C<1> to make modules "less inquisitive" during their |
921 |
root |
1.45 |
installation. You can set (and export!) any environment variable you want |
922 |
|
|
- some modules (such as L<Coro> or L<EV>) use environment variables for |
923 |
|
|
further tweaking. |
924 |
root |
1.43 |
|
925 |
root |
1.11 |
=item C<PERL_PREFIX> |
926 |
root |
1.2 |
|
927 |
root |
1.6 |
The prefix where perl gets installed (default: F<$STATICPERL/perl>), |
928 |
|
|
i.e. where the F<bin> and F<lib> subdirectories will end up. |
929 |
root |
1.2 |
|
930 |
root |
1.10 |
=item C<PERL_CONFIGURE> |
931 |
|
|
|
932 |
|
|
Additional Configure options - these are simply passed to the perl |
933 |
|
|
Configure script. For example, if you wanted to enable dynamic loading, |
934 |
|
|
you could pass C<-Dusedl>. To enable ithreads (Why would you want that |
935 |
|
|
insanity? Don't! Use L<forks> instead!) you would pass C<-Duseithreads> |
936 |
|
|
and so on. |
937 |
|
|
|
938 |
|
|
More commonly, you would either activate 64 bit integer support |
939 |
|
|
(C<-Duse64bitint>), or disable large files support (-Uuselargefiles), to |
940 |
|
|
reduce filesize further. |
941 |
|
|
|
942 |
root |
1.24 |
=item C<PERL_CC>, C<PERL_CCFLAGS>, C<PERL_OPTIMIZE>, C<PERL_LDFLAGS>, C<PERL_LIBS> |
943 |
root |
1.2 |
|
944 |
root |
1.6 |
These flags are passed to perl's F<Configure> script, and are generally |
945 |
|
|
optimised for small size (at the cost of performance). Since they also |
946 |
|
|
contain subtle workarounds around various build issues, changing these |
947 |
root |
1.24 |
usually requires understanding their default values - best look at |
948 |
|
|
the top of the F<staticperl> script for more info on these, and use a |
949 |
|
|
F<~/.staticperlrc> to override them. |
950 |
|
|
|
951 |
|
|
Most of the variables override (or modify) the corresponding F<Configure> |
952 |
|
|
variable, except C<PERL_CCFLAGS>, which gets appended. |
953 |
root |
1.2 |
|
954 |
root |
1.40 |
You should have a look near the beginning of the F<staticperl> script - |
955 |
|
|
staticperl tries to default C<PERL_OPTIMIZE> to some psace-saving options |
956 |
|
|
suitable for newer gcc versions. For other compilers or older versions you |
957 |
|
|
need to adjust these, for example, in your F<~/.staticperlrc>. |
958 |
|
|
|
959 |
root |
1.2 |
=back |
960 |
|
|
|
961 |
root |
1.5 |
=head4 Variables you probably I<do not want> to override |
962 |
root |
1.2 |
|
963 |
|
|
=over 4 |
964 |
|
|
|
965 |
root |
1.23 |
=item C<MAKE> |
966 |
|
|
|
967 |
|
|
The make command to use - default is C<make>. |
968 |
|
|
|
969 |
root |
1.2 |
=item C<MKBUNDLE> |
970 |
|
|
|
971 |
|
|
Where F<staticperl> writes the C<mkbundle> command to |
972 |
|
|
(default: F<$STATICPERL/mkbundle>). |
973 |
|
|
|
974 |
|
|
=item C<STATICPERL_MODULES> |
975 |
|
|
|
976 |
|
|
Additional modules needed by C<mkbundle> - should therefore not be changed |
977 |
|
|
unless you know what you are doing. |
978 |
|
|
|
979 |
|
|
=back |
980 |
|
|
|
981 |
|
|
=head3 OVERRIDABLE HOOKS |
982 |
|
|
|
983 |
|
|
In addition to environment variables, it is possible to provide some |
984 |
|
|
shell functions that are called at specific times. To provide your own |
985 |
root |
1.3 |
commands, just define the corresponding function. |
986 |
root |
1.2 |
|
987 |
root |
1.38 |
The actual order in which hooks are invoked during a full install |
988 |
|
|
from scratch is C<preconfigure>, C<patchconfig>, C<postconfigure>, |
989 |
|
|
C<postbuild>, C<postinstall>. |
990 |
|
|
|
991 |
root |
1.2 |
Example: install extra modules from CPAN and from some directories |
992 |
|
|
at F<staticperl install> time. |
993 |
|
|
|
994 |
|
|
postinstall() { |
995 |
root |
1.4 |
rm -rf lib/threads* # weg mit Schaden |
996 |
root |
1.2 |
instcpan IO::AIO EV |
997 |
|
|
instsrc ~/src/AnyEvent |
998 |
|
|
instsrc ~/src/XML-Sablotron-1.0100001 |
999 |
root |
1.4 |
instcpan Anyevent::AIO AnyEvent::HTTPD |
1000 |
root |
1.2 |
} |
1001 |
|
|
|
1002 |
|
|
=over 4 |
1003 |
|
|
|
1004 |
root |
1.12 |
=item preconfigure |
1005 |
|
|
|
1006 |
root |
1.38 |
Called just before running F<./Configure> in the perl source |
1007 |
root |
1.12 |
directory. Current working directory is the perl source directory. |
1008 |
|
|
|
1009 |
|
|
This can be used to set any C<PERL_xxx> variables, which might be costly |
1010 |
|
|
to compute. |
1011 |
|
|
|
1012 |
root |
1.38 |
=item patchconfig |
1013 |
|
|
|
1014 |
|
|
Called after running F<./Configure> in the perl source directory to create |
1015 |
|
|
F<./config.sh>, but before running F<./Configure -S> to actually apply the |
1016 |
|
|
config. Current working directory is the perl source directory. |
1017 |
|
|
|
1018 |
|
|
Can be used to tailor/patch F<config.sh> or do any other modifications. |
1019 |
|
|
|
1020 |
root |
1.2 |
=item postconfigure |
1021 |
|
|
|
1022 |
|
|
Called after configuring, but before building perl. Current working |
1023 |
|
|
directory is the perl source directory. |
1024 |
|
|
|
1025 |
|
|
=item postbuild |
1026 |
|
|
|
1027 |
|
|
Called after building, but before installing perl. Current working |
1028 |
|
|
directory is the perl source directory. |
1029 |
|
|
|
1030 |
|
|
I have no clue what this could be used for - tell me. |
1031 |
|
|
|
1032 |
|
|
=item postinstall |
1033 |
|
|
|
1034 |
|
|
Called after perl and any extra modules have been installed in C<$PREFIX>, |
1035 |
|
|
but before setting the "installation O.K." flag. |
1036 |
|
|
|
1037 |
|
|
The current working directory is C<$PREFIX>, but maybe you should not rely |
1038 |
|
|
on that. |
1039 |
|
|
|
1040 |
|
|
This hook is most useful to customise the installation, by deleting files, |
1041 |
|
|
or installing extra modules using the C<instcpan> or C<instsrc> functions. |
1042 |
|
|
|
1043 |
|
|
The script must return with a zero exit status, or the installation will |
1044 |
|
|
fail. |
1045 |
|
|
|
1046 |
|
|
=back |
1047 |
root |
1.1 |
|
1048 |
root |
1.9 |
=head1 ANATOMY OF A BUNDLE |
1049 |
|
|
|
1050 |
|
|
When not building a new perl binary, C<mkbundle> will leave a number of |
1051 |
|
|
files in the current working directory, which can be used to embed a perl |
1052 |
|
|
interpreter in your program. |
1053 |
|
|
|
1054 |
|
|
Intimate knowledge of L<perlembed> and preferably some experience with |
1055 |
|
|
embedding perl is highly recommended. |
1056 |
|
|
|
1057 |
|
|
C<mkperl> (or the C<--perl> option) basically does this to link the new |
1058 |
|
|
interpreter (it also adds a main program to F<bundle.>): |
1059 |
|
|
|
1060 |
|
|
$Config{cc} $(cat bundle.ccopts) -o perl bundle.c $(cat bundle.ldopts) |
1061 |
|
|
|
1062 |
|
|
=over 4 |
1063 |
|
|
|
1064 |
|
|
=item bundle.h |
1065 |
|
|
|
1066 |
|
|
A header file that contains the prototypes of the few symbols "exported" |
1067 |
|
|
by bundle.c, and also exposes the perl headers to the application. |
1068 |
|
|
|
1069 |
|
|
=over 4 |
1070 |
|
|
|
1071 |
root |
1.33 |
=item staticperl_init (xs_init = 0) |
1072 |
root |
1.9 |
|
1073 |
|
|
Initialises the perl interpreter. You can use the normal perl functions |
1074 |
|
|
after calling this function, for example, to define extra functions or |
1075 |
|
|
to load a .pm file that contains some initialisation code, or the main |
1076 |
|
|
program function: |
1077 |
|
|
|
1078 |
|
|
XS (xsfunction) |
1079 |
|
|
{ |
1080 |
|
|
dXSARGS; |
1081 |
|
|
|
1082 |
|
|
// now we have items, ST(i) etc. |
1083 |
|
|
} |
1084 |
|
|
|
1085 |
|
|
static void |
1086 |
|
|
run_myapp(void) |
1087 |
|
|
{ |
1088 |
root |
1.33 |
staticperl_init (0); |
1089 |
root |
1.9 |
newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$"); |
1090 |
|
|
eval_pv ("require myapp::main", 1); // executes "myapp/main.pm" |
1091 |
|
|
} |
1092 |
|
|
|
1093 |
root |
1.33 |
When your bootcode already wants to access some XS functions at |
1094 |
|
|
compiletime, then you need to supply an C<xs_init> function pointer that |
1095 |
|
|
is called as soon as perl is initialised enough to define XS functions, |
1096 |
|
|
but before the preamble code is executed: |
1097 |
|
|
|
1098 |
|
|
static void |
1099 |
|
|
xs_init (pTHX) |
1100 |
|
|
{ |
1101 |
|
|
newXSproto ("myapp::xsfunction", xsfunction, __FILE__, "$$;$"); |
1102 |
|
|
} |
1103 |
|
|
|
1104 |
|
|
static void |
1105 |
|
|
run_myapp(void) |
1106 |
|
|
{ |
1107 |
|
|
staticperl_init (xs_init); |
1108 |
|
|
} |
1109 |
|
|
|
1110 |
|
|
=item staticperl_cleanup () |
1111 |
|
|
|
1112 |
|
|
In the unlikely case that you want to destroy the perl interpreter, here |
1113 |
|
|
is the corresponding function. |
1114 |
|
|
|
1115 |
root |
1.9 |
=item staticperl_xs_init (pTHX) |
1116 |
|
|
|
1117 |
|
|
Sometimes you need direct control over C<perl_parse> and C<perl_run>, in |
1118 |
|
|
which case you do not want to use C<staticperl_init> but call them on your |
1119 |
|
|
own. |
1120 |
|
|
|
1121 |
|
|
Then you need this function - either pass it directly as the C<xs_init> |
1122 |
root |
1.33 |
function to C<perl_parse>, or call it as one of the first things from your |
1123 |
|
|
own C<xs_init> function. |
1124 |
root |
1.9 |
|
1125 |
|
|
=item PerlInterpreter *staticperl |
1126 |
|
|
|
1127 |
|
|
The perl interpreter pointer used by staticperl. Not normally so useful, |
1128 |
|
|
but there it is. |
1129 |
|
|
|
1130 |
|
|
=back |
1131 |
|
|
|
1132 |
|
|
=item bundle.ccopts |
1133 |
|
|
|
1134 |
|
|
Contains the compiler options required to compile at least F<bundle.c> and |
1135 |
|
|
any file that includes F<bundle.h> - you should probably use it in your |
1136 |
|
|
C<CFLAGS>. |
1137 |
|
|
|
1138 |
|
|
=item bundle.ldopts |
1139 |
|
|
|
1140 |
|
|
The linker options needed to link the final program. |
1141 |
|
|
|
1142 |
|
|
=back |
1143 |
|
|
|
1144 |
|
|
=head1 RUNTIME FUNCTIONALITY |
1145 |
|
|
|
1146 |
root |
1.48 |
Binaries created with C<mkbundle>/C<mkperl> contain extra functionality, |
1147 |
|
|
mostly related to the extra files bundled in the binary (the virtual |
1148 |
|
|
filesystem). All of this data is statically compiled into the binary, and |
1149 |
|
|
accessing means copying it from a read-only section of your binary. Data |
1150 |
|
|
pages in this way is usually freed by the operating system, as it isn't |
1151 |
|
|
use more the onace. |
1152 |
|
|
|
1153 |
|
|
=head2 VIRTUAL FILESYSTEM |
1154 |
|
|
|
1155 |
|
|
Every bundle has a virtual filesystem. The only information stored in it |
1156 |
|
|
is the path and contents of each file that was bundled. |
1157 |
|
|
|
1158 |
|
|
=head3 LAYOUT |
1159 |
|
|
|
1160 |
|
|
Any path starting with an ampersand (F<&>) or exclamation mark (F<!>) are |
1161 |
|
|
reserved by F<staticperl>. They must only be used as described in this |
1162 |
|
|
section. |
1163 |
|
|
|
1164 |
|
|
=over 4 |
1165 |
|
|
|
1166 |
|
|
=item ! |
1167 |
|
|
|
1168 |
|
|
All files that typically cannot be loaded from memory (such as dynamic |
1169 |
|
|
objects or shared libraries), but have to reside in the filesystem, are |
1170 |
|
|
prefixed with F<!>. Typically these files get written out to some |
1171 |
|
|
(semi-)temporary directory shortly after program startup, or before being |
1172 |
|
|
used. |
1173 |
|
|
|
1174 |
|
|
=item !boot |
1175 |
|
|
|
1176 |
|
|
The bootstrap file, if specified during bundling. |
1177 |
|
|
|
1178 |
|
|
=item !auto/ |
1179 |
|
|
|
1180 |
|
|
Shared objects or dlls corresponding to dynamically-linked perl extensions |
1181 |
|
|
are stored with an F<!auto/> prefix. |
1182 |
root |
1.9 |
|
1183 |
root |
1.48 |
=item !lib/ |
1184 |
|
|
|
1185 |
|
|
External shared libraries are stored in this directory. |
1186 |
|
|
|
1187 |
|
|
=item any letter |
1188 |
|
|
|
1189 |
|
|
Any path starting with a letter is a perl library file. For example, |
1190 |
|
|
F<Coro/AIO.pm> corresponds to the file loaded by C<use Coro::AIO>, and |
1191 |
|
|
F<Coro/jit.pl> corresponds to C<require "Coro/jit.pl">. |
1192 |
|
|
|
1193 |
|
|
Obviously, module names shouldn't start with any other characters than |
1194 |
|
|
letters :) |
1195 |
|
|
|
1196 |
|
|
=back |
1197 |
|
|
|
1198 |
|
|
=head3 FUNCTIONS |
1199 |
root |
1.9 |
|
1200 |
|
|
=over 4 |
1201 |
|
|
|
1202 |
|
|
=item $file = staticperl::find $path |
1203 |
|
|
|
1204 |
|
|
Returns the data associated with the given C<$path> |
1205 |
root |
1.48 |
(e.g. C<Digest/MD5.pm>, C<auto/POSIX/autosplit.ix>). |
1206 |
root |
1.9 |
|
1207 |
|
|
Returns C<undef> if the file isn't embedded. |
1208 |
|
|
|
1209 |
|
|
=item @paths = staticperl::list |
1210 |
|
|
|
1211 |
|
|
Returns the list of all paths embedded in this binary. |
1212 |
|
|
|
1213 |
|
|
=back |
1214 |
|
|
|
1215 |
root |
1.48 |
=head2 EXTRA FEATURES |
1216 |
|
|
|
1217 |
|
|
In addition, for the embedded loading of perl files to work, F<staticperl> |
1218 |
|
|
overrides the C<@INC> array. |
1219 |
|
|
|
1220 |
root |
1.29 |
=head1 FULLY STATIC BINARIES - UCLIBC AND BUILDROOT |
1221 |
root |
1.9 |
|
1222 |
root |
1.10 |
To make truly static (Linux-) libraries, you might want to have a look at |
1223 |
root |
1.9 |
buildroot (L<http://buildroot.uclibc.org/>). |
1224 |
|
|
|
1225 |
|
|
Buildroot is primarily meant to set up a cross-compile environment (which |
1226 |
|
|
is not so useful as perl doesn't quite like cross compiles), but it can also compile |
1227 |
|
|
a chroot environment where you can use F<staticperl>. |
1228 |
|
|
|
1229 |
|
|
To do so, download buildroot, and enable "Build options => development |
1230 |
|
|
files in target filesystem" and optionally "Build options => gcc |
1231 |
|
|
optimization level (optimize for size)". At the time of writing, I had |
1232 |
|
|
good experiences with GCC 4.4.x but not GCC 4.5. |
1233 |
|
|
|
1234 |
|
|
To minimise code size, I used C<-pipe -ffunction-sections -fdata-sections |
1235 |
|
|
-finline-limit=8 -fno-builtin-strlen -mtune=i386>. The C<-mtune=i386> |
1236 |
|
|
doesn't decrease codesize much, but it makes the file much more |
1237 |
root |
1.41 |
compressible (and the execution a lot slower...). |
1238 |
root |
1.9 |
|
1239 |
|
|
If you don't need Coro or threads, you can go with "linuxthreads.old" (or |
1240 |
|
|
no thread support). For Coro, it is highly recommended to switch to a |
1241 |
|
|
uClibc newer than 0.9.31 (at the time of this writing, I used the 20101201 |
1242 |
|
|
snapshot) and enable NPTL, otherwise Coro needs to be configured with the |
1243 |
|
|
ultra-slow pthreads backend to work around linuxthreads bugs (it also uses |
1244 |
|
|
twice the address space needed for stacks). |
1245 |
|
|
|
1246 |
root |
1.10 |
If you use C<linuxthreads.old>, then you should also be aware that |
1247 |
|
|
uClibc shares C<errno> between all threads when statically linking. See |
1248 |
|
|
L<http://lists.uclibc.org/pipermail/uclibc/2010-June/044157.html> for a |
1249 |
root |
1.42 |
workaround (and L<https://bugs.uclibc.org/2089> for discussion). |
1250 |
root |
1.10 |
|
1251 |
root |
1.11 |
C<ccache> support is also recommended, especially if you want |
1252 |
|
|
to play around with buildroot options. Enabling the C<miniperl> |
1253 |
|
|
package will probably enable all options required for a successful |
1254 |
|
|
perl build. F<staticperl> itself additionally needs either C<wget> |
1255 |
|
|
(recommended, for CPAN) or C<curl>. |
1256 |
root |
1.9 |
|
1257 |
|
|
As for shells, busybox should provide all that is needed, but the default |
1258 |
|
|
busybox configuration doesn't include F<comm> which is needed by perl - |
1259 |
|
|
either make a custom busybox config, or compile coreutils. |
1260 |
|
|
|
1261 |
|
|
For the latter route, you might find that bash has some bugs that keep |
1262 |
|
|
it from working properly in a chroot - either use dash (and link it to |
1263 |
|
|
F</bin/sh> inside the chroot) or link busybox to F</bin/sh>, using it's |
1264 |
|
|
built-in ash shell. |
1265 |
|
|
|
1266 |
|
|
Finally, you need F</dev/null> inside the chroot for many scripts to work |
1267 |
root |
1.42 |
- either F<cp /dev/null output/target/dev> or bind-mounting your F</dev> |
1268 |
|
|
will provide this. |
1269 |
root |
1.9 |
|
1270 |
|
|
After you have compiled and set up your buildroot target, you can copy |
1271 |
|
|
F<staticperl> from the C<App::Staticperl> distribution or from your |
1272 |
root |
1.42 |
perl F<bin> directory (if you installed it) into the F<output/target> |
1273 |
root |
1.9 |
filesystem, chroot inside and run it. |
1274 |
|
|
|
1275 |
root |
1.17 |
=head1 RECIPES / SPECIFIC MODULES |
1276 |
|
|
|
1277 |
|
|
This section contains some common(?) recipes and information about |
1278 |
|
|
problems with some common modules or perl constructs that require extra |
1279 |
|
|
files to be included. |
1280 |
|
|
|
1281 |
|
|
=head2 MODULES |
1282 |
|
|
|
1283 |
|
|
=over 4 |
1284 |
|
|
|
1285 |
|
|
=item utf8 |
1286 |
|
|
|
1287 |
|
|
Some functionality in the utf8 module, such as swash handling (used |
1288 |
|
|
for unicode character ranges in regexes) is implemented in the |
1289 |
root |
1.18 |
C<"utf8_heavy.pl"> library: |
1290 |
|
|
|
1291 |
root |
1.37 |
-Mutf8_heavy.pl |
1292 |
root |
1.17 |
|
1293 |
|
|
Many Unicode properties in turn are defined in separate modules, |
1294 |
|
|
such as C<"unicore/Heavy.pl"> and more specific data tables such as |
1295 |
root |
1.18 |
C<"unicore/To/Digit.pl"> or C<"unicore/lib/Perl/Word.pl">. These tables |
1296 |
|
|
are big (7MB uncompressed, although F<staticperl> contains special |
1297 |
|
|
handling for those files), so including them on demand by your application |
1298 |
|
|
only might pay off. |
1299 |
root |
1.17 |
|
1300 |
root |
1.18 |
To simply include the whole unicode database, use: |
1301 |
root |
1.17 |
|
1302 |
root |
1.30 |
--incglob '/unicore/**.pl' |
1303 |
root |
1.17 |
|
1304 |
|
|
=item AnyEvent |
1305 |
|
|
|
1306 |
|
|
AnyEvent needs a backend implementation that it will load in a delayed |
1307 |
|
|
fashion. The L<AnyEvent::Impl::Perl> backend is the default choice |
1308 |
|
|
for AnyEvent if it can't find anything else, and is usually a safe |
1309 |
|
|
fallback. If you plan to use e.g. L<EV> (L<POE>...), then you need to |
1310 |
|
|
include the L<AnyEvent::Impl::EV> (L<AnyEvent::Impl::POE>...) backend as |
1311 |
|
|
well. |
1312 |
|
|
|
1313 |
|
|
If you want to handle IRIs or IDNs (L<AnyEvent::Util> punycode and idn |
1314 |
|
|
functions), you also need to include C<"AnyEvent/Util/idna.pl"> and |
1315 |
|
|
C<"AnyEvent/Util/uts46data.pl">. |
1316 |
|
|
|
1317 |
root |
1.29 |
Or you can use C<--usepacklists> and specify C<-MAnyEvent> to include |
1318 |
root |
1.20 |
everything. |
1319 |
|
|
|
1320 |
root |
1.39 |
=item Cairo |
1321 |
|
|
|
1322 |
|
|
See Glib, same problem, same solution. |
1323 |
|
|
|
1324 |
root |
1.18 |
=item Carp |
1325 |
|
|
|
1326 |
|
|
Carp had (in older versions of perl) a dependency on L<Carp::Heavy>. As of |
1327 |
|
|
perl 5.12.2 (maybe earlier), this dependency no longer exists. |
1328 |
|
|
|
1329 |
|
|
=item Config |
1330 |
|
|
|
1331 |
|
|
The F<perl -V> switch (as well as many modules) needs L<Config>, which in |
1332 |
|
|
turn might need L<"Config_heavy.pl">. Including the latter gives you |
1333 |
|
|
both. |
1334 |
|
|
|
1335 |
root |
1.39 |
=item Glib |
1336 |
|
|
|
1337 |
|
|
Glib literally requires Glib to be installed already to build - it tries |
1338 |
|
|
to fake this by running Glib out of the build directory before being |
1339 |
|
|
built. F<staticperl> tries to work around this by forcing C<MAN1PODS> and |
1340 |
|
|
C<MAN3PODS> to be empty via the C<PERL_MM_OPT> environment variable. |
1341 |
|
|
|
1342 |
|
|
=item Gtk2 |
1343 |
|
|
|
1344 |
|
|
See Pango, same problems, same solution. |
1345 |
|
|
|
1346 |
|
|
=item Pango |
1347 |
|
|
|
1348 |
|
|
In addition to the C<MAN3PODS> problem in Glib, Pango also routes around |
1349 |
|
|
L<ExtUtils::MakeMaker> by compiling its files on its own. F<staticperl> |
1350 |
|
|
tries to patch L<ExtUtils::MM_Unix> to route around Pango. |
1351 |
|
|
|
1352 |
root |
1.18 |
=item Term::ReadLine::Perl |
1353 |
|
|
|
1354 |
root |
1.29 |
Also needs L<Term::ReadLine::readline>, or C<--usepacklists>. |
1355 |
root |
1.18 |
|
1356 |
root |
1.17 |
=item URI |
1357 |
|
|
|
1358 |
|
|
URI implements schemes as separate modules - the generic URL scheme is |
1359 |
|
|
implemented in L<URI::_generic>, HTTP is implemented in L<URI::http>. If |
1360 |
root |
1.20 |
you need to use any of these schemes, you should include these manually, |
1361 |
root |
1.29 |
or use C<--usepacklists>. |
1362 |
root |
1.17 |
|
1363 |
|
|
=back |
1364 |
|
|
|
1365 |
|
|
=head2 RECIPES |
1366 |
|
|
|
1367 |
|
|
=over 4 |
1368 |
|
|
|
1369 |
root |
1.29 |
=item Just link everything in |
1370 |
root |
1.18 |
|
1371 |
|
|
To link just about everything installed in the perl library into a new |
1372 |
root |
1.29 |
perl, try this (the first time this runs it will take a long time, as a |
1373 |
|
|
lot of files need to be parsed): |
1374 |
root |
1.18 |
|
1375 |
root |
1.29 |
staticperl mkperl -v --strip ppi --incglob '*' |
1376 |
root |
1.18 |
|
1377 |
root |
1.29 |
If you don't mind the extra megabytes, this can be a very effective way of |
1378 |
|
|
creating bundles without having to worry about forgetting any modules. |
1379 |
|
|
|
1380 |
|
|
You get even more useful variants of this method by first selecting |
1381 |
|
|
everything, and then excluding stuff you are reasonable sure not to need - |
1382 |
|
|
L<bigperl|http://staticperl.schmorp.de/bigperl.html> uses this approach. |
1383 |
|
|
|
1384 |
|
|
=item Getting rid of netdb functions |
1385 |
root |
1.17 |
|
1386 |
|
|
The perl core has lots of netdb functions (C<getnetbyname>, C<getgrent> |
1387 |
|
|
and so on) that few applications use. You can avoid compiling them in by |
1388 |
|
|
putting the following fragment into a C<preconfigure> hook: |
1389 |
|
|
|
1390 |
|
|
preconfigure() { |
1391 |
|
|
for sym in \ |
1392 |
|
|
d_getgrnam_r d_endgrent d_endgrent_r d_endhent \ |
1393 |
|
|
d_endhostent_r d_endnent d_endnetent_r d_endpent \ |
1394 |
|
|
d_endprotoent_r d_endpwent d_endpwent_r d_endsent \ |
1395 |
|
|
d_endservent_r d_getgrent d_getgrent_r d_getgrgid_r \ |
1396 |
|
|
d_getgrnam_r d_gethbyaddr d_gethent d_getsbyport \ |
1397 |
|
|
d_gethostbyaddr_r d_gethostbyname_r d_gethostent_r \ |
1398 |
|
|
d_getlogin_r d_getnbyaddr d_getnbyname d_getnent \ |
1399 |
|
|
d_getnetbyaddr_r d_getnetbyname_r d_getnetent_r \ |
1400 |
|
|
d_getpent d_getpbyname d_getpbynumber d_getprotobyname_r \ |
1401 |
|
|
d_getprotobynumber_r d_getprotoent_r d_getpwent \ |
1402 |
|
|
d_getpwent_r d_getpwnam_r d_getpwuid_r d_getsent \ |
1403 |
|
|
d_getservbyname_r d_getservbyport_r d_getservent_r \ |
1404 |
|
|
d_getspnam_r d_getsbyname |
1405 |
|
|
# d_gethbyname |
1406 |
|
|
do |
1407 |
|
|
PERL_CONFIGURE="$PERL_CONFIGURE -U$sym" |
1408 |
|
|
done |
1409 |
|
|
} |
1410 |
|
|
|
1411 |
root |
1.31 |
This mostly gains space when linking statically, as the functions will |
1412 |
root |
1.21 |
likely not be linked in. The gain for dynamically-linked binaries is |
1413 |
root |
1.17 |
smaller. |
1414 |
|
|
|
1415 |
|
|
Also, this leaves C<gethostbyname> in - not only is it actually used |
1416 |
|
|
often, the L<Socket> module also exposes it, so leaving it out usually |
1417 |
|
|
gains little. Why Socket exposes a C function that is in the core already |
1418 |
|
|
is anybody's guess. |
1419 |
|
|
|
1420 |
|
|
=back |
1421 |
|
|
|
1422 |
root |
1.1 |
=head1 AUTHOR |
1423 |
|
|
|
1424 |
|
|
Marc Lehmann <schmorp@schmorp.de> |
1425 |
|
|
http://software.schmorp.de/pkg/staticperl.html |