README

   1 [This is an unsupported, pre-release version of Perl 5.0.]
   2
   3                            Perl Kit, Version 5.0
   4
   5             Copyright (c) 1989,1990,1991,1992,1993,1994  Larry Wall
   6                             All rights reserved.
   7
   8     This program is free software; you can redistribute it and/or modify
   9     it under the terms of either:
  10
  11         a) the GNU General Public License as published by the Free
  12         Software Foundation; either version 1, or (at your option) any
  13         later version, or
  14
  15         b) the "Artistic License" which comes with this Kit.
  16
  17     This program is distributed in the hope that it will be useful,
  18     but WITHOUT ANY WARRANTY; without even the implied warranty of
  19     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See either
  20     the GNU General Public License or the Artistic License for more details.
  21
  22     You should have received a copy of the Artistic License with this
  23     Kit, in the file named "Artistic".  If not, I'll be glad to provide one.
  24
  25     You should also have received a copy of the GNU General Public License
  26     along with this program; if not, write to the Free Software
  27     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  28
  29     For those of you that choose to use the GNU General Public License,
  30     my interpretation of the GNU General Public License is that no Perl
  31     script falls under the terms of the GPL unless you explicitly put
  32     said script under the terms of the GPL yourself.  Furthermore, any
  33     object code linked with uperl.o does not automatically fall under the
  34     terms of the GPL, provided such object code only adds definitions
  35     of subroutines and variables, and does not otherwise impair the
  36     resulting interpreter from executing any standard Perl script.  I
  37     consider linking in C subroutines in this manner to be the moral
  38     equivalent of defining subroutines in the Perl language itself.  You
  39     may sell such an object file as proprietary provided that you provide
  40     or offer to provide the Perl source, as specified by the GNU General
  41     Public License.  (This is merely an alternate way of specifying input
  42     to the program.)  You may also sell a binary produced by the dumping of
  43     a running Perl script that belongs to you, provided that you provide or
  44     offer to provide the Perl source as specified by the GPL.  (The
  45     fact that a Perl interpreter and your code are in the same binary file
  46     is, in this case, a form of mere aggregation.)  This is my interpretation
  47     of the GPL.  If you still have concerns or difficulties understanding
  48     my intent, feel free to contact me.  Of course, the Artistic License
  49     spells all this out for your protection, so you may prefer to use that.
  50
  51 --------------------------------------------------------------------------
  52
  53 Perl is a language that combines some of the features of C, sed, awk
  54 and shell.  See the manual page for more hype.  There are also two Nutshell
  55 Handbooks published by O'Reilly & Assoc.  See pod/perlbook.pod
  56 for more information.
  57
  58 Please read all the directions below before you proceed any further, and
  59 then follow them carefully.
  60
  61 After you have unpacked your kit, you should have all the files listed
  62 in MANIFEST.
  63
  64 Installation
  65
  66 1)  Run Configure.  This will figure out various things about your system.
  67     Some things Configure will figure out for itself, other things it
  68     will ask you about.  It will then proceed to make config.h,
  69     config.sh, and Makefile. You may have to explicitly say
  70         sh Configure    to ensure that Configure is run under sh.
  71     If you're a hotshot, run Configure -d to take all the defaults and
  72     then edit config.sh to patch up any flaws.
  73
  74     Configure supports a number of useful options.  Run Configure -h
  75     to get a listing.  To compile with gcc, for example, you can run
  76     Configure -Dcc=gcc, or answer 'gcc' at the cc prompt.
  77
  78     By default, perl will be installed in /usr/local/{bin, lib, man}.
  79     You can specify a different prefix for the default installation
  80     directory, when Configure prompts you or by using something like
  81     Configure -Dprefix=/whatever.
  82
  83     You can also supply a file config.over to over-ride Configure's
  84     guesses.  It will get loaded up at the very end, just before
  85     config.sh is created.
  86
  87     You might possibly have to trim # comments from the front of Configure
  88     if your sh doesn't handle them, but all other # comments will be taken
  89     care of.
  90
  91     (If you don't have sh, you'll have to copy the sample file config.H to
  92     config.h and edit the config.h to reflect your system's peculiarities.)
  93
  94 2)  Glance through config.h to make sure system dependencies are correct.
  95     Most of them should have been taken care of by running the Configure script.
  96
  97     If you have any additional changes to make to the C definitions, they
  98     can be done in cflags.SH.  For instance, to turn off the optimizer
  99     on toke.c, find the line in the switch structure for toke.c and
 100     put the command optimize='-g' before the ;;.  To change the C flags
 101     for all the files, edit config.sh and change either $ccflags or $optimize.
 102
 103 3)  make depend
 104
 105     This will look for all the includes and modify Makefile accordingly.
 106     Configure will offer to do this for you.
 107
 108 4)  make
 109
 110     This will attempt to make perl in the current directory.
 111
 112     If you can't compile successfully, try adding a -DCRIPPLED_CC flag.
 113     (Just because you get no errors doesn't mean it compiled right!)
 114     This simplifies some complicated expressions for compilers that
 115     get indigestion easily.  If that has no effect, try turning off
 116     optimization.  If you have missing routines, you probably need to
 117     add some library or other, or you need to undefine some feature that
 118     Configure thought was there but is defective or incomplete.
 119
 120     Some compilers will not compile or optimize the larger files without
 121     some extra switches to use larger jump offsets or allocate larger
 122     internal tables.  You can customize the switches for each file in
 123     cflags.SH.  It's okay to insert rules for specific files into
 124     Makefile.SH, since a default rule only takes effect in the
 125     absence of a specific rule.
 126
 127     Many of the following hints are now done automatically by Configure.
 128     Some of the hints here were for Perl 4, and are probably obsolete.
 129     They're left here for the moment just to give you some ideas for
 130     what to try if you're having trouble.
 131
 132     AIX/RT may need a -a switch and -DCRIPPLED_CC.
 133     Ultrix 3.[01] on MIPS needs to undefine WAITPID--the system call is busted.
 134     MIPS machines may need to undef d_volatile.
 135     MIPS machines may need to turn off -O on some files.
 136     Some MIPS machines may need to undefine CASTNEGFLOAT.
 137     Xenix 386 may need -UM_I86.  See also README.xenix.
 138     Genix may need to use libc rather than libc_s, or #undef VARARGS.
 139     NCR Tower 32 (OS 2.01.01) may need -W2,-Sl,2000 and #undef MKDIR.
 140     A/UX may appear to work with -O -B/usr/lib/big/ optimizer flags.
 141     A/UX may need -lposix to find rewinddir.
 142     A/UX may need -ZP -DPOSIX, and -g if big cc is used.
 143     UTS may need one or more of -DCRIPPLED_CC, -K or -g, and undef LSTAT.
 144     If you get syntax errors on '(', try -DCRIPPLED_CC.
 145     Machines with half-implemented dbm routines will need to #undef I_ODBM
 146     SCO prior to 3.2.4 may be missing dbmclose().  An upgrade to 3.2.4
 147     that includes libdbm.nfs (which includes dbmclose()) may be available.
 148     If you get duplicates upon linking for malloc et al, say -DHIDEMYMALLOC.
 149     If you get duplicate function definitions (a perl function has the
 150     same name as another function on your system) try -DEMBED.
 151
 152 5)  make test
 153
 154     This will run the regression tests on the perl you just made.
 155     If it doesn't say "All tests successful" then something went wrong.
 156     See the README in the t subdirectory.  Note that you can't run it
 157     in background if this disables opening of /dev/tty.  If "make test"
 158     bombs out, just cd to the t directory and run TEST by hand to see if
 159     it makes any difference.  If individual tests bomb, you can run
 160     them by hand, e.g., ./perl op/groups.t
 161
 162 6)  make install
 163
 164     This will put perl into a public directory (such as /usr/local/bin).
 165     It will also try to put the man pages in a reasonable place.  It will not
 166     nroff the man page, however.  You may need to be root to do this.  If
 167     you are not root, you must own the directories in question and you should
 168     ignore any messages about chown not working.
 169
 170     Most of the documentation in the pod/ directory is also available
 171     in HTML format.  Type
 172         cd pod; make html; cd ..
 173     to generate the html versions.
 174
 175 7)  Read the manual entries before running perl.
 176
 177 8)  IMPORTANT!  Help save the world!  Communicate any problems and suggested
 178     patches to me, lwall@netlabs.com (Larry Wall), so we can
 179     keep the world in sync.  If you have a problem, there's someone else
 180     out there who either has had or will have the same problem.
 181
 182     If possible, send in patches such that the patch program will apply them.
 183     Context diffs are the best, then normal diffs.  Don't send ed scripts--
 184     I've probably changed my copy since the version you have.  It's also
 185     helpful if you send the output of "uname -a".
 186
 187     Watch for perl patches in comp.lang.perl.  Patches will generally be
 188     in a form usable by the patch program.  If you are just now bringing up
 189     perl and aren't sure how many patches there are, write to me and I'll
 190     send any you don't have.  Your current patch level is shown in patchlevel.h.
 191
 192
 193 Just a personal note:  I want you to know that I create nice things like this
 194 because it pleases the Author of my story.  If this bothers you, then your
 195 notion of Authorship needs some revision.  But you can use perl anyway. :-)
 196
 197                                                         The author.