README

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