Introduce NVef, NVff, and NVgf, use the middle one.
[perl.git] / README.os2
1 If you read this file _as_is_, just ignore the funny characters you
2 see. It is written in the POD format (see perlpod manpage) which is
3 specially designed to be readable as is.
4
5 =head1 NAME
6
7 perlos2 - Perl under OS/2, DOS, Win0.3*, Win0.95 and WinNT.
8
9 =head1 SYNOPSIS
10
11 One can read this document in the following formats:
12
13         man perlos2
14         view perl perlos2
15         explorer perlos2.html
16         info perlos2
17
18 to list some (not all may be available simultaneously), or it may
19 be read I<as is>: either as F<README.os2>, or F<pod/perlos2.pod>.
20
21 To read the F<.INF> version of documentation (B<very> recommended)
22 outside of OS/2, one needs an IBM's reader (may be available on IBM
23 ftp sites (?)  (URL anyone?)) or shipped with PC DOS 7.0 and IBM's
24 Visual Age C++ 3.5.
25
26 A copy of a Win* viewer is contained in the "Just add OS/2 Warp" package
27
28   ftp://ftp.software.ibm.com/ps/products/os2/tools/jaow/jaow.zip
29
30 in F<?:\JUST_ADD\view.exe>. This gives one an access to EMX's 
31 F<.INF> docs as well (text form is available in F</emx/doc> in 
32 EMX's distribution).
33
34 Note that if you have F<lynx.exe> installed, you can follow WWW links
35 from this document in F<.INF> format. If you have EMX docs installed 
36 correctly, you can follow library links (you need to have C<view emxbook>
37 working by setting C<EMXBOOK> environment variable as it is described
38 in EMX docs).
39
40 =cut
41
42 Contents
43  
44  perlos2 - Perl under OS/2, DOS, Win0.3*, Win0.95 and WinNT. 
45
46       NAME 
47       SYNOPSIS 
48       DESCRIPTION 
49          -  Target 
50          -  Other OSes 
51          -  Prerequisites 
52          -  Starting Perl programs under OS/2 (and DOS and...)
53          -  Starting OS/2 (and DOS) programs under Perl 
54       Frequently asked questions 
55          -  I cannot run external programs 
56          -  I cannot embed perl into my program, or use perl.dll from my program. 
57          -  `` and pipe-open do not work under DOS. 
58          -  Cannot start find.exe "pattern" file
59       INSTALLATION 
60          -  Automatic binary installation 
61          -  Manual binary installation 
62          -  Warning 
63       Accessing documentation 
64          -  OS/2 .INF file 
65          -  Plain text 
66          -  Manpages 
67          -  HTML 
68          -  GNU info files 
69          -  .PDF files 
70          -  LaTeX docs 
71       BUILD 
72          -  Prerequisites 
73          -  Getting perl source 
74          -  Application of the patches 
75          -  Hand-editing 
76          -  Making 
77          -  Testing 
78          -  Installing the built perl 
79          -  a.out-style build 
80       Build FAQ 
81          -  Some / became \ in pdksh. 
82          -  'errno' - unresolved external 
83          -  Problems with tr 
84          -  Some problem (forget which ;-) 
85          -  Library ... not found 
86          -  Segfault in make 
87       Specific (mis)features of EMX port 
88          -  setpriority, getpriority 
89          -  system() 
90          -  extproc on the first line
91          -  Additional modules: 
92          -  Prebuilt methods: 
93          -  Misfeatures 
94          -  Modifications 
95       Perl flavors 
96          -  perl.exe 
97          -  perl_.exe 
98          -  perl__.exe 
99          -  perl___.exe 
100          -  Why strange names? 
101          -  Why dynamic linking? 
102          -  Why chimera build? 
103       ENVIRONMENT 
104          -  PERLLIB_PREFIX 
105          -  PERL_BADLANG 
106          -  PERL_BADFREE 
107          -  PERL_SH_DIR 
108          -  TMP or TEMP 
109       Evolution 
110          -  Priorities 
111          -  DLL name mangling 
112          -  Threading 
113          -  Calls to external programs 
114          -  Memory allocation 
115          -  Threads
116       AUTHOR 
117       SEE ALSO 
118   
119 =head1 DESCRIPTION
120
121 =head2 Target
122
123 The target is to make OS/2 the best supported platform for
124 using/building/developing Perl and I<Perl applications>, as well as
125 make Perl the best language to use under OS/2. The secondary target is
126 to try to make this work under DOS and Win* as well (but not B<too> hard).
127
128 The current state is quite close to this target. Known limitations:
129
130 =over 5
131
132 =item *
133
134 Some *nix programs use fork() a lot, but currently fork() is not
135 supported after I<use>ing dynamically loaded extensions.
136
137 =item *
138
139 You need a separate perl executable F<perl__.exe> (see L<perl__.exe>)
140 to use PM code in your application (like the forthcoming Perl/Tk).
141
142 =item *
143
144 There is no simple way to access WPS objects. The only way I know
145 is via C<OS2::REXX> extension (see L<OS2::REXX>), and we do not have access to
146 convenience methods of Object-REXX. (Is it possible at all? I know
147 of no Object-REXX API.)
148
149 =back
150
151 Please keep this list up-to-date by informing me about other items.
152
153 =head2 Other OSes
154
155 Since OS/2 port of perl uses a remarkable EMX environment, it can
156 run (and build extensions, and - possibly - be build itself) under any
157 environment which can run EMX. The current list is DOS,
158 DOS-inside-OS/2, Win0.3*, Win0.95 and WinNT. Out of many perl flavors,
159 only one works, see L<"perl_.exe">.
160
161 Note that not all features of Perl are available under these
162 environments. This depends on the features the I<extender> - most
163 probably RSX - decided to implement.
164
165 Cf. L<Prerequisites>.
166
167 =head2 Prerequisites
168
169 =over 6
170
171 =item EMX
172
173 EMX runtime is required (may be substituted by RSX). Note that
174 it is possible to make F<perl_.exe> to run under DOS without any
175 external support by binding F<emx.exe>/F<rsx.exe> to it, see L<emxbind>. Note
176 that under DOS for best results one should use RSX runtime, which
177 has much more functions working (like C<fork>, C<popen> and so on). In
178 fact RSX is required if there is no VCPI present. Note the
179 RSX requires DPMI.
180
181 Only the latest runtime is supported, currently C<0.9d fix 03>. Perl may run
182 under earlier versions of EMX, but this is not tested.
183
184 One can get different parts of EMX from, say
185
186   http://www.leo.org/pub/comp/os/os2/leo/gnu/emx+gcc/
187   http://powerusersbbs.com/pub/os2/dev/   [EMX+GCC Development]
188   http://hobbes.nmsu.edu/pub/os2/dev/emx/v0.9d/
189
190 The runtime component should have the name F<emxrt.zip>.
191
192 B<NOTE>. It is enough to have F<emx.exe>/F<rsx.exe> on your path. One
193 does not need to specify them explicitly (though this
194
195   emx perl_.exe -de 0
196
197 will work as well.)
198
199 =item RSX
200
201 To run Perl on DPMI platforms one needs RSX runtime. This is
202 needed under DOS-inside-OS/2, Win0.3*, Win0.95 and WinNT (see 
203 L<"Other OSes">). RSX would not work with VCPI
204 only, as EMX would, it requires DMPI.
205
206 Having RSX and the latest F<sh.exe> one gets a fully functional
207 B<*nix>-ish environment under DOS, say, C<fork>, C<``> and
208 pipe-C<open> work. In fact, MakeMaker works (for static build), so one
209 can have Perl development environment under DOS. 
210
211 One can get RSX from, say
212
213   ftp://ftp.cdrom.com/pub/os2/emx09c/contrib
214   ftp://ftp.uni-bielefeld.de/pub/systems/msdos/misc
215   ftp://ftp.leo.org/pub/comp/os/os2/leo/devtools/emx+gcc/contrib
216
217 Contact the author on C<rainer@mathematik.uni-bielefeld.de>.
218
219 The latest F<sh.exe> with DOS hooks is available at
220
221   ftp://ftp.math.ohio-state.edu/pub/users/ilya/os2/sh_dos.zip
222
223 =item HPFS
224
225 Perl does not care about file systems, but to install the whole perl
226 library intact one needs a file system which supports long file names.
227
228 Note that if you do not plan to build the perl itself, it may be
229 possible to fool EMX to truncate file names. This is not supported,
230 read EMX docs to see how to do it.
231
232 =item pdksh
233
234 To start external programs with complicated command lines (like with
235 pipes in between, and/or quoting of arguments), Perl uses an external
236 shell. With EMX port such shell should be named <sh.exe>, and located
237 either in the wired-in-during-compile locations (usually F<F:/bin>),
238 or in configurable location (see L<"PERL_SH_DIR">).
239
240 For best results use EMX pdksh. The soon-to-be-available standard
241 binary (5.2.12?) runs under DOS (with L<RSX>) as well, meanwhile use
242 the binary from
243
244   ftp://ftp.math.ohio-state.edu/pub/users/ilya/os2/sh_dos.zip
245
246 =back
247
248 =head2 Starting Perl programs under OS/2 (and DOS and...)
249
250 Start your Perl program F<foo.pl> with arguments C<arg1 arg2 arg3> the
251 same way as on any other platform, by
252
253         perl foo.pl arg1 arg2 arg3
254
255 If you want to specify perl options C<-my_opts> to the perl itself (as
256 opposed to to your program), use
257
258         perl -my_opts foo.pl arg1 arg2 arg3
259
260 Alternately, if you use OS/2-ish shell, like CMD or 4os2, put
261 the following at the start of your perl script:
262
263         extproc perl -S -my_opts
264
265 rename your program to F<foo.cmd>, and start it by typing
266
267         foo arg1 arg2 arg3
268
269 Note that because of stupid OS/2 limitations the full path of the perl
270 script is not available when you use C<extproc>, thus you are forced to
271 use C<-S> perl switch, and your script should be on path. As a plus
272 side, if you know a full path to your script, you may still start it
273 with 
274
275         perl ../../blah/foo.cmd arg1 arg2 arg3
276
277 (note that the argument C<-my_opts> is taken care of by the C<extproc> line
278 in your script, see L<C<extproc> on the first line>).
279
280 To understand what the above I<magic> does, read perl docs about C<-S>
281 switch - see L<perlrun>, and cmdref about C<extproc>:
282
283         view perl perlrun
284         man perlrun
285         view cmdref extproc
286         help extproc
287
288 or whatever method you prefer.
289
290 There are also endless possibilities to use I<executable extensions> of
291 4os2, I<associations> of WPS and so on... However, if you use
292 *nixish shell (like F<sh.exe> supplied in the binary distribution),
293 you need to follow the syntax specified in L<perlrun/"Switches">.
294
295 Note that B<-S> switch enables a search with additional extensions 
296 F<.cmd>, F<.btm>, F<.bat>, F<.pl> as well.
297
298 =head2 Starting OS/2 (and DOS) programs under Perl
299
300 This is what system() (see L<perlfunc/system>), C<``> (see
301 L<perlop/"I/O Operators">), and I<open pipe> (see L<perlfunc/open>)
302 are for. (Avoid exec() (see L<perlfunc/exec>) unless you know what you
303 do).
304
305 Note however that to use some of these operators you need to have a
306 sh-syntax shell installed (see L<"Pdksh">, 
307 L<"Frequently asked questions">), and perl should be able to find it
308 (see L<"PERL_SH_DIR">).
309
310 The cases when the shell is used are:
311
312 =over
313
314 =item 1
315
316 One-argument system() (see L<perlfunc/system>), exec() (see L<perlfunc/exec>)
317 with redirection or shell meta-characters;
318
319 =item 2
320
321 Pipe-open (see L<perlfunc/open>) with the command which contains redirection 
322 or shell meta-characters;
323
324 =item 3
325
326 Backticks C<``> (see L<perlop/"I/O Operators">) with the command which contains
327 redirection or shell meta-characters;
328
329 =item 4
330
331 If the executable called by system()/exec()/pipe-open()/C<``> is a script
332 with the "magic" C<#!> line or C<extproc> line which specifies shell;
333
334 =item 5
335
336 If the executable called by system()/exec()/pipe-open()/C<``> is a script
337 without "magic" line, and C<$ENV{EXECSHELL}> is set to shell;
338
339 =item 6
340
341 If the executable called by system()/exec()/pipe-open()/C<``> is not
342 found;
343
344 =item 7
345
346 For globbing (see L<perlfunc/glob>, L<perlop/"I/O Operators">).
347
348 =back
349
350 For the sake of speed for a common case, in the above algorithms 
351 backslashes in the command name are not considered as shell metacharacters.
352
353 Perl starts scripts which begin with cookies
354 C<extproc> or C<#!> directly, without an intervention of shell.  Perl uses the
355 same algorithm to find the executable as F<pdksh>: if the path
356 on C<#!> line does not work, and contains C</>, then the executable
357 is searched in F<.> and on C<PATH>.  To find arguments for these scripts
358 Perl uses a different algorithm than F<pdksh>: up to 3 arguments are 
359 recognized, and trailing whitespace is stripped.
360
361 If a script
362 does not contain such a cooky, then to avoid calling F<sh.exe>, Perl uses
363 the same algorithm as F<pdksh>: if C<$ENV{EXECSHELL}> is set, the
364 script is given as the first argument to this command, if not set, then
365 C<$ENV{COMSPEC} /c> is used (or a hardwired guess if C<$ENV{COMSPEC}> is
366 not set).
367
368 If starting scripts directly, Perl will use exactly the same algorithm as for 
369 the search of script given by B<-S> command-line option: it will look in
370 the current directory, then on components of C<$ENV{PATH}> using the 
371 following order of appended extensions: no extension, F<.cmd>, F<.btm>, 
372 F<.bat>, F<.pl>.
373
374 Note that Perl will start to look for scripts only if OS/2 cannot start the
375 specified application, thus C<system 'blah'> will not look for a script if 
376 there is an executable file F<blah.exe> I<anywhere> on C<PATH>.  
377
378 Note also that executable files on OS/2 can have an arbitrary extension, 
379 but F<.exe> will be automatically appended if no dot is present in the name.  
380 The workaround as as simple as that:  since F<blah.> and F<blah> denote the 
381 same file, to start an executable residing in file F<n:/bin/blah> (no 
382 extension) give an argument C<n:/bin/blah.> to system().
383
384 The last note is that currently it is not straightforward to start PM 
385 programs from VIO (=text-mode) Perl process and visa versa.  Either ensure
386 that shell will be used, as in C<system 'cmd /c epm'>, or start it using
387 optional arguments to system() documented in C<OS2::Process> module.  This
388 is considered a bug and should be fixed soon.
389
390
391 =head1 Frequently asked questions
392
393 =head2 I cannot run external programs
394
395 =over 4
396
397 =item
398
399 Did you run your programs with C<-w> switch? See 
400 L<Starting OS/2 (and DOS) programs under Perl>.
401
402 =item
403
404 Do you try to run I<internal> shell commands, like C<`copy a b`>
405 (internal for F<cmd.exe>), or C<`glob a*b`> (internal for ksh)? You
406 need to specify your shell explicitly, like C<`cmd /c copy a b`>,
407 since Perl cannot deduce which commands are internal to your shell.
408
409 =back
410
411 =head2 I cannot embed perl into my program, or use F<perl.dll> from my
412 program. 
413
414 =over 4
415
416 =item Is your program EMX-compiled with C<-Zmt -Zcrtdll>?
417
418 If not, you need to build a stand-alone DLL for perl. Contact me, I
419 did it once. Sockets would not work, as a lot of other stuff.
420
421 =item Did you use L<ExtUtils::Embed>?
422
423 I had reports it does not work. Somebody would need to fix it.
424
425 =back
426
427 =head2 C<``> and pipe-C<open> do not work under DOS.
428
429 This may a variant of just L<"I cannot run external programs">, or a
430 deeper problem. Basically: you I<need> RSX (see L<"Prerequisites">)
431 for these commands to work, and you may need a port of F<sh.exe> which
432 understands command arguments. One of such ports is listed in
433 L<"Prerequisites"> under RSX. Do not forget to set variable
434 C<L<"PERL_SH_DIR">> as well.
435
436 DPMI is required for RSX.
437
438 =head2 Cannot start C<find.exe "pattern" file>
439
440 Use one of
441
442   system 'cmd', '/c', 'find "pattern" file';
443   `cmd /c 'find "pattern" file'`
444
445 This would start F<find.exe> via F<cmd.exe> via C<sh.exe> via
446 C<perl.exe>, but this is a price to pay if you want to use
447 non-conforming program. In fact F<find.exe> cannot be started at all
448 using C library API only. Otherwise the following command-lines were
449 equivalent:
450
451   find "pattern" file
452   find pattern file
453
454 =head1 INSTALLATION
455
456 =head2 Automatic binary installation
457
458 The most convenient way of installing perl is via perl installer
459 F<install.exe>. Just follow the instructions, and 99% of the
460 installation blues would go away. 
461
462 Note however, that you need to have F<unzip.exe> on your path, and
463 EMX environment I<running>. The latter means that if you just
464 installed EMX, and made all the needed changes to F<Config.sys>,
465 you may need to reboot in between. Check EMX runtime by running
466
467         emxrev
468
469 A folder is created on your desktop which contains some useful
470 objects.
471
472 B<Things not taken care of by automatic binary installation:>
473
474 =over 15
475
476 =item C<PERL_BADLANG>
477
478 may be needed if you change your codepage I<after> perl installation,
479 and the new value is not supported by EMX. See L<"PERL_BADLANG">.
480
481 =item C<PERL_BADFREE>
482
483 see L<"PERL_BADFREE">.
484
485 =item F<Config.pm>
486
487 This file resides somewhere deep in the location you installed your
488 perl library, find it out by 
489
490   perl -MConfig -le "print $INC{'Config.pm'}"
491
492 While most important values in this file I<are> updated by the binary
493 installer, some of them may need to be hand-edited. I know no such
494 data, please keep me informed if you find one.
495
496 =back
497
498 B<NOTE>. Because of a typo the binary installer of 5.00305
499 would install a variable C<PERL_SHPATH> into F<Config.sys>. Please
500 remove this variable and put C<L<PERL_SH_DIR>> instead.
501
502 =head2 Manual binary installation
503
504 As of version 5.00305, OS/2 perl binary distribution comes split
505 into 11 components. Unfortunately, to enable configurable binary
506 installation, the file paths in the zip files are not absolute, but
507 relative to some directory.
508
509 Note that the extraction with the stored paths is still necessary
510 (default with unzip, specify C<-d> to pkunzip). However, you
511 need to know where to extract the files. You need also to manually
512 change entries in F<Config.sys> to reflect where did you put the
513 files. Note that if you have some primitive unzipper (like
514 pkunzip), you may get a lot of warnings/errors during
515 unzipping. Upgrade to C<(w)unzip>.
516
517 Below is the sample of what to do to reproduce the configuration on my
518 machine:
519
520 =over 3
521
522 =item Perl VIO and PM executables (dynamically linked)
523
524   unzip perl_exc.zip *.exe *.ico -d f:/emx.add/bin
525   unzip perl_exc.zip *.dll -d f:/emx.add/dll
526
527 (have the directories with C<*.exe> on PATH, and C<*.dll> on
528 LIBPATH);
529
530 =item Perl_ VIO executable (statically linked)
531
532   unzip perl_aou.zip -d f:/emx.add/bin
533
534 (have the directory on PATH);
535
536 =item Executables for Perl utilities
537
538   unzip perl_utl.zip -d f:/emx.add/bin
539
540 (have the directory on PATH);
541
542 =item Main Perl library
543
544   unzip perl_mlb.zip -d f:/perllib/lib
545
546 If this directory is preserved, you do not need to change
547 anything. However, for perl to find it if it is changed, you need to
548 C<set PERLLIB_PREFIX> in F<Config.sys>, see L<"PERLLIB_PREFIX">.
549
550 =item Additional Perl modules
551
552   unzip perl_ste.zip -d f:/perllib/lib/site_perl
553
554 If you do not change this directory, do nothing. Otherwise put this
555 directory and subdirectory F<./os2> in C<PERLLIB> or C<PERL5LIB>
556 variable. Do not use C<PERL5LIB> unless you have it set already. See
557 L<perl/"ENVIRONMENT">. 
558
559 =item Tools to compile Perl modules
560
561   unzip perl_blb.zip -d f:/perllib/lib
562
563 If this directory is preserved, you do not need to change
564 anything. However, for perl to find it if it is changed, you need to
565 C<set PERLLIB_PREFIX> in F<Config.sys>, see L<"PERLLIB_PREFIX">.
566
567 =item Manpages for Perl and utilities
568
569   unzip perl_man.zip -d f:/perllib/man
570
571 This directory should better be on C<MANPATH>. You need to have a
572 working man to access these files.
573
574 =item Manpages for Perl modules
575
576   unzip perl_mam.zip -d f:/perllib/man
577
578 This directory should better be on C<MANPATH>. You need to have a
579 working man to access these files.
580
581 =item Source for Perl documentation
582
583   unzip perl_pod.zip -d f:/perllib/lib
584
585 This is used by by C<perldoc> program (see L<perldoc>), and may be used to
586 generate HTML documentation usable by WWW browsers, and
587 documentation in zillions of other formats: C<info>, C<LaTeX>,
588 C<Acrobat>, C<FrameMaker> and so on.
589
590 =item Perl manual in F<.INF> format
591
592   unzip perl_inf.zip -d d:/os2/book
593
594 This directory should better be on C<BOOKSHELF>.
595
596 =item Pdksh
597
598   unzip perl_sh.zip -d f:/bin
599
600 This is used by perl to run external commands which explicitly
601 require shell, like the commands using I<redirection> and I<shell
602 metacharacters>. It is also used instead of explicit F</bin/sh>.
603
604 Set C<PERL_SH_DIR> (see L<"PERL_SH_DIR">) if you move F<sh.exe> from
605 the above location.
606
607 B<Note.> It may be possible to use some other sh-compatible shell
608 (I<not tested>).
609
610 =back
611
612 After you installed the components you needed and updated the
613 F<Config.sys> correspondingly, you need to hand-edit
614 F<Config.pm>. This file resides somewhere deep in the location you
615 installed your perl library, find it out by
616
617   perl -MConfig -le "print $INC{'Config.pm'}"
618
619 You need to correct all the entries which look like file paths (they
620 currently start with C<f:/>).
621
622 =head2 B<Warning>
623
624 The automatic and manual perl installation leave precompiled paths
625 inside perl executables. While these paths are overwriteable (see
626 L<"PERLLIB_PREFIX">, L<"PERL_SH_DIR">), one may get better results by
627 binary editing of paths inside the executables/DLLs.
628
629 =head1 Accessing documentation
630
631 Depending on how you built/installed perl you may have (otherwise
632 identical) Perl documentation in the following formats:
633
634 =head2 OS/2 F<.INF> file
635
636 Most probably the most convenient form. Under OS/2 view it as
637
638   view perl
639   view perl perlfunc
640   view perl less
641   view perl ExtUtils::MakeMaker
642
643 (currently the last two may hit a wrong location, but this may improve
644 soon). Under Win* see L<"SYNOPSIS">.
645
646 If you want to build the docs yourself, and have I<OS/2 toolkit>, run
647
648         pod2ipf > perl.ipf
649
650 in F</perllib/lib/pod> directory, then
651
652         ipfc /inf perl.ipf
653
654 (Expect a lot of errors during the both steps.) Now move it on your
655 BOOKSHELF path.
656
657 =head2 Plain text
658
659 If you have perl documentation in the source form, perl utilities
660 installed, and GNU groff installed, you may use 
661
662         perldoc perlfunc
663         perldoc less
664         perldoc ExtUtils::MakeMaker
665
666 to access the perl documentation in the text form (note that you may get
667 better results using perl manpages).
668
669 Alternately, try running pod2text on F<.pod> files.
670
671 =head2 Manpages
672
673 If you have man installed on your system, and you installed perl
674 manpages, use something like this:
675
676         man perlfunc
677         man 3 less
678         man ExtUtils.MakeMaker
679
680 to access documentation for different components of Perl. Start with
681
682         man perl
683
684 Note that dot (F<.>) is used as a package separator for documentation
685 for packages, and as usual, sometimes you need to give the section - C<3>
686 above - to avoid shadowing by the I<less(1) manpage>.
687
688 Make sure that the directory B<above> the directory with manpages is
689 on our C<MANPATH>, like this
690
691   set MANPATH=c:/man;f:/perllib/man
692
693 =head2 HTML
694
695 If you have some WWW browser available, installed the Perl
696 documentation in the source form, and Perl utilities, you can build
697 HTML docs. Cd to directory with F<.pod> files, and do like this
698
699         cd f:/perllib/lib/pod
700         pod2html
701
702 After this you can direct your browser the file F<perl.html> in this
703 directory, and go ahead with reading docs, like this:
704
705         explore file:///f:/perllib/lib/pod/perl.html
706
707 Alternatively you may be able to get these docs prebuilt from CPAN.
708
709 =head2 GNU C<info> files
710
711 Users of Emacs would appreciate it very much, especially with
712 C<CPerl> mode loaded. You need to get latest C<pod2info> from C<CPAN>,
713 or, alternately, prebuilt info pages.
714
715 =head2 F<.PDF> files
716
717 for C<Acrobat> are available on CPAN (for slightly old version of
718 perl).
719
720 =head2 C<LaTeX> docs
721
722 can be constructed using C<pod2latex>.
723
724 =head1 BUILD
725
726 Here we discuss how to build Perl under OS/2. There is an alternative
727 (but maybe older) view on L<http://www.shadow.net/~troc/os2perl.html>.
728
729 =head2 Prerequisites
730
731 You need to have the latest EMX development environment, the full
732 GNU tool suite (gawk renamed to awk, and GNU F<find.exe>
733 earlier on path than the OS/2 F<find.exe>, same with F<sort.exe>, to
734 check use
735
736   find --version
737   sort --version
738
739 ). You need the latest version of F<pdksh> installed as F<sh.exe>.
740
741 Check that you have B<BSD> libraries and headers installed, and - 
742 optionally - Berkeley DB headers and libraries, and crypt.
743
744 Possible locations to get this from are
745
746   ftp://hobbes.nmsu.edu/os2/unix/
747   ftp://ftp.cdrom.com/pub/os2/unix/
748   ftp://ftp.cdrom.com/pub/os2/dev32/
749   ftp://ftp.cdrom.com/pub/os2/emx09c/
750
751 It is reported that the following archives contain enough utils to
752 build perl: gnufutil.zip, gnusutil.zip, gnututil.zip, gnused.zip,
753 gnupatch.zip, gnuawk.zip, gnumake.zip and ksh527rt.zip.  Note that
754 all these utilities are known to be available from LEO:
755
756   ftp://ftp.leo.org/pub/comp/os/os2/leo/gnu
757
758 Make sure that no copies or perl are currently running.  Later steps
759 of the build may fail since an older version of perl.dll loaded into
760 memory may be found. 
761
762 Also make sure that you have F</tmp> directory on the current drive,
763 and F<.> directory in your C<LIBPATH>. One may try to correct the
764 latter condition by
765
766   set BEGINLIBPATH .
767
768 if you use something like F<CMD.EXE> or latest versions of F<4os2.exe>.
769
770 Make sure your gcc is good for C<-Zomf> linking: run C<omflibs>
771 script in F</emx/lib> directory.
772
773 Check that you have link386 installed. It comes standard with OS/2,
774 but may be not installed due to customization. If typing
775
776   link386
777
778 shows you do not have it, do I<Selective install>, and choose C<Link
779 object modules> in I<Optional system utilities/More>. If you get into
780 link386, press C<Ctrl-C>.
781
782 =head2 Getting perl source
783
784 You need to fetch the latest perl source (including developers
785 releases). With some probability it is located in 
786
787   http://www.perl.com/CPAN/src/5.0
788   http://www.perl.com/CPAN/src/5.0/unsupported
789
790 If not, you may need to dig in the indices to find it in the directory
791 of the current maintainer.
792
793 Quick cycle of developers release may break the OS/2 build time to
794 time, looking into 
795
796   http://www.perl.com/CPAN/ports/os2/ilyaz/
797
798 may indicate the latest release which was publicly released by the
799 maintainer. Note that the release may include some additional patches
800 to apply to the current source of perl.
801
802 Extract it like this
803
804   tar vzxf perl5.00409.tar.gz
805
806 You may see a message about errors while extracting F<Configure>. This is
807 because there is a conflict with a similarly-named file F<configure>.
808
809 Change to the directory of extraction.
810
811 =head2 Application of the patches
812
813 You need to apply the patches in F<./os2/diff.*> like this:
814
815   gnupatch -p0 < os2\diff.configure
816
817 You may also need to apply the patches supplied with the binary
818 distribution of perl.
819
820 Note also that the F<db.lib> and F<db.a> from the EMX distribution
821 are not suitable for multi-threaded compile (note that currently perl
822 is not multithread-safe, but is compiled as multithreaded for
823 compatibility with XFree86-OS/2). Get a corrected one from
824
825   ftp://ftp.math.ohio-state.edu/pub/users/ilya/os2/db_mt.zip
826
827 To make C<-p> filetest work, one may also need to apply the following patch
828 to EMX headers:
829
830   --- /emx/include/sys/stat.h.orig      Thu May 23 13:48:16 1996
831   +++ /emx/include/sys/stat.h   Sun Jul 12 14:11:32 1998
832   @@ -53,7 +53,7 @@ struct stat
833    #endif
834
835    #if !defined (S_IFMT)
836   -#define S_IFMT   0160000  /* Mask for file type */
837   +#define S_IFMT   0170000  /* Mask for file type */
838    #define S_IFIFO  0010000  /* Pipe */
839    #define S_IFCHR  0020000  /* Character device */
840    #define S_IFDIR  0040000  /* Directory */
841
842
843 =head2 Hand-editing
844
845 You may look into the file F<./hints/os2.sh> and correct anything
846 wrong you find there. I do not expect it is needed anywhere.
847
848 =head2 Making
849
850   sh Configure -des -D prefix=f:/perllib
851
852 C<prefix> means: where to install the resulting perl library. Giving
853 correct prefix you may avoid the need to specify C<PERLLIB_PREFIX>,
854 see L<"PERLLIB_PREFIX">.
855
856 I<Ignore the message about missing C<ln>, and about C<-c> option to
857 tr>. In fact if you can trace where the latter spurious warning
858 comes from, please inform me.
859
860 Now
861
862   make
863
864 At some moment the built may die, reporting a I<version mismatch> or
865 I<unable to run F<perl>>. This means that most of the build has been
866 finished, and it is the time to move the constructed F<perl.dll> to
867 some I<absolute> location in LIBPATH. After this is done the build
868 should finish without a lot of fuss. I<One can avoid the interruption
869 if one has the correct prebuilt version of F<perl.dll> on LIBPATH, but
870 probably this is not needed anymore, since F<miniperl.exe> is linked
871 statically now.>
872
873 Warnings which are safe to ignore: I<mkfifo() redefined> inside
874 F<POSIX.c>.
875
876 =head2 Testing
877
878 If you haven't yet moved perl.dll onto LIBPATH, do it now (alternatively, if
879 you have a previous perl installation you'd rather not disrupt until this one
880 is installed, copy perl.dll to the t directory).
881
882 Now run
883
884   make test
885
886 All tests should succeed (with some of them skipped).  Note that on one
887 of the systems I see intermittent failures of F<io/pipe.t> subtest 9.
888 Any help to track what happens with this test is appreciated.
889
890 Some tests may generate extra messages similar to
891
892 =over 4
893
894 =item A lot of C<bad free>
895
896 in database tests related to Berkeley DB. This is a confirmed bug of
897 DB. You may disable this warnings, see L<"PERL_BADFREE">.
898
899 There is not much we can do with it (but apparently it does not cause 
900 any real error with data).
901
902 =item Process terminated by SIGTERM/SIGINT
903
904 This is a standard message issued by OS/2 applications. *nix
905 applications die in silence. It is considered a feature. One can
906 easily disable this by appropriate sighandlers. 
907
908 However the test engine bleeds these message to screen in unexpected
909 moments. Two messages of this kind I<should> be present during
910 testing.
911
912 =back
913
914 Two F<lib/io_*> tests may generate popups (system error C<SYS3175>), 
915 but should succeed anyway.  This is due to a bug of EMX related to 
916 fork()ing with dynamically loaded libraries.
917
918 I submitted a patch to EMX which makes it possible to fork() with EMX 
919 dynamic libraries loaded, which makes F<lib/io*> tests pass without
920 skipping offended tests. This means that soon the number of skipped tests
921 may decrease yet more.
922
923 To get finer test reports, call
924
925   perl t/harness
926
927 The report with F<io/pipe.t> failing may look like this:
928
929   Failed Test  Status Wstat Total Fail  Failed  List of failed
930   ------------------------------------------------------------
931   io/pipe.t                    12    1   8.33%  9
932   7 tests skipped, plus 56 subtests skipped.
933   Failed 1/195 test scripts, 99.49% okay. 1/6542 subtests failed, 99.98% okay.
934
935 The reasons for most important skipped tests are:
936
937 =over 8
938
939 =item F<op/fs.t>
940
941 =over 4
942
943 =item 18
944
945 Checks C<atime> and C<mtime> of C<stat()> - unfortunately, HPFS
946 provides only 2sec time granularity (for compatibility with FAT?).
947
948 =item 25
949
950 Checks C<truncate()> on a filehandle just opened for write - I do not
951 know why this should or should not work.
952
953 =back
954
955 =item F<lib/io_pipe.t>
956
957 Checks C<IO::Pipe> module. Some feature of EMX - test fork()s with
958 dynamic extension loaded - unsupported now.
959
960 =item F<lib/io_sock.t>
961
962 Checks C<IO::Socket> module. Some feature of EMX - test fork()s
963 with dynamic extension loaded - unsupported now.
964
965 =item F<op/stat.t>
966
967 Checks C<stat()>. Tests:
968
969 =over 4
970
971 =item 4
972
973 Checks C<atime> and C<mtime> of C<stat()> - unfortunately, HPFS
974 provides only 2sec time granularity (for compatibility with FAT?).
975
976 =back
977
978 =item F<lib/io_udp.t>
979
980 It never terminates, apparently some bug in storing the last socket from
981 which we obtained a message.
982
983 =back
984
985 =head2 Installing the built perl
986
987 If you haven't yet moved perl.dll onto LIBPATH, do it now.
988
989 Run
990
991   make install
992
993 It would put the generated files into needed locations. Manually put
994 F<perl.exe>, F<perl__.exe> and F<perl___.exe> to a location on your
995 PATH, F<perl.dll> to a location on your LIBPATH.
996
997 Run
998
999   make cmdscripts INSTALLCMDDIR=d:/ir/on/path
1000
1001 to convert perl utilities to F<.cmd> files and put them on
1002 PATH. You need to put F<.EXE>-utilities on path manually. They are
1003 installed in C<$prefix/bin>, here C<$prefix> is what you gave to
1004 F<Configure>, see L<Making>.
1005
1006 =head2 C<a.out>-style build
1007
1008 Proceed as above, but make F<perl_.exe> (see L<"perl_.exe">) by
1009
1010   make perl_
1011
1012 test and install by
1013
1014   make aout_test
1015   make aout_install
1016
1017 Manually put F<perl_.exe> to a location on your PATH.
1018
1019 Since C<perl_> has the extensions prebuilt, it does not suffer from
1020 the I<dynamic extensions + fork()> syndrome, thus the failing tests
1021 look like
1022
1023   Failed Test  Status Wstat Total Fail  Failed  List of failed
1024   ---------------------------------------------------------------
1025   io/fs.t                      26   11  42.31%  2-5, 7-11, 18, 25
1026   op/stat.t                    56    5   8.93%  3-4, 20, 35, 39
1027   Failed 2/118 test scripts, 98.31% okay. 16/2445 subtests failed, 99.35% okay.
1028
1029 B<Note.> The build process for C<perl_> I<does not know> about all the
1030 dependencies, so you should make sure that anything is up-to-date,
1031 say, by doing
1032
1033   make perl.dll
1034
1035 first.
1036
1037 =head1 Build FAQ
1038
1039 =head2 Some C</> became C<\> in pdksh.
1040
1041 You have a very old pdksh. See L<Prerequisites>.
1042
1043 =head2 C<'errno'> - unresolved external
1044
1045 You do not have MT-safe F<db.lib>. See L<Prerequisites>.
1046
1047 =head2 Problems with tr or sed
1048
1049 reported with very old version of tr and sed.
1050
1051 =head2 Some problem (forget which ;-)
1052
1053 You have an older version of F<perl.dll> on your LIBPATH, which
1054 broke the build of extensions.
1055
1056 =head2 Library ... not found
1057
1058 You did not run C<omflibs>. See L<Prerequisites>.
1059
1060 =head2 Segfault in make
1061
1062 You use an old version of GNU make. See L<Prerequisites>.
1063
1064 =head2 op/sprintf test failure
1065
1066 This can result from a bug in emx sprintf which was fixed in 0.9d fix 03.
1067
1068 =head1 Specific (mis)features of OS/2 port
1069
1070 =head2 C<setpriority>, C<getpriority>
1071
1072 Note that these functions are compatible with *nix, not with the older
1073 ports of '94 - 95. The priorities are absolute, go from 32 to -95,
1074 lower is quicker. 0 is the default priority.
1075
1076 =head2 C<system()>
1077
1078 Multi-argument form of C<system()> allows an additional numeric
1079 argument. The meaning of this argument is described in
1080 L<OS2::Process>.
1081
1082 =head2 C<extproc> on the first line
1083
1084 If the first chars of a script are C<"extproc ">, this line is treated
1085 as C<#!>-line, thus all the switches on this line are processed (twice
1086 if script was started via cmd.exe).
1087
1088 =head2 Additional modules:
1089
1090 L<OS2::Process>, L<OS2::REXX>, L<OS2::PrfDB>, L<OS2::ExtAttr>. These
1091 modules provide access to additional numeric argument for C<system>
1092 and to the list of the running processes,
1093 to DLLs having functions with REXX signature and to REXX runtime, to
1094 OS/2 databases in the F<.INI> format, and to Extended Attributes.
1095
1096 Two additional extensions by Andreas Kaiser, C<OS2::UPM>, and
1097 C<OS2::FTP>, are included into my ftp directory, mirrored on CPAN.
1098
1099 =head2 Prebuilt methods:
1100
1101 =over 4
1102
1103 =item C<File::Copy::syscopy>
1104
1105 used by C<File::Copy::copy>, see L<File::Copy>.
1106
1107 =item C<DynaLoader::mod2fname>
1108
1109 used by C<DynaLoader> for DLL name mangling.
1110
1111 =item  C<Cwd::current_drive()>
1112
1113 Self explanatory.
1114
1115 =item  C<Cwd::sys_chdir(name)>
1116
1117 leaves drive as it is.
1118
1119 =item  C<Cwd::change_drive(name)>
1120
1121
1122 =item  C<Cwd::sys_is_absolute(name)>
1123
1124 means has drive letter and is_rooted.
1125
1126 =item  C<Cwd::sys_is_rooted(name)>
1127
1128 means has leading C<[/\\]> (maybe after a drive-letter:).
1129
1130 =item  C<Cwd::sys_is_relative(name)>
1131
1132 means changes with current dir.
1133
1134 =item  C<Cwd::sys_cwd(name)>
1135
1136 Interface to cwd from EMX. Used by C<Cwd::cwd>.
1137
1138 =item  C<Cwd::sys_abspath(name, dir)>
1139
1140 Really really odious function to implement. Returns absolute name of
1141 file which would have C<name> if CWD were C<dir>.  C<Dir> defaults to the
1142 current dir.
1143
1144 =item  C<Cwd::extLibpath([type])>
1145
1146 Get current value of extended library search path. If C<type> is
1147 present and I<true>, works with END_LIBPATH, otherwise with
1148 C<BEGIN_LIBPATH>. 
1149
1150 =item  C<Cwd::extLibpath_set( path [, type ] )>
1151
1152 Set current value of extended library search path. If C<type> is
1153 present and I<true>, works with END_LIBPATH, otherwise with
1154 C<BEGIN_LIBPATH>. 
1155
1156 =back
1157
1158 (Note that some of these may be moved to different libraries -
1159 eventually).
1160
1161
1162 =head2 Misfeatures
1163
1164 =over 4
1165
1166 =item
1167
1168 Since L<flock(3)> is present in EMX, but is not functional, it is 
1169 emulated by perl.  To disable the emulations, set environment variable
1170 C<USE_PERL_FLOCK=0>.
1171
1172 =item
1173
1174 Here is the list of things which may be "broken" on
1175 EMX (from EMX docs):
1176
1177 =over
1178
1179 =item *
1180
1181 The functions L<recvmsg(3)>, L<sendmsg(3)>, and L<socketpair(3)> are not
1182 implemented.
1183
1184 =item *
1185
1186 L<sock_init(3)> is not required and not implemented.
1187
1188 =item *
1189
1190 L<flock(3)> is not yet implemented (dummy function).  (Perl has a workaround.)
1191
1192 =item *
1193
1194 L<kill(3)>:  Special treatment of PID=0, PID=1 and PID=-1 is not implemented.
1195
1196 =item *
1197
1198 L<waitpid(3)>:
1199
1200       WUNTRACED
1201               Not implemented.
1202       waitpid() is not implemented for negative values of PID.
1203
1204 =back
1205
1206 Note that C<kill -9> does not work with the current version of EMX.
1207
1208 =item
1209
1210 Since F<sh.exe> is used for globing (see L<perlfunc/glob>), the bugs
1211 of F<sh.exe> plague perl as well. 
1212
1213 In particular, uppercase letters do not work in C<[...]>-patterns with
1214 the current pdksh.
1215
1216 =back
1217
1218 =head2 Modifications
1219
1220 Perl modifies some standard C library calls in the following ways:
1221
1222 =over 9
1223
1224 =item C<popen>
1225
1226 C<my_popen> uses F<sh.exe> if shell is required, cf. L<"PERL_SH_DIR">.
1227
1228 =item C<tmpnam>
1229
1230 is created using C<TMP> or C<TEMP> environment variable, via
1231 C<tempnam>.
1232
1233 =item C<tmpfile>
1234
1235 If the current directory is not writable, file is created using modified
1236 C<tmpnam>, so there may be a race condition.
1237
1238 =item C<ctermid>
1239
1240 a dummy implementation.
1241
1242 =item C<stat>
1243
1244 C<os2_stat> special-cases F</dev/tty> and F</dev/con>.
1245
1246 =item C<flock>
1247
1248 Since L<flock(3)> is present in EMX, but is not functional, it is 
1249 emulated by perl.  To disable the emulations, set environment variable
1250 C<USE_PERL_FLOCK=0>.
1251
1252 =back
1253
1254 =head1 Perl flavors
1255
1256 Because of idiosyncrasies of OS/2 one cannot have all the eggs in the
1257 same basket (though EMX environment tries hard to overcome this
1258 limitations, so the situation may somehow improve). There are 4
1259 executables for Perl provided by the distribution:
1260
1261 =head2 F<perl.exe>
1262
1263 The main workhorse. This is a chimera executable: it is compiled as an
1264 C<a.out>-style executable, but is linked with C<omf>-style dynamic
1265 library F<perl.dll>, and with dynamic CRT DLL. This executable is a
1266 VIO application.
1267
1268 It can load perl dynamic extensions, and it can fork(). Unfortunately,
1269 with the current version of EMX it cannot fork() with dynamic
1270 extensions loaded (may be fixed by patches to EMX).
1271
1272 B<Note.> Keep in mind that fork() is needed to open a pipe to yourself.
1273
1274 =head2 F<perl_.exe>
1275
1276 This is a statically linked C<a.out>-style executable. It can fork(),
1277 but cannot load dynamic Perl extensions. The supplied executable has a
1278 lot of extensions prebuilt, thus there are situations when it can
1279 perform tasks not possible using F<perl.exe>, like fork()ing when
1280 having some standard extension loaded. This executable is a VIO
1281 application.
1282
1283 B<Note.> A better behaviour could be obtained from C<perl.exe> if it
1284 were statically linked with standard I<Perl extensions>, but
1285 dynamically linked with the I<Perl DLL> and CRT DLL. Then it would
1286 be able to fork() with standard extensions, I<and> would be able to
1287 dynamically load arbitrary extensions. Some changes to Makefiles and
1288 hint files should be necessary to achieve this.
1289
1290 I<This is also the only executable with does not require OS/2.> The
1291 friends locked into C<M$> world would appreciate the fact that this
1292 executable runs under DOS, Win0.3*, Win0.95 and WinNT with an
1293 appropriate extender. See L<"Other OSes">.
1294
1295 =head2 F<perl__.exe>
1296
1297 This is the same executable as F<perl___.exe>, but it is a PM
1298 application. 
1299
1300 B<Note.> Usually STDIN, STDERR, and STDOUT of a PM
1301 application are redirected to C<nul>. However, it is possible to see
1302 them if you start C<perl__.exe> from a PM program which emulates a
1303 console window, like I<Shell mode> of Emacs or EPM. Thus it I<is
1304 possible> to use Perl debugger (see L<perldebug>) to debug your PM
1305 application.
1306
1307 This flavor is required if you load extensions which use PM, like
1308 the forthcoming C<Perl/Tk>.
1309
1310 =head2 F<perl___.exe>
1311
1312 This is an C<omf>-style executable which is dynamically linked to
1313 F<perl.dll> and CRT DLL. I know no advantages of this executable
1314 over C<perl.exe>, but it cannot fork() at all. Well, one advantage is
1315 that the build process is not so convoluted as with C<perl.exe>.
1316
1317 It is a VIO application.
1318
1319 =head2 Why strange names?
1320
1321 Since Perl processes the C<#!>-line (cf. 
1322 L<perlrun/DESCRIPTION>, L<perlrun/Switches>,
1323 L<perldiag/"Not a perl script">, 
1324 L<perldiag/"No Perl script found in input">), it should know when a
1325 program I<is a Perl>. There is some naming convention which allows
1326 Perl to distinguish correct lines from wrong ones. The above names are
1327 almost the only names allowed by this convention which do not contain
1328 digits (which have absolutely different semantics).
1329
1330 =head2 Why dynamic linking?
1331
1332 Well, having several executables dynamically linked to the same huge
1333 library has its advantages, but this would not substantiate the
1334 additional work to make it compile. The reason is stupid-but-quick
1335 "hard" dynamic linking used by OS/2.
1336
1337 The address tables of DLLs are patched only once, when they are
1338 loaded. The addresses of entry points into DLLs are guaranteed to be
1339 the same for all programs which use the same DLL, which reduces the
1340 amount of runtime patching - once DLL is loaded, its code is
1341 read-only.
1342
1343 While this allows some performance advantages, this makes life
1344 terrible for developers, since the above scheme makes it impossible
1345 for a DLL to be resolved to a symbol in the .EXE file, since this
1346 would need a DLL to have different relocations tables for the
1347 executables which use it.
1348
1349 However, a Perl extension is forced to use some symbols from the perl
1350 executable, say to know how to find the arguments provided on the perl
1351 internal evaluation stack. The solution is that the main code of
1352 interpreter should be contained in a DLL, and the F<.EXE> file just loads
1353 this DLL into memory and supplies command-arguments.
1354
1355 This I<greatly> increases the load time for the application (as well as
1356 the number of problems during compilation). Since interpreter is in a DLL,
1357 the CRT is basically forced to reside in a DLL as well (otherwise
1358 extensions would not be able to use CRT).
1359
1360 =head2 Why chimera build?
1361
1362 Current EMX environment does not allow DLLs compiled using Unixish
1363 C<a.out> format to export symbols for data. This forces C<omf>-style
1364 compile of F<perl.dll>.
1365
1366 Current EMX environment does not allow F<.EXE> files compiled in
1367 C<omf> format to fork(). fork() is needed for exactly three Perl
1368 operations:
1369
1370 =over 4
1371
1372 =item explicit fork()
1373
1374 in the script, and
1375
1376 =item open FH, "|-"
1377
1378 =item open FH, "-|"
1379
1380 opening pipes to itself.
1381
1382 =back
1383
1384 While these operations are not questions of life and death, a lot of
1385 useful scripts use them. This forces C<a.out>-style compile of
1386 F<perl.exe>.
1387
1388
1389 =head1 ENVIRONMENT
1390
1391 Here we list environment variables with are either OS/2- and DOS- and
1392 Win*-specific, or are more important under OS/2 than under other OSes.
1393
1394 =head2 C<PERLLIB_PREFIX>
1395
1396 Specific for EMX port. Should have the form
1397
1398   path1;path2
1399
1400 or
1401
1402   path1 path2
1403
1404 If the beginning of some prebuilt path matches F<path1>, it is
1405 substituted with F<path2>.
1406
1407 Should be used if the perl library is moved from the default
1408 location in preference to C<PERL(5)LIB>, since this would not leave wrong
1409 entries in @INC.  Say, if the compiled version of perl looks for @INC
1410 in F<f:/perllib/lib>, and you want to install the library in
1411 F<h:/opt/gnu>, do
1412
1413   set PERLLIB_PREFIX=f:/perllib/lib;h:/opt/gnu
1414
1415 =head2 C<PERL_BADLANG>
1416
1417 If 1, perl ignores setlocale() failing. May be useful with some
1418 strange I<locale>s.
1419
1420 =head2 C<PERL_BADFREE>
1421
1422 If 1, perl would not warn of in case of unwarranted free(). May be
1423 useful in conjunction with the module DB_File, since Berkeley DB
1424 memory handling code is buggy.
1425
1426 =head2 C<PERL_SH_DIR>
1427
1428 Specific for EMX port. Gives the directory part of the location for
1429 F<sh.exe>.
1430
1431 =head2 C<USE_PERL_FLOCK>
1432
1433 Specific for EMX port. Since L<flock(3)> is present in EMX, but is not 
1434 functional, it is emulated by perl.  To disable the emulations, set 
1435 environment variable C<USE_PERL_FLOCK=0>.
1436
1437 =head2 C<TMP> or C<TEMP>
1438
1439 Specific for EMX port. Used as storage place for temporary files, most
1440 notably C<-e> scripts.
1441
1442 =head1 Evolution
1443
1444 Here we list major changes which could make you by surprise.
1445
1446 =head2 Priorities
1447
1448 C<setpriority> and C<getpriority> are not compatible with earlier
1449 ports by Andreas Kaiser. See C<"setpriority, getpriority">.
1450
1451 =head2 DLL name mangling
1452
1453 With the release 5.003_01 the dynamically loadable libraries
1454 should be rebuilt. In particular, DLLs are now created with the names
1455 which contain a checksum, thus allowing workaround for OS/2 scheme of
1456 caching DLLs.
1457
1458 =head2 Threading
1459
1460 As of release 5.003_01 perl is linked to multithreaded CRT
1461 DLL.  If perl itself is not compiled multithread-enabled, so will not be perl
1462 malloc(). However, extensions may use multiple thread on their own
1463 risk. 
1464
1465 Needed to compile C<Perl/Tk> for XFree86-OS/2 out-of-the-box.
1466
1467 =head2 Calls to external programs
1468
1469 Due to a popular demand the perl external program calling has been
1470 changed wrt Andreas Kaiser's port.  I<If> perl needs to call an
1471 external program I<via shell>, the F<f:/bin/sh.exe> will be called, or
1472 whatever is the override, see L<"PERL_SH_DIR">.
1473
1474 Thus means that you need to get some copy of a F<sh.exe> as well (I
1475 use one from pdksh). The drive F<F:> above is set up automatically during
1476 the build to a correct value on the builder machine, but is
1477 overridable at runtime,
1478
1479 B<Reasons:> a consensus on C<perl5-porters> was that perl should use
1480 one non-overridable shell per platform. The obvious choices for OS/2
1481 are F<cmd.exe> and F<sh.exe>. Having perl build itself would be impossible
1482 with F<cmd.exe> as a shell, thus I picked up C<sh.exe>. Thus assures almost
1483 100% compatibility with the scripts coming from *nix. As an added benefit 
1484 this works as well under DOS if you use DOS-enabled port of pdksh 
1485 (see L<"Prerequisites">).
1486
1487 B<Disadvantages:> currently F<sh.exe> of pdksh calls external programs
1488 via fork()/exec(), and there is I<no> functioning exec() on
1489 OS/2. exec() is emulated by EMX by asynchronous call while the caller
1490 waits for child completion (to pretend that the C<pid> did not change). This
1491 means that 1 I<extra> copy of F<sh.exe> is made active via fork()/exec(),
1492 which may lead to some resources taken from the system (even if we do
1493 not count extra work needed for fork()ing).
1494
1495 Note that this a lesser issue now when we do not spawn F<sh.exe>
1496 unless needed (metachars found).
1497
1498 One can always start F<cmd.exe> explicitly via
1499
1500   system 'cmd', '/c', 'mycmd', 'arg1', 'arg2', ...
1501
1502 If you need to use F<cmd.exe>, and do not want to hand-edit thousands of your
1503 scripts, the long-term solution proposed on p5-p is to have a directive
1504
1505   use OS2::Cmd;
1506
1507 which will override system(), exec(), C<``>, and
1508 C<open(,'...|')>. With current perl you may override only system(),
1509 readpipe() - the explicit version of C<``>, and maybe exec(). The code
1510 will substitute the one-argument call to system() by
1511 C<CORE::system('cmd.exe', '/c', shift)>.
1512
1513 If you have some working code for C<OS2::Cmd>, please send it to me,
1514 I will include it into distribution. I have no need for such a module, so
1515 cannot test it.
1516
1517 For the details of the current situation with calling external programs,
1518 see L<Starting OS/2 (and DOS) programs under Perl>.
1519
1520 =over
1521
1522 =item
1523
1524 External scripts may be called by name.  Perl will try the same extensions
1525 as when processing B<-S> command-line switch.
1526
1527 =back
1528
1529 =head2 Memory allocation
1530
1531 Perl uses its own malloc() under OS/2 - interpreters are usually malloc-bound
1532 for speed, but perl is not, since its malloc is lightning-fast.
1533 Perl-memory-usage-tuned benchmarks show that Perl's malloc is 5 times quicker
1534 than EMX one.  I do not have convincing data about memory footprint, but
1535 a (pretty random) benchmark showed that Perl one is 5% better.
1536
1537 Combination of perl's malloc() and rigid DLL name resolution creates
1538 a special problem with library functions which expect their return value to
1539 be free()d by system's free(). To facilitate extensions which need to call 
1540 such functions, system memory-allocation functions are still available with
1541 the prefix C<emx_> added. (Currently only DLL perl has this, it should 
1542 propagate to F<perl_.exe> shortly.)
1543
1544 =head2 Threads
1545
1546 One can build perl with thread support enabled by providing C<-D usethreads>
1547 option to F<Configure>.  Currently OS/2 support of threads is very 
1548 preliminary.
1549
1550 Most notable problems: 
1551
1552 =over
1553
1554 =item C<COND_WAIT> 
1555
1556 may have a race condition.  Needs a reimplementation (in terms of chaining
1557 waiting threads, with linker list stored in per-thread structure?).
1558
1559 =item F<os2.c>
1560
1561 has a couple of static variables used in OS/2-specific functions.  (Need to be
1562 moved to per-thread structure, or serialized?)
1563
1564 =back
1565
1566 Note that these problems should not discourage experimenting, since they
1567 have a low probability of affecting small programs.
1568
1569 =cut
1570
1571 OS/2 extensions
1572 ~~~~~~~~~~~~~~~
1573 I include 3 extensions by Andreas Kaiser, OS2::REXX, OS2::UPM, and OS2::FTP, 
1574 into my ftp directory, mirrored on CPAN. I made
1575 some minor changes needed to compile them by standard tools. I cannot 
1576 test UPM and FTP, so I will appreciate your feedback. Other extensions
1577 there are OS2::ExtAttr, OS2::PrfDB for tied access to EAs and .INI
1578 files - and maybe some other extensions at the time you read it.
1579
1580 Note that OS2 perl defines 2 pseudo-extension functions
1581 OS2::Copy::copy and DynaLoader::mod2fname (many more now, see
1582 L<Prebuilt methods>).
1583
1584 The -R switch of older perl is deprecated. If you need to call a REXX code
1585 which needs access to variables, include the call into a REXX compartment
1586 created by 
1587         REXX_call {...block...};
1588
1589 Two new functions are supported by REXX code, 
1590         REXX_eval 'string';
1591         REXX_eval_with 'string', REXX_function_name => \&perl_sub_reference;
1592
1593 If you have some other extensions you want to share, send the code to
1594 me.  At least two are available: tied access to EA's, and tied access
1595 to system databases.
1596
1597 =head1 AUTHOR
1598
1599 Ilya Zakharevich, ilya@math.ohio-state.edu
1600
1601 =head1 SEE ALSO
1602
1603 perl(1).
1604
1605 =cut
1606