This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
regen/feature.pl - use regen/HeaderParser to parse perl.h
[perl5.git] / README.vos
1 # vim: syntax=pod
2
3 If you read this file _as_is_, just ignore the funny characters you
4 see. It is written in the POD format (see pod/perlpod.pod) which is
5 specially designed to be readable as is.
6
7 =head1 NAME
8
9 perlvos - Perl for Stratus OpenVOS
10
11 =head1 SYNOPSIS
12
13 This file contains notes for building perl on the Stratus OpenVOS
14 operating system.  Perl is a scripting or macro language that is
15 popular on many systems.  See L<perlbook> for a number of good books
16 on Perl.
17
18 These are instructions for building Perl from source.  This version of
19 Perl requires the dynamic linking support that is found in OpenVOS
20 Release 17.1 and thus is not supported on OpenVOS Release 17.0 or
21 earlier releases.
22
23 If you are running VOS Release 14.4.1 or later, you can obtain a
24 pre-compiled, supported copy of perl by purchasing the GNU Tools
25 product from Stratus Technologies.
26
27 =head1 BUILDING PERL FOR OPENVOS
28
29 To build perl from its source code on the Stratus V Series platform
30 you must have OpenVOS Release 17.1.0 or later, GNU Tools Release
31 3.5 or later, and the C/POSIX Runtime Libraries.
32
33 Follow the normal instructions for building perl; e.g, enter bash, run
34 the Configure script, then use "gmake" to build perl.
35
36 =head1 INSTALLING PERL IN OPENVOS
37
38 =over 4
39
40 =item 1
41
42 After you have built perl using the Configure script, ensure that you
43 have modify and default write permission to C<< >system>ported >> and
44 all subdirectories.  Then type
45
46      gmake install
47
48 =item 2
49
50 While there are currently no architecture-specific extensions or
51 modules distributed with perl, the following directories can be
52 used to hold such files (replace the string VERSION by the
53 appropriate version number):
54
55      >system>ported>lib>perl5>VERSION>i786
56
57 =item 3
58
59 Site-specific perl extensions and modules can be installed in one of
60 two places.  Put architecture-independent files into:
61
62      >system>ported>lib>perl5>site_perl>VERSION
63
64 Put site-specific architecture-dependent files into one of the
65 following directories:
66
67      >system>ported>lib>perl5>site_perl>VERSION>i786
68
69 =item 4
70
71 You can examine the @INC variable from within a perl program
72 to see the order in which Perl searches these directories.
73
74 =back
75
76 =head1 USING PERL IN OPENVOS
77
78 =head2 Restrictions of Perl on OpenVOS
79
80 This port of Perl version 5 prefers Unix-style, slash-separated
81 pathnames over OpenVOS-style greater-than-separated pathnames.
82 OpenVOS-style pathnames should work in most contexts, but if you have
83 trouble, replace all greater-than characters by slash characters.
84 Because the slash character is used as a pathname delimiter, Perl
85 cannot process OpenVOS pathnames containing a slash character in a
86 directory or file name; these must be renamed.
87
88 This port of Perl also uses Unix-epoch date values internally.
89 As long as you are dealing with ASCII character string
90 representations of dates, this should not be an issue.  The
91 supported epoch is January 1, 1980 to January 17, 2038.
92
93 See the file pod/perlport.pod for more information about the OpenVOS
94 port of Perl.
95
96 =head1 TEST STATUS
97
98 A number of the perl self-tests fails for various reasons; generally
99 these are minor and due to subtle differences between common
100 POSIX-based environments and the OpenVOS POSIX environment.  Ensure
101 that you conduct sufficient testing of your code to guarantee that it
102 works properly in the OpenVOS environment.
103
104 =head1 SUPPORT STATUS
105
106 I'm offering this port "as is".  You can ask me questions, but I
107 can't guarantee I'll be able to answer them.  There are some
108 excellent books available on the Perl language; consult a book
109 seller.
110
111 If you want a supported version of perl for OpenVOS, purchase the
112 OpenVOS GNU Tools product from Stratus Technologies, along with a
113 support contract (or from anyone else who will sell you support).
114
115 =head1 AUTHOR
116
117 Paul Green (Paul.Green@stratus.com)
118
119 =head1 LAST UPDATE
120
121 February 28, 2013
122
123 =cut