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