This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perl 3.0 patch #41 (combined patch)
[perl5.git] / README
CommitLineData
8d063cd8 1
a687059c 2 Perl Kit, Version 3.0
8d063cd8 3
21d892ea 4 Copyright (c) 1989,1990, Larry Wall
a687059c
LW
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.
8d063cd8 19
79220ce3
LW
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
8d063cd8
LW
40--------------------------------------------------------------------------
41
42Perl is a language that combines some of the features of C, sed, awk and shell.
43See the manual page for more hype.
44
45Perl will probably not run on machines with a small address space.
46
47Please read all the directions below before you proceed any further, and
a687059c 48then follow them carefully.
8d063cd8
LW
49
50After you have unpacked your kit, you should have all the files listed
51in MANIFEST.
52
53Installation
54
551) 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.
59
60 You might possibly have to trim # comments from the front of Configure
61 if your sh doesn't handle them, but all other # comments will be taken
62 care of.
63
64 (If you don't have sh, you'll have to copy the sample file config.H to
65 config.h and edit the config.h to reflect your system's peculiarities.)
66
672) Glance through config.h to make sure system dependencies are correct.
68 Most of them should have been taken care of by running the Configure script.
69
70 If you have any additional changes to make to the C definitions, they
71 can be done in the Makefile, or in config.h. Bear in mind that they will
72 get undone next time you run Configure.
73
743) make depend
75
76 This will look for all the includes and modify Makefile accordingly.
77 Configure will offer to do this for you.
78
794) make
80
81 This will attempt to make perl in the current directory.
82
d8f2e4cc
LW
83 If you can't compile successfully, try adding a -DCRIPPLED_CC flag.
84 (Just because you get no errors doesn't mean it compiled right!)
85 This simplifies some complicated expressions for compilers that
86 get indigestion easily. If that has no effect, try turning off
87 optimization. If you have missing routines, you probably need to
88 add some library or other, or you need to undefine some feature that
89 Configure thought was there but is defective or incomplete.
90
91 Some compilers will not compile or optimize the larger files without
92 some extra switches to use larger jump offsets or allocate larger
93 internal tables. It's okay to insert rules for specific files into
b6ccd89c 94 Makefile.SH, since a default rule only takes effect in the
d8f2e4cc
LW
95 absence of a specific rule.
96
97 The 3b2 needs to turn off -O.
e5d73d77 98 Domain/OS 10.3 (at least) native C 6.7 may need -opt 2 for eval.c
d8f2e4cc 99 AIX/RT may need a -a switch and -DCRIPPLED_CC.
21d892ea 100 SUNOS 4.0.[12] needs #define fputs(str,fp) fprintf(fp,"%s",str) in perl.h
e5d73d77 101 SUNOS 3.[45] should use the system malloc.
d8f2e4cc
LW
102 SGI machines may need -Ddouble="long float".
103 Ultrix (2.3) may need to hand assemble teval.s with a -J switch.
449aadca 104 Ultrix on MIPS machines may need -DLANGUAGE_C.
5303340c
LW
105 Ultrix 3.[01] on MIPS needs to undefine WAITPID--the system call is busted.
106 MIPS machines may need to undef d_volatile.
79220ce3 107 MIPS machines may need to turn off -O on perly.c and tperly.c.
5303340c 108 Some MIPS machines may need to undefine CASTNEGFLOAT.
d8f2e4cc 109 SCO Xenix may need -m25000 for yacc.
5303340c 110 Xenix 386 needs -Sm11000 for yacc, and may need -UM_I86.
d8f2e4cc 111 Genix needs to use libc rather than libc_s, or #undef VARARGS.
449aadca 112 NCR Tower 32 (OS 2.01.01) may need -W2,-Sl,2000 and #undef MKDIR.
79220ce3
LW
113 A/UX may need -ZP -DPOSIX, and -g if big cc is used.
114 FPS machines may need -J and -DBADSWITCH.
5303340c 115 UTS may need one or more of -DCRIPPLED_CC, -K or -g, and undef LSTAT.
4e8eb4f0 116 Dnix (not dynix) may need to remove -O.
79220ce3 117 If you get syntax errors on '(', try -DCRIPPLED_CC or -DBADSWITCH or both.
449aadca
LW
118 Machines with half-implemented dbm routines will need to #undef ODBM & NDBM.
119 C's that don't try to restore registers on longjmp() may need -DJMPCLOBBER.
120 (Try this if you get random glitches.)
d8f2e4cc 121
8d063cd8
LW
1225) make test
123
124 This will run the regression tests on the perl you just made.
125 If it doesn't say "All tests successful" then something went wrong.
378cc40b 126 See the README in the t subdirectory. Note that you can't run it
03a14243
LW
127 in background if this disables opening of /dev/tty. If "make test"
128 bombs out, just cd to the t directory and run TEST by hand to see if
129 it makes any difference.
8d063cd8
LW
130
1316) make install
132
a687059c 133 This will put perl into a public directory (such as /usr/local/bin).
8d063cd8
LW
134 It will also try to put the man pages in a reasonable place. It will not
135 nroff the man page, however. You may need to be root to do this. If
136 you are not root, you must own the directories in question and you should
137 ignore any messages about chown not working.
138
1397) Read the manual entry before running perl.
140
a687059c 1418) IMPORTANT! Help save the world! Communicate any problems and suggested
8d063cd8
LW
142 patches to me, lwall@jpl-devvax.jpl.nasa.gov (Larry Wall), so we can
143 keep the world in sync. If you have a problem, there's someone else
144 out there who either has had or will have the same problem.
145
146 If possible, send in patches such that the patch program will apply them.
147 Context diffs are the best, then normal diffs. Don't send ed scripts--
148 I've probably changed my copy since the version you have.
149
d8f2e4cc 150 Watch for perl patches in comp.lang.perl. Patches will generally be
8d063cd8
LW
151 in a form usable by the patch program. If you are just now bringing up
152 perl and aren't sure how many patches there are, write to me and I'll
153 send any you don't have. Your current patch level is shown in patchlevel.h.
154
a687059c
LW
155
156Just a personal note: I want you to know that I create nice things like this
157because it pleases the Author of my story. If this bothers you, then your
158notion of Authorship needs some revision. But you can use perl anyway. :-)
159
160 The author.