| 1 | If you read this file _as_is_, just ignore the funny characters you see. |
| 2 | It is written in the POD format (see pod/perlpod.pod) which is specially |
| 3 | designed to be readable as is. |
| 4 | |
| 5 | =head1 NAME |
| 6 | |
| 7 | Install - Build and Installation guide for perl5. |
| 8 | |
| 9 | =head1 Reporting Problems |
| 10 | |
| 11 | Wherever possible please use the perlbug tool supplied with this Perl |
| 12 | to report problems, as it automatically includes summary configuration |
| 13 | information about your perl, which may help us track down problems far |
| 14 | more quickly. But first you should read the advice in this file, |
| 15 | carefully re-read the error message and check the relevant manual pages |
| 16 | on your system, as these may help you find an immediate solution. If |
| 17 | you are not sure whether what you are seeing is a bug, you can send a |
| 18 | message describing the problem to the comp.lang.perl.misc newsgroup to |
| 19 | get advice. |
| 20 | |
| 21 | The perlbug tool is installed along with perl, so after you have |
| 22 | completed C<make install> it should be possible to run it with plain |
| 23 | C<perlbug>. If the install fails, or you want to report problems with |
| 24 | C<make test> without installing perl, then you can use C<make nok> to |
| 25 | run perlbug to report the problem, or run it by hand from this source |
| 26 | directory with C<./perl -Ilib utils/perlbug> |
| 27 | |
| 28 | If the build fails too early to run perlbug uninstalled, then please |
| 29 | B<run> the C<./myconfig> shell script, and mail its output along with |
| 30 | an accurate description of your problem to perlbug@perl.org |
| 31 | |
| 32 | If Configure itself fails, and does not generate a config.sh file |
| 33 | (needed to run C<./myconfig>), then please mail perlbug@perl.org the |
| 34 | description of how Configure fails along with details of your system |
| 35 | - for example the output from running C<uname -a> |
| 36 | |
| 37 | Please try to make your message brief but clear. Brief, clear bug |
| 38 | reports tend to get answered more quickly. Please don't worry if your |
| 39 | written English is not great - what matters is how well you describe |
| 40 | the important technical details of the problem you have encountered, |
| 41 | not whether your grammar and spelling is flawless. |
| 42 | |
| 43 | Trim out unnecessary information. Do not include large files (such as |
| 44 | config.sh or a complete Configure or make log) unless absolutely |
| 45 | necessary. Do not include a complete transcript of your build |
| 46 | session. Just include the failing commands, the relevant error |
| 47 | messages, and whatever preceding commands are necessary to give the |
| 48 | appropriate context. Plain text should usually be sufficient--fancy |
| 49 | attachments or encodings may actually reduce the number of people who |
| 50 | read your message. Your message will get relayed to over 400 |
| 51 | subscribers around the world so please try to keep it brief but clear. |
| 52 | |
| 53 | If you are unsure what makes a good bug report please read "How to |
| 54 | report Bugs Effectively" by Simon Tatham: |
| 55 | http://www.chiark.greenend.org.uk/~sgtatham/bugs.html |
| 56 | |
| 57 | =head1 SYNOPSIS |
| 58 | |
| 59 | First, make sure you have an up-to-date version of Perl. If you |
| 60 | didn't get your Perl source from CPAN, check the latest version at |
| 61 | http://www.cpan.org/src/. Perl uses a version scheme where even-numbered |
| 62 | subreleases (like 5.6.x and 5.8.x) are stable maintenance releases and |
| 63 | odd-numbered subreleases (like 5.7.x and 5.9.x) are unstable |
| 64 | development releases. Development releases should not be used in |
| 65 | production environments. Fixes and new features are first carefully |
| 66 | tested in development releases and only if they prove themselves to be |
| 67 | worthy will they be migrated to the maintenance releases. |
| 68 | |
| 69 | The basic steps to build and install perl5 on a Unix system with all |
| 70 | the defaults are: |
| 71 | |
| 72 | rm -f config.sh Policy.sh |
| 73 | sh Configure -de |
| 74 | make |
| 75 | make test |
| 76 | make install |
| 77 | |
| 78 | Each of these is explained in further detail below. |
| 79 | |
| 80 | The above commands will install Perl to /usr/local (or some other |
| 81 | platform-specific directory -- see the appropriate file in hints/.) |
| 82 | If that's not okay with you, can run Configure interactively and use |
| 83 | |
| 84 | rm -f config.sh Policy.sh |
| 85 | sh Configure |
| 86 | make |
| 87 | make test |
| 88 | make install |
| 89 | |
| 90 | # You may also wish to add these: |
| 91 | (cd /usr/include && h2ph *.h sys/*.h) |
| 92 | (installhtml --help) |
| 93 | (cd pod && make tex && <process the latex files>) |
| 94 | |
| 95 | or you can use some of the Configure options described below. |
| 96 | |
| 97 | If you have problems, corrections, or questions, please see |
| 98 | L<"Reporting Problems"> above. |
| 99 | |
| 100 | For information on what's new in this release, see the |
| 101 | pod/perldelta.pod file. For more detailed information about specific |
| 102 | changes, see the Changes file. |
| 103 | |
| 104 | =head1 DESCRIPTION |
| 105 | |
| 106 | This document is written in pod format as an easy way to indicate its |
| 107 | structure. The pod format is described in pod/perlpod.pod, but you can |
| 108 | read it as is with any pager or editor. Headings and items are marked |
| 109 | by lines beginning with '='. The other mark-up used is |
| 110 | |
| 111 | B<text> embolden text, used for switches, programs or commands |
| 112 | C<code> literal code |
| 113 | L<name> A link (cross reference) to name |
| 114 | F<file> A filename |
| 115 | |
| 116 | Although most of the defaults are probably fine for most users, |
| 117 | you should probably at least skim through this document before |
| 118 | proceeding. |
| 119 | |
| 120 | In addition to this file, check if there is a README file specific to |
| 121 | your operating system, since it may provide additional or different |
| 122 | instructions for building Perl. If there is a hint file for your |
| 123 | system (in the hints/ directory) you should also read that hint file |
| 124 | for even more information. (Unixware users should use the svr4.sh or |
| 125 | the svr5.sh hint file.) |
| 126 | |
| 127 | For additional information about porting Perl, see the section on |
| 128 | L<"Porting information"> below, and look at the files in the Porting/ |
| 129 | directory. |
| 130 | |
| 131 | =head1 PRELIMINARIES |
| 132 | |
| 133 | =head2 Changes and Incompatibilities |
| 134 | |
| 135 | Please see pod/perldelta.pod for a description of the changes and |
| 136 | potential incompatibilities introduced with this release. A few of |
| 137 | the most important issues are listed below, but you should refer |
| 138 | to pod/perldelta.pod for more detailed information. |
| 139 | |
| 140 | =head3 WARNING: This version is not binary compatible with releases of |
| 141 | Perl prior to 5.9.0. |
| 142 | |
| 143 | If you have built extensions (i.e. modules that include C code) |
| 144 | using an earlier version of Perl, you will need to rebuild and reinstall |
| 145 | those extensions. |
| 146 | |
| 147 | Pure perl modules without XS or C code should continue to work fine |
| 148 | without reinstallation. See the discussions below on |
| 149 | L<"Coexistence with earlier versions of perl5"> and |
| 150 | L<"Upgrading from 5.005 or 5.6 to 5.8.0"> for more details. |
| 151 | |
| 152 | The standard extensions supplied with Perl will be handled automatically. |
| 153 | |
| 154 | On a related issue, old modules may possibly be affected by the changes |
| 155 | in the Perl language in the current release. Please see |
| 156 | pod/perldelta.pod for a description of what's changed. See your |
| 157 | installed copy of the perllocal.pod file for a (possibly incomplete) |
| 158 | list of locally installed modules. Also see CPAN::autobundle for one |
| 159 | way to make a "bundle" of your currently installed modules. |
| 160 | |
| 161 | =head2 Space Requirements |
| 162 | |
| 163 | The complete perl5 source tree takes up about 60 MB of disk space. |
| 164 | After completing make, it takes up roughly 100 MB, though the actual |
| 165 | total is likely to be quite system-dependent. The installation |
| 166 | directories need something on the order of 45 MB, though again that |
| 167 | value is system-dependent. A perl build with debug symbols and |
| 168 | -DDEBUGGING will require something on the order of 10 MB extra. |
| 169 | |
| 170 | =head1 Start with a Fresh Distribution |
| 171 | |
| 172 | If you have built perl before, you should clean out the build directory |
| 173 | with the command |
| 174 | |
| 175 | make distclean |
| 176 | |
| 177 | or |
| 178 | |
| 179 | make realclean |
| 180 | |
| 181 | The only difference between the two is that make distclean also removes |
| 182 | your old config.sh and Policy.sh files. |
| 183 | |
| 184 | The results of a Configure run are stored in the config.sh and Policy.sh |
| 185 | files. If you are upgrading from a previous version of perl, or if you |
| 186 | change systems or compilers or make other significant changes, or if |
| 187 | you are experiencing difficulties building perl, you should probably |
| 188 | not re-use your old config.sh. Simply remove it |
| 189 | |
| 190 | rm -f config.sh |
| 191 | |
| 192 | If you wish to use your old config.sh, be especially attentive to the |
| 193 | version and architecture-specific questions and answers. For example, |
| 194 | the default directory for architecture-dependent library modules |
| 195 | includes the version name. By default, Configure will reuse your old |
| 196 | name (e.g. /opt/perl/lib/i86pc-solaris/5.003) even if you're running |
| 197 | Configure for a different version, e.g. 5.004. Yes, Configure should |
| 198 | probably check and correct for this, but it doesn't. Similarly, if you |
| 199 | used a shared libperl.so (see below) with version numbers, you will |
| 200 | probably want to adjust them as well. |
| 201 | |
| 202 | Also, be careful to check your architecture name. For example, some |
| 203 | Linux distributions use i386, while others may use i486. If you build |
| 204 | it yourself, Configure uses the output of the arch command, which |
| 205 | might be i586 or i686 instead. If you pick up a precompiled binary, or |
| 206 | compile extensions on different systems, they might not all agree on |
| 207 | the architecture name. |
| 208 | |
| 209 | In short, if you wish to use your old config.sh, I recommend running |
| 210 | Configure interactively rather than blindly accepting the defaults. |
| 211 | |
| 212 | If your reason to reuse your old config.sh is to save your particular |
| 213 | installation choices, then you can probably achieve the same effect by |
| 214 | using the Policy.sh file. See the section on L<"Site-wide Policy |
| 215 | settings"> below. If you wish to start with a fresh distribution, you |
| 216 | also need to remove any old Policy.sh files you may have with |
| 217 | |
| 218 | rm -f Policy.sh |
| 219 | |
| 220 | =head1 Run Configure |
| 221 | |
| 222 | Configure will figure out various things about your system. Some |
| 223 | things Configure will figure out for itself, other things it will ask |
| 224 | you about. To accept the default, just press RETURN. The default is |
| 225 | almost always okay. It is normal for some things to be "NOT found", |
| 226 | since Configure often searches for many different ways of performing |
| 227 | the same function. |
| 228 | |
| 229 | At any Configure prompt, you can type &-d and Configure will use the |
| 230 | defaults from then on. |
| 231 | |
| 232 | After it runs, Configure will perform variable substitution on all the |
| 233 | *.SH files and offer to run make depend. |
| 234 | |
| 235 | =head2 Common Configure options |
| 236 | |
| 237 | Configure supports a number of useful options. Run |
| 238 | |
| 239 | Configure -h |
| 240 | |
| 241 | to get a listing. See the Porting/Glossary file for a complete list of |
| 242 | Configure variables you can set and their definitions. |
| 243 | |
| 244 | =over 4 |
| 245 | |
| 246 | =item gcc |
| 247 | |
| 248 | To compile with gcc you should run |
| 249 | |
| 250 | sh Configure -Dcc=gcc |
| 251 | |
| 252 | This is the preferred way to specify gcc (or another alternative |
| 253 | compiler) so that the hints files can set appropriate defaults. |
| 254 | |
| 255 | =item Installation prefix |
| 256 | |
| 257 | By default, for most systems, perl will be installed in |
| 258 | /usr/local/{bin, lib, man}. (See L<"Installation Directories"> |
| 259 | and L<"Coexistence with earlier versions of perl5"> below for |
| 260 | further details.) |
| 261 | |
| 262 | You can specify a different 'prefix' for the default installation |
| 263 | directory when Configure prompts you, or by using the Configure command |
| 264 | line option -Dprefix='/some/directory', e.g. |
| 265 | |
| 266 | sh Configure -Dprefix=/opt/perl |
| 267 | |
| 268 | If your prefix contains the string "perl", then the suggested |
| 269 | directory structure is simplified. For example, if you use |
| 270 | prefix=/opt/perl, then Configure will suggest /opt/perl/lib instead of |
| 271 | /opt/perl/lib/perl5/. Again, see L<"Installation Directories"> below |
| 272 | for more details. Do not include a trailing slash, (i.e. /opt/perl/) |
| 273 | or you may experience odd test failures. |
| 274 | |
| 275 | NOTE: You must not specify an installation directory that is the same |
| 276 | as or below your perl source directory. If you do, installperl will |
| 277 | attempt infinite recursion. |
| 278 | |
| 279 | =item /usr/bin/perl |
| 280 | |
| 281 | It may seem obvious, but Perl is useful only when users can easily |
| 282 | find it. It's often a good idea to have both /usr/bin/perl and |
| 283 | /usr/local/bin/perl be symlinks to the actual binary. Be especially |
| 284 | careful, however, not to overwrite a version of perl supplied by your |
| 285 | vendor unless you are sure you know what you are doing. If you insist |
| 286 | on replacing your vendor's perl, useful information on how it was |
| 287 | configured may be found with |
| 288 | |
| 289 | perl -V:config_args |
| 290 | |
| 291 | (Check the output carefully, however, since this doesn't preserve |
| 292 | spaces in arguments to Configure. For that, you have to look carefully |
| 293 | at config_arg1, config_arg2, etc.) |
| 294 | |
| 295 | By default, Configure will not try to link /usr/bin/perl to the current |
| 296 | version of perl. You can turn on that behavior by running |
| 297 | |
| 298 | Configure -Dinstallusrbinperl |
| 299 | |
| 300 | or by answering 'yes' to the appropriate Configure prompt. |
| 301 | |
| 302 | In any case, system administrators are strongly encouraged to put |
| 303 | (symlinks to) perl and its accompanying utilities, such as perldoc, |
| 304 | into a directory typically found along a user's PATH, or in another |
| 305 | obvious and convenient place. |
| 306 | |
| 307 | =item Building a development release. |
| 308 | |
| 309 | For development releases (odd subreleases, like 5.9.x) if you want to |
| 310 | use Configure -d, you will also need to supply -Dusedevel to Configure, |
| 311 | because the default answer to the question "do you really want to |
| 312 | Configure a development version?" is "no". The -Dusedevel skips that |
| 313 | sanity check. |
| 314 | |
| 315 | =back |
| 316 | |
| 317 | If you are willing to accept all the defaults, and you want terse |
| 318 | output, you can run |
| 319 | |
| 320 | sh Configure -des |
| 321 | |
| 322 | For example for my Solaris/x86 system, I usually use |
| 323 | |
| 324 | sh Configure -Dprefix=/opt/perl -Doptimize='-xpentium -xO4' -des |
| 325 | |
| 326 | =head2 Altering config.sh variables for C compiler switches etc. |
| 327 | |
| 328 | For most users, most of the Configure defaults are fine, or can easily |
| 329 | be set on the Configure command line. However, if Configure doesn't |
| 330 | have an option to do what you want, you can change Configure variables |
| 331 | after the platform hints have been run by using Configure's -A switch. |
| 332 | For example, here's how to add a couple of extra flags to C compiler |
| 333 | invocations: |
| 334 | |
| 335 | sh Configure -Accflags="-DPERL_EXTERNAL_GLOB -DPERL_POLLUTE_MALLOC" |
| 336 | |
| 337 | For more help on Configure switches, run |
| 338 | |
| 339 | sh Configure -h |
| 340 | |
| 341 | =head2 Major Configure-time Build Options |
| 342 | |
| 343 | There are several different ways to Configure and build perl for your |
| 344 | system. For most users, the defaults are sensible and will work. |
| 345 | Some users, however, may wish to further customize perl. Here are |
| 346 | some of the main things you can change. |
| 347 | |
| 348 | =head3 Threads |
| 349 | |
| 350 | On some platforms, perl can be compiled with support for threads. To |
| 351 | enable this, run |
| 352 | |
| 353 | sh Configure -Dusethreads |
| 354 | |
| 355 | Currently, you need to specify -Dusethreads on the Configure command |
| 356 | line so that the hint files can make appropriate adjustments. |
| 357 | |
| 358 | The default is to compile without thread support. |
| 359 | |
| 360 | Perl has two different internal threads implementations. The current |
| 361 | model (available internally since 5.6, and as a user-level module since |
| 362 | 5.8) is called interpreter-based implementation (ithreads), with one |
| 363 | interpreter per thread, and explicit sharing of data. The 5.005 |
| 364 | version (5005threads) is considered obsolete, buggy, and unmaintained. |
| 365 | |
| 366 | By default, Configure selects ithreads if -Dusethreads is specified. |
| 367 | |
| 368 | However, if you insist, you can select the unsupported old 5005threads behavior |
| 369 | |
| 370 | sh Configure -Dusethreads -Duse5005threads |
| 371 | |
| 372 | The 'threads' module is for use with the ithreads implementation. The |
| 373 | 'Thread' module offers an interface to either 5005threads or ithreads |
| 374 | (whichever has been configured). |
| 375 | |
| 376 | When using threads, perl uses a dynamically-sized buffer for some of |
| 377 | the thread-safe library calls, such as those in the getpw*() family. |
| 378 | This buffer starts small, but it will keep growing until the result |
| 379 | fits. To get a fixed upper limit, you should compile Perl with |
| 380 | PERL_REENTRANT_MAXSIZE defined to be the number of bytes you want. One |
| 381 | way to do this is to run Configure with |
| 382 | C<-Accflags=-DPERL_REENTRANT_MAXSIZE=65536> |
| 383 | |
| 384 | =head3 Large file support. |
| 385 | |
| 386 | Since Perl 5.6.0, Perl has supported large files (files larger than |
| 387 | 2 gigabytes), and in many common platforms like Linux or Solaris this |
| 388 | support is on by default. |
| 389 | |
| 390 | This is both good and bad. It is good in that you can use large files, |
| 391 | seek(), stat(), and -s them. It is bad in that if you are interfacing Perl |
| 392 | using some extension, the components you are connecting to must also |
| 393 | be large file aware: if Perl thinks files can be large but the other |
| 394 | parts of the software puzzle do not understand the concept, bad things |
| 395 | will happen. One popular extension suffering from this ailment is the |
| 396 | Apache extension mod_perl. |
| 397 | |
| 398 | There's also one known limitation with the current large files |
| 399 | implementation: unless you also have 64-bit integers (see the next |
| 400 | section), you cannot use the printf/sprintf non-decimal integer formats |
| 401 | like C<%x> to print filesizes. You can use C<%d>, though. |
| 402 | |
| 403 | =head3 64 bit support. |
| 404 | |
| 405 | If your platform does not have run natively at 64 bits, but can |
| 406 | simulate them with compiler flags and/or C<long long> or C<int64_t>, |
| 407 | you can build a perl that uses 64 bits. |
| 408 | |
| 409 | There are actually two modes of 64-bitness: the first one is achieved |
| 410 | using Configure -Duse64bitint and the second one using Configure |
| 411 | -Duse64bitall. The difference is that the first one is minimal and |
| 412 | the second one maximal. The first works in more places than the second. |
| 413 | |
| 414 | The C<use64bitint> option does only as much as is required to get |
| 415 | 64-bit integers into Perl (this may mean, for example, using "long |
| 416 | longs") while your memory may still be limited to 2 gigabytes (because |
| 417 | your pointers could still be 32-bit). Note that the name C<64bitint> |
| 418 | does not imply that your C compiler will be using 64-bit C<int>s (it |
| 419 | might, but it doesn't have to). The C<use64bitint> simply means that |
| 420 | you will be able to have 64 bit-wide scalar values. |
| 421 | |
| 422 | The C<use64bitall> option goes all the way by attempting to switch |
| 423 | integers (if it can), longs (and pointers) to being 64-bit. This may |
| 424 | create an even more binary incompatible Perl than -Duse64bitint: the |
| 425 | resulting executable may not run at all in a 32-bit box, or you may |
| 426 | have to reboot/reconfigure/rebuild your operating system to be 64-bit |
| 427 | aware. |
| 428 | |
| 429 | Natively 64-bit systems like Alpha and Cray need neither -Duse64bitint |
| 430 | nor -Duse64bitall. |
| 431 | |
| 432 | NOTE: 64-bit support is still experimental on most platforms. |
| 433 | Existing support only covers the LP64 data model. In particular, the |
| 434 | LLP64 data model is not yet supported. 64-bit libraries and system |
| 435 | APIs on many platforms have not stabilized--your mileage may vary. |
| 436 | |
| 437 | =head3 Long doubles |
| 438 | |
| 439 | In some systems you may be able to use long doubles to enhance the |
| 440 | range and precision of your double precision floating point numbers |
| 441 | (that is, Perl's numbers). Use Configure -Duselongdouble to enable |
| 442 | this support (if it is available). |
| 443 | |
| 444 | =head3 "more bits" |
| 445 | |
| 446 | You can "Configure -Dusemorebits" to turn on both the 64-bit support |
| 447 | and the long double support. |
| 448 | |
| 449 | =head3 Selecting File IO mechanisms |
| 450 | |
| 451 | Executive summary: as of Perl 5.8, you should use the default "PerlIO" |
| 452 | as the IO mechanism unless you have a good reason not to. |
| 453 | |
| 454 | In more detail: previous versions of perl used the standard IO |
| 455 | mechanisms as defined in stdio.h. Versions 5.003_02 and later of perl |
| 456 | introduced alternate IO mechanisms via a "PerlIO" abstraction, but up |
| 457 | until and including Perl 5.6, the stdio mechanism was still the default |
| 458 | and the only supported mechanism. |
| 459 | |
| 460 | Starting from Perl 5.8, the default mechanism is to use the PerlIO |
| 461 | abstraction, because it allows better control of I/O mechanisms, |
| 462 | instead of having to work with (often, work around) vendors' I/O |
| 463 | implementations. |
| 464 | |
| 465 | This PerlIO abstraction can be (but again, unless you know what you |
| 466 | are doing, should not be) disabled either on the Configure command |
| 467 | line with |
| 468 | |
| 469 | sh Configure -Uuseperlio |
| 470 | |
| 471 | or interactively at the appropriate Configure prompt. |
| 472 | |
| 473 | With the PerlIO abstraction layer, there is another possibility for |
| 474 | the underlying IO calls, AT&T's "sfio". This has superior performance |
| 475 | to stdio.h in many cases, and is extensible by the use of "discipline" |
| 476 | modules ("Native" PerlIO has them too). Sfio currently only builds on |
| 477 | a subset of the UNIX platforms perl supports. Because the data |
| 478 | structures are completely different from stdio, perl extension modules |
| 479 | or external libraries may not work. This configuration exists to |
| 480 | allow these issues to be worked on. |
| 481 | |
| 482 | This option requires the 'sfio' package to have been built and installed. |
| 483 | The latest sfio is available from http://www.research.att.com/sw/tools/sfio/ |
| 484 | |
| 485 | You select this option by |
| 486 | |
| 487 | sh Configure -Duseperlio -Dusesfio |
| 488 | |
| 489 | If you have already selected -Duseperlio, and if Configure detects |
| 490 | that you have sfio, then sfio will be the default suggested by |
| 491 | Configure. |
| 492 | |
| 493 | Note: On some systems, sfio's iffe configuration script fails to |
| 494 | detect that you have an atexit function (or equivalent). Apparently, |
| 495 | this is a problem at least for some versions of Linux and SunOS 4. |
| 496 | Configure should detect this problem and warn you about problems with |
| 497 | _exit vs. exit. If you have this problem, the fix is to go back to |
| 498 | your sfio sources and correct iffe's guess about atexit. |
| 499 | |
| 500 | =head3 Algorithmic Complexity Attacks on Hashes |
| 501 | |
| 502 | In Perls 5.8.0 and earlier it was easy to create degenerate hashes. |
| 503 | Processing such hashes would consume large amounts of CPU time, |
| 504 | enabling a "Denial of Service" attack against Perl. Such hashes may be |
| 505 | a problem for example for mod_perl sites, sites with Perl CGI scripts |
| 506 | and web services, that process data originating from external sources. |
| 507 | |
| 508 | In Perl 5.8.1 a security feature was introduced to make it harder to |
| 509 | create such degenerate hashes. A visible side effect of this was that |
| 510 | the keys(), values(), and each() functions may return the hash elements |
| 511 | in different order between different runs of Perl even with the same |
| 512 | data. It also had unintended binary incompatibility issues with |
| 513 | certain modules compiled against Perl 5.8.0. |
| 514 | |
| 515 | In Perl 5.8.2 an improved scheme was introduced. Hashes will return |
| 516 | elements in the same order as Perl 5.8.0 by default. On a hash by hash |
| 517 | basis, if pathological data is detected during a hash key insertion, |
| 518 | then that hash will switch to an alternative random hash seed. As |
| 519 | adding keys can always dramatically change returned hash element order, |
| 520 | existing programs will not be affected by this, unless they |
| 521 | specifically test for pre-recorded hash return order for contrived |
| 522 | data. (eg the list of keys generated by C<map {"\0"x$_} 0..15> trigger |
| 523 | randomisation) In effect the new implementation means that 5.8.1 scheme |
| 524 | is only being used on hashes which are under attack. |
| 525 | |
| 526 | One can still revert to the old guaranteed repeatable order (and be |
| 527 | vulnerable to attack by wily crackers) by setting the environment |
| 528 | variable PERL_HASH_SEED, see L<perlrun/PERL_HASH_SEED>. Another option |
| 529 | is to add -DUSE_HASH_SEED_EXPLICIT to the compilation flags (for |
| 530 | example by using C<Configure -Accflags=-DUSE_HASH_SEED_EXPLICIT>), in |
| 531 | which case one has to explicitly set the PERL_HASH_SEED environment |
| 532 | variable to enable the security feature, or by adding -DNO_HASH_SEED to |
| 533 | the compilation flags to completely disable the randomisation feature. |
| 534 | |
| 535 | B<Perl has never guaranteed any ordering of the hash keys>, and the |
| 536 | ordering has already changed several times during the lifetime of Perl |
| 537 | 5. Also, the ordering of hash keys has always been, and continues to |
| 538 | be, affected by the insertion order. It is likely that Perl 5.10 and |
| 539 | Perl 6 will randomise all hashes. Note that because of this |
| 540 | randomisation for example the Data::Dumper results will be different |
| 541 | between different runs of Perl since Data::Dumper by default dumps |
| 542 | hashes "unordered". The use of the Data::Dumper C<Sortkeys> option is |
| 543 | recommended. |
| 544 | |
| 545 | =head3 SOCKS |
| 546 | |
| 547 | Perl can be configured to be 'socksified', that is, to use the SOCKS |
| 548 | TCP/IP proxy protocol library. SOCKS is used to give applications |
| 549 | access to transport layer network proxies. Perl supports only SOCKS |
| 550 | Version 5. You can find more about SOCKS from http://www.socks.nec.com/ |
| 551 | |
| 552 | =head3 Dynamic Loading |
| 553 | |
| 554 | By default, Configure will compile perl to use dynamic loading if |
| 555 | your system supports it. If you want to force perl to be compiled |
| 556 | statically, you can either choose this when Configure prompts you or |
| 557 | you can use the Configure command line option -Uusedl. |
| 558 | |
| 559 | =head3 Building a shared Perl library |
| 560 | |
| 561 | Currently, for most systems, the main perl executable is built by |
| 562 | linking the "perl library" libperl.a with perlmain.o, your static |
| 563 | extensions (usually just DynaLoader.a) and various extra libraries, |
| 564 | such as -lm. |
| 565 | |
| 566 | On some systems that support dynamic loading, it may be possible to |
| 567 | replace libperl.a with a shared libperl.so. If you anticipate building |
| 568 | several different perl binaries (e.g. by embedding libperl into |
| 569 | different programs, or by using the optional compiler extension), then |
| 570 | you might wish to build a shared libperl.so so that all your binaries |
| 571 | can share the same library. |
| 572 | |
| 573 | The disadvantages are that there may be a significant performance |
| 574 | penalty associated with the shared libperl.so, and that the overall |
| 575 | mechanism is still rather fragile with respect to different versions |
| 576 | and upgrades. |
| 577 | |
| 578 | In terms of performance, on my test system (Solaris 2.5_x86) the perl |
| 579 | test suite took roughly 15% longer to run with the shared libperl.so. |
| 580 | Your system and typical applications may well give quite different |
| 581 | results. |
| 582 | |
| 583 | The default name for the shared library is typically something like |
| 584 | libperl.so.6.2 (for Perl 5.6.2), or libperl.so.602, or simply |
| 585 | libperl.so. Configure tries to guess a sensible naming convention |
| 586 | based on your C library name. Since the library gets installed in a |
| 587 | version-specific architecture-dependent directory, the exact name |
| 588 | isn't very important anyway, as long as your linker is happy. |
| 589 | |
| 590 | For some systems (mostly SVR4), building a shared libperl is required |
| 591 | for dynamic loading to work, and hence is already the default. |
| 592 | |
| 593 | You can elect to build a shared libperl by |
| 594 | |
| 595 | sh Configure -Duseshrplib |
| 596 | |
| 597 | To build a shared libperl, the environment variable controlling shared |
| 598 | library search (LD_LIBRARY_PATH in most systems, DYLD_LIBRARY_PATH for |
| 599 | NeXTSTEP/OPENSTEP/Darwin, LIBRARY_PATH for BeOS, LD_LIBRARY_PATH/SHLIB_PATH |
| 600 | for HP-UX, LIBPATH for AIX, PATH for Cygwin) must be set up to include |
| 601 | the Perl build directory because that's where the shared libperl will |
| 602 | be created. Configure arranges makefile to have the correct shared |
| 603 | library search settings. You can find the name of the environment |
| 604 | variable Perl thinks works in your your system by |
| 605 | |
| 606 | grep ldlibpthname config.sh |
| 607 | |
| 608 | However, there are some special cases where manually setting the |
| 609 | shared library path might be required. For example, if you want to run |
| 610 | something like the following with the newly-built but not-yet-installed |
| 611 | ./perl: |
| 612 | |
| 613 | cd t; ./perl misc/failing_test.t |
| 614 | or |
| 615 | ./perl -Ilib ~/my_mission_critical_test |
| 616 | |
| 617 | then you need to set up the shared library path explicitly. |
| 618 | You can do this with |
| 619 | |
| 620 | LD_LIBRARY_PATH=`pwd`:$LD_LIBRARY_PATH; export LD_LIBRARY_PATH |
| 621 | |
| 622 | for Bourne-style shells, or |
| 623 | |
| 624 | setenv LD_LIBRARY_PATH `pwd` |
| 625 | |
| 626 | for Csh-style shells. (This procedure may also be needed if for some |
| 627 | unexpected reason Configure fails to set up makefile correctly.) (And |
| 628 | again, it may be something other than LD_LIBRARY_PATH for you, see above.) |
| 629 | |
| 630 | You can often recognize failures to build/use a shared libperl from error |
| 631 | messages complaining about a missing libperl.so (or libperl.sl in HP-UX), |
| 632 | for example: |
| 633 | 18126:./miniperl: /sbin/loader: Fatal Error: cannot map libperl.so |
| 634 | |
| 635 | There is also an potential problem with the shared perl library if you |
| 636 | want to have more than one "flavor" of the same version of perl (e.g. |
| 637 | with and without -DDEBUGGING). For example, suppose you build and |
| 638 | install a standard Perl 5.8.0 with a shared library. Then, suppose you |
| 639 | try to build Perl 5.8.0 with -DDEBUGGING enabled, but everything else |
| 640 | the same, including all the installation directories. How can you |
| 641 | ensure that your newly built perl will link with your newly built |
| 642 | libperl.so.8 rather with the installed libperl.so.8? The answer is |
| 643 | that you might not be able to. The installation directory is encoded |
| 644 | in the perl binary with the LD_RUN_PATH environment variable (or |
| 645 | equivalent ld command-line option). On Solaris, you can override that |
| 646 | with LD_LIBRARY_PATH; on Linux, you can only override at runtime via |
| 647 | LD_PRELOAD, specifying the exact filename you wish to be used; and on |
| 648 | Digital Unix, you can override LD_LIBRARY_PATH by setting the |
| 649 | _RLD_ROOT environment variable to point to the perl build directory. |
| 650 | |
| 651 | In other words, it is generally not a good idea to try to build a perl |
| 652 | with a shared library if $archlib/CORE/$libperl already exists from a |
| 653 | previous build. |
| 654 | |
| 655 | A good workaround is to specify a different directory for the |
| 656 | architecture-dependent library for your -DDEBUGGING version of perl. |
| 657 | You can do this by changing all the *archlib* variables in config.sh to |
| 658 | point to your new architecture-dependent library. |
| 659 | |
| 660 | =head3 Environment access |
| 661 | |
| 662 | Perl often needs to write to the program's environment, such as when C<%ENV> |
| 663 | is assigned to. Many implementations of the C library function C<putenv()> |
| 664 | leak memory, so where possible perl will manipulate the environment directly |
| 665 | to avoid these leaks. The default is now to perform direct manipulation |
| 666 | whenever perl is running as a stand alone interpreter, and to call the safe |
| 667 | but potentially leaky C<putenv()> function when the perl interpreter is |
| 668 | embedded in another application. You can force perl to always use C<putenv()> |
| 669 | by compiling with -DPERL_USE_SAFE_PUTENV. You can force an embedded perl to |
| 670 | use direct manipulation by setting C<PL_use_safe_putenv = 0;> after the |
| 671 | C<perl_construct()> call. |
| 672 | |
| 673 | =head2 Installation Directories |
| 674 | |
| 675 | The installation directories can all be changed by answering the |
| 676 | appropriate questions in Configure. For convenience, all the |
| 677 | installation questions are near the beginning of Configure. |
| 678 | Do not include trailing slashes on directory names. |
| 679 | |
| 680 | I highly recommend running Configure interactively to be sure it puts |
| 681 | everything where you want it. At any point during the Configure |
| 682 | process, you can answer a question with &-d and Configure will use |
| 683 | the defaults from then on. Alternatively, you can |
| 684 | |
| 685 | grep '^install' config.sh |
| 686 | |
| 687 | after Configure has run to verify the installation paths. |
| 688 | |
| 689 | The defaults are intended to be reasonable and sensible for most |
| 690 | people building from sources. Those who build and distribute binary |
| 691 | distributions or who export perl to a range of systems will probably |
| 692 | need to alter them. If you are content to just accept the defaults, |
| 693 | you can safely skip the next section. |
| 694 | |
| 695 | The directories set up by Configure fall into three broad categories. |
| 696 | |
| 697 | =over 4 |
| 698 | |
| 699 | =item Directories for the perl distribution |
| 700 | |
| 701 | By default, Configure will use the following directories for 5.9.0. |
| 702 | $version is the full perl version number, including subversion, e.g. |
| 703 | 5.9.0 or 5.9.1, and $archname is a string like sun4-sunos, |
| 704 | determined by Configure. The full definitions of all Configure |
| 705 | variables are in the file Porting/Glossary. |
| 706 | |
| 707 | Configure variable Default value |
| 708 | $prefixexp /usr/local |
| 709 | $binexp $prefixexp/bin |
| 710 | $scriptdirexp $prefixexp/bin |
| 711 | $privlibexp $prefixexp/lib/perl5/$version |
| 712 | $archlibexp $prefixexp/lib/perl5/$version/$archname |
| 713 | $man1direxp $prefixexp/man/man1 |
| 714 | $man3direxp $prefixexp/man/man3 |
| 715 | $html1direxp (none) |
| 716 | $html3direxp (none) |
| 717 | |
| 718 | $prefixexp is generated from $prefix, with ~ expansion done to convert home |
| 719 | directories into absolute paths. Similarly for the other variables listed. As |
| 720 | file system calls do not do this, you should always reference the ...exp |
| 721 | variables, to support users who build perl in their home directory. |
| 722 | |
| 723 | Actually, Configure recognizes the SVR3-style |
| 724 | /usr/local/man/l_man/man1 directories, if present, and uses those |
| 725 | instead. Also, if $prefix contains the string "perl", the library |
| 726 | directories are simplified as described below. For simplicity, only |
| 727 | the common style is shown here. |
| 728 | |
| 729 | =item Directories for site-specific add-on files |
| 730 | |
| 731 | After perl is installed, you may later wish to add modules (e.g. from |
| 732 | CPAN) or scripts. Configure will set up the following directories to |
| 733 | be used for installing those add-on modules and scripts. |
| 734 | |
| 735 | Configure variable Default value |
| 736 | $siteprefixexp $prefixexp |
| 737 | $sitebinexp $siteprefixexp/bin |
| 738 | $sitescriptexp $siteprefixexp/bin |
| 739 | $sitelibexp $siteprefixexp/lib/perl5/site_perl/$version |
| 740 | $sitearchexp $siteprefixexp/lib/perl5/site_perl/$version/$archname |
| 741 | $siteman1direxp $siteprefixexp/man/man1 |
| 742 | $siteman3direxp $siteprefixexp/man/man3 |
| 743 | $sitehtml1direxp (none) |
| 744 | $sitehtml3direxp (none) |
| 745 | |
| 746 | By default, ExtUtils::MakeMaker will install architecture-independent |
| 747 | modules into $sitelib and architecture-dependent modules into $sitearch. |
| 748 | |
| 749 | =item Directories for vendor-supplied add-on files |
| 750 | |
| 751 | Lastly, if you are building a binary distribution of perl for |
| 752 | distribution, Configure can optionally set up the following directories |
| 753 | for you to use to distribute add-on modules. |
| 754 | |
| 755 | Configure variable Default value |
| 756 | $vendorprefixexp (none) |
| 757 | (The next ones are set only if vendorprefix is set.) |
| 758 | $vendorbinexp $vendorprefixexp/bin |
| 759 | $vendorscriptexp $vendorprefixexp/bin |
| 760 | $vendorlibexp |
| 761 | $vendorprefixexp/lib/perl5/vendor_perl/$version |
| 762 | $vendorarchexp |
| 763 | $vendorprefixexp/lib/perl5/vendor_perl/$version/$archname |
| 764 | $vendorman1direxp $vendorprefixexp/man/man1 |
| 765 | $vendorman3direxp $vendorprefixexp/man/man3 |
| 766 | $vendorhtml1direxp (none) |
| 767 | $vendorhtml3direxp (none) |
| 768 | |
| 769 | These are normally empty, but may be set as needed. For example, |
| 770 | a vendor might choose the following settings: |
| 771 | |
| 772 | $prefix /usr |
| 773 | $siteprefix /usr/local |
| 774 | $vendorprefix /usr |
| 775 | |
| 776 | This would have the effect of setting the following: |
| 777 | |
| 778 | $binexp /usr/bin |
| 779 | $scriptdirexp /usr/bin |
| 780 | $privlibexp /usr/lib/perl5/$version |
| 781 | $archlibexp /usr/lib/perl5/$version/$archname |
| 782 | $man1direxp /usr/man/man1 |
| 783 | $man3direxp /usr/man/man3 |
| 784 | |
| 785 | $sitebinexp /usr/local/bin |
| 786 | $sitescriptexp /usr/local/bin |
| 787 | $sitelibexp /usr/local/lib/perl5/site_perl/$version |
| 788 | $sitearchexp /usr/local/lib/perl5/site_perl/$version/$archname |
| 789 | $siteman1direxp /usr/local/man/man1 |
| 790 | $siteman3direxp /usr/local/man/man3 |
| 791 | |
| 792 | $vendorbinexp /usr/bin |
| 793 | $vendorscriptexp /usr/bin |
| 794 | $vendorlibexp /usr/lib/perl5/vendor_perl/$version |
| 795 | $vendorarchexp /usr/lib/perl5/vendor_perl/$version/$archname |
| 796 | $vendorman1direxp /usr/man/man1 |
| 797 | $vendorman3direxp /usr/man/man3 |
| 798 | |
| 799 | Note how in this example, the vendor-supplied directories are in the |
| 800 | /usr hierarchy, while the directories reserved for the end-user are in |
| 801 | the /usr/local hierarchy. |
| 802 | |
| 803 | The entire installed library hierarchy is installed in locations with |
| 804 | version numbers, keeping the installations of different versions distinct. |
| 805 | However, later installations of Perl can still be configured to search the |
| 806 | installed libraries corresponding to compatible earlier versions. |
| 807 | See L<"Coexistence with earlier versions of perl5"> below for more details |
| 808 | on how Perl can be made to search older version directories. |
| 809 | |
| 810 | Of course you may use these directories however you see fit. For |
| 811 | example, you may wish to use $siteprefix for site-specific files that |
| 812 | are stored locally on your own disk and use $vendorprefix for |
| 813 | site-specific files that are stored elsewhere on your organization's |
| 814 | network. One way to do that would be something like |
| 815 | |
| 816 | sh Configure -Dsiteprefix=/usr/local -Dvendorprefix=/usr/share/perl |
| 817 | |
| 818 | =item otherlibdirs |
| 819 | |
| 820 | As a final catch-all, Configure also offers an $otherlibdirs |
| 821 | variable. This variable contains a colon-separated list of additional |
| 822 | directories to add to @INC. By default, it will be empty. |
| 823 | Perl will search these directories (including architecture and |
| 824 | version-specific subdirectories) for add-on modules and extensions. |
| 825 | |
| 826 | For example, if you have a bundle of perl libraries from a previous |
| 827 | installation, perhaps in a strange place: |
| 828 | |
| 829 | Configure -Dotherlibdirs=/usr/lib/perl5/site_perl/5.8.1 |
| 830 | |
| 831 | =item APPLLIB_EXP |
| 832 | |
| 833 | There is one other way of adding paths to @INC at perl build time, and |
| 834 | that is by setting the APPLLIB_EXP C pre-processor token to a colon- |
| 835 | separated list of directories, like this |
| 836 | |
| 837 | sh Configure -Accflags='-DAPPLLIB_EXP=\"/usr/libperl\"' |
| 838 | |
| 839 | The directories defined by APPLLIB_EXP get added to @INC I<first>, |
| 840 | ahead of any others, and so provide a way to override the standard perl |
| 841 | modules should you, for example, want to distribute fixes without |
| 842 | touching the perl distribution proper. And, like otherlib dirs, |
| 843 | version and architecture specific subdirectories are also searched, if |
| 844 | present, at run time. Of course, you can still search other @INC |
| 845 | directories ahead of those in APPLLIB_EXP by using any of the standard |
| 846 | run-time methods: $PERLLIB, $PERL5LIB, -I, use lib, etc. |
| 847 | |
| 848 | =item USE_SITECUSTOMIZE |
| 849 | |
| 850 | Run-time customization of @INC can be enabled with: |
| 851 | |
| 852 | sh Configure -Dusesitecustomize |
| 853 | |
| 854 | Which will define USE_SITECUSTOMIZE and $Config{usesitecustomize}. |
| 855 | When enabled, make perl run F<$sitelibexp/sitecustomize.pl> before |
| 856 | anything else. This script can then be set up to add additional |
| 857 | entries to @INC. |
| 858 | |
| 859 | =item Man Pages |
| 860 | |
| 861 | In versions 5.005_57 and earlier, the default was to store module man |
| 862 | pages in a version-specific directory, such as |
| 863 | /usr/local/lib/perl5/$version/man/man3. The default for 5.005_58 and |
| 864 | after is /usr/local/man/man3 so that most users can find the man pages |
| 865 | without resetting MANPATH. |
| 866 | |
| 867 | You can continue to use the old default from the command line with |
| 868 | |
| 869 | sh Configure -Dman3dir=/usr/local/lib/perl5/5.9.0/man/man3 |
| 870 | |
| 871 | Some users also prefer to use a .3pm suffix. You can do that with |
| 872 | |
| 873 | sh Configure -Dman3ext=3pm |
| 874 | |
| 875 | Again, these are just the defaults, and can be changed as you run |
| 876 | Configure. |
| 877 | |
| 878 | =item HTML pages |
| 879 | |
| 880 | Currently, the standard perl installation does not do anything with |
| 881 | HTML documentation, but that may change in the future. Further, some |
| 882 | add-on modules may wish to install HTML documents. The html Configure |
| 883 | variables listed above are provided if you wish to specify where such |
| 884 | documents should be placed. The default is "none", but will likely |
| 885 | eventually change to something useful based on user feedback. |
| 886 | |
| 887 | =back |
| 888 | |
| 889 | Some users prefer to append a "/share" to $privlib and $sitelib |
| 890 | to emphasize that those directories can be shared among different |
| 891 | architectures. |
| 892 | |
| 893 | Note that these are just the defaults. You can actually structure the |
| 894 | directories any way you like. They don't even have to be on the same |
| 895 | filesystem. |
| 896 | |
| 897 | Further details about the installation directories, maintenance and |
| 898 | development subversions, and about supporting multiple versions are |
| 899 | discussed in L<"Coexistence with earlier versions of perl5"> below. |
| 900 | |
| 901 | If you specify a prefix that contains the string "perl", then the |
| 902 | library directory structure is slightly simplified. Instead of |
| 903 | suggesting $prefix/lib/perl5/, Configure will suggest $prefix/lib. |
| 904 | |
| 905 | Thus, for example, if you Configure with |
| 906 | -Dprefix=/opt/perl, then the default library directories for 5.9.0 are |
| 907 | |
| 908 | Configure variable Default value |
| 909 | $privlib /opt/perl/lib/5.9.0 |
| 910 | $archlib /opt/perl/lib/5.9.0/$archname |
| 911 | $sitelib /opt/perl/lib/site_perl/5.9.0 |
| 912 | $sitearch /opt/perl/lib/site_perl/5.9.0/$archname |
| 913 | |
| 914 | =head2 Changing the installation directory |
| 915 | |
| 916 | Configure distinguishes between the directory in which perl (and its |
| 917 | associated files) should be installed and the directory in which it |
| 918 | will eventually reside. For most sites, these two are the same; for |
| 919 | sites that use AFS, this distinction is handled automatically. |
| 920 | However, sites that use software such as depot to manage software |
| 921 | packages, or users building binary packages for distribution may also |
| 922 | wish to install perl into a different directory and use that |
| 923 | management software to move perl to its final destination. This |
| 924 | section describes how to do that. |
| 925 | |
| 926 | Suppose you want to install perl under the /tmp/perl5 directory. You |
| 927 | could edit config.sh and change all the install* variables to point to |
| 928 | /tmp/perl5 instead of /usr/local, or you could simply use the |
| 929 | following command line: |
| 930 | |
| 931 | sh Configure -Dinstallprefix=/tmp/perl5 |
| 932 | |
| 933 | (replace /tmp/perl5 by a directory of your choice). |
| 934 | |
| 935 | Beware, though, that if you go to try to install new add-on |
| 936 | modules, they too will get installed in under '/tmp/perl5' if you |
| 937 | follow this example. The next section shows one way of dealing with |
| 938 | that problem. |
| 939 | |
| 940 | =head2 Creating an installable tar archive |
| 941 | |
| 942 | If you need to install perl on many identical systems, it is convenient |
| 943 | to compile it once and create an archive that can be installed on |
| 944 | multiple systems. Suppose, for example, that you want to create an |
| 945 | archive that can be installed in /opt/perl. One way to do that is by |
| 946 | using the DESTDIR variable during C<make install>. The DESTDIR is |
| 947 | automatically prepended to all the installation paths. Thus you |
| 948 | simply do: |
| 949 | |
| 950 | sh Configure -Dprefix=/opt/perl -des |
| 951 | make |
| 952 | make test |
| 953 | make install DESTDIR=/tmp/perl5 |
| 954 | cd /tmp/perl5/opt/perl |
| 955 | tar cvf /tmp/perl5-archive.tar . |
| 956 | |
| 957 | =head2 Site-wide Policy settings |
| 958 | |
| 959 | After Configure runs, it stores a number of common site-wide "policy" |
| 960 | answers (such as installation directories and the local perl contact |
| 961 | person) in the Policy.sh file. If you want to build perl on another |
| 962 | system using the same policy defaults, simply copy the Policy.sh file |
| 963 | to the new system and Configure will use it along with the appropriate |
| 964 | hint file for your system. |
| 965 | |
| 966 | Alternatively, if you wish to change some or all of those policy |
| 967 | answers, you should |
| 968 | |
| 969 | rm -f Policy.sh |
| 970 | |
| 971 | to ensure that Configure doesn't re-use them. |
| 972 | |
| 973 | Further information is in the Policy_sh.SH file itself. |
| 974 | |
| 975 | If the generated Policy.sh file is unsuitable, you may freely edit it |
| 976 | to contain any valid shell commands. It will be run just after the |
| 977 | platform-specific hints files. |
| 978 | |
| 979 | =head2 Disabling older versions of Perl |
| 980 | |
| 981 | Configure will search for binary compatible versions of previously |
| 982 | installed perl binaries in the tree that is specified as target tree |
| 983 | and these will be used by the perl being built. |
| 984 | See L<"Coexistence with earlier versions of perl5"> for more details. |
| 985 | |
| 986 | To disable this use of older perl modules, even completely valid pure perl |
| 987 | modules, you can specify to not include the paths found: |
| 988 | |
| 989 | sh Configure -Dinc_version_list=none ... |
| 990 | |
| 991 | When using the newer perl, you can add these paths again in the |
| 992 | $PERL5LIB environment variable or with perl's -I runtime option. |
| 993 | |
| 994 | =head2 Building Perl outside of the source directory |
| 995 | |
| 996 | Sometimes it is desirable to build Perl in a directory different from |
| 997 | where the sources are, for example if you want to keep your sources |
| 998 | read-only, or if you want to share the sources between different binary |
| 999 | architectures. You can do this (if your file system supports symbolic |
| 1000 | links) by |
| 1001 | |
| 1002 | mkdir /tmp/perl/build/directory |
| 1003 | cd /tmp/perl/build/directory |
| 1004 | sh /path/to/perl/source/Configure -Dmksymlinks ... |
| 1005 | |
| 1006 | This will create in /tmp/perl/build/directory a tree of symbolic links |
| 1007 | pointing to files in /path/to/perl/source. The original files are left |
| 1008 | unaffected. After Configure has finished you can just say |
| 1009 | |
| 1010 | make |
| 1011 | |
| 1012 | as usual, and Perl will be built in /tmp/perl/build/directory. |
| 1013 | |
| 1014 | =head2 Building a debugging perl |
| 1015 | |
| 1016 | You can run perl scripts under the perl debugger at any time with |
| 1017 | B<perl -d your_script>. If, however, you want to debug perl itself, |
| 1018 | you probably want to do |
| 1019 | |
| 1020 | sh Configure -Doptimize='-g' |
| 1021 | |
| 1022 | This will do two independent things: First, it will force compilation |
| 1023 | to use cc -g so that you can use your system's debugger on the |
| 1024 | executable. (Note: Your system may actually require something like |
| 1025 | cc -g2. Check your man pages for cc(1) and also any hint file for |
| 1026 | your system.) Second, it will add -DDEBUGGING to your ccflags |
| 1027 | variable in config.sh so that you can use B<perl -D> to access perl's |
| 1028 | internal state. (Note: Configure will only add -DDEBUGGING by default |
| 1029 | if you are not reusing your old config.sh. If you want to reuse your |
| 1030 | old config.sh, then you can just edit it and change the optimize and |
| 1031 | ccflags variables by hand and then propagate your changes as shown in |
| 1032 | L<"Propagating your changes to config.sh"> below.) |
| 1033 | |
| 1034 | You can actually specify -g and -DDEBUGGING independently, but usually |
| 1035 | it's convenient to have both. |
| 1036 | |
| 1037 | If you are using a shared libperl, see the warnings about multiple |
| 1038 | versions of perl under L<Building a shared Perl library>. |
| 1039 | |
| 1040 | =head2 Extensions |
| 1041 | |
| 1042 | Perl ships with a number of standard extensions. These are contained |
| 1043 | in the ext/ subdirectory. |
| 1044 | |
| 1045 | By default, Configure will offer to build every extension which appears |
| 1046 | to be supported. For example, Configure will offer to build GDBM_File |
| 1047 | only if it is able to find the gdbm library. (See examples below.) |
| 1048 | Configure does not contain code to test for POSIX compliance, so POSIX |
| 1049 | is always built by default. If you wish to skip POSIX, you can |
| 1050 | set the Configure variable useposix=false from the Configure command line. |
| 1051 | |
| 1052 | If you unpack any additional extensions in the ext/ directory before |
| 1053 | running Configure, then Configure will offer to build those additional |
| 1054 | extensions as well. Most users probably shouldn't have to do this -- |
| 1055 | it is usually easier to build additional extensions later after perl |
| 1056 | has been installed. However, if you wish to have those additional |
| 1057 | extensions statically linked into the perl binary, then this offers a |
| 1058 | convenient way to do that in one step. (It is not necessary, however; |
| 1059 | you can build and install extensions just fine even if you don't have |
| 1060 | dynamic loading. See lib/ExtUtils/MakeMaker.pm for more details.) |
| 1061 | |
| 1062 | If you have dynamic loading, another way of specifying extra modules |
| 1063 | is described in L<"Adding extra modules to the build"> below. |
| 1064 | |
| 1065 | You can learn more about each of the supplied extensions by consulting the |
| 1066 | documentation in the individual .pm modules, located under the |
| 1067 | ext/ subdirectory. |
| 1068 | |
| 1069 | Even if you do not have dynamic loading, you must still build the |
| 1070 | DynaLoader extension; you should just build the stub dl_none.xs |
| 1071 | version. Configure will suggest this as the default. |
| 1072 | |
| 1073 | To disable certain extensions so that they are not built, use the |
| 1074 | -Dnoextensions=... and -Donlyextensions=... options. They both accept |
| 1075 | a space-separated list of extensions. The extensions listed in |
| 1076 | C<noextensions> are removed from the list of extensions to build, while |
| 1077 | the C<onlyextensions> is rather more severe and builds only the listed |
| 1078 | extensions. The latter should be used with extreme caution since |
| 1079 | certain extensions are used by many other extensions and modules: |
| 1080 | examples of such modules include Fcntl and IO. The order of processing |
| 1081 | these options is first C<only> (if present), then C<no> (if present). |
| 1082 | |
| 1083 | Of course, you may always run Configure interactively and select only |
| 1084 | the extensions you want. |
| 1085 | |
| 1086 | Note: The DB_File module will only work with version 1.x of Berkeley |
| 1087 | DB or newer releases of version 2. Configure will automatically detect |
| 1088 | this for you and refuse to try to build DB_File with earlier |
| 1089 | releases of version 2. |
| 1090 | |
| 1091 | If you re-use your old config.sh but change your system (e.g. by |
| 1092 | adding libgdbm) Configure will still offer your old choices of extensions |
| 1093 | for the default answer, but it will also point out the discrepancy to |
| 1094 | you. |
| 1095 | |
| 1096 | Finally, if you have dynamic loading (most modern systems do) |
| 1097 | remember that these extensions do not increase the size of your perl |
| 1098 | executable, nor do they impact start-up time, so you probably might as |
| 1099 | well build all the ones that will work on your system. |
| 1100 | |
| 1101 | =head2 Including locally-installed libraries |
| 1102 | |
| 1103 | Perl5 comes with interfaces to number of database extensions, including |
| 1104 | dbm, ndbm, gdbm, and Berkeley db. For each extension, if |
| 1105 | Configure can find the appropriate header files and libraries, it will |
| 1106 | automatically include that extension. The gdbm and db libraries |
| 1107 | are not included with perl. See the library documentation for |
| 1108 | how to obtain the libraries. |
| 1109 | |
| 1110 | If your database header (.h) files are not in a directory normally |
| 1111 | searched by your C compiler, then you will need to include the |
| 1112 | appropriate -I/your/directory option when prompted by Configure. If |
| 1113 | your database libraries are not in a directory normally |
| 1114 | searched by your C compiler and linker, then you will need to include |
| 1115 | the appropriate -L/your/directory option when prompted by Configure. |
| 1116 | See the examples below. |
| 1117 | |
| 1118 | =head3 Examples |
| 1119 | |
| 1120 | =over 4 |
| 1121 | |
| 1122 | =item gdbm in /usr/local |
| 1123 | |
| 1124 | Suppose you have gdbm and want Configure to find it and build the |
| 1125 | GDBM_File extension. This example assumes you have gdbm.h |
| 1126 | installed in /usr/local/include/gdbm.h and libgdbm.a installed in |
| 1127 | /usr/local/lib/libgdbm.a. Configure should figure all the |
| 1128 | necessary steps out automatically. |
| 1129 | |
| 1130 | Specifically, when Configure prompts you for flags for |
| 1131 | your C compiler, you should include -I/usr/local/include. |
| 1132 | |
| 1133 | When Configure prompts you for linker flags, you should include |
| 1134 | -L/usr/local/lib. |
| 1135 | |
| 1136 | If you are using dynamic loading, then when Configure prompts you for |
| 1137 | linker flags for dynamic loading, you should again include |
| 1138 | -L/usr/local/lib. |
| 1139 | |
| 1140 | Again, this should all happen automatically. This should also work if |
| 1141 | you have gdbm installed in any of (/usr/local, /opt/local, /usr/gnu, |
| 1142 | /opt/gnu, /usr/GNU, or /opt/GNU). |
| 1143 | |
| 1144 | =item gdbm in /usr/you |
| 1145 | |
| 1146 | Suppose you have gdbm installed in some place other than /usr/local/, |
| 1147 | but you still want Configure to find it. To be specific, assume you |
| 1148 | have /usr/you/include/gdbm.h and /usr/you/lib/libgdbm.a. You |
| 1149 | still have to add -I/usr/you/include to cc flags, but you have to take |
| 1150 | an extra step to help Configure find libgdbm.a. Specifically, when |
| 1151 | Configure prompts you for library directories, you have to add |
| 1152 | /usr/you/lib to the list. |
| 1153 | |
| 1154 | It is possible to specify this from the command line too (all on one |
| 1155 | line): |
| 1156 | |
| 1157 | sh Configure -de \ |
| 1158 | -Dlocincpth="/usr/you/include" \ |
| 1159 | -Dloclibpth="/usr/you/lib" |
| 1160 | |
| 1161 | locincpth is a space-separated list of include directories to search. |
| 1162 | Configure will automatically add the appropriate -I directives. |
| 1163 | |
| 1164 | loclibpth is a space-separated list of library directories to search. |
| 1165 | Configure will automatically add the appropriate -L directives. If |
| 1166 | you have some libraries under /usr/local/ and others under |
| 1167 | /usr/you, then you have to include both, namely |
| 1168 | |
| 1169 | sh Configure -de \ |
| 1170 | -Dlocincpth="/usr/you/include /usr/local/include" \ |
| 1171 | -Dloclibpth="/usr/you/lib /usr/local/lib" |
| 1172 | |
| 1173 | =back |
| 1174 | |
| 1175 | =head2 Building DB, NDBM, and ODBM interfaces with Berkeley DB 3 |
| 1176 | |
| 1177 | A Perl interface for DB3 is part of Berkeley DB, but if you want to |
| 1178 | compile the standard Perl DB/ODBM/NDBM interfaces, you must follow |
| 1179 | following instructions. |
| 1180 | |
| 1181 | Berkeley DB3 from Sleepycat Software is by default installed without |
| 1182 | DB1 compatibility code (needed for the DB_File interface) and without |
| 1183 | links to compatibility files. So if you want to use packages written |
| 1184 | for the DB/ODBM/NDBM interfaces, you need to configure DB3 with |
| 1185 | --enable-compat185 (and optionally with --enable-dump185) and create |
| 1186 | additional references (suppose you are installing DB3 with |
| 1187 | --prefix=/usr): |
| 1188 | |
| 1189 | ln -s libdb-3.so /usr/lib/libdbm.so |
| 1190 | ln -s libdb-3.so /usr/lib/libndbm.so |
| 1191 | echo '#define DB_DBM_HSEARCH 1' >dbm.h |
| 1192 | echo '#include <db.h>' >>dbm.h |
| 1193 | install -m 0644 dbm.h /usr/include/dbm.h |
| 1194 | install -m 0644 dbm.h /usr/include/ndbm.h |
| 1195 | |
| 1196 | Optionally, if you have compiled with --enable-compat185 (not needed |
| 1197 | for ODBM/NDBM): |
| 1198 | |
| 1199 | ln -s libdb-3.so /usr/lib/libdb1.so |
| 1200 | ln -s libdb-3.so /usr/lib/libdb.so |
| 1201 | |
| 1202 | ODBM emulation seems not to be perfect, but is quite usable, |
| 1203 | using DB 3.1.17: |
| 1204 | |
| 1205 | lib/odbm.............FAILED at test 9 |
| 1206 | Failed 1/64 tests, 98.44% okay |
| 1207 | |
| 1208 | =head2 Overriding an old config.sh |
| 1209 | |
| 1210 | If you want to use your old config.sh but override some of the items |
| 1211 | with command line options, you need to use B<Configure -O>. |
| 1212 | |
| 1213 | =head2 GNU-style configure |
| 1214 | |
| 1215 | If you prefer the GNU-style configure command line interface, you can |
| 1216 | use the supplied configure.gnu command, e.g. |
| 1217 | |
| 1218 | CC=gcc ./configure.gnu |
| 1219 | |
| 1220 | The configure.gnu script emulates a few of the more common configure |
| 1221 | options. Try |
| 1222 | |
| 1223 | ./configure.gnu --help |
| 1224 | |
| 1225 | for a listing. |
| 1226 | |
| 1227 | (The file is called configure.gnu to avoid problems on systems |
| 1228 | that would not distinguish the files "Configure" and "configure".) |
| 1229 | |
| 1230 | See L<Cross-compilation> below for information on cross-compiling. |
| 1231 | |
| 1232 | =head2 Malloc Issues |
| 1233 | |
| 1234 | Perl relies heavily on malloc(3) to grow data structures as needed, |
| 1235 | so perl's performance can be noticeably affected by the performance of |
| 1236 | the malloc function on your system. The perl source is shipped with a |
| 1237 | version of malloc that has been optimized for the typical requests from |
| 1238 | perl, so there's a chance that it may be both faster and use less memory |
| 1239 | than your system malloc. |
| 1240 | |
| 1241 | However, if your system already has an excellent malloc, or if you are |
| 1242 | experiencing difficulties with extensions that use third-party libraries |
| 1243 | that call malloc, then you should probably use your system's malloc. |
| 1244 | (Or, you might wish to explore the malloc flags discussed below.) |
| 1245 | |
| 1246 | =over 4 |
| 1247 | |
| 1248 | =item Using the system malloc |
| 1249 | |
| 1250 | To build without perl's malloc, you can use the Configure command |
| 1251 | |
| 1252 | sh Configure -Uusemymalloc |
| 1253 | |
| 1254 | or you can answer 'n' at the appropriate interactive Configure prompt. |
| 1255 | |
| 1256 | =item -DPERL_POLLUTE_MALLOC |
| 1257 | |
| 1258 | NOTE: This flag is enabled automatically on some platforms if you just |
| 1259 | run Configure to accept all the defaults on those platforms. |
| 1260 | |
| 1261 | Perl's malloc family of functions are normally called Perl_malloc(), |
| 1262 | Perl_realloc(), Perl_calloc() and Perl_mfree(). |
| 1263 | These names do not clash with the system versions of these functions. |
| 1264 | |
| 1265 | If this flag is enabled, however, Perl's malloc family of functions |
| 1266 | will have the same names as the system versions. This may be required |
| 1267 | sometimes if you have libraries that like to free() data that may have |
| 1268 | been allocated by Perl_malloc() and vice versa. |
| 1269 | |
| 1270 | Note that enabling this option may sometimes lead to duplicate symbols |
| 1271 | from the linker for malloc et al. In such cases, the system probably |
| 1272 | does not allow its malloc functions to be fully replaced with custom |
| 1273 | versions. |
| 1274 | |
| 1275 | =item -DPERL_DEBUGGING_MSTATS |
| 1276 | |
| 1277 | This flag enables debugging mstats, which is required to use the |
| 1278 | Devel::Peek::mstat() function. You cannot enable this unless you are |
| 1279 | using Perl's malloc, so a typical Configure command would be |
| 1280 | |
| 1281 | sh Configure -Accflags=-DPERL_DEBUGGING_MSTATS -Dusemymalloc='y' |
| 1282 | |
| 1283 | to enable this option. |
| 1284 | |
| 1285 | =back |
| 1286 | |
| 1287 | =head2 What if it doesn't work? |
| 1288 | |
| 1289 | If you run into problems, try some of the following ideas. |
| 1290 | If none of them help, then see L<"Reporting Problems"> above. |
| 1291 | |
| 1292 | =over 4 |
| 1293 | |
| 1294 | =item Running Configure Interactively |
| 1295 | |
| 1296 | If Configure runs into trouble, remember that you can always run |
| 1297 | Configure interactively so that you can check (and correct) its |
| 1298 | guesses. |
| 1299 | |
| 1300 | All the installation questions have been moved to the top, so you don't |
| 1301 | have to wait for them. Once you've handled them (and your C compiler and |
| 1302 | flags) you can type &-d at the next Configure prompt and Configure |
| 1303 | will use the defaults from then on. |
| 1304 | |
| 1305 | If you find yourself trying obscure command line incantations and |
| 1306 | config.over tricks, I recommend you run Configure interactively |
| 1307 | instead. You'll probably save yourself time in the long run. |
| 1308 | |
| 1309 | =item Hint files |
| 1310 | |
| 1311 | The perl distribution includes a number of system-specific hints files |
| 1312 | in the hints/ directory. If one of them matches your system, Configure |
| 1313 | will offer to use that hint file. |
| 1314 | |
| 1315 | Several of the hint files contain additional important information. |
| 1316 | If you have any problems, it is a good idea to read the relevant hint file |
| 1317 | for further information. See hints/solaris_2.sh for an extensive example. |
| 1318 | More information about writing good hints is in the hints/README.hints |
| 1319 | file. |
| 1320 | |
| 1321 | =item *** WHOA THERE!!! *** |
| 1322 | |
| 1323 | Occasionally, Configure makes a wrong guess. For example, on SunOS |
| 1324 | 4.1.3, Configure incorrectly concludes that tzname[] is in the |
| 1325 | standard C library. The hint file is set up to correct for this. You |
| 1326 | will see a message: |
| 1327 | |
| 1328 | *** WHOA THERE!!! *** |
| 1329 | The recommended value for $d_tzname on this machine was "undef"! |
| 1330 | Keep the recommended value? [y] |
| 1331 | |
| 1332 | You should always keep the recommended value unless, after reading the |
| 1333 | relevant section of the hint file, you are sure you want to try |
| 1334 | overriding it. |
| 1335 | |
| 1336 | If you are re-using an old config.sh, the word "previous" will be |
| 1337 | used instead of "recommended". Again, you will almost always want |
| 1338 | to keep the previous value, unless you have changed something on your |
| 1339 | system. |
| 1340 | |
| 1341 | For example, suppose you have added libgdbm.a to your system |
| 1342 | and you decide to reconfigure perl to use GDBM_File. When you run |
| 1343 | Configure again, you will need to add -lgdbm to the list of libraries. |
| 1344 | Now, Configure will find your gdbm include file and library and will |
| 1345 | issue a message: |
| 1346 | |
| 1347 | *** WHOA THERE!!! *** |
| 1348 | The previous value for $i_gdbm on this machine was "undef"! |
| 1349 | Keep the previous value? [y] |
| 1350 | |
| 1351 | In this case, you do not want to keep the previous value, so you |
| 1352 | should answer 'n'. (You'll also have to manually add GDBM_File to |
| 1353 | the list of dynamic extensions to build.) |
| 1354 | |
| 1355 | =item Changing Compilers |
| 1356 | |
| 1357 | If you change compilers or make other significant changes, you should |
| 1358 | probably not re-use your old config.sh. Simply remove it or |
| 1359 | rename it, e.g. mv config.sh config.sh.old. Then rerun Configure |
| 1360 | with the options you want to use. |
| 1361 | |
| 1362 | This is a common source of problems. If you change from cc to |
| 1363 | gcc, you should almost always remove your old config.sh. |
| 1364 | |
| 1365 | =item Propagating your changes to config.sh |
| 1366 | |
| 1367 | If you make any changes to config.sh, you should propagate |
| 1368 | them to all the .SH files by running |
| 1369 | |
| 1370 | sh Configure -S |
| 1371 | |
| 1372 | You will then have to rebuild by running |
| 1373 | |
| 1374 | make depend |
| 1375 | make |
| 1376 | |
| 1377 | =item config.over and config.arch |
| 1378 | |
| 1379 | You can also supply a shell script config.over to over-ride |
| 1380 | Configure's guesses. It will get loaded up at the very end, just |
| 1381 | before config.sh is created. You have to be careful with this, |
| 1382 | however, as Configure does no checking that your changes make sense. |
| 1383 | This file is usually good for site-specific customizations. |
| 1384 | |
| 1385 | There is also another file that, if it exists, is loaded before the |
| 1386 | config.over, called config.arch. This file is intended to be per |
| 1387 | architecture, not per site, and usually it's the architecture-specific |
| 1388 | hints file that creates the config.arch. |
| 1389 | |
| 1390 | =item config.h |
| 1391 | |
| 1392 | Many of the system dependencies are contained in config.h. |
| 1393 | Configure builds config.h by running the config_h.SH script. |
| 1394 | The values for the variables are taken from config.sh. |
| 1395 | |
| 1396 | If there are any problems, you can edit config.h directly. Beware, |
| 1397 | though, that the next time you run Configure, your changes will be |
| 1398 | lost. |
| 1399 | |
| 1400 | =item cflags |
| 1401 | |
| 1402 | If you have any additional changes to make to the C compiler command |
| 1403 | line, they can be made in cflags.SH. For instance, to turn off the |
| 1404 | optimizer on toke.c, find the line in the switch structure for |
| 1405 | toke.c and put the command optimize='-g' before the ;; . You |
| 1406 | can also edit cflags directly, but beware that your changes will be |
| 1407 | lost the next time you run Configure. |
| 1408 | |
| 1409 | To explore various ways of changing ccflags from within a hint file, |
| 1410 | see the file hints/README.hints. |
| 1411 | |
| 1412 | To change the C flags for all the files, edit config.sh and change either |
| 1413 | $ccflags or $optimize, and then re-run |
| 1414 | |
| 1415 | sh Configure -S |
| 1416 | make depend |
| 1417 | |
| 1418 | =item No sh |
| 1419 | |
| 1420 | If you don't have sh, you'll have to copy the sample file |
| 1421 | Porting/config.sh to config.sh and edit your config.sh to reflect your |
| 1422 | system's peculiarities. See Porting/pumpkin.pod for more information. |
| 1423 | You'll probably also have to extensively modify the extension building |
| 1424 | mechanism. |
| 1425 | |
| 1426 | =item Digital UNIX/Tru64 UNIX and BIN_SH |
| 1427 | |
| 1428 | In Digital UNIX/Tru64 UNIX, Configure might abort with |
| 1429 | |
| 1430 | Build a threading Perl? [n] |
| 1431 | Configure[2437]: Syntax error at line 1 : `config.sh' is not expected. |
| 1432 | |
| 1433 | This indicates that Configure is being run with a broken Korn shell |
| 1434 | (even though you think you are using a Bourne shell by using |
| 1435 | "sh Configure" or "./Configure"). The Korn shell bug has been reported |
| 1436 | to Compaq as of February 1999 but in the meanwhile, the reason ksh is |
| 1437 | being used is that you have the environment variable BIN_SH set to |
| 1438 | 'xpg4'. This causes /bin/sh to delegate its duties to /bin/posix/sh |
| 1439 | (a ksh). Unset the environment variable and rerun Configure. |
| 1440 | |
| 1441 | =item HP-UX 11, pthreads, and libgdbm |
| 1442 | |
| 1443 | If you are running Configure with -Dusethreads in HP-UX 11, be warned |
| 1444 | that POSIX threads and libgdbm (the GNU dbm library) compiled before |
| 1445 | HP-UX 11 do not mix. This will cause a basic test run by Configure to |
| 1446 | fail |
| 1447 | |
| 1448 | Pthread internal error: message: __libc_reinit() failed, file: ../pthreads/pthread.c, line: 1096 |
| 1449 | Return Pointer is 0xc082bf33 |
| 1450 | sh: 5345 Quit(coredump) |
| 1451 | |
| 1452 | and Configure will give up. The cure is to recompile and install |
| 1453 | libgdbm under HP-UX 11. |
| 1454 | |
| 1455 | =item Porting information |
| 1456 | |
| 1457 | Specific information for the OS/2, Plan 9, VMS and Win32 ports is in the |
| 1458 | corresponding README files and subdirectories. Additional information, |
| 1459 | including a glossary of all those config.sh variables, is in the Porting |
| 1460 | subdirectory. Porting/Glossary should especially come in handy. |
| 1461 | |
| 1462 | Ports for other systems may also be available. You should check out |
| 1463 | http://www.cpan.org/ports for current information on ports to |
| 1464 | various other operating systems. |
| 1465 | |
| 1466 | If you plan to port Perl to a new architecture, study carefully the |
| 1467 | section titled "Philosophical Issues in Patching and Porting Perl" |
| 1468 | in the file Porting/pumpkin.pod and the file Porting/patching.pod. |
| 1469 | Study also how other non-UNIX ports have solved problems. |
| 1470 | |
| 1471 | =back |
| 1472 | |
| 1473 | =head2 Adding extra modules to the build |
| 1474 | |
| 1475 | You can specify extra modules or module bundles to be fetched from the |
| 1476 | CPAN and installed as part of the Perl build. Either use the -Dextras=... |
| 1477 | command line parameter to Configure, for example like this: |
| 1478 | |
| 1479 | Configure -Dextras="Compress::Zlib Bundle::LWP DBI" |
| 1480 | |
| 1481 | or answer first 'y' to the question 'Install any extra modules?' and |
| 1482 | then answer "Compress::Zlib Bundle::LWP DBI" to the 'Extras?' question. |
| 1483 | The module or the bundle names are as for the CPAN module 'install' command. |
| 1484 | This will only work if those modules are to be built as dynamic |
| 1485 | extensions. If you wish to include those extra modules as static |
| 1486 | extensions, see L<"Extensions"> above. |
| 1487 | |
| 1488 | Notice that because the CPAN module will be used to fetch the extra |
| 1489 | modules, you will need access to the CPAN, either via the Internet, |
| 1490 | or via a local copy such as a CD-ROM or a local CPAN mirror. If you |
| 1491 | do not, using the extra modules option will die horribly. |
| 1492 | |
| 1493 | Also notice that you yourself are responsible for satisfying any extra |
| 1494 | dependencies such as external headers or libraries BEFORE trying the build. |
| 1495 | For example: you will need to have the zlib.h header and the libz |
| 1496 | library installed for the Compress::Zlib, or the Foo database specific |
| 1497 | headers and libraries installed for the DBD::Foo module. The Configure |
| 1498 | process or the Perl build process will not help you with these. |
| 1499 | |
| 1500 | =head2 suidperl |
| 1501 | |
| 1502 | suidperl is an optional component, which is normally neither built |
| 1503 | nor installed by default. From perlfaq1: |
| 1504 | |
| 1505 | On some systems, setuid and setgid scripts (scripts written |
| 1506 | in the C shell, Bourne shell, or Perl, for example, with the |
| 1507 | set user or group ID permissions enabled) are insecure due to |
| 1508 | a race condition in the kernel. For those systems, Perl versions |
| 1509 | 5 and 4 attempt to work around this vulnerability with an optional |
| 1510 | component, a special program named suidperl, also known as sperl. |
| 1511 | This program attempts to emulate the set-user-ID and set-group-ID |
| 1512 | features of the kernel. |
| 1513 | |
| 1514 | Because of the buggy history of suidperl, and the difficulty |
| 1515 | of properly security auditing as large and complex piece of |
| 1516 | software as Perl, we cannot recommend using suidperl and the feature |
| 1517 | should be considered deprecated. |
| 1518 | Instead, use a tool specifically designed to handle changes in |
| 1519 | privileges, such as B<sudo>, http://www.courtesan.com/sudo/ . |
| 1520 | |
| 1521 | =head1 make depend |
| 1522 | |
| 1523 | This will look for all the includes. The output is stored in makefile. |
| 1524 | The only difference between Makefile and makefile is the dependencies at |
| 1525 | the bottom of makefile. If you have to make any changes, you should edit |
| 1526 | makefile, not Makefile, since the Unix make command reads makefile first. |
| 1527 | (On non-Unix systems, the output may be stored in a different file. |
| 1528 | Check the value of $firstmakefile in your config.sh if in doubt.) |
| 1529 | |
| 1530 | Configure will offer to do this step for you, so it isn't listed |
| 1531 | explicitly above. |
| 1532 | |
| 1533 | =head1 make |
| 1534 | |
| 1535 | This will attempt to make perl in the current directory. |
| 1536 | |
| 1537 | =head2 Expected errors |
| 1538 | |
| 1539 | These errors are normal, and can be ignored: |
| 1540 | |
| 1541 | ... |
| 1542 | make: [extra.pods] Error 1 (ignored) |
| 1543 | ... |
| 1544 | make: [extras.make] Error 1 (ignored) |
| 1545 | |
| 1546 | =head2 What if it doesn't work? |
| 1547 | |
| 1548 | If you can't compile successfully, try some of the following ideas. |
| 1549 | If none of them help, and careful reading of the error message and |
| 1550 | the relevant manual pages on your system doesn't help, |
| 1551 | then see L<"Reporting Problems"> above. |
| 1552 | |
| 1553 | =over 4 |
| 1554 | |
| 1555 | =item hints |
| 1556 | |
| 1557 | If you used a hint file, try reading the comments in the hint file |
| 1558 | for further tips and information. |
| 1559 | |
| 1560 | =item extensions |
| 1561 | |
| 1562 | If you can successfully build miniperl, but the process crashes |
| 1563 | during the building of extensions, run |
| 1564 | |
| 1565 | make minitest |
| 1566 | |
| 1567 | to test your version of miniperl. |
| 1568 | |
| 1569 | =item locale |
| 1570 | |
| 1571 | If you have any locale-related environment variables set, try unsetting |
| 1572 | them. I have some reports that some versions of IRIX hang while |
| 1573 | running B<./miniperl configpm> with locales other than the C locale. |
| 1574 | See the discussion under L<"make test"> below about locales and the |
| 1575 | whole L<"Locale problems"> section in the file pod/perllocale.pod. |
| 1576 | The latter is especially useful if you see something like this |
| 1577 | |
| 1578 | perl: warning: Setting locale failed. |
| 1579 | perl: warning: Please check that your locale settings: |
| 1580 | LC_ALL = "En_US", |
| 1581 | LANG = (unset) |
| 1582 | are supported and installed on your system. |
| 1583 | perl: warning: Falling back to the standard locale ("C"). |
| 1584 | |
| 1585 | at Perl startup. |
| 1586 | |
| 1587 | =item varargs |
| 1588 | |
| 1589 | If you get varargs problems with gcc, be sure that gcc is installed |
| 1590 | correctly and that you are not passing -I/usr/include to gcc. When using |
| 1591 | gcc, you should probably have i_stdarg='define' and i_varargs='undef' |
| 1592 | in config.sh. The problem is usually solved by installing gcc |
| 1593 | correctly. If you do change config.sh, don't forget to propagate |
| 1594 | your changes (see L<"Propagating your changes to config.sh"> below). |
| 1595 | See also the L<"vsprintf"> item below. |
| 1596 | |
| 1597 | =item util.c |
| 1598 | |
| 1599 | If you get error messages such as the following (the exact line |
| 1600 | numbers and function name may vary in different versions of perl): |
| 1601 | |
| 1602 | util.c: In function `Perl_form': |
| 1603 | util.c:1107: number of arguments doesn't match prototype |
| 1604 | proto.h:125: prototype declaration |
| 1605 | |
| 1606 | it might well be a symptom of the gcc "varargs problem". See the |
| 1607 | previous L<"varargs"> item. |
| 1608 | |
| 1609 | =item LD_LIBRARY_PATH |
| 1610 | |
| 1611 | If you run into dynamic loading problems, check your setting of |
| 1612 | the LD_LIBRARY_PATH environment variable. If you're creating a static |
| 1613 | Perl library (libperl.a rather than libperl.so) it should build |
| 1614 | fine with LD_LIBRARY_PATH unset, though that may depend on details |
| 1615 | of your local set-up. |
| 1616 | |
| 1617 | =item nm extraction |
| 1618 | |
| 1619 | If Configure seems to be having trouble finding library functions, |
| 1620 | try not using nm extraction. You can do this from the command line |
| 1621 | with |
| 1622 | |
| 1623 | sh Configure -Uusenm |
| 1624 | |
| 1625 | or by answering the nm extraction question interactively. |
| 1626 | If you have previously run Configure, you should not reuse your old |
| 1627 | config.sh. |
| 1628 | |
| 1629 | =item umask not found |
| 1630 | |
| 1631 | If the build processes encounters errors relating to umask(), the problem |
| 1632 | is probably that Configure couldn't find your umask() system call. |
| 1633 | Check your config.sh. You should have d_umask='define'. If you don't, |
| 1634 | this is probably the L<"nm extraction"> problem discussed above. Also, |
| 1635 | try reading the hints file for your system for further information. |
| 1636 | |
| 1637 | =item vsprintf |
| 1638 | |
| 1639 | If you run into problems with vsprintf in compiling util.c, the |
| 1640 | problem is probably that Configure failed to detect your system's |
| 1641 | version of vsprintf(). Check whether your system has vprintf(). |
| 1642 | (Virtually all modern Unix systems do.) Then, check the variable |
| 1643 | d_vprintf in config.sh. If your system has vprintf, it should be: |
| 1644 | |
| 1645 | d_vprintf='define' |
| 1646 | |
| 1647 | If Configure guessed wrong, it is likely that Configure guessed wrong |
| 1648 | on a number of other common functions too. This is probably |
| 1649 | the L<"nm extraction"> problem discussed above. |
| 1650 | |
| 1651 | =item do_aspawn |
| 1652 | |
| 1653 | If you run into problems relating to do_aspawn or do_spawn, the |
| 1654 | problem is probably that Configure failed to detect your system's |
| 1655 | fork() function. Follow the procedure in the previous item |
| 1656 | on L<"nm extraction">. |
| 1657 | |
| 1658 | =item __inet_* errors |
| 1659 | |
| 1660 | If you receive unresolved symbol errors during Perl build and/or test |
| 1661 | referring to __inet_* symbols, check to see whether BIND 8.1 is |
| 1662 | installed. It installs a /usr/local/include/arpa/inet.h that refers to |
| 1663 | these symbols. Versions of BIND later than 8.1 do not install inet.h |
| 1664 | in that location and avoid the errors. You should probably update to a |
| 1665 | newer version of BIND (and remove the files the old one left behind). |
| 1666 | If you can't, you can either link with the updated resolver library provided |
| 1667 | with BIND 8.1 or rename /usr/local/bin/arpa/inet.h during the Perl build and |
| 1668 | test process to avoid the problem. |
| 1669 | |
| 1670 | =item *_r() prototype NOT found |
| 1671 | |
| 1672 | On a related note, if you see a bunch of complaints like the above about |
| 1673 | reentrant functions - specifically networking-related ones - being present |
| 1674 | but without prototypes available, check to see if BIND 8.1 (or possibly |
| 1675 | other BIND 8 versions) is (or has been) installed. They install |
| 1676 | header files such as netdb.h into places such as /usr/local/include (or into |
| 1677 | another directory as specified at build/install time), at least optionally. |
| 1678 | Remove them or put them in someplace that isn't in the C preprocessor's |
| 1679 | header file include search path (determined by -I options plus defaults, |
| 1680 | normally /usr/include). |
| 1681 | |
| 1682 | =item #error "No DATAMODEL_NATIVE specified" |
| 1683 | |
| 1684 | This is a common error when trying to build perl on Solaris 2.6 with a |
| 1685 | gcc installation from Solaris 2.5 or 2.5.1. The Solaris header files |
| 1686 | changed, so you need to update your gcc installation. You can either |
| 1687 | rerun the fixincludes script from gcc or take the opportunity to |
| 1688 | update your gcc installation. |
| 1689 | |
| 1690 | =item Optimizer |
| 1691 | |
| 1692 | If you can't compile successfully, try turning off your compiler's |
| 1693 | optimizer. Edit config.sh and change the line |
| 1694 | |
| 1695 | optimize='-O' |
| 1696 | |
| 1697 | to |
| 1698 | |
| 1699 | optimize=' ' |
| 1700 | |
| 1701 | then propagate your changes with B<sh Configure -S> and rebuild |
| 1702 | with B<make depend; make>. |
| 1703 | |
| 1704 | =item Missing functions and Undefined symbols |
| 1705 | |
| 1706 | If the build of miniperl fails with a long list of missing functions or |
| 1707 | undefined symbols, check the libs variable in the config.sh file. It |
| 1708 | should look something like |
| 1709 | |
| 1710 | libs='-lsocket -lnsl -ldl -lm -lc' |
| 1711 | |
| 1712 | The exact libraries will vary from system to system, but you typically |
| 1713 | need to include at least the math library -lm. Normally, Configure |
| 1714 | will suggest the correct defaults. If the libs variable is empty, you |
| 1715 | need to start all over again. Run |
| 1716 | |
| 1717 | make distclean |
| 1718 | |
| 1719 | and start from the very beginning. This time, unless you are sure of |
| 1720 | what you are doing, accept the default list of libraries suggested by |
| 1721 | Configure. |
| 1722 | |
| 1723 | If the libs variable looks correct, you might have the |
| 1724 | L<"nm extraction"> problem discussed above. |
| 1725 | |
| 1726 | If you stil have missing routines or undefined symbols, you probably |
| 1727 | need to add some library or other, or you need to undefine some feature |
| 1728 | that Configure thought was there but is defective or incomplete. If |
| 1729 | you used a hint file, see if it has any relevant advice. You can also |
| 1730 | look through through config.h for likely suspects. |
| 1731 | |
| 1732 | =item toke.c |
| 1733 | |
| 1734 | Some compilers will not compile or optimize the larger files (such as |
| 1735 | toke.c) without some extra switches to use larger jump offsets or |
| 1736 | allocate larger internal tables. You can customize the switches for |
| 1737 | each file in cflags. It's okay to insert rules for specific files into |
| 1738 | makefile since a default rule only takes effect in the absence of a |
| 1739 | specific rule. |
| 1740 | |
| 1741 | =item Missing dbmclose |
| 1742 | |
| 1743 | SCO prior to 3.2.4 may be missing dbmclose(). An upgrade to 3.2.4 |
| 1744 | that includes libdbm.nfs (which includes dbmclose()) may be available. |
| 1745 | |
| 1746 | =item Note (probably harmless): No library found for -lsomething |
| 1747 | |
| 1748 | If you see such a message during the building of an extension, but |
| 1749 | the extension passes its tests anyway (see L<"make test"> below), |
| 1750 | then don't worry about the warning message. The extension |
| 1751 | Makefile.PL goes looking for various libraries needed on various |
| 1752 | systems; few systems will need all the possible libraries listed. |
| 1753 | For example, a system may have -lcposix or -lposix, but it's |
| 1754 | unlikely to have both, so most users will see warnings for the one |
| 1755 | they don't have. The phrase 'probably harmless' is intended to |
| 1756 | reassure you that nothing unusual is happening, and the build |
| 1757 | process is continuing. |
| 1758 | |
| 1759 | On the other hand, if you are building GDBM_File and you get the |
| 1760 | message |
| 1761 | |
| 1762 | Note (probably harmless): No library found for -lgdbm |
| 1763 | |
| 1764 | then it's likely you're going to run into trouble somewhere along |
| 1765 | the line, since it's hard to see how you can use the GDBM_File |
| 1766 | extension without the -lgdbm library. |
| 1767 | |
| 1768 | It is true that, in principle, Configure could have figured all of |
| 1769 | this out, but Configure and the extension building process are not |
| 1770 | quite that tightly coordinated. |
| 1771 | |
| 1772 | =item sh: ar: not found |
| 1773 | |
| 1774 | This is a message from your shell telling you that the command 'ar' |
| 1775 | was not found. You need to check your PATH environment variable to |
| 1776 | make sure that it includes the directory with the 'ar' command. This |
| 1777 | is a common problem on Solaris, where 'ar' is in the /usr/ccs/bin |
| 1778 | directory. |
| 1779 | |
| 1780 | =item db-recno failure on tests 51, 53 and 55 |
| 1781 | |
| 1782 | Old versions of the DB library (including the DB library which comes |
| 1783 | with FreeBSD 2.1) had broken handling of recno databases with modified |
| 1784 | bval settings. Upgrade your DB library or OS. |
| 1785 | |
| 1786 | =item Bad arg length for semctl, is XX, should be ZZZ |
| 1787 | |
| 1788 | If you get this error message from the ext/IPC/SysV/t/sem test, your System |
| 1789 | V IPC may be broken. The XX typically is 20, and that is what ZZZ |
| 1790 | also should be. Consider upgrading your OS, or reconfiguring your OS |
| 1791 | to include the System V semaphores. |
| 1792 | |
| 1793 | =item ext/IPC/SysV/t/sem........semget: No space left on device |
| 1794 | |
| 1795 | Either your account or the whole system has run out of semaphores. Or |
| 1796 | both. Either list the semaphores with "ipcs" and remove the unneeded |
| 1797 | ones (which ones these are depends on your system and applications) |
| 1798 | with "ipcrm -s SEMAPHORE_ID_HERE" or configure more semaphores to your |
| 1799 | system. |
| 1800 | |
| 1801 | =item GNU binutils |
| 1802 | |
| 1803 | If you mix GNU binutils (nm, ld, ar) with equivalent vendor-supplied |
| 1804 | tools you may be in for some trouble. For example creating archives |
| 1805 | with an old GNU 'ar' and then using a new current vendor-supplied 'ld' |
| 1806 | may lead into linking problems. Either recompile your GNU binutils |
| 1807 | under your current operating system release, or modify your PATH not |
| 1808 | to include the GNU utils before running Configure, or specify the |
| 1809 | vendor-supplied utilities explicitly to Configure, for example by |
| 1810 | Configure -Dar=/bin/ar. |
| 1811 | |
| 1812 | =item THIS PACKAGE SEEMS TO BE INCOMPLETE |
| 1813 | |
| 1814 | The F<Configure> program has not been able to find all the files which |
| 1815 | make up the complete Perl distribution. You may have a damaged source |
| 1816 | archive file (in which case you may also have seen messages such as |
| 1817 | C<gzip: stdin: unexpected end of file> and C<tar: Unexpected EOF on |
| 1818 | archive file>), or you may have obtained a structurally-sound but |
| 1819 | incomplete archive. In either case, try downloading again from the |
| 1820 | official site named at the start of this document. If you do find |
| 1821 | that any site is carrying a corrupted or incomplete source code |
| 1822 | archive, please report it to the site's maintainer. |
| 1823 | |
| 1824 | =item invalid token: ## |
| 1825 | |
| 1826 | You are using a non-ANSI-compliant C compiler. To compile Perl, you |
| 1827 | need to use a compiler that supports ANSI C. If there is a README |
| 1828 | file for your system, it may have further details on your compiler |
| 1829 | options. |
| 1830 | |
| 1831 | =item Miscellaneous |
| 1832 | |
| 1833 | Some additional things that have been reported for either perl4 or perl5: |
| 1834 | |
| 1835 | Genix may need to use libc rather than libc_s, or #undef VARARGS. |
| 1836 | |
| 1837 | NCR Tower 32 (OS 2.01.01) may need -W2,-Sl,2000 and #undef MKDIR. |
| 1838 | |
| 1839 | UTS may need one or more of -K or -g, and undef LSTAT. |
| 1840 | |
| 1841 | FreeBSD can fail the ext/IPC/SysV/t/sem.t test if SysV IPC has not been |
| 1842 | configured in the kernel. Perl tries to detect this, though, and |
| 1843 | you will get a message telling you what to do. |
| 1844 | |
| 1845 | HP-UX 11 Y2K patch "Y2K-1100 B.11.00.B0125 HP-UX Core OS Year 2000 |
| 1846 | Patch Bundle" has been reported to break the io/fs test #18 which |
| 1847 | tests whether utime() can change timestamps. The Y2K patch seems to |
| 1848 | break utime() so that over NFS the timestamps do not get changed |
| 1849 | (on local filesystems utime() still works). |
| 1850 | |
| 1851 | Building Perl on a system that has also BIND (headers and libraries) |
| 1852 | installed may run into troubles because BIND installs its own netdb.h |
| 1853 | and socket.h, which may not agree with the operating system's ideas of |
| 1854 | the same files. Similarly, including -lbind may conflict with libc's |
| 1855 | view of the world. You may have to tweak -Dlocincpth and -Dloclibpth |
| 1856 | to avoid the BIND. |
| 1857 | |
| 1858 | =back |
| 1859 | |
| 1860 | =head2 Cross-compilation |
| 1861 | |
| 1862 | Perl can be cross-compiled. It is just not trivial, cross-compilation |
| 1863 | rarely is. Perl is routinely cross-compiled for many platforms (as of |
| 1864 | June 2005 at least PocketPC aka WinCE, Open Zaurus, EPOC, Symbian, and |
| 1865 | the IBM OS/400). These platforms are known as the B<target> platforms, |
| 1866 | while the systems where the compilation takes place are the B<host> |
| 1867 | platforms. |
| 1868 | |
| 1869 | What makes the situation difficult is that first of all, |
| 1870 | cross-compilation environments vary significantly in how they are set |
| 1871 | up and used, and secondly because the primary way of configuring Perl |
| 1872 | (using the rather large Unix-tool-dependent Configure script) is not |
| 1873 | awfully well suited for cross-compilation. However, starting from |
| 1874 | version 5.8.0, the Configure script also knows one way of supporting |
| 1875 | cross-compilation support, please keep reading. |
| 1876 | |
| 1877 | See the following files for more information about compiling Perl for |
| 1878 | the particular platforms: |
| 1879 | |
| 1880 | =over 4 |
| 1881 | |
| 1882 | =item WinCE/PocketPC |
| 1883 | |
| 1884 | README.ce, wince/README.perlce |
| 1885 | |
| 1886 | =item Open Zaurus |
| 1887 | |
| 1888 | Cross/README |
| 1889 | |
| 1890 | =item EPOC |
| 1891 | |
| 1892 | README.epoc |
| 1893 | |
| 1894 | =item Symbian |
| 1895 | |
| 1896 | README.symbian |
| 1897 | |
| 1898 | =item OS/400 |
| 1899 | |
| 1900 | README.os400 |
| 1901 | |
| 1902 | =back |
| 1903 | |
| 1904 | Packaging and transferring either the core Perl modules or CPAN |
| 1905 | modules to the target platform is also left up to the each |
| 1906 | cross-compilation environment. Often the cross-compilation target |
| 1907 | platforms are somewhat limited in diskspace: see the section |
| 1908 | L<Minimizing the Perl installation> to learn more of the minimal set |
| 1909 | of files required for a functional Perl installation. |
| 1910 | |
| 1911 | For some cross-compilation environments the Configure option |
| 1912 | C<-Dinstallprefix=...> might be handy, see L<Changing the installation |
| 1913 | directory>. |
| 1914 | |
| 1915 | About the cross-compilation support of Configure: what is known to |
| 1916 | work is running Configure in a cross-compilation environment and |
| 1917 | building the miniperl executable. What is known not to work is |
| 1918 | building the perl executable because that would require building |
| 1919 | extensions: Dynaloader statically and File::Glob dynamically, for |
| 1920 | extensions one needs MakeMaker and MakeMaker is not yet |
| 1921 | cross-compilation aware, and neither is the main Makefile. |
| 1922 | |
| 1923 | The cross-compilation setup of Configure has successfully been used in |
| 1924 | at least two Linux cross-compilation environments. The setups were |
| 1925 | both such that the host system was Intel Linux with a gcc built for |
| 1926 | cross-compiling into ARM Linux, and there was a SSH connection to the |
| 1927 | target system. |
| 1928 | |
| 1929 | To run Configure in cross-compilation mode the basic switch that |
| 1930 | has to be used is C<-Dusecrosscompile>. |
| 1931 | |
| 1932 | sh ./Configure -des -Dusecrosscompile -D... |
| 1933 | |
| 1934 | This will make the cpp symbol USE_CROSS_COMPILE and the %Config |
| 1935 | symbol C<usecrosscompile> available. |
| 1936 | |
| 1937 | During the Configure and build, certain helper scripts will be created |
| 1938 | into the Cross/ subdirectory. The scripts are used to execute a |
| 1939 | cross-compiled executable, and to transfer files to and from the |
| 1940 | target host. The execution scripts are named F<run-*> and the |
| 1941 | transfer scripts F<to-*> and F<from-*>. The part after the dash is |
| 1942 | the method to use for remote execution and transfer: by default the |
| 1943 | methods are B<ssh> and B<scp>, thus making the scripts F<run-ssh>, |
| 1944 | F<to-scp>, and F<from-scp>. |
| 1945 | |
| 1946 | To configure the scripts for a target host and a directory (in which |
| 1947 | the execution will happen and which is to and from where the transfer |
| 1948 | happens), supply Configure with |
| 1949 | |
| 1950 | -Dtargethost=so.me.ho.st -Dtargetdir=/tar/get/dir |
| 1951 | |
| 1952 | The targethost is what e.g. ssh will use as the hostname, the targetdir |
| 1953 | must exist (the scripts won't create it), the targetdir defaults to /tmp. |
| 1954 | You can also specify a username to use for ssh/rsh logins |
| 1955 | |
| 1956 | -Dtargetuser=luser |
| 1957 | |
| 1958 | but in case you don't, "root" will be used. |
| 1959 | |
| 1960 | Because this is a cross-compilation effort, you will also need to specify |
| 1961 | which target environment and which compilation environment to use. |
| 1962 | This includes the compiler, the header files, and the libraries. |
| 1963 | In the below we use the usual settings for the iPAQ cross-compilation |
| 1964 | environment: |
| 1965 | |
| 1966 | -Dtargetarch=arm-linux |
| 1967 | -Dcc=arm-linux-gcc |
| 1968 | -Dusrinc=/skiff/local/arm-linux/include |
| 1969 | -Dincpth=/skiff/local/arm-linux/include |
| 1970 | -Dlibpth=/skiff/local/arm-linux/lib |
| 1971 | |
| 1972 | If the name of the C<cc> has the usual GNU C semantics for cross |
| 1973 | compilers, that is, CPU-OS-gcc, the names of the C<ar>, C<nm>, and |
| 1974 | C<ranlib> will also be automatically chosen to be CPU-OS-ar and so on. |
| 1975 | (The C<ld> requires more thought and will be chosen later by Configure |
| 1976 | as appropriate.) Also, in this case the incpth, libpth, and usrinc |
| 1977 | will be guessed by Configure (unless explicitly set to something else, |
| 1978 | in which case Configure's guesses with be appended). |
| 1979 | |
| 1980 | In addition to the default execution/transfer methods you can also |
| 1981 | choose B<rsh> for execution, and B<rcp> or B<cp> for transfer, |
| 1982 | for example: |
| 1983 | |
| 1984 | -Dtargetrun=rsh -Dtargetto=rcp -Dtargetfrom=cp |
| 1985 | |
| 1986 | Putting it all together: |
| 1987 | |
| 1988 | sh ./Configure -des -Dusecrosscompile \ |
| 1989 | -Dtargethost=so.me.ho.st \ |
| 1990 | -Dtargetdir=/tar/get/dir \ |
| 1991 | -Dtargetuser=root \ |
| 1992 | -Dtargetarch=arm-linux \ |
| 1993 | -Dcc=arm-linux-gcc \ |
| 1994 | -Dusrinc=/skiff/local/arm-linux/include \ |
| 1995 | -Dincpth=/skiff/local/arm-linux/include \ |
| 1996 | -Dlibpth=/skiff/local/arm-linux/lib \ |
| 1997 | -D... |
| 1998 | |
| 1999 | or if you are happy with the defaults: |
| 2000 | |
| 2001 | sh ./Configure -des -Dusecrosscompile \ |
| 2002 | -Dtargethost=so.me.ho.st \ |
| 2003 | -Dcc=arm-linux-gcc \ |
| 2004 | -D... |
| 2005 | |
| 2006 | Another example where the cross-compiler has been installed under |
| 2007 | F</usr/local/arm/2.95.5>: |
| 2008 | |
| 2009 | sh ./Configure -des -Dusecrosscompile \ |
| 2010 | -Dtargethost=so.me.ho.st \ |
| 2011 | -Dcc=/usr/local/arm/2.95.5/bin/arm-linux-gcc \ |
| 2012 | -Dincpth=/usr/local/arm/2.95.5/include \ |
| 2013 | -Dusrinc=/usr/local/arm/2.95.5/include \ |
| 2014 | -Dlibpth=/usr/local/arm/2.95.5/lib |
| 2015 | |
| 2016 | =head1 make test |
| 2017 | |
| 2018 | This will run the regression tests on the perl you just made. If |
| 2019 | 'make test' doesn't say "All tests successful" then something went |
| 2020 | wrong. See the file t/README in the t subdirectory. |
| 2021 | |
| 2022 | Note that you can't run the tests in background if this disables |
| 2023 | opening of /dev/tty. You can use 'make test-notty' in that case but |
| 2024 | a few tty tests will be skipped. |
| 2025 | |
| 2026 | =head2 What if make test doesn't work? |
| 2027 | |
| 2028 | If make test bombs out, just cd to the t directory and run ./TEST |
| 2029 | by hand to see if it makes any difference. If individual tests |
| 2030 | bomb, you can run them by hand, e.g., |
| 2031 | |
| 2032 | ./perl op/groups.t |
| 2033 | |
| 2034 | Another way to get more detailed information about failed tests and |
| 2035 | individual subtests is to cd to the t directory and run |
| 2036 | |
| 2037 | ./perl harness |
| 2038 | |
| 2039 | (this assumes that most basic tests succeed, since harness uses |
| 2040 | complicated constructs). For extension and library tests you |
| 2041 | need a little bit more: you need to setup your environment variable |
| 2042 | PERL_CORE to a true value (like "1"), and you need to supply the |
| 2043 | right Perl library path: |
| 2044 | |
| 2045 | setenv PERL_CORE 1 |
| 2046 | ./perl -I../lib ../ext/Socket/Socket.t |
| 2047 | ./perl -I../lib ../lib/less.t |
| 2048 | |
| 2049 | (For csh-like shells on UNIX; adjust appropriately for other platforms.) |
| 2050 | You should also read the individual tests to see if there are any helpful |
| 2051 | comments that apply to your system. You may also need to setup your |
| 2052 | shared library path if you get errors like: |
| 2053 | |
| 2054 | /sbin/loader: Fatal Error: cannot map libperl.so |
| 2055 | |
| 2056 | See L</"Building a shared Perl library"> earlier in this document. |
| 2057 | |
| 2058 | =over 4 |
| 2059 | |
| 2060 | =item locale |
| 2061 | |
| 2062 | Note: One possible reason for errors is that some external programs |
| 2063 | may be broken due to the combination of your environment and the way |
| 2064 | B<make test> exercises them. For example, this may happen if you have |
| 2065 | one or more of these environment variables set: LC_ALL LC_CTYPE |
| 2066 | LC_COLLATE LANG. In some versions of UNIX, the non-English locales |
| 2067 | are known to cause programs to exhibit mysterious errors. |
| 2068 | |
| 2069 | If you have any of the above environment variables set, please try |
| 2070 | |
| 2071 | setenv LC_ALL C |
| 2072 | |
| 2073 | (for C shell) or |
| 2074 | |
| 2075 | LC_ALL=C;export LC_ALL |
| 2076 | |
| 2077 | for Bourne or Korn shell) from the command line and then retry |
| 2078 | make test. If the tests then succeed, you may have a broken program that |
| 2079 | is confusing the testing. Please run the troublesome test by hand as |
| 2080 | shown above and see whether you can locate the program. Look for |
| 2081 | things like: exec, `backquoted command`, system, open("|...") or |
| 2082 | open("...|"). All these mean that Perl is trying to run some |
| 2083 | external program. |
| 2084 | |
| 2085 | =item Timing problems |
| 2086 | |
| 2087 | Several tests in the test suite check timing functions, such as |
| 2088 | sleep(), and see if they return in a reasonable amount of time. |
| 2089 | If your system is quite busy and doesn't respond quickly enough, |
| 2090 | these tests might fail. If possible, try running the tests again |
| 2091 | with the system under a lighter load. These timing-sensitive |
| 2092 | and load-sensitive tests include F<t/op/alarm.t>, |
| 2093 | F<ext/Time/HiRes/HiRes.t>, F<lib/Benchmark.t>, |
| 2094 | F<lib/Memoize/t/expmod_t.t>, and F<lib/Memoize/t/speed.t>. |
| 2095 | |
| 2096 | =item Out of memory |
| 2097 | |
| 2098 | On some systems, particularly those with smaller amounts of RAM, some |
| 2099 | of the tests in t/op/pat.t may fail with an "Out of memory" message. |
| 2100 | For example, on my SparcStation IPC with 12 MB of RAM, in perl5.5.670, |
| 2101 | test 85 will fail if run under either t/TEST or t/harness. |
| 2102 | |
| 2103 | Try stopping other jobs on the system and then running the test by itself: |
| 2104 | |
| 2105 | cd t; ./perl op/pat.t |
| 2106 | |
| 2107 | to see if you have any better luck. If your perl still fails this |
| 2108 | test, it does not necessarily mean you have a broken perl. This test |
| 2109 | tries to exercise the regular expression subsystem quite thoroughly, |
| 2110 | and may well be far more demanding than your normal usage. |
| 2111 | |
| 2112 | =item Failures from lib/File/Temp/t/security saying "system possibly insecure" |
| 2113 | |
| 2114 | First, such warnings are not necessarily serious or indicative of a |
| 2115 | real security threat. That being said, they bear investigating. |
| 2116 | |
| 2117 | Note that each of the tests is run twice. The first time is in the |
| 2118 | directory returned by File::Spec->tmpdir() (often /tmp on Unix |
| 2119 | systems), and the second time in the directory from which the test was |
| 2120 | run (usually the 't' directory, if the test was run as part of 'make |
| 2121 | test'). |
| 2122 | |
| 2123 | The tests may fail for the following reasons: |
| 2124 | |
| 2125 | (1) If the directory the tests are being run in is owned by somebody |
| 2126 | other than the user running the tests, or by root (uid 0). |
| 2127 | |
| 2128 | This failure can happen if the Perl source code distribution is |
| 2129 | unpacked in such a way that the user ids in the distribution package |
| 2130 | are used as-is. Some tar programs do this. |
| 2131 | |
| 2132 | (2) If the directory the tests are being run in is writable by group or |
| 2133 | by others, and there is no sticky bit set for the directory. (With |
| 2134 | UNIX/POSIX semantics, write access to a directory means the right to |
| 2135 | add or remove files in that directory. The 'sticky bit' is a feature |
| 2136 | used in some UNIXes to give extra protection to files: if the bit is |
| 2137 | set for a directory, no one but the owner (or root) can remove that |
| 2138 | file even if the permissions would otherwise allow file removal by |
| 2139 | others.) |
| 2140 | |
| 2141 | This failure may or may not be a real problem: it depends on the |
| 2142 | permissions policy used on this particular system. This failure can |
| 2143 | also happen if the system either doesn't support the sticky bit (this |
| 2144 | is the case with many non-UNIX platforms: in principle File::Temp |
| 2145 | should know about these platforms and skip the tests), or if the system |
| 2146 | supports the sticky bit but for some reason or reasons it is not being |
| 2147 | used. This is, for example, the case with HP-UX: as of HP-UX release |
| 2148 | 11.00, the sticky bit is very much supported, but HP-UX doesn't use it |
| 2149 | on its /tmp directory as shipped. Also, as with the permissions, some |
| 2150 | local policy might dictate that the stickiness is not used. |
| 2151 | |
| 2152 | (3) If the system supports the POSIX 'chown giveaway' feature and if |
| 2153 | any of the parent directories of the temporary file back to the root |
| 2154 | directory are 'unsafe', using the definitions given above in (1) and |
| 2155 | (2). For Unix systems, this is usually not an issue if you are |
| 2156 | building on a local disk. See the documentation for the File::Temp |
| 2157 | module for more information about 'chown giveaway'. |
| 2158 | |
| 2159 | See the documentation for the File::Temp module for more information |
| 2160 | about the various security aspects of temporary files. |
| 2161 | |
| 2162 | =back |
| 2163 | |
| 2164 | =head1 make install |
| 2165 | |
| 2166 | This will put perl into the public directory you specified to |
| 2167 | Configure; by default this is /usr/local/bin. It will also try |
| 2168 | to put the man pages in a reasonable place. It will not nroff the man |
| 2169 | pages, however. You may need to be root to run B<make install>. If you |
| 2170 | are not root, you must still have permission to install into the directories |
| 2171 | in question and you should ignore any messages about chown not working. |
| 2172 | |
| 2173 | If "make install" just says "`install' is up to date" or something |
| 2174 | similar, you may be on a case-insensitive filesystems such as Mac's HFS+, |
| 2175 | and you should say "make install-all". (This confusion is brought to you |
| 2176 | by the Perl distribution having a file called INSTALL.) |
| 2177 | |
| 2178 | =head2 Installing perl under different names |
| 2179 | |
| 2180 | If you want to install perl under a name other than "perl" (for example, |
| 2181 | when installing perl with special features enabled, such as debugging), |
| 2182 | indicate the alternate name on the "make install" line, such as: |
| 2183 | |
| 2184 | make install PERLNAME=myperl |
| 2185 | |
| 2186 | You can separately change the base used for versioned names (like |
| 2187 | "perl5.005") by setting PERLNAME_VERBASE, like |
| 2188 | |
| 2189 | make install PERLNAME=perl5 PERLNAME_VERBASE=perl |
| 2190 | |
| 2191 | This can be useful if you have to install perl as "perl5" (e.g. to |
| 2192 | avoid conflicts with an ancient version in /usr/bin supplied by your vendor). |
| 2193 | Without this the versioned binary would be called "perl55.005". |
| 2194 | |
| 2195 | =head2 Installing perl under a different directory |
| 2196 | |
| 2197 | You can install perl under a different destination directory by using |
| 2198 | the DESTDIR variable during C<make install>, with a command like |
| 2199 | |
| 2200 | make install DESTDIR=/tmp/perl5 |
| 2201 | |
| 2202 | DESTDIR is automatically prepended to all the installation paths. See |
| 2203 | the example in L<"Creating an installable tar archive"> above. |
| 2204 | |
| 2205 | |
| 2206 | =head2 Installed files |
| 2207 | |
| 2208 | If you want to see exactly what will happen without installing |
| 2209 | anything, you can run |
| 2210 | |
| 2211 | ./perl installperl -n |
| 2212 | ./perl installman -n |
| 2213 | |
| 2214 | make install will install the following: |
| 2215 | |
| 2216 | binaries |
| 2217 | |
| 2218 | perl, |
| 2219 | perl5.nnn where nnn is the current release number. This |
| 2220 | will be a link to perl. |
| 2221 | suidperl, |
| 2222 | sperl5.nnn If you requested setuid emulation. |
| 2223 | a2p awk-to-perl translator |
| 2224 | |
| 2225 | scripts |
| 2226 | |
| 2227 | cppstdin This is used by perl -P, if your cc -E can't |
| 2228 | read from stdin. |
| 2229 | c2ph, pstruct Scripts for handling C structures in header files. |
| 2230 | s2p sed-to-perl translator |
| 2231 | find2perl find-to-perl translator |
| 2232 | h2ph Extract constants and simple macros from C headers |
| 2233 | h2xs Converts C .h header files to Perl extensions. |
| 2234 | perlbug Tool to report bugs in Perl. |
| 2235 | perldoc Tool to read perl's pod documentation. |
| 2236 | pl2pm Convert Perl 4 .pl files to Perl 5 .pm modules |
| 2237 | pod2html, Converters from perl's pod documentation format |
| 2238 | pod2latex, to other useful formats. |
| 2239 | pod2man, |
| 2240 | pod2text, |
| 2241 | pod2checker, |
| 2242 | pod2select, |
| 2243 | pod2usage |
| 2244 | splain Describe Perl warnings and errors |
| 2245 | dprofpp Perl code profile post-processor |
| 2246 | |
| 2247 | library files |
| 2248 | |
| 2249 | in $privlib and $archlib specified to |
| 2250 | Configure, usually under /usr/local/lib/perl5/. |
| 2251 | |
| 2252 | documentation |
| 2253 | |
| 2254 | man pages in $man1dir, usually /usr/local/man/man1. |
| 2255 | module man |
| 2256 | pages in $man3dir, usually /usr/local/man/man3. |
| 2257 | pod/*.pod in $privlib/pod/. |
| 2258 | |
| 2259 | Installperl will also create the directories listed above |
| 2260 | in L<"Installation Directories">. |
| 2261 | |
| 2262 | Perl's *.h header files and the libperl library are also installed |
| 2263 | under $archlib so that any user may later build new modules, run the |
| 2264 | optional Perl compiler, or embed the perl interpreter into another |
| 2265 | program even if the Perl source is no longer available. |
| 2266 | |
| 2267 | Sometimes you only want to install the version-specific parts of the perl |
| 2268 | installation. For example, you may wish to install a newer version of |
| 2269 | perl alongside an already installed production version of perl without |
| 2270 | disabling installation of new modules for the production version. |
| 2271 | To only install the version-specific parts of the perl installation, run |
| 2272 | |
| 2273 | Configure -Dversiononly |
| 2274 | |
| 2275 | or answer 'y' to the appropriate Configure prompt. Alternatively, |
| 2276 | you can just manually run |
| 2277 | |
| 2278 | ./perl installperl -v |
| 2279 | |
| 2280 | and skip installman altogether. |
| 2281 | See also L<"Maintaining completely separate versions"> for another |
| 2282 | approach. |
| 2283 | |
| 2284 | =head1 Coexistence with earlier versions of perl5 |
| 2285 | |
| 2286 | Perl 5.9 is not binary compatible with earlier versions of Perl. |
| 2287 | In other words, you will have to recompile your XS modules. |
| 2288 | |
| 2289 | In general, you can usually safely upgrade from one version of Perl (e.g. |
| 2290 | 5.8.0) to another similar version (e.g. 5.8.2) without re-compiling |
| 2291 | all of your add-on extensions. You can also safely leave the old version |
| 2292 | around in case the new version causes you problems for some reason. |
| 2293 | For example, if you want to be sure that your script continues to run |
| 2294 | with 5.8.2, simply replace the '#!/usr/local/bin/perl' line at the |
| 2295 | top of the script with the particular version you want to run, e.g. |
| 2296 | #!/usr/local/bin/perl5.8.2. |
| 2297 | |
| 2298 | Usually, most extensions will probably not need to be recompiled to use |
| 2299 | with a newer version of Perl Here is how it is supposed to work. |
| 2300 | (These examples assume you accept all the Configure defaults.) |
| 2301 | |
| 2302 | Suppose you already have version 5.005_03 installed. The directories |
| 2303 | searched by 5.005_03 are |
| 2304 | |
| 2305 | /usr/local/lib/perl5/5.00503/$archname |
| 2306 | /usr/local/lib/perl5/5.00503 |
| 2307 | /usr/local/lib/perl5/site_perl/5.005/$archname |
| 2308 | /usr/local/lib/perl5/site_perl/5.005 |
| 2309 | |
| 2310 | Beginning with 5.6.0 the version number in the site libraries are |
| 2311 | fully versioned. Now, suppose you install version 5.6.0. The directories |
| 2312 | searched by version 5.6.0 will be |
| 2313 | |
| 2314 | /usr/local/lib/perl5/5.6.0/$archname |
| 2315 | /usr/local/lib/perl5/5.6.0 |
| 2316 | /usr/local/lib/perl5/site_perl/5.6.0/$archname |
| 2317 | /usr/local/lib/perl5/site_perl/5.6.0 |
| 2318 | |
| 2319 | /usr/local/lib/perl5/site_perl/5.005/$archname |
| 2320 | /usr/local/lib/perl5/site_perl/5.005 |
| 2321 | /usr/local/lib/perl5/site_perl/ |
| 2322 | |
| 2323 | Notice the last three entries -- Perl understands the default structure |
| 2324 | of the $sitelib directories and will look back in older, compatible |
| 2325 | directories. This way, modules installed under 5.005_03 will continue |
| 2326 | to be usable by 5.005_03 but will also accessible to 5.6.0. Further, |
| 2327 | suppose that you upgrade a module to one which requires features |
| 2328 | present only in 5.6.0. That new module will get installed into |
| 2329 | /usr/local/lib/perl5/site_perl/5.6.0 and will be available to 5.6.0, |
| 2330 | but will not interfere with the 5.005_03 version. |
| 2331 | |
| 2332 | The last entry, /usr/local/lib/perl5/site_perl/, is there so that |
| 2333 | 5.6.0 and above will look for 5.004-era pure perl modules. |
| 2334 | |
| 2335 | Lastly, suppose you now install 5.8.0, which is not binary compatible |
| 2336 | with 5.6.0. The directories searched by 5.8.0 (if you don't change the |
| 2337 | Configure defaults) will be: |
| 2338 | |
| 2339 | /usr/local/lib/perl5/5.8.0/$archname |
| 2340 | /usr/local/lib/perl5/5.8.0 |
| 2341 | /usr/local/lib/perl5/site_perl/5.8.0/$archname |
| 2342 | /usr/local/lib/perl5/site_perl/5.8.0 |
| 2343 | |
| 2344 | /usr/local/lib/perl5/site_perl/5.6.0 |
| 2345 | |
| 2346 | /usr/local/lib/perl5/site_perl/5.005 |
| 2347 | |
| 2348 | /usr/local/lib/perl5/site_perl/ |
| 2349 | |
| 2350 | Note that the earlier $archname entries are now gone, but pure perl |
| 2351 | modules from earlier versions will still be found. |
| 2352 | |
| 2353 | Assuming the users in your site are still actively using perl 5.6.0 and |
| 2354 | 5.005 after you installed 5.8.0, you can continue to install add-on |
| 2355 | extensions using any of perl 5.8.0, 5.6.0, or 5.005. The installations |
| 2356 | of these different versions remain distinct, but remember that the |
| 2357 | newer versions of perl are automatically set up to search the |
| 2358 | compatible site libraries of the older ones. This means that |
| 2359 | installing a new XS extension with 5.005 will make it visible to both |
| 2360 | 5.005 and 5.6.0, but not to 5.8.0. Installing a pure perl module with |
| 2361 | 5.005 will make it visible to all three versions. Later, if you |
| 2362 | install the same extension using, say, perl 5.8.0, it will override the |
| 2363 | 5.005-installed version, but only for perl 5.8.0. |
| 2364 | |
| 2365 | This way, you can choose to share compatible extensions, but also upgrade |
| 2366 | to a newer version of an extension that may be incompatible with earlier |
| 2367 | versions, without breaking the earlier versions' installations. |
| 2368 | |
| 2369 | =head2 Maintaining completely separate versions |
| 2370 | |
| 2371 | Many users prefer to keep all versions of perl in completely |
| 2372 | separate directories. This guarantees that an update to one version |
| 2373 | won't interfere with another version. (The defaults guarantee this for |
| 2374 | libraries after 5.6.0, but not for executables. TODO?) One convenient |
| 2375 | way to do this is by using a separate prefix for each version, such as |
| 2376 | |
| 2377 | sh Configure -Dprefix=/opt/perl5.8.2 |
| 2378 | |
| 2379 | and adding /opt/perl5.8.2/bin to the shell PATH variable. Such users |
| 2380 | may also wish to add a symbolic link /usr/local/bin/perl so that |
| 2381 | scripts can still start with #!/usr/local/bin/perl. |
| 2382 | |
| 2383 | Others might share a common directory for maintenance sub-versions |
| 2384 | (e.g. 5.8 for all 5.8.x versions), but change directory with |
| 2385 | each major version. |
| 2386 | |
| 2387 | If you are installing a development subversion, you probably ought to |
| 2388 | seriously consider using a separate directory, since development |
| 2389 | subversions may not have all the compatibility wrinkles ironed out |
| 2390 | yet. |
| 2391 | |
| 2392 | =head2 Upgrading from 5.005 or 5.6 to 5.8.0 |
| 2393 | |
| 2394 | B<Perl 5.9.0 is binary incompatible with Perl 5.8.x, Perl 5.6.x, 5.005, |
| 2395 | and any earlier Perl release.> Perl modules having binary parts |
| 2396 | (meaning that a C compiler is used) will have to be recompiled to be |
| 2397 | used with 5.9.0. If you find you do need to rebuild an extension with |
| 2398 | 5.9.0, you may safely do so without disturbing the older |
| 2399 | installations. (See L<"Coexistence with earlier versions of perl5"> |
| 2400 | above.) |
| 2401 | |
| 2402 | See your installed copy of the perllocal.pod file for a (possibly |
| 2403 | incomplete) list of locally installed modules. Note that you want |
| 2404 | perllocal.pod, not perllocale.pod, for installed module information. |
| 2405 | |
| 2406 | =head1 Coexistence with perl4 |
| 2407 | |
| 2408 | You can safely install perl5 even if you want to keep perl4 around. |
| 2409 | |
| 2410 | By default, the perl5 libraries go into /usr/local/lib/perl5/, so |
| 2411 | they don't override the perl4 libraries in /usr/local/lib/perl/. |
| 2412 | |
| 2413 | In your /usr/local/bin directory, you should have a binary named |
| 2414 | perl4.036. That will not be touched by the perl5 installation |
| 2415 | process. Most perl4 scripts should run just fine under perl5. |
| 2416 | However, if you have any scripts that require perl4, you can replace |
| 2417 | the #! line at the top of them by #!/usr/local/bin/perl4.036 (or |
| 2418 | whatever the appropriate pathname is). See L<perltrap> for |
| 2419 | possible problems running perl4 scripts under perl5. |
| 2420 | |
| 2421 | =head1 cd /usr/include; h2ph *.h sys/*.h |
| 2422 | |
| 2423 | Some perl scripts need to be able to obtain information from the |
| 2424 | system header files. This command will convert the most commonly used |
| 2425 | header files in /usr/include into files that can be easily interpreted |
| 2426 | by perl. These files will be placed in the architecture-dependent |
| 2427 | library ($archlib) directory you specified to Configure. |
| 2428 | |
| 2429 | Note: Due to differences in the C and perl languages, the conversion |
| 2430 | of the header files is not perfect. You will probably have to |
| 2431 | hand-edit some of the converted files to get them to parse correctly. |
| 2432 | For example, h2ph breaks spectacularly on type casting and certain |
| 2433 | structures. |
| 2434 | |
| 2435 | =head1 installhtml --help |
| 2436 | |
| 2437 | Some sites may wish to make perl documentation available in HTML |
| 2438 | format. The installhtml utility can be used to convert pod |
| 2439 | documentation into linked HTML files and install them. |
| 2440 | |
| 2441 | Currently, the supplied ./installhtml script does not make use of the |
| 2442 | html Configure variables. This should be fixed in a future release. |
| 2443 | |
| 2444 | The following command-line is an example of one used to convert |
| 2445 | perl documentation: |
| 2446 | |
| 2447 | ./installhtml \ |
| 2448 | --podroot=. \ |
| 2449 | --podpath=lib:ext:pod:vms \ |
| 2450 | --recurse \ |
| 2451 | --htmldir=/perl/nmanual \ |
| 2452 | --htmlroot=/perl/nmanual \ |
| 2453 | --splithead=pod/perlipc \ |
| 2454 | --splititem=pod/perlfunc \ |
| 2455 | --libpods=perlfunc:perlguts:perlvar:perlrun:perlop \ |
| 2456 | --verbose |
| 2457 | |
| 2458 | See the documentation in installhtml for more details. It can take |
| 2459 | many minutes to execute a large installation and you should expect to |
| 2460 | see warnings like "no title", "unexpected directive" and "cannot |
| 2461 | resolve" as the files are processed. We are aware of these problems |
| 2462 | (and would welcome patches for them). |
| 2463 | |
| 2464 | You may find it helpful to run installhtml twice. That should reduce |
| 2465 | the number of "cannot resolve" warnings. |
| 2466 | |
| 2467 | =head1 cd pod && make tex && (process the latex files) |
| 2468 | |
| 2469 | Some sites may also wish to make the documentation in the pod/ directory |
| 2470 | available in TeX format. Type |
| 2471 | |
| 2472 | (cd pod && make tex && <process the latex files>) |
| 2473 | |
| 2474 | =head1 Minimizing the Perl installation |
| 2475 | |
| 2476 | The following section is meant for people worrying about squeezing the |
| 2477 | Perl installation into minimal systems (for example when installing |
| 2478 | operating systems, or in really small filesystems). |
| 2479 | |
| 2480 | Leaving out as many extensions as possible is an obvious way: |
| 2481 | Encode, with its big conversion tables, consumes a lot of |
| 2482 | space. On the other hand, you cannot throw away everything. The |
| 2483 | Fcntl module is pretty essential. If you need to do network |
| 2484 | programming, you'll appreciate the Socket module, and so forth: it all |
| 2485 | depends on what do you need to do. |
| 2486 | |
| 2487 | In the following we offer two different slimmed down installation |
| 2488 | recipes. They are informative, not normative: the choice of files |
| 2489 | depends on what you need. |
| 2490 | |
| 2491 | Firstly, the bare minimum to run this script |
| 2492 | |
| 2493 | use strict; |
| 2494 | use warnings; |
| 2495 | foreach my $f (</*>) { |
| 2496 | print("$f\n"); |
| 2497 | } |
| 2498 | |
| 2499 | in Linux is as follows (under $Config{prefix}): |
| 2500 | |
| 2501 | ./bin/perl |
| 2502 | ./lib/perl5/5.9.3/strict.pm |
| 2503 | ./lib/perl5/5.9.3/warnings.pm |
| 2504 | ./lib/perl5/5.9.3/i686-linux/File/Glob.pm |
| 2505 | ./lib/perl5/5.9.3/i686-linux/XSLoader.pm |
| 2506 | ./lib/perl5/5.9.3/i686-linux/auto/File/Glob/Glob.so |
| 2507 | |
| 2508 | Secondly, Debian perl-base package contains the following files, |
| 2509 | size about 1.9MB in its i386 version: |
| 2510 | |
| 2511 | /usr/bin/perl |
| 2512 | /usr/bin/perl5.8.4 |
| 2513 | /usr/lib/perl/5.8 |
| 2514 | /usr/lib/perl/5.8.4/B.pm |
| 2515 | /usr/lib/perl/5.8.4/B/Deparse.pm |
| 2516 | /usr/lib/perl/5.8.4/Config.pm |
| 2517 | /usr/lib/perl/5.8.4/Cwd.pm |
| 2518 | /usr/lib/perl/5.8.4/Data/Dumper.pm |
| 2519 | /usr/lib/perl/5.8.4/DynaLoader.pm |
| 2520 | /usr/lib/perl/5.8.4/Errno.pm |
| 2521 | /usr/lib/perl/5.8.4/Fcntl.pm |
| 2522 | /usr/lib/perl/5.8.4/File/Glob.pm |
| 2523 | /usr/lib/perl/5.8.4/IO.pm |
| 2524 | /usr/lib/perl/5.8.4/IO/File.pm |
| 2525 | /usr/lib/perl/5.8.4/IO/Handle.pm |
| 2526 | /usr/lib/perl/5.8.4/IO/Pipe.pm |
| 2527 | /usr/lib/perl/5.8.4/IO/Seekable.pm |
| 2528 | /usr/lib/perl/5.8.4/IO/Select.pm |
| 2529 | /usr/lib/perl/5.8.4/IO/Socket.pm |
| 2530 | /usr/lib/perl/5.8.4/POSIX.pm |
| 2531 | /usr/lib/perl/5.8.4/Socket.pm |
| 2532 | /usr/lib/perl/5.8.4/XSLoader.pm |
| 2533 | /usr/lib/perl/5.8.4/auto/Cwd/Cwd.bs |
| 2534 | /usr/lib/perl/5.8.4/auto/Cwd/Cwd.so |
| 2535 | /usr/lib/perl/5.8.4/auto/Data/Dumper/Dumper.bs |
| 2536 | /usr/lib/perl/5.8.4/auto/Data/Dumper/Dumper.so |
| 2537 | /usr/lib/perl/5.8.4/auto/DynaLoader/DynaLoader.a |
| 2538 | /usr/lib/perl/5.8.4/auto/DynaLoader/autosplit.ix |
| 2539 | /usr/lib/perl/5.8.4/auto/DynaLoader/dl_expandspec.al |
| 2540 | /usr/lib/perl/5.8.4/auto/DynaLoader/dl_find_symbol_anywhere.al |
| 2541 | /usr/lib/perl/5.8.4/auto/DynaLoader/dl_findfile.al |
| 2542 | /usr/lib/perl/5.8.4/auto/DynaLoader/extralibs.ld |
| 2543 | /usr/lib/perl/5.8.4/auto/Fcntl/Fcntl.bs |
| 2544 | /usr/lib/perl/5.8.4/auto/Fcntl/Fcntl.so |
| 2545 | /usr/lib/perl/5.8.4/auto/File/Glob/Glob.bs |
| 2546 | /usr/lib/perl/5.8.4/auto/File/Glob/Glob.so |
| 2547 | /usr/lib/perl/5.8.4/auto/IO/IO.bs |
| 2548 | /usr/lib/perl/5.8.4/auto/IO/IO.so |
| 2549 | /usr/lib/perl/5.8.4/auto/POSIX/POSIX.bs |
| 2550 | /usr/lib/perl/5.8.4/auto/POSIX/POSIX.so |
| 2551 | /usr/lib/perl/5.8.4/auto/POSIX/autosplit.ix |
| 2552 | /usr/lib/perl/5.8.4/auto/POSIX/load_imports.al |
| 2553 | /usr/lib/perl/5.8.4/auto/Socket/Socket.bs |
| 2554 | /usr/lib/perl/5.8.4/auto/Socket/Socket.so |
| 2555 | /usr/lib/perl/5.8.4/lib.pm |
| 2556 | /usr/lib/perl/5.8.4/re.pm |
| 2557 | /usr/share/doc/perl-base |
| 2558 | /usr/share/doc/perl/AUTHORS.gz |
| 2559 | /usr/share/doc/perl/Documentation |
| 2560 | /usr/share/doc/perl/README.Debian.gz |
| 2561 | /usr/share/doc/perl/changelog.Debian.gz |
| 2562 | /usr/share/doc/perl/copyright |
| 2563 | /usr/share/man/man1/perl.1.gz |
| 2564 | /usr/share/perl/5.8 |
| 2565 | /usr/share/perl/5.8.4/AutoLoader.pm |
| 2566 | /usr/share/perl/5.8.4/Carp.pm |
| 2567 | /usr/share/perl/5.8.4/Carp/Heavy.pm |
| 2568 | /usr/share/perl/5.8.4/Exporter.pm |
| 2569 | /usr/share/perl/5.8.4/Exporter/Heavy.pm |
| 2570 | /usr/share/perl/5.8.4/File/Spec.pm |
| 2571 | /usr/share/perl/5.8.4/File/Spec/Unix.pm |
| 2572 | /usr/share/perl/5.8.4/FileHandle.pm |
| 2573 | /usr/share/perl/5.8.4/Getopt/Long.pm |
| 2574 | /usr/share/perl/5.8.4/IO/Socket/INET.pm |
| 2575 | /usr/share/perl/5.8.4/IO/Socket/UNIX.pm |
| 2576 | /usr/share/perl/5.8.4/IPC/Open2.pm |
| 2577 | /usr/share/perl/5.8.4/IPC/Open3.pm |
| 2578 | /usr/share/perl/5.8.4/List/Util.pm |
| 2579 | /usr/share/perl/5.8.4/Scalar/Util.pm |
| 2580 | /usr/share/perl/5.8.4/SelectSaver.pm |
| 2581 | /usr/share/perl/5.8.4/Symbol.pm |
| 2582 | /usr/share/perl/5.8.4/Text/ParseWords.pm |
| 2583 | /usr/share/perl/5.8.4/Text/Tabs.pm |
| 2584 | /usr/share/perl/5.8.4/Text/Wrap.pm |
| 2585 | /usr/share/perl/5.8.4/attributes.pm |
| 2586 | /usr/share/perl/5.8.4/base.pm |
| 2587 | /usr/share/perl/5.8.4/bytes.pm |
| 2588 | /usr/share/perl/5.8.4/bytes_heavy.pl |
| 2589 | /usr/share/perl/5.8.4/constant.pm |
| 2590 | /usr/share/perl/5.8.4/fields.pm |
| 2591 | /usr/share/perl/5.8.4/integer.pm |
| 2592 | /usr/share/perl/5.8.4/locale.pm |
| 2593 | /usr/share/perl/5.8.4/overload.pm |
| 2594 | /usr/share/perl/5.8.4/strict.pm |
| 2595 | /usr/share/perl/5.8.4/utf8.pm |
| 2596 | /usr/share/perl/5.8.4/utf8_heavy.pl |
| 2597 | /usr/share/perl/5.8.4/vars.pm |
| 2598 | /usr/share/perl/5.8.4/warnings.pm |
| 2599 | /usr/share/perl/5.8.4/warnings/register.pm |
| 2600 | |
| 2601 | A nice trick to find out the minimal set of Perl library files you will |
| 2602 | need to run a Perl program is |
| 2603 | |
| 2604 | perl -e 'do "prog.pl"; END { print "$_\n" for sort keys %INC }' |
| 2605 | |
| 2606 | (this will not find libraries required in runtime, unfortunately, but |
| 2607 | it's a minimal set) and if you want to find out all the files you can |
| 2608 | use something like the below |
| 2609 | |
| 2610 | strace perl -le 'do "x.pl"' 2>&1 | perl -nle '/^open\(\"(.+?)"/ && print $1' |
| 2611 | |
| 2612 | (The 'strace' is Linux-specific, other similar utilities include 'truss' |
| 2613 | and 'ktrace'.) |
| 2614 | |
| 2615 | =head1 DOCUMENTATION |
| 2616 | |
| 2617 | Read the manual entries before running perl. The main documentation |
| 2618 | is in the pod/ subdirectory and should have been installed during the |
| 2619 | build process. Type B<man perl> to get started. Alternatively, you |
| 2620 | can type B<perldoc perl> to use the supplied perldoc script. This is |
| 2621 | sometimes useful for finding things in the library modules. |
| 2622 | |
| 2623 | Under UNIX, you can produce a documentation book in postscript form, |
| 2624 | along with its table of contents, by going to the pod/ subdirectory and |
| 2625 | running (either): |
| 2626 | |
| 2627 | ./roffitall -groff # If you have GNU groff installed |
| 2628 | ./roffitall -psroff # If you have psroff |
| 2629 | |
| 2630 | This will leave you with two postscript files ready to be printed. |
| 2631 | (You may need to fix the roffitall command to use your local troff |
| 2632 | set-up.) |
| 2633 | |
| 2634 | Note that you must have performed the installation already before running |
| 2635 | the above, since the script collects the installed files to generate |
| 2636 | the documentation. |
| 2637 | |
| 2638 | =head1 AUTHOR |
| 2639 | |
| 2640 | Original author: Andy Dougherty doughera@lafayette.edu , borrowing very |
| 2641 | heavily from the original README by Larry Wall, with lots of helpful |
| 2642 | feedback and additions from the perl5-porters@perl.org folks. |
| 2643 | |
| 2644 | If you have problems, corrections, or questions, please see |
| 2645 | L<"Reporting Problems"> above. |
| 2646 | |
| 2647 | =head1 REDISTRIBUTION |
| 2648 | |
| 2649 | This document is part of the Perl package and may be distributed under |
| 2650 | the same terms as perl itself, with the following additional request: |
| 2651 | If you are distributing a modified version of perl (perhaps as part of |
| 2652 | a larger package) please B<do> modify these installation instructions |
| 2653 | and the contact information to match your distribution. |