perl 3.0 patch #7 (combined patch)
[perl.git] / README
1
2                         Perl Kit, Version 3.0
3
4                     Copyright (c) 1989, 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 --------------------------------------------------------------------------
21
22 Perl is a language that combines some of the features of C, sed, awk and shell.
23 See the manual page for more hype.
24
25 Perl will probably not run on machines with a small address space.
26
27 Please read all the directions below before you proceed any further, and
28 then follow them carefully.
29
30 After you have unpacked your kit, you should have all the files listed
31 in MANIFEST.
32
33 Installation
34
35 1)  Run Configure.  This will figure out various things about your system.
36     Some things Configure will figure out for itself, other things it will
37     ask you about.  It will then proceed to make config.h, config.sh, and
38     Makefile.
39
40     You might possibly have to trim # comments from the front of Configure
41     if your sh doesn't handle them, but all other # comments will be taken
42     care of.
43
44     (If you don't have sh, you'll have to copy the sample file config.H to
45     config.h and edit the config.h to reflect your system's peculiarities.)
46
47 2)  Glance through config.h to make sure system dependencies are correct.
48     Most of them should have been taken care of by running the Configure script.
49
50     If you have any additional changes to make to the C definitions, they
51     can be done in the Makefile, or in config.h.  Bear in mind that they will
52     get undone next time you run Configure.
53
54 3)  make depend
55
56     This will look for all the includes and modify Makefile accordingly.
57     Configure will offer to do this for you.
58
59 4)  make
60
61     This will attempt to make perl in the current directory.
62
63     If you can't compile successfully, try adding a -DCRIPPLED_CC flag.
64     (Just because you get no errors doesn't mean it compiled right!)
65     This simplifies some complicated expressions for compilers that
66     get indigestion easily.  If that has no effect, try turning off
67     optimization.  If you have missing routines, you probably need to
68     add some library or other, or you need to undefine some feature that
69     Configure thought was there but is defective or incomplete.
70
71     Some compilers will not compile or optimize the larger files without
72     some extra switches to use larger jump offsets or allocate larger
73     internal tables.  It's okay to insert rules for specific files into
74     Makefile.SH, since a default rule only take effect in the
75     absence of a specific rule.
76
77     The 3b2 needs to turn off -O.
78     AIX/RT may need a -a switch and -DCRIPPLED_CC.
79     SGI machines may need -Ddouble="long float".
80     Ultrix (2.3) may need to hand assemble teval.s with a -J switch.
81     SCO Xenix may need -m25000 for yacc.
82     Genix needs to use libc rather than libc_s, or #undef VARARGS.
83
84 5)  make test
85
86     This will run the regression tests on the perl you just made.
87     If it doesn't say "All tests successful" then something went wrong.
88     See the README in the t subdirectory.  Note that you can't run it
89     in background if this disables opening of /dev/tty.  If "make test"
90     bombs out, just cd to the t directory and run TEST by hand to see if
91     it makes any difference.
92
93 6)  make install
94
95     This will put perl into a public directory (such as /usr/local/bin).
96     It will also try to put the man pages in a reasonable place.  It will not
97     nroff the man page, however.  You may need to be root to do this.  If
98     you are not root, you must own the directories in question and you should
99     ignore any messages about chown not working.
100
101 7)  Read the manual entry before running perl.
102
103 8)  IMPORTANT!  Help save the world!  Communicate any problems and suggested
104     patches to me, lwall@jpl-devvax.jpl.nasa.gov (Larry Wall), so we can
105     keep the world in sync.  If you have a problem, there's someone else
106     out there who either has had or will have the same problem.
107
108     If possible, send in patches such that the patch program will apply them.
109     Context diffs are the best, then normal diffs.  Don't send ed scripts--
110     I've probably changed my copy since the version you have.
111
112     Watch for perl patches in comp.lang.perl.  Patches will generally be
113     in a form usable by the patch program.  If you are just now bringing up
114     perl and aren't sure how many patches there are, write to me and I'll
115     send any you don't have.  Your current patch level is shown in patchlevel.h.
116
117
118 Just a personal note:  I want you to know that I create nice things like this
119 because it pleases the Author of my story.  If this bothers you, then your
120 notion of Authorship needs some revision.  But you can use perl anyway. :-)
121
122                                                         The author.