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