Add README for improved VMS::Stdio extension
[p5sagit/p5-mst-13.2.git] / vms / ext / Stdio / 0README.txt
1 This directory contains the source code for the Perl extension
2 VMS::Stdio, which provides access from Perl to VMS-specific
3 stdio functions.  For more specific documentation of its
4 function, please see the pod section of Stdio.pm.
5
6                        *** Please Note ***
7
8 This package is the direct descendant of VMS::stdio, but as of Perl
9 5.002, the name has been changed to VMS::Stdio, in order to conform
10 to the Perl naming convention that extensions whose name begins
11 with a lowercase letter represent compile-time "pragmas", while
12 extensions which provide added functionality have names whose parts
13 begin with uppercase letters.  In addition, the functions
14 vmsfopen and fgetname have been renamed vmsopen and getname,
15 respectively, in order to more closely resemble related Perl
16 I/O operators, which do not retain the 'f' from corresponding
17 C routine names.
18
19 A transitional interface to the old routine names has been
20 provided, so that calls to these routines will generate a
21 warning, and be routed to the corresponding VMS::Stdio
22 routine.  This interface will be removed in a future release,
23 so please update your code to use the new names.
24
25
26 ===> Installation
27
28 This extension, like most Perl extensions, should be installed
29 by copying the files in this directory to a location *outside*
30 the Perl distribution tree, and then saying
31
32     $ perl Makefile.PL  ! Build Descrip.MMS for this extension
33     $ MMK               ! Build the extension
34     $ MMK test          ! Run its regression tests
35     $ MMK install       ! Install required files in public Perl tree
36
37
38 ===> Revision History
39
40 1.0  29-Nov-1994  Charles Bailey  bailey@genetics.upenn.edu
41      original version - vmsfopen
42 1.1  09-Mar-1995  Charles Bailey  bailey@genetics.upenn.edu
43      changed calling sequence to return FH/undef - like POSIX::open
44      added fgetname and tmpnam
45 2.0  28-Feb-1996  Charles Bailey  bailey@genetics.upenn.edu
46      major rewrite for Perl 5.002: name changed to VMS::Stdio,
47      new functions added, and prototypes incorporated