Also MANIFEST the vms/perlvms restoration.
[p5sagit/p5-mst-13.2.git] / README.mpeix
CommitLineData
ab648d5e 1If you read this file _as_is_, just ignore the funny characters you
2see. It is written in the POD format (see perlpod manpage) which is
3specially designed to be readable as is.
1d84e8df 4
ab648d5e 5=head1 NAME
1d84e8df 6
ab648d5e 7README.mpeix - Perl/iX for HP e3000 MPE
b5ab5069 8
ab648d5e 9=head1 SYNOPSIS
1d84e8df 10
ab648d5e 11 http://www.bixby.org/mark/perlix.html
feb33499 12 http://jazz.external.hp.com/src/hp_freeware/perl/
ab648d5e 13 Perl language for MPE
b606c525 14 Last updated July 29, 2003 @ 2100 UTC
b5ab5069 15
ab648d5e 16=head1 NOTE
1d84e8df 17
ab648d5e 18This is a podified version of the above-mentioned web page,
19podified by Jarkko Hietaniemi 2001-Jan-01.
1d84e8df 20
37a78d01 21=head1 Binary distribution from HP
22
23The simplest way to obtain Perl for the MPE/iX is to go either of
24these URLs and follow the instructions within.
25
26http://jazz.external.hp.com/src/hp_freeware/perl/
27http://www.bixby.org/mark/perlix.html
28
29Use which ever one is more recent.
30
31
210b36aa 32=head1 What's New in Perl for MPE/iX
1d84e8df 33
ab648d5e 34June 1, 2000
b5ab5069 35
ab648d5e 36=over 4
1d84e8df 37
ab648d5e 38=item *
1d84e8df 39
ab648d5e 40Rebuilt to be compatible with mod_perl. If you plan on using
41mod_perl, you MUST download and install this version of Perl/iX!
b5ab5069 42
ab648d5e 43=item *
1d84e8df 44
ab648d5e 45uselargefiles="undef": not available in MPE for POSIX files yet.
b5ab5069 46
ab648d5e 47=item *
1d84e8df 48
ab648d5e 49Now bundled with various add-on packages:
1d84e8df 50
ab648d5e 51=over 8
1d84e8df 52
ab648d5e 53=item *
1d84e8df 54
37a78d01 55libnet (as seen on CPAN)
1d84e8df 56
ab648d5e 57=item *
1d84e8df 58
ab648d5e 59libwww-perl (LWP) which lets Perl programs behave like web browsers:
b5ab5069 60
ab648d5e 61 1. #!/PERL/PUB/perl
62 2. use LWP::Simple;
63 3. $doc = get('http://www.bixby.org/mark/perlix.html'); # reads the
64 web page into variable $doc
b5ab5069 65
ab648d5e 66(http://www.bixby.org/mark/perlix.html)
1d84e8df 67
ab648d5e 68=item *
1d84e8df 69
ab648d5e 70mod_perl (just the perl portion; the actual DSO will be released
71soon with Apache/iX 1.3.12 from bixby.org). This module allows you to
72write high performance persistent Perl CGI scripts and all sorts of
73cool things. (http://perl.apache.org/)
b5ab5069 74
ab648d5e 75and much much more hiding under /PERL/PUB/.cpan/
b5ab5069 76
ab648d5e 77=item *
1d84e8df 78
ab648d5e 79The CPAN module now works for automatic downloading and
80installing of add-on packages:
1d84e8df 81
ab648d5e 82 1. export FTP_PASSIVE=1
83 2. perl -MCPAN -e shell
84 3. Ignore any terminal I/O related complaints!
b5ab5069 85
ab648d5e 86(http://theoryx5.uwinnipeg.ca/CPAN/data/perl/CPAN.html)
1d84e8df 87
ab648d5e 88=back
1d84e8df 89
ab648d5e 90=back
91
92May 20, 2000
93
94=over 4
95
96=item *
97
98Updated to version 5.6.0. Builds straight out of the box on MPE/iX.
99
100=item *
101
102Perl's getpwnam() function which had regressed to being
103unimplemented on MPE is now implemented once again.
b5ab5069 104
ab648d5e 105=back
106
107September 17, 1999
108
109=over 4
110
111=item *
112
113Migrated from cccd.edu to bixby.org.
114
115=back
b5ab5069 116
a83b6f46 117=head1 Welcome to Perl/iX
ab648d5e 118
119This is the official home page for the HP e3000 MPE/iX
f224927c 120( http://www.hp.com/go/e3000 ) port of the Perl scripting
121language ( http://www.perl.com/ ) which gives you all of the power of C,
ab648d5e 122awk, sed, and sh in a single language. Check here for the latest news,
123implemented functionality, known bugs, to-do list, etc. Status reports
124about major milestones will also be posted to the HP3000-L mailing list
f224927c 125( http://www.lsoft.com/scripts/wl.exe?SL1=HP3000-L&H=RAVEN.UTC.EDU ) and
ab648d5e 126its associated gatewayed newsgroup comp.sys.hp.mpe.
b5ab5069 127
ab648d5e 128I'm doing this port because I can't live without Perl on the Unix
129machines that I administer, and I want to have the same power
130available to me on MPE.
b5ab5069 131
ab648d5e 132Please send your comments, questions, and bug reports directly to me,
f224927c 133Mark Bixby ( http://www.bixby.org/mark/ ), by e-mailing to
ab648d5e 134mark@bixby.org. Or just post them to HP3000-L.
b5ab5069 135
ab648d5e 136The platform I'm using to do this port is an HP 3000 957RX running
137MPE/iX 6.0 and using the GNU gcc C compiler
f224927c 138( http://jazz.external.hp.com/src/gnu/gnuframe.html ).
b5ab5069 139
ab648d5e 140The combined porting wisdom from all of my ports can be found in my
141MPE/iX Porting Guide (http://www.bixby.org/mark/porting.html).
b5ab5069 142
ab648d5e 143IMPORTANT NOTICE: Yes, I do work for the HP CSY R&D lab, but ALL of
144the software you download from bixby.org is my personal freeware that
145is NOT supported by HP.
146
a83b6f46 147=head1 System Requirements for Perl/iX
ab648d5e 148
149=over 4
150
151=item *
152
153MPE/iX 5.5 or later. This version of Perl/iX does NOT run on
154MPE/iX 5.0 or earlier, nor does it run on "classic" MPE/V machines.
155
156=item *
157
158If you wish to recompile Perl, you must install both GNUCORE and
159GNUGCC from jazz (http://jazz.external.hp.com/src/gnu/gnuframe.html).
160
161=item *
162
163Perl/iX will be happier on MPE/iX 5.5 if you install the MPEKX40B
164extended POSIX filename characters patch, but this is optional.
165
166=item *
167
168Patch LBCJXT6A is required on MPE/iX 5.5 machines in order to
169prevent Perl/iX from dying with an unresolved external reference
170to _getenv_libc.
171
172=item *
173
174If you will be compiling Perl/iX yourself, you will also need
f224927c 175Syslog/iX ( http://www.bixby.org/mark/syslogix.html ) and the
ab648d5e 176/BIND/PUB/include and /BIND/PUB/lib portions of BIND/iX
f224927c 177( http://www.bixby.org/mark/bindix.html ).
ab648d5e 178
179=back
180
181=head1 How to Obtain Perl/iX
182
183=over 4
184
185=item 1.
186
187Download Perl using either FTP.ARPA.SYS or some other client
188
189=item 2.
190
191Extract the installation script
192
193=item 3.
194
195Edit the installation script
196
197=item 4.
198
199Run the installation script
200
201=item 5.
202
203Convert your *.a system archive libraries to *.sl shared libraries
b5ab5069 204
ab648d5e 205=back
1d84e8df 206
207Download Perl using FTP.ARPA.SYS from your HP 3000 (the preferred
208method).....
b5ab5069 209
ab648d5e 210 :HELLO MANAGER.SYS
211 :XEQ FTP.ARPA.SYS
212 open ftp.bixby.org
213 anonymous
214 your@email.address
215 bytestream
216 cd /pub/mpe
217 get perl-5.6.0-mpe.tar.Z /tmp/perl.tar.Z;disc=2147483647
218 exit
1d84e8df 219
220.....Or download using some other generic web or ftp client (the alternate
221method)
b5ab5069 222
1d84e8df 223Download the following files (make sure that you use "binary mode" or
224whatever client feature that is 8-bit clean):
225
ab648d5e 226=over 4
227
228=item *
229
230Perl from
231
232 http://www.bixby.org/ftp/pub/mpe/perl-5.6.0-mpe.tar.Z
233
234or
235
236 ftp://ftp.bixby.org/pub/mpe/perl-5.6.0-mpe.tar.Z
b5ab5069 237
ab648d5e 238=item *
1d84e8df 239
240Upload those files to your HP 3000 in an 8-bit clean bytestream manner to:
241
ab648d5e 242 /tmp/perl.tar.Z
b5ab5069 243
ab648d5e 244=item *
1d84e8df 245
246Then extract the installation script (after both download methods)
b5ab5069 247
ab648d5e 248 :CHDIR /tmp
249 :XEQ TAR.HPBIN.SYS 'xvfopz /tmp/perl.tar.Z INSTALL'
1d84e8df 250
ab648d5e 251=item *
1d84e8df 252
253Edit the installation script
b5ab5069 254
ab648d5e 255Examine the accounting structure creation commands and modify if
256necessary (adding additional capabilities, choosing a non-system
257volume set, etc).
1d84e8df 258
ab648d5e 259 :XEQ VI.HPBIN.SYS /tmp/INSTALL
1d84e8df 260
ab648d5e 261=item *
1d84e8df 262
ab648d5e 263Run the installation script.
b5ab5069 264
1d84e8df 265The accounting structure will be created and then all files will be
266extracted from the archive.
267
ab648d5e 268 :XEQ SH.HPBIN.SYS /tmp/INSTALL
269
270=item *
271
272Convert your *.a system archive libraries to *.sl shared libraries
b5ab5069 273
ab648d5e 274You only have to do this ONCE on your MPE/iX 5.5 machine in order to
275convert /lib/lib*.a and /usr/lib/lib*.a libraries to their *.sl
276equivalents. This step should not be necessary on MPE/iX 6.0 or later
277machines because the 6.0 or later update process does it for you.
278
279 :XEQ SH.HPBIN.SYS /PERL/PUB/LIBSHP3K
280
281=back
282
a83b6f46 283=head1 Perl/iX Distribution Contents Highlights
ab648d5e 284
285=over 4
286
287=item README
288
289The file you're reading now.
b5ab5069 290
ab648d5e 291=item INSTALL
292
293Perl/iX Installation script.
b5ab5069 294
ab648d5e 295=item LIBSHP3K
296
297Script to convert *.a system archive libraries to *.sl shared libraries.
b5ab5069 298
ab648d5e 299=item PERL
300
301Perl NMPRG executable. A version-numbered backup copy also
302exists. You might wish to "ln -s /PERL/PUB/PERL /usr/local/bin/perl".
b5ab5069 303
ab648d5e 304=item .cpan/
305
306Much add-on source code downloaded with the CPAN module.
b5ab5069 307
ab648d5e 308=item lib/
309
310Perl libraries, both core and add-on.
b5ab5069 311
ab648d5e 312=item man/
313
314Perl man page documentation.
315
316=item public_html/feedback.cgi
317
318Sample feedback CGI form written in Perl.
b5ab5069 319
ab648d5e 320=item src/perl-5.6.0-mpe
321
322Source code.
323
324=back
b5ab5069 325
ab648d5e 326=head1 How to Compile Perl/iX
327
328=over 4
329
330=item 1.
331
332cd src/perl-5.6.0-mpe
333
334=item 2.
335
336Read the INSTALL file for the official instructions
337
338=item 3.
339
340./Configure -d
341
342=item 4.
343
344make
345
346=item 5.
347
348./mpeix/relink
349
350=item 6.
351
352make test (expect approximately 15 out of 11306 subtests to fail,
353mostly due to MPE not supporting hard links, UDP socket problems,
354and handling exit() return codes improperly)
355
356=item 7.
357
358make install
359
360=item 8.
361
362Optionally create symbolic links that point to the Perl
363executable, i.e. ln -s /PERL/PUB/PERL /usr/local/bin/perl
b5ab5069 364
ab648d5e 365=back
1d84e8df 366
367The summary test results from "cd t; ./perl -I../lib harness":
368
ab648d5e 369 Failed Test Status Wstat Total Fail Failed List of failed
370 ---------------------------------------------------------------------------
371 io/fs.t 29 8 27.59% 2-5, 7-9, 11
372 io/openpid.t 10 1 10.00% 7
373 lib/io_sock.t 14 1 7.14% 13
374 lib/io_udp.t 7 2 28.57% 3, 5
375 lib/posix.t 27 1 3.70% 12
376 op/lex_assign.t 187 1 0.53% 13
377 op/stat.t 58 1 1.72% 3
378 15 tests and 94 subtests skipped.
379 Failed 7/236 test scripts, 97.03% okay. 15/11306 subtests failed, 99.87% okay.
380
381=head1 Getting Started with Perl/iX
382
383Create your Perl script files with "#!/PERL/PUB/perl" (or an
384equivalent symbolic link) as the first line. Use the chmod command to
385make sure that your script has execute permission. Run your script!
b5ab5069 386
ab648d5e 387Be sure to take a look at the CPAN module list
f224927c 388( http://www.cpan.org/CPAN.html ). A wide variety of free Perl software
ab648d5e 389is available. You can automatically download these packages by using
f224927c 390the CPAN module ( http://theoryx5.uwinnipeg.ca/CPAN/data/perl/CPAN.html ).
ab648d5e 391
392=head1 MPE/iX Implementation Considerations
393
394There some minor functionality issues to be aware of when comparing
395Perl for Unix (Perl/UX) to Perl/iX:
396
397=over 4
398
399=item *
400
401MPE gcc/ld doesn't properly support linking NMPRG executables against
402NMXL dynamic libraries, so you must manually run mpeix/relink after
403each re-build of Perl.
404
405=item *
406
407Perl/iX File::Copy will use MPE's /bin/cp command to copy files by
408name in order to preserve file attributes like file code.
409
410=item *
411
412MPE (and thus Perl/iX) lacks support for setgrent(), endgrent(),
413setpwent(), endpwent().
414
415=item *
416
417MPE (and thus Perl/iX) lacks support for hard links.
418
419=item *
420
421MPE requires GETPRIVMODE() in order to bind() to ports less than 1024.
422Perl/iX will call GETPRIVMODE() automatically on your behalf if you
423attempt to bind() to these low-numbered ports. Note that the Perl/iX
424executable and the PERL account do not normally have CAP=PM, so if you
425will be bind()-ing to these privileged ports, you will manually need
426to add PM capability as appropriate.
427
428=item *
429
430MPE requires that you bind() to an IP address of zero. Perl/iX
431automatically replaces the IP address that you pass to bind() with
432a zero.
433
434=item *
435
ab648d5e 436MPE requires GETPRIVMODE() in order to setuid(). There are too many
437calls to setuid() within Perl/iX, so I have not attempted an automatic
438GETPRIVMODE() solution similar to bind().
439
440=back
b5ab5069 441
a83b6f46 442=head1 Known Perl/iX Bugs Under Investigation
ab648d5e 443
444None.
b5ab5069 445
a83b6f46 446=head1 Perl/iX To-Do List
ab648d5e 447
448=over 4
449
450=item *
451
452Make setuid()/setgid() support work.
453
454=item *
455
456Make sure that fcntl() against a socket descriptor is redirected to sfcntl().
457
458=item *
459
460Add support for Berkeley DB once I've finished porting Berkeley DB.
461
462=item *
463
464Write an MPE XS extension library containing miscellaneous important
465MPE functions like GETPRIVMODE(), GETUSERMODE(), and sfcntl().
b5ab5069 466
ab648d5e 467=back
468
a83b6f46 469=head1 Perl/iX Change History
ab648d5e 470
471May 6, 1999
b5ab5069 472
ab648d5e 473=over 4
474
475=item *
476
477Patch LBCJXT6A is required on MPE/iX 5.5 machines in order to prevent
478Perl/iX from dying with an unresolved external reference to _getenv_libc.
b5ab5069 479
ab648d5e 480=back
481
482April 7, 1999
483
484=over 4
485
486=item *
487
488Updated to version 5.005_03.
489
490=item *
491
492The official source distribution once again compiles "straight out
493of the box" for MPE.
494
495=item *
496
497The current incarnation of the 5.5 POSIX filename extended
498characters patch is now MPEKX40B.
499
500=item *
501
502The LIBSHP3K *.a -> *.sl library conversion script is now included
503as /PERL/PUB/LIBSHP3K.
b5ab5069 504
ab648d5e 505=back
506
507November 20, 1998
508
509=over 4
510
511=item *
512
513Updated to version 5.005_02.
514
515=item *
516
517Fixed a DynaLoader bug that was unable to load symbols from relative
518path name libraries.
519
520=item *
521
522Fixed a .xs compilation bug where the mpeixish.sh include file wasn't
523being installed into the proper directory.
524
525=item *
526
527All bugfixes will be submitted back to the official Perl developers.
528
529=item *
530
531The current incarnation of the POSIX filename extended characters
532patch is now MPEKXJ3A.
b5ab5069 533
ab648d5e 534=back
b5ab5069 535
ab648d5e 536August 14, 1998
537
538=over 4
539
540=item *
541
542The previous POSIX filename extended characters patch MPEKX44C has
543been superseded by MPEKXB5A.
b5ab5069 544
ab648d5e 545=back
b5ab5069 546
ab648d5e 547August 7, 1998
548
549=over 4
550
551=item *
552
553The previous POSIX filename extended characters patch MPEKX76A has
554been superseded by MPEKX44C.
ab648d5e 555
556=back
b5ab5069 557
ab648d5e 558July 28, 1998
559
b5ab5069 560=over 4
561
ab648d5e 562=item *
563
564Updated to version 5.005_01.
b5ab5069 565
ab648d5e 566=back
b5ab5069 567
ab648d5e 568July 23, 1998
569
570=over 4
571
572=item *
573
574Updated to version 5.005 (production release). The public
575freeware sources are now 100% MPE-ready "straight out of the box".
b5ab5069 576
ab648d5e 577=back
b5ab5069 578
ab648d5e 579July 17, 1998
580
581=over 4
582
583=item *
584
585Updated to version 5.005b1 (public beta release). The public
586freeware sources are now 99.9% MPE-ready. By installing and
587testing this beta on your own HP3000, you will be helping to
588insure that the final release of 5.005 will be 100% MPE-ready and
589100% bug free.
590
591=item *
592
593My MPE binary release is now extracted using my standard INSTALL script.
b5ab5069 594
ab648d5e 595=back
b5ab5069 596
ab648d5e 597July 15, 1998
598
599=over 4
600
601=item *
602
603Changed startperl to #!/PERL/PUB/perl so that Perl will recognize
604scripts more easily and efficiently.
b5ab5069 605
ab648d5e 606=back
b5ab5069 607
ab648d5e 608July 8, 1998
609
610=over 4
611
612=item *
613
614Updated to version 5.004_70 (internal developer release) which is now
615MPE-ready. The next public freeware release of Perl should compile
616"straight out of the box" on MPE. Note that this version of Perl/iX
617was strictly internal to me and never publicly released. Note that
618[21]BIND/iX is now required (well, the include files and libbind.a) if
619you wish to compile Perl/iX.
b5ab5069 620
ab648d5e 621=back
b5ab5069 622
ab648d5e 623November 6, 1997
624
625=over 4
626
627=item *
628
629Updated to version 5.004_04. No changes in MPE-specific functionality.
b5ab5069 630
ab648d5e 631=back
b5ab5069 632
ab648d5e 633October 16, 1997
634
635=over 4
636
637=item *
638
639Added Demos section to the Perl/iX home page so you can see some
640sample Perl applications running on my 3000.
b5ab5069 641
ab648d5e 642=back
b5ab5069 643
ab648d5e 644October 3, 1997
645
646=over 4
647
648=item *
649
650Added System Requirements section to the Perl/iX home page just so the
651prerequisites stand out more. Various other home page tweaks.
b5ab5069 652
ab648d5e 653=back
b5ab5069 654
ab648d5e 655October 2, 1997
656
657=over 4
658
659=item *
660
661Initial public release.
b5ab5069 662
ab648d5e 663=back
b5ab5069 664
ab648d5e 665September 1997
666
667=over 4
668
669=item *
670
671Porting begins.
672
673=back
b5ab5069 674
a83b6f46 675=head1 AUTHOR
b5ab5069 676
ab648d5e 677Mark Bixby, mark@bixby.org
678