This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
metaconfig unit changes for #17522.
[metaconfig.git] / dist-3.0at70b / README
1                              dist 3.0
2
3                    Copyright (c) 1988, Larry Wall
4                 Copyright (c) 1990-1992, Harlan Stenn
5               Copyright (c) 1991-1997, Raphael Manfredi
6
7 ------------------------------------------------------------------------
8     This program is free software; you can redistribute it and/or modify
9     it under the terms of the Artistic License, a copy of which can be
10     found with this package.
11
12     This program is distributed in the hope that it will be useful,
13     but WITHOUT ANY WARRANTY; without even the implied warranty of
14     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15     Artistic License for more details.
16 ------------------------------------------------------------------------
17
18 This version of dist requires you to have at least perl 4.0 PL36.
19 It has also been ported to work with perl 5.0 PL0, provided you have
20 at least integrated patches 0a-0h, issued by Andy Dougherty and made
21 available at the following ftp sites:
22
23         ftp.demon.co.uk:/pub/perl/db/perl5.000-p0a-p0h.tar.gz
24         ftp.funet.fi:/pub/languages/perl/ports/perl5/perl5.000-p0a-p0h.tar.gz
25
26 Please read all the directions below before you proceed any further, and
27 then follow them carefully.
28
29 After you have unpacked your kit, you should have all the files listed
30 in MANIFEST.
31
32 ========================================================================
33                            It's not the way I wrote it, but the
34                            way you play it makes it sound a lot better.
35                                 -- Camille Saint-Saens (French composer)
36
37 The dist package consists of four parts:
38
39     1) The Configure generator (metaconfig) and its supporting files.
40     2) The distribution kit maker (makedist) and its supporting files.
41     3) The patch distribution system (pat*) and its supporting files.
42     4) The Makefile generator (jmake) and its supporting files.
43
44 Each of these can be used separately from the others.  Before you can
45 use any of those, however, the directory containing your package (not this
46 package) must be initialized by putting a .package file into it.  This
47 can be done by running packinit in that directory.
48
49 There is a mailing list hosted in Japan and set up by Shigeya Suzuki
50 <shigeya@foretune.co.jp>, for discussion about the dist package as a
51 whole. It's a good place to ask questions (or answer them) and to
52 send your patches. I will post official patches to the net, as well
53 as to the dist-users list.
54
55 To send a mail to the list, address it to <dist-users@foretune.co.jp>.
56 To subscribe, send a mail to <majordomo@foretune.co.jp>. If you don't
57 know how to use majordomo, the syntax of the subscribe command is:
58
59         subscribe dist-users [address]
60
61 where the address part is optional. You may unsubscribe automatically
62 at any time by sending:
63
64         unsubscribe dist-users
65
66 If you have a problem with this version of dist, it is recommended that
67 you subscribe to the list, then send a description of your problem to it.
68 If you send mail to me personally, I may not be able to answer in a
69 timely fashion.
70
71 This mailing list has low traffic (a few articles per week, typically),
72 and it is expected to remain so, with a high signal/noise ratio.
73
74 Notes:
75
76     If you are running on a system with <= 14 char filenames, don't
77     distribute any files with filenames longer than 12 chars (with the
78     exception of patchlevel.h), so that there will be room for a
79     2-digit extension indicating patch number in your bugs direcory.
80     This includes .SH files, so any shell script built by a .SH file
81     should be 9 characters or less.  On systems with flexfilenames you
82     don't have to worry about it.
83
84     This package has been designed on top of dist 2.0, which has been
85     written by Larry Wall <lwall@netlabs.com>.
86 ========================================================================
87
88 INSTALLATION
89
90 1) Run Configure. This will figure out various things about your
91 system. After it has completed, it will produce config.h and config.sh.
92
93 You might possibly have to trim # comments from the front of Configure
94 if your shell doesn't handle them, but all other comments will be taken
95 care of.
96
97 2) Run make.
98
99 3) If make succeeded, you may wish to do "make install install.man". Be
100 sure your rights are correct (if you install manual pages, you may need
101 super-user privileges). By not running "make install.man", you avoid the
102 installation of the manual pages.
103
104 4) Read the manual entry before running.
105
106 5) IMPORTANT!  Communicate any problem and suggested patches to me,
107 ram@hptnos02.grenoble.hp.com (Raphael Manfredi), so we can keep this
108 distribution in sync.  If you have a problem, there will be someone else
109 who had it or will have it too...
110
111 If possible, send me patches such that the patch program will apply
112 them.  Context diffs are the best, then normal diffs.  Do not send ed
113 scripts, I have probably changed my copy since the version you got.
114
115 6) After everything is installed, you can do make clobber. This will
116 clean up everything and let you re-distribute this kit, without
117 carrying useless files. You should keep this distribution intact, so
118 that future patches will be applyable.
119
120 7) I have an automatic patch sender. Send me the following mail:
121
122         Subject: Command
123         @SH mailhelp PATH
124
125 and you'll get instructions (PATH stands for YOUR e-mail address, either
126 in INTERNET or in bang notation). I would recommend you to get all the
127 issued patches before you start making some modifications on this
128 package.
129
130 8) If you wish to deinstall the package, you may run "make deinstall".
131 A separate "make deinstall.man" will remove the manual pages. Be sure
132 the makefiles are correctly set before running any deinstall target.
133 On USG systems, some executable have a chance to remain despite the
134 deinstall (text file busy...).
135
136         Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>