README

   1 This is an unsupported, pre-release version of Perl 5.0.  It is expected
   2 to work only on a Sparc architecture machine.  NO CONFIGURE SUPPORT IS
   3 PROVIDED, despite what it says below.  In fact, if you succeed in
   4 configuring and making a new makefile, you'll probably overwrite the
   5 only makefile that works.  Note that a SunOS executable comes with the
   6 kit, so you may not need to compile at all.  See file Changes for a
   7 list of new features.  If you look at t/op/ref.t you'll see some of
   8 them in use.  perl -Dxst is also fun.
   9
  10                            Perl Kit, Version 5.0
  11
  12             Copyright (c) 1989,1990,1991,1992,1993,1994  Larry Wall
  13                             All rights reserved.
  14
  15     This program is free software; you can redistribute it and/or modify
  16     it under the terms of either:
  17
  18         a) the GNU General Public License as published by the Free
  19         Software Foundation; either version 1, or (at your option) any
  20         later version, or
  21
  22         b) the "Artistic License" which comes with this Kit.
  23
  24     This program is distributed in the hope that it will be useful,
  25     but WITHOUT ANY WARRANTY; without even the implied warranty of
  26     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See either
  27     the GNU General Public License or the Artistic License for more details.
  28
  29     You should have received a copy of the Artistic License with this
  30     Kit, in the file named "Artistic".  If not, I'll be glad to provide one.
  31
  32     You should also have received a copy of the GNU General Public License
  33     along with this program; if not, write to the Free Software
  34     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  35
  36     For those of you that choose to use the GNU General Public License,
  37     my interpretation of the GNU General Public License is that no Perl
  38     script falls under the terms of the GPL unless you explicitly put
  39     said script under the terms of the GPL yourself.  Furthermore, any
  40     object code linked with uperl.o does not automatically fall under the
  41     terms of the GPL, provided such object code only adds definitions
  42     of subroutines and variables, and does not otherwise impair the
  43     resulting interpreter from executing any standard Perl script.  I
  44     consider linking in C subroutines in this manner to be the moral
  45     equivalent of defining subroutines in the Perl language itself.  You
  46     may sell such an object file as proprietary provided that you provide
  47     or offer to provide the Perl source, as specified by the GNU General
  48     Public License.  (This is merely an alternate way of specifying input
  49     to the program.)  You may also sell a binary produced by the dumping of
  50     a running Perl script that belongs to you, provided that you provide or
  51     offer to provide the Perl source as specified by the GPL.  (The
  52     fact that a Perl interpreter and your code are in the same binary file
  53     is, in this case, a form of mere aggregation.)  This is my interpretation
  54     of the GPL.  If you still have concerns or difficulties understanding
  55     my intent, feel free to contact me.  Of course, the Artistic License
  56     spells all this out for your protection, so you may prefer to use that.
  57
  58 --------------------------------------------------------------------------
  59
  60 Perl is a language that combines some of the features of C, sed, awk
  61 and shell.  See the manual page for more hype.  There's also a Nutshell
  62 Handbook published by O'Reilly & Assoc.  Their U.S. number is
  63 1-800-998-9938 and their international number is 1-707-829-0515.
  64 E-mail to nuts@ora.com.
  65
  66 Please read all the directions below before you proceed any further, and
  67 then follow them carefully.
  68
  69 After you have unpacked your kit, you should have all the files listed
  70 in MANIFEST.
  71
  72 Installation
  73
  74 1)  Run Configure.  This will figure out various things about your system.
  75     Some things Configure will figure out for itself, other things it will
  76     ask you about.  It will then proceed to make config.h, config.sh, and
  77     Makefile.  If you're a hotshot, run Configure -d to take all the
  78     defaults and then edit config.sh to patch up any flaws.
  79
  80     You might possibly have to trim # comments from the front of Configure
  81     if your sh doesn't handle them, but all other # comments will be taken
  82     care of.
  83
  84     (If you don't have sh, you'll have to copy the sample file config.H to
  85     config.h and edit the config.h to reflect your system's peculiarities.)
  86
  87 2)  Glance through config.h to make sure system dependencies are correct.
  88     Most of them should have been taken care of by running the Configure script.
  89
  90     If you have any additional changes to make to the C definitions, they
  91     can be done in cflags.SH.  For instance, to turn off the optimizer
  92     on eval.c, find the line in the switch structure for eval.c and
  93     put the command $optimize='-g' before the ;;.  You will probably
  94     want to change the entry for teval.c too.  To change the C flags
  95     for all the files, edit config.sh and change either $ccflags or $optimize.
  96
  97 3)  make depend
  98
  99     This will look for all the includes and modify Makefile accordingly.
 100     Configure will offer to do this for you.
 101
 102 4)  make
 103
 104     This will attempt to make perl in the current directory.
 105
 106     If you can't compile successfully, try adding a -DCRIPPLED_CC flag.
 107     (Just because you get no errors doesn't mean it compiled right!)
 108     This simplifies some complicated expressions for compilers that
 109     get indigestion easily.  If that has no effect, try turning off
 110     optimization.  If you have missing routines, you probably need to
 111     add some library or other, or you need to undefine some feature that
 112     Configure thought was there but is defective or incomplete.
 113
 114     Some compilers will not compile or optimize the larger files without
 115     some extra switches to use larger jump offsets or allocate larger
 116     internal tables.  You can customize the switches for each file in
 117     cflags.SH.  It's okay to insert rules for specific files into
 118     Makefile.SH, since a default rule only takes effect in the
 119     absence of a specific rule.
 120
 121     Most of the following hints are now done automatically by Configure.
 122
 123     The 3b2 needs to turn off -O.
 124     Compilers with limited switch tables may have to define -DSMALLSWITCHES
 125     Domain/OS 10.3 (at least) native C 6.7 may need -opt 2 for eval.c
 126     AIX/RT may need a -a switch and -DCRIPPLED_CC.
 127     AIX RS/6000 needs to use system malloc and avoid -O on eval.c and toke.c.
 128     AIX RS/6000 needs -D_NO_PROTO.
 129     SUNOS 4.0.[12] needs -DFPUTS_BOTCH.
 130     SUNOS 3.[45] should use the system malloc.
 131     SGI machines may need -Ddouble="long float" and -O1.
 132     Vax-based systems may need to hand assemble teval.s with a -J switch.
 133     Ultrix on MIPS machines may need -DLANGUAGE_C.
 134     Ultrix 4.0 on MIPS machines may need -Olimit 2900 or so.
 135     Ultrix 3.[01] on MIPS needs to undefine WAITPID--the system call is busted.
 136     MIPS machines need /bin before /bsd43/bin in PATH.
 137     MIPS machines may need to undef d_volatile.
 138     MIPS machines may need to turn off -O on cmd.c, perl.c and tperl.c.
 139     Some MIPS machines may need to undefine CASTNEGFLOAT.
 140     Xenix 386 needs -Sm11000 for yacc, and may need -UM_I86.
 141     SCO Xenix may need -m25000 for yacc.  See also README.xenix.
 142     Genix needs to use libc rather than libc_s, or #undef VARARGS.
 143     NCR Tower 32 (OS 2.01.01) may need -W2,-Sl,2000 and #undef MKDIR.
 144     A/UX may appears to work with -O -B/usr/lib/big/ optimizer flags.
 145     A/UX needs -lposix to find rewinddir.
 146     A/UX may need -ZP -DPOSIX, and -g if big cc is used.
 147     FPS machines may need -J and -DBADSWITCH.
 148     UTS may need one or more of -DCRIPPLED_CC, -K or -g, and undef LSTAT.
 149     dynix may need to undefine CASTNEGFLOAT (d_castneg='undef' in config.sh).
 150     Dnix (not dynix) may need to remove -O.
 151     IRIX 3.3 may need to undefine VFORK.
 152     HP/UX may need to pull cerror.o and syscall.o out of libc.a and link
 153         them in explicitly.
 154     If you get syntax errors on '(', try -DCRIPPLED_CC or -DBADSWITCH or both.
 155     Machines with half-implemented dbm routines will need to #undef ODBM & NDBM.
 156     If you have GDBM available and want it instead of NDBM, say -DHAS_GDBM.
 157     C's that don't try to restore registers on longjmp() may need -DJMPCLOBBER.
 158         (Try this if you get random glitches.)
 159     If you get duplicates upon linking for malloc et al, say -DHIDEMYMALLOC.
 160     Turn on support for 64-bit integers (long longs) with -DQUAD.
 161
 162 5)  make test
 163
 164     This will run the regression tests on the perl you just made.
 165     If it doesn't say "All tests successful" then something went wrong.
 166     See the README in the t subdirectory.  Note that you can't run it
 167     in background if this disables opening of /dev/tty.  If "make test"
 168     bombs out, just cd to the t directory and run TEST by hand to see if
 169     it makes any difference.  If individual tests bomb, you can run
 170     them by hand, e.g., ./perl op/groups.t
 171
 172 6)  make install
 173
 174     This will put perl into a public directory (such as /usr/local/bin).
 175     It will also try to put the man pages in a reasonable place.  It will not
 176     nroff the man page, however.  You may need to be root to do this.  If
 177     you are not root, you must own the directories in question and you should
 178     ignore any messages about chown not working.
 179
 180 7)  Read the manual entry before running perl.
 181
 182 8)  IMPORTANT!  Help save the world!  Communicate any problems and suggested
 183     patches to me, lwall@netlabs.com (Larry Wall), so we can
 184     keep the world in sync.  If you have a problem, there's someone else
 185     out there who either has had or will have the same problem.
 186
 187     If possible, send in patches such that the patch program will apply them.
 188     Context diffs are the best, then normal diffs.  Don't send ed scripts--
 189     I've probably changed my copy since the version you have.  It's also
 190     helpful if you send the output of "uname -a".
 191
 192     Watch for perl patches in comp.lang.perl.  Patches will generally be
 193     in a form usable by the patch program.  If you are just now bringing up
 194     perl and aren't sure how many patches there are, write to me and I'll
 195     send any you don't have.  Your current patch level is shown in patchlevel.h.
 196
 197
 198 Just a personal note:  I want you to know that I create nice things like this
 199 because it pleases the Author of my story.  If this bothers you, then your
 200 notion of Authorship needs some revision.  But you can use perl anyway. :-)
 201
 202                                                         The author.