Update IPC SysV test from blead (hopefully is more graceful under duress)
[perl.git] / README.dos
1 If you read this file _as_is_, just ignore the funny characters you\r
2 see. It is written in the POD format (see perlpod manpage) which is\r
3 specially designed to be readable as is.\r
4 \r
5 =head1 NAME\r
6 \r
7 perldos - Perl under DOS, W31, W95.\r
8                                  \r
9 =head1 SYNOPSIS\r
10 \r
11 These are instructions for building Perl under DOS (or w??), using\r
12 DJGPP v2.01 or later. Under w95 long filenames are supported.\r
13 \r
14 =head1 DESCRIPTION\r
15 \r
16 Before you start, you should glance through the README file\r
17 found in the top-level directory where the Perl distribution\r
18 was extracted.  Make sure you read and understand the terms under\r
19 which this software is being distributed.\r
20 \r
21 This port currently supports MakeMaker (the set of modules that\r
22 is used to build extensions to perl).  Therefore, you should be\r
23 able to build and install most extensions found in the CPAN sites.\r
24 \r
25 =head2 Prerequisites\r
26 \r
27 =over 4\r
28 \r
29 =item DJGPP\r
30 \r
31 DJGPP is a port of GNU C/C++ compiler and development tools to 32-bit,\r
32 protected-mode environment on Intel 32-bit CPUs running MS-DOS and compatible\r
33 operating systems, by DJ Delorie <dj@delorie.com> and friends.\r
34 \r
35 For more details (FAQ), check out the home of DJGPP at:\r
36 \r
37         http://www.delorie.com/djgpp/\r
38 \r
39 If you have questions about DJGPP, try posting to the DJGPP newsgroup:\r
40 comp.os.msdos.djgpp, or use the email gateway djgpp@delorie.com.\r
41 \r
42 You can find the full DJGPP distribution on any SimTel.Net mirror all over\r
43 the world. Like:\r
44 \r
45         ftp://ftp.simtel.net/pub/simtelnet/gnu/djgpp/v2*\r
46 \r
47 You need the following files to build perl (or add new modules):\r
48 \r
49         v2/djdev201.zip\r
50         v2/bnu27b.zip\r
51         v2gnu/gcc2721b.zip\r
52         v2gnu/bsh1147b.zip\r
53         v2gnu/mak3761b.zip\r
54         v2gnu/fil316b.zip\r
55         v2gnu/sed118b.zip\r
56         v2gnu/txt122b.zip\r
57         v2gnu/dif271b.zip\r
58         v2gnu/grep21b.zip\r
59         v2gnu/shl112b.zip\r
60         v2gnu/gawk303b.zip\r
61         v2misc/csdpmi4b.zip \r
62 \r
63 or any newer version.\r
64 \r
65 =item Pthreads\r
66 \r
67 If you want multithreading support in perl, you need a pthread library\r
68 that supports DJGPP. One of them can be found at:\r
69 \r
70         ftp://ftp.cs.fsu.edu/pub/PART/PTHREADS/pthreads.zip\r
71 \r
72 But thread support is still in alpha, it may be unstable. For more information\r
73 see below.\r
74 \r
75 =back\r
76 \r
77 =head2 Shortcomings of Perl under DOS\r
78 \r
79 Perl under DOS lacks some features of perl under UNIX because of\r
80 deficiencies in the UNIX-emulation, most notably:\r
81 \r
82 =over 4\r
83 \r
84 =item *\r
85 \r
86 fork() and pipe()\r
87 \r
88 =item *\r
89 \r
90 some features of the UNIX filesystem regarding link count and file dates\r
91 \r
92 =item *\r
93 \r
94 in-place operation is a little bit broken with short filenames\r
95 \r
96 =item *\r
97 \r
98 sockets\r
99 \r
100 =back\r
101 \r
102 =head2 Building\r
103 \r
104 =over 4\r
105 \r
106 =item *\r
107 \r
108 Unpack the source package F<perl5.00?_??.tar.gz> with djtarx. If you want\r
109 to use long file names under w95, don't forget to use\r
110 \r
111         set LFN=y\r
112         \r
113 before unpacking the archive.\r
114 \r
115 =item *\r
116 \r
117 Create a "symlink" or copy your bash.exe to sh.exe in your C<($DJDIR)/bin>\r
118 directory.\r
119 \r
120         ln -s bash.exe sh.exe\r
121 \r
122 And make the C<SHELL> environment variable point to this F<sh.exe>:\r
123 \r
124         set SHELL=c:/djgpp/bin/sh.exe (use full path name!)\r
125 \r
126 You can do this in F<djgpp.env> too. Add this line BEFORE any section\r
127 definition:\r
128 \r
129         +SHELL=%DJDIR%/bin/sh.exe\r
130 \r
131 =item *\r
132 \r
133 If you have F<split.exe> and F<gsplit.exe> in your path, then rename \r
134 F<split.exe> to F<djsplit.exe>, and F<gsplit.exe> to F<split.exe>.\r
135 Copy or link F<gecho.exe> to F<echo.exe> if you don't have F<echo.exe>.\r
136 Copy or link F<gawk.exe> to F<awk.exe> if you don't have F<awk.exe>.\r
137 \r
138 =item *\r
139 \r
140 Chdir to the djgpp subdirectory of perl toplevel and type the following\r
141 command:\r
142 \r
143         configure.bat\r
144 \r
145 This will do some preprocessing then run the Configure script for you.\r
146 The Configure script is interactive, but in most cases you\r
147 just need to press ENTER.\r
148 \r
149 If the script says that your package is incomplete, and asks whether\r
150 to continue, just answer with Y (this can only happen if you don't use\r
151 long filenames).\r
152 \r
153 When Configure asks about the extensions, I suggest IO and Fcntl,\r
154 and if you want database handling then SDBM_File or GDBM_File\r
155 (you need to install gdbm for this one). If you want to use the\r
156 POSIX extension (this is the default), make sure that the stack\r
157 size of your F<cc1.exe> is at least 512kbyte (you can check this\r
158 with: C<stubedit cc1.exe>).\r
159 \r
160 You can use the Configure script in non-interactive mode too.\r
161 When I built my F<perl.exe>, I used something like this:\r
162 \r
163         configure.bat -Uuseposix -des\r
164 \r
165 You can find more info about Configure's command line switches in\r
166 the F<INSTALL> file.\r
167 \r
168 When the script ends, and you want to change some values in the\r
169 generated F<config.sh> file, then run\r
170 \r
171         sh Configure -S\r
172 \r
173 after you made your modifications.\r
174 \r
175 IMPORTANT: if you use this C<-S> switch, be sure to delete the CONFIG\r
176 environment variable before running the script:\r
177 \r
178         set CONFIG=\r
179 \r
180 =item *\r
181 \r
182 Now you can compile Perl. Type:\r
183 \r
184         make\r
185 \r
186 =back\r
187 \r
188 =head2 Testing\r
189 \r
190 Type:\r
191 \r
192         make test\r
193 \r
194 You should see "All tests successful" if you configured a database\r
195 manager, and 1 failed test script if not (F<lib/anydbm.t>). If you\r
196 configured POSIX you will see 1 additional failed subtest in F<lib/posix.t>.\r
197 \r
198 =head2 Installation\r
199 \r
200 Type:\r
201 \r
202         make install\r
203 \r
204 This will copy the newly compiled perl and libraries into your DJGPP\r
205 directory structure. Perl.exe and the utilities go into C<($DJDIR)/bin>,\r
206 and the library goes under C<($DJDIR)/lib/perl5>. The pod documentation\r
207 goes under C<($DJDIR)/lib/perl5/pod>.\r
208 \r
209 =head2 Threaded perl under dos-djgpp\r
210 \r
211 Multithreading support is considered alpha, because some of the\r
212 tests in C<ext/Thread> still die with SIGSEGV (patches are welcome). But\r
213 if you want to give it a try, here are the necessary steps:\r
214 \r
215 =over 4\r
216 \r
217 =item\r
218 \r
219 1. You will need a pthread library which supports djgpp. Go, and download\r
220 FSU's version from:\r
221 \r
222       ftp://ftp.cs.fsu.edu/pub/PART/PTHREADS/pthreads.zip\r
223 \r
224 The latest version is 3.5, released in Feb 98.\r
225 \r
226 =item \r
227 \r
228 2. Unzip the file, cd to C<threads\src> and run F<configur.bat>.\r
229 \r
230 =item \r
231 \r
232 3. Add C<RAND_SWITCH> or C<MUTEX_SWITCH> or C<RR_SWITCH> to C<CFLAGS>\r
233 in the F<makefile>. Note that using these values, multithreading will\r
234 NOT be preemptive. This is necessary, since djgpp's libc is not thread safe.\r
235 \r
236 =item \r
237 \r
238 4. Apply the following patch:\r
239 \r
240     *** include/pthread/signal.h~       Wed Feb  4 10:51:24 1998\r
241     --- include/pthread/signal.h        Tue Feb 10 22:40:32 1998\r
242     ***************\r
243     *** 364,368 ****\r
244     --- 364,370 ----\r
245       \r
246       #ifndef SA_ONSTACK\r
247     + #ifdef  SV_ONSTACK\r
248       #define SA_ONSTACK SV_ONSTACK\r
249     + #endif\r
250       #endif /* !SA_ONSTACK */\r
251 \r
252 =item\r
253 \r
254 5. run make (before you do this, you must make sure your C<SHELL> environment \r
255 variable does NOT point to bash).\r
256 \r
257 =item\r
258 \r
259 6. Install the library and header files into your djgpp directory structure.\r
260 \r
261 =item\r
262 \r
263 7. Add C<-Dusethreads> to the commmand line of perl's F<configure.bat>.\r
264 \r
265 =back\r
266 \r
267 =head1 AUTHOR\r
268 \r
269 Laszlo Molnar, F<molnarl@cdata.tvnet.hu>\r
270 \r
271 =head1 SEE ALSO\r
272 \r
273 perl(1).\r
274 \r
275 =cut\r
276 \r