a "replacement" for awk and sed
[perl.git] / README
1
2                         Perl Kit, Version 1.0
3
4                     Copyright (c) 1987, Larry Wall
5
6 You may copy the perl kit in whole or in part as long as you don't try to
7 make money off it, or pretend that you wrote it.
8 --------------------------------------------------------------------------
9
10 Perl is a language that combines some of the features of C, sed, awk and shell.
11 See the manual page for more hype.
12
13 Perl will probably not run on machines with a small address space.
14
15 Please read all the directions below before you proceed any further, and
16 then follow them carefully.  Failure to do so may void your warranty. :-)
17
18 After you have unpacked your kit, you should have all the files listed
19 in MANIFEST.
20
21 Installation
22
23 1)  Run Configure.  This will figure out various things about your system.
24     Some things Configure will figure out for itself, other things it will
25     ask you about.  It will then proceed to make config.h, config.sh, and
26     Makefile.
27
28     You might possibly have to trim # comments from the front of Configure
29     if your sh doesn't handle them, but all other # comments will be taken
30     care of.
31
32     (If you don't have sh, you'll have to copy the sample file config.H to
33     config.h and edit the config.h to reflect your system's peculiarities.)
34
35 2)  Glance through config.h to make sure system dependencies are correct.
36     Most of them should have been taken care of by running the Configure script.
37
38     If you have any additional changes to make to the C definitions, they
39     can be done in the Makefile, or in config.h.  Bear in mind that they will
40     get undone next time you run Configure.
41
42 3)  make depend
43
44     This will look for all the includes and modify Makefile accordingly.
45     Configure will offer to do this for you.
46
47 4)  make
48
49     This will attempt to make perl in the current directory.
50
51 5)  make test
52
53     This will run the regression tests on the perl you just made.
54     If it doesn't say "All tests successful" then something went wrong.
55     See the README in the t subdirectory.
56
57 6)  make install
58
59     This will put perl into a public directory (normally /usr/local/bin).
60     It will also try to put the man pages in a reasonable place.  It will not
61     nroff the man page, however.  You may need to be root to do this.  If
62     you are not root, you must own the directories in question and you should
63     ignore any messages about chown not working.
64
65 7)  Read the manual entry before running perl.
66
67 8)  Go down to the x2p directory and do a "make depend, a "make" and a
68     "make install" to create the awk to perl and sed to perl translators.
69
70 9)  IMPORTANT!  Help save the world!  Communicate any problems and suggested
71     patches to me, lwall@jpl-devvax.jpl.nasa.gov (Larry Wall), so we can
72     keep the world in sync.  If you have a problem, there's someone else
73     out there who either has had or will have the same problem.
74
75     If possible, send in patches such that the patch program will apply them.
76     Context diffs are the best, then normal diffs.  Don't send ed scripts--
77     I've probably changed my copy since the version you have.
78
79     Watch for perl patches in comp.sources.bugs.  Patches will generally be
80     in a form usable by the patch program.  If you are just now bringing up
81     perl and aren't sure how many patches there are, write to me and I'll
82     send any you don't have.  Your current patch level is shown in patchlevel.h.
83