Remove unreachable duplicate (?#...) parsing code from S_reg()
[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).  There is also a different viewer named xview.
33
34 Note that if you have F<lynx.exe> or F<netscape.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 (This may be a little bit obsolete)
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          -  "It does not work"
56          -  I cannot run external programs
57          -  I cannot embed perl into my program, or use perl.dll from my
58          -  `` and pipe-open do not work under DOS.
59          -  Cannot start find.exe "pattern" file
60       INSTALLATION
61          -  Automatic binary installation
62          -  Manual binary installation
63          -  Warning
64       Accessing documentation
65          -  OS/2 .INF file
66          -  Plain text
67          -  Manpages
68          -  HTML
69          -  GNU info files
70          -  PDF files
71          -  LaTeX docs
72       BUILD
73          -  The short story
74          -  Prerequisites
75          -  Getting perl source
76          -  Application of the patches
77          -  Hand-editing
78          -  Making
79          -  Testing
80          -  Installing the built perl
81          -  a.out-style build
82       Build FAQ
83          -  Some / became \ in pdksh.
84          -  'errno' - unresolved external
85          -  Problems with tr or sed
86          -  Some problem (forget which ;-)
87          -  Library ... not found
88          -  Segfault in make
89          -  op/sprintf test failure
90       Specific (mis)features of OS/2 port
91          -  setpriority, getpriority
92          -  system()
93          -  extproc on the first line
94          -  Additional modules:
95          -  Prebuilt methods:
96          -  Prebuilt variables:
97          -  Misfeatures
98          -  Modifications
99          -  Identifying DLLs
100          -  Centralized management of resources
101       Perl flavors
102          -  perl.exe
103          -  perl_.exe
104          -  perl__.exe
105          -  perl___.exe
106          -  Why strange names?
107          -  Why dynamic linking?
108          -  Why chimera build?
109       ENVIRONMENT
110          -  PERLLIB_PREFIX
111          -  PERL_BADLANG
112          -  PERL_BADFREE
113          -  PERL_SH_DIR
114          -  USE_PERL_FLOCK
115          -  TMP or TEMP
116       Evolution
117          -  Text-mode filehandles
118          -  Priorities
119          -  DLL name mangling: pre 5.6.2
120          -  DLL name mangling: 5.6.2 and beyond
121          -  DLL forwarder generation
122          -  Threading
123          -  Calls to external programs
124          -  Memory allocation
125          -  Threads
126       BUGS
127       AUTHOR
128       SEE ALSO
129
130 =head1 DESCRIPTION
131
132 =head2 Target
133
134 The target is to make OS/2 one of the best supported platform for
135 using/building/developing Perl and I<Perl applications>, as well as
136 make Perl the best language to use under OS/2. The secondary target is
137 to try to make this work under DOS and Win* as well (but not B<too> hard).
138
139 The current state is quite close to this target. Known limitations:
140
141 =over 5
142
143 =item *
144
145 Some *nix programs use fork() a lot; with the mostly useful flavors of
146 perl for OS/2 (there are several built simultaneously) this is
147 supported; but some flavors do not support this (e.g., when Perl is
148 called from inside REXX).  Using fork() after
149 I<use>ing dynamically loading extensions would not work with I<very> old
150 versions of EMX.
151
152 =item *
153
154 You need a separate perl executable F<perl__.exe> (see L</perl__.exe>)
155 if you want to use PM code in your application (as Perl/Tk or OpenGL
156 Perl modules do) without having a text-mode window present.
157
158 While using the standard F<perl.exe> from a text-mode window is possible
159 too, I have seen cases when this causes degradation of the system stability.
160 Using F<perl__.exe> avoids such a degradation.
161
162 =item *
163
164 There is no simple way to access WPS objects. The only way I know
165 is via C<OS2::REXX> and C<SOM> extensions (see L<OS2::REXX>, L<SOM>).
166 However, we do not have access to
167 convenience methods of Object-REXX. (Is it possible at all? I know
168 of no Object-REXX API.)  The C<SOM> extension (currently in alpha-text)
169 may eventually remove this shortcoming; however, due to the fact that
170 DII is not supported by the C<SOM> module, using C<SOM> is not as
171 convenient as one would like it.
172
173 =back
174
175 Please keep this list up-to-date by informing me about other items.
176
177 =head2 Other OSes
178
179 Since OS/2 port of perl uses a remarkable EMX environment, it can
180 run (and build extensions, and - possibly - be built itself) under any
181 environment which can run EMX. The current list is DOS,
182 DOS-inside-OS/2, Win0.3*, Win0.95 and WinNT. Out of many perl flavors,
183 only one works, see L<"perl_.exe">.
184
185 Note that not all features of Perl are available under these
186 environments. This depends on the features the I<extender> - most
187 probably RSX - decided to implement.
188
189 Cf. L</Prerequisites>.
190
191 =head2 Prerequisites
192
193 =over 6
194
195 =item EMX
196
197 EMX runtime is required (may be substituted by RSX). Note that
198 it is possible to make F<perl_.exe> to run under DOS without any
199 external support by binding F<emx.exe>/F<rsx.exe> to it, see C<emxbind>. Note
200 that under DOS for best results one should use RSX runtime, which
201 has much more functions working (like C<fork>, C<popen> and so on). In
202 fact RSX is required if there is no VCPI present. Note the
203 RSX requires DPMI.  Many implementations of DPMI are known to be very
204 buggy, beware!
205
206 Only the latest runtime is supported, currently C<0.9d fix 03>. Perl may run
207 under earlier versions of EMX, but this is not tested.
208
209 One can get different parts of EMX from, say
210
211   ftp://crydee.sai.msu.ru/pub/comp/os/os2/leo/gnu/emx+gcc/
212   http://hobbes.nmsu.edu/h-browse.php?dir=/pub/os2/dev/emx/v0.9d/
213
214 The runtime component should have the name F<emxrt.zip>.
215
216 B<NOTE>. When using F<emx.exe>/F<rsx.exe>, it is enough to have them on your path. One
217 does not need to specify them explicitly (though this
218
219   emx perl_.exe -de 0
220
221 will work as well.)
222
223 =item RSX
224
225 To run Perl on DPMI platforms one needs RSX runtime. This is
226 needed under DOS-inside-OS/2, Win0.3*, Win0.95 and WinNT (see 
227 L<"Other OSes">). RSX would not work with VCPI
228 only, as EMX would, it requires DMPI.
229
230 Having RSX and the latest F<sh.exe> one gets a fully functional
231 B<*nix>-ish environment under DOS, say, C<fork>, C<``> and
232 pipe-C<open> work. In fact, MakeMaker works (for static build), so one
233 can have Perl development environment under DOS. 
234
235 One can get RSX from, say
236
237   http://cd.textfiles.com/hobbesos29804/disk1/EMX09C/
238   ftp://crydee.sai.msu.ru/pub/comp/os/os2/leo/gnu/emx+gcc/contrib/
239
240 Contact the author on C<rainer@mathematik.uni-bielefeld.de>.
241
242 The latest F<sh.exe> with DOS hooks is available in
243
244   http://www.ilyaz.org/software/os2/
245
246 as F<sh_dos.zip> or under similar names starting with C<sh>, C<pdksh> etc.
247
248 =item HPFS
249
250 Perl does not care about file systems, but the perl library contains
251 many files with long names, so to install it intact one needs a file
252 system which supports long file names.
253
254 Note that if you do not plan to build the perl itself, it may be
255 possible to fool EMX to truncate file names. This is not supported,
256 read EMX docs to see how to do it.
257
258 =item pdksh
259
260 To start external programs with complicated command lines (like with
261 pipes in between, and/or quoting of arguments), Perl uses an external
262 shell. With EMX port such shell should be named F<sh.exe>, and located
263 either in the wired-in-during-compile locations (usually F<F:/bin>),
264 or in configurable location (see L<"PERL_SH_DIR">).
265
266 For best results use EMX pdksh. The standard binary (5.2.14 or later) runs
267 under DOS (with L</RSX>) as well, see
268
269   http://www.ilyaz.org/software/os2/
270
271 =back
272
273 =head2 Starting Perl programs under OS/2 (and DOS and...)
274
275 Start your Perl program F<foo.pl> with arguments C<arg1 arg2 arg3> the
276 same way as on any other platform, by
277
278         perl foo.pl arg1 arg2 arg3
279
280 If you want to specify perl options C<-my_opts> to the perl itself (as
281 opposed to your program), use
282
283         perl -my_opts foo.pl arg1 arg2 arg3
284
285 Alternately, if you use OS/2-ish shell, like CMD or 4os2, put
286 the following at the start of your perl script:
287
288         extproc perl -S -my_opts
289
290 rename your program to F<foo.cmd>, and start it by typing
291
292         foo arg1 arg2 arg3
293
294 Note that because of stupid OS/2 limitations the full path of the perl
295 script is not available when you use C<extproc>, thus you are forced to
296 use C<-S> perl switch, and your script should be on the C<PATH>. As a plus
297 side, if you know a full path to your script, you may still start it
298 with 
299
300         perl ../../blah/foo.cmd arg1 arg2 arg3
301
302 (note that the argument C<-my_opts> is taken care of by the C<extproc> line
303 in your script, see L<C<extproc> on the first line>).
304
305 To understand what the above I<magic> does, read perl docs about C<-S>
306 switch - see L<perlrun>, and cmdref about C<extproc>:
307
308         view perl perlrun
309         man perlrun
310         view cmdref extproc
311         help extproc
312
313 or whatever method you prefer.
314
315 There are also endless possibilities to use I<executable extensions> of
316 4os2, I<associations> of WPS and so on... However, if you use
317 *nixish shell (like F<sh.exe> supplied in the binary distribution),
318 you need to follow the syntax specified in L<perlrun/"Command Switches">.
319
320 Note that B<-S> switch supports scripts with additional extensions 
321 F<.cmd>, F<.btm>, F<.bat>, F<.pl> as well.
322
323 =head2 Starting OS/2 (and DOS) programs under Perl
324
325 This is what system() (see L<perlfunc/system>), C<``> (see
326 L<perlop/"I/O Operators">), and I<open pipe> (see L<perlfunc/open>)
327 are for. (Avoid exec() (see L<perlfunc/exec>) unless you know what you
328 do).
329
330 Note however that to use some of these operators you need to have a
331 sh-syntax shell installed (see L<"Pdksh">, 
332 L<"Frequently asked questions">), and perl should be able to find it
333 (see L<"PERL_SH_DIR">).
334
335 The cases when the shell is used are:
336
337 =over
338
339 =item 1
340
341 One-argument system() (see L<perlfunc/system>), exec() (see L<perlfunc/exec>)
342 with redirection or shell meta-characters;
343
344 =item 2
345
346 Pipe-open (see L<perlfunc/open>) with the command which contains redirection 
347 or shell meta-characters;
348
349 =item 3
350
351 Backticks C<``> (see L<perlop/"I/O Operators">) with the command which contains
352 redirection or shell meta-characters;
353
354 =item 4
355
356 If the executable called by system()/exec()/pipe-open()/C<``> is a script
357 with the "magic" C<#!> line or C<extproc> line which specifies shell;
358
359 =item 5
360
361 If the executable called by system()/exec()/pipe-open()/C<``> is a script
362 without "magic" line, and C<$ENV{EXECSHELL}> is set to shell;
363
364 =item 6
365
366 If the executable called by system()/exec()/pipe-open()/C<``> is not
367 found (is not this remark obsolete?);
368
369 =item 7
370
371 For globbing (see L<perlfunc/glob>, L<perlop/"I/O Operators">)
372 (obsolete? Perl uses builtin globbing nowadays...).
373
374 =back
375
376 For the sake of speed for a common case, in the above algorithms 
377 backslashes in the command name are not considered as shell metacharacters.
378
379 Perl starts scripts which begin with cookies
380 C<extproc> or C<#!> directly, without an intervention of shell.  Perl uses the
381 same algorithm to find the executable as F<pdksh>: if the path
382 on C<#!> line does not work, and contains C</>, then the directory
383 part of the executable is ignored, and the executable
384 is searched in F<.> and on C<PATH>.  To find arguments for these scripts
385 Perl uses a different algorithm than F<pdksh>: up to 3 arguments are 
386 recognized, and trailing whitespace is stripped.
387
388 If a script
389 does not contain such a cooky, then to avoid calling F<sh.exe>, Perl uses
390 the same algorithm as F<pdksh>: if C<$ENV{EXECSHELL}> is set, the
391 script is given as the first argument to this command, if not set, then
392 C<$ENV{COMSPEC} /c> is used (or a hardwired guess if C<$ENV{COMSPEC}> is
393 not set).
394
395 When starting scripts directly, Perl uses exactly the same algorithm as for 
396 the search of script given by B<-S> command-line option: it will look in
397 the current directory, then on components of C<$ENV{PATH}> using the 
398 following order of appended extensions: no extension, F<.cmd>, F<.btm>, 
399 F<.bat>, F<.pl>.
400
401 Note that Perl will start to look for scripts only if OS/2 cannot start the
402 specified application, thus C<system 'blah'> will not look for a script if 
403 there is an executable file F<blah.exe> I<anywhere> on C<PATH>.  In
404 other words, C<PATH> is essentially searched twice: once by the OS for
405 an executable, then by Perl for scripts.
406
407 Note also that executable files on OS/2 can have an arbitrary extension, 
408 but F<.exe> will be automatically appended if no dot is present in the name.  
409 The workaround is as simple as that:  since F<blah.> and F<blah> denote the 
410 same file (at list on FAT and HPFS file systems), to start an executable residing in file F<n:/bin/blah> (no 
411 extension) give an argument C<n:/bin/blah.> (dot appended) to system().
412
413 Perl will start PM programs from VIO (=text-mode) Perl process in a
414 separate PM session;
415 the opposite is not true: when you start a non-PM program from a PM
416 Perl process, Perl would not run it in a separate session.  If a separate
417 session is desired, either ensure
418 that shell will be used, as in C<system 'cmd /c myprog'>, or start it using
419 optional arguments to system() documented in C<OS2::Process> module.  This
420 is considered to be a feature.
421
422 =head1 Frequently asked questions
423
424 =head2 "It does not work"
425
426 Perl binary distributions come with a F<testperl.cmd> script which tries
427 to detect common problems with misconfigured installations.  There is a
428 pretty large chance it will discover which step of the installation you
429 managed to goof.  C<;-)>
430
431 =head2 I cannot run external programs
432
433 =over 4
434
435 =item *
436
437 Did you run your programs with C<-w> switch? See 
438 L<Starting OSE<sol>2 (and DOS) programs under Perl>.
439
440 =item *
441
442 Do you try to run I<internal> shell commands, like C<`copy a b`>
443 (internal for F<cmd.exe>), or C<`glob a*b`> (internal for ksh)? You
444 need to specify your shell explicitly, like C<`cmd /c copy a b`>,
445 since Perl cannot deduce which commands are internal to your shell.
446
447 =back
448
449 =head2 I cannot embed perl into my program, or use F<perl.dll> from my
450 program. 
451
452 =over 4
453
454 =item Is your program EMX-compiled with C<-Zmt -Zcrtdll>?
455
456 Well, nowadays Perl DLL should be usable from a differently compiled
457 program too...  If you can run Perl code from REXX scripts (see
458 L<OS2::REXX>), then there are some other aspect of interaction which
459 are overlooked by the current hackish code to support
460 differently-compiled principal programs.
461
462 If everything else fails, you need to build a stand-alone DLL for
463 perl. Contact me, I did it once. Sockets would not work, as a lot of
464 other stuff.
465
466 =item Did you use L<ExtUtils::Embed>?
467
468 Some time ago I had reports it does not work.  Nowadays it is checked
469 in the Perl test suite, so grep F<./t> subdirectory of the build tree
470 (as well as F<*.t> files in the F<./lib> subdirectory) to find how it
471 should be done "correctly".
472
473 =back
474
475 =head2 C<``> and pipe-C<open> do not work under DOS.
476
477 This may a variant of just L<"I cannot run external programs">, or a
478 deeper problem. Basically: you I<need> RSX (see L</Prerequisites>)
479 for these commands to work, and you may need a port of F<sh.exe> which
480 understands command arguments. One of such ports is listed in
481 L</Prerequisites> under RSX. Do not forget to set variable
482 C<L<"PERL_SH_DIR">> as well.
483
484 DPMI is required for RSX.
485
486 =head2 Cannot start C<find.exe "pattern" file>
487
488 The whole idea of the "standard C API to start applications" is that
489 the forms C<foo> and C<"foo"> of program arguments are completely
490 interchangeable.  F<find> breaks this paradigm;
491
492   find "pattern" file
493   find pattern file
494
495 are not equivalent; F<find> cannot be started directly using the above
496 API.  One needs a way to surround the doublequotes in some other
497 quoting construction, necessarily having an extra non-Unixish shell in
498 between.
499
500 Use one of
501
502   system 'cmd', '/c', 'find "pattern" file';
503   `cmd /c 'find "pattern" file'`
504
505 This would start F<find.exe> via F<cmd.exe> via C<sh.exe> via
506 C<perl.exe>, but this is a price to pay if you want to use
507 non-conforming program.
508
509 =head1 INSTALLATION
510
511 =head2 Automatic binary installation
512
513 The most convenient way of installing a binary distribution of perl is via perl installer
514 F<install.exe>. Just follow the instructions, and 99% of the
515 installation blues would go away. 
516
517 Note however, that you need to have F<unzip.exe> on your path, and
518 EMX environment I<running>. The latter means that if you just
519 installed EMX, and made all the needed changes to F<Config.sys>,
520 you may need to reboot in between. Check EMX runtime by running
521
522         emxrev
523
524 Binary installer also creates a folder on your desktop with some useful
525 objects.  If you need to change some aspects of the work of the binary
526 installer, feel free to edit the file F<Perl.pkg>.  This may be useful
527 e.g., if you need to run the installer many times and do not want to
528 make many interactive changes in the GUI.
529
530 B<Things not taken care of by automatic binary installation:>
531
532 =over 15
533
534 =item C<PERL_BADLANG>
535
536 may be needed if you change your codepage I<after> perl installation,
537 and the new value is not supported by EMX. See L<"PERL_BADLANG">.
538
539 =item C<PERL_BADFREE>
540
541 see L<"PERL_BADFREE">.
542
543 =item F<Config.pm>
544
545 This file resides somewhere deep in the location you installed your
546 perl library, find it out by 
547
548   perl -MConfig -le "print $INC{'Config.pm'}"
549
550 While most important values in this file I<are> updated by the binary
551 installer, some of them may need to be hand-edited. I know no such
552 data, please keep me informed if you find one.  Moreover, manual
553 changes to the installed version may need to be accompanied by an edit
554 of this file.
555
556 =back
557
558 B<NOTE>. Because of a typo the binary installer of 5.00305
559 would install a variable C<PERL_SHPATH> into F<Config.sys>. Please
560 remove this variable and put C<L</PERL_SH_DIR>> instead.
561
562 =head2 Manual binary installation
563
564 As of version 5.00305, OS/2 perl binary distribution comes split
565 into 11 components. Unfortunately, to enable configurable binary
566 installation, the file paths in the zip files are not absolute, but
567 relative to some directory.
568
569 Note that the extraction with the stored paths is still necessary
570 (default with unzip, specify C<-d> to pkunzip). However, you
571 need to know where to extract the files. You need also to manually
572 change entries in F<Config.sys> to reflect where did you put the
573 files. Note that if you have some primitive unzipper (like
574 C<pkunzip>), you may get a lot of warnings/errors during
575 unzipping. Upgrade to C<(w)unzip>.
576
577 Below is the sample of what to do to reproduce the configuration on my
578 machine.  In F<VIEW.EXE> you can press C<Ctrl-Insert> now, and
579 cut-and-paste from the resulting file - created in the directory you
580 started F<VIEW.EXE> from.
581
582 For each component, we mention environment variables related to each
583 installation directory.  Either choose directories to match your
584 values of the variables, or create/append-to variables to take into
585 account the directories.
586
587 =over 3
588
589 =item Perl VIO and PM executables (dynamically linked)
590
591   unzip perl_exc.zip *.exe *.ico -d f:/emx.add/bin
592   unzip perl_exc.zip *.dll -d f:/emx.add/dll
593
594 (have the directories with C<*.exe> on PATH, and C<*.dll> on
595 LIBPATH);
596
597 =item Perl_ VIO executable (statically linked)
598
599   unzip perl_aou.zip -d f:/emx.add/bin
600
601 (have the directory on PATH);
602
603 =item Executables for Perl utilities
604
605   unzip perl_utl.zip -d f:/emx.add/bin
606
607 (have the directory on PATH);
608
609 =item Main Perl library
610
611   unzip perl_mlb.zip -d f:/perllib/lib
612
613 If this directory is exactly the same as the prefix which was compiled
614 into F<perl.exe>, you do not need to change
615 anything. However, for perl to find the library if you use a different
616 path, you need to
617 C<set PERLLIB_PREFIX> in F<Config.sys>, see L<"PERLLIB_PREFIX">.
618
619 =item Additional Perl modules
620
621   unzip perl_ste.zip -d f:/perllib/lib/site_perl/5.17.10/
622
623 Same remark as above applies.  Additionally, if this directory is not
624 one of directories on @INC (and @INC is influenced by C<PERLLIB_PREFIX>), you
625 need to put this
626 directory and subdirectory F<./os2> in C<PERLLIB> or C<PERL5LIB>
627 variable. Do not use C<PERL5LIB> unless you have it set already. See
628 L<perl/"ENVIRONMENT">.
629
630 B<[Check whether this extraction directory is still applicable with
631 the new directory structure layout!]>
632
633 =item Tools to compile Perl modules
634
635   unzip perl_blb.zip -d f:/perllib/lib
636
637 Same remark as for F<perl_ste.zip>.
638
639 =item Manpages for Perl and utilities
640
641   unzip perl_man.zip -d f:/perllib/man
642
643 This directory should better be on C<MANPATH>. You need to have a
644 working F<man> to access these files.
645
646 =item Manpages for Perl modules
647
648   unzip perl_mam.zip -d f:/perllib/man
649
650 This directory should better be on C<MANPATH>. You need to have a
651 working man to access these files.
652
653 =item Source for Perl documentation
654
655   unzip perl_pod.zip -d f:/perllib/lib
656
657 This is used by the C<perldoc> program (see L<perldoc>), and may be used to
658 generate HTML documentation usable by WWW browsers, and
659 documentation in zillions of other formats: C<info>, C<LaTeX>,
660 C<Acrobat>, C<FrameMaker> and so on.  [Use programs such as
661 F<pod2latex> etc.]
662
663 =item Perl manual in F<.INF> format
664
665   unzip perl_inf.zip -d d:/os2/book
666
667 This directory should better be on C<BOOKSHELF>.
668
669 =item Pdksh
670
671   unzip perl_sh.zip -d f:/bin
672
673 This is used by perl to run external commands which explicitly
674 require shell, like the commands using I<redirection> and I<shell
675 metacharacters>. It is also used instead of explicit F</bin/sh>.
676
677 Set C<PERL_SH_DIR> (see L<"PERL_SH_DIR">) if you move F<sh.exe> from
678 the above location.
679
680 B<Note.> It may be possible to use some other sh-compatible shell (untested).
681
682 =back
683
684 After you installed the components you needed and updated the
685 F<Config.sys> correspondingly, you need to hand-edit
686 F<Config.pm>. This file resides somewhere deep in the location you
687 installed your perl library, find it out by
688
689   perl -MConfig -le "print $INC{'Config.pm'}"
690
691 You need to correct all the entries which look like file paths (they
692 currently start with C<f:/>).
693
694 =head2 B<Warning>
695
696 The automatic and manual perl installation leave precompiled paths
697 inside perl executables. While these paths are overwriteable (see
698 L<"PERLLIB_PREFIX">, L<"PERL_SH_DIR">), some people may prefer
699 binary editing of paths inside the executables/DLLs.
700
701 =head1 Accessing documentation
702
703 Depending on how you built/installed perl you may have (otherwise
704 identical) Perl documentation in the following formats:
705
706 =head2 OS/2 F<.INF> file
707
708 Most probably the most convenient form. Under OS/2 view it as
709
710   view perl
711   view perl perlfunc
712   view perl less
713   view perl ExtUtils::MakeMaker
714
715 (currently the last two may hit a wrong location, but this may improve
716 soon). Under Win* see L<"SYNOPSIS">.
717
718 If you want to build the docs yourself, and have I<OS/2 toolkit>, run
719
720         pod2ipf > perl.ipf
721
722 in F</perllib/lib/pod> directory, then
723
724         ipfc /inf perl.ipf
725
726 (Expect a lot of errors during the both steps.) Now move it on your
727 BOOKSHELF path.
728
729 =head2 Plain text
730
731 If you have perl documentation in the source form, perl utilities
732 installed, and GNU groff installed, you may use 
733
734         perldoc perlfunc
735         perldoc less
736         perldoc ExtUtils::MakeMaker
737
738 to access the perl documentation in the text form (note that you may get
739 better results using perl manpages).
740
741 Alternately, try running pod2text on F<.pod> files.
742
743 =head2 Manpages
744
745 If you have F<man> installed on your system, and you installed perl
746 manpages, use something like this:
747
748         man perlfunc
749         man 3 less
750         man ExtUtils.MakeMaker
751
752 to access documentation for different components of Perl. Start with
753
754         man perl
755
756 Note that dot (F<.>) is used as a package separator for documentation
757 for packages, and as usual, sometimes you need to give the section - C<3>
758 above - to avoid shadowing by the I<less(1) manpage>.
759
760 Make sure that the directory B<above> the directory with manpages is
761 on our C<MANPATH>, like this
762
763   set MANPATH=c:/man;f:/perllib/man
764
765 for Perl manpages in C<f:/perllib/man/man1/> etc.
766
767 =head2 HTML
768
769 If you have some WWW browser available, installed the Perl
770 documentation in the source form, and Perl utilities, you can build
771 HTML docs. Cd to directory with F<.pod> files, and do like this
772
773         cd f:/perllib/lib/pod
774         pod2html
775
776 After this you can direct your browser the file F<perl.html> in this
777 directory, and go ahead with reading docs, like this:
778
779         explore file:///f:/perllib/lib/pod/perl.html
780
781 Alternatively you may be able to get these docs prebuilt from CPAN.
782
783 =head2 GNU C<info> files
784
785 Users of Emacs would appreciate it very much, especially with
786 C<CPerl> mode loaded. You need to get latest C<pod2texi> from C<CPAN>,
787 or, alternately, the prebuilt info pages.
788
789 =head2 F<PDF> files
790
791 for C<Acrobat> are available on CPAN (may be for slightly older version of
792 perl).
793
794 =head2 C<LaTeX> docs
795
796 can be constructed using C<pod2latex>.
797
798 =head1 BUILD
799
800 Here we discuss how to build Perl under OS/2.
801
802 =head2 The short story
803
804 Assume that you are a seasoned porter, so are sure that all the necessary
805 tools are already present on your system, and you know how to get the Perl
806 source distribution.  Untar it, change to the extract directory, and
807
808   gnupatch -p0 < os2\diff.configure
809   sh Configure -des -D prefix=f:/perllib
810   make
811   make test
812   make install
813   make aout_test
814   make aout_install
815
816 This puts the executables in f:/perllib/bin.  Manually move them to the
817 C<PATH>, manually move the built F<perl*.dll> to C<LIBPATH> (here for
818 Perl DLL F<*> is a not-very-meaningful hex checksum), and run
819
820   make installcmd INSTALLCMDDIR=d:/ir/on/path
821
822 Assuming that the C<man>-files were put on an appropriate location,
823 this completes the installation of minimal Perl system.  (The binary
824 distribution contains also a lot of additional modules, and the
825 documentation in INF format.)
826
827 What follows is a detailed guide through these steps.
828
829 =head2 Prerequisites
830
831 You need to have the latest EMX development environment, the full
832 GNU tool suite (gawk renamed to awk, and GNU F<find.exe>
833 earlier on path than the OS/2 F<find.exe>, same with F<sort.exe>, to
834 check use
835
836   find --version
837   sort --version
838
839 ). You need the latest version of F<pdksh> installed as F<sh.exe>.
840
841 Check that you have B<BSD> libraries and headers installed, and - 
842 optionally - Berkeley DB headers and libraries, and crypt.
843
844 Possible locations to get the files:
845
846
847   ftp://ftp.uni-heidelberg.de/pub/os2/unix/
848   http://hobbes.nmsu.edu/h-browse.php?dir=/pub/os2
849   http://cd.textfiles.com/hobbesos29804/disk1/DEV32/
850   http://cd.textfiles.com/hobbesos29804/disk1/EMX09C/
851
852 It is reported that the following archives contain enough utils to
853 build perl: F<gnufutil.zip>, F<gnusutil.zip>, F<gnututil.zip>, F<gnused.zip>,
854 F<gnupatch.zip>, F<gnuawk.zip>, F<gnumake.zip>, F<gnugrep.zip>, F<bsddev.zip> and
855 F<ksh527rt.zip> (or a later version).  Note that all these utilities are
856 known to be available from LEO:
857
858   ftp://crydee.sai.msu.ru/pub/comp/os/os2/leo/gnu/
859
860 Note also that the F<db.lib> and F<db.a> from the EMX distribution
861 are not suitable for multi-threaded compile (even single-threaded
862 flavor of Perl uses multi-threaded C RTL, for
863 compatibility with XFree86-OS/2). Get a corrected one from
864
865   http://www.ilyaz.org/software/os2/db_mt.zip
866
867 If you have I<exactly the same version of Perl> installed already,
868 make sure that no copies or perl are currently running.  Later steps
869 of the build may fail since an older version of F<perl.dll> loaded into
870 memory may be found.  Running C<make test> becomes meaningless, since
871 the test are checking a previous build of perl (this situation is detected
872 and reported by F<lib/os2_base.t> test).  Do not forget to unset
873 C<PERL_EMXLOAD_SEC> in environment.
874
875 Also make sure that you have F</tmp> directory on the current drive,
876 and F<.> directory in your C<LIBPATH>. One may try to correct the
877 latter condition by
878
879   set BEGINLIBPATH .\.
880
881 if you use something like F<CMD.EXE> or latest versions of
882 F<4os2.exe>.  (Setting BEGINLIBPATH to just C<.> is ignored by the
883 OS/2 kernel.)
884
885 Make sure your gcc is good for C<-Zomf> linking: run C<omflibs>
886 script in F</emx/lib> directory.
887
888 Check that you have link386 installed. It comes standard with OS/2,
889 but may be not installed due to customization. If typing
890
891   link386
892
893 shows you do not have it, do I<Selective install>, and choose C<Link
894 object modules> in I<Optional system utilities/More>. If you get into
895 link386 prompts, press C<Ctrl-C> to exit.
896
897 =head2 Getting perl source
898
899 You need to fetch the latest perl source (including developers
900 releases). With some probability it is located in 
901
902   http://www.cpan.org/src/
903   http://www.cpan.org/src/unsupported
904
905 If not, you may need to dig in the indices to find it in the directory
906 of the current maintainer.
907
908 Quick cycle of developers release may break the OS/2 build time to
909 time, looking into 
910
911   http://www.cpan.org/ports/os2/
912
913 may indicate the latest release which was publicly released by the
914 maintainer. Note that the release may include some additional patches
915 to apply to the current source of perl.
916
917 Extract it like this
918
919   tar vzxf perl5.00409.tar.gz
920
921 You may see a message about errors while extracting F<Configure>. This is
922 because there is a conflict with a similarly-named file F<configure>.
923
924 Change to the directory of extraction.
925
926 =head2 Application of the patches
927
928 You need to apply the patches in F<./os2/diff.*> like this:
929
930   gnupatch -p0 < os2\diff.configure
931
932 You may also need to apply the patches supplied with the binary
933 distribution of perl.  It also makes sense to look on the
934 perl5-porters mailing list for the latest OS/2-related patches (see
935 L<http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/>).  Such
936 patches usually contain strings C</os2/> and C<patch>, so it makes
937 sense looking for these strings.
938
939 =head2 Hand-editing
940
941 You may look into the file F<./hints/os2.sh> and correct anything
942 wrong you find there. I do not expect it is needed anywhere.
943
944 =head2 Making
945
946   sh Configure -des -D prefix=f:/perllib
947
948 C<prefix> means: where to install the resulting perl library. Giving
949 correct prefix you may avoid the need to specify C<PERLLIB_PREFIX>,
950 see L<"PERLLIB_PREFIX">.
951
952 I<Ignore the message about missing C<ln>, and about C<-c> option to
953 tr>. The latter is most probably already fixed, if you see it and can trace
954 where the latter spurious warning comes from, please inform me.
955
956 Now
957
958   make
959
960 At some moment the built may die, reporting a I<version mismatch> or
961 I<unable to run F<perl>>.  This means that you do not have F<.> in
962 your LIBPATH, so F<perl.exe> cannot find the needed F<perl67B2.dll> (treat
963 these hex digits as line noise).  After this is fixed the build
964 should finish without a lot of fuss.
965
966 =head2 Testing
967
968 Now run
969
970   make test
971
972 All tests should succeed (with some of them skipped).  If you have the
973 same version of Perl installed, it is crucial that you have C<.> early
974 in your LIBPATH (or in BEGINLIBPATH), otherwise your tests will most
975 probably test the wrong version of Perl.
976
977 Some tests may generate extra messages similar to
978
979 =over 4
980
981 =item A lot of C<bad free>
982
983 in database tests related to Berkeley DB. I<This should be fixed already.>
984 If it persists, you may disable this warnings, see L<"PERL_BADFREE">.
985
986 =item Process terminated by SIGTERM/SIGINT
987
988 This is a standard message issued by OS/2 applications. *nix
989 applications die in silence. It is considered to be a feature. One can
990 easily disable this by appropriate sighandlers. 
991
992 However the test engine bleeds these message to screen in unexpected
993 moments. Two messages of this kind I<should> be present during
994 testing.
995
996 =back
997
998 To get finer test reports, call
999
1000   perl t/harness
1001
1002 The report with F<io/pipe.t> failing may look like this:
1003
1004   Failed Test  Status Wstat Total Fail  Failed  List of failed
1005   ------------------------------------------------------------
1006   io/pipe.t                    12    1   8.33%  9
1007   7 tests skipped, plus 56 subtests skipped.
1008   Failed 1/195 test scripts, 99.49% okay. 1/6542 subtests failed, 99.98% okay.
1009
1010 The reasons for most important skipped tests are:
1011
1012 =over 8
1013
1014 =item F<op/fs.t>
1015
1016 =over 4
1017
1018 =item 18
1019
1020 Checks C<atime> and C<mtime> of C<stat()> - unfortunately, HPFS
1021 provides only 2sec time granularity (for compatibility with FAT?).
1022
1023 =item 25
1024
1025 Checks C<truncate()> on a filehandle just opened for write - I do not
1026 know why this should or should not work.
1027
1028 =back
1029
1030 =item F<op/stat.t>
1031
1032 Checks C<stat()>. Tests:
1033
1034 =over 4
1035
1036 =item 4
1037
1038 Checks C<atime> and C<mtime> of C<stat()> - unfortunately, HPFS
1039 provides only 2sec time granularity (for compatibility with FAT?).
1040
1041 =back
1042
1043 =back
1044
1045 =head2 Installing the built perl
1046
1047 If you haven't yet moved C<perl*.dll> onto LIBPATH, do it now.
1048
1049 Run
1050
1051   make install
1052
1053 It would put the generated files into needed locations. Manually put
1054 F<perl.exe>, F<perl__.exe> and F<perl___.exe> to a location on your
1055 PATH, F<perl.dll> to a location on your LIBPATH.
1056
1057 Run
1058
1059   make installcmd INSTALLCMDDIR=d:/ir/on/path
1060
1061 to convert perl utilities to F<.cmd> files and put them on
1062 PATH. You need to put F<.EXE>-utilities on path manually. They are
1063 installed in C<$prefix/bin>, here C<$prefix> is what you gave to
1064 F<Configure>, see L</Making>.
1065
1066 If you use C<man>, either move the installed F<*/man/> directories to
1067 your C<MANPATH>, or modify C<MANPATH> to match the location.  (One
1068 could have avoided this by providing a correct C<manpath> option to
1069 F<./Configure>, or editing F<./config.sh> between configuring and
1070 making steps.)
1071
1072 =head2 C<a.out>-style build
1073
1074 Proceed as above, but make F<perl_.exe> (see L<"perl_.exe">) by
1075
1076   make perl_
1077
1078 test and install by
1079
1080   make aout_test
1081   make aout_install
1082
1083 Manually put F<perl_.exe> to a location on your PATH.
1084
1085 B<Note.> The build process for C<perl_> I<does not know> about all the
1086 dependencies, so you should make sure that anything is up-to-date,
1087 say, by doing
1088
1089   make perl_dll
1090
1091 first.
1092
1093 =head1 Building a binary distribution
1094
1095 [This section provides a short overview only...]
1096
1097 Building should proceed differently depending on whether the version of perl
1098 you install is already present and used on your system, or is a new version
1099 not yet used.  The description below assumes that the version is new, so
1100 installing its DLLs and F<.pm> files will not disrupt the operation of your
1101 system even if some intermediate steps are not yet fully working.
1102
1103 The other cases require a little bit more convoluted procedures.  Below I
1104 suppose that the current version of Perl is C<5.8.2>, so the executables are
1105 named accordingly.
1106
1107 =over
1108
1109 =item 1.
1110
1111 Fully build and test the Perl distribution.  Make sure that no tests are
1112 failing with C<test> and C<aout_test> targets; fix the bugs in Perl and
1113 the Perl test suite detected by these tests.  Make sure that C<all_test>
1114 make target runs as clean as possible.  Check that F<os2/perlrexx.cmd>
1115 runs fine.
1116
1117 =item 2.
1118
1119 Fully install Perl, including C<installcmd> target.  Copy the generated DLLs
1120 to C<LIBPATH>; copy the numbered Perl executables (as in F<perl5.8.2.exe>)
1121 to C<PATH>; copy C<perl_.exe> to C<PATH> as C<perl_5.8.2.exe>.  Think whether
1122 you need backward-compatibility DLLs.  In most cases you do not need to install
1123 them yet; but sometime this may simplify the following steps.
1124
1125 =item 3.
1126
1127 Make sure that C<CPAN.pm> can download files from CPAN.  If not, you may need
1128 to manually install C<Net::FTP>.
1129
1130 =item 4.
1131
1132 Install the bundle C<Bundle::OS2_default>
1133
1134   perl5.8.2 -MCPAN -e "install Bundle::OS2_default" < nul |& tee 00cpan_i_1
1135
1136 This may take a couple of hours on 1GHz processor (when run the first time).
1137 And this should not be necessarily a smooth procedure.  Some modules may not
1138 specify required dependencies, so one may need to repeat this procedure several
1139 times until the results stabilize.
1140
1141   perl5.8.2 -MCPAN -e "install Bundle::OS2_default" < nul |& tee 00cpan_i_2
1142   perl5.8.2 -MCPAN -e "install Bundle::OS2_default" < nul |& tee 00cpan_i_3
1143
1144 Even after they stabilize, some tests may fail.
1145
1146 Fix as many discovered bugs as possible.  Document all the bugs which are not
1147 fixed, and all the failures with unknown reasons.  Inspect the produced logs
1148 F<00cpan_i_1> to find suspiciously skipped tests, and other fishy events.
1149
1150 Keep in mind that I<installation> of some modules may fail too: for example,
1151 the DLLs to update may be already loaded by F<CPAN.pm>.  Inspect the C<install>
1152 logs (in the example above F<00cpan_i_1> etc) for errors, and install things
1153 manually, as in
1154
1155   cd $CPANHOME/.cpan/build/Digest-MD5-2.31
1156   make install
1157
1158 Some distributions may fail some tests, but you may want to install them
1159 anyway (as above, or via C<force install> command of C<CPAN.pm> shell-mode).
1160
1161 Since this procedure may take quite a long time to complete, it makes sense
1162 to "freeze" your CPAN configuration by disabling periodic updates of the
1163 local copy of CPAN index: set C<index_expire> to some big value (I use 365),
1164 then save the settings
1165
1166   CPAN> o conf index_expire 365
1167   CPAN> o conf commit
1168
1169 Reset back to the default value C<1> when you are finished.
1170
1171 =item 5.
1172
1173 When satisfied with the results, rerun the C<installcmd> target.  Now you
1174 can copy C<perl5.8.2.exe> to C<perl.exe>, and install the other OMF-build
1175 executables: C<perl__.exe> etc.  They are ready to be used.
1176
1177 =item 6.
1178
1179 Change to the C<./pod> directory of the build tree, download the Perl logo
1180 F<CamelGrayBig.BMP>, and run
1181
1182   ( perl2ipf > perl.ipf ) |& tee 00ipf
1183   ipfc /INF perl.ipf |& tee 00inf
1184
1185 This produces the Perl docs online book C<perl.INF>.  Install in on
1186 C<BOOKSHELF> path.
1187
1188 =item 7.
1189
1190 Now is the time to build statically linked executable F<perl_.exe> which
1191 includes newly-installed via C<Bundle::OS2_default> modules.  Doing testing
1192 via C<CPAN.pm> is going to be painfully slow, since it statically links
1193 a new executable per XS extension.
1194
1195 Here is a possible workaround: create a toplevel F<Makefile.PL> in
1196 F<$CPANHOME/.cpan/build/> with contents being (compare with L<Making
1197 executables with a custom collection of statically loaded extensions>)
1198
1199   use ExtUtils::MakeMaker;
1200   WriteMakefile NAME => 'dummy';
1201
1202 execute this as
1203
1204   perl_5.8.2.exe Makefile.PL <nul |& tee 00aout_c1
1205   make -k all test <nul |& 00aout_t1
1206
1207 Again, this procedure should not be absolutely smooth.  Some C<Makefile.PL>'s
1208 in subdirectories may be buggy, and would not run as "child" scripts.  The
1209 interdependency of modules can strike you; however, since non-XS modules
1210 are already installed, the prerequisites of most modules have a very good
1211 chance to be present.
1212
1213 If you discover some glitches, move directories of problematic modules to a
1214 different location; if these modules are non-XS modules, you may just ignore
1215 them - they are already installed; the remaining, XS, modules you need to
1216 install manually one by one.
1217
1218 After each such removal you need to rerun the C<Makefile.PL>/C<make> process;
1219 usually this procedure converges soon.  (But be sure to convert all the
1220 necessary external C libraries from F<.lib> format to F<.a> format: run one of
1221
1222   emxaout foo.lib
1223   emximp -o foo.a foo.lib
1224
1225 whichever is appropriate.)  Also, make sure that the DLLs for external
1226 libraries are usable with with executables compiled without C<-Zmtd> options.
1227
1228 When you are sure that only a few subdirectories
1229 lead to failures, you may want to add C<-j4> option to C<make> to speed up
1230 skipping subdirectories with already finished build.
1231
1232 When you are satisfied with the results of tests, install the build C libraries
1233 for extensions:
1234
1235   make install |& tee 00aout_i
1236
1237 Now you can rename the file F<./perl.exe> generated during the last phase
1238 to F<perl_5.8.2.exe>; place it on C<PATH>; if there is an inter-dependency
1239 between some XS modules, you may need to repeat the C<test>/C<install> loop
1240 with this new executable and some excluded modules - until the procedure
1241 converges.
1242
1243 Now you have all the necessary F<.a> libraries for these Perl modules in the
1244 places where Perl builder can find it.  Use the perl builder: change to an
1245 empty directory, create a "dummy" F<Makefile.PL> again, and run
1246
1247   perl_5.8.2.exe Makefile.PL |& tee 00c
1248   make perl                  |& tee 00p
1249
1250 This should create an executable F<./perl.exe> with all the statically loaded
1251 extensions built in.  Compare the generated F<perlmain.c> files to make sure
1252 that during the iterations the number of loaded extensions only increases.
1253 Rename F<./perl.exe> to F<perl_5.8.2.exe> on C<PATH>.
1254
1255 When it converges, you got a functional variant of F<perl_5.8.2.exe>; copy it
1256 to C<perl_.exe>.  You are done with generation of the local Perl installation.
1257
1258 =item 8.
1259
1260 Make sure that the installed modules are actually installed in the location
1261 of the new Perl, and are not inherited from entries of @INC given for
1262 inheritance from the older versions of Perl: set C<PERLLIB_582_PREFIX> to
1263 redirect the new version of Perl to a new location, and copy the installed
1264 files to this new location.  Redo the tests to make sure that the versions of
1265 modules inherited from older versions of Perl are not needed.
1266
1267 Actually, the log output of L<pod2ipf(1)> during the step 6 gives a very detailed
1268 info about which modules are loaded from which place; so you may use it as
1269 an additional verification tool.
1270
1271 Check that some temporary files did not make into the perl install tree.
1272 Run something like this
1273
1274   pfind . -f "!(/\.(pm|pl|ix|al|h|a|lib|txt|pod|imp|bs|dll|ld|bs|inc|xbm|yml|cgi|uu|e2x|skip|packlist|eg|cfg|html|pub|enc|all|ini|po|pot)$/i or /^\w+$/") | less
1275
1276 in the install tree (both top one and F<sitelib> one).
1277
1278 Compress all the DLLs with F<lxlite>.  The tiny F<.exe> can be compressed with
1279 C</c:max> (the bug only appears when there is a fixup in the last 6 bytes of a
1280 page (?); since the tiny executables are much smaller than a page, the bug
1281 will not hit).  Do not compress C<perl_.exe> - it would not work under DOS.
1282
1283 =item 9.
1284
1285 Now you can generate the binary distribution.  This is done by running the
1286 test of the CPAN distribution C<OS2::SoftInstaller>.  Tune up the file
1287 F<test.pl> to suit the layout of current version of Perl first.  Do not
1288 forget to pack the necessary external DLLs accordingly.  Include the
1289 description of the bugs and test suite failures you could not fix.  Include
1290 the small-stack versions of Perl executables from Perl build directory.
1291
1292 Include F<perl5.def> so that people can relink the perl DLL preserving
1293 the binary compatibility, or can create compatibility DLLs.  Include the diff
1294 files (C<diff -pu old new>) of fixes you did so that people can rebuild your
1295 version.  Include F<perl5.map> so that one can use remote debugging.
1296
1297 =item 10.
1298
1299 Share what you did with the other people.  Relax.  Enjoy fruits of your work.
1300
1301 =item 11.
1302
1303 Brace yourself for thanks, bug reports, hate mail and spam coming as result
1304 of the previous step.  No good deed should remain unpunished!
1305
1306 =back
1307
1308 =head1 Building custom F<.EXE> files
1309
1310 The Perl executables can be easily rebuilt at any moment.  Moreover, one can
1311 use the I<embedding> interface (see L<perlembed>) to make very customized
1312 executables.
1313
1314 =head2 Making executables with a custom collection of statically loaded extensions
1315
1316 It is a little bit easier to do so while I<decreasing> the list of statically
1317 loaded extensions.  We discuss this case only here.
1318
1319 =over
1320
1321 =item 1.
1322
1323 Change to an empty directory, and create a placeholder <Makefile.PL>:
1324
1325   use ExtUtils::MakeMaker;
1326   WriteMakefile NAME => 'dummy';
1327
1328 =item 2.
1329
1330 Run it with the flavor of Perl (F<perl.exe> or F<perl_.exe>) you want to
1331 rebuild.
1332
1333   perl_ Makefile.PL
1334
1335 =item 3.
1336
1337 Ask it to create new Perl executable:
1338
1339   make perl
1340
1341 (you may need to manually add C<PERLTYPE=-DPERL_CORE> to this commandline on
1342 some versions of Perl; the symptom is that the command-line globbing does not
1343 work from OS/2 shells with the newly-compiled executable; check with
1344
1345   .\perl.exe -wle "print for @ARGV" *
1346
1347 ).
1348
1349 =item 4.
1350
1351 The previous step created F<perlmain.c> which contains a list of newXS() calls
1352 near the end.  Removing unnecessary calls, and rerunning
1353
1354   make perl
1355
1356 will produce a customized executable.
1357
1358 =back
1359
1360 =head2 Making executables with a custom search-paths
1361
1362 The default perl executable is flexible enough to support most usages.
1363 However, one may want something yet more flexible; for example, one may want
1364 to find Perl DLL relatively to the location of the EXE file; or one may want
1365 to ignore the environment when setting the Perl-library search patch, etc.
1366
1367 If you fill comfortable with I<embedding> interface (see L<perlembed>), such
1368 things are easy to do repeating the steps outlined in L<Making
1369 executables with a custom collection of statically loaded extensions>, and
1370 doing more comprehensive edits to main() of F<perlmain.c>.  The people with
1371 little desire to understand Perl can just rename main(), and do necessary
1372 modification in a custom main() which calls the renamed function in appropriate
1373 time.
1374
1375 However, there is a third way: perl DLL exports the main() function and several
1376 callbacks to customize the search path.  Below is a complete example of a
1377 "Perl loader" which
1378
1379 =over
1380
1381 =item 1.
1382
1383 Looks for Perl DLL in the directory C<$exedir/../dll>;
1384
1385 =item 2.
1386
1387 Prepends the above directory to C<BEGINLIBPATH>;
1388
1389 =item 3.
1390
1391 Fails if the Perl DLL found via C<BEGINLIBPATH> is different from what was
1392 loaded on step 1; e.g., another process could have loaded it from C<LIBPATH>
1393 or from a different value of C<BEGINLIBPATH>.  In these cases one needs to
1394 modify the setting of the system so that this other process either does not
1395 run, or loads the DLL from C<BEGINLIBPATH> with C<LIBPATHSTRICT=T> (available
1396 with kernels after September 2000).
1397
1398 =item 4.
1399
1400 Loads Perl library from C<$exedir/../dll/lib/>.
1401
1402 =item 5.
1403
1404 Uses Bourne shell from C<$exedir/../dll/sh/ksh.exe>.
1405
1406 =back
1407
1408 For best results compile the C file below with the same options as the Perl
1409 DLL.  However, a lot of functionality will work even if the executable is not
1410 an EMX applications, e.g., if compiled with
1411
1412   gcc -Wall -DDOSISH -DOS2=1 -O2 -s -Zomf -Zsys perl-starter.c -DPERL_DLL_BASENAME=\"perl312F\" -Zstack 8192 -Zlinker /PM:VIO
1413
1414 Here is the sample C file:
1415
1416   #define INCL_DOS
1417   #define INCL_NOPM
1418   /* These are needed for compile if os2.h includes os2tk.h, not os2emx.h */
1419   #define INCL_DOSPROCESS
1420   #include <os2.h>
1421
1422   #include "EXTERN.h"
1423   #define PERL_IN_MINIPERLMAIN_C
1424   #include "perl.h"
1425
1426   static char *me;
1427   HMODULE handle;
1428
1429   static void
1430   die_with(char *msg1, char *msg2, char *msg3, char *msg4)
1431   {
1432      ULONG c;
1433      char *s = " error: ";
1434
1435      DosWrite(2, me, strlen(me), &c);
1436      DosWrite(2, s, strlen(s), &c);
1437      DosWrite(2, msg1, strlen(msg1), &c);
1438      DosWrite(2, msg2, strlen(msg2), &c);
1439      DosWrite(2, msg3, strlen(msg3), &c);
1440      DosWrite(2, msg4, strlen(msg4), &c);
1441      DosWrite(2, "\r\n", 2, &c);
1442      exit(255);
1443   }
1444
1445   typedef ULONG (*fill_extLibpath_t)(int type, char *pre, char *post, int replace, char *msg);
1446   typedef int (*main_t)(int type, char *argv[], char *env[]);
1447   typedef int (*handler_t)(void* data, int which);
1448
1449   #ifndef PERL_DLL_BASENAME
1450   #  define PERL_DLL_BASENAME "perl"
1451   #endif
1452
1453   static HMODULE
1454   load_perl_dll(char *basename)
1455   {
1456       char buf[300], fail[260];
1457       STRLEN l, dirl;
1458       fill_extLibpath_t f;
1459       ULONG rc_fullname;
1460       HMODULE handle, handle1;
1461
1462       if (_execname(buf, sizeof(buf) - 13) != 0)
1463           die_with("Can't find full path: ", strerror(errno), "", "");
1464       /* XXXX Fill 'me' with new value */
1465       l = strlen(buf);
1466       while (l && buf[l-1] != '/' && buf[l-1] != '\\')
1467           l--;
1468       dirl = l - 1;
1469       strcpy(buf + l, basename);
1470       l += strlen(basename);
1471       strcpy(buf + l, ".dll");
1472       if ( (rc_fullname = DosLoadModule(fail, sizeof fail, buf, &handle)) != 0
1473            && DosLoadModule(fail, sizeof fail, basename, &handle) != 0 )
1474           die_with("Can't load DLL ", buf, "", "");
1475       if (rc_fullname)
1476           return handle;                /* was loaded with short name; all is fine */
1477       if (DosQueryProcAddr(handle, 0, "fill_extLibpath", (PFN*)&f))
1478           die_with(buf, ": DLL exports no symbol ", "fill_extLibpath", "");
1479       buf[dirl] = 0;
1480       if (f(0 /*BEGINLIBPATH*/, buf /* prepend */, NULL /* append */,
1481             0 /* keep old value */, me))
1482           die_with(me, ": prepending BEGINLIBPATH", "", "");
1483       if (DosLoadModule(fail, sizeof fail, basename, &handle1) != 0)
1484           die_with(me, ": finding perl DLL again via BEGINLIBPATH", "", "");
1485       buf[dirl] = '\\';     
1486       if (handle1 != handle) {
1487           if (DosQueryModuleName(handle1, sizeof(fail), fail))
1488               strcpy(fail, "???");
1489           die_with(buf, ":\n\tperl DLL via BEGINLIBPATH is different: \n\t",
1490                    fail,
1491                    "\n\tYou may need to manipulate global BEGINLIBPATH and LIBPATHSTRICT"
1492                    "\n\tso that the other copy is loaded via BEGINLIBPATH.");
1493       }
1494       return handle;
1495   }
1496
1497   int
1498   main(int argc, char **argv, char **env)
1499   {
1500       main_t f;
1501       handler_t h;
1502
1503       me = argv[0];
1504       /**/
1505       handle = load_perl_dll(PERL_DLL_BASENAME);
1506
1507       if (DosQueryProcAddr(handle, 0, "Perl_OS2_handler_install", (PFN*)&h))
1508           die_with(PERL_DLL_BASENAME, ": DLL exports no symbol ", "Perl_OS2_handler_install", "");
1509       if ( !h((void *)"~installprefix", Perlos2_handler_perllib_from)
1510            || !h((void *)"~dll", Perlos2_handler_perllib_to)
1511            || !h((void *)"~dll/sh/ksh.exe", Perlos2_handler_perl_sh) )
1512           die_with(PERL_DLL_BASENAME, ": Can't install @INC manglers", "", "");
1513
1514       if (DosQueryProcAddr(handle, 0, "dll_perlmain", (PFN*)&f))
1515           die_with(PERL_DLL_BASENAME, ": DLL exports no symbol ", "dll_perlmain", "");
1516       return f(argc, argv, env);
1517   }
1518
1519
1520 =head1 Build FAQ
1521
1522 =head2 Some C</> became C<\> in pdksh.
1523
1524 You have a very old pdksh. See L</Prerequisites>.
1525
1526 =head2 C<'errno'> - unresolved external
1527
1528 You do not have MT-safe F<db.lib>. See L</Prerequisites>.
1529
1530 =head2 Problems with tr or sed
1531
1532 reported with very old version of tr and sed.
1533
1534 =head2 Some problem (forget which ;-)
1535
1536 You have an older version of F<perl.dll> on your LIBPATH, which
1537 broke the build of extensions.
1538
1539 =head2 Library ... not found
1540
1541 You did not run C<omflibs>. See L</Prerequisites>.
1542
1543 =head2 Segfault in make
1544
1545 You use an old version of GNU make. See L</Prerequisites>.
1546
1547 =head2 op/sprintf test failure
1548
1549 This can result from a bug in emx sprintf which was fixed in 0.9d fix 03.
1550
1551 =head1 Specific (mis)features of OS/2 port
1552
1553 =head2 C<setpriority>, C<getpriority>
1554
1555 Note that these functions are compatible with *nix, not with the older
1556 ports of '94 - 95. The priorities are absolute, go from 32 to -95,
1557 lower is quicker. 0 is the default priority.
1558
1559 B<WARNING>.  Calling C<getpriority> on a non-existing process could lock
1560 the system before Warp3 fixpak22.  Starting with Warp3, Perl will use
1561 a workaround: it aborts getpriority() if the process is not present.
1562 This is not possible on older versions C<2.*>, and has a race
1563 condition anyway.
1564
1565 =head2 C<system()>
1566
1567 Multi-argument form of C<system()> allows an additional numeric
1568 argument. The meaning of this argument is described in
1569 L<OS2::Process>.
1570
1571 When finding a program to run, Perl first asks the OS to look for executables
1572 on C<PATH> (OS/2 adds extension F<.exe> if no extension is present).
1573 If not found, it looks for a script with possible extensions 
1574 added in this order: no extension, F<.cmd>, F<.btm>, 
1575 F<.bat>, F<.pl>.  If found, Perl checks the start of the file for magic
1576 strings C<"#!"> and C<"extproc ">.  If found, Perl uses the rest of the
1577 first line as the beginning of the command line to run this script.  The
1578 only mangling done to the first line is extraction of arguments (currently
1579 up to 3), and ignoring of the path-part of the "interpreter" name if it can't
1580 be found using the full path.
1581
1582 E.g., C<system 'foo', 'bar', 'baz'> may lead Perl to finding
1583 F<C:/emx/bin/foo.cmd> with the first line being
1584
1585  extproc /bin/bash    -x   -c
1586
1587 If F</bin/bash.exe> is not found, then Perl looks for an executable F<bash.exe> on
1588 C<PATH>.  If found in F<C:/emx.add/bin/bash.exe>, then the above system() is
1589 translated to
1590
1591   system qw(C:/emx.add/bin/bash.exe -x -c C:/emx/bin/foo.cmd bar baz)
1592
1593 One additional translation is performed: instead of F</bin/sh> Perl uses
1594 the hardwired-or-customized shell (see C<L<"PERL_SH_DIR">>).
1595
1596 The above search for "interpreter" is recursive: if F<bash> executable is not
1597 found, but F<bash.btm> is found, Perl will investigate its first line etc.
1598 The only hardwired limit on the recursion depth is implicit: there is a limit
1599 4 on the number of additional arguments inserted before the actual arguments
1600 given to system().  In particular, if no additional arguments are specified
1601 on the "magic" first lines, then the limit on the depth is 4.
1602
1603 If Perl finds that the found executable is of PM type when the
1604 current session is not, it will start the new process in a separate session of
1605 necessary type.  Call via C<OS2::Process> to disable this magic.
1606
1607 B<WARNING>.  Due to the described logic, you need to explicitly
1608 specify F<.com> extension if needed.  Moreover, if the executable
1609 F<perl5.6.1> is requested, Perl will not look for F<perl5.6.1.exe>.
1610 [This may change in the future.]
1611
1612 =head2 C<extproc> on the first line
1613
1614 If the first chars of a Perl script are C<"extproc ">, this line is treated
1615 as C<#!>-line, thus all the switches on this line are processed (twice
1616 if script was started via cmd.exe).  See L<perlrun/DESCRIPTION>.
1617
1618 =head2 Additional modules:
1619
1620 L<OS2::Process>, L<OS2::DLL>, L<OS2::REXX>, L<OS2::PrfDB>, L<OS2::ExtAttr>. These
1621 modules provide access to additional numeric argument for C<system>
1622 and to the information about the running process,
1623 to DLLs having functions with REXX signature and to the REXX runtime, to
1624 OS/2 databases in the F<.INI> format, and to Extended Attributes.
1625
1626 Two additional extensions by Andreas Kaiser, C<OS2::UPM>, and
1627 C<OS2::FTP>, are included into C<ILYAZ> directory, mirrored on CPAN.
1628 Other OS/2-related extensions are available too.
1629
1630 =head2 Prebuilt methods:
1631
1632 =over 4
1633
1634 =item C<File::Copy::syscopy>
1635
1636 used by C<File::Copy::copy>, see L<File::Copy>.
1637
1638 =item C<DynaLoader::mod2fname>
1639
1640 used by C<DynaLoader> for DLL name mangling.
1641
1642 =item  C<Cwd::current_drive()>
1643
1644 Self explanatory.
1645
1646 =item  C<Cwd::sys_chdir(name)>
1647
1648 leaves drive as it is.
1649
1650 =item  C<Cwd::change_drive(name)>
1651
1652 changes the "current" drive.
1653
1654 =item  C<Cwd::sys_is_absolute(name)>
1655
1656 means has drive letter and is_rooted.
1657
1658 =item  C<Cwd::sys_is_rooted(name)>
1659
1660 means has leading C<[/\\]> (maybe after a drive-letter:).
1661
1662 =item  C<Cwd::sys_is_relative(name)>
1663
1664 means changes with current dir.
1665
1666 =item  C<Cwd::sys_cwd(name)>
1667
1668 Interface to cwd from EMX. Used by C<Cwd::cwd>.
1669
1670 =item  C<Cwd::sys_abspath(name, dir)>
1671
1672 Really really odious function to implement. Returns absolute name of
1673 file which would have C<name> if CWD were C<dir>.  C<Dir> defaults to the
1674 current dir.
1675
1676 =item  C<Cwd::extLibpath([type])>
1677
1678 Get current value of extended library search path. If C<type> is
1679 present and positive, works with C<END_LIBPATH>, if negative, works
1680 with C<LIBPATHSTRICT>, otherwise with C<BEGIN_LIBPATH>. 
1681
1682 =item  C<Cwd::extLibpath_set( path [, type ] )>
1683
1684 Set current value of extended library search path. If C<type> is
1685 present and positive, works with <END_LIBPATH>, if negative, works
1686 with C<LIBPATHSTRICT>, otherwise with C<BEGIN_LIBPATH>.
1687
1688 =item C<OS2::Error(do_harderror,do_exception)>
1689
1690 Returns C<undef> if it was not called yet, otherwise bit 1 is
1691 set if on the previous call do_harderror was enabled, bit
1692 2 is set if on previous call do_exception was enabled.
1693
1694 This function enables/disables error popups associated with 
1695 hardware errors (Disk not ready etc.) and software exceptions.
1696
1697 I know of no way to find out the state of popups I<before> the first call
1698 to this function.
1699
1700 =item C<OS2::Errors2Drive(drive)>
1701
1702 Returns C<undef> if it was not called yet, otherwise return false if errors
1703 were not requested to be written to a hard drive, or the drive letter if
1704 this was requested.
1705
1706 This function may redirect error popups associated with hardware errors
1707 (Disk not ready etc.) and software exceptions to the file POPUPLOG.OS2 at
1708 the root directory of the specified drive.  Overrides OS2::Error() specified
1709 by individual programs.  Given argument undef will disable redirection.
1710
1711 Has global effect, persists after the application exits.
1712
1713 I know of no way to find out the state of redirection of popups to the disk
1714 I<before> the first call to this function.
1715
1716 =item OS2::SysInfo()
1717
1718 Returns a hash with system information. The keys of the hash are
1719
1720         MAX_PATH_LENGTH, MAX_TEXT_SESSIONS, MAX_PM_SESSIONS,
1721         MAX_VDM_SESSIONS, BOOT_DRIVE, DYN_PRI_VARIATION,
1722         MAX_WAIT, MIN_SLICE, MAX_SLICE, PAGE_SIZE,
1723         VERSION_MAJOR, VERSION_MINOR, VERSION_REVISION,
1724         MS_COUNT, TIME_LOW, TIME_HIGH, TOTPHYSMEM, TOTRESMEM,
1725         TOTAVAILMEM, MAXPRMEM, MAXSHMEM, TIMER_INTERVAL,
1726         MAX_COMP_LENGTH, FOREGROUND_FS_SESSION,
1727         FOREGROUND_PROCESS
1728
1729 =item OS2::BootDrive()
1730
1731 Returns a letter without colon.
1732
1733 =item C<OS2::MorphPM(serve)>, C<OS2::UnMorphPM(serve)>
1734
1735 Transforms the current application into a PM application and back.
1736 The argument true means that a real message loop is going to be served.
1737 OS2::MorphPM() returns the PM message queue handle as an integer.
1738
1739 See L<"Centralized management of resources"> for additional details.
1740
1741 =item C<OS2::Serve_Messages(force)>
1742
1743 Fake on-demand retrieval of outstanding PM messages.  If C<force> is false,
1744 will not dispatch messages if a real message loop is known to
1745 be present.  Returns number of messages retrieved.
1746
1747 Dies with "QUITing..." if WM_QUIT message is obtained.
1748
1749 =item C<OS2::Process_Messages(force [, cnt])>
1750
1751 Retrieval of PM messages until window creation/destruction.  
1752 If C<force> is false, will not dispatch messages if a real message loop
1753 is known to be present.
1754
1755 Returns change in number of windows.  If C<cnt> is given,
1756 it is incremented by the number of messages retrieved.
1757
1758 Dies with "QUITing..." if WM_QUIT message is obtained.
1759
1760 =item C<OS2::_control87(new,mask)>
1761
1762 the same as L<_control87(3)> of EMX.  Takes integers as arguments, returns
1763 the previous coprocessor control word as an integer.  Only bits in C<new> which
1764 are present in C<mask> are changed in the control word.
1765
1766 =item OS2::get_control87()
1767
1768 gets the coprocessor control word as an integer.
1769
1770 =item C<OS2::set_control87_em(new=MCW_EM,mask=MCW_EM)>
1771
1772 The variant of OS2::_control87() with default values good for
1773 handling exception mask: if no C<mask>, uses exception mask part of C<new>
1774 only.  If no C<new>, disables all the floating point exceptions.
1775
1776 See L<"Misfeatures"> for details.
1777
1778 =item C<OS2::DLLname([how [, \&xsub]])>
1779
1780 Gives the information about the Perl DLL or the DLL containing the C
1781 function bound to by C<&xsub>.  The meaning of C<how> is: default (2):
1782 full name; 0: handle; 1: module name.
1783
1784 =back
1785
1786 (Note that some of these may be moved to different libraries -
1787 eventually).
1788
1789
1790 =head2 Prebuilt variables:
1791
1792 =over 4
1793
1794 =item $OS2::emx_rev
1795
1796 numeric value is the same as _emx_rev of EMX, a string value the same
1797 as _emx_vprt (similar to C<0.9c>).
1798
1799 =item $OS2::emx_env
1800
1801 same as _emx_env of EMX, a number similar to 0x8001.
1802
1803 =item $OS2::os_ver
1804
1805 a number C<OS_MAJOR + 0.001 * OS_MINOR>.
1806
1807 =item $OS2::is_aout
1808
1809 true if the Perl library was compiled in AOUT format.
1810
1811 =item $OS2::can_fork
1812
1813 true if the current executable is an AOUT EMX executable, so Perl can
1814 fork.  Do not use this, use the portable check for
1815 $Config::Config{dfork}.
1816
1817 =item $OS2::nsyserror
1818
1819 This variable (default is 1) controls whether to enforce the contents
1820 of $^E to start with C<SYS0003>-like id.  If set to 0, then the string
1821 value of $^E is what is available from the OS/2 message file.  (Some
1822 messages in this file have an C<SYS0003>-like id prepended, some not.)
1823
1824 =back
1825
1826 =head2 Misfeatures
1827
1828 =over 4
1829
1830 =item *
1831
1832 Since L<flock(3)> is present in EMX, but is not functional, it is 
1833 emulated by perl.  To disable the emulations, set environment variable
1834 C<USE_PERL_FLOCK=0>.
1835
1836 =item *
1837
1838 Here is the list of things which may be "broken" on
1839 EMX (from EMX docs):
1840
1841 =over 4
1842
1843 =item *
1844
1845 The functions L<recvmsg(3)>, L<sendmsg(3)>, and L<socketpair(3)> are not
1846 implemented.
1847
1848 =item *
1849
1850 L<sock_init(3)> is not required and not implemented.
1851
1852 =item *
1853
1854 L<flock(3)> is not yet implemented (dummy function).  (Perl has a workaround.)
1855
1856 =item *
1857
1858 L<kill(3)>:  Special treatment of PID=0, PID=1 and PID=-1 is not implemented.
1859
1860 =item *
1861
1862 L<waitpid(3)>:
1863
1864       WUNTRACED
1865               Not implemented.
1866       waitpid() is not implemented for negative values of PID.
1867
1868 =back
1869
1870 Note that C<kill -9> does not work with the current version of EMX.
1871
1872 =item *
1873
1874 See L<"Text-mode filehandles">.
1875
1876 =item *
1877
1878 Unix-domain sockets on OS/2 live in a pseudo-file-system C</sockets/...>.
1879 To avoid a failure to create a socket with a name of a different form,
1880 C<"/socket/"> is prepended to the socket name (unless it starts with this
1881 already).
1882
1883 This may lead to problems later in case the socket is accessed via the
1884 "usual" file-system calls using the "initial" name.
1885
1886 =item *
1887
1888 Apparently, IBM used a compiler (for some period of time around '95?) which
1889 changes FP mask right and left.  This is not I<that> bad for IBM's
1890 programs, but the same compiler was used for DLLs which are used with
1891 general-purpose applications.  When these DLLs are used, the state of
1892 floating-point flags in the application is not predictable.
1893
1894 What is much worse, some DLLs change the floating point flags when in
1895 _DLLInitTerm() (e.g., F<TCP32IP>).  This means that even if you do not I<call>
1896 any function in the DLL, just the act of loading this DLL will reset your
1897 flags.  What is worse, the same compiler was used to compile some HOOK DLLs.
1898 Given that HOOK dlls are executed in the context of I<all> the applications
1899 in the system, this means a complete unpredictability of floating point
1900 flags on systems using such HOOK DLLs.  E.g., F<GAMESRVR.DLL> of B<DIVE>
1901 origin changes the floating point flags on each write to the TTY of a VIO
1902 (windowed text-mode) applications.
1903
1904 Some other (not completely debugged) situations when FP flags change include
1905 some video drivers (?), and some operations related to creation of the windows.
1906 People who code B<OpenGL> may have more experience on this.
1907
1908 Perl is generally used in the situation when all the floating-point
1909 exceptions are ignored, as is the default under EMX.  If they are not ignored,
1910 some benign Perl programs would get a C<SIGFPE> and would die a horrible death.
1911
1912 To circumvent this, Perl uses two hacks.  They help against I<one> type of
1913 damage only: FP flags changed when loading a DLL.
1914
1915 One of the hacks is to disable floating point exceptions on Perl startup (as
1916 is the default with EMX).  This helps only with compile-time-linked DLLs
1917 changing the flags before main() had a chance to be called.
1918
1919 The other hack is to restore FP flags after a call to dlopen().  This helps
1920 against similar damage done by DLLs _DLLInitTerm() at runtime.  Currently
1921 no way to switch these hacks off is provided.
1922
1923 =back
1924
1925 =head2 Modifications
1926
1927 Perl modifies some standard C library calls in the following ways:
1928
1929 =over 9
1930
1931 =item C<popen>
1932
1933 C<my_popen> uses F<sh.exe> if shell is required, cf. L<"PERL_SH_DIR">.
1934
1935 =item C<tmpnam>
1936
1937 is created using C<TMP> or C<TEMP> environment variable, via
1938 C<tempnam>.
1939
1940 =item C<tmpfile>
1941
1942 If the current directory is not writable, file is created using modified
1943 C<tmpnam>, so there may be a race condition.
1944
1945 =item C<ctermid>
1946
1947 a dummy implementation.
1948
1949 =item C<stat>
1950
1951 C<os2_stat> special-cases F</dev/tty> and F</dev/con>.
1952
1953 =item C<mkdir>, C<rmdir>
1954
1955 these EMX functions do not work if the path contains a trailing C</>.
1956 Perl contains a workaround for this.
1957
1958 =item C<flock>
1959
1960 Since L<flock(3)> is present in EMX, but is not functional, it is 
1961 emulated by perl.  To disable the emulations, set environment variable
1962 C<USE_PERL_FLOCK=0>.
1963
1964 =back
1965
1966 =head2 Identifying DLLs
1967
1968 All the DLLs built with the current versions of Perl have ID strings
1969 identifying the name of the extension, its version, and the version
1970 of Perl required for this DLL.  Run C<bldlevel DLL-name> to find this
1971 info.
1972
1973 =head2 Centralized management of resources
1974
1975 Since to call certain OS/2 API one needs to have a correctly initialized
1976 C<Win> subsystem, OS/2-specific extensions may require getting C<HAB>s and
1977 C<HMQ>s.  If an extension would do it on its own, another extension could
1978 fail to initialize.
1979
1980 Perl provides a centralized management of these resources:
1981
1982 =over
1983
1984 =item C<HAB>
1985
1986 To get the HAB, the extension should call C<hab = perl_hab_GET()> in C.  After
1987 this call is performed, C<hab> may be accessed as C<Perl_hab>.  There is
1988 no need to release the HAB after it is used.
1989
1990 If by some reasons F<perl.h> cannot be included, use
1991
1992   extern int Perl_hab_GET(void);
1993
1994 instead.
1995
1996 =item C<HMQ>
1997
1998 There are two cases:
1999
2000 =over
2001
2002 =item *
2003
2004 the extension needs an C<HMQ> only because some API will not work otherwise.
2005 Use C<serve = 0> below.
2006
2007 =item *
2008
2009 the extension needs an C<HMQ> since it wants to engage in a PM event loop.
2010 Use C<serve = 1> below.
2011
2012 =back
2013
2014 To get an C<HMQ>, the extension should call C<hmq = perl_hmq_GET(serve)> in C.
2015 After this call is performed, C<hmq> may be accessed as C<Perl_hmq>.
2016
2017 To signal to Perl that HMQ is not needed any more, call
2018 C<perl_hmq_UNSET(serve)>.  Perl process will automatically morph/unmorph itself
2019 into/from a PM process if HMQ is needed/not-needed.  Perl will automatically
2020 enable/disable C<WM_QUIT> message during shutdown if the message queue is
2021 served/not-served.
2022
2023 B<NOTE>.  If during a shutdown there is a message queue which did not disable
2024 WM_QUIT, and which did not process the received WM_QUIT message, the
2025 shutdown will be automatically cancelled.  Do not call C<perl_hmq_GET(1)>
2026 unless you are going to process messages on an orderly basis.
2027
2028 =item Treating errors reported by OS/2 API
2029
2030 There are two principal conventions (it is useful to call them C<Dos*>
2031 and C<Win*> - though this part of the function signature is not always
2032 determined by the name of the API) of reporting the error conditions
2033 of OS/2 API.  Most of C<Dos*> APIs report the error code as the result
2034 of the call (so 0 means success, and there are many types of errors).
2035 Most of C<Win*> API report success/fail via the result being
2036 C<TRUE>/C<FALSE>; to find the reason for the failure one should call
2037 WinGetLastError() API.
2038
2039 Some C<Win*> entry points also overload a "meaningful" return value
2040 with the error indicator; having a 0 return value indicates an error.
2041 Yet some other C<Win*> entry points overload things even more, and 0
2042 return value may mean a successful call returning a valid value 0, as
2043 well as an error condition; in the case of a 0 return value one should
2044 call WinGetLastError() API to distinguish a successful call from a
2045 failing one.
2046
2047 By convention, all the calls to OS/2 API should indicate their
2048 failures by resetting $^E.  All the Perl-accessible functions which
2049 call OS/2 API may be broken into two classes: some die()s when an API
2050 error is encountered, the other report the error via a false return
2051 value (of course, this does not concern Perl-accessible functions
2052 which I<expect> a failure of the OS/2 API call, having some workarounds
2053 coded).
2054
2055 Obviously, in the situation of the last type of the signature of an OS/2
2056 API, it is must more convenient for the users if the failure is
2057 indicated by die()ing: one does not need to check $^E to know that
2058 something went wrong.  If, however, this solution is not desirable by
2059 some reason, the code in question should reset $^E to 0 before making
2060 this OS/2 API call, so that the caller of this Perl-accessible
2061 function has a chance to distinguish a success-but-0-return value from
2062 a failure.  (One may return undef as an alternative way of reporting
2063 an error.)
2064
2065 The macros to simplify this type of error propagation are
2066
2067 =over
2068
2069 =item C<CheckOSError(expr)>
2070
2071 Returns true on error, sets $^E.  Expects expr() be a call of
2072 C<Dos*>-style API.
2073
2074 =item C<CheckWinError(expr)>
2075
2076 Returns true on error, sets $^E.  Expects expr() be a call of
2077 C<Win*>-style API.
2078
2079 =item C<SaveWinError(expr)>
2080
2081 Returns C<expr>, sets $^E from WinGetLastError() if C<expr> is false.
2082
2083 =item C<SaveCroakWinError(expr,die,name1,name2)>
2084
2085 Returns C<expr>, sets $^E from WinGetLastError() if C<expr> is false,
2086 and die()s if C<die> and $^E are true.  The message to die is the
2087 concatenated strings C<name1> and C<name2>, separated by C<": "> from
2088 the contents of $^E.
2089
2090 =item C<WinError_2_Perl_rc>
2091
2092 Sets C<Perl_rc> to the return value of WinGetLastError().
2093
2094 =item C<FillWinError>
2095
2096 Sets C<Perl_rc> to the return value of WinGetLastError(), and sets $^E
2097 to the corresponding value.
2098
2099 =item C<FillOSError(rc)>
2100
2101 Sets C<Perl_rc> to C<rc>, and sets $^E to the corresponding value.
2102
2103 =back
2104
2105 =item Loading DLLs and ordinals in DLLs
2106
2107 Some DLLs are only present in some versions of OS/2, or in some
2108 configurations of OS/2.  Some exported entry points are present only
2109 in DLLs shipped with some versions of OS/2.  If these DLLs and entry
2110 points were linked directly for a Perl executable/DLL or from a Perl
2111 extensions, this binary would work only with the specified
2112 versions/setups.  Even if these entry points were not needed, the
2113 I<load> of the executable (or DLL) would fail.
2114
2115 For example, many newer useful APIs are not present in OS/2 v2; many
2116 PM-related APIs require DLLs not available on floppy-boot setup.
2117
2118 To make these calls fail I<only when the calls are executed>, one
2119 should call these API via a dynamic linking API.  There is a subsystem
2120 in Perl to simplify such type of calls.  A large number of entry
2121 points available for such linking is provided (see C<entries_ordinals>
2122 - and also C<PMWIN_entries> - in F<os2ish.h>).  These ordinals can be
2123 accessed via the APIs:
2124
2125   CallORD(), DeclFuncByORD(), DeclVoidFuncByORD(),
2126   DeclOSFuncByORD(), DeclWinFuncByORD(), AssignFuncPByORD(),
2127   DeclWinFuncByORD_CACHE(), DeclWinFuncByORD_CACHE_survive(),
2128   DeclWinFuncByORD_CACHE_resetError_survive(),
2129   DeclWinFunc_CACHE(), DeclWinFunc_CACHE_resetError(),
2130   DeclWinFunc_CACHE_survive(), DeclWinFunc_CACHE_resetError_survive()
2131
2132 See the header files and the C code in the supplied OS/2-related
2133 modules for the details on usage of these functions.
2134
2135 Some of these functions also combine dynaloading semantic with the
2136 error-propagation semantic discussed above.
2137
2138 =back
2139
2140 =head1 Perl flavors
2141
2142 Because of idiosyncrasies of OS/2 one cannot have all the eggs in the
2143 same basket (though EMX environment tries hard to overcome this
2144 limitations, so the situation may somehow improve). There are 4
2145 executables for Perl provided by the distribution:
2146
2147 =head2 F<perl.exe>
2148
2149 The main workhorse. This is a chimera executable: it is compiled as an
2150 C<a.out>-style executable, but is linked with C<omf>-style dynamic
2151 library F<perl.dll>, and with dynamic CRT DLL. This executable is a
2152 VIO application.
2153
2154 It can load perl dynamic extensions, and it can fork().
2155
2156 B<Note.> Keep in mind that fork() is needed to open a pipe to yourself.
2157
2158 =head2 F<perl_.exe>
2159
2160 This is a statically linked C<a.out>-style executable. It cannot
2161 load dynamic Perl extensions. The executable supplied in binary
2162 distributions has a lot of extensions prebuilt, thus the above restriction is 
2163 important only if you use custom-built extensions. This executable is a VIO
2164 application.
2165
2166 I<This is the only executable with does not require OS/2.> The
2167 friends locked into C<M$> world would appreciate the fact that this
2168 executable runs under DOS, Win0.3*, Win0.95 and WinNT with an
2169 appropriate extender. See L<"Other OSes">.
2170
2171 =head2 F<perl__.exe>
2172
2173 This is the same executable as F<perl___.exe>, but it is a PM
2174 application. 
2175
2176 B<Note.> Usually (unless explicitly redirected during the startup)
2177 STDIN, STDERR, and STDOUT of a PM
2178 application are redirected to F<nul>. However, it is possible to I<see>
2179 them if you start C<perl__.exe> from a PM program which emulates a
2180 console window, like I<Shell mode> of Emacs or EPM. Thus it I<is
2181 possible> to use Perl debugger (see L<perldebug>) to debug your PM
2182 application (but beware of the message loop lockups - this will not
2183 work if you have a message queue to serve, unless you hook the serving
2184 into the getc() function of the debugger).
2185
2186 Another way to see the output of a PM program is to run it as
2187
2188   pm_prog args 2>&1 | cat -
2189
2190 with a shell I<different> from F<cmd.exe>, so that it does not create
2191 a link between a VIO session and the session of C<pm_porg>.  (Such a link
2192 closes the VIO window.)  E.g., this works with F<sh.exe> - or with Perl!
2193
2194   open P, 'pm_prog args 2>&1 |' or die;
2195   print while <P>;
2196
2197 The flavor F<perl__.exe> is required if you want to start your program without
2198 a VIO window present, but not C<detach>ed (run C<help detach> for more info).
2199 Very useful for extensions which use PM, like C<Perl/Tk> or C<OpenGL>.
2200
2201 Note also that the differences between PM and VIO executables are only
2202 in the I<default> behaviour.  One can start I<any> executable in
2203 I<any> kind of session by using the arguments C</fs>, C</pm> or
2204 C</win> switches of the command C<start> (of F<CMD.EXE> or a similar
2205 shell).  Alternatively, one can use the numeric first argument of the
2206 C<system> Perl function (see L<OS2::Process>).
2207
2208 =head2 F<perl___.exe>
2209
2210 This is an C<omf>-style executable which is dynamically linked to
2211 F<perl.dll> and CRT DLL. I know no advantages of this executable
2212 over C<perl.exe>, but it cannot fork() at all. Well, one advantage is
2213 that the build process is not so convoluted as with C<perl.exe>.
2214
2215 It is a VIO application.
2216
2217 =head2 Why strange names?
2218
2219 Since Perl processes the C<#!>-line (cf. 
2220 L<perlrun/DESCRIPTION>, L<perlrun/Command Switches>,
2221 L<perldiag/"No Perl script found in input">), it should know when a
2222 program I<is a Perl>. There is some naming convention which allows
2223 Perl to distinguish correct lines from wrong ones. The above names are
2224 almost the only names allowed by this convention which do not contain
2225 digits (which have absolutely different semantics).
2226
2227 =head2 Why dynamic linking?
2228
2229 Well, having several executables dynamically linked to the same huge
2230 library has its advantages, but this would not substantiate the
2231 additional work to make it compile. The reason is the complicated-to-developers
2232 but very quick and convenient-to-users "hard" dynamic linking used by OS/2.
2233
2234 There are two distinctive features of the dyna-linking model of OS/2:
2235 first, all the references to external functions are resolved at the compile time;
2236 second, there is no runtime fixup of the DLLs after they are loaded into memory.
2237 The first feature is an enormous advantage over other models: it avoids
2238 conflicts when several DLLs used by an application export entries with
2239 the same name.  In such cases "other" models of dyna-linking just choose
2240 between these two entry points using some random criterion - with predictable
2241 disasters as results.  But it is the second feature which requires the build
2242 of F<perl.dll>.
2243
2244 The address tables of DLLs are patched only once, when they are
2245 loaded. The addresses of the entry points into DLLs are guaranteed to be
2246 the same for all the programs which use the same DLL.  This removes the
2247 runtime fixup - once DLL is loaded, its code is read-only.
2248
2249 While this allows some (significant?) performance advantages, this makes life
2250 much harder for developers, since the above scheme makes it impossible
2251 for a DLL to be "linked" to a symbol in the F<.EXE> file.  Indeed, this
2252 would need a DLL to have different relocations tables for the
2253 (different) executables which use this DLL.
2254
2255 However, a dynamically loaded Perl extension is forced to use some symbols
2256 from the perl
2257 executable, e.g., to know how to find the arguments to the functions:
2258 the arguments live on the perl
2259 internal evaluation stack. The solution is to put the main code of
2260 the interpreter into a DLL, and make the F<.EXE> file which just loads
2261 this DLL into memory and supplies command-arguments.  The extension DLL
2262 cannot link to symbols in F<.EXE>, but it has no problem linking
2263 to symbols in the F<.DLL>.
2264
2265 This I<greatly> increases the load time for the application (as well as
2266 complexity of the compilation). Since interpreter is in a DLL,
2267 the C RTL is basically forced to reside in a DLL as well (otherwise
2268 extensions would not be able to use CRT).  There are some advantages if
2269 you use different flavors of perl, such as running F<perl.exe> and
2270 F<perl__.exe> simultaneously: they share the memory of F<perl.dll>.
2271
2272 B<NOTE>.  There is one additional effect which makes DLLs more wasteful:
2273 DLLs are loaded in the shared memory region, which is a scarse resource
2274 given the 512M barrier of the "standard" OS/2 virtual memory.  The code of
2275 F<.EXE> files is also shared by all the processes which use the particular
2276 F<.EXE>, but they are "shared in the private address space of the process";
2277 this is possible because the address at which different sections
2278 of the F<.EXE> file are loaded is decided at compile-time, thus all the
2279 processes have these sections loaded at same addresses, and no fixup
2280 of internal links inside the F<.EXE> is needed.
2281
2282 Since DLLs may be loaded at run time, to have the same mechanism for DLLs
2283 one needs to have the address range of I<any of the loaded> DLLs in the
2284 system to be available I<in all the processes> which did not load a particular
2285 DLL yet.  This is why the DLLs are mapped to the shared memory region.
2286
2287 =head2 Why chimera build?
2288
2289 Current EMX environment does not allow DLLs compiled using Unixish
2290 C<a.out> format to export symbols for data (or at least some types of
2291 data). This forces C<omf>-style compile of F<perl.dll>.
2292
2293 Current EMX environment does not allow F<.EXE> files compiled in
2294 C<omf> format to fork(). fork() is needed for exactly three Perl
2295 operations:
2296
2297 =over 4
2298
2299 =item *
2300
2301 explicit fork() in the script, 
2302
2303 =item *
2304
2305 C<open FH, "|-">
2306
2307 =item *
2308
2309 C<open FH, "-|">, in other words, opening pipes to itself.
2310
2311 =back
2312
2313 While these operations are not questions of life and death, they are
2314 needed for a lot of
2315 useful scripts. This forces C<a.out>-style compile of
2316 F<perl.exe>.
2317
2318
2319 =head1 ENVIRONMENT
2320
2321 Here we list environment variables with are either OS/2- and DOS- and
2322 Win*-specific, or are more important under OS/2 than under other OSes.
2323
2324 =head2 C<PERLLIB_PREFIX>
2325
2326 Specific for EMX port. Should have the form
2327
2328   path1;path2
2329
2330 or
2331
2332   path1 path2
2333
2334 If the beginning of some prebuilt path matches F<path1>, it is
2335 substituted with F<path2>.
2336
2337 Should be used if the perl library is moved from the default
2338 location in preference to C<PERL(5)LIB>, since this would not leave wrong
2339 entries in @INC.  For example, if the compiled version of perl looks for @INC
2340 in F<f:/perllib/lib>, and you want to install the library in
2341 F<h:/opt/gnu>, do
2342
2343   set PERLLIB_PREFIX=f:/perllib/lib;h:/opt/gnu
2344
2345 This will cause Perl with the prebuilt @INC of
2346
2347   f:/perllib/lib/5.00553/os2
2348   f:/perllib/lib/5.00553
2349   f:/perllib/lib/site_perl/5.00553/os2
2350   f:/perllib/lib/site_perl/5.00553
2351   .
2352
2353 to use the following @INC:
2354
2355   h:/opt/gnu/5.00553/os2
2356   h:/opt/gnu/5.00553
2357   h:/opt/gnu/site_perl/5.00553/os2
2358   h:/opt/gnu/site_perl/5.00553
2359   .
2360
2361 =head2 C<PERL_BADLANG>
2362
2363 If 0, perl ignores setlocale() failing. May be useful with some
2364 strange I<locale>s.
2365
2366 =head2 C<PERL_BADFREE>
2367
2368 If 0, perl would not warn of in case of unwarranted free(). With older
2369 perls this might be
2370 useful in conjunction with the module DB_File, which was buggy when
2371 dynamically linked and OMF-built.
2372
2373 Should not be set with newer Perls, since this may hide some I<real> problems.
2374
2375 =head2 C<PERL_SH_DIR>
2376
2377 Specific for EMX port. Gives the directory part of the location for
2378 F<sh.exe>.
2379
2380 =head2 C<USE_PERL_FLOCK>
2381
2382 Specific for EMX port. Since L<flock(3)> is present in EMX, but is not 
2383 functional, it is emulated by perl.  To disable the emulations, set 
2384 environment variable C<USE_PERL_FLOCK=0>.
2385
2386 =head2 C<TMP> or C<TEMP>
2387
2388 Specific for EMX port. Used as storage place for temporary files.
2389
2390 =head1 Evolution
2391
2392 Here we list major changes which could make you by surprise.
2393
2394 =head2 Text-mode filehandles
2395
2396 Starting from version 5.8, Perl uses a builtin translation layer for
2397 text-mode files.  This replaces the efficient well-tested EMX layer by
2398 some code which should be best characterized as a "quick hack".
2399
2400 In addition to possible bugs and an inability to follow changes to the
2401 translation policy with off/on switches of TERMIO translation, this
2402 introduces a serious incompatible change: before sysread() on
2403 text-mode filehandles would go through the translation layer, now it
2404 would not.
2405
2406 =head2 Priorities
2407
2408 C<setpriority> and C<getpriority> are not compatible with earlier
2409 ports by Andreas Kaiser. See C<"setpriority, getpriority">.
2410
2411 =head2 DLL name mangling: pre 5.6.2
2412
2413 With the release 5.003_01 the dynamically loadable libraries
2414 should be rebuilt when a different version of Perl is compiled. In particular,
2415 DLLs (including F<perl.dll>) are now created with the names
2416 which contain a checksum, thus allowing workaround for OS/2 scheme of
2417 caching DLLs.
2418
2419 It may be possible to code a simple workaround which would 
2420
2421 =over
2422
2423 =item *
2424
2425 find the old DLLs looking through the old @INC;
2426
2427 =item *
2428
2429 mangle the names according to the scheme of new perl and copy the DLLs to
2430 these names;
2431
2432 =item *
2433
2434 edit the internal C<LX> tables of DLL to reflect the change of the name
2435 (probably not needed for Perl extension DLLs, since the internally coded names
2436 are not used for "specific" DLLs, they used only for "global" DLLs).
2437
2438 =item *
2439
2440 edit the internal C<IMPORT> tables and change the name of the "old"
2441 F<perl????.dll> to the "new" F<perl????.dll>.
2442
2443 =back
2444
2445 =head2 DLL name mangling: 5.6.2 and beyond
2446
2447 In fact mangling of I<extension> DLLs was done due to misunderstanding
2448 of the OS/2 dynaloading model.  OS/2 (effectively) maintains two
2449 different tables of loaded DLL:
2450
2451 =over
2452
2453 =item Global DLLs
2454
2455 those loaded by the base name from C<LIBPATH>; including those
2456 associated at link time;
2457
2458 =item specific DLLs
2459
2460 loaded by the full name.
2461
2462 =back
2463
2464 When resolving a request for a global DLL, the table of already-loaded
2465 specific DLLs is (effectively) ignored; moreover, specific DLLs are
2466 I<always> loaded from the prescribed path.
2467
2468 There is/was a minor twist which makes this scheme fragile: what to do
2469 with DLLs loaded from
2470
2471 =over
2472
2473 =item C<BEGINLIBPATH> and C<ENDLIBPATH>
2474
2475 (which depend on the process)
2476
2477 =item F<.> from C<LIBPATH>
2478
2479 which I<effectively> depends on the process (although C<LIBPATH> is the
2480 same for all the processes).
2481
2482 =back
2483
2484 Unless C<LIBPATHSTRICT> is set to C<T> (and the kernel is after
2485 2000/09/01), such DLLs are considered to be global.  When loading a
2486 global DLL it is first looked in the table of already-loaded global
2487 DLLs.  Because of this the fact that one executable loaded a DLL from
2488 C<BEGINLIBPATH> and C<ENDLIBPATH>, or F<.> from C<LIBPATH> may affect
2489 I<which> DLL is loaded when I<another> executable requests a DLL with
2490 the same name.  I<This> is the reason for version-specific mangling of
2491 the DLL name for perl DLL.
2492
2493 Since the Perl extension DLLs are always loaded with the full path,
2494 there is no need to mangle their names in a version-specific ways:
2495 their directory already reflects the corresponding version of perl,
2496 and @INC takes into account binary compatibility with older version.
2497 Starting from C<5.6.2> the name mangling scheme is fixed to be the
2498 same as for Perl 5.005_53 (same as in a popular binary release).  Thus
2499 new Perls will be able to I<resolve the names> of old extension DLLs
2500 if @INC allows finding their directories.
2501
2502 However, this still does not guarantee that these DLL may be loaded.
2503 The reason is the mangling of the name of the I<Perl DLL>.  And since
2504 the extension DLLs link with the Perl DLL, extension DLLs for older
2505 versions would load an older Perl DLL, and would most probably
2506 segfault (since the data in this DLL is not properly initialized).
2507
2508 There is a partial workaround (which can be made complete with newer
2509 OS/2 kernels): create a forwarder DLL with the same name as the DLL of
2510 the older version of Perl, which forwards the entry points to the
2511 newer Perl's DLL.  Make this DLL accessible on (say) the C<BEGINLIBPATH> of
2512 the new Perl executable.  When the new executable accesses old Perl's
2513 extension DLLs, they would request the old Perl's DLL by name, get the
2514 forwarder instead, so effectively will link with the currently running
2515 (new) Perl DLL.
2516
2517 This may break in two ways:
2518
2519 =over
2520
2521 =item *
2522
2523 Old perl executable is started when a new executable is running has
2524 loaded an extension compiled for the old executable (ouph!).  In this
2525 case the old executable will get a forwarder DLL instead of the old
2526 perl DLL, so would link with the new perl DLL.  While not directly
2527 fatal, it will behave the same as new executable.  This beats the whole
2528 purpose of explicitly starting an old executable.
2529
2530 =item *
2531
2532 A new executable loads an extension compiled for the old executable
2533 when an old perl executable is running.  In this case the extension
2534 will not pick up the forwarder - with fatal results.
2535
2536 =back
2537
2538 With support for C<LIBPATHSTRICT> this may be circumvented - unless
2539 one of DLLs is started from F<.> from C<LIBPATH> (I do not know
2540 whether C<LIBPATHSTRICT> affects this case).
2541
2542 B<REMARK>.  Unless newer kernels allow F<.> in C<BEGINLIBPATH> (older
2543 do not), this mess cannot be completely cleaned.  (It turns out that
2544 as of the beginning of 2002, F<.> is not allowed, but F<.\.> is - and
2545 it has the same effect.)
2546
2547
2548 B<REMARK>.  C<LIBPATHSTRICT>, C<BEGINLIBPATH> and C<ENDLIBPATH> are
2549 not environment variables, although F<cmd.exe> emulates them on C<SET
2550 ...> lines.  From Perl they may be accessed by
2551 L<Cwd::extLibpath|/Cwd::extLibpath([type])> and
2552 L<Cwd::extLibpath_set|/Cwd::extLibpath_set( path [, type ] )>.
2553
2554 =head2 DLL forwarder generation
2555
2556 Assume that the old DLL is named F<perlE0AC.dll> (as is one for
2557 5.005_53), and the new version is 5.6.1.  Create a file
2558 F<perl5shim.def-leader> with
2559
2560   LIBRARY 'perlE0AC' INITINSTANCE TERMINSTANCE
2561   DESCRIPTION '@#perl5-porters@perl.org:5.006001#@ Perl module for 5.00553 -> Perl 5.6.1 forwarder'
2562   CODE LOADONCALL
2563   DATA LOADONCALL NONSHARED MULTIPLE
2564   EXPORTS
2565
2566 modifying the versions/names as needed.  Run
2567
2568  perl -wnle "next if 0../EXPORTS/; print qq(  \"$1\") if /\"(\w+)\"/" perl5.def >lst
2569
2570 in the Perl build directory (to make the DLL smaller replace perl5.def
2571 with the definition file for the older version of Perl if present).
2572
2573  cat perl5shim.def-leader lst >perl5shim.def
2574  gcc -Zomf -Zdll -o perlE0AC.dll perl5shim.def -s -llibperl
2575
2576 (ignore multiple C<warning L4085>).
2577
2578 =head2 Threading
2579
2580 As of release 5.003_01 perl is linked to multithreaded C RTL
2581 DLL.  If perl itself is not compiled multithread-enabled, so will not be perl's
2582 malloc(). However, extensions may use multiple thread on their own
2583 risk. 
2584
2585 This was needed to compile C<Perl/Tk> for XFree86-OS/2 out-of-the-box, and
2586 link with DLLs for other useful libraries, which typically are compiled
2587 with C<-Zmt -Zcrtdll>.
2588
2589 =head2 Calls to external programs
2590
2591 Due to a popular demand the perl external program calling has been
2592 changed wrt Andreas Kaiser's port.  I<If> perl needs to call an
2593 external program I<via shell>, the F<f:/bin/sh.exe> will be called, or
2594 whatever is the override, see L<"PERL_SH_DIR">.
2595
2596 Thus means that you need to get some copy of a F<sh.exe> as well (I
2597 use one from pdksh). The path F<F:/bin> above is set up automatically during
2598 the build to a correct value on the builder machine, but is
2599 overridable at runtime,
2600
2601 B<Reasons:> a consensus on C<perl5-porters> was that perl should use
2602 one non-overridable shell per platform. The obvious choices for OS/2
2603 are F<cmd.exe> and F<sh.exe>. Having perl build itself would be impossible
2604 with F<cmd.exe> as a shell, thus I picked up C<sh.exe>. This assures almost
2605 100% compatibility with the scripts coming from *nix. As an added benefit 
2606 this works as well under DOS if you use DOS-enabled port of pdksh 
2607 (see L</Prerequisites>).
2608
2609 B<Disadvantages:> currently F<sh.exe> of pdksh calls external programs
2610 via fork()/exec(), and there is I<no> functioning exec() on
2611 OS/2. exec() is emulated by EMX by an asynchronous call while the caller
2612 waits for child completion (to pretend that the C<pid> did not change). This
2613 means that 1 I<extra> copy of F<sh.exe> is made active via fork()/exec(),
2614 which may lead to some resources taken from the system (even if we do
2615 not count extra work needed for fork()ing).
2616
2617 Note that this a lesser issue now when we do not spawn F<sh.exe>
2618 unless needed (metachars found).
2619
2620 One can always start F<cmd.exe> explicitly via
2621
2622   system 'cmd', '/c', 'mycmd', 'arg1', 'arg2', ...
2623
2624 If you need to use F<cmd.exe>, and do not want to hand-edit thousands of your
2625 scripts, the long-term solution proposed on p5-p is to have a directive
2626
2627   use OS2::Cmd;
2628
2629 which will override system(), exec(), C<``>, and
2630 C<open(,'...|')>. With current perl you may override only system(),
2631 readpipe() - the explicit version of C<``>, and maybe exec(). The code
2632 will substitute the one-argument call to system() by
2633 C<CORE::system('cmd.exe', '/c', shift)>.
2634
2635 If you have some working code for C<OS2::Cmd>, please send it to me,
2636 I will include it into distribution. I have no need for such a module, so
2637 cannot test it.
2638
2639 For the details of the current situation with calling external programs,
2640 see L<Starting OSE<sol>2 (and DOS) programs under Perl>.  Set us mention a couple
2641 of features:
2642
2643 =over 4
2644
2645 =item *
2646
2647 External scripts may be called by their basename.  Perl will try the same
2648 extensions as when processing B<-S> command-line switch.
2649
2650 =item *
2651
2652 External scripts starting with C<#!> or C<extproc > will be executed directly,
2653 without calling the shell, by calling the program specified on the rest of
2654 the first line.
2655
2656 =back
2657
2658 =head2 Memory allocation
2659
2660 Perl uses its own malloc() under OS/2 - interpreters are usually malloc-bound
2661 for speed, but perl is not, since its malloc is lightning-fast.
2662 Perl-memory-usage-tuned benchmarks show that Perl's malloc is 5 times quicker
2663 than EMX one.  I do not have convincing data about memory footprint, but
2664 a (pretty random) benchmark showed that Perl's one is 5% better.
2665
2666 Combination of perl's malloc() and rigid DLL name resolution creates
2667 a special problem with library functions which expect their return value to
2668 be free()d by system's free(). To facilitate extensions which need to call 
2669 such functions, system memory-allocation functions are still available with
2670 the prefix C<emx_> added. (Currently only DLL perl has this, it should 
2671 propagate to F<perl_.exe> shortly.)
2672
2673 =head2 Threads
2674
2675 One can build perl with thread support enabled by providing C<-D usethreads>
2676 option to F<Configure>.  Currently OS/2 support of threads is very 
2677 preliminary.
2678
2679 Most notable problems: 
2680
2681 =over 4
2682
2683 =item C<COND_WAIT> 
2684
2685 may have a race condition (but probably does not due to edge-triggered
2686 nature of OS/2 Event semaphores).  (Needs a reimplementation (in terms of chaining
2687 waiting threads, with the linked list stored in per-thread structure?)?)
2688
2689 =item F<os2.c>
2690
2691 has a couple of static variables used in OS/2-specific functions.  (Need to be
2692 moved to per-thread structure, or serialized?)
2693
2694 =back
2695
2696 Note that these problems should not discourage experimenting, since they
2697 have a low probability of affecting small programs.
2698
2699 =head1 BUGS
2700
2701 This description is not updated often (since 5.6.1?), see F<./os2/Changes>
2702 for more info.
2703
2704 =cut
2705
2706 OS/2 extensions
2707 ~~~~~~~~~~~~~~~
2708 I include 3 extensions by Andreas Kaiser, OS2::REXX, OS2::UPM, and OS2::FTP, 
2709 into my ftp directory, mirrored on CPAN. I made
2710 some minor changes needed to compile them by standard tools. I cannot 
2711 test UPM and FTP, so I will appreciate your feedback. Other extensions
2712 there are OS2::ExtAttr, OS2::PrfDB for tied access to EAs and .INI
2713 files - and maybe some other extensions at the time you read it.
2714
2715 Note that OS2 perl defines 2 pseudo-extension functions
2716 OS2::Copy::copy and DynaLoader::mod2fname (many more now, see
2717 L<Prebuilt methods>).
2718
2719 The -R switch of older perl is deprecated. If you need to call a REXX code
2720 which needs access to variables, include the call into a REXX compartment
2721 created by 
2722         REXX_call {...block...};
2723
2724 Two new functions are supported by REXX code, 
2725         REXX_eval 'string';
2726         REXX_eval_with 'string', REXX_function_name => \&perl_sub_reference;
2727
2728 If you have some other extensions you want to share, send the code to
2729 me.  At least two are available: tied access to EA's, and tied access
2730 to system databases.
2731
2732 =head1 AUTHOR
2733
2734 Ilya Zakharevich, cpan@ilyaz.org
2735
2736 =head1 SEE ALSO
2737
2738 perl(1).
2739
2740 =cut
2741