This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
fixup Perl_magic_freemglob()
[perl5.git] / README.vos
index 06fe061..7249f49 100644 (file)
@@ -4,225 +4,101 @@ specially designed to be readable as is.
 
 =head1 NAME
 
-README.vos - Perl for Stratus VOS
+perlvos - Perl for Stratus OpenVOS
 
 =head1 SYNOPSIS
 
-This is a port of Perl version 5, revision 7, to VOS.  Perl is a
-scripting or macro language that is popular on many systems.  See your
-local computer bookstore for a number of good books on Perl.
+This file contains notes for building perl on the Stratus OpenVOS
+operating system.  Perl is a scripting or macro language that is
+popular on many systems.  See L<perlbook> for a number of good books
+on Perl.
 
-=head2 Stratus POSIX Support
+These are instructions for building Perl from source.  This version of
+Perl requires the dynamic linking support that is found in OpenVOS
+Release 17.1 and thus is not supported on OpenVOS Release 17.0 or
+earlier releases.
 
-Note that there are two different implementations of POSIX.1
-support on VOS.  There is an alpha version of POSIX that is
-available from the Stratus anonymous ftp site
-(ftp://ftp.stratus.com/pub/vos/posix/alpha/alpha.html).  There
-is a generally-available version of POSIX that comes with the
-VOS Standard C compiler and C runtime in VOS Release 14.3.0 or
-higher.  This port of POSIX will compile and bind with either
-version of POSIX.
+If you are running VOS Release 14.4.1 or later, you can obtain a
+pre-compiled, supported copy of perl by purchasing the GNU Tools
+product from Stratus Technologies.
 
-Most of the Perl features should work on VOS regardless of which
-version of POSIX that you are using.  However, the alpha version
-of POSIX is missing a number of key functions, and therefore any
-attempt by perl.pm to call the following unimplemented POSIX
-functions will result in an error message and an immediate and
-fatal call to the VOS debugger.  They are "dup", "fork", and
-"waitpid".  The lack of these functions pretty much prevents you
-from starting VOS commands and grabbing their output in perl.
-The workaround is to run the commands outside of perl, then have
-perl process the output file.  These functions are all available
-in the generally-available version of POSIX.
+=head1 BUILDING PERL FOR OPENVOS
 
-=head1 INSTALLING PERL IN VOS
+To build perl from its source code on the Stratus V Series platform
+you must have OpenVOS Release 17.1.0 or later, GNU Tools Release
+3.5 or later, and the C/POSIX Runtime Libraries.
 
-=head2 Compiling Perl 5 on VOS
+Follow the normal instructions for building perl; e.g, enter bash, run
+the Configure script, then use "gmake" to build perl.
 
-Before you can build Perl 5 on VOS, you need to have or acquire the
-following additional items.
-
-=over 5
-
-=item 1
-
-The VOS Standard C Compiler (or the VOS Standard C
-Cross-Compiler) and the VOS C Runtime.  If you are using
-the generally-available version of POSIX support, you may
-instead use the the VOS GNU C/C++ Compiler.  These are
-standard Stratus products.
-
-=item 2
-
-Either the VOS OS TCP/IP or STCP product set.  If you are
-building with the alpha version of POSIX you need the OS
-TCP/IP product set.  If you are building with the
-generally-available version of POSIX you need the STCP
-product set.  These are standard Stratus products.
-
-=item 3
-
-Either the alpha or generally-available version of the VOS
-POSIX.1 environment.
-
-The alpha version of POSIX.1 support is available on the
-Stratus FTP site.  Login anonymously to ftp.stratus.com and
-get the file /pub/vos/posix/alpha/posix.save.evf.gz in
-binary file-transfer mode.  Or use the Uniform Resource
-Locator (URL)
-ftp://ftp.stratus.com/pub/vos/alpha/posix.save.evf.gz from
-your web browser.  Instructions for unbundling this file
-are at ftp://ftp.stratus.com/pub/vos/utility/utility.html.
-This is not a standard Stratus product.
-
-In VOS Release 14.3.0, the generally-available version of
-POSIX.1 support is bundled with the VOS Standard C compiler
-(or Standard C Cross-Compiler).  In VOS Release 14.4.0 or
-higher, it is also bundled with the VOS C Runtime.  These
-are standard Stratus products.
-
-=item 4
-
-You must compile this version of Perl 5 on VOS Release
-14.1.0 or higher because some of the perl source files
-contain more than 32,767 source lines.  Due to VOS
-release-compatibility rules, this port of perl may not
-execute on VOS Release 12 or earlier.
-
-=item 5
-
-If you are using the generally-available version of VOS
-POSIX support, then you should also acquire the VOS GNU
-C/C++ Compiler and GNU Tools product.  When perl is built
-with this version of POSIX support, it assumes that it can
-find "bash", "sed" and other POSIX-compatible commands in
-the directory /system/gnu_library/bin.
-
-=back
-
-To build perl 5, change to the "vos" subdirectory and type the
-command "compile_perl -processor X", where X is the processor
-type (mc68020, i80860, pa7100, pa8000) that you wish to use.
-Note that the generally-available version of POSIX.1 support is
-not available for the mc68020 or i80860 processors.
-
-Use the "-version alpha" control argument to build perl with
-the alpha version of POSIX support, and use the "-version
-ga" control argument to build it with the
-generally-available version of POSIX.  The default is "ga".
-
-Use the "-compiler cc" control argument to build perl with
-the VOS Standard C compiler.  Use the "-compiler gcc"
-control argument to build it with the GNU GCC compiler.  The
-default is "cc".
-
-You must have purchased the VOS Standard C Cross Compiler in
-order to compile perl for a processor type that is different
-from the processor type of the module.
-
-Note that code compiled for the pa7100 processor type can
-execute on the PA7100, PA8000, PA8500 and PA8600 processors, and
-that code compiled for the pa8000 processor type can execute on
-the PA8000, PA8500 and PA8600 processors.
-
-=head2 Installing Perl 5 on VOS
+=head1 INSTALLING PERL IN OPENVOS
 
 =over 4
 
 =item 1
 
-Create the directory >system>ported>command_library.
+After you have built perl using the Configure script, ensure that you
+have modify and default write permission to C<< >system>ported >> and
+all subdirectories.  Then type
 
-=item 2
+     gmake install
 
-Copy the appropriate version of the perl program module to
-this directory.  For example, with your current directory
-set to the top-level directory of Perl 5, to install the
-executable program module for the Motorola 68K
-architecture, enter:
+=item 2
 
-          !copy_file vos>obj>perl.pm >system>ported>command_library>*
+While there are currently no architecture-specific extensions or
+modules distributed with perl, the following directories can be
+used to hold such files (replace the string VERSION by the
+appropriate version number):
 
-(If you wish to use both Perl version 4 and Perl version 5,
-you must give them different names; for example, perl.pm
-and perl5.pm).
+     >system>ported>lib>perl5>VERSION>i786
 
 =item 3
 
-Create the directory >system>ported>perl>lib.
-
-=item 4
-
-Copy all of the files and subdirectories from the lib
-subdirectory into this new directory.  For example, with
-the current directory set to the top-level directory of the
-perl distribution, enter:
-
-          !copy_dir lib >system>ported>perl>lib>5.7
-
-=item 5
-
-While there are currently no architecture-specific
-extensions or modules distributed with perl, the following
-directories can be used to hold such files:
-
-          >system>ported>perl>lib>5.7.68k
-          >system>ported>perl>lib>5.7.860
-          >system>ported>perl>lib>5.7.7100
-          >system>ported>perl>lib>5.7.8000
-
-=item 6
-
 Site-specific perl extensions and modules can be installed in one of
 two places.  Put architecture-independent files into:
 
-          >system>ported>perl>lib>site>5.7
+     >system>ported>lib>perl5>site_perl>VERSION
 
-Put architecture-dependent files into one of the following
-directories:
+Put site-specific architecture-dependent files into one of the
+following directories:
 
-          >system>ported>perl>lib>site>5.7.68k
-          >system>ported>perl>lib>site>5.7.860
-          >system>ported>perl>lib>site>5.7.7100
-          >system>ported>perl>lib>site>5.7.8000
+     >system>ported>lib>perl5>site_perl>VERSION>i786
 
-=item 7
+=item 4
 
 You can examine the @INC variable from within a perl program
 to see the order in which Perl searches these directories.
 
 =back
 
-=head1 USING PERL IN VOS
+=head1 USING PERL IN OPENVOS
 
-=head2 Unimplemented Features of Perl on VOS
+=head2 Restrictions of Perl on OpenVOS
 
-If perl is built with the alpha version of VOS POSIX.1 support
-and if it attempts to call an unimplemented VOS POSIX.1
-function, it will print a fatal error message and enter the VOS
-debugger.  This error is not recoverable.  See vos_dummies.c for
-a list of the unimplemented POSIX.1 functions.  To see what
-functions are unimplemented and what the error message looks
-like, compile and execute "test_vos_dummies.c".
-
-=head2 Restrictions of Perl on VOS
-
-This port of Perl version 5 to VOS prefers Unix-style,
-slash-separated pathnames over VOS-style greater-than-separated
-pathnames.  VOS-style pathnames should work in most contexts, but
-if you have trouble, replace all greater-than characters by slash
-characters.  Because the slash character is used as a pathname
-delimiter, Perl cannot process VOS pathnames containing a slash
-character in a directory or file name; these must be renamed.
+This port of Perl version 5 prefers Unix-style, slash-separated
+pathnames over OpenVOS-style greater-than-separated pathnames.
+OpenVOS-style pathnames should work in most contexts, but if you have
+trouble, replace all greater-than characters by slash characters.
+Because the slash character is used as a pathname delimiter, Perl
+cannot process OpenVOS pathnames containing a slash character in a
+directory or file name; these must be renamed.
 
 This port of Perl also uses Unix-epoch date values internally.
 As long as you are dealing with ASCII character string
 representations of dates, this should not be an issue.  The
 supported epoch is January 1, 1980 to January 17, 2038.
 
-See the file pod/perlport.pod for more information about the VOS
+See the file pod/perlport.pod for more information about the OpenVOS
 port of Perl.
 
+=head1 TEST STATUS
+
+A number of the perl self-tests fails for various reasons; generally
+these are minor and due to subtle differences between common
+POSIX-based environments and the OpenVOS POSIX environment.  Ensure
+that you conduct sufficient testing of your code to guarantee that it
+works properly in the OpenVOS environment.
+
 =head1 SUPPORT STATUS
 
 I'm offering this port "as is".  You can ask me questions, but I
@@ -230,12 +106,16 @@ can't guarantee I'll be able to answer them.  There are some
 excellent books available on the Perl language; consult a book
 seller.
 
+If you want a supported version of perl for OpenVOS, purchase the
+OpenVOS GNU Tools product from Stratus Technologies, along with a
+support contract (or from anyone else who will sell you support).
+
 =head1 AUTHOR
 
-Paul Green (Paul_Green@stratus.com)
+Paul Green (Paul.Green@stratus.com)
 
 =head1 LAST UPDATE
 
-June 11, 2001
+February 28, 2013
 
 =cut