doc 0cc522 as requested by Nicholas
[p5sagit/p5-mst-13.2.git] / README.vos
1 If you read this file _as_is_, just ignore the funny characters you
2 see. It is written in the POD format (see pod/perlpod.pod) which is
3 specially designed to be readable as is.
4
5 =head1 NAME
6
7 README.vos - Perl for Stratus VOS
8
9 =head1 SYNOPSIS
10
11 This file contains notes for building perl on the Stratus VOS
12 operating system.  Perl is a scripting or macro language that is
13 popular on many systems.  See L<perlbook> for a number of good
14 books on Perl.
15
16 These are instructions for building Perl from source.  Most
17 people can simply download a pre-compiled distribution from the
18 VOS anonymous FTP site.  This version of Perl is not supported
19 on VOS Release 14.2.0 or earlier releases.  If you are running
20 VOS Release 14.3.0 or later, download Perl from
21 ftp://ftp.stratus.com/pub/vos/posix/ga/ga.html.  Instructions
22 for unbundling the Perl distribution file are at
23 ftp://ftp.stratus.com/pub/vos/utility/utility.html.
24
25 If you are running VOS Release 14.4.1 or later, you can obtain a
26 pre-compiled, supported copy of perl by purchasing Release 2.0.1
27 (or later) of the VOS GNU C/C++ and GNU Tools product from
28 Stratus Technologies.
29
30 =head1 BUILDING PERL FOR VOS
31
32 To build perl from its source code on the Stratus Continuum
33 platform, you must be have VOS Release 14.5.0 or later, the STCP
34 product, and the GNU C/C++ and GNU Tools, Release 2.0.1 or
35 later.  On the V Series platform you must have VOS Release
36 15.0.0 or later, and any version of the GNU C/C++ and GNU Tools
37 product.
38
39 To build full perl using the supplied Configure script and
40 makefiles, change to the "vos" subdirectory and type the command
41 "compile_full_perl" or "start_process compile_full_perl".  This
42 will configure, build, and test perl.
43
44 =head1 INSTALLING PERL IN VOS
45
46 =over 4
47
48 =item 1
49
50 If you have built perl using the Configure script, ensure that
51 you have modify and default write permission to C<<
52 >system>ported >> and all subdirectories.  Then type
53
54      gmake install
55
56 =item 2
57
58 While there are currently no architecture-specific
59 extensions or modules distributed with perl, the following
60 directories can be used to hold such files:
61
62      >system>ported>lib>perl5>5.9.0>7100
63      >system>ported>lib>perl5>5.9.0>8000
64      >system>ported>lib>perl5>5.9.0>i786
65
66 =item 3
67
68 Site-specific perl extensions and modules can be installed in one of
69 two places.  Put architecture-independent files into:
70
71      >system>ported>lib>perl5>site_perl>5.9.0
72
73 Put site-specific architecture-dependent files into one of the
74 following directories:
75
76      >system>ported>lib>perl5>site_perl>5.9.0>7100
77      >system>ported>lib>perl5>site_perl>5.9.0>8000
78      >system>ported>lib>perl5>site_perl>5.9.0>i786
79
80 =item 4
81
82 You can examine the @INC variable from within a perl program
83 to see the order in which Perl searches these directories.
84
85 =back
86
87 =head1 USING PERL IN VOS
88
89 =head2 Restrictions of Perl on VOS
90
91 This port of Perl version 5 to VOS prefers Unix-style,
92 slash-separated pathnames over VOS-style greater-than-separated
93 pathnames.  VOS-style pathnames should work in most contexts, but
94 if you have trouble, replace all greater-than characters by slash
95 characters.  Because the slash character is used as a pathname
96 delimiter, Perl cannot process VOS pathnames containing a slash
97 character in a directory or file name; these must be renamed.
98
99 This port of Perl also uses Unix-epoch date values internally.
100 As long as you are dealing with ASCII character string
101 representations of dates, this should not be an issue.  The
102 supported epoch is January 1, 1980 to January 17, 2038.
103
104 See the file pod/perlport.pod for more information about the VOS
105 port of Perl.
106
107 =head2 Handling of underflow and overflow
108
109 Prior to VOS Release 14.7.0, VOS does not support automatically
110 mapping overflowed floating-point values to +infinity, nor
111 automatically mapping underflowed floating-point values to zero,
112 unlike many other platforms.  The Perl pack function has been
113 modified to perform such mapping in software on VOS.  Performing
114 other floating-point computations that underflow or overflow
115 will probably result in SIGFPE.  Don't push your luck.
116
117 As of VOS Release 14.7.0, the VOS POSIX runtime sets up the
118 PA-RISC and IA-32 hardware floating-point status register so
119 that the overflow and underflow exceptions do not trap, but
120 instead automatically convert the result to infinity or zero, as
121 appropriate.  As of this writing, there are still floating-point
122 operations that can trap, for example, subtracting two infinite
123 values.  This is recorded as suggestion posix-1022, which has
124 been fixed in VOS Release 15.2 and higher.
125
126 =head1 TEST STATUS
127
128 When Perl 5.9.0 is built using the native build process on VOS
129 Release 14.7.0 and GNU C++/GNU Tools 2.0.2a, all but nine
130 attempted tests either pass or result in TODO (ignored)
131 failures.  The tests that fail are:
132
133 t/io/dup, test 2
134 t/io/tell, test 28
135 t/op/pack, test 0
136 ext/B/t/bytecode, test 1
137 ext/Devel/Peek/t/Peek, test 1
138 ext/Encode/t/enc_module, test 1
139 ext/IO/t/io_dup, test 2
140 lib/ExtUtils/t/MM_Unix, test 94
141 lib/Net/ing/t/450_service, test 8
142
143 =head1 SUPPORT STATUS
144
145 I'm offering this port "as is".  You can ask me questions, but I
146 can't guarantee I'll be able to answer them.  There are some
147 excellent books available on the Perl language; consult a book
148 seller.
149
150 If you want a supported version of perl for VOS, purchase the
151 VOS GNU C/C++ and GNU Tools Release 2.0.1 (or later) product from
152 Stratus Technologies, along with a support contract (or from
153 anyone else who will sell you support).
154
155 =head1 AUTHOR
156
157 Paul Green (Paul.Green@stratus.com)
158
159 =head1 LAST UPDATE
160
161 February 7, 2008
162
163 =cut