Commit | Line | Data |
---|---|---|
ffe25ee3 B |
1 | # vim: syntax=pod |
2 | ||
f1300be0 | 3 | If you read this file _as_is_, just ignore the funny characters you see. |
b0a63d58 | 4 | It is written in the POD format (see F<pod/perlpod.pod>) which is specially |
f1300be0 YST |
5 | designed to be readable as is. |
6 | ||
8e07c86e AD |
7 | =head1 NAME |
8 | ||
cb8c159f | 9 | INSTALL - Build and Installation guide for perl 5. |
8e07c86e AD |
10 | |
11 | =head1 SYNOPSIS | |
12 | ||
7df75831 | 13 | First, make sure you have an up-to-date version of Perl. If you |
ce80d64e | 14 | didn't get your Perl source from CPAN, check the latest version at |
f6521f7c | 15 | L<https://www.cpan.org/src/>. Perl uses a version scheme where even-numbered |
08854360 | 16 | subreleases (like 5.8.x and 5.10.x) are stable maintenance releases and |
ce80d64e AD |
17 | odd-numbered subreleases (like 5.7.x and 5.9.x) are unstable |
18 | development releases. Development releases should not be used in | |
19 | production environments. Fixes and new features are first carefully | |
20 | tested in development releases and only if they prove themselves to be | |
21 | worthy will they be migrated to the maintenance releases. | |
3ce0d271 | 22 | |
7df75831 | 23 | The basic steps to build and install perl 5 on a Unix system with all |
dd3196cd | 24 | the defaults are to run, from a freshly unpacked source tree: |
8e07c86e | 25 | |
491517e0 | 26 | sh Configure -de |
8e07c86e AD |
27 | make |
28 | make test | |
29 | make install | |
36477c24 | 30 | |
8e07c86e AD |
31 | Each of these is explained in further detail below. |
32 | ||
b0a63d58 KW |
33 | The above commands will install Perl to F</usr/local> (or some other |
34 | platform-specific directory -- see the appropriate file in F<hints/>.) | |
7df75831 | 35 | If that's not okay with you, you can run Configure interactively, by |
ff52061e | 36 | just typing "sh Configure" (without the -de args). You can also specify |
b0a63d58 | 37 | any prefix location by adding C<"-Dprefix='/some/dir'"> to Configure's args. |
ff52061e RGS |
38 | To explicitly name the perl binary, use the command |
39 | "make install PERLNAME=myperl". | |
491517e0 | 40 | |
668cbedd | 41 | Building perl from source requires an ANSI compliant C compiler. |
a66ca998 NC |
42 | C89 with a minimal subset of C99 features is required. Some other |
43 | features available in C99 will be probed for and used when found. | |
51eec7ec | 44 | |
ff52061e | 45 | These options, and many more, are explained in further detail below. |
7f678428 | 46 | |
e0ddbfb2 | 47 | If you're building perl from a git repository, you should also consult |
b0a63d58 | 48 | the documentation in F<pod/perlgit.pod> for information on that special |
e0ddbfb2 RS |
49 | circumstance. |
50 | ||
8d74ce1c | 51 | If you have problems, corrections, or questions, please see |
ff52061e | 52 | L<"Reporting Problems"> below. |
8d74ce1c | 53 | |
7beaa944 | 54 | For information on what's new in this release, see the |
b0a63d58 | 55 | F<pod/perldelta.pod> file. For more information about how to find more |
9519d2ec | 56 | specific detail about changes, see the Changes file. |
c3edaffb | 57 | |
1ec51d55 | 58 | =head1 DESCRIPTION |
edb1cbcb | 59 | |
c3edaffb | 60 | This document is written in pod format as an easy way to indicate its |
b0a63d58 | 61 | structure. The pod format is described in F<pod/perlpod.pod>, but you can |
1ec51d55 CS |
62 | read it as is with any pager or editor. Headings and items are marked |
63 | by lines beginning with '='. The other mark-up used is | |
64 | ||
65 | B<text> embolden text, used for switches, programs or commands | |
66 | C<code> literal code | |
67 | L<name> A link (cross reference) to name | |
ce80d64e | 68 | F<file> A filename |
1ec51d55 | 69 | |
c42e3e15 | 70 | Although most of the defaults are probably fine for most users, |
ce80d64e | 71 | you should probably at least skim through this document before |
1ec51d55 | 72 | proceeding. |
c3edaffb | 73 | |
ce80d64e AD |
74 | In addition to this file, check if there is a README file specific to |
75 | your operating system, since it may provide additional or different | |
76 | instructions for building Perl. If there is a hint file for your | |
b0a63d58 | 77 | system (in the F<hints/> directory) you might also want to read it |
dd3196cd | 78 | for even more information. |
c42e3e15 | 79 | |
ce80d64e | 80 | For additional information about porting Perl, see the section on |
b0a63d58 | 81 | L<"Porting information"> below, and look at the files in the F<Porting/> |
ce80d64e | 82 | directory. |
d56c5707 | 83 | |
ce80d64e | 84 | =head1 PRELIMINARIES |
c42e3e15 | 85 | |
ce80d64e | 86 | =head2 Changes and Incompatibilities |
c42e3e15 | 87 | |
b0a63d58 | 88 | Please see F<pod/perldelta.pod> for a description of the changes and |
ce80d64e AD |
89 | potential incompatibilities introduced with this release. A few of |
90 | the most important issues are listed below, but you should refer | |
b0a63d58 | 91 | to F<pod/perldelta.pod> for more detailed information. |
c42e3e15 | 92 | |
c44af6e3 NC |
93 | =head3 Compatibility with earlier versions |
94 | ||
ab97e755 MB |
95 | B<WARNING:> This version is not binary compatible with earlier versions |
96 | of Perl. If you have built extensions (i.e. modules that include C code) | |
64fa5b0b DM |
97 | using an earlier version of Perl, you will need to rebuild and reinstall |
98 | those extensions. | |
1b1c1ae2 GS |
99 | |
100 | Pure perl modules without XS or C code should continue to work fine | |
dd3196cd | 101 | without reinstallation. See the discussion below on |
7df75831 | 102 | L<"Coexistence with earlier versions of perl 5"> for more details. |
693762b4 AD |
103 | |
104 | The standard extensions supplied with Perl will be handled automatically. | |
105 | ||
ce80d64e AD |
106 | On a related issue, old modules may possibly be affected by the changes |
107 | in the Perl language in the current release. Please see | |
b0a63d58 | 108 | F<pod/perldelta.pod> for a description of what's changed. See your |
ce80d64e | 109 | installed copy of the perllocal.pod file for a (possibly incomplete) |
c75cfcf0 FC |
110 | list of locally installed modules. Also see the L<CPAN> module's |
111 | C<autobundle> function for one way to make a "bundle" of your currently | |
112 | installed modules. | |
16dc217a | 113 | |
c44af6e3 NC |
114 | =head3 C99 |
115 | ||
116 | With 5.36 we changed our C compiler baseline requirement from "ANSI C89" to | |
117 | "C89 plus some specific C99 features". We have been using C99 features | |
118 | optionally for some time - we now additionally B<rely> on a few in the core C | |
119 | code and installed headers, which we know work on all supported compilers on | |
120 | all platforms we target. Because earlier versions of Perl still compile with | |
121 | strictly ANSI C89 compilers and there are still a few installations in the | |
122 | wild which use these very old compilers, XS code that targets earlier versions | |
123 | of Perl must not B<rely> on C99 features - that includes XS code in this | |
124 | distribution that is dual life on CPAN. To test that XS code can build on | |
125 | such compilers, some authors configure their perl builds with compiler flags | |
126 | to warn or raise errors on C99 specific features, most often for mixed | |
127 | declarations and code. This obviously will not work if you attempt it for | |
128 | this release - it will not build. However, XS authors should be aware that | |
129 | this means | |
130 | ||
131 | =over 4 | |
132 | ||
133 | =item * | |
134 | ||
135 | If you change the C compiler flags in your F<Makefile.PL> or similar to add | |
136 | such warnings or errors, you must now only do it for 5.35.4 or earlier. | |
137 | ||
138 | =item * | |
139 | ||
140 | Do not rely on now being able to use C99 features in your XS code, even for | |
141 | platforms with C99 compilers - some installations of earlier versions of perl | |
142 | are deliberately configured to enforce C89 standards so that locally authored | |
143 | extension code conforms to them. If you choose to require C99 for your code, | |
144 | that's fine, but do so knowing that if you distribute it, some installations | |
145 | of perl are configured to fault C99. | |
146 | ||
147 | =back | |
148 | ||
aa689395 | 149 | =head1 Run Configure |
8e07c86e AD |
150 | |
151 | Configure will figure out various things about your system. Some | |
152 | things Configure will figure out for itself, other things it will ask | |
d6baa268 JH |
153 | you about. To accept the default, just press RETURN. The default is |
154 | almost always okay. It is normal for some things to be "NOT found", | |
155 | since Configure often searches for many different ways of performing | |
156 | the same function. | |
157 | ||
ce80d64e | 158 | At any Configure prompt, you can type &-d and Configure will use the |
d6baa268 | 159 | defaults from then on. |
8e07c86e AD |
160 | |
161 | After it runs, Configure will perform variable substitution on all the | |
1ec51d55 | 162 | *.SH files and offer to run make depend. |
8e07c86e | 163 | |
dd3196cd RGS |
164 | The results of a Configure run are stored in the config.sh and Policy.sh |
165 | files. | |
166 | ||
ce80d64e | 167 | =head2 Common Configure options |
844fc9f4 | 168 | |
ce80d64e | 169 | Configure supports a number of useful options. Run |
844fc9f4 | 170 | |
ce80d64e | 171 | Configure -h |
d6baa268 | 172 | |
b52f3fcb JK |
173 | to get a listing. |
174 | ||
175 | Many Configure switches are expressed as C<key=value> pairs, for example: | |
176 | ||
177 | -Dcc=clang | |
178 | ||
179 | Sometimes the value to be supplied for a switch is a string which contains | |
180 | spaces. In that case, the value needs to be quoted so as to delimit that | |
181 | "shell word" from any following switch. Example: | |
182 | ||
183 | sh ./Configure -des \ | |
184 | -Doptimize="-O2 -pipe -fstack-protector -fno-strict-aliasing" \ | |
185 | -Dusedevel | |
186 | ||
187 | Once Configure has run, you will be able to access configuration data via | |
188 | entries in the file F<config.sh>. | |
189 | ||
190 | config_arg0='./Configure' | |
191 | config_args='-des -Doptimize=-O2 -pipe -fstack-protector -fno-strict-aliasing -Dusedevel' | |
192 | config_argc=3 | |
193 | config_arg1='-des' | |
194 | config_arg2='-Doptimize=-O2 -pipe -fstack-protector -fno-strict-aliasing' | |
195 | config_arg3='-Dusedevel' | |
196 | ||
197 | See the F<Porting/Glossary> file for a complete list of | |
fb73857a | 198 | Configure variables you can set and their definitions. |
199 | ||
d6baa268 JH |
200 | =over 4 |
201 | ||
08854360 | 202 | =item C compiler |
d6baa268 | 203 | |
08854360 RGS |
204 | To compile with gcc, if it's not the default compiler on your |
205 | system, you should run | |
8e07c86e AD |
206 | |
207 | sh Configure -Dcc=gcc | |
208 | ||
08854360 | 209 | This is the preferred way to specify gcc (or any another alternative |
8e07c86e AD |
210 | compiler) so that the hints files can set appropriate defaults. |
211 | ||
d6baa268 | 212 | =item Installation prefix |
4633a7c4 | 213 | |
8e07c86e | 214 | By default, for most systems, perl will be installed in |
b0a63d58 | 215 | F</usr/local/>{F<bin>, F<lib>, F<man>}. (See L<"Installation Directories"> |
7df75831 | 216 | and L<"Coexistence with earlier versions of perl 5"> below for |
8d74ce1c AD |
217 | further details.) |
218 | ||
219 | You can specify a different 'prefix' for the default installation | |
ce80d64e | 220 | directory when Configure prompts you, or by using the Configure command |
b0a63d58 | 221 | line option C<-Dprefix='/some/directory'>, e.g. |
8e07c86e | 222 | |
25f94b33 | 223 | sh Configure -Dprefix=/opt/perl |
4633a7c4 | 224 | |
d6baa268 JH |
225 | If your prefix contains the string "perl", then the suggested |
226 | directory structure is simplified. For example, if you use | |
b0a63d58 KW |
227 | C<prefix=/opt/perl>, then Configure will suggest F</opt/perl/lib> instead of |
228 | F</opt/perl/lib/perl5/>. Again, see L<"Installation Directories"> below | |
229 | for more details. Do not include a trailing slash, (i.e. F</opt/perl/>) | |
bc70e9ec | 230 | or you may experience odd test failures. |
8e07c86e | 231 | |
8d74ce1c AD |
232 | NOTE: You must not specify an installation directory that is the same |
233 | as or below your perl source directory. If you do, installperl will | |
234 | attempt infinite recursion. | |
84902520 | 235 | |
b0a63d58 | 236 | =item F</usr/bin/perl> |
d6baa268 JH |
237 | |
238 | It may seem obvious, but Perl is useful only when users can easily | |
b0a63d58 KW |
239 | find it. It's often a good idea to have both F</usr/bin/perl> and |
240 | F</usr/local/bin/perl> be symlinks to the actual binary. Be especially | |
d6baa268 | 241 | careful, however, not to overwrite a version of perl supplied by your |
b66c6cec AD |
242 | vendor unless you are sure you know what you are doing. If you insist |
243 | on replacing your vendor's perl, useful information on how it was | |
244 | configured may be found with | |
245 | ||
246 | perl -V:config_args | |
247 | ||
248 | (Check the output carefully, however, since this doesn't preserve | |
ce80d64e AD |
249 | spaces in arguments to Configure. For that, you have to look carefully |
250 | at config_arg1, config_arg2, etc.) | |
d6baa268 | 251 | |
b0a63d58 | 252 | By default, Configure will not try to link F</usr/bin/perl> to the current |
ce80d64e | 253 | version of perl. You can turn on that behavior by running |
d6baa268 | 254 | |
7d56c962 | 255 | Configure -Dinstallusrbinperl |
d6baa268 | 256 | |
7d56c962 | 257 | or by answering 'yes' to the appropriate Configure prompt. |
d6baa268 | 258 | |
ce80d64e AD |
259 | In any case, system administrators are strongly encouraged to put |
260 | (symlinks to) perl and its accompanying utilities, such as perldoc, | |
4682965a MB |
261 | into a directory typically found along a user's PATH, or in another |
262 | obvious and convenient place. | |
263 | ||
71c4561b | 264 | =item Building a development release |
04d420f9 | 265 | |
ce80d64e AD |
266 | For development releases (odd subreleases, like 5.9.x) if you want to |
267 | use Configure -d, you will also need to supply -Dusedevel to Configure, | |
268 | because the default answer to the question "do you really want to | |
269 | Configure a development version?" is "no". The -Dusedevel skips that | |
270 | sanity check. | |
d6baa268 JH |
271 | |
272 | =back | |
8e07c86e | 273 | |
203c3eec AD |
274 | If you are willing to accept all the defaults, and you want terse |
275 | output, you can run | |
276 | ||
277 | sh Configure -des | |
278 | ||
dd3196cd | 279 | =head2 Altering Configure variables for C compiler switches etc. |
46bb10fb | 280 | |
ce80d64e AD |
281 | For most users, most of the Configure defaults are fine, or can easily |
282 | be set on the Configure command line. However, if Configure doesn't | |
283 | have an option to do what you want, you can change Configure variables | |
284 | after the platform hints have been run by using Configure's -A switch. | |
285 | For example, here's how to add a couple of extra flags to C compiler | |
286 | invocations: | |
46bb10fb | 287 | |
08854360 | 288 | sh Configure -Accflags="-DPERL_EXTERNAL_GLOB -DNO_HASH_SEED" |
46bb10fb | 289 | |
5247441a | 290 | To clarify, those ccflags values are not Configure options; if passed to |
dd3196cd RGS |
291 | Configure directly, they won't do anything useful (they will define a |
292 | variable in config.sh, but without taking any action based upon it). | |
293 | But when passed to the compiler, those flags will activate #ifdefd code. | |
5247441a | 294 | |
ce80d64e | 295 | For more help on Configure switches, run |
46bb10fb | 296 | |
ce80d64e | 297 | sh Configure -h |
46bb10fb | 298 | |
ce80d64e | 299 | =head2 Major Configure-time Build Options |
46bb10fb | 300 | |
ce80d64e AD |
301 | There are several different ways to Configure and build perl for your |
302 | system. For most users, the defaults are sensible and will work. | |
303 | Some users, however, may wish to further customize perl. Here are | |
304 | some of the main things you can change. | |
46bb10fb | 305 | |
ce80d64e | 306 | =head3 Threads |
cc65bb49 | 307 | |
ce80d64e AD |
308 | On some platforms, perl can be compiled with support for threads. To |
309 | enable this, run | |
4633a7c4 | 310 | |
ce80d64e | 311 | sh Configure -Dusethreads |
4633a7c4 | 312 | |
ce80d64e | 313 | The default is to compile without thread support. |
cc65bb49 | 314 | |
ab97e755 MB |
315 | Perl used to have two different internal threads implementations. The |
316 | current model (available internally since 5.6, and as a user-level module | |
317 | since 5.8) is called interpreter-based implementation (ithreads), with | |
318 | one interpreter per thread, and explicit sharing of data. The (deprecated) | |
319 | 5.005 version (5005threads) was removed for release 5.10. | |
d6baa268 | 320 | |
ce80d64e | 321 | The 'threads' module is for use with the ithreads implementation. The |
ab97e755 MB |
322 | 'Thread' module emulates the old 5005threads interface on top of the |
323 | current ithreads model. | |
d6baa268 | 324 | |
ce80d64e AD |
325 | When using threads, perl uses a dynamically-sized buffer for some of |
326 | the thread-safe library calls, such as those in the getpw*() family. | |
327 | This buffer starts small, but it will keep growing until the result | |
328 | fits. To get a fixed upper limit, you should compile Perl with | |
329 | PERL_REENTRANT_MAXSIZE defined to be the number of bytes you want. One | |
330 | way to do this is to run Configure with | |
08854360 | 331 | C<-Accflags=-DPERL_REENTRANT_MAXSIZE=65536>. |
d6baa268 | 332 | |
08854360 | 333 | =head3 Large file support |
b367e8b0 | 334 | |
ce80d64e AD |
335 | Since Perl 5.6.0, Perl has supported large files (files larger than |
336 | 2 gigabytes), and in many common platforms like Linux or Solaris this | |
337 | support is on by default. | |
d6baa268 | 338 | |
ce80d64e | 339 | This is both good and bad. It is good in that you can use large files, |
ab97e755 MB |
340 | seek(), stat(), and -s them. It is bad in that if you are interfacing |
341 | Perl using some extension, the components you are connecting to must also | |
ce80d64e AD |
342 | be large file aware: if Perl thinks files can be large but the other |
343 | parts of the software puzzle do not understand the concept, bad things | |
08854360 | 344 | will happen. |
d6baa268 | 345 | |
ce80d64e AD |
346 | There's also one known limitation with the current large files |
347 | implementation: unless you also have 64-bit integers (see the next | |
348 | section), you cannot use the printf/sprintf non-decimal integer formats | |
349 | like C<%x> to print filesizes. You can use C<%d>, though. | |
d6baa268 | 350 | |
71c4561b RGS |
351 | If you want to compile perl without large file support, use |
352 | ||
353 | sh Configure -Uuselargefiles | |
354 | ||
08854360 | 355 | =head3 64 bit support |
d6baa268 | 356 | |
08854360 RGS |
357 | If your platform does not run natively at 64 bits, but can simulate |
358 | them with compiler flags and/or C<long long> or C<int64_t>, | |
ce80d64e | 359 | you can build a perl that uses 64 bits. |
d6baa268 | 360 | |
ce80d64e AD |
361 | There are actually two modes of 64-bitness: the first one is achieved |
362 | using Configure -Duse64bitint and the second one using Configure | |
363 | -Duse64bitall. The difference is that the first one is minimal and | |
364 | the second one maximal. The first works in more places than the second. | |
d6baa268 | 365 | |
ce80d64e AD |
366 | The C<use64bitint> option does only as much as is required to get |
367 | 64-bit integers into Perl (this may mean, for example, using "long | |
368 | longs") while your memory may still be limited to 2 gigabytes (because | |
369 | your pointers could still be 32-bit). Note that the name C<64bitint> | |
370 | does not imply that your C compiler will be using 64-bit C<int>s (it | |
371 | might, but it doesn't have to). The C<use64bitint> simply means that | |
372 | you will be able to have 64 bit-wide scalar values. | |
d6baa268 | 373 | |
ce80d64e AD |
374 | The C<use64bitall> option goes all the way by attempting to switch |
375 | integers (if it can), longs (and pointers) to being 64-bit. This may | |
376 | create an even more binary incompatible Perl than -Duse64bitint: the | |
377 | resulting executable may not run at all in a 32-bit box, or you may | |
378 | have to reboot/reconfigure/rebuild your operating system to be 64-bit | |
379 | aware. | |
d6baa268 | 380 | |
08854360 | 381 | Natively 64-bit systems need neither -Duse64bitint nor -Duse64bitall. |
0e78eb44 MB |
382 | On these systems, it might be the default compilation mode, and there |
383 | is currently no guarantee that passing no use64bitall option to the | |
384 | Configure process will build a 32bit perl. Implementing -Duse32bit* | |
1ed7425e | 385 | options is planned for a future release of perl. |
d6baa268 | 386 | |
ce80d64e | 387 | =head3 Long doubles |
d6baa268 | 388 | |
ce80d64e AD |
389 | In some systems you may be able to use long doubles to enhance the |
390 | range and precision of your double precision floating point numbers | |
391 | (that is, Perl's numbers). Use Configure -Duselongdouble to enable | |
392 | this support (if it is available). | |
d6baa268 | 393 | |
aacf4ea2 JH |
394 | Note that the exact format and range of long doubles varies: |
395 | the most common is the x86 80-bit (64 bits of mantissa) format, | |
396 | but there are others, with different mantissa and exponent ranges. | |
397 | ||
ce80d64e | 398 | =head3 "more bits" |
b367e8b0 | 399 | |
ce80d64e AD |
400 | You can "Configure -Dusemorebits" to turn on both the 64-bit support |
401 | and the long double support. | |
b367e8b0 | 402 | |
257c99f5 JH |
403 | =head3 quadmath |
404 | ||
b7ce25dd | 405 | One option for more precision is that gcc 4.6 and later have a library |
257c99f5 JH |
406 | called quadmath, which implements the IEEE 754 quadruple precision |
407 | (128-bit, 113 bits of mantissa) floating point numbers. The library | |
408 | works at least on x86 and ia64 platforms. It may be part of your gcc | |
409 | installation, or you may need to install it separately. | |
410 | ||
79f6e7a5 JH |
411 | With "Configure -Dusequadmath" you can try enabling its use, but note |
412 | the compiler dependency, you may need to also add "-Dcc=...". | |
84e6cb05 | 413 | At C level the type is called C<__float128> (note, not "long double"), |
b7ce25dd | 414 | but Perl source knows it as NV. (This is not "long doubles".) |
257c99f5 | 415 | |
ce80d64e | 416 | =head3 Algorithmic Complexity Attacks on Hashes |
504f80c1 | 417 | |
e6b54db6 YO |
418 | Perl 5.18 reworked the measures used to secure its hash function |
419 | from algorithmic complexity attacks. By default it will build with | |
420 | all of these measures enabled along with support for controlling and | |
421 | disabling them via environment variables. | |
422 | ||
423 | You can override various aspects of this feature by defining various | |
424 | symbols during configure. An example might be: | |
425 | ||
f0c21bde | 426 | sh Configure -Accflags=-DPERL_HASH_FUNC_SIPHASH |
e6b54db6 YO |
427 | |
428 | B<Unless stated otherwise these options are considered experimental or | |
429 | insecure and are not recommended for production use.> | |
430 | ||
99111b89 YO |
431 | Since Perl 5.18 we have included support for multiple hash functions, |
432 | although from time to time we change which functions we support, | |
8bc8b6db | 433 | and which function is default (currently SBOX+SIPHASH13 on 64 bit builds |
99111b89 YO |
434 | and SBOX+ZAPHOD32 for 32 bit builds). You can choose a different |
435 | algorithm by defining one of the following symbols during configure. | |
055663bc | 436 | Note that there are security implications regarding which hash function you choose |
99111b89 YO |
437 | to use. The functions are listed roughly by how secure they are believed |
438 | to be, with the one believed to be most secure at release time being PERL_HASH_FUNC_SIPHASH. | |
e6b54db6 YO |
439 | |
440 | PERL_HASH_FUNC_SIPHASH | |
99111b89 YO |
441 | PERL_HASH_FUNC_SIPHASH13 |
442 | PERL_HASH_FUNC_ZAPHOD32 | |
8bc8b6db | 443 | |
99111b89 YO |
444 | In addition, these, (or custom hash functions), may be "fronted" by the |
445 | SBOX32 hash function for keys under a chosen size. This hash function is | |
446 | special in that it has proven theoretical security properties, and is very | |
447 | fast to hash, but which by nature is restricted to a maximum key length, | |
448 | and which has rather expensive setup costs (relatively speaking), both in | |
449 | terms of performance and more importantly in terms of memory. SBOX32 | |
450 | requires 1k of storage per character it can hash, and it must populate that | |
451 | storage with 256 32-bit random values as well. In practice the RNG we use | |
055663bc | 452 | for seeding the SBOX32 storage is very efficient, and populating the table |
ab473f03 | 453 | required for hashing even fairly long keys is negligible as we only do it |
055663bc | 454 | during startup. By default we build with SBOX32 enabled, but you can change |
86d84dd0 YO |
455 | that by setting the C<PERL_HASH_USE_SBOX32_ALSO> in the Configure process, |
456 | with something like this | |
99111b89 | 457 | |
86d84dd0 | 458 | -Accflags='-DPERL_HASH_USE_SBOX32_ALSO=0' |
99111b89 | 459 | |
86d84dd0 | 460 | or alternatively you can use the simple define C<PERL_HASH_NO_SBOX32> like this: |
99111b89 | 461 | |
86d84dd0 | 462 | -Accflags='-DPERL_HASH_NO_SBOX32' |
99111b89 | 463 | |
86d84dd0 YO |
464 | By default Perl will use SBOX32 to hash strings 24 bytes |
465 | or shorter, you can change this length by setting C<SBOX32_MAX_LEN> | |
466 | to the desired length, with the maximum length being 256. For example with | |
467 | this: | |
468 | ||
469 | -Accflags='-DSBOX_MAX_LEN=128' | |
99111b89 YO |
470 | |
471 | As of Perl 5.18 the order returned by keys(), values(), and each() is | |
472 | non-deterministic and distinct per hash, and the insert order for | |
473 | colliding keys is randomized as well, and perl allows for controlling this | |
474 | by the PERL_PERTURB_KEYS environment setting. You can disable this behavior | |
86d84dd0 | 475 | entirely with the define C<PERL_PERTURB_KEYS_DISABLED> with |
e6b54db6 | 476 | |
86d84dd0 | 477 | -Accflags='-DPERL_PERTURB_KEYS_DISABLED' |
e6b54db6 | 478 | |
99111b89 | 479 | You can disable the environment variable checks and compile time specify |
86d84dd0 YO |
480 | the type of key traversal randomization to be used by defining either |
481 | C<PERL_PERTURB_KEYS_RANDOM> or C<PERL_PERTURB_KEYS_DETERMINISTIC> with | |
482 | ||
483 | -Accflags='-DPERL_PERTURB_KEYS_RANDOM' | |
484 | ||
485 | or | |
e6b54db6 | 486 | |
86d84dd0 | 487 | -Accflags='-DPERL_PERTURB_KEYS_DETERMINISTIC' |
e6b54db6 | 488 | |
99111b89 YO |
489 | Since Perl 5.18 the seed used for the hash function is randomly selected |
490 | at process start, which can be overridden by specifying a seed by setting | |
25722165 YO |
491 | the PERL_HASH_SEED environment variable. Be aware that |
492 | PERL_PERTURB_KEYS_DETERMINISTIC and the equivalent environment variable | |
493 | setting will produce the same results if and only if the code does not | |
494 | put non-deterministic data into a hash, and the code is executed in exactly | |
495 | the same context in terms of the environment. If the code populates a hash | |
496 | with random data, or builds a hash using the address of its items, or | |
497 | if the code is run in a different environment context with a different | |
498 | number or selection of environment variables then the result may differ. | |
499 | DETERMINISTIC in this context means "if everything else is kept the same | |
500 | the same results should be observed". | |
e6b54db6 | 501 | |
99111b89 | 502 | You can change this behavior so that your perl is built with a hard coded |
86d84dd0 | 503 | seed with the define C<NO_HASH_SEED> by providing to Configure |
e6b54db6 | 504 | |
86d84dd0 | 505 | -Accflags='-DNO_HASH_SEED' |
e6b54db6 | 506 | |
99111b89 YO |
507 | Note that if you do this you should modify the code in hv_func.h to specify |
508 | your own key. In the future this define may be renamed and replaced with one | |
509 | that requires you to specify the key to use. | |
504f80c1 | 510 | |
99111b89 | 511 | B<NOTE WELL: Perl has never guaranteed any ordering of the hash keys>, and the |
86358043 NC |
512 | ordering has already changed several times during the lifetime of Perl |
513 | 5. Also, the ordering of hash keys has always been, and continues to | |
99111b89 YO |
514 | be, affected by the insertion order regardless of whether you build with |
515 | or without the randomization features. Note that because of this | |
516 | and especially with randomization that the key order of a hash is *undefined* | |
517 | and that things like Data::Dumper, for example, may produce different output | |
518 | between different runs of Perl, since Data::Dumper serializes the key in the | |
519 | native order for the hash. The use of the Data::Dumper C<Sortkeys> option is | |
520 | recommended if you are comparing dumps between different invocations of perl. | |
504f80c1 | 521 | |
ab97e755 MB |
522 | See L<perlrun/PERL_HASH_SEED> and L<perlrun/PERL_PERTURB_KEYS> for |
523 | details on the environment variables, and L<perlsec/Algorithmic | |
524 | Complexity Attacks> for further security details. | |
e6b54db6 | 525 | |
7897d656 | 526 | The C<PERL_HASH_SEED> and C<PERL_PERTURB_KEYS> environment variables can |
95309d6b TC |
527 | be disabled by building configuring perl with |
528 | C<-Accflags=-DNO_PERL_HASH_ENV>. | |
529 | ||
530 | The C<PERL_HASH_SEED_DEBUG> environment variable can be disabled by | |
531 | configuring perl with C<-Accflags=-DNO_PERL_HASH_SEED_DEBUG>. | |
532 | ||
741a5c73 YO |
533 | =head3 MISCELLANEOUS CONFIG |
534 | ||
535 | Perl uses various defines to control defaults for its behavior. These | |
536 | values are chosen to represent "sane" config, but users can override | |
537 | these values in their builds if they wish. This is a list of such | |
538 | settings. | |
539 | ||
540 | =over 2 | |
541 | ||
542 | =item PERL_MAX_NESTED_EVAL_BEGIN_BLOCKS_DEFAULT | |
543 | ||
544 | This define is used to control the default maximum number of nested | |
545 | eval/BEGIN statements, and in this context require should be | |
546 | understood to be a special form of eval so this means require/BEGIN | |
547 | and "use" statements as well. | |
548 | ||
549 | Currently each C<BEGIN> block inside of an C<eval EXPR> or C<require> | |
550 | operation will use a fairly high number of frames of the perl internal | |
551 | C stack, and this value is used to prevent stack overflows. Normally | |
552 | it is defaulted to 1000 but the default can be configured to another | |
553 | value, for instance 100, like this | |
554 | ||
555 | -Accflags='-DPERL_MAX_NESTED_EVAL_BEGIN_BLOCKS_DEFAULT=100' | |
556 | ||
557 | ||
558 | If you don't know what this is then it is safe to ignore it. Do not | |
559 | configure this to 0 or another very low value, it will break a lot of | |
560 | code. If you want to set it to a low value use the run time variable | |
561 | C<${^MAX_NESTED_EVAL_BEGIN_BLOCKS}> instead. | |
562 | ||
563 | =back | |
564 | ||
ce80d64e | 565 | =head3 SOCKS |
1b9c9cf5 DH |
566 | |
567 | Perl can be configured to be 'socksified', that is, to use the SOCKS | |
568 | TCP/IP proxy protocol library. SOCKS is used to give applications | |
569 | access to transport layer network proxies. Perl supports only SOCKS | |
71c4561b RGS |
570 | Version 5. The corresponding Configure option is -Dusesocks. |
571 | You can find more about SOCKS from wikipedia at | |
f6521f7c | 572 | L<https://en.wikipedia.org/wiki/SOCKS>. |
1b9c9cf5 | 573 | |
ce80d64e | 574 | =head3 Dynamic Loading |
d6baa268 | 575 | |
71c4561b RGS |
576 | By default, Configure will compile perl to use dynamic loading. |
577 | If you want to force perl to be compiled completely | |
d6baa268 JH |
578 | statically, you can either choose this when Configure prompts you or |
579 | you can use the Configure command line option -Uusedl. | |
7df75831 RGS |
580 | With this option, you won't be able to use any new extension |
581 | (XS) module without recompiling perl itself. | |
d6baa268 | 582 | |
ce80d64e | 583 | =head3 Building a shared Perl library |
c3edaffb | 584 | |
585 | Currently, for most systems, the main perl executable is built by | |
586 | linking the "perl library" libperl.a with perlmain.o, your static | |
8ba4bff0 | 587 | extensions, and various extra libraries, such as -lm. |
c3edaffb | 588 | |
08854360 | 589 | On systems that support dynamic loading, it may be possible to |
9d67150a | 590 | replace libperl.a with a shared libperl.so. If you anticipate building |
c3edaffb | 591 | several different perl binaries (e.g. by embedding libperl into |
592 | different programs, or by using the optional compiler extension), then | |
9d67150a | 593 | you might wish to build a shared libperl.so so that all your binaries |
c3edaffb | 594 | can share the same library. |
595 | ||
596 | The disadvantages are that there may be a significant performance | |
9d67150a | 597 | penalty associated with the shared libperl.so, and that the overall |
aa689395 | 598 | mechanism is still rather fragile with respect to different versions |
c3edaffb | 599 | and upgrades. |
600 | ||
601 | In terms of performance, on my test system (Solaris 2.5_x86) the perl | |
9d67150a | 602 | test suite took roughly 15% longer to run with the shared libperl.so. |
c3edaffb | 603 | Your system and typical applications may well give quite different |
604 | results. | |
605 | ||
606 | The default name for the shared library is typically something like | |
08854360 | 607 | libperl.so.5.8.8 (for Perl 5.8.8), or libperl.so.588, or simply |
9d67150a | 608 | libperl.so. Configure tries to guess a sensible naming convention |
c3edaffb | 609 | based on your C library name. Since the library gets installed in a |
610 | version-specific architecture-dependent directory, the exact name | |
611 | isn't very important anyway, as long as your linker is happy. | |
612 | ||
c3edaffb | 613 | You can elect to build a shared libperl by |
614 | ||
ce80d64e AD |
615 | sh Configure -Duseshrplib |
616 | ||
617 | To build a shared libperl, the environment variable controlling shared | |
618 | library search (LD_LIBRARY_PATH in most systems, DYLD_LIBRARY_PATH for | |
f05550c0 | 619 | Darwin, LD_LIBRARY_PATH/SHLIB_PATH |
0fd807f7 | 620 | for HP-UX, LIBPATH for AIX and z/OS, PATH for Cygwin) must be set up to include |
ce80d64e AD |
621 | the Perl build directory because that's where the shared libperl will |
622 | be created. Configure arranges makefile to have the correct shared | |
623 | library search settings. You can find the name of the environment | |
624 | variable Perl thinks works in your your system by | |
625 | ||
626 | grep ldlibpthname config.sh | |
627 | ||
628 | However, there are some special cases where manually setting the | |
629 | shared library path might be required. For example, if you want to run | |
630 | something like the following with the newly-built but not-yet-installed | |
631 | ./perl: | |
632 | ||
a070ca95 | 633 | ./perl -I. -MTestInit t/misc/failing_test.t |
08854360 | 634 | |
ce80d64e | 635 | or |
08854360 | 636 | |
ce80d64e AD |
637 | ./perl -Ilib ~/my_mission_critical_test |
638 | ||
639 | then you need to set up the shared library path explicitly. | |
640 | You can do this with | |
641 | ||
642 | LD_LIBRARY_PATH=`pwd`:$LD_LIBRARY_PATH; export LD_LIBRARY_PATH | |
643 | ||
644 | for Bourne-style shells, or | |
645 | ||
646 | setenv LD_LIBRARY_PATH `pwd` | |
647 | ||
648 | for Csh-style shells. (This procedure may also be needed if for some | |
649 | unexpected reason Configure fails to set up makefile correctly.) (And | |
650 | again, it may be something other than LD_LIBRARY_PATH for you, see above.) | |
651 | ||
652 | You can often recognize failures to build/use a shared libperl from error | |
653 | messages complaining about a missing libperl.so (or libperl.sl in HP-UX), | |
654 | for example: | |
08854360 RGS |
655 | |
656 | 18126:./miniperl: /sbin/loader: Fatal Error: cannot map libperl.so | |
ce80d64e AD |
657 | |
658 | There is also an potential problem with the shared perl library if you | |
659 | want to have more than one "flavor" of the same version of perl (e.g. | |
660 | with and without -DDEBUGGING). For example, suppose you build and | |
08854360 RGS |
661 | install a standard Perl 5.10.0 with a shared library. Then, suppose you |
662 | try to build Perl 5.10.0 with -DDEBUGGING enabled, but everything else | |
ce80d64e AD |
663 | the same, including all the installation directories. How can you |
664 | ensure that your newly built perl will link with your newly built | |
665 | libperl.so.8 rather with the installed libperl.so.8? The answer is | |
666 | that you might not be able to. The installation directory is encoded | |
667 | in the perl binary with the LD_RUN_PATH environment variable (or | |
668 | equivalent ld command-line option). On Solaris, you can override that | |
669 | with LD_LIBRARY_PATH; on Linux, you can only override at runtime via | |
670 | LD_PRELOAD, specifying the exact filename you wish to be used; and on | |
671 | Digital Unix, you can override LD_LIBRARY_PATH by setting the | |
672 | _RLD_ROOT environment variable to point to the perl build directory. | |
673 | ||
674 | In other words, it is generally not a good idea to try to build a perl | |
675 | with a shared library if $archlib/CORE/$libperl already exists from a | |
676 | previous build. | |
677 | ||
678 | A good workaround is to specify a different directory for the | |
679 | architecture-dependent library for your -DDEBUGGING version of perl. | |
680 | You can do this by changing all the *archlib* variables in config.sh to | |
681 | point to your new architecture-dependent library. | |
682 | ||
0a790ceb JK |
683 | =head3 External glob |
684 | ||
685 | Before File::Glob entered core in 5.6.0 globbing was implemented by shelling | |
686 | out. If the environmental variable PERL_EXTERNAL_GLOB is defined and if the | |
687 | F<csh> shell is available, perl will still do this the old way. | |
688 | ||
ce80d64e AD |
689 | =head2 Installation Directories |
690 | ||
691 | The installation directories can all be changed by answering the | |
be8498a1 RGS |
692 | appropriate questions in Configure. For convenience, all the installation |
693 | questions are near the beginning of Configure. Do not include trailing | |
694 | slashes on directory names. At any point during the Configure process, | |
695 | you can answer a question with &-d and Configure will use the defaults | |
696 | from then on. Alternatively, you can | |
ce80d64e AD |
697 | |
698 | grep '^install' config.sh | |
699 | ||
700 | after Configure has run to verify the installation paths. | |
701 | ||
702 | The defaults are intended to be reasonable and sensible for most | |
703 | people building from sources. Those who build and distribute binary | |
704 | distributions or who export perl to a range of systems will probably | |
705 | need to alter them. If you are content to just accept the defaults, | |
706 | you can safely skip the next section. | |
707 | ||
708 | The directories set up by Configure fall into three broad categories. | |
709 | ||
710 | =over 4 | |
711 | ||
712 | =item Directories for the perl distribution | |
713 | ||
1b2f5479 | 714 | By default, Configure will use the following directories for 5.37.7. |
ce80d64e | 715 | $version is the full perl version number, including subversion, e.g. |
8891dd8d | 716 | 5.12.3, and $archname is a string like sun4-sunos, |
ce80d64e AD |
717 | determined by Configure. The full definitions of all Configure |
718 | variables are in the file Porting/Glossary. | |
719 | ||
720 | Configure variable Default value | |
721 | $prefixexp /usr/local | |
722 | $binexp $prefixexp/bin | |
723 | $scriptdirexp $prefixexp/bin | |
724 | $privlibexp $prefixexp/lib/perl5/$version | |
725 | $archlibexp $prefixexp/lib/perl5/$version/$archname | |
726 | $man1direxp $prefixexp/man/man1 | |
727 | $man3direxp $prefixexp/man/man3 | |
728 | $html1direxp (none) | |
729 | $html3direxp (none) | |
730 | ||
ab97e755 MB |
731 | $prefixexp is generated from $prefix, with ~ expansion done to convert |
732 | home directories into absolute paths. Similarly for the other variables | |
733 | listed. As file system calls do not do this, you should always reference | |
734 | the ...exp variables, to support users who build perl in their home | |
735 | directory. | |
ce80d64e AD |
736 | |
737 | Actually, Configure recognizes the SVR3-style | |
738 | /usr/local/man/l_man/man1 directories, if present, and uses those | |
739 | instead. Also, if $prefix contains the string "perl", the library | |
740 | directories are simplified as described below. For simplicity, only | |
741 | the common style is shown here. | |
742 | ||
743 | =item Directories for site-specific add-on files | |
744 | ||
745 | After perl is installed, you may later wish to add modules (e.g. from | |
746 | CPAN) or scripts. Configure will set up the following directories to | |
747 | be used for installing those add-on modules and scripts. | |
748 | ||
979b4168 KW |
749 | Configure Default |
750 | variable value | |
751 | $siteprefixexp $prefixexp | |
752 | $sitebinexp $siteprefixexp/bin | |
753 | $sitescriptexp $siteprefixexp/bin | |
754 | $sitelibexp $siteprefixexp/lib/perl5/site_perl/$version | |
755 | $sitearchexp | |
756 | $siteprefixexp/lib/perl5/site_perl/$version/$archname | |
757 | $siteman1direxp $siteprefixexp/man/man1 | |
758 | $siteman3direxp $siteprefixexp/man/man3 | |
759 | $sitehtml1direxp (none) | |
760 | $sitehtml3direxp (none) | |
ce80d64e AD |
761 | |
762 | By default, ExtUtils::MakeMaker will install architecture-independent | |
763 | modules into $sitelib and architecture-dependent modules into $sitearch. | |
764 | ||
765 | =item Directories for vendor-supplied add-on files | |
766 | ||
767 | Lastly, if you are building a binary distribution of perl for | |
768 | distribution, Configure can optionally set up the following directories | |
769 | for you to use to distribute add-on modules. | |
770 | ||
979b4168 KW |
771 | Configure Default |
772 | variable value | |
773 | $vendorprefixexp (none) | |
774 | ||
775 | (The next ones are set only if vendorprefix is set.) | |
776 | ||
777 | $vendorbinexp $vendorprefixexp/bin | |
778 | $vendorscriptexp $vendorprefixexp/bin | |
779 | $vendorlibexp $vendorprefixexp/lib/perl5/vendor_perl/$version | |
780 | $vendorarchexp | |
781 | $vendorprefixexp/lib/perl5/vendor_perl/$version/$archname | |
782 | $vendorman1direxp $vendorprefixexp/man/man1 | |
783 | $vendorman3direxp $vendorprefixexp/man/man3 | |
784 | $vendorhtml1direxp (none) | |
785 | $vendorhtml3direxp (none) | |
ce80d64e AD |
786 | |
787 | These are normally empty, but may be set as needed. For example, | |
788 | a vendor might choose the following settings: | |
789 | ||
979b4168 KW |
790 | $prefix /usr |
791 | $siteprefix /usr/local | |
792 | $vendorprefix /usr | |
ce80d64e AD |
793 | |
794 | This would have the effect of setting the following: | |
795 | ||
979b4168 KW |
796 | $binexp /usr/bin |
797 | $scriptdirexp /usr/bin | |
798 | $privlibexp /usr/lib/perl5/$version | |
799 | $archlibexp /usr/lib/perl5/$version/$archname | |
800 | $man1direxp /usr/man/man1 | |
801 | $man3direxp /usr/man/man3 | |
802 | ||
803 | $sitebinexp /usr/local/bin | |
804 | $sitescriptexp /usr/local/bin | |
805 | $sitelibexp /usr/local/lib/perl5/site_perl/$version | |
806 | $sitearchexp /usr/local/lib/perl5/site_perl/$version/$archname | |
807 | $siteman1direxp /usr/local/man/man1 | |
808 | $siteman3direxp /usr/local/man/man3 | |
809 | ||
810 | $vendorbinexp /usr/bin | |
811 | $vendorscriptexp /usr/bin | |
812 | $vendorlibexp /usr/lib/perl5/vendor_perl/$version | |
813 | $vendorarchexp /usr/lib/perl5/vendor_perl/$version/$archname | |
814 | $vendorman1direxp /usr/man/man1 | |
815 | $vendorman3direxp /usr/man/man3 | |
ce80d64e AD |
816 | |
817 | Note how in this example, the vendor-supplied directories are in the | |
668cbedd | 818 | /usr hierarchy, while the directories reserved for the end user are in |
ce80d64e AD |
819 | the /usr/local hierarchy. |
820 | ||
821 | The entire installed library hierarchy is installed in locations with | |
822 | version numbers, keeping the installations of different versions distinct. | |
ab97e755 MB |
823 | However, later installations of Perl can still be configured to search |
824 | the installed libraries corresponding to compatible earlier versions. | |
825 | See L<"Coexistence with earlier versions of perl 5"> below for more | |
826 | details on how Perl can be made to search older version directories. | |
ce80d64e AD |
827 | |
828 | Of course you may use these directories however you see fit. For | |
829 | example, you may wish to use $siteprefix for site-specific files that | |
830 | are stored locally on your own disk and use $vendorprefix for | |
831 | site-specific files that are stored elsewhere on your organization's | |
832 | network. One way to do that would be something like | |
833 | ||
979b4168 | 834 | sh Configure -Dsiteprefix=/usr/local -Dvendorprefix=/usr/share/perl |
ce80d64e AD |
835 | |
836 | =item otherlibdirs | |
837 | ||
838 | As a final catch-all, Configure also offers an $otherlibdirs | |
839 | variable. This variable contains a colon-separated list of additional | |
840 | directories to add to @INC. By default, it will be empty. | |
841 | Perl will search these directories (including architecture and | |
842 | version-specific subdirectories) for add-on modules and extensions. | |
843 | ||
844 | For example, if you have a bundle of perl libraries from a previous | |
845 | installation, perhaps in a strange place: | |
846 | ||
f0c21bde | 847 | sh Configure -Dotherlibdirs=/usr/lib/perl5/site_perl/5.8.1 |
ce80d64e AD |
848 | |
849 | =item APPLLIB_EXP | |
850 | ||
851 | There is one other way of adding paths to @INC at perl build time, and | |
852 | that is by setting the APPLLIB_EXP C pre-processor token to a colon- | |
853 | separated list of directories, like this | |
854 | ||
855 | sh Configure -Accflags='-DAPPLLIB_EXP=\"/usr/libperl\"' | |
856 | ||
857 | The directories defined by APPLLIB_EXP get added to @INC I<first>, | |
858 | ahead of any others, and so provide a way to override the standard perl | |
859 | modules should you, for example, want to distribute fixes without | |
860 | touching the perl distribution proper. And, like otherlib dirs, | |
861 | version and architecture specific subdirectories are also searched, if | |
862 | present, at run time. Of course, you can still search other @INC | |
863 | directories ahead of those in APPLLIB_EXP by using any of the standard | |
864 | run-time methods: $PERLLIB, $PERL5LIB, -I, use lib, etc. | |
865 | ||
939e7f26 DM |
866 | =item default_inc_excludes_dot |
867 | ||
988217a0 | 868 | Since version 5.26.0, default perl builds no longer includes C<'.'> as the |
218f5fa9 | 869 | last element of @INC. The old behaviour can restored using |
939e7f26 | 870 | |
f0c21bde | 871 | sh Configure -Udefault_inc_excludes_dot |
939e7f26 DM |
872 | |
873 | Note that this is likely to make programs run under such a perl | |
874 | interpreter less secure. | |
875 | ||
785aa5e3 | 876 | =item usesitecustomize |
20ef40cf GA |
877 | |
878 | Run-time customization of @INC can be enabled with: | |
879 | ||
36de116d | 880 | sh Configure -Dusesitecustomize |
20ef40cf | 881 | |
785aa5e3 RGS |
882 | which will define USE_SITECUSTOMIZE and $Config{usesitecustomize}. |
883 | When enabled, this makes perl run F<$sitelibexp/sitecustomize.pl> before | |
20ef40cf GA |
884 | anything else. This script can then be set up to add additional |
885 | entries to @INC. | |
886 | ||
ce80d64e AD |
887 | =item Man Pages |
888 | ||
be8498a1 RGS |
889 | By default, man pages will be installed in $man1dir and $man3dir, which |
890 | are normally /usr/local/man/man1 and /usr/local/man/man3. If you | |
891 | want to use a .3pm suffix for perl man pages, you can do that with | |
ce80d64e AD |
892 | |
893 | sh Configure -Dman3ext=3pm | |
894 | ||
a36b9036 MB |
895 | You can disable installation of man pages completely using |
896 | ||
897 | sh Configure -Dman1dir=none -Dman3dir=none | |
898 | ||
ce80d64e AD |
899 | =item HTML pages |
900 | ||
901 | Currently, the standard perl installation does not do anything with | |
902 | HTML documentation, but that may change in the future. Further, some | |
903 | add-on modules may wish to install HTML documents. The html Configure | |
904 | variables listed above are provided if you wish to specify where such | |
905 | documents should be placed. The default is "none", but will likely | |
906 | eventually change to something useful based on user feedback. | |
907 | ||
908 | =back | |
909 | ||
910 | Some users prefer to append a "/share" to $privlib and $sitelib | |
911 | to emphasize that those directories can be shared among different | |
912 | architectures. | |
913 | ||
914 | Note that these are just the defaults. You can actually structure the | |
915 | directories any way you like. They don't even have to be on the same | |
916 | filesystem. | |
c3edaffb | 917 | |
ce80d64e AD |
918 | Further details about the installation directories, maintenance and |
919 | development subversions, and about supporting multiple versions are | |
7df75831 | 920 | discussed in L<"Coexistence with earlier versions of perl 5"> below. |
10c7e831 | 921 | |
ce80d64e AD |
922 | If you specify a prefix that contains the string "perl", then the |
923 | library directory structure is slightly simplified. Instead of | |
924 | suggesting $prefix/lib/perl5/, Configure will suggest $prefix/lib. | |
2bf2710f | 925 | |
ce80d64e AD |
926 | Thus, for example, if you Configure with |
927 | -Dprefix=/opt/perl, then the default library directories for 5.9.0 are | |
2bf2710f | 928 | |
ce80d64e AD |
929 | Configure variable Default value |
930 | $privlib /opt/perl/lib/5.9.0 | |
931 | $archlib /opt/perl/lib/5.9.0/$archname | |
932 | $sitelib /opt/perl/lib/site_perl/5.9.0 | |
933 | $sitearch /opt/perl/lib/site_perl/5.9.0/$archname | |
2bf2710f | 934 | |
ce80d64e | 935 | =head2 Changing the installation directory |
c3edaffb | 936 | |
ce80d64e | 937 | Configure distinguishes between the directory in which perl (and its |
7df75831 | 938 | associated files) should be installed, and the directory in which it |
ce80d64e AD |
939 | will eventually reside. For most sites, these two are the same; for |
940 | sites that use AFS, this distinction is handled automatically. | |
7df75831 RGS |
941 | However, sites that use package management software such as rpm or |
942 | dpkg, or users building binary packages for distribution may also | |
943 | wish to install perl into a different directory before moving perl | |
944 | to its final destination. There are two ways to do that: | |
945 | ||
946 | =over 4 | |
947 | ||
948 | =item installprefix | |
c3edaffb | 949 | |
be8498a1 RGS |
950 | To install perl under the /tmp/perl5 directory, use the following |
951 | command line: | |
c3edaffb | 952 | |
7df75831 | 953 | sh Configure -Dinstallprefix=/tmp/perl5 |
c3edaffb | 954 | |
ce80d64e | 955 | (replace /tmp/perl5 by a directory of your choice). |
2bf2710f | 956 | |
ce80d64e AD |
957 | Beware, though, that if you go to try to install new add-on |
958 | modules, they too will get installed in under '/tmp/perl5' if you | |
7df75831 RGS |
959 | follow this example. That's why it's usually better to use DESTDIR, |
960 | as shown in the next section. | |
c3edaffb | 961 | |
7df75831 | 962 | =item DESTDIR |
9d67150a | 963 | |
ce80d64e AD |
964 | If you need to install perl on many identical systems, it is convenient |
965 | to compile it once and create an archive that can be installed on | |
966 | multiple systems. Suppose, for example, that you want to create an | |
967 | archive that can be installed in /opt/perl. One way to do that is by | |
968 | using the DESTDIR variable during C<make install>. The DESTDIR is | |
969 | automatically prepended to all the installation paths. Thus you | |
970 | simply do: | |
830717a7 | 971 | |
ce80d64e AD |
972 | sh Configure -Dprefix=/opt/perl -des |
973 | make | |
974 | make test | |
975 | make install DESTDIR=/tmp/perl5 | |
976 | cd /tmp/perl5/opt/perl | |
977 | tar cvf /tmp/perl5-archive.tar . | |
9d67150a | 978 | |
7df75831 RGS |
979 | =back |
980 | ||
32878f30 NP |
981 | =head2 Relocatable @INC |
982 | ||
983 | To create a relocatable perl tree, use the following command line: | |
984 | ||
985 | sh Configure -Duserelocatableinc | |
986 | ||
987 | Then the paths in @INC (and everything else in %Config) can be | |
988 | optionally located via the path of the perl executable. | |
989 | ||
990 | That means that, if the string ".../" is found at the start of any | |
991 | path, it's substituted with the directory of $^X. So, the relocation | |
992 | can be configured on a per-directory basis, although the default with | |
993 | "-Duserelocatableinc" is that everything is relocated. The initial | |
994 | install is done to the original configured prefix. | |
995 | ||
79f7885c RGS |
996 | This option is not compatible with the building of a shared libperl |
997 | ("-Duseshrplib"), because in that case perl is linked with an hard-coded | |
998 | rpath that points at the libperl.so, that cannot be relocated. | |
999 | ||
ce80d64e | 1000 | =head2 Site-wide Policy settings |
55479bb6 | 1001 | |
ce80d64e | 1002 | After Configure runs, it stores a number of common site-wide "policy" |
7df75831 RGS |
1003 | answers (such as installation directories) in the Policy.sh file. |
1004 | If you want to build perl on another system using the same policy | |
1005 | defaults, simply copy the Policy.sh file to the new system's perl build | |
1006 | directory, and Configure will use it. This will work even if Policy.sh was | |
a0a8d9d3 | 1007 | generated for another version of Perl, or on a system with a |
da1b4322 | 1008 | different architecture and/or operating system. However, in such cases, |
a0a8d9d3 DD |
1009 | you should review the contents of the file before using it: for |
1010 | example, your new target may not keep its man pages in the same place | |
1011 | as the system on which the file was generated. | |
55479bb6 | 1012 | |
ce80d64e AD |
1013 | Alternatively, if you wish to change some or all of those policy |
1014 | answers, you should | |
c3edaffb | 1015 | |
ce80d64e | 1016 | rm -f Policy.sh |
aa689395 | 1017 | |
ce80d64e | 1018 | to ensure that Configure doesn't re-use them. |
2ae324a7 | 1019 | |
ce80d64e | 1020 | Further information is in the Policy_sh.SH file itself. |
aa689395 | 1021 | |
ce80d64e AD |
1022 | If the generated Policy.sh file is unsuitable, you may freely edit it |
1023 | to contain any valid shell commands. It will be run just after the | |
1024 | platform-specific hints files. | |
aa689395 | 1025 | |
ce80d64e | 1026 | =head2 Disabling older versions of Perl |
aa689395 | 1027 | |
ce80d64e | 1028 | Configure will search for binary compatible versions of previously |
7df75831 RGS |
1029 | installed perl binaries in the tree that is specified as target tree, |
1030 | and these will be used as locations to search for modules by the perl | |
1031 | being built. The list of perl versions found will be put in the Configure | |
1032 | variable inc_version_list. | |
86058a2d | 1033 | |
ab97e755 MB |
1034 | To disable this use of older perl modules, even completely valid pure |
1035 | perl modules, you can specify to not include the paths found: | |
b2a6d19e | 1036 | |
ce80d64e | 1037 | sh Configure -Dinc_version_list=none ... |
d6baa268 | 1038 | |
ab97e755 MB |
1039 | If you do want to use modules from some previous perl versions, the |
1040 | variable must contain a space separated list of directories under the | |
1041 | site_perl directory, and has to include architecture-dependent | |
1042 | directories separately, eg. | |
274ca399 | 1043 | |
4683a5d7 | 1044 | sh Configure -Dinc_version_list="5.16.0/x86_64-linux 5.16.0" ... |
274ca399 | 1045 | |
ce80d64e | 1046 | When using the newer perl, you can add these paths again in the |
668cbedd | 1047 | PERL5LIB environment variable or with perl's -I runtime option. |
86058a2d | 1048 | |
ce80d64e | 1049 | =head2 Building Perl outside of the source directory |
86058a2d | 1050 | |
ce80d64e AD |
1051 | Sometimes it is desirable to build Perl in a directory different from |
1052 | where the sources are, for example if you want to keep your sources | |
1053 | read-only, or if you want to share the sources between different binary | |
1054 | architectures. You can do this (if your file system supports symbolic | |
1055 | links) by | |
06c896bb | 1056 | |
ce80d64e AD |
1057 | mkdir /tmp/perl/build/directory |
1058 | cd /tmp/perl/build/directory | |
1059 | sh /path/to/perl/source/Configure -Dmksymlinks ... | |
06c896bb | 1060 | |
ce80d64e AD |
1061 | This will create in /tmp/perl/build/directory a tree of symbolic links |
1062 | pointing to files in /path/to/perl/source. The original files are left | |
1063 | unaffected. After Configure has finished you can just say | |
06c896bb | 1064 | |
ce80d64e | 1065 | make |
7df75831 RGS |
1066 | make test |
1067 | make install | |
06c896bb | 1068 | |
ce80d64e | 1069 | as usual, and Perl will be built in /tmp/perl/build/directory. |
aa689395 | 1070 | |
3bf462b8 CS |
1071 | =head2 Building a debugging perl |
1072 | ||
1073 | You can run perl scripts under the perl debugger at any time with | |
3fe9a6f1 | 1074 | B<perl -d your_script>. If, however, you want to debug perl itself, |
eaf812ae MB |
1075 | you probably want to have support for perl internal debugging code |
1076 | (activated by adding -DDEBUGGING to ccflags), and/or support for the | |
f075db89 | 1077 | system debugger by adding -g to the optimisation flags. |
eaf812ae | 1078 | |
f075db89 DM |
1079 | A perl compiled with the DEBUGGING C preprocessor macro will support the |
1080 | C<-D> perl command-line switch, have assertions enabled, and have many | |
1081 | extra checks compiled into the code; but will execute much more slowly | |
1082 | (typically 2-3x) and the binary will be much larger (typically 2-3x). | |
08854360 | 1083 | |
f075db89 DM |
1084 | As a convenience, debugging code (-DDEBUGGING) and debugging symbols (-g) |
1085 | can be enabled jointly or separately using a Configure switch, also | |
1086 | (somewhat confusingly) named -DDEBUGGING. For a more eye appealing call, | |
1087 | -DEBUGGING is defined to be an alias for -DDEBUGGING. For both, the -U | |
1088 | calls are also supported, in order to be able to overrule the hints or | |
1089 | Policy.sh settings. | |
eaf812ae | 1090 | |
7df75831 | 1091 | Here are the DEBUGGING modes: |
3bf462b8 | 1092 | |
7df75831 | 1093 | =over 4 |
3bf462b8 | 1094 | |
f075db89 | 1095 | =item Configure -DDEBUGGING |
eaf812ae | 1096 | |
f075db89 | 1097 | =item Configure -DEBUGGING |
eaf812ae | 1098 | |
f075db89 | 1099 | =item Configure -DEBUGGING=both |
eaf812ae | 1100 | |
7df75831 RGS |
1101 | Sets both -DDEBUGGING in the ccflags, and adds -g to optimize. |
1102 | ||
1103 | You can actually specify -g and -DDEBUGGING independently (see below), | |
1104 | but usually it's convenient to have both. | |
eaf812ae | 1105 | |
f075db89 | 1106 | =item Configure -DEBUGGING=-g |
eaf812ae | 1107 | |
f075db89 | 1108 | =item Configure -Doptimize=-g |
7df75831 | 1109 | |
eaf812ae MB |
1110 | Adds -g to optimize, but does not set -DDEBUGGING. |
1111 | ||
7df75831 RGS |
1112 | (Note: Your system may actually require something like cc -g2. |
1113 | Check your man pages for cc(1) and also any hint file for your system.) | |
1114 | ||
f075db89 | 1115 | =item Configure -DEBUGGING=none |
eaf812ae | 1116 | |
f075db89 | 1117 | =item Configure -UDEBUGGING |
7df75831 | 1118 | |
eaf812ae MB |
1119 | Removes -g from optimize, and -DDEBUGGING from ccflags. |
1120 | ||
1121 | =back | |
1122 | ||
3bf462b8 | 1123 | If you are using a shared libperl, see the warnings about multiple |
ef460fb9 | 1124 | versions of perl under L</Building a shared Perl library>. |
3bf462b8 | 1125 | |
def5f8a5 DM |
1126 | Note that a perl built with -DDEBUGGING will be much bigger and will run |
1127 | much, much more slowly than a standard perl. | |
1db12997 DM |
1128 | |
1129 | =head2 DTrace support | |
1130 | ||
979b4168 | 1131 | On platforms where DTrace is available, it may be enabled by |
ab97e755 MB |
1132 | using the -Dusedtrace option to Configure. DTrace probes are available |
1133 | for subroutine entry (sub-entry) and subroutine exit (sub-exit). Here's a | |
1db12997 DM |
1134 | simple D script that uses them: |
1135 | ||
1136 | perl$target:::sub-entry, perl$target:::sub-return { | |
1137 | printf("%s %s (%s:%d)\n", probename == "sub-entry" ? "->" : "<-", | |
1138 | copyinstr(arg0), copyinstr(arg1), arg2); | |
1139 | } | |
1140 | ||
1141 | ||
8d74ce1c AD |
1142 | =head2 Extensions |
1143 | ||
80c1f5de | 1144 | Perl ships with a number of standard extensions. These are contained |
b0a63d58 | 1145 | in the F<ext/> subdirectory. |
80c1f5de | 1146 | |
8d74ce1c AD |
1147 | By default, Configure will offer to build every extension which appears |
1148 | to be supported. For example, Configure will offer to build GDBM_File | |
7df75831 | 1149 | only if it is able to find the gdbm library. |
ce80d64e AD |
1150 | |
1151 | To disable certain extensions so that they are not built, use the | |
1152 | -Dnoextensions=... and -Donlyextensions=... options. They both accept | |
47bd56ab DM |
1153 | a space-separated list of extensions, such as C<IPC/SysV>. The extensions |
1154 | listed in | |
ce80d64e AD |
1155 | C<noextensions> are removed from the list of extensions to build, while |
1156 | the C<onlyextensions> is rather more severe and builds only the listed | |
1157 | extensions. The latter should be used with extreme caution since | |
1158 | certain extensions are used by many other extensions and modules: | |
1159 | examples of such modules include Fcntl and IO. The order of processing | |
1160 | these options is first C<only> (if present), then C<no> (if present). | |
8d74ce1c AD |
1161 | |
1162 | Of course, you may always run Configure interactively and select only | |
1163 | the extensions you want. | |
1164 | ||
7df75831 RGS |
1165 | If you unpack any additional extensions in the ext/ directory before |
1166 | running Configure, then Configure will offer to build those additional | |
1167 | extensions as well. Most users probably shouldn't have to do this -- | |
1168 | it is usually easier to build additional extensions later after perl | |
1169 | has been installed. However, if you wish to have those additional | |
1170 | extensions statically linked into the perl binary, then this offers a | |
1171 | convenient way to do that in one step. (It is not necessary, however; | |
1172 | you can build and install extensions just fine even if you don't have | |
1173 | dynamic loading. See lib/ExtUtils/MakeMaker.pm for more details.) | |
1174 | Another way of specifying extra modules is described in | |
1175 | L<"Adding extra modules to the build"> below. | |
8d74ce1c | 1176 | |
dd3196cd | 1177 | If you re-use an old config.sh but change your system (e.g. by |
8d74ce1c AD |
1178 | adding libgdbm) Configure will still offer your old choices of extensions |
1179 | for the default answer, but it will also point out the discrepancy to | |
1180 | you. | |
1181 | ||
8d74ce1c AD |
1182 | =head2 Including locally-installed libraries |
1183 | ||
7df75831 RGS |
1184 | Perl comes with interfaces to number of libraries, including threads, |
1185 | dbm, ndbm, gdbm, and Berkeley db. For the *db* extension, if | |
8d74ce1c | 1186 | Configure can find the appropriate header files and libraries, it will |
7df75831 | 1187 | automatically include that extension. The threading extension needs |
27021420 | 1188 | to be specified explicitly (see L</Threads>). |
7df75831 RGS |
1189 | |
1190 | Those libraries are not distributed with perl. If your header (.h) files | |
1191 | for those libraries are not in a directory normally searched by your C | |
1192 | compiler, then you will need to include the appropriate -I/your/directory | |
1193 | option when prompted by Configure. If your libraries are not in a | |
1194 | directory normally searched by your C compiler and linker, then you will | |
1195 | need to include the appropriate -L/your/directory option when prompted | |
1196 | by Configure. See the examples below. | |
8d74ce1c | 1197 | |
ce80d64e | 1198 | =head3 Examples |
8d74ce1c AD |
1199 | |
1200 | =over 4 | |
1201 | ||
1202 | =item gdbm in /usr/local | |
1203 | ||
1204 | Suppose you have gdbm and want Configure to find it and build the | |
d6baa268 | 1205 | GDBM_File extension. This example assumes you have gdbm.h |
8d74ce1c AD |
1206 | installed in /usr/local/include/gdbm.h and libgdbm.a installed in |
1207 | /usr/local/lib/libgdbm.a. Configure should figure all the | |
1208 | necessary steps out automatically. | |
1209 | ||
1210 | Specifically, when Configure prompts you for flags for | |
7df75831 RGS |
1211 | your C compiler, you should include -I/usr/local/include, if it's |
1212 | not here yet. Similarly, when Configure prompts you for linker flags, | |
1213 | you should include -L/usr/local/lib. | |
8d74ce1c AD |
1214 | |
1215 | If you are using dynamic loading, then when Configure prompts you for | |
1216 | linker flags for dynamic loading, you should again include | |
1217 | -L/usr/local/lib. | |
1218 | ||
d6baa268 JH |
1219 | Again, this should all happen automatically. This should also work if |
1220 | you have gdbm installed in any of (/usr/local, /opt/local, /usr/gnu, | |
1221 | /opt/gnu, /usr/GNU, or /opt/GNU). | |
8d74ce1c | 1222 | |
e8b9ce60 AD |
1223 | =item BerkeleyDB in /usr/local/BerkeleyDB |
1224 | ||
668cbedd | 1225 | The version of BerkeleyDB distributed by Oracle installs in a |
e8b9ce60 AD |
1226 | version-specific directory by default, typically something like |
1227 | /usr/local/BerkeleyDB.4.7. To have Configure find that, you need to add | |
ab97e755 MB |
1228 | -I/usr/local/BerkeleyDB.4.7/include to cc flags, as in the previous |
1229 | example, and you will also have to take extra steps to help Configure | |
1230 | find -ldb. Specifically, when Configure prompts you for library | |
1231 | directories, add /usr/local/BerkeleyDB.4.7/lib to the list. Also, you | |
1232 | will need to add appropriate linker flags to tell the runtime linker | |
1233 | where to find the BerkeleyDB shared libraries. | |
e8b9ce60 AD |
1234 | |
1235 | It is possible to specify this from the command line (all on one | |
8d74ce1c AD |
1236 | line): |
1237 | ||
979b4168 KW |
1238 | sh Configure -de \ |
1239 | -Dlocincpth='/usr/local/BerkeleyDB.4.7/include \ | |
1240 | /usr/local/include' \ | |
1241 | -Dloclibpth='/usr/local/BerkeleyDB.4.7/lib /usr/local/lib' \ | |
1242 | -Aldflags='-R/usr/local/BerkeleyDB.4.7/lib' | |
8d74ce1c AD |
1243 | |
1244 | locincpth is a space-separated list of include directories to search. | |
1245 | Configure will automatically add the appropriate -I directives. | |
1246 | ||
1247 | loclibpth is a space-separated list of library directories to search. | |
e8b9ce60 | 1248 | Configure will automatically add the appropriate -L directives. |
8d74ce1c | 1249 | |
e8b9ce60 AD |
1250 | The addition to ldflags is so that the dynamic linker knows where to find |
1251 | the BerkeleyDB libraries. For Linux and Solaris, the -R option does that. | |
1252 | Other systems may use different flags. Use the appropriate flag for your | |
1253 | system. | |
8d74ce1c AD |
1254 | |
1255 | =back | |
1256 | ||
b76ca5cc BF |
1257 | =head2 Specifying a logical root directory |
1258 | ||
1259 | If you are cross-compiling, or are using a compiler which has it's own | |
1260 | headers and libraries in a nonstandard location, and your compiler | |
ab97e755 MB |
1261 | understands the C<--sysroot> option, you can use the C<-Dsysroot> option |
1262 | to specify the logical root directory under which all libraries and | |
1263 | headers are searched for. This patch adjusts Configure to search under | |
1264 | $sysroot, instead of /. | |
1265 | ||
b76ca5cc BF |
1266 | --sysroot is added to ccflags and friends so that make in |
1267 | ExtUtils::MakeMaker, and other extensions, will use it. | |
1268 | ||
ce80d64e AD |
1269 | =head2 Overriding an old config.sh |
1270 | ||
dd3196cd RGS |
1271 | If you want to use an old config.sh produced by a previous run of |
1272 | Configure, but override some of the items with command line options, you | |
1273 | need to use B<Configure -O>. | |
ce80d64e AD |
1274 | |
1275 | =head2 GNU-style configure | |
1276 | ||
1277 | If you prefer the GNU-style configure command line interface, you can | |
1278 | use the supplied configure.gnu command, e.g. | |
1279 | ||
1280 | CC=gcc ./configure.gnu | |
1281 | ||
1282 | The configure.gnu script emulates a few of the more common configure | |
1283 | options. Try | |
1284 | ||
1285 | ./configure.gnu --help | |
1286 | ||
1287 | for a listing. | |
1288 | ||
52917b36 TC |
1289 | Unrecognized arguments with a double dash prefix produce an error. |
1290 | ||
1291 | Any other arguments are passed through to C<Configure>, so you could | |
1292 | build a threaded perl with: | |
1293 | ||
1294 | CC=gcc ./configure.gnu -Dusethreads | |
1295 | ||
ce80d64e AD |
1296 | (The file is called configure.gnu to avoid problems on systems |
1297 | that would not distinguish the files "Configure" and "configure".) | |
1298 | ||
ce80d64e AD |
1299 | =head2 Malloc Issues |
1300 | ||
1301 | Perl relies heavily on malloc(3) to grow data structures as needed, | |
1302 | so perl's performance can be noticeably affected by the performance of | |
1303 | the malloc function on your system. The perl source is shipped with a | |
1304 | version of malloc that has been optimized for the typical requests from | |
1305 | perl, so there's a chance that it may be both faster and use less memory | |
1306 | than your system malloc. | |
1307 | ||
1308 | However, if your system already has an excellent malloc, or if you are | |
1309 | experiencing difficulties with extensions that use third-party libraries | |
1310 | that call malloc, then you should probably use your system's malloc. | |
1311 | (Or, you might wish to explore the malloc flags discussed below.) | |
1312 | ||
1313 | =over 4 | |
1314 | ||
1315 | =item Using the system malloc | |
1316 | ||
1317 | To build without perl's malloc, you can use the Configure command | |
1318 | ||
1319 | sh Configure -Uusemymalloc | |
1320 | ||
1321 | or you can answer 'n' at the appropriate interactive Configure prompt. | |
1322 | ||
73d6d1b0 RGS |
1323 | Note that Perl's malloc isn't always used by default; that actually |
1324 | depends on your system. For example, on Linux and FreeBSD (and many more | |
1325 | systems), Configure chooses to use the system's malloc by default. | |
1326 | See the appropriate file in the F<hints/> directory to see how the | |
1327 | default is set. | |
1328 | ||
ce80d64e AD |
1329 | =item -DPERL_POLLUTE_MALLOC |
1330 | ||
1331 | NOTE: This flag is enabled automatically on some platforms if you just | |
7df75831 | 1332 | run Configure to accept all the defaults. |
ce80d64e AD |
1333 | |
1334 | Perl's malloc family of functions are normally called Perl_malloc(), | |
1335 | Perl_realloc(), Perl_calloc() and Perl_mfree(). | |
1336 | These names do not clash with the system versions of these functions. | |
1337 | ||
1338 | If this flag is enabled, however, Perl's malloc family of functions | |
1339 | will have the same names as the system versions. This may be required | |
1340 | sometimes if you have libraries that like to free() data that may have | |
1341 | been allocated by Perl_malloc() and vice versa. | |
1342 | ||
1343 | Note that enabling this option may sometimes lead to duplicate symbols | |
1344 | from the linker for malloc et al. In such cases, the system probably | |
1345 | does not allow its malloc functions to be fully replaced with custom | |
1346 | versions. | |
1347 | ||
1348 | =item -DPERL_DEBUGGING_MSTATS | |
1349 | ||
1350 | This flag enables debugging mstats, which is required to use the | |
1351 | Devel::Peek::mstat() function. You cannot enable this unless you are | |
1352 | using Perl's malloc, so a typical Configure command would be | |
1353 | ||
7df75831 | 1354 | sh Configure -Accflags=-DPERL_DEBUGGING_MSTATS -Dusemymalloc |
ce80d64e AD |
1355 | |
1356 | to enable this option. | |
1357 | ||
1358 | =back | |
1359 | ||
8e07c86e AD |
1360 | =head2 What if it doesn't work? |
1361 | ||
8d74ce1c | 1362 | If you run into problems, try some of the following ideas. |
ff52061e | 1363 | If none of them help, then see L<"Reporting Problems"> below. |
8d74ce1c | 1364 | |
8e07c86e AD |
1365 | =over 4 |
1366 | ||
25f94b33 AD |
1367 | =item Running Configure Interactively |
1368 | ||
1369 | If Configure runs into trouble, remember that you can always run | |
1370 | Configure interactively so that you can check (and correct) its | |
1371 | guesses. | |
1372 | ||
1373 | All the installation questions have been moved to the top, so you don't | |
aa689395 | 1374 | have to wait for them. Once you've handled them (and your C compiler and |
1ec51d55 | 1375 | flags) you can type &-d at the next Configure prompt and Configure |
25f94b33 AD |
1376 | will use the defaults from then on. |
1377 | ||
1378 | If you find yourself trying obscure command line incantations and | |
1379 | config.over tricks, I recommend you run Configure interactively | |
1380 | instead. You'll probably save yourself time in the long run. | |
1381 | ||
aa689395 | 1382 | =item Hint files |
8e07c86e | 1383 | |
a0a8d9d3 DD |
1384 | Hint files tell Configure about a number of things: |
1385 | ||
1386 | =over 4 | |
1387 | ||
1388 | =item o | |
1389 | ||
1390 | The peculiarities or conventions of particular platforms -- non-standard | |
1391 | library locations and names, default installation locations for binaries, | |
1392 | and so on. | |
1393 | ||
1394 | =item o | |
1395 | ||
1396 | The deficiencies of the platform -- for example, library functions that, | |
1397 | although present, are too badly broken to be usable; or limits on | |
1398 | resources that are generously available on most platforms. | |
1399 | ||
1400 | =item o | |
1401 | ||
ab97e755 MB |
1402 | How best to optimize for the platform, both in terms of binary size |
1403 | and/or speed, and for Perl feature support. Because of wide variations in | |
1404 | the implementation of shared libraries and of threading, for example, | |
1405 | Configure often needs hints in order to be able to use these features. | |
a0a8d9d3 DD |
1406 | |
1407 | =back | |
1408 | ||
1409 | The perl distribution includes many system-specific hints files | |
1410 | in the hints/ directory. If one of them matches your system, Configure | |
1411 | will offer to use that hint file. Unless you have a very good reason | |
1412 | not to, you should accept its offer. | |
8e07c86e AD |
1413 | |
1414 | Several of the hint files contain additional important information. | |
ab97e755 MB |
1415 | If you have any problems, it is a good idea to read the relevant hint |
1416 | file for further information. See hints/solaris_2.sh for an extensive | |
1417 | example. More information about writing good hints is in the | |
1418 | hints/README.hints file, which also explains hint files known as | |
1419 | callback-units. | |
a0a8d9d3 DD |
1420 | |
1421 | Note that any hint file is read before any Policy file, meaning that | |
1422 | Policy overrides hints -- see L</Site-wide Policy settings>. | |
8e07c86e | 1423 | |
73d6d1b0 | 1424 | =item WHOA THERE!!! |
edb1cbcb | 1425 | |
ab97e755 MB |
1426 | If you are re-using an old config.sh, it's possible that Configure |
1427 | detects different values from the ones specified in this file. You will | |
1428 | almost always want to keep the previous value, unless you have changed | |
1429 | something on your system. | |
edb1cbcb | 1430 | |
1431 | For example, suppose you have added libgdbm.a to your system | |
1432 | and you decide to reconfigure perl to use GDBM_File. When you run | |
1433 | Configure again, you will need to add -lgdbm to the list of libraries. | |
bfb7748a AD |
1434 | Now, Configure will find your gdbm include file and library and will |
1435 | issue a message: | |
edb1cbcb | 1436 | |
1437 | *** WHOA THERE!!! *** | |
1438 | The previous value for $i_gdbm on this machine was "undef"! | |
1439 | Keep the previous value? [y] | |
1440 | ||
1ec51d55 | 1441 | In this case, you do not want to keep the previous value, so you |
c3edaffb | 1442 | should answer 'n'. (You'll also have to manually add GDBM_File to |
edb1cbcb | 1443 | the list of dynamic extensions to build.) |
1444 | ||
8e07c86e AD |
1445 | =item Changing Compilers |
1446 | ||
1447 | If you change compilers or make other significant changes, you should | |
1ec51d55 | 1448 | probably not re-use your old config.sh. Simply remove it or |
dd3196cd | 1449 | rename it, then rerun Configure with the options you want to use. |
8e07c86e | 1450 | |
c3edaffb | 1451 | =item Propagating your changes to config.sh |
8e07c86e | 1452 | |
1ec51d55 CS |
1453 | If you make any changes to config.sh, you should propagate |
1454 | them to all the .SH files by running | |
1455 | ||
1456 | sh Configure -S | |
1457 | ||
1458 | You will then have to rebuild by running | |
9d67150a | 1459 | |
1460 | make depend | |
1461 | make | |
8e07c86e | 1462 | |
48370efc JH |
1463 | =item config.over and config.arch |
1464 | ||
668cbedd | 1465 | You can also supply a shell script config.over to override |
48370efc JH |
1466 | Configure's guesses. It will get loaded up at the very end, just |
1467 | before config.sh is created. You have to be careful with this, | |
1468 | however, as Configure does no checking that your changes make sense. | |
1469 | This file is usually good for site-specific customizations. | |
1470 | ||
1471 | There is also another file that, if it exists, is loaded before the | |
1472 | config.over, called config.arch. This file is intended to be per | |
1473 | architecture, not per site, and usually it's the architecture-specific | |
1474 | hints file that creates the config.arch. | |
8e07c86e AD |
1475 | |
1476 | =item config.h | |
1477 | ||
1ec51d55 CS |
1478 | Many of the system dependencies are contained in config.h. |
1479 | Configure builds config.h by running the config_h.SH script. | |
1480 | The values for the variables are taken from config.sh. | |
8e07c86e | 1481 | |
1ec51d55 CS |
1482 | If there are any problems, you can edit config.h directly. Beware, |
1483 | though, that the next time you run Configure, your changes will be | |
8e07c86e AD |
1484 | lost. |
1485 | ||
1486 | =item cflags | |
1487 | ||
1488 | If you have any additional changes to make to the C compiler command | |
1ec51d55 | 1489 | line, they can be made in cflags.SH. For instance, to turn off the |
5729ffdd NC |
1490 | optimizer on toke.c, find the switch structure marked 'or customize here', |
1491 | and add a line for toke.c ahead of the catch-all *) so that it now reads: | |
1492 | ||
1493 | : or customize here | |
1494 | ||
1495 | case "$file" in | |
1496 | toke) optimize='-g' ;; | |
1497 | *) ;; | |
1498 | ||
ab97e755 MB |
1499 | You should not edit the generated file cflags directly, as your changes |
1500 | will be lost the next time you run Configure, or if you edit config.sh. | |
8e07c86e | 1501 | |
f5b3b617 AD |
1502 | To explore various ways of changing ccflags from within a hint file, |
1503 | see the file hints/README.hints. | |
1504 | ||
1505 | To change the C flags for all the files, edit config.sh and change either | |
1506 | $ccflags or $optimize, and then re-run | |
1ec51d55 CS |
1507 | |
1508 | sh Configure -S | |
1509 | make depend | |
8e07c86e | 1510 | |
aa689395 | 1511 | =item No sh |
8e07c86e | 1512 | |
c42e3e15 GS |
1513 | If you don't have sh, you'll have to copy the sample file |
1514 | Porting/config.sh to config.sh and edit your config.sh to reflect your | |
1515 | system's peculiarities. See Porting/pumpkin.pod for more information. | |
8e07c86e AD |
1516 | You'll probably also have to extensively modify the extension building |
1517 | mechanism. | |
1518 | ||
c3edaffb | 1519 | =item Porting information |
1520 | ||
e6f03d26 | 1521 | Specific information for the OS/2, Plan 9, VMS and Win32 ports is in the |
1ec51d55 CS |
1522 | corresponding README files and subdirectories. Additional information, |
1523 | including a glossary of all those config.sh variables, is in the Porting | |
ce80d64e | 1524 | subdirectory. Porting/Glossary should especially come in handy. |
c3edaffb | 1525 | |
7f678428 | 1526 | Ports for other systems may also be available. You should check out |
f6521f7c | 1527 | L<https://www.cpan.org/ports> for current information on ports to |
7f678428 | 1528 | various other operating systems. |
1529 | ||
ce80d64e | 1530 | If you plan to port Perl to a new architecture, study carefully the |
491517e0 | 1531 | section titled "Philosophical Issues in Patching and Porting Perl" |
c222ef46 | 1532 | in the file Porting/pumpkin.pod and the file pod/perlgit.pod. |
491517e0 JA |
1533 | Study also how other non-UNIX ports have solved problems. |
1534 | ||
8e07c86e AD |
1535 | =back |
1536 | ||
ce80d64e | 1537 | =head2 Adding extra modules to the build |
fadf0ef5 JH |
1538 | |
1539 | You can specify extra modules or module bundles to be fetched from the | |
1540 | CPAN and installed as part of the Perl build. Either use the -Dextras=... | |
1541 | command line parameter to Configure, for example like this: | |
1542 | ||
d3df0cfd | 1543 | Configure -Dextras="Bundle::LWP DBI" |
fadf0ef5 JH |
1544 | |
1545 | or answer first 'y' to the question 'Install any extra modules?' and | |
d3df0cfd | 1546 | then answer "Bundle::LWP DBI" to the 'Extras?' question. |
ab97e755 MB |
1547 | The module or the bundle names are as for the CPAN module 'install' |
1548 | command. This will only work if those modules are to be built as dynamic | |
a522f097 AD |
1549 | extensions. If you wish to include those extra modules as static |
1550 | extensions, see L<"Extensions"> above. | |
fadf0ef5 JH |
1551 | |
1552 | Notice that because the CPAN module will be used to fetch the extra | |
1553 | modules, you will need access to the CPAN, either via the Internet, | |
1554 | or via a local copy such as a CD-ROM or a local CPAN mirror. If you | |
1555 | do not, using the extra modules option will die horribly. | |
1556 | ||
1557 | Also notice that you yourself are responsible for satisfying any extra | |
ab97e755 MB |
1558 | dependencies such as external headers or libraries BEFORE trying the |
1559 | build. For example: you will need to have the Foo database specific | |
fadf0ef5 JH |
1560 | headers and libraries installed for the DBD::Foo module. The Configure |
1561 | process or the Perl build process will not help you with these. | |
1562 | ||
ce80d64e | 1563 | =head2 suidperl |
03739d21 | 1564 | |
172dd959 JV |
1565 | suidperl was an optional component of earlier releases of perl. It is no |
1566 | longer available. Instead, use a tool specifically designed to handle | |
1567 | changes in privileges, such as B<sudo>. | |
03739d21 | 1568 | |
8e07c86e AD |
1569 | =head1 make depend |
1570 | ||
bfb7748a AD |
1571 | This will look for all the includes. The output is stored in makefile. |
1572 | The only difference between Makefile and makefile is the dependencies at | |
1573 | the bottom of makefile. If you have to make any changes, you should edit | |
ce80d64e | 1574 | makefile, not Makefile, since the Unix make command reads makefile first. |
bfb7748a AD |
1575 | (On non-Unix systems, the output may be stored in a different file. |
1576 | Check the value of $firstmakefile in your config.sh if in doubt.) | |
8e07c86e AD |
1577 | |
1578 | Configure will offer to do this step for you, so it isn't listed | |
1579 | explicitly above. | |
1580 | ||
1581 | =head1 make | |
1582 | ||
1583 | This will attempt to make perl in the current directory. | |
1584 | ||
8d410bc4 YST |
1585 | =head2 Expected errors |
1586 | ||
f5b5f377 | 1587 | These error reports are normal, and can be ignored: |
8d410bc4 YST |
1588 | |
1589 | ... | |
1590 | make: [extra.pods] Error 1 (ignored) | |
1591 | ... | |
1592 | make: [extras.make] Error 1 (ignored) | |
1593 | ||
8d74ce1c AD |
1594 | =head2 What if it doesn't work? |
1595 | ||
8e07c86e | 1596 | If you can't compile successfully, try some of the following ideas. |
7f678428 | 1597 | If none of them help, and careful reading of the error message and |
8d74ce1c | 1598 | the relevant manual pages on your system doesn't help, |
ff52061e | 1599 | then see L<"Reporting Problems"> below. |
8e07c86e AD |
1600 | |
1601 | =over 4 | |
1602 | ||
1ec51d55 | 1603 | =item hints |
8e07c86e AD |
1604 | |
1605 | If you used a hint file, try reading the comments in the hint file | |
1606 | for further tips and information. | |
1607 | ||
1ec51d55 | 1608 | =item extensions |
8e07c86e | 1609 | |
1ec51d55 | 1610 | If you can successfully build miniperl, but the process crashes |
ce80d64e | 1611 | during the building of extensions, run |
c3edaffb | 1612 | |
3a6175e1 | 1613 | make minitest |
c3edaffb | 1614 | |
1615 | to test your version of miniperl. | |
1616 | ||
e57fd563 | 1617 | =item locale |
1618 | ||
bfb7748a AD |
1619 | If you have any locale-related environment variables set, try unsetting |
1620 | them. I have some reports that some versions of IRIX hang while | |
1621 | running B<./miniperl configpm> with locales other than the C locale. | |
1622 | See the discussion under L<"make test"> below about locales and the | |
ab97e755 MB |
1623 | whole L<perllocale/"LOCALE PROBLEMS"> section in the file |
1624 | pod/perllocale.pod. The latter is especially useful if you see something | |
1625 | like this | |
3e6e419a JH |
1626 | |
1627 | perl: warning: Setting locale failed. | |
1628 | perl: warning: Please check that your locale settings: | |
1629 | LC_ALL = "En_US", | |
1630 | LANG = (unset) | |
1631 | are supported and installed on your system. | |
1632 | perl: warning: Falling back to the standard locale ("C"). | |
1633 | ||
1634 | at Perl startup. | |
e57fd563 | 1635 | |
06aa495b DM |
1636 | =item other environment variables |
1637 | ||
1638 | Configure does not check for environment variables that can sometimes | |
1639 | have a major influence on how perl is built or tested. For example, | |
1640 | OBJECT_MODE on AIX determines the way the compiler and linker deal with | |
1641 | their objects, but this is a variable that only influences build-time | |
1642 | behaviour, and should not affect the perl scripts that are eventually | |
1643 | executed by the perl binary. Other variables, like PERL_UNICODE, | |
adbb55c0 | 1644 | PERL5LIB, and PERL5OPT will influence the behaviour of the test suite. |
06aa495b DM |
1645 | So if you are getting strange test failures, you may want to try |
1646 | retesting with the various PERL variables unset. | |
1647 | ||
1ec51d55 | 1648 | =item LD_LIBRARY_PATH |
c3edaffb | 1649 | |
1650 | If you run into dynamic loading problems, check your setting of | |
0fd807f7 KW |
1651 | the LD_LIBRARY_PATH environment variable (or on some systems the equivalent |
1652 | with a different name, see L</Building a shared Perl library>). If you're | |
1653 | creating a static Perl library (libperl.a rather than libperl.so) it should | |
1654 | build fine with LD_LIBRARY_PATH unset, though that may depend on details of | |
1655 | your local setup. | |
c3edaffb | 1656 | |
aa689395 | 1657 | =item nm extraction |
c3edaffb | 1658 | |
1659 | If Configure seems to be having trouble finding library functions, | |
1660 | try not using nm extraction. You can do this from the command line | |
1661 | with | |
1662 | ||
1663 | sh Configure -Uusenm | |
1664 | ||
1665 | or by answering the nm extraction question interactively. | |
1ec51d55 | 1666 | If you have previously run Configure, you should not reuse your old |
c3edaffb | 1667 | config.sh. |
1668 | ||
bfb7748a AD |
1669 | =item umask not found |
1670 | ||
1671 | If the build processes encounters errors relating to umask(), the problem | |
1672 | is probably that Configure couldn't find your umask() system call. | |
1673 | Check your config.sh. You should have d_umask='define'. If you don't, | |
1674 | this is probably the L<"nm extraction"> problem discussed above. Also, | |
1675 | try reading the hints file for your system for further information. | |
1676 | ||
3fe9a6f1 | 1677 | =item do_aspawn |
1678 | ||
1679 | If you run into problems relating to do_aspawn or do_spawn, the | |
1680 | problem is probably that Configure failed to detect your system's | |
bfb7748a AD |
1681 | fork() function. Follow the procedure in the previous item |
1682 | on L<"nm extraction">. | |
3fe9a6f1 | 1683 | |
84902520 TB |
1684 | =item __inet_* errors |
1685 | ||
1686 | If you receive unresolved symbol errors during Perl build and/or test | |
1687 | referring to __inet_* symbols, check to see whether BIND 8.1 is | |
1688 | installed. It installs a /usr/local/include/arpa/inet.h that refers to | |
1689 | these symbols. Versions of BIND later than 8.1 do not install inet.h | |
1690 | in that location and avoid the errors. You should probably update to a | |
6d240721 | 1691 | newer version of BIND (and remove the files the old one left behind). |
ab97e755 MB |
1692 | If you can't, you can either link with the updated resolver library |
1693 | provided with BIND 8.1 or rename /usr/local/bin/arpa/inet.h during the | |
1694 | Perl build and test process to avoid the problem. | |
6d240721 | 1695 | |
73d6d1b0 | 1696 | =item .*_r() prototype NOT found |
6d240721 JH |
1697 | |
1698 | On a related note, if you see a bunch of complaints like the above about | |
ab97e755 MB |
1699 | reentrant functions -- specifically networking-related ones -- being |
1700 | present but without prototypes available, check to see if BIND 8.1 (or | |
1701 | possibly other BIND 8 versions) is (or has been) installed. They install | |
1702 | header files such as netdb.h into places such as /usr/local/include (or | |
1703 | into another directory as specified at build/install time), at least | |
1704 | optionally. Remove them or put them in someplace that isn't in the C | |
1705 | preprocessor's header file include search path (determined by -I options | |
1706 | plus defaults, normally /usr/include). | |
84902520 | 1707 | |
d6baa268 JH |
1708 | =item #error "No DATAMODEL_NATIVE specified" |
1709 | ||
1710 | This is a common error when trying to build perl on Solaris 2.6 with a | |
1711 | gcc installation from Solaris 2.5 or 2.5.1. The Solaris header files | |
1712 | changed, so you need to update your gcc installation. You can either | |
1713 | rerun the fixincludes script from gcc or take the opportunity to | |
1714 | update your gcc installation. | |
1715 | ||
aa689395 | 1716 | =item Optimizer |
c3edaffb | 1717 | |
9d67150a | 1718 | If you can't compile successfully, try turning off your compiler's |
aa689395 | 1719 | optimizer. Edit config.sh and change the line |
9d67150a | 1720 | |
1721 | optimize='-O' | |
1722 | ||
bfb7748a | 1723 | to |
9d67150a | 1724 | |
1725 | optimize=' ' | |
1726 | ||
1727 | then propagate your changes with B<sh Configure -S> and rebuild | |
1728 | with B<make depend; make>. | |
1729 | ||
4bbc1586 | 1730 | =item Missing functions and Undefined symbols |
9d67150a | 1731 | |
4bbc1586 AD |
1732 | If the build of miniperl fails with a long list of missing functions or |
1733 | undefined symbols, check the libs variable in the config.sh file. It | |
1734 | should look something like | |
1735 | ||
1736 | libs='-lsocket -lnsl -ldl -lm -lc' | |
1737 | ||
1738 | The exact libraries will vary from system to system, but you typically | |
1739 | need to include at least the math library -lm. Normally, Configure | |
1740 | will suggest the correct defaults. If the libs variable is empty, you | |
1741 | need to start all over again. Run | |
1742 | ||
1743 | make distclean | |
1744 | ||
1745 | and start from the very beginning. This time, unless you are sure of | |
1746 | what you are doing, accept the default list of libraries suggested by | |
1747 | Configure. | |
1748 | ||
0ff780f4 MB |
1749 | If the libs variable is missing -lm, there is a chance that libm.so.1 |
1750 | is available, but the required (symbolic) link to libm.so is missing. | |
1751 | (same could be the case for other libraries like libcrypt.so). You | |
1752 | should check your installation for packages that create that link, and | |
1753 | if no package is installed that supplies that link or you cannot install | |
1754 | them, make the symbolic link yourself e.g.: | |
1755 | ||
c7121961 FC |
1756 | $ rpm -qf /usr/lib64/libm.so |
1757 | glibc-devel-2.15-22.17.1.x86_64 | |
1758 | $ ls -lgo /usr/lib64/libm.so | |
1759 | lrwxrwxrwx 1 16 Jan 7 2013 /usr/lib64/libm.so -> /lib64/libm.so.6 | |
0ff780f4 | 1760 | |
c7121961 | 1761 | or |
0ff780f4 | 1762 | |
c7121961 | 1763 | $ sudo ln -s /lib64/libm.so.6 /lib64/libm.so |
0ff780f4 | 1764 | |
4bbc1586 AD |
1765 | If the libs variable looks correct, you might have the |
1766 | L<"nm extraction"> problem discussed above. | |
1767 | ||
668cbedd | 1768 | If you still have missing routines or undefined symbols, you probably |
0ff780f4 MB |
1769 | need to add some library or other, make a symbolic link like described |
1770 | above, or you need to undefine some feature that Configure thought was | |
1771 | there but is defective or incomplete. If you used a hint file, see if | |
a3815e44 | 1772 | it has any relevant advice. You can also look through config.h |
0ff780f4 | 1773 | for likely suspects. |
8e07c86e | 1774 | |
1ec51d55 | 1775 | =item toke.c |
8e07c86e | 1776 | |
1ec51d55 CS |
1777 | Some compilers will not compile or optimize the larger files (such as |
1778 | toke.c) without some extra switches to use larger jump offsets or | |
1779 | allocate larger internal tables. You can customize the switches for | |
ab97e755 MB |
1780 | each file in cflags.SH. It's okay to insert rules for specific files |
1781 | into makefile since a default rule only takes effect in the absence of a | |
8e07c86e AD |
1782 | specific rule. |
1783 | ||
7f678428 | 1784 | =item Missing dbmclose |
8e07c86e | 1785 | |
c3edaffb | 1786 | SCO prior to 3.2.4 may be missing dbmclose(). An upgrade to 3.2.4 |
1787 | that includes libdbm.nfs (which includes dbmclose()) may be available. | |
8e07c86e | 1788 | |
1bb125e2 MB |
1789 | =item error: too few arguments to function 'dbmclose' |
1790 | ||
1791 | Building ODBM_File on some (Open)SUSE distributions might run into this | |
1792 | error, as the header file is broken. There are two ways to deal with this | |
1793 | ||
1794 | 1. Disable the use of ODBM_FILE | |
1795 | ||
f0c21bde | 1796 | sh Configure ... -Dnoextensions=ODBM_File |
1bb125e2 MB |
1797 | |
1798 | 2. Fix the header file, somewhat like this: | |
1799 | ||
1800 | --- a/usr/include/dbm.h 2010-03-24 08:54:59.000000000 +0100 | |
1801 | +++ b/usr/include/dbm.h 2010-03-24 08:55:15.000000000 +0100 | |
1802 | @@ -59,4 +59,4 @@ extern datum firstkey __P((void)); | |
1803 | ||
1804 | extern datum nextkey __P((datum key)); | |
1805 | ||
1806 | -extern int dbmclose __P((DBM *)); | |
1807 | +extern int dbmclose __P((void)); | |
1808 | ||
44666fef | 1809 | =item Warning (mostly harmless): No library found for -lsomething |
7f678428 | 1810 | |
1811 | If you see such a message during the building of an extension, but | |
1812 | the extension passes its tests anyway (see L<"make test"> below), | |
1813 | then don't worry about the warning message. The extension | |
1814 | Makefile.PL goes looking for various libraries needed on various | |
aa689395 | 1815 | systems; few systems will need all the possible libraries listed. |
74b7c41f | 1816 | Most users will see warnings for the ones they don't have. The |
44666fef | 1817 | phrase 'mostly harmless' is intended to reassure you that nothing |
74b7c41f | 1818 | unusual is happening, and the build process is continuing. |
7f678428 | 1819 | |
1820 | On the other hand, if you are building GDBM_File and you get the | |
1821 | message | |
1822 | ||
44666fef | 1823 | Warning (mostly harmless): No library found for -lgdbm |
7f678428 | 1824 | |
1825 | then it's likely you're going to run into trouble somewhere along | |
1826 | the line, since it's hard to see how you can use the GDBM_File | |
1827 | extension without the -lgdbm library. | |
1828 | ||
1829 | It is true that, in principle, Configure could have figured all of | |
1830 | this out, but Configure and the extension building process are not | |
1831 | quite that tightly coordinated. | |
1832 | ||
aa689395 | 1833 | =item sh: ar: not found |
1834 | ||
1835 | This is a message from your shell telling you that the command 'ar' | |
1836 | was not found. You need to check your PATH environment variable to | |
1837 | make sure that it includes the directory with the 'ar' command. This | |
1ec51d55 | 1838 | is a common problem on Solaris, where 'ar' is in the /usr/ccs/bin |
aa689395 | 1839 | directory. |
1840 | ||
1841 | =item db-recno failure on tests 51, 53 and 55 | |
1842 | ||
1843 | Old versions of the DB library (including the DB library which comes | |
1844 | with FreeBSD 2.1) had broken handling of recno databases with modified | |
1845 | bval settings. Upgrade your DB library or OS. | |
1846 | ||
6087ac44 JH |
1847 | =item Bad arg length for semctl, is XX, should be ZZZ |
1848 | ||
c935ba53 | 1849 | If you get this error message from the F<cpan/IPC-SysV/t/sem.t> test, your |
ab97e755 | 1850 | System V IPC may be broken. The XX typically is 20, and that is what ZZZ |
6087ac44 JH |
1851 | also should be. Consider upgrading your OS, or reconfiguring your OS |
1852 | to include the System V semaphores. | |
1853 | ||
c935ba53 | 1854 | =item cpan/IPC-SysV/t/sem........semget: No space left on device |
220f3621 GS |
1855 | |
1856 | Either your account or the whole system has run out of semaphores. Or | |
1857 | both. Either list the semaphores with "ipcs" and remove the unneeded | |
1858 | ones (which ones these are depends on your system and applications) | |
1859 | with "ipcrm -s SEMAPHORE_ID_HERE" or configure more semaphores to your | |
1860 | system. | |
1861 | ||
d6baa268 JH |
1862 | =item GNU binutils |
1863 | ||
1864 | If you mix GNU binutils (nm, ld, ar) with equivalent vendor-supplied | |
1865 | tools you may be in for some trouble. For example creating archives | |
1866 | with an old GNU 'ar' and then using a new current vendor-supplied 'ld' | |
1867 | may lead into linking problems. Either recompile your GNU binutils | |
1868 | under your current operating system release, or modify your PATH not | |
1869 | to include the GNU utils before running Configure, or specify the | |
1870 | vendor-supplied utilities explicitly to Configure, for example by | |
1871 | Configure -Dar=/bin/ar. | |
1872 | ||
16dc217a GS |
1873 | =item THIS PACKAGE SEEMS TO BE INCOMPLETE |
1874 | ||
1875 | The F<Configure> program has not been able to find all the files which | |
1876 | make up the complete Perl distribution. You may have a damaged source | |
1877 | archive file (in which case you may also have seen messages such as | |
1878 | C<gzip: stdin: unexpected end of file> and C<tar: Unexpected EOF on | |
1879 | archive file>), or you may have obtained a structurally-sound but | |
1880 | incomplete archive. In either case, try downloading again from the | |
1881 | official site named at the start of this document. If you do find | |
1882 | that any site is carrying a corrupted or incomplete source code | |
1883 | archive, please report it to the site's maintainer. | |
1884 | ||
16dc217a GS |
1885 | =item invalid token: ## |
1886 | ||
ce80d64e AD |
1887 | You are using a non-ANSI-compliant C compiler. To compile Perl, you |
1888 | need to use a compiler that supports ANSI C. If there is a README | |
1889 | file for your system, it may have further details on your compiler | |
1890 | options. | |
16dc217a | 1891 | |
1ec51d55 | 1892 | =item Miscellaneous |
8e07c86e | 1893 | |
7df75831 | 1894 | Some additional things that have been reported: |
8e07c86e AD |
1895 | |
1896 | Genix may need to use libc rather than libc_s, or #undef VARARGS. | |
1897 | ||
1898 | NCR Tower 32 (OS 2.01.01) may need -W2,-Sl,2000 and #undef MKDIR. | |
1899 | ||
668cbedd | 1900 | UTS may need one or more of -K or -g, and #undef LSTAT. |
8e07c86e | 1901 | |
c935ba53 | 1902 | FreeBSD can fail the F<cpan/IPC-SysV/t/sem.t> test if SysV IPC has not been |
5cda700b | 1903 | configured in the kernel. Perl tries to detect this, though, and |
ce80d64e | 1904 | you will get a message telling you what to do. |
6087ac44 | 1905 | |
6c8d78fb HS |
1906 | Building Perl on a system that has also BIND (headers and libraries) |
1907 | installed may run into troubles because BIND installs its own netdb.h | |
1908 | and socket.h, which may not agree with the operating system's ideas of | |
1909 | the same files. Similarly, including -lbind may conflict with libc's | |
1910 | view of the world. You may have to tweak -Dlocincpth and -Dloclibpth | |
1911 | to avoid the BIND. | |
1912 | ||
8e07c86e AD |
1913 | =back |
1914 | ||
58a21a9b JH |
1915 | =head2 Cross-compilation |
1916 | ||
e7a3c61b | 1917 | Perl can be cross-compiled. It is just not trivial, cross-compilation |
30bba555 | 1918 | rarely is. Perl is routinely cross-compiled for several platforms: as of |
ae2a00c5 | 1919 | June 2019, these include Android, Blackberry 10, |
79c32fc2 | 1920 | ARM Linux, and Solaris. Previous versions of |
30bba555 BF |
1921 | Perl also provided support for Open Zaurus, Symbian, and |
1922 | the IBM OS/400, but it's unknown if those ports are still functional. | |
ab97e755 MB |
1923 | These platforms are known as the B<target> platforms, while the systems |
1924 | where the compilation takes place are the B<host> platforms. | |
e7a3c61b JH |
1925 | |
1926 | What makes the situation difficult is that first of all, | |
1927 | cross-compilation environments vary significantly in how they are set | |
1928 | up and used, and secondly because the primary way of configuring Perl | |
1929 | (using the rather large Unix-tool-dependent Configure script) is not | |
1930 | awfully well suited for cross-compilation. However, starting from | |
30bba555 BF |
1931 | version 5.18.0, the Configure script also knows two ways of supporting |
1932 | cross-compilation, so please keep reading. | |
e7a3c61b JH |
1933 | |
1934 | See the following files for more information about compiling Perl for | |
1935 | the particular platforms: | |
1936 | ||
1937 | =over 4 | |
1938 | ||
30bba555 | 1939 | =item Android |
e7a3c61b | 1940 | |
ab97e755 MB |
1941 | L<"Cross-compilation" in README.android or |
1942 | perlandroid|perlandroid/Cross-compilation> | |
e7a3c61b | 1943 | |
30bba555 | 1944 | =item Blackberry |
e7a3c61b | 1945 | |
30bba555 | 1946 | L<"Cross-compilation" in README.qnx or perlqnx|perlqnx/Cross-compilation> |
e7a3c61b | 1947 | |
30bba555 | 1948 | =item Solaris |
e7a3c61b | 1949 | |
ab97e755 MB |
1950 | L<"CROSS-COMPILATION" in README.solaris or |
1951 | perlsolaris|perlsolaris/CROSS-COMPILATION> | |
30bba555 BF |
1952 | |
1953 | =item Linux | |
1954 | ||
1955 | This document; See below. | |
e7a3c61b JH |
1956 | |
1957 | =back | |
1958 | ||
1959 | Packaging and transferring either the core Perl modules or CPAN | |
1960 | modules to the target platform is also left up to the each | |
1961 | cross-compilation environment. Often the cross-compilation target | |
1962 | platforms are somewhat limited in diskspace: see the section | |
ef460fb9 | 1963 | L</Minimizing the Perl installation> to learn more of the minimal set |
e7a3c61b JH |
1964 | of files required for a functional Perl installation. |
1965 | ||
1966 | For some cross-compilation environments the Configure option | |
ef460fb9 | 1967 | C<-Dinstallprefix=...> might be handy, see L</Changing the installation |
e7a3c61b JH |
1968 | directory>. |
1969 | ||
30bba555 | 1970 | About the cross-compilation support of Configure: There's two forms. |
ab97e755 MB |
1971 | The more common one requires some way of transferring and running |
1972 | executables in the target system, such as an ssh connection; this is the | |
1973 | C<./Configure -Dusecrosscompile -Dtargethost=...> route. The second | |
1974 | method doesn't need access to the target system, but requires you to | |
a3815e44 | 1975 | provide a config.sh, and a canned Makefile; the rest of this section |
ab97e755 | 1976 | describes the former. |
e7a3c61b | 1977 | |
30bba555 | 1978 | This cross-compilation setup of Configure has successfully been used in |
ab97e755 MB |
1979 | a wide variety of setups, such as a 64-bit OS X host for an Android ARM |
1980 | target, or an amd64 Linux host targeting x86 Solaris, or even Windows. | |
e7a3c61b JH |
1981 | |
1982 | To run Configure in cross-compilation mode the basic switch that | |
30bba555 | 1983 | has to be used is C<-Dusecrosscompile>: |
58a21a9b JH |
1984 | |
1985 | sh ./Configure -des -Dusecrosscompile -D... | |
1986 | ||
1987 | This will make the cpp symbol USE_CROSS_COMPILE and the %Config | |
30bba555 | 1988 | symbol C<usecrosscompile> available. |
58a21a9b JH |
1989 | |
1990 | During the Configure and build, certain helper scripts will be created | |
1991 | into the Cross/ subdirectory. The scripts are used to execute a | |
1992 | cross-compiled executable, and to transfer files to and from the | |
1993 | target host. The execution scripts are named F<run-*> and the | |
1994 | transfer scripts F<to-*> and F<from-*>. The part after the dash is | |
1995 | the method to use for remote execution and transfer: by default the | |
1996 | methods are B<ssh> and B<scp>, thus making the scripts F<run-ssh>, | |
1997 | F<to-scp>, and F<from-scp>. | |
1998 | ||
1999 | To configure the scripts for a target host and a directory (in which | |
2000 | the execution will happen and which is to and from where the transfer | |
2001 | happens), supply Configure with | |
2002 | ||
2003 | -Dtargethost=so.me.ho.st -Dtargetdir=/tar/get/dir | |
2004 | ||
2005 | The targethost is what e.g. ssh will use as the hostname, the targetdir | |
93bc48fa JH |
2006 | must exist (the scripts won't create it), the targetdir defaults to /tmp. |
2007 | You can also specify a username to use for ssh/rsh logins | |
58a21a9b JH |
2008 | |
2009 | -Dtargetuser=luser | |
2010 | ||
30bba555 | 2011 | but in case you don't, "root" will be used. Similarly, you can specify |
ab97e755 MB |
2012 | a non-standard (i.e. not 22) port for the connection, if applicable, |
2013 | through | |
30bba555 BF |
2014 | |
2015 | -Dtargetport=2222 | |
58a21a9b | 2016 | |
30bba555 BF |
2017 | If the name of C<cc> has the usual GNU C semantics for cross |
2018 | compilers, that is, CPU-OS-gcc, the target architecture (C<targetarch>), | |
2019 | plus names of the C<ar>, C<nm>, and C<ranlib> will also be automatically | |
2020 | chosen to be CPU-OS-ar and so on. | |
2021 | (The C<ld> requires more thought and will be chosen later by Configure | |
2022 | as appropriate). This will also aid in guessing the proper | |
2023 | operating system name for the target, which has other repercussions, like | |
ab97e755 MB |
2024 | better defaults and possibly critical fixes for the platform. If |
2025 | Configure isn't guessing the OS name properly, you may need to either add | |
2026 | a hint file redirecting Configure's guess, or modify Configure to make | |
2027 | the correct choice. | |
30bba555 BF |
2028 | |
2029 | If your compiler doesn't follow that convention, you will also need to | |
2030 | specify which target environment to use, as well as C<ar> and friends: | |
58a21a9b JH |
2031 | |
2032 | -Dtargetarch=arm-linux | |
30bba555 BF |
2033 | -Dcc=mycrossgcc |
2034 | -Dar=... | |
2035 | ||
2036 | Additionally, a cross-compilation toolchain will usually install it's own | |
ab97e755 | 2037 | logical system root somewhere -- that is, it'll create a directory |
a95b3d6a KW |
2038 | somewhere which includes subdirectories like C<'include'> or C<'lib'>. For |
2039 | example, you may end up with F</skiff/local/arm-linux>, where | |
2040 | F</skiff/local/arm-linux/bin> holds the binaries for cross-compilation, | |
2041 | F</skiff/local/arm-linux/include> has the headers, and | |
2042 | F</skiff/local/arm-linux/lib> has the library files. | |
30bba555 BF |
2043 | If this is the case, and you are using a compiler that understands |
2044 | C<--sysroot>, like gcc or clang, you'll want to specify the | |
2045 | C<-Dsysroot> option for Configure: | |
2046 | ||
2047 | -Dsysroot=/skiff/local/arm-linux | |
2048 | ||
2049 | However, if your don't have a suitable directory to pass to C<-Dsysroot>, | |
2050 | you will also need to specify which target environment to use: | |
2051 | ||
58a21a9b JH |
2052 | -Dusrinc=/skiff/local/arm-linux/include |
2053 | -Dincpth=/skiff/local/arm-linux/include | |
2054 | -Dlibpth=/skiff/local/arm-linux/lib | |
2055 | ||
58a21a9b JH |
2056 | In addition to the default execution/transfer methods you can also |
2057 | choose B<rsh> for execution, and B<rcp> or B<cp> for transfer, | |
2058 | for example: | |
2059 | ||
2060 | -Dtargetrun=rsh -Dtargetto=rcp -Dtargetfrom=cp | |
2061 | ||
2062 | Putting it all together: | |
2063 | ||
2064 | sh ./Configure -des -Dusecrosscompile \ | |
93bc48fa | 2065 | -Dtargethost=so.me.ho.st \ |
30bba555 | 2066 | -Dtargetdir=/tar/get/dir \ |
58a21a9b JH |
2067 | -Dtargetuser=root \ |
2068 | -Dtargetarch=arm-linux \ | |
2069 | -Dcc=arm-linux-gcc \ | |
30bba555 | 2070 | -Dsysroot=/skiff/local/arm-linux \ |
58a21a9b JH |
2071 | -D... |
2072 | ||
e7a3c61b | 2073 | or if you are happy with the defaults: |
93bc48fa JH |
2074 | |
2075 | sh ./Configure -des -Dusecrosscompile \ | |
2076 | -Dtargethost=so.me.ho.st \ | |
2077 | -Dcc=arm-linux-gcc \ | |
2078 | -D... | |
2079 | ||
e7a3c61b JH |
2080 | Another example where the cross-compiler has been installed under |
2081 | F</usr/local/arm/2.95.5>: | |
2082 | ||
2083 | sh ./Configure -des -Dusecrosscompile \ | |
2084 | -Dtargethost=so.me.ho.st \ | |
2085 | -Dcc=/usr/local/arm/2.95.5/bin/arm-linux-gcc \ | |
30bba555 BF |
2086 | -Dsysroot=/usr/local/arm/2.95.5 |
2087 | ||
2088 | There is also a C<targetenv> option for Configure which can be used | |
2089 | to modify the environment of the target just before testing begins | |
2090 | during 'make test'. For example, if the target system has a nonstandard | |
2091 | /tmp location, you could do this: | |
2092 | ||
2093 | -Dtargetenv="export TMPDIR=/other/tmp;" | |
2094 | ||
ab97e755 MB |
2095 | If you are planning on cross-compiling to several platforms, or some |
2096 | other thing that would involve running Configure several times, there are | |
2097 | two options that can be used to speed things up considerably. | |
30bba555 BF |
2098 | As a bit of background, when you |
2099 | call Configure with C<-Dusecrosscompile>, it begins by actually partially | |
2100 | building a miniperl on the host machine, as well as the generate_uudmap | |
2101 | binary, and we end up using that during the build. | |
ab97e755 MB |
2102 | So instead of building that new perl every single time, you can build it |
2103 | just once in a separate directory, and then pass the resulting binaries | |
2104 | to Configure like this: | |
30bba555 BF |
2105 | |
2106 | -Dhostperl=/path/to/second/build/dir/miniperl | |
2107 | -Dhostgenerate=/path/to/second/build/dir/generate_uudmap | |
2108 | ||
2109 | Much less commonly, if you are cross-compiling from an ASCII host to an | |
2110 | EBCDIC target, or vise versa, you'll have to pass C<-Uhostgenerate> to | |
2111 | Configure, to signify that you want to build a generate_uudmap binary | |
2112 | that, during make, will be run on the target system. | |
e7a3c61b | 2113 | |
8e07c86e AD |
2114 | =head1 make test |
2115 | ||
d6baa268 JH |
2116 | This will run the regression tests on the perl you just made. If |
2117 | 'make test' doesn't say "All tests successful" then something went | |
36bded94 | 2118 | wrong. |
84902520 | 2119 | |
84902520 | 2120 | Note that you can't run the tests in background if this disables |
fb73857a | 2121 | opening of /dev/tty. You can use 'make test-notty' in that case but |
2122 | a few tty tests will be skipped. | |
c3edaffb | 2123 | |
c4f23d77 AD |
2124 | =head2 What if make test doesn't work? |
2125 | ||
1ec51d55 | 2126 | If make test bombs out, just cd to the t directory and run ./TEST |
36bded94 | 2127 | by hand to see if it makes any difference. |
8e07c86e | 2128 | |
36bded94 AD |
2129 | One way to get more detailed information about failed tests and |
2130 | individual subtests is to run the harness from the t directory: | |
aa689395 | 2131 | |
785aa5e3 | 2132 | cd t ; ./perl harness <list of tests> |
aa689395 | 2133 | |
fb73857a | 2134 | (this assumes that most basic tests succeed, since harness uses |
785aa5e3 RGS |
2135 | complicated constructs). If no list of tests is provided, harness |
2136 | will run all tests. | |
10c7e831 | 2137 | |
36bded94 AD |
2138 | If individual tests fail, you can often run them by hand (from the main |
2139 | perl directory), e.g., | |
2140 | ||
524a2f33 | 2141 | ./perl -I. -MTestInit t/op/groups.t |
36bded94 | 2142 | |
fb73857a | 2143 | You should also read the individual tests to see if there are any helpful |
10c7e831 JH |
2144 | comments that apply to your system. You may also need to setup your |
2145 | shared library path if you get errors like: | |
2146 | ||
2147 | /sbin/loader: Fatal Error: cannot map libperl.so | |
2148 | ||
36bded94 AD |
2149 | The file t/README in the t subdirectory contains more information about |
2150 | running and modifying tests. | |
2151 | ||
10c7e831 | 2152 | See L</"Building a shared Perl library"> earlier in this document. |
c3edaffb | 2153 | |
c4f23d77 AD |
2154 | =over 4 |
2155 | ||
2156 | =item locale | |
2157 | ||
1ec51d55 | 2158 | Note: One possible reason for errors is that some external programs |
c07a80fd | 2159 | may be broken due to the combination of your environment and the way |
785aa5e3 | 2160 | 'make test' exercises them. For example, this may happen if you have |
1ec51d55 CS |
2161 | one or more of these environment variables set: LC_ALL LC_CTYPE |
2162 | LC_COLLATE LANG. In some versions of UNIX, the non-English locales | |
e57fd563 | 2163 | are known to cause programs to exhibit mysterious errors. |
2164 | ||
2165 | If you have any of the above environment variables set, please try | |
aa689395 | 2166 | |
2167 | setenv LC_ALL C | |
2168 | ||
2169 | (for C shell) or | |
2170 | ||
2171 | LC_ALL=C;export LC_ALL | |
2172 | ||
1ec51d55 CS |
2173 | for Bourne or Korn shell) from the command line and then retry |
2174 | make test. If the tests then succeed, you may have a broken program that | |
aa689395 | 2175 | is confusing the testing. Please run the troublesome test by hand as |
e57fd563 | 2176 | shown above and see whether you can locate the program. Look for |
1ec51d55 CS |
2177 | things like: exec, `backquoted command`, system, open("|...") or |
2178 | open("...|"). All these mean that Perl is trying to run some | |
e57fd563 | 2179 | external program. |
eed2e782 | 2180 | |
0740bb5b AD |
2181 | =item Timing problems |
2182 | ||
c29923ff JH |
2183 | Several tests in the test suite check timing functions, such as |
2184 | sleep(), and see if they return in a reasonable amount of time. | |
9341413f JH |
2185 | If your system is quite busy and doesn't respond quickly enough, |
2186 | these tests might fail. If possible, try running the tests again | |
2187 | with the system under a lighter load. These timing-sensitive | |
2188 | and load-sensitive tests include F<t/op/alarm.t>, | |
d0b0e707 TH |
2189 | F<dist/Time-HiRes/t/alarm.t>, F<dist/Time-HiRes/t/clock.t>, |
2190 | F<dist/Time-HiRes/t/itimer.t>, F<dist/Time-HiRes/t/usleep.t>, | |
1543af16 | 2191 | F<dist/threads-shared/t/waithires.t>, |
c935ba53 | 2192 | F<dist/threads-shared/t/stress.t>, F<lib/Benchmark.t>, |
9341413f | 2193 | F<lib/Memoize/t/expmod_t.t>, and F<lib/Memoize/t/speed.t>. |
0740bb5b | 2194 | |
f89caa8d RGS |
2195 | You might also experience some failures in F<t/op/stat.t> if you build |
2196 | perl on an NFS filesystem, if the remote clock and the system clock are | |
2197 | different. | |
2198 | ||
c4f23d77 AD |
2199 | =item Out of memory |
2200 | ||
2201 | On some systems, particularly those with smaller amounts of RAM, some | |
2202 | of the tests in t/op/pat.t may fail with an "Out of memory" message. | |
7970f296 GS |
2203 | For example, on my SparcStation IPC with 12 MB of RAM, in perl5.5.670, |
2204 | test 85 will fail if run under either t/TEST or t/harness. | |
c4f23d77 AD |
2205 | |
2206 | Try stopping other jobs on the system and then running the test by itself: | |
2207 | ||
524a2f33 | 2208 | ./perl -I. -MTestInit t/op/pat.t |
c4f23d77 AD |
2209 | |
2210 | to see if you have any better luck. If your perl still fails this | |
2211 | test, it does not necessarily mean you have a broken perl. This test | |
2212 | tries to exercise the regular expression subsystem quite thoroughly, | |
2213 | and may well be far more demanding than your normal usage. | |
2214 | ||
a55bb48b AD |
2215 | =item libgcc_s.so.1: cannot open shared object file |
2216 | ||
2217 | This message has been reported on gcc-3.2.3 and earlier installed with | |
2218 | a non-standard prefix. Setting the LD_LIBRARY_PATH environment variable | |
2219 | (or equivalent) to include gcc's lib/ directory with the libgcc_s.so.1 | |
2220 | shared library should fix the problem. | |
2221 | ||
4f76e5ba AD |
2222 | =item Failures from lib/File/Temp/t/security saying "system possibly insecure" |
2223 | ||
2224 | First, such warnings are not necessarily serious or indicative of a | |
2225 | real security threat. That being said, they bear investigating. | |
2226 | ||
2227 | Note that each of the tests is run twice. The first time is in the | |
2228 | directory returned by File::Spec->tmpdir() (often /tmp on Unix | |
2229 | systems), and the second time in the directory from which the test was | |
2230 | run (usually the 't' directory, if the test was run as part of 'make | |
2231 | test'). | |
2232 | ||
2233 | The tests may fail for the following reasons: | |
2234 | ||
2235 | (1) If the directory the tests are being run in is owned by somebody | |
2236 | other than the user running the tests, or by root (uid 0). | |
2237 | ||
2238 | This failure can happen if the Perl source code distribution is | |
668cbedd | 2239 | unpacked in such a way that the user IDs in the distribution package |
4f76e5ba AD |
2240 | are used as-is. Some tar programs do this. |
2241 | ||
2242 | (2) If the directory the tests are being run in is writable by group or | |
2243 | by others, and there is no sticky bit set for the directory. (With | |
2244 | UNIX/POSIX semantics, write access to a directory means the right to | |
2245 | add or remove files in that directory. The 'sticky bit' is a feature | |
2246 | used in some UNIXes to give extra protection to files: if the bit is | |
2247 | set for a directory, no one but the owner (or root) can remove that | |
2248 | file even if the permissions would otherwise allow file removal by | |
2249 | others.) | |
2250 | ||
2251 | This failure may or may not be a real problem: it depends on the | |
2252 | permissions policy used on this particular system. This failure can | |
2253 | also happen if the system either doesn't support the sticky bit (this | |
2254 | is the case with many non-UNIX platforms: in principle File::Temp | |
2255 | should know about these platforms and skip the tests), or if the system | |
2256 | supports the sticky bit but for some reason or reasons it is not being | |
2257 | used. This is, for example, the case with HP-UX: as of HP-UX release | |
2258 | 11.00, the sticky bit is very much supported, but HP-UX doesn't use it | |
2259 | on its /tmp directory as shipped. Also, as with the permissions, some | |
2260 | local policy might dictate that the stickiness is not used. | |
781948c1 | 2261 | |
b2b23189 JH |
2262 | (3) If the system supports the POSIX 'chown giveaway' feature and if |
2263 | any of the parent directories of the temporary file back to the root | |
2264 | directory are 'unsafe', using the definitions given above in (1) and | |
4f76e5ba AD |
2265 | (2). For Unix systems, this is usually not an issue if you are |
2266 | building on a local disk. See the documentation for the File::Temp | |
2267 | module for more information about 'chown giveaway'. | |
781948c1 JH |
2268 | |
2269 | See the documentation for the File::Temp module for more information | |
4f76e5ba | 2270 | about the various security aspects of temporary files. |
781948c1 | 2271 | |
c4f23d77 AD |
2272 | =back |
2273 | ||
5ee651a9 | 2274 | The core distribution can now run its regression tests in parallel on |
ab97e755 MB |
2275 | Unix-like platforms. Instead of running C<make test>, set C<TEST_JOBS> |
2276 | in your environment to the number of tests to run in parallel, and run | |
5ee651a9 NC |
2277 | C<make test_harness>. On a Bourne-like shell, this can be done as |
2278 | ||
2279 | TEST_JOBS=3 make test_harness # Run 3 tests in parallel | |
2280 | ||
ab97e755 MB |
2281 | An environment variable is used, rather than parallel make itself, |
2282 | because L<TAP::Harness> needs to be able to schedule individual | |
2283 | non-conflicting test scripts itself, and there is no standard interface | |
2284 | to C<make> utilities to interact with their job schedulers. | |
5ee651a9 | 2285 | |
8e07c86e AD |
2286 | =head1 make install |
2287 | ||
2288 | This will put perl into the public directory you specified to | |
ab97e755 MB |
2289 | Configure; by default this is /usr/local/bin. It will also try to put |
2290 | the man pages in a reasonable place. It will not nroff the man pages, | |
2291 | however. You may need to be root to run B<make install>. If you are not | |
2292 | root, you must still have permission to install into the directories | |
ce80d64e AD |
2293 | in question and you should ignore any messages about chown not working. |
2294 | ||
19f4563d | 2295 | If "make install" just says "'install' is up to date" or something |
ce80d64e AD |
2296 | similar, you may be on a case-insensitive filesystems such as Mac's HFS+, |
2297 | and you should say "make install-all". (This confusion is brought to you | |
2298 | by the Perl distribution having a file called INSTALL.) | |
8e07c86e | 2299 | |
dd64f1c3 AD |
2300 | =head2 Installing perl under different names |
2301 | ||
2302 | If you want to install perl under a name other than "perl" (for example, | |
2303 | when installing perl with special features enabled, such as debugging), | |
2304 | indicate the alternate name on the "make install" line, such as: | |
2305 | ||
2306 | make install PERLNAME=myperl | |
2307 | ||
beb13193 | 2308 | You can separately change the base used for versioned names (like |
be8498a1 | 2309 | "perl5.8.9") by setting PERLNAME_VERBASE, like |
beb13193 RS |
2310 | |
2311 | make install PERLNAME=perl5 PERLNAME_VERBASE=perl | |
2312 | ||
ab97e755 MB |
2313 | This can be useful if you have to install perl as "perl5" (e.g. to avoid |
2314 | conflicts with an ancient version in /usr/bin supplied by your vendor). | |
be8498a1 | 2315 | Without this the versioned binary would be called "perl55.8.8". |
beb13193 | 2316 | |
ce80d64e AD |
2317 | =head2 Installing perl under a different directory |
2318 | ||
2319 | You can install perl under a different destination directory by using | |
2320 | the DESTDIR variable during C<make install>, with a command like | |
2321 | ||
2322 | make install DESTDIR=/tmp/perl5 | |
2323 | ||
2324 | DESTDIR is automatically prepended to all the installation paths. See | |
7df75831 | 2325 | the example in L<"DESTDIR"> above. |
ce80d64e | 2326 | |
dd64f1c3 AD |
2327 | =head2 Installed files |
2328 | ||
8e07c86e AD |
2329 | If you want to see exactly what will happen without installing |
2330 | anything, you can run | |
4633a7c4 | 2331 | |
8e07c86e AD |
2332 | ./perl installperl -n |
2333 | ./perl installman -n | |
2334 | ||
1ec51d55 | 2335 | make install will install the following: |
8e07c86e | 2336 | |
d56c5707 JH |
2337 | binaries |
2338 | ||
8e07c86e | 2339 | perl, |
be8498a1 | 2340 | perl5.n.n where 5.n.n is the current release number. This |
8e07c86e | 2341 | will be a link to perl. |
d56c5707 JH |
2342 | |
2343 | scripts | |
2344 | ||
979b4168 KW |
2345 | cppstdin This is used by the deprecated switch perl -P, |
2346 | if your cc -E can't read from stdin. | |
979b4168 KW |
2347 | corelist Shows versions of modules that come with |
2348 | different | |
668cbedd KW |
2349 | versions of perl. |
2350 | cpan The CPAN shell. | |
668cbedd | 2351 | enc2xs Encoding module generator. |
979b4168 KW |
2352 | h2ph Extract constants and simple macros from C |
2353 | headers. | |
8e07c86e | 2354 | h2xs Converts C .h header files to Perl extensions. |
73d6d1b0 RGS |
2355 | instmodsh A shell to examine installed modules. |
2356 | libnetcfg Configure libnet. | |
24b3df7f | 2357 | perlbug Tool to report bugs in Perl. |
8e07c86e | 2358 | perldoc Tool to read perl's pod documentation. |
668cbedd | 2359 | perlivp Perl Installation Verification Procedure. |
73d6d1b0 | 2360 | piconv A Perl implementation of the encoding conversion |
668cbedd KW |
2361 | utility iconv. |
2362 | pl2pm Convert Perl 4 .pl files to Perl 5 .pm modules. | |
8e07c86e | 2363 | pod2html, Converters from perl's pod documentation format |
d56c5707 JH |
2364 | pod2man, |
2365 | pod2text, | |
d56c5707 | 2366 | pod2usage |
668cbedd KW |
2367 | podchecker POD syntax checker. |
2368 | podselect Prints sections of POD documentation. | |
2369 | prove A command-line tool for running tests. | |
2370 | psed A Perl implementation of sed. | |
2371 | ptar A Perl implementation of tar. | |
2372 | ptardiff A diff for tar archives. | |
2373 | ptargrep A grep for tar archives. | |
668cbedd KW |
2374 | shasum A tool to print or check SHA checksums. |
2375 | splain Describe Perl warnings and errors. | |
2376 | xsubpp Compiler to convert Perl XS code into C code. | |
979b4168 | 2377 | zipdetails display the internal structure of zip files |
8e07c86e | 2378 | |
d56c5707 JH |
2379 | library files |
2380 | ||
2381 | in $privlib and $archlib specified to | |
8e07c86e | 2382 | Configure, usually under /usr/local/lib/perl5/. |
d56c5707 JH |
2383 | |
2384 | documentation | |
2385 | ||
d6baa268 JH |
2386 | man pages in $man1dir, usually /usr/local/man/man1. |
2387 | module man | |
2388 | pages in $man3dir, usually /usr/local/man/man3. | |
8e07c86e AD |
2389 | pod/*.pod in $privlib/pod/. |
2390 | ||
33cceb07 | 2391 | installperl will also create the directories listed above |
d6baa268 | 2392 | in L<"Installation Directories">. |
4633a7c4 | 2393 | |
d56c5707 | 2394 | Perl's *.h header files and the libperl library are also installed |
d6baa268 | 2395 | under $archlib so that any user may later build new modules, run the |
56c6f531 JH |
2396 | optional Perl compiler, or embed the perl interpreter into another |
2397 | program even if the Perl source is no longer available. | |
8e07c86e | 2398 | |
6baaafe3 | 2399 | =head2 Installing with a version-specific suffix |
33cceb07 | 2400 | |
6baaafe3 DC |
2401 | Sometimes you only want to install the perl distribution with a |
2402 | version-specific suffix. For example, you may wish to install a newer | |
2403 | version of perl alongside an already installed production version. | |
d56c5707 JH |
2404 | To only install the version-specific parts of the perl installation, run |
2405 | ||
2406 | Configure -Dversiononly | |
2407 | ||
2408 | or answer 'y' to the appropriate Configure prompt. Alternatively, | |
2409 | you can just manually run | |
2410 | ||
2411 | ./perl installperl -v | |
2412 | ||
2413 | and skip installman altogether. | |
33cceb07 | 2414 | |
d56c5707 JH |
2415 | See also L<"Maintaining completely separate versions"> for another |
2416 | approach. | |
2417 | ||
f4ce0e6d RGS |
2418 | =head1 cd /usr/include; h2ph *.h sys/*.h |
2419 | ||
2420 | Some perl scripts need to be able to obtain information from the | |
2421 | system header files. This command will convert the most commonly used | |
2422 | header files in /usr/include into files that can be easily interpreted | |
2423 | by perl. These files will be placed in the architecture-dependent | |
2424 | library ($archlib) directory you specified to Configure. | |
2425 | ||
668cbedd | 2426 | Note: Due to differences in the C and perl languages, the conversion |
f4ce0e6d RGS |
2427 | of the header files is not perfect. You will probably have to |
2428 | hand-edit some of the converted files to get them to parse correctly. | |
2429 | For example, h2ph breaks spectacularly on type casting and certain | |
2430 | structures. | |
2431 | ||
2432 | =head1 installhtml --help | |
2433 | ||
2434 | Some sites may wish to make perl documentation available in HTML | |
2435 | format. The installhtml utility can be used to convert pod | |
2436 | documentation into linked HTML files and install them. | |
2437 | ||
2438 | Currently, the supplied ./installhtml script does not make use of the | |
2439 | html Configure variables. This should be fixed in a future release. | |
2440 | ||
2441 | The following command-line is an example of one used to convert | |
2442 | perl documentation: | |
2443 | ||
2444 | ./installhtml \ | |
2445 | --podroot=. \ | |
2446 | --podpath=lib:ext:pod:vms \ | |
2447 | --recurse \ | |
2448 | --htmldir=/perl/nmanual \ | |
2449 | --htmlroot=/perl/nmanual \ | |
2450 | --splithead=pod/perlipc \ | |
2451 | --splititem=pod/perlfunc \ | |
f4ce0e6d RGS |
2452 | --verbose |
2453 | ||
2454 | See the documentation in installhtml for more details. It can take | |
2455 | many minutes to execute a large installation and you should expect to | |
2456 | see warnings like "no title", "unexpected directive" and "cannot | |
2457 | resolve" as the files are processed. We are aware of these problems | |
2458 | (and would welcome patches for them). | |
2459 | ||
2460 | You may find it helpful to run installhtml twice. That should reduce | |
2461 | the number of "cannot resolve" warnings. | |
2462 | ||
2463 | =head1 cd pod && make tex && (process the latex files) | |
2464 | ||
2465 | Some sites may also wish to make the documentation in the pod/ directory | |
2466 | available in TeX format. Type | |
2467 | ||
2468 | (cd pod && make tex && <process the latex files>) | |
2469 | ||
2470 | =head1 Starting all over again | |
2471 | ||
668cbedd | 2472 | If you wish to rebuild perl from the same build directory, you should |
f4ce0e6d RGS |
2473 | clean it out with the command |
2474 | ||
2475 | make distclean | |
2476 | ||
2477 | or | |
2478 | ||
2479 | make realclean | |
2480 | ||
2481 | The only difference between the two is that make distclean also removes | |
dd8235d9 | 2482 | your old config.sh and Policy.sh files. (A plain 'make clean' is now |
54f6f377 | 2483 | equivalent to 'make realclean'.) |
f4ce0e6d RGS |
2484 | |
2485 | If you are upgrading from a previous version of perl, or if you | |
2486 | change systems or compilers or make other significant changes, or if | |
668cbedd | 2487 | you are experiencing difficulties building perl, you should not reuse |
f4ce0e6d RGS |
2488 | your old config.sh. |
2489 | ||
2490 | If your reason to reuse your old config.sh is to save your particular | |
2491 | installation choices, then you can probably achieve the same effect by | |
2492 | using the Policy.sh file. See the section on L<"Site-wide Policy | |
2493 | settings"> above. | |
2494 | ||
ff52061e RGS |
2495 | =head1 Reporting Problems |
2496 | ||
8166b4e0 DB |
2497 | Please report problems to the GitHub issue tracker at |
2498 | https://github.com/Perl/perl5/issues, which will ask for the | |
2499 | appropriate summary configuration information about your perl, which | |
2500 | may help us track down problems far more quickly. But first you should | |
2501 | read the advice in this file, carefully re-read the error message and | |
2502 | check the relevant manual pages on your system, as these may help you | |
2503 | find an immediate solution. Once you've exhausted the documentation, | |
2504 | please report bugs to us using the GitHub tracker. | |
2505 | ||
2506 | The summary configuration information can be printed with C<perl -V>. | |
2507 | If the install fails, or you want to report problems with C<make test> | |
2508 | without installing perl, then you can run it by hand from this source | |
2509 | directory with C<./perl -V>. | |
2510 | ||
2511 | If the build fails too early to run perl, then please | |
2512 | B<run> the C<./myconfig> shell script, and include its output along | |
2513 | with an accurate description of your problem. | |
ff52061e RGS |
2514 | |
2515 | If Configure itself fails, and does not generate a config.sh file | |
8166b4e0 | 2516 | (needed to run C<./myconfig>), then please open an issue with the |
ff52061e | 2517 | description of how Configure fails along with details of your system |
8166b4e0 | 2518 | -- for example the output from running C<uname -a>. |
ff52061e RGS |
2519 | |
2520 | Please try to make your message brief but clear. Brief, clear bug | |
2521 | reports tend to get answered more quickly. Please don't worry if your | |
668cbedd | 2522 | written English is not great -- what matters is how well you describe |
ff52061e RGS |
2523 | the important technical details of the problem you have encountered, |
2524 | not whether your grammar and spelling is flawless. | |
2525 | ||
2526 | Trim out unnecessary information. Do not include large files (such as | |
2527 | config.sh or a complete Configure or make log) unless absolutely | |
2528 | necessary. Do not include a complete transcript of your build | |
2529 | session. Just include the failing commands, the relevant error | |
2530 | messages, and whatever preceding commands are necessary to give the | |
8166b4e0 | 2531 | appropriate context. |
ff52061e | 2532 | |
87c118b9 | 2533 | If the bug you are reporting has security implications which make it |
8166b4e0 | 2534 | inappropriate to send to a public issue tracker, then see |
87c118b9 DM |
2535 | L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION> |
2536 | for details of how to report the issue. | |
5acb7768 | 2537 | |
ff52061e RGS |
2538 | If you are unsure what makes a good bug report please read "How to |
2539 | report Bugs Effectively" by Simon Tatham: | |
f6521f7c | 2540 | L<https://www.chiark.greenend.org.uk/~sgtatham/bugs.html> |
ff52061e | 2541 | |
7df75831 | 2542 | =head1 Coexistence with earlier versions of perl 5 |
4633a7c4 | 2543 | |
1b2f5479 | 2544 | Perl 5.37.7 is not binary compatible with earlier versions of Perl. |
cc65bb49 | 2545 | In other words, you will have to recompile your XS modules. |
14eee2f1 | 2546 | |
725c980e SH |
2547 | In general, you can usually safely upgrade from one stable version of Perl |
2548 | (e.g. 5.30.0) to another similar minor version (e.g. 5.30.1) without | |
33cceb07 | 2549 | re-compiling all of your extensions. You can also safely leave the old |
ab97e755 MB |
2550 | version around in case the new version causes you problems for some |
2551 | reason. | |
693762b4 | 2552 | |
be8498a1 RGS |
2553 | Usually, most extensions will probably not need to be recompiled to be |
2554 | used with a newer version of Perl. Here is how it is supposed to work. | |
ce80d64e | 2555 | (These examples assume you accept all the Configure defaults.) |
693762b4 | 2556 | |
33cceb07 RGS |
2557 | Suppose you already have version 5.8.7 installed. The directories |
2558 | searched by 5.8.7 are typically like: | |
d6baa268 | 2559 | |
33cceb07 RGS |
2560 | /usr/local/lib/perl5/5.8.7/$archname |
2561 | /usr/local/lib/perl5/5.8.7 | |
2562 | /usr/local/lib/perl5/site_perl/5.8.7/$archname | |
2563 | /usr/local/lib/perl5/site_perl/5.8.7 | |
d6baa268 | 2564 | |
33cceb07 RGS |
2565 | Now, suppose you install version 5.8.8. The directories |
2566 | searched by version 5.8.8 will be: | |
d6baa268 | 2567 | |
33cceb07 RGS |
2568 | /usr/local/lib/perl5/5.8.8/$archname |
2569 | /usr/local/lib/perl5/5.8.8 | |
2570 | /usr/local/lib/perl5/site_perl/5.8.8/$archname | |
2571 | /usr/local/lib/perl5/site_perl/5.8.8 | |
d6baa268 | 2572 | |
33cceb07 RGS |
2573 | /usr/local/lib/perl5/site_perl/5.8.7/$archname |
2574 | /usr/local/lib/perl5/site_perl/5.8.7 | |
c42e3e15 | 2575 | /usr/local/lib/perl5/site_perl/ |
bfb7748a | 2576 | |
c42e3e15 | 2577 | Notice the last three entries -- Perl understands the default structure |
d6baa268 | 2578 | of the $sitelib directories and will look back in older, compatible |
33cceb07 RGS |
2579 | directories. This way, modules installed under 5.8.7 will continue |
2580 | to be usable by 5.8.7 but will also accessible to 5.8.8. Further, | |
d6baa268 | 2581 | suppose that you upgrade a module to one which requires features |
33cceb07 RGS |
2582 | present only in 5.8.8. That new module will get installed into |
2583 | /usr/local/lib/perl5/site_perl/5.8.8 and will be available to 5.8.8, | |
2584 | but will not interfere with the 5.8.7 version. | |
bfb7748a | 2585 | |
c42e3e15 | 2586 | The last entry, /usr/local/lib/perl5/site_perl/, is there so that |
fe23a901 | 2587 | 5.6.0 and above will look for 5.004-era pure perl modules. |
d6baa268 | 2588 | |
33cceb07 RGS |
2589 | Lastly, suppose you now install 5.10.0, which is not binary compatible |
2590 | with 5.8.x. The directories searched by 5.10.0 (if you don't change the | |
fe23a901 RF |
2591 | Configure defaults) will be: |
2592 | ||
33cceb07 RGS |
2593 | /usr/local/lib/perl5/5.10.0/$archname |
2594 | /usr/local/lib/perl5/5.10.0 | |
2595 | /usr/local/lib/perl5/site_perl/5.10.0/$archname | |
2596 | /usr/local/lib/perl5/site_perl/5.10.0 | |
d6baa268 | 2597 | |
33cceb07 | 2598 | /usr/local/lib/perl5/site_perl/5.8.8 |
d6baa268 | 2599 | |
33cceb07 | 2600 | /usr/local/lib/perl5/site_perl/5.8.7 |
fe23a901 | 2601 | |
d6baa268 | 2602 | /usr/local/lib/perl5/site_perl/ |
bfb7748a | 2603 | |
cc65bb49 AD |
2604 | Note that the earlier $archname entries are now gone, but pure perl |
2605 | modules from earlier versions will still be found. | |
2606 | ||
0a08c020 GS |
2607 | This way, you can choose to share compatible extensions, but also upgrade |
2608 | to a newer version of an extension that may be incompatible with earlier | |
2609 | versions, without breaking the earlier versions' installations. | |
693762b4 AD |
2610 | |
2611 | =head2 Maintaining completely separate versions | |
4633a7c4 | 2612 | |
1ec51d55 | 2613 | Many users prefer to keep all versions of perl in completely |
d6baa268 | 2614 | separate directories. This guarantees that an update to one version |
0a08c020 GS |
2615 | won't interfere with another version. (The defaults guarantee this for |
2616 | libraries after 5.6.0, but not for executables. TODO?) One convenient | |
2617 | way to do this is by using a separate prefix for each version, such as | |
d52d4e46 | 2618 | |
1b2f5479 | 2619 | sh Configure -Dprefix=/opt/perl5.37.7 |
d52d4e46 | 2620 | |
1b2f5479 | 2621 | and adding /opt/perl5.37.7/bin to the shell PATH variable. Such users |
d52d4e46 | 2622 | may also wish to add a symbolic link /usr/local/bin/perl so that |
2623 | scripts can still start with #!/usr/local/bin/perl. | |
2624 | ||
693762b4 | 2625 | Others might share a common directory for maintenance sub-versions |
33cceb07 | 2626 | (e.g. 5.10 for all 5.10.x versions), but change directory with |
693762b4 AD |
2627 | each major version. |
2628 | ||
6877a1cf AD |
2629 | If you are installing a development subversion, you probably ought to |
2630 | seriously consider using a separate directory, since development | |
2631 | subversions may not have all the compatibility wrinkles ironed out | |
2632 | yet. | |
2633 | ||
53462700 | 2634 | =head2 Upgrading from 5.37.3 or earlier |
693762b4 | 2635 | |
1b2f5479 | 2636 | B<Perl 5.37.7 may not be binary compatible with Perl 5.37.3 or |
4683a5d7 | 2637 | earlier Perl releases.> Perl modules having binary parts |
e655887d | 2638 | (meaning that a C compiler is used) will have to be recompiled to be |
1b2f5479 MM |
2639 | used with 5.37.7. If you find you do need to rebuild an extension with |
2640 | 5.37.7, you may safely do so without disturbing the older | |
7df75831 | 2641 | installations. (See L<"Coexistence with earlier versions of perl 5"> |
e655887d | 2642 | above.) |
c42e3e15 GS |
2643 | |
2644 | See your installed copy of the perllocal.pod file for a (possibly | |
2645 | incomplete) list of locally installed modules. Note that you want | |
cc65bb49 | 2646 | perllocal.pod, not perllocale.pod, for installed module information. |
693762b4 | 2647 | |
8ebf57cf JH |
2648 | =head1 Minimizing the Perl installation |
2649 | ||
2650 | The following section is meant for people worrying about squeezing the | |
2651 | Perl installation into minimal systems (for example when installing | |
2652 | operating systems, or in really small filesystems). | |
2653 | ||
c8214fdf | 2654 | Leaving out as many extensions as possible is an obvious way: |
5cda700b AD |
2655 | Encode, with its big conversion tables, consumes a lot of |
2656 | space. On the other hand, you cannot throw away everything. The | |
2657 | Fcntl module is pretty essential. If you need to do network | |
c8214fdf JH |
2658 | programming, you'll appreciate the Socket module, and so forth: it all |
2659 | depends on what do you need to do. | |
2660 | ||
8ebf57cf JH |
2661 | In the following we offer two different slimmed down installation |
2662 | recipes. They are informative, not normative: the choice of files | |
2663 | depends on what you need. | |
2664 | ||
2665 | Firstly, the bare minimum to run this script | |
2666 | ||
2667 | use strict; | |
2668 | use warnings; | |
2669 | foreach my $f (</*>) { | |
2670 | print("$f\n"); | |
2671 | } | |
2672 | ||
1b2f5479 | 2673 | in Linux with perl-5.37.7 is as follows (under $Config{prefix}): |
8ebf57cf JH |
2674 | |
2675 | ./bin/perl | |
1b2f5479 MM |
2676 | ./lib/perl5/5.37.7/strict.pm |
2677 | ./lib/perl5/5.37.7/warnings.pm | |
2678 | ./lib/perl5/5.37.7/i686-linux/File/Glob.pm | |
2679 | ./lib/perl5/5.37.7/feature.pm | |
2680 | ./lib/perl5/5.37.7/XSLoader.pm | |
2681 | ./lib/perl5/5.37.7/i686-linux/auto/File/Glob/Glob.so | |
8ebf57cf | 2682 | |
ab97e755 MB |
2683 | Secondly, for perl-5.10.1, the Debian perl-base package contains 591 |
2684 | files, (of which 510 are for lib/unicore) totaling about 3.5MB in its | |
2685 | i386 version. Omitting the lib/unicore/* files for brevity, the | |
2686 | remaining files are: | |
8ebf57cf | 2687 | |
bfe08c74 | 2688 | /usr/bin/perl |
00930d57 AD |
2689 | /usr/bin/perl5.10.1 |
2690 | /usr/lib/perl/5.10.1/Config.pm | |
2691 | /usr/lib/perl/5.10.1/Config_git.pl | |
2692 | /usr/lib/perl/5.10.1/Config_heavy.pl | |
2693 | /usr/lib/perl/5.10.1/Cwd.pm | |
2694 | /usr/lib/perl/5.10.1/DynaLoader.pm | |
2695 | /usr/lib/perl/5.10.1/Errno.pm | |
2696 | /usr/lib/perl/5.10.1/Fcntl.pm | |
2697 | /usr/lib/perl/5.10.1/File/Glob.pm | |
2698 | /usr/lib/perl/5.10.1/Hash/Util.pm | |
2699 | /usr/lib/perl/5.10.1/IO.pm | |
2700 | /usr/lib/perl/5.10.1/IO/File.pm | |
2701 | /usr/lib/perl/5.10.1/IO/Handle.pm | |
2702 | /usr/lib/perl/5.10.1/IO/Pipe.pm | |
2703 | /usr/lib/perl/5.10.1/IO/Seekable.pm | |
2704 | /usr/lib/perl/5.10.1/IO/Select.pm | |
2705 | /usr/lib/perl/5.10.1/IO/Socket.pm | |
2706 | /usr/lib/perl/5.10.1/IO/Socket/INET.pm | |
2707 | /usr/lib/perl/5.10.1/IO/Socket/UNIX.pm | |
2708 | /usr/lib/perl/5.10.1/List/Util.pm | |
2709 | /usr/lib/perl/5.10.1/POSIX.pm | |
2710 | /usr/lib/perl/5.10.1/Scalar/Util.pm | |
2711 | /usr/lib/perl/5.10.1/Socket.pm | |
2712 | /usr/lib/perl/5.10.1/XSLoader.pm | |
2713 | /usr/lib/perl/5.10.1/auto/Cwd/Cwd.so | |
2714 | /usr/lib/perl/5.10.1/auto/DynaLoader/autosplit.ix | |
2715 | /usr/lib/perl/5.10.1/auto/DynaLoader/dl_expandspec.al | |
2716 | /usr/lib/perl/5.10.1/auto/DynaLoader/dl_find_symbol_anywhere.al | |
2717 | /usr/lib/perl/5.10.1/auto/DynaLoader/dl_findfile.al | |
2718 | /usr/lib/perl/5.10.1/auto/Fcntl/Fcntl.so | |
2719 | /usr/lib/perl/5.10.1/auto/File/Glob/Glob.so | |
2720 | /usr/lib/perl/5.10.1/auto/Hash/Util/Util.so | |
2721 | /usr/lib/perl/5.10.1/auto/IO/IO.so | |
2722 | /usr/lib/perl/5.10.1/auto/List/Util/Util.so | |
2723 | /usr/lib/perl/5.10.1/auto/POSIX/POSIX.so | |
2724 | /usr/lib/perl/5.10.1/auto/POSIX/autosplit.ix | |
2725 | /usr/lib/perl/5.10.1/auto/POSIX/load_imports.al | |
2726 | /usr/lib/perl/5.10.1/auto/Socket/Socket.so | |
2727 | /usr/lib/perl/5.10.1/lib.pm | |
2728 | /usr/lib/perl/5.10.1/re.pm | |
8ebf57cf | 2729 | /usr/share/doc/perl/AUTHORS.gz |
bfe08c74 | 2730 | /usr/share/doc/perl/Documentation |
00930d57 | 2731 | /usr/share/doc/perl/README.Debian |
8ebf57cf | 2732 | /usr/share/doc/perl/changelog.Debian.gz |
bfe08c74 | 2733 | /usr/share/doc/perl/copyright |
00930d57 | 2734 | /usr/share/lintian/overrides/perl-base |
8ebf57cf | 2735 | /usr/share/man/man1/perl.1.gz |
00930d57 AD |
2736 | /usr/share/man/man1/perl5.10.1.1.gz |
2737 | /usr/share/perl/5.10.1/AutoLoader.pm | |
2738 | /usr/share/perl/5.10.1/Carp.pm | |
2739 | /usr/share/perl/5.10.1/Carp/Heavy.pm | |
2740 | /usr/share/perl/5.10.1/Exporter.pm | |
2741 | /usr/share/perl/5.10.1/Exporter/Heavy.pm | |
2742 | /usr/share/perl/5.10.1/File/Spec.pm | |
2743 | /usr/share/perl/5.10.1/File/Spec/Unix.pm | |
2744 | /usr/share/perl/5.10.1/FileHandle.pm | |
2745 | /usr/share/perl/5.10.1/Getopt/Long.pm | |
2746 | /usr/share/perl/5.10.1/IPC/Open2.pm | |
2747 | /usr/share/perl/5.10.1/IPC/Open3.pm | |
2748 | /usr/share/perl/5.10.1/SelectSaver.pm | |
2749 | /usr/share/perl/5.10.1/Symbol.pm | |
2750 | /usr/share/perl/5.10.1/Text/ParseWords.pm | |
2751 | /usr/share/perl/5.10.1/Text/Tabs.pm | |
2752 | /usr/share/perl/5.10.1/Text/Wrap.pm | |
2753 | /usr/share/perl/5.10.1/Tie/Hash.pm | |
2754 | /usr/share/perl/5.10.1/attributes.pm | |
2755 | /usr/share/perl/5.10.1/base.pm | |
2756 | /usr/share/perl/5.10.1/bytes.pm | |
2757 | /usr/share/perl/5.10.1/bytes_heavy.pl | |
2758 | /usr/share/perl/5.10.1/constant.pm | |
2759 | /usr/share/perl/5.10.1/fields.pm | |
2760 | /usr/share/perl/5.10.1/integer.pm | |
2761 | /usr/share/perl/5.10.1/locale.pm | |
2762 | /usr/share/perl/5.10.1/overload.pm | |
2763 | /usr/share/perl/5.10.1/strict.pm | |
2764 | /usr/share/perl/5.10.1/unicore/* | |
2765 | /usr/share/perl/5.10.1/utf8.pm | |
2766 | /usr/share/perl/5.10.1/utf8_heavy.pl | |
2767 | /usr/share/perl/5.10.1/vars.pm | |
2768 | /usr/share/perl/5.10.1/warnings.pm | |
2769 | /usr/share/perl/5.10.1/warnings/register.pm | |
8ebf57cf | 2770 | |
e7a3c61b JH |
2771 | A nice trick to find out the minimal set of Perl library files you will |
2772 | need to run a Perl program is | |
2773 | ||
a0a8d9d3 | 2774 | perl -e 'do "prog.pl"; END { print "$_\n" for sort keys %INC }' |
e7a3c61b JH |
2775 | |
2776 | (this will not find libraries required in runtime, unfortunately, but | |
2777 | it's a minimal set) and if you want to find out all the files you can | |
2778 | use something like the below | |
2779 | ||
979b4168 KW |
2780 | strace perl -le 'do "x.pl"' 2>&1 \ |
2781 | | perl -nle '/^open\(\"(.+?)"/ && print $1' | |
e7a3c61b JH |
2782 | |
2783 | (The 'strace' is Linux-specific, other similar utilities include 'truss' | |
2784 | and 'ktrace'.) | |
2785 | ||
c19ccd8c RGS |
2786 | =head2 C<-DNO_MATHOMS> |
2787 | ||
2788 | If you configure perl with C<-Accflags=-DNO_MATHOMS>, the functions from | |
2789 | F<mathoms.c> will not be compiled in. Those functions are no longer used | |
2790 | by perl itself; for source compatibility reasons, though, they weren't | |
2791 | completely removed. | |
2792 | ||
d6295071 TC |
2793 | =head2 C<-DNO_PERL_INTERNAL_RAND_SEED> |
2794 | X<PERL_INTERNAL_RAND_SEED> | |
2795 | ||
2796 | If you configure perl with C<-Accflags=-DNO_PERL_INTERNAL_RAND_SEED>, | |
ab473f03 | 2797 | perl will ignore the C<PERL_INTERNAL_RAND_SEED> environment variable. |
d6295071 | 2798 | |
bf2a3dae YO |
2799 | =head2 C<-DNO_PERL_RAND_SEED> |
2800 | X<PERL_RAND_SEED> | |
2801 | ||
2802 | If you configure perl with C<-Accflags=-DNO_PERL_RAND_SEED>, | |
2803 | perl will ignore the C<PERL_RAND_SEED> environment variable. | |
2804 | ||
8e07c86e AD |
2805 | =head1 DOCUMENTATION |
2806 | ||
bfb7748a | 2807 | Read the manual entries before running perl. The main documentation |
b0a63d58 | 2808 | is in the F<pod/> subdirectory and should have been installed during the |
8e07c86e | 2809 | build process. Type B<man perl> to get started. Alternatively, you |
bfb7748a AD |
2810 | can type B<perldoc perl> to use the supplied perldoc script. This is |
2811 | sometimes useful for finding things in the library modules. | |
8e07c86e AD |
2812 | |
2813 | =head1 AUTHOR | |
2814 | ||
bfb7748a AD |
2815 | Original author: Andy Dougherty doughera@lafayette.edu , borrowing very |
2816 | heavily from the original README by Larry Wall, with lots of helpful | |
2817 | feedback and additions from the perl5-porters@perl.org folks. | |
fb73857a | 2818 | |
f5b3b617 AD |
2819 | If you have problems, corrections, or questions, please see |
2820 | L<"Reporting Problems"> above. | |
2821 | ||
2822 | =head1 REDISTRIBUTION | |
2823 | ||
2824 | This document is part of the Perl package and may be distributed under | |
d6baa268 | 2825 | the same terms as perl itself, with the following additional request: |
f5b3b617 | 2826 | If you are distributing a modified version of perl (perhaps as part of |
d6baa268 | 2827 | a larger package) please B<do> modify these installation instructions |
ba673321 DH |
2828 | and the contact information to match your distribution. Additional |
2829 | information for packagers is in F<PACKAGING>. |