This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
[perl #112786] Fix build under clang++
[perl5.git] / pod / perlport.pod
CommitLineData
e41182b5
GS
1=head1 NAME
2
3perlport - Writing portable Perl
4
e41182b5
GS
5=head1 DESCRIPTION
6
b7df3edc
GS
7Perl runs on numerous operating systems. While most of them share
8much in common, they also have their own unique features.
e41182b5
GS
9
10This document is meant to help you to find out what constitutes portable
b7df3edc 11Perl code. That way once you make a decision to write portably,
e41182b5
GS
12you know where the lines are drawn, and you can stay within them.
13
b7df3edc
GS
14There is a tradeoff between taking full advantage of one particular
15type of computer and taking advantage of a full range of them.
16Naturally, as you broaden your range and become more diverse, the
17common factors drop, and you are left with an increasingly smaller
18area of common ground in which you can operate to accomplish a
19particular task. Thus, when you begin attacking a problem, it is
20important to consider under which part of the tradeoff curve you
21want to operate. Specifically, you must decide whether it is
22important that the task that you are coding have the full generality
23of being portable, or whether to just get the job done right now.
24This is the hardest choice to be made. The rest is easy, because
25Perl provides many choices, whichever way you want to approach your
0a47030a
GS
26problem.
27
28Looking at it another way, writing portable code is usually about
b7df3edc
GS
29willfully limiting your available choices. Naturally, it takes
30discipline and sacrifice to do that. The product of portability
31and convenience may be a constant. You have been warned.
e41182b5
GS
32
33Be aware of two important points:
34
35=over 4
36
37=item Not all Perl programs have to be portable
38
b7df3edc 39There is no reason you should not use Perl as a language to glue Unix
e41182b5
GS
40tools together, or to prototype a Macintosh application, or to manage the
41Windows registry. If it makes no sense to aim for portability for one
42reason or another in a given program, then don't bother.
43
b7df3edc 44=item Nearly all of Perl already I<is> portable
e41182b5
GS
45
46Don't be fooled into thinking that it is hard to create portable Perl
47code. It isn't. Perl tries its level-best to bridge the gaps between
48what's available on different platforms, and all the means available to
49use those features. Thus almost all Perl code runs on any machine
6ab3f9cb 50without modification. But there are some significant issues in
e41182b5
GS
51writing portable code, and this document is entirely about those issues.
52
53=back
54
b7df3edc
GS
55Here's the general rule: When you approach a task commonly done
56using a whole range of platforms, think about writing portable
e41182b5
GS
57code. That way, you don't sacrifice much by way of the implementation
58choices you can avail yourself of, and at the same time you can give
59your users lots of platform choices. On the other hand, when you have to
60take advantage of some unique feature of a particular platform, as is
61often the case with systems programming (whether for Unix, Windows,
204ad8d5 62VMS, etc.), consider writing platform-specific code.
e41182b5 63
b7df3edc
GS
64When the code will run on only two or three operating systems, you
65may need to consider only the differences of those particular systems.
66The important thing is to decide where the code will run and to be
0a47030a
GS
67deliberate in your decision.
68
69The material below is separated into three main sections: main issues of
7ee27b7c 70portability (L<"ISSUES">), platform-specific issues (L<"PLATFORMS">), and
b7df3edc 71built-in perl functions that behave differently on various ports
7ee27b7c 72(L<"FUNCTION IMPLEMENTATIONS">).
e41182b5
GS
73
74This information should not be considered complete; it includes possibly
b8099c3d 75transient information about idiosyncrasies of some of the ports, almost
b7df3edc 76all of which are in a state of constant evolution. Thus, this material
e41182b5 77should be considered a perpetual work in progress
cc07ed0b 78(C<< <IMG SRC="yellow_sign.gif" ALT="Under Construction"> >>).
e41182b5 79
e41182b5
GS
80=head1 ISSUES
81
82=head2 Newlines
83
638bc118 84In most operating systems, lines in files are terminated by newlines.
e41182b5 85Just what is used as a newline may vary from OS to OS. Unix
b7df3edc 86traditionally uses C<\012>, one type of DOSish I/O uses C<\015\012>,
e41182b5
GS
87and S<Mac OS> uses C<\015>.
88
b7df3edc
GS
89Perl uses C<\n> to represent the "logical" newline, where what is
90logical may depend on the platform in use. In MacPerl, C<\n> always
51d9476f 91means C<\015>. In DOSish perls, C<\n> usually means C<\012>, but when
92accessing a file in "text" mode, perl uses the C<:crlf> layer that
93translates it to (or from) C<\015\012>, depending on whether you're
94reading or writing. Unix does the same thing on ttys in canonical
95mode. C<\015\012> is commonly referred to as CRLF.
b7df3edc 96
31bb23b1
XN
97To trim trailing newlines from text lines use chomp(). With default
98settings that function looks for a trailing C<\n> character and thus
99trims in a portable way.
5b3eff12
MS
100
101When dealing with binary files (or text files in binary mode) be sure
102to explicitly set $/ to the appropriate value for your file format
103before using chomp().
104
b7df3edc
GS
105Because of the "text" mode translation, DOSish perls have limitations
106in using C<seek> and C<tell> on a file accessed in "text" mode.
107Stick to C<seek>-ing to locations you got from C<tell> (and no
108others), and you are usually free to use C<seek> and C<tell> even
109in "text" mode. Using C<seek> or C<tell> or other file operations
110may be non-portable. If you use C<binmode> on a file, however, you
111can usually C<seek> and C<tell> with arbitrary values in safety.
e41182b5
GS
112
113A common misconception in socket programming is that C<\n> eq C<\012>
0a47030a 114everywhere. When using protocols such as common Internet protocols,
e41182b5
GS
115C<\012> and C<\015> are called for specifically, and the values of
116the logical C<\n> and C<\r> (carriage return) are not reliable.
117
118 print SOCKET "Hi there, client!\r\n"; # WRONG
119 print SOCKET "Hi there, client!\015\012"; # RIGHT
120
0a47030a
GS
121However, using C<\015\012> (or C<\cM\cJ>, or C<\x0D\x0A>) can be tedious
122and unsightly, as well as confusing to those maintaining the code. As
6ab3f9cb 123such, the Socket module supplies the Right Thing for those who want it.
e41182b5
GS
124
125 use Socket qw(:DEFAULT :crlf);
126 print SOCKET "Hi there, client!$CRLF" # RIGHT
127
6ab3f9cb 128When reading from a socket, remember that the default input record
b7df3edc
GS
129separator C<$/> is C<\n>, but robust socket code will recognize as
130either C<\012> or C<\015\012> as end of line:
e41182b5
GS
131
132 while (<SOCKET>) {
133 # ...
134 }
135
b7df3edc
GS
136Because both CRLF and LF end in LF, the input record separator can
137be set to LF and any CR stripped later. Better to write:
e41182b5
GS
138
139 use Socket qw(:DEFAULT :crlf);
140 local($/) = LF; # not needed if $/ is already \012
141
142 while (<SOCKET>) {
143 s/$CR?$LF/\n/; # not sure if socket uses LF or CRLF, OK
144 # s/\015?\012/\n/; # same thing
145 }
146
b7df3edc
GS
147This example is preferred over the previous one--even for Unix
148platforms--because now any C<\015>'s (C<\cM>'s) are stripped out
e41182b5
GS
149(and there was much rejoicing).
150
6ab3f9cb 151Similarly, functions that return text data--such as a function that
b7df3edc
GS
152fetches a web page--should sometimes translate newlines before
153returning the data, if they've not yet been translated to the local
154newline representation. A single line of code will often suffice:
2ee0eb3c 155
b7df3edc
GS
156 $data =~ s/\015?\012/\n/g;
157 return $data;
2ee0eb3c 158
6ab3f9cb
GS
159Some of this may be confusing. Here's a handy reference to the ASCII CR
160and LF characters. You can print it out and stick it in your wallet.
161
74555b7a
PP
162 LF eq \012 eq \x0A eq \cJ eq chr(10) eq ASCII 10
163 CR eq \015 eq \x0D eq \cM eq chr(13) eq ASCII 13
6ab3f9cb
GS
164
165 | Unix | DOS | Mac |
166 ---------------------------
167 \n | LF | LF | CR |
168 \r | CR | CR | LF |
169 \n * | LF | CRLF | CR |
170 \r * | CR | CR | LF |
171 ---------------------------
172 * text-mode STDIO
173
b7df3edc
GS
174The Unix column assumes that you are not accessing a serial line
175(like a tty) in canonical mode. If you are, then CR on input becomes
176"\n", and "\n" on output becomes CRLF.
177
6ab3f9cb 178These are just the most common definitions of C<\n> and C<\r> in Perl.
522b859a
JH
179There may well be others. For example, on an EBCDIC implementation
180such as z/OS (OS/390) or OS/400 (using the ILE, the PASE is ASCII-based)
181the above material is similar to "Unix" but the code numbers change:
74555b7a 182
d770bc45
TS
183 LF eq \025 eq \x15 eq \cU eq chr(21) eq CP-1047 21
184 LF eq \045 eq \x25 eq chr(37) eq CP-0037 37
74555b7a
PP
185 CR eq \015 eq \x0D eq \cM eq chr(13) eq CP-1047 13
186 CR eq \015 eq \x0D eq \cM eq chr(13) eq CP-0037 13
187
188 | z/OS | OS/400 |
189 ----------------------
190 \n | LF | LF |
191 \r | CR | CR |
192 \n * | LF | LF |
193 \r * | CR | CR |
194 ----------------------
195 * text-mode STDIO
6ab3f9cb 196
322422de
GS
197=head2 Numbers endianness and Width
198
199Different CPUs store integers and floating point numbers in different
200orders (called I<endianness>) and widths (32-bit and 64-bit being the
b7df3edc
GS
201most common today). This affects your programs when they attempt to transfer
202numbers in binary format from one CPU architecture to another,
203usually either "live" via network connection, or by storing the
204numbers to secondary storage such as a disk file or tape.
322422de 205
b7df3edc 206Conflicting storage orders make utter mess out of the numbers. If a
d1e3b762 207little-endian host (Intel, VAX) stores 0x12345678 (305419896 in
b84d4f81
JH
208decimal), a big-endian host (Motorola, Sparc, PA) reads it as
2090x78563412 (2018915346 in decimal). Alpha and MIPS can be either:
210Digital/Compaq used/uses them in little-endian mode; SGI/Cray uses
211them in big-endian mode. To avoid this problem in network (socket)
212connections use the C<pack> and C<unpack> formats C<n> and C<N>, the
213"network" orders. These are guaranteed to be portable.
322422de 214
7a4d2905 215As of perl 5.9.2, you can also use the C<E<gt>> and C<E<lt>> modifiers
1109a392
MHM
216to force big- or little-endian byte-order. This is useful if you want
217to store signed integers or 64-bit integers, for example.
218
d1e3b762
GS
219You can explore the endianness of your platform by unpacking a
220data structure packed in native format such as:
221
222 print unpack("h*", pack("s2", 1, 2)), "\n";
223 # '10002000' on e.g. Intel x86 or Alpha 21064 in little-endian mode
224 # '00100020' on e.g. Motorola 68040
225
226If you need to distinguish between endian architectures you could use
227either of the variables set like so:
228
229 $is_big_endian = unpack("h*", pack("s", 1)) =~ /01/;
4375e838 230 $is_little_endian = unpack("h*", pack("s", 1)) =~ /^1/;
d1e3b762 231
b7df3edc
GS
232Differing widths can cause truncation even between platforms of equal
233endianness. The platform of shorter width loses the upper parts of the
322422de
GS
234number. There is no good solution for this problem except to avoid
235transferring or storing raw binary numbers.
236
b7df3edc 237One can circumnavigate both these problems in two ways. Either
322422de 238transfer and store numbers always in text format, instead of raw
b7df3edc 239binary, or else consider using modules like Data::Dumper (included in
83df6a1d
JH
240the standard distribution as of Perl 5.005) and Storable (included as
241of perl 5.8). Keeping all data as text significantly simplifies matters.
322422de 242
979699d9
JH
243The v-strings are portable only up to v2147483647 (0x7FFFFFFF), that's
244how far EBCDIC, or more precisely UTF-EBCDIC will go.
245
433acd8a 246=head2 Files and Filesystems
e41182b5
GS
247
248Most platforms these days structure files in a hierarchical fashion.
b7df3edc 249So, it is reasonably safe to assume that all platforms support the
6ab3f9cb 250notion of a "path" to uniquely identify a file on the system. How
b7df3edc 251that path is really written, though, differs considerably.
e41182b5 252
4375e838 253Although similar, file path specifications differ between Unix,
b7df3edc
GS
254Windows, S<Mac OS>, OS/2, VMS, VOS, S<RISC OS>, and probably others.
255Unix, for example, is one of the few OSes that has the elegant idea
256of a single root directory.
322422de 257
6ab3f9cb
GS
258DOS, OS/2, VMS, VOS, and Windows can work similarly to Unix with C</>
259as path separator, or in their own idiosyncratic ways (such as having
260several root directories and various "unrooted" device files such NIL:
261and LPT:).
322422de 262
204ad8d5 263S<Mac OS> 9 and earlier used C<:> as a path separator instead of C</>.
322422de 264
6ab3f9cb
GS
265The filesystem may support neither hard links (C<link>) nor
266symbolic links (C<symlink>, C<readlink>, C<lstat>).
433acd8a 267
6ab3f9cb 268The filesystem may support neither access timestamp nor change
433acd8a
JH
269timestamp (meaning that about the only portable timestamp is the
270modification timestamp), or one second granularity of any timestamps
271(e.g. the FAT filesystem limits the time granularity to two seconds).
272
74555b7a 273The "inode change timestamp" (the C<-C> filetest) may really be the
e1020413 274"creation timestamp" (which it is not in Unix).
95a3fe12 275
495c5fdc
PG
276VOS perl can emulate Unix filenames with C</> as path separator. The
277native pathname characters greater-than, less-than, number-sign, and
278percent-sign are always accepted.
279
6ab3f9cb 280S<RISC OS> perl can emulate Unix filenames with C</> as path
322422de 281separator, or go native and use C<.> for path separator and C<:> to
6ab3f9cb 282signal filesystems and disk names.
e41182b5 283
e1020413 284Don't assume Unix filesystem access semantics: that read, write,
a1667ba3
JH
285and execute are all the permissions there are, and even if they exist,
286that their semantics (for example what do r, w, and x mean on
e1020413 287a directory) are the Unix ones. The various Unix/POSIX compatibility
a1667ba3
JH
288layers usually try to make interfaces like chmod() work, but sometimes
289there simply is no good mapping.
290
b7df3edc
GS
291If all this is intimidating, have no (well, maybe only a little)
292fear. There are modules that can help. The File::Spec modules
293provide methods to do the Right Thing on whatever platform happens
294to be running the program.
e41182b5 295
6ab3f9cb
GS
296 use File::Spec::Functions;
297 chdir(updir()); # go up one directory
ceaffd1d 298 my $file = catfile(curdir(), 'temp', 'file.txt');
e41182b5 299 # on Unix and Win32, './temp/file.txt'
204ad8d5 300 # on Mac OS Classic, ':temp:file.txt'
d1e3b762 301 # on VMS, '[.temp]file.txt'
e41182b5 302
b7df3edc 303File::Spec is available in the standard distribution as of version
d1e3b762
GS
3045.004_05. File::Spec::Functions is only in File::Spec 0.7 and later,
305and some versions of perl come with version 0.6. If File::Spec
306is not updated to 0.7 or later, you must use the object-oriented
307interface from File::Spec (or upgrade File::Spec).
e41182b5 308
b7df3edc
GS
309In general, production code should not have file paths hardcoded.
310Making them user-supplied or read from a configuration file is
311better, keeping in mind that file path syntax varies on different
312machines.
e41182b5
GS
313
314This is especially noticeable in scripts like Makefiles and test suites,
315which often assume C</> as a path separator for subdirectories.
316
b7df3edc 317Also of use is File::Basename from the standard distribution, which
e41182b5
GS
318splits a pathname into pieces (base filename, full path to directory,
319and file suffix).
320
19799a22 321Even when on a single platform (if you can call Unix a single platform),
b7df3edc 322remember not to count on the existence or the contents of particular
3c075c7d 323system-specific files or directories, like F</etc/passwd>,
b7df3edc
GS
324F</etc/sendmail.conf>, F</etc/resolv.conf>, or even F</tmp/>. For
325example, F</etc/passwd> may exist but not contain the encrypted
326passwords, because the system is using some form of enhanced security.
327Or it may not contain all the accounts, because the system is using NIS.
3c075c7d 328If code does need to rely on such a file, include a description of the
b7df3edc 329file and its format in the code's documentation, then make it easy for
3c075c7d
CN
330the user to override the default location of the file.
331
b7df3edc
GS
332Don't assume a text file will end with a newline. They should,
333but people forget.
e41182b5 334
ec481373
JH
335Do not have two files or directories of the same name with different
336case, like F<test.pl> and F<Test.pl>, as many platforms have
337case-insensitive (or at least case-forgiving) filenames. Also, try
338not to have non-word characters (except for C<.>) in the names, and
339keep them to the 8.3 convention, for maximum portability, onerous a
340burden though this may appear.
dd9f0070 341
b7df3edc
GS
342Likewise, when using the AutoSplit module, try to keep your functions to
3438.3 naming and case-insensitive conventions; or, at the least,
dd9f0070
CN
344make it so the resulting files have a unique (case-insensitively)
345first 8 characters.
346
ec481373
JH
347Whitespace in filenames is tolerated on most systems, but not all,
348and even on systems where it might be tolerated, some utilities
fe829689 349might become confused by such whitespace.
ec481373 350
016930a6
JM
351Many systems (DOS, VMS ODS-2) cannot have more than one C<.> in their
352filenames.
433acd8a 353
c47ff5f1 354Don't assume C<< > >> won't be the first character of a filename.
fe829689
PN
355Always use C<< < >> explicitly to open a file for reading, or even
356better, use the three-arg version of open, unless you want the user to
357be able to specify a pipe open.
0a47030a 358
ceaffd1d 359 open my $fh, '<', $existing_file) or die $!;
0a47030a 360
6ab3f9cb
GS
361If filenames might use strange characters, it is safest to open it
362with C<sysopen> instead of C<open>. C<open> is magic and can
c47ff5f1 363translate characters like C<< > >>, C<< < >>, and C<|>, which may
b7df3edc 364be the wrong thing to do. (Sometimes, though, it's the right thing.)
fe829689
PN
365Three-arg open can also help protect against this translation in cases
366where it is undesirable.
e41182b5 367
ec481373 368Don't use C<:> as a part of a filename since many systems use that for
8939ba94 369their own semantics (Mac OS Classic for separating pathname components,
ec481373 370many networking schemes and utilities for separating the nodename and
08fef530
JH
371the pathname, and so on). For the same reasons, avoid C<@>, C<;> and
372C<|>.
ec481373 373
e1516da7
JH
374Don't assume that in pathnames you can collapse two leading slashes
375C<//> into one: some networking and clustering filesystems have special
376semantics for that. Let the operating system to sort it out.
377
ec481373
JH
378The I<portable filename characters> as defined by ANSI C are
379
380 a b c d e f g h i j k l m n o p q r t u v w x y z
381 A B C D E F G H I J K L M N O P Q R T U V W X Y Z
382 0 1 2 3 4 5 6 7 8 9
383 . _ -
384
08fef530 385and the "-" shouldn't be the first character. If you want to be
e1516da7
JH
386hypercorrect, stay case-insensitive and within the 8.3 naming
387convention (all the files and directories have to be unique within one
388directory if their names are lowercased and truncated to eight
389characters before the C<.>, if any, and to three characters after the
390C<.>, if any). (And do not use C<.>s in directory names.)
ec481373 391
e41182b5
GS
392=head2 System Interaction
393
b7df3edc
GS
394Not all platforms provide a command line. These are usually platforms
395that rely primarily on a Graphical User Interface (GUI) for user
396interaction. A program requiring a command line interface might
397not work everywhere. This is probably for the user of the program
398to deal with, so don't stay up late worrying about it.
e41182b5 399
c87488a3
HS
400Some platforms can't delete or rename files held open by the system,
401this limitation may also apply to changing filesystem metainformation
402like file permissions or owners. Remember to C<close> files when you
403are done with them. Don't C<unlink> or C<rename> an open file. Don't
404C<tie> or C<open> a file already tied or opened; C<untie> or C<close>
405it first.
e41182b5 406
0a47030a
GS
407Don't open the same file more than once at a time for writing, as some
408operating systems put mandatory locks on such files.
409
73e9292c
JH
410Don't assume that write/modify permission on a directory gives the
411right to add or delete files/directories in that directory. That is
412filesystem specific: in some filesystems you need write/modify
413permission also (or even just) in the file/directory itself. In some
414filesystems (AFS, DFS) the permission to add/delete directory entries
415is a completely separate permission.
416
417Don't assume that a single C<unlink> completely gets rid of the file:
418some filesystems (most notably the ones in VMS) have versioned
419filesystems, and unlink() removes only the most recent one (it doesn't
420remove all the versions because by default the native tools on those
421platforms remove just the most recent version, too). The portable
422idiom to remove all the versions of a file is
423
94bb614c 424 1 while unlink "file";
73e9292c
JH
425
426This will terminate if the file is undeleteable for some reason
427(protected, not there, and so on).
428
e41182b5 429Don't count on a specific environment variable existing in C<%ENV>.
0a47030a 430Don't count on C<%ENV> entries being case-sensitive, or even
4a0d0822 431case-preserving. Don't try to clear %ENV by saying C<%ENV = ();>, or,
6be8f7a6 432if you really have to, make it conditional on C<$^O ne 'VMS'> since in
4a0d0822
JH
433VMS the C<%ENV> table is much more than a per-process key-value string
434table.
e41182b5 435
c73b03b7
JM
436On VMS, some entries in the %ENV hash are dynamically created when
437their key is used on a read if they did not previously exist. The
438values for C<$ENV{HOME}>, C<$ENV{TERM}>, C<$ENV{HOME}>, and C<$ENV{USER}>,
439are known to be dynamically generated. The specific names that are
440dynamically generated may vary with the version of the C library on VMS,
441and more may exist than is documented.
442
443On VMS by default, changes to the %ENV hash are persistent after the process
444exits. This can cause unintended issues.
445
d1e3b762 446Don't count on signals or C<%SIG> for anything.
e41182b5
GS
447
448Don't count on filename globbing. Use C<opendir>, C<readdir>, and
449C<closedir> instead.
450
b8099c3d 451Don't count on per-program environment variables, or per-program current
dd9f0070 452directories.
b8099c3d 453
c87488a3 454Don't count on specific values of C<$!>, neither numeric nor
ac036724 455especially the strings values. Users may switch their locales causing
c87488a3
HS
456error messages to be translated into their languages. If you can
457trust a POSIXish environment, you can portably use the symbols defined
458by the Errno module, like ENOENT. And don't trust on the values of C<$!>
459at all except immediately after a failed system call.
3c075c7d 460
a10d74f3
PG
461=head2 Command names versus file pathnames
462
463Don't assume that the name used to invoke a command or program with
464C<system> or C<exec> can also be used to test for the existence of the
465file that holds the executable code for that command or program.
68fb0eb7
PG
466First, many systems have "internal" commands that are built-in to the
467shell or OS and while these commands can be invoked, there is no
468corresponding file. Second, some operating systems (e.g., Cygwin,
469DJGPP, OS/2, and VOS) have required suffixes for executable files;
470these suffixes are generally permitted on the command name but are not
a10d74f3
PG
471required. Thus, a command like "perl" might exist in a file named
472"perl", "perl.exe", or "perl.pm", depending on the operating system.
473The variable "_exe" in the Config module holds the executable suffix,
68fb0eb7
PG
474if any. Third, the VMS port carefully sets up $^X and
475$Config{perlpath} so that no further processing is required. This is
476just as well, because the matching regular expression used below would
477then have to deal with a possible trailing version number in the VMS
478file name.
a10d74f3
PG
479
480To convert $^X to a file pathname, taking account of the requirements
481of the various operating system possibilities, say:
7ee27b7c 482
a61fc69c
KW
483 use Config;
484 my $thisperl = $^X;
485 if ($^O ne 'VMS')
486 {$thisperl .= $Config{_exe} unless $thisperl =~ m/$Config{_exe}$/i;}
a10d74f3
PG
487
488To convert $Config{perlpath} to a file pathname, say:
7ee27b7c 489
a61fc69c
KW
490 use Config;
491 my $thisperl = $Config{perlpath};
492 if ($^O ne 'VMS')
493 {$thisperl .= $Config{_exe} unless $thisperl =~ m/$Config{_exe}$/i;}
a10d74f3 494
7137b697
JH
495=head2 Networking
496
497Don't assume that you can reach the public Internet.
498
499Don't assume that there is only one way to get through firewalls
500to the public Internet.
501
932f293e
JH
502Don't assume that you can reach outside world through any other port
503than 80, or some web proxy. ftp is blocked by many firewalls.
504
dbc6a9ce
JH
505Don't assume that you can send email by connecting to the local SMTP port.
506
7137b697 507Don't assume that you can reach yourself or any node by the name
dbc6a9ce 508'localhost'. The same goes for '127.0.0.1'. You will have to try both.
932f293e 509
86feb2c5
JH
510Don't assume that the host has only one network card, or that it
511can't bind to many virtual IP addresses.
932f293e
JH
512
513Don't assume a particular network device name.
7137b697 514
dbc6a9ce 515Don't assume a particular set of ioctl()s will work.
7137b697
JH
516
517Don't assume that you can ping hosts and get replies.
518
dbc6a9ce
JH
519Don't assume that any particular port (service) will respond.
520
ac036724 521Don't assume that Sys::Hostname (or any other API or command) returns
522either a fully qualified hostname or a non-qualified hostname: it all
523depends on how the system had been configured. Also remember that for
524things such as DHCP and NAT, the hostname you get back might not be
525very useful.
dbc6a9ce 526
ac036724 527All the above "don't":s may look daunting, and they are, but the key
932f293e
JH
528is to degrade gracefully if one cannot reach the particular network
529service one wants. Croaking or hanging do not look very professional.
530
e41182b5
GS
531=head2 Interprocess Communication (IPC)
532
b7df3edc
GS
533In general, don't directly access the system in code meant to be
534portable. That means, no C<system>, C<exec>, C<fork>, C<pipe>,
535C<``>, C<qx//>, C<open> with a C<|>, nor any of the other things
536that makes being a perl hacker worth being.
e41182b5
GS
537
538Commands that launch external processes are generally supported on
b7df3edc
GS
539most platforms (though many of them do not support any type of
540forking). The problem with using them arises from what you invoke
541them on. External tools are often named differently on different
4375e838 542platforms, may not be available in the same location, might accept
b7df3edc
GS
543different arguments, can behave differently, and often present their
544results in a platform-dependent way. Thus, you should seldom depend
545on them to produce consistent results. (Then again, if you're calling
546I<netstat -a>, you probably don't expect it to run on both Unix and CP/M.)
e41182b5 547
b7df3edc 548One especially common bit of Perl code is opening a pipe to B<sendmail>:
e41182b5 549
b7df3edc
GS
550 open(MAIL, '|/usr/lib/sendmail -t')
551 or die "cannot fork sendmail: $!";
e41182b5
GS
552
553This is fine for systems programming when sendmail is known to be
554available. But it is not fine for many non-Unix systems, and even
555some Unix systems that may not have sendmail installed. If a portable
b7df3edc
GS
556solution is needed, see the various distributions on CPAN that deal
557with it. Mail::Mailer and Mail::Send in the MailTools distribution are
558commonly used, and provide several mailing methods, including mail,
559sendmail, and direct SMTP (via Net::SMTP) if a mail transfer agent is
560not available. Mail::Sendmail is a standalone module that provides
561simple, platform-independent mailing.
562
563The Unix System V IPC (C<msg*(), sem*(), shm*()>) is not available
564even on all Unix platforms.
e41182b5 565
a81e5e2e
A
566Do not use either the bare result of C<pack("N", 10, 20, 30, 40)> or
567bare v-strings (such as C<v10.20.30.40>) to represent IPv4 addresses:
568both forms just pack the four bytes into network order. That this
569would be equal to the C language C<in_addr> struct (which is what the
570socket code internally uses) is not guaranteed. To be portable use
571the routines of the Socket extension, such as C<inet_aton()>,
572C<inet_ntoa()>, and C<sockaddr_in()>.
6b2463a0 573
e41182b5 574The rule of thumb for portable code is: Do it all in portable Perl, or
0a47030a
GS
575use a module (that may internally implement it with platform-specific
576code, but expose a common interface).
e41182b5 577
e41182b5
GS
578=head2 External Subroutines (XS)
579
b7df3edc 580XS code can usually be made to work with any platform, but dependent
e41182b5
GS
581libraries, header files, etc., might not be readily available or
582portable, or the XS code itself might be platform-specific, just as Perl
583code might be. If the libraries and headers are portable, then it is
584normally reasonable to make sure the XS code is portable, too.
585
b7df3edc
GS
586A different type of portability issue arises when writing XS code:
587availability of a C compiler on the end-user's system. C brings
588with it its own portability issues, and writing XS code will expose
589you to some of those. Writing purely in Perl is an easier way to
e41182b5
GS
590achieve portability.
591
e41182b5
GS
592=head2 Standard Modules
593
594In general, the standard modules work across platforms. Notable
6ab3f9cb 595exceptions are the CPAN module (which currently makes connections to external
e41182b5 596programs that may not be available), platform-specific modules (like
6ab3f9cb 597ExtUtils::MM_VMS), and DBM modules.
e41182b5 598
b7df3edc 599There is no one DBM module available on all platforms.
6ab3f9cb
GS
600SDBM_File and the others are generally available on all Unix and DOSish
601ports, but not in MacPerl, where only NBDM_File and DB_File are
0a47030a 602available.
e41182b5
GS
603
604The good news is that at least some DBM module should be available, and
6ab3f9cb 605AnyDBM_File will use whichever module it can find. Of course, then
b7df3edc
GS
606the code needs to be fairly strict, dropping to the greatest common
607factor (e.g., not exceeding 1K for each record), so that it will
6ab3f9cb 608work with any DBM module. See L<AnyDBM_File> for more details.
e41182b5 609
e41182b5
GS
610=head2 Time and Date
611
0a47030a 612The system's notion of time of day and calendar date is controlled in
b7df3edc 613widely different ways. Don't assume the timezone is stored in C<$ENV{TZ}>,
0a47030a 614and even if it is, don't assume that you can control the timezone through
c87488a3
HS
615that variable. Don't assume anything about the three-letter timezone
616abbreviations (for example that MST would be the Mountain Standard Time,
617it's been known to stand for Moscow Standard Time). If you need to
618use timezones, express them in some unambiguous format like the
619exact number of minutes offset from UTC, or the POSIX timezone
620format.
e41182b5 621
322422de 622Don't assume that the epoch starts at 00:00:00, January 1, 1970,
c87488a3
HS
623because that is OS- and implementation-specific. It is better to
624store a date in an unambiguous representation. The ISO 8601 standard
766af94f 625defines YYYY-MM-DD as the date format, or YYYY-MM-DDTHH:MM:SS
c87488a3 626(that's a literal "T" separating the date from the time).
91d20606 627Please do use the ISO 8601 instead of making us guess what
c87488a3
HS
628date 02/03/04 might be. ISO 8601 even sorts nicely as-is.
629A text representation (like "1987-12-18") can be easily converted
630into an OS-specific value using a module like Date::Parse.
631An array of values, such as those returned by C<localtime>, can be
632converted to an OS-specific representation using Time::Local.
322422de 633
19799a22
GS
634When calculating specific times, such as for tests in time or date modules,
635it may be appropriate to calculate an offset for the epoch.
b7df3edc 636
19799a22 637 require Time::Local;
ceaffd1d 638 my $offset = Time::Local::timegm(0, 0, 0, 1, 0, 70);
b7df3edc 639
204ad8d5
JV
640The value for C<$offset> in Unix will be C<0>, but in Mac OS Classic
641will be some large number. C<$offset> can then be added to a Unix time
642value to get what should be the proper value on any system.
322422de
GS
643
644=head2 Character sets and character encoding
645
ec481373
JH
646Assume very little about character sets.
647
648Assume nothing about numerical values (C<ord>, C<chr>) of characters.
649Do not use explicit code point ranges (like \xHH-\xHH); use for
650example symbolic character classes like C<[:print:]>.
651
652Do not assume that the alphabetic characters are encoded contiguously
653(in the numeric sense). There may be gaps.
654
655Do not assume anything about the ordering of the characters.
656The lowercase letters may come before or after the uppercase letters;
b432a672
AL
657the lowercase and uppercase may be interlaced so that both "a" and "A"
658come before "b"; the accented and other international characters may
659be interlaced so that E<auml> comes before "b".
322422de
GS
660
661=head2 Internationalisation
662
b7df3edc
GS
663If you may assume POSIX (a rather large assumption), you may read
664more about the POSIX locale system from L<perllocale>. The locale
665system at least attempts to make things a little bit more portable,
666or at least more convenient and native-friendly for non-English
667users. The system affects character sets and encoding, and date
668and time formatting--amongst other things.
e41182b5 669
c87488a3
HS
670If you really want to be international, you should consider Unicode.
671See L<perluniintro> and L<perlunicode> for more information.
672
11264fdb
JH
673If you want to use non-ASCII bytes (outside the bytes 0x00..0x7f) in
674the "source code" of your code, to be portable you have to be explicit
675about what bytes they are. Someone might for example be using your
676code under a UTF-8 locale, in which case random native bytes might be
677illegal ("Malformed UTF-8 ...") This means that for example embedding
678ISO 8859-1 bytes beyond 0x7f into your strings might cause trouble
679later. If the bytes are native 8-bit bytes, you can use the C<bytes>
680pragma. If the bytes are in a string (regular expression being a
681curious string), you can often also use the C<\xHH> notation instead
2575c402
JW
682of embedding the bytes as-is. (If you want to write your code in UTF-8,
683you can use the C<utf8>.) The C<bytes> and C<utf8> pragmata are
684available since Perl 5.6.0.
11264fdb 685
e41182b5
GS
686=head2 System Resources
687
0a47030a
GS
688If your code is destined for systems with severely constrained (or
689missing!) virtual memory systems then you want to be I<especially> mindful
690of avoiding wasteful constructs such as:
e41182b5 691
ceaffd1d 692 my @lines = <$very_large_file>; # bad
e41182b5 693
ceaffd1d 694 while (<$fh>) {$file .= $_} # sometimes bad
695 my $file = join('', <$fh>); # better
e41182b5 696
b7df3edc
GS
697The last two constructs may appear unintuitive to most people. The
698first repeatedly grows a string, whereas the second allocates a
699large chunk of memory in one go. On some systems, the second is
700more efficient that the first.
0a47030a 701
e41182b5
GS
702=head2 Security
703
b7df3edc 704Most multi-user platforms provide basic levels of security, usually
ac036724 705implemented at the filesystem level. Some, however, unfortunately do
706not. Thus the notion of user id, or "home" directory,
b7df3edc
GS
707or even the state of being logged-in, may be unrecognizable on many
708platforms. If you write programs that are security-conscious, it
709is usually best to know what type of system you will be running
710under so that you can write code explicitly for that platform (or
711class of platforms).
0a47030a 712
e1020413 713Don't assume the Unix filesystem access semantics: the operating
a1667ba3
JH
714system or the filesystem may be using some ACL systems, which are
715richer languages than the usual rwx. Even if the rwx exist,
716their semantics might be different.
717
718(From security viewpoint testing for permissions before attempting to
719do something is silly anyway: if one tries this, there is potential
ac036724 720for race conditions. Someone or something might change the
a1667ba3
JH
721permissions between the permissions check and the actual operation.
722Just try the operation.)
723
e1020413 724Don't assume the Unix user and group semantics: especially, don't
2edcc0d9 725expect the C<< $< >> and C<< $> >> (or the C<$(> and C<$)>) to work
a1667ba3
JH
726for switching identities (or memberships).
727
728Don't assume set-uid and set-gid semantics. (And even if you do,
729think twice: set-uid and set-gid are a known can of security worms.)
730
e41182b5
GS
731=head2 Style
732
733For those times when it is necessary to have platform-specific code,
734consider keeping the platform-specific code in one place, making porting
6ab3f9cb 735to other platforms easier. Use the Config module and the special
0a47030a
GS
736variable C<$^O> to differentiate platforms, as described in
737L<"PLATFORMS">.
e41182b5 738
b7df3edc
GS
739Be careful in the tests you supply with your module or programs.
740Module code may be fully portable, but its tests might not be. This
741often happens when tests spawn off other processes or call external
742programs to aid in the testing, or when (as noted above) the tests
c87488a3
HS
743assume certain things about the filesystem and paths. Be careful not
744to depend on a specific output style for errors, such as when checking
745C<$!> after a failed system call. Using C<$!> for anything else than
746displaying it as output is doubtful (though see the Errno module for
747testing reasonably portably for error value). Some platforms expect
748a certain output format, and Perl on those platforms may have been
749adjusted accordingly. Most specifically, don't anchor a regex when
750testing an error value.
e41182b5 751
0a47030a 752=head1 CPAN Testers
e41182b5 753
0a47030a
GS
754Modules uploaded to CPAN are tested by a variety of volunteers on
755different platforms. These CPAN testers are notified by mail of each
e41182b5 756new upload, and reply to the list with PASS, FAIL, NA (not applicable to
0a47030a 757this platform), or UNKNOWN (unknown), along with any relevant notations.
e41182b5
GS
758
759The purpose of the testing is twofold: one, to help developers fix any
0a47030a 760problems in their code that crop up because of lack of testing on other
b7df3edc 761platforms; two, to provide users with information about whether
0a47030a 762a given module works on a given platform.
e41182b5 763
7ee27b7c
AT
764Also see:
765
e41182b5
GS
766=over 4
767
7ee27b7c
AT
768=item *
769
636280bd 770Mailing list: cpan-testers-discuss@perl.org
7ee27b7c
AT
771
772=item *
e41182b5 773
500f1b69 774Testing results: L<http://www.cpantesters.org/>
e41182b5
GS
775
776=back
777
e41182b5
GS
778=head1 PLATFORMS
779
780As of version 5.002, Perl is built with a C<$^O> variable that
781indicates the operating system it was built on. This was implemented
b7df3edc
GS
782to help speed up code that would otherwise have to C<use Config>
783and use the value of C<$Config{osname}>. Of course, to get more
e41182b5
GS
784detailed information about the system, looking into C<%Config> is
785certainly recommended.
786
b7df3edc
GS
787C<%Config> cannot always be trusted, however, because it was built
788at compile time. If perl was built in one place, then transferred
789elsewhere, some values may be wrong. The values may even have been
790edited after the fact.
6ab3f9cb 791
e41182b5
GS
792=head2 Unix
793
794Perl works on a bewildering variety of Unix and Unix-like platforms (see
795e.g. most of the files in the F<hints/> directory in the source code kit).
796On most of these systems, the value of C<$^O> (hence C<$Config{'osname'}>,
d1e3b762
GS
797too) is determined either by lowercasing and stripping punctuation from the
798first field of the string returned by typing C<uname -a> (or a similar command)
799at the shell prompt or by testing the file system for the presence of
800uniquely named files such as a kernel or header file. Here, for example,
801are a few of the more popular Unix flavors:
e41182b5 802
b7df3edc 803 uname $^O $Config{'archname'}
6ab3f9cb 804 --------------------------------------------
b7df3edc 805 AIX aix aix
6ab3f9cb 806 BSD/OS bsdos i386-bsdos
e1516da7 807 Darwin darwin darwin
6ab3f9cb
GS
808 dgux dgux AViiON-dgux
809 DYNIX/ptx dynixptx i386-dynixptx
b7df3edc 810 FreeBSD freebsd freebsd-i386
df00ff3b 811 Haiku haiku BePC-haiku
d1e3b762 812 Linux linux arm-linux
b7df3edc 813 Linux linux i386-linux
6ab3f9cb
GS
814 Linux linux i586-linux
815 Linux linux ppc-linux
b7df3edc
GS
816 HP-UX hpux PA-RISC1.1
817 IRIX irix irix
b787fad4 818 Mac OS X darwin darwin
d1e3b762
GS
819 NeXT 3 next next-fat
820 NeXT 4 next OPENSTEP-Mach
6ab3f9cb 821 openbsd openbsd i386-openbsd
b7df3edc 822 OSF1 dec_osf alpha-dec_osf
6ab3f9cb
GS
823 reliantunix-n svr4 RM400-svr4
824 SCO_SV sco_sv i386-sco_sv
825 SINIX-N svr4 RM400-svr4
826 sn4609 unicos CRAY_C90-unicos
827 sn6521 unicosmk t3e-unicosmk
828 sn9617 unicos CRAY_J90-unicos
b7df3edc
GS
829 SunOS solaris sun4-solaris
830 SunOS solaris i86pc-solaris
831 SunOS4 sunos sun4-sunos
e41182b5 832
b7df3edc
GS
833Because the value of C<$Config{archname}> may depend on the
834hardware architecture, it can vary more than the value of C<$^O>.
6ab3f9cb 835
e41182b5
GS
836=head2 DOS and Derivatives
837
b7df3edc 838Perl has long been ported to Intel-style microcomputers running under
e41182b5
GS
839systems like PC-DOS, MS-DOS, OS/2, and most Windows platforms you can
840bring yourself to mention (except for Windows CE, if you count that).
b7df3edc 841Users familiar with I<COMMAND.COM> or I<CMD.EXE> style shells should
e41182b5
GS
842be aware that each of these file specifications may have subtle
843differences:
844
ceaffd1d 845 my $filespec0 = "c:/foo/bar/file.txt";
846 my $filespec1 = "c:\\foo\\bar\\file.txt";
847 my $filespec2 = 'c:\foo\bar\file.txt';
848 my $filespec3 = 'c:\\foo\\bar\\file.txt';
e41182b5 849
b7df3edc
GS
850System calls accept either C</> or C<\> as the path separator.
851However, many command-line utilities of DOS vintage treat C</> as
852the option prefix, so may get confused by filenames containing C</>.
853Aside from calling any external programs, C</> will work just fine,
854and probably better, as it is more consistent with popular usage,
855and avoids the problem of remembering what to backwhack and what
856not to.
e41182b5 857
b7df3edc
GS
858The DOS FAT filesystem can accommodate only "8.3" style filenames. Under
859the "case-insensitive, but case-preserving" HPFS (OS/2) and NTFS (NT)
0a47030a 860filesystems you may have to be careful about case returned with functions
e41182b5
GS
861like C<readdir> or used with functions like C<open> or C<opendir>.
862
b7df3edc
GS
863DOS also treats several filenames as special, such as AUX, PRN,
864NUL, CON, COM1, LPT1, LPT2, etc. Unfortunately, sometimes these
865filenames won't even work if you include an explicit directory
866prefix. It is best to avoid such filenames, if you want your code
867to be portable to DOS and its derivatives. It's hard to know what
868these all are, unfortunately.
e41182b5
GS
869
870Users of these operating systems may also wish to make use of
b7df3edc 871scripts such as I<pl2bat.bat> or I<pl2cmd> to
e41182b5
GS
872put wrappers around your scripts.
873
874Newline (C<\n>) is translated as C<\015\012> by STDIO when reading from
6ab3f9cb
GS
875and writing to files (see L<"Newlines">). C<binmode(FILEHANDLE)>
876will keep C<\n> translated as C<\012> for that filehandle. Since it is a
877no-op on other systems, C<binmode> should be used for cross-platform code
b7df3edc
GS
878that deals with binary data. That's assuming you realize in advance
879that your data is in binary. General-purpose programs should
880often assume nothing about their data.
e41182b5 881
b7df3edc 882The C<$^O> variable and the C<$Config{archname}> values for various
e41182b5
GS
883DOSish perls are as follows:
884
67ac489e
MS
885 OS $^O $Config{archname} ID Version
886 --------------------------------------------------------
887 MS-DOS dos ?
888 PC-DOS dos ?
889 OS/2 os2 ?
890 Windows 3.1 ? ? 0 3 01
891 Windows 95 MSWin32 MSWin32-x86 1 4 00
892 Windows 98 MSWin32 MSWin32-x86 1 4 10
893 Windows ME MSWin32 MSWin32-x86 1 ?
894 Windows NT MSWin32 MSWin32-x86 2 4 xx
895 Windows NT MSWin32 MSWin32-ALPHA 2 4 xx
896 Windows NT MSWin32 MSWin32-ppc 2 4 xx
7ee27b7c
AT
897 Windows 2000 MSWin32 MSWin32-x86 2 5 00
898 Windows XP MSWin32 MSWin32-x86 2 5 01
899 Windows 2003 MSWin32 MSWin32-x86 2 5 02
bc643a33
CJ
900 Windows Vista MSWin32 MSWin32-x86 2 6 00
901 Windows 7 MSWin32 MSWin32-x86 2 6 01
902 Windows 7 MSWin32 MSWin32-x64 2 6 01
ae525322
CBW
903 Windows 2008 MSWin32 MSWin32-x86 2 6 01
904 Windows 2008 MSWin32 MSWin32-x64 2 6 01
67ac489e 905 Windows CE MSWin32 ? 3
7ee27b7c 906 Cygwin cygwin cygwin
e41182b5 907
34aaaa84
PP
908The various MSWin32 Perl's can distinguish the OS they are running on
909via the value of the fifth element of the list returned from
910Win32::GetOSVersion(). For example:
911
912 if ($^O eq 'MSWin32') {
913 my @os_version_info = Win32::GetOSVersion();
914 print +('3.1','95','NT')[$os_version_info[4]],"\n";
915 }
916
7939d86b
JH
917There are also Win32::IsWinNT() and Win32::IsWin95(), try C<perldoc Win32>,
918and as of libwin32 0.19 (not part of the core Perl distribution)
919Win32::GetOSName(). The very portable POSIX::uname() will work too:
1d65be3a
JH
920
921 c:\> perl -MPOSIX -we "print join '|', uname"
922 Windows NT|moonru|5.0|Build 2195 (Service Pack 2)|x86
d99f392e 923
e41182b5
GS
924Also see:
925
926=over 4
927
c997b287 928=item *
e41182b5 929
500f1b69 930The djgpp environment for DOS, L<http://www.delorie.com/djgpp/>
c997b287 931and L<perldos>.
e41182b5 932
c997b287 933=item *
e41182b5 934
c997b287 935The EMX environment for DOS, OS/2, etc. emx@iaehv.nl,
500f1b69 936L<ftp://hobbes.nmsu.edu/pub/os2/dev/emx/> Also L<perlos2>.
e41182b5 937
c997b287 938=item *
d1e3b762 939
c997b287
GS
940Build instructions for Win32 in L<perlwin32>, or under the Cygnus environment
941in L<perlcygwin>.
942
943=item *
944
945The C<Win32::*> modules in L<Win32>.
946
947=item *
948
500f1b69 949The ActiveState Pages, L<http://www.activestate.com/>
c997b287
GS
950
951=item *
952
953The Cygwin environment for Win32; F<README.cygwin> (installed
500f1b69 954as L<perlcygwin>), L<http://www.cygwin.com/>
c997b287
GS
955
956=item *
957
958The U/WIN environment for Win32,
500f1b69 959L<http://www.research.att.com/sw/tools/uwin/>
c997b287 960
cea6626f 961=item *
d1e3b762 962
cea6626f 963Build instructions for OS/2, L<perlos2>
d1e3b762 964
e41182b5
GS
965=back
966
e41182b5
GS
967=head2 VMS
968
c997b287 969Perl on VMS is discussed in L<perlvms> in the perl distribution.
016930a6
JM
970
971The official name of VMS as of this writing is OpenVMS.
972
b7df3edc 973Perl on VMS can accept either VMS- or Unix-style file
e41182b5
GS
974specifications as in either of the following:
975
976 $ perl -ne "print if /perl_setup/i" SYS$LOGIN:LOGIN.COM
977 $ perl -ne "print if /perl_setup/i" /sys$login/login.com
978
979but not a mixture of both as in:
980
981 $ perl -ne "print if /perl_setup/i" sys$login:/login.com
982 Can't open sys$login:/login.com: file specification syntax error
983
984Interacting with Perl from the Digital Command Language (DCL) shell
985often requires a different set of quotation marks than Unix shells do.
986For example:
987
988 $ perl -e "print ""Hello, world.\n"""
989 Hello, world.
990
b7df3edc 991There are several ways to wrap your perl scripts in DCL F<.COM> files, if
e41182b5
GS
992you are so inclined. For example:
993
994 $ write sys$output "Hello from DCL!"
995 $ if p1 .eqs. ""
996 $ then perl -x 'f$environment("PROCEDURE")
997 $ else perl -x - 'p1 'p2 'p3 'p4 'p5 'p6 'p7 'p8
998 $ deck/dollars="__END__"
999 #!/usr/bin/perl
1000
1001 print "Hello from Perl!\n";
1002
1003 __END__
1004 $ endif
1005
1006Do take care with C<$ ASSIGN/nolog/user SYS$COMMAND: SYS$INPUT> if your
c47ff5f1 1007perl-in-DCL script expects to do things like C<< $read = <STDIN>; >>.
e41182b5 1008
016930a6
JM
1009The VMS operating system has two filesystems, known as ODS-2 and ODS-5.
1010
1011For ODS-2, filenames are in the format "name.extension;version". The
1012maximum length for filenames is 39 characters, and the maximum length for
e41182b5
GS
1013extensions is also 39 characters. Version is a number from 1 to
101432767. Valid characters are C</[A-Z0-9$_-]/>.
1015
016930a6
JM
1016The ODS-2 filesystem is case-insensitive and does not preserve case.
1017Perl simulates this by converting all filenames to lowercase internally.
1018
1019For ODS-5, filenames may have almost any character in them and can include
1020Unicode characters. Characters that could be misinterpreted by the DCL
1021shell or file parsing utilities need to be prefixed with the C<^>
1022character, or replaced with hexadecimal characters prefixed with the
1023C<^> character. Such prefixing is only needed with the pathnames are
e1020413 1024in VMS format in applications. Programs that can accept the Unix format
016930a6
JM
1025of pathnames do not need the escape characters. The maximum length for
1026filenames is 255 characters. The ODS-5 file system can handle both
1027a case preserved and a case sensitive mode.
1028
1029ODS-5 is only available on the OpenVMS for 64 bit platforms.
1030
1031Support for the extended file specifications is being done as optional
1032settings to preserve backward compatibility with Perl scripts that
1033assume the previous VMS limitations.
1034
e1020413
TC
1035In general routines on VMS that get a Unix format file specification
1036should return it in a Unix format, and when they get a VMS format
016930a6
JM
1037specification they should return a VMS format unless they are documented
1038to do a conversion.
1039
1040For routines that generate return a file specification, VMS allows setting
1041if the C library which Perl is built on if it will be returned in VMS
e1020413 1042format or in Unix format.
016930a6
JM
1043
1044With the ODS-2 file system, there is not much difference in syntax of
e1020413 1045filenames without paths for VMS or Unix. With the extended character
016930a6
JM
1046set available with ODS-5 there can be a significant difference.
1047
1048Because of this, existing Perl scripts written for VMS were sometimes
e1020413 1049treating VMS and Unix filenames interchangeably. Without the extended
016930a6
JM
1050character set enabled, this behavior will mostly be maintained for
1051backwards compatibility.
1052
1053When extended characters are enabled with ODS-5, the handling of
e1020413 1054Unix formatted file specifications is to that of a Unix system.
016930a6
JM
1055
1056VMS file specifications without extensions have a trailing dot. An
e1020413 1057equivalent Unix file specification should not show the trailing dot.
016930a6
JM
1058
1059The result of all of this, is that for VMS, for portable scripts, you
1060can not depend on Perl to present the filenames in lowercase, to be
1061case sensitive, and that the filenames could be returned in either
e1020413 1062Unix or VMS format.
016930a6
JM
1063
1064And if a routine returns a file specification, unless it is intended to
1065convert it, it should return it in the same format as it found it.
1066
1067C<readdir> by default has traditionally returned lowercased filenames.
1068When the ODS-5 support is enabled, it will return the exact case of the
1069filename on the disk.
1070
1071Files without extensions have a trailing period on them, so doing a
1072C<readdir> in the default mode with a file named F<A.;5> will
1073return F<a.> when VMS is (though that file could be opened with
0a47030a 1074C<open(FH, 'A')>).
e41182b5 1075
016930a6 1076With support for extended file specifications and if C<opendir> was
e1020413 1077given a Unix format directory, a file named F<A.;5> will return F<a>
016930a6
JM
1078and optionally in the exact case on the disk. When C<opendir> is given
1079a VMS format directory, then C<readdir> should return F<a.>, and
1080again with the optionally the exact case.
1081
f34d0673 1082RMS had an eight level limit on directory depths from any rooted logical
1089a9e3
CB
1083(allowing 16 levels overall) prior to VMS 7.2, and even with versions of
1084VMS on VAX up through 7.3. Hence C<PERL_ROOT:[LIB.2.3.4.5.6.7.8]> is a
1085valid directory specification but C<PERL_ROOT:[LIB.2.3.4.5.6.7.8.9]> is
1086not. F<Makefile.PL> authors might have to take this into account, but at
1087least they can refer to the former as C</PERL_ROOT/lib/2/3/4/5/6/7/8/>.
1088
1089Pumpkings and module integrators can easily see whether files with too many
1090directory levels have snuck into the core by running the following in the
1091top-level source directory:
1092
a61fc69c 1093 $ perl -ne "$_=~s/\s+.*//; print if scalar(split /\//) > 8;" < MANIFEST
1089a9e3 1094
e41182b5 1095
6ab3f9cb 1096The VMS::Filespec module, which gets installed as part of the build
0a47030a
GS
1097process on VMS, is a pure Perl module that can easily be installed on
1098non-VMS platforms and can be helpful for conversions to and from RMS
016930a6
JM
1099native formats. It is also now the only way that you should check to
1100see if VMS is in a case sensitive mode.
e41182b5 1101
5e12dbfa
PP
1102What C<\n> represents depends on the type of file opened. It usually
1103represents C<\012> but it could also be C<\015>, C<\012>, C<\015\012>,
fa11829f 1104C<\000>, C<\040>, or nothing depending on the file organization and
5e12dbfa
PP
1105record format. The VMS::Stdio module provides access to the
1106special fopen() requirements of files with unusual attributes on VMS.
e41182b5
GS
1107
1108TCP/IP stacks are optional on VMS, so socket routines might not be
1109implemented. UDP sockets may not be supported.
1110
016930a6
JM
1111The TCP/IP library support for all current versions of VMS is dynamically
1112loaded if present, so even if the routines are configured, they may
1113return a status indicating that they are not implemented.
1114
e41182b5
GS
1115The value of C<$^O> on OpenVMS is "VMS". To determine the architecture
1116that you are running on without resorting to loading all of C<%Config>
1117you can examine the content of the C<@INC> array like so:
1118
1119 if (grep(/VMS_AXP/, @INC)) {
1120 print "I'm on Alpha!\n";
6ab3f9cb 1121
e41182b5
GS
1122 } elsif (grep(/VMS_VAX/, @INC)) {
1123 print "I'm on VAX!\n";
6ab3f9cb 1124
016930a6
JM
1125 } elsif (grep(/VMS_IA64/, @INC)) {
1126 print "I'm on IA64!\n";
1127
e41182b5
GS
1128 } else {
1129 print "I'm not so sure about where $^O is...\n";
1130 }
1131
016930a6
JM
1132In general, the significant differences should only be if Perl is running
1133on VMS_VAX or one of the 64 bit OpenVMS platforms.
1134
b7df3edc
GS
1135On VMS, perl determines the UTC offset from the C<SYS$TIMEZONE_DIFFERENTIAL>
1136logical name. Although the VMS epoch began at 17-NOV-1858 00:00:00.00,
6ab3f9cb 1137calls to C<localtime> are adjusted to count offsets from
b7df3edc 113801-JAN-1970 00:00:00.00, just like Unix.
6ab3f9cb 1139
e41182b5
GS
1140Also see:
1141
1142=over 4
1143
c997b287
GS
1144=item *
1145
96090e4f 1146F<README.vms> (installed as F<README_vms>), L<perlvms>
c997b287
GS
1147
1148=item *
1149
1089a9e3 1150vmsperl list, vmsperl-subscribe@perl.org
e41182b5 1151
c997b287 1152=item *
e41182b5 1153
500f1b69 1154vmsperl on the web, L<http://www.sidhe.org/vmsperl/index.html>
e41182b5
GS
1155
1156=back
1157
495c5fdc
PG
1158=head2 VOS
1159
10fb90aa
PG
1160Perl on VOS (also known as OpenVOS) is discussed in F<README.vos>
1161in the perl distribution (installed as L<perlvos>). Perl on VOS
1162can accept either VOS- or Unix-style file specifications as in
1163either of the following:
495c5fdc 1164
ea8b8ad2
VP
1165 $ perl -ne "print if /perl_setup/i" >system>notices
1166 $ perl -ne "print if /perl_setup/i" /system/notices
495c5fdc
PG
1167
1168or even a mixture of both as in:
1169
ea8b8ad2 1170 $ perl -ne "print if /perl_setup/i" >system/notices
495c5fdc 1171
b7df3edc 1172Even though VOS allows the slash character to appear in object
495c5fdc 1173names, because the VOS port of Perl interprets it as a pathname
10fb90aa
PG
1174delimiting character, VOS files, directories, or links whose
1175names contain a slash character cannot be processed. Such files
1176must be renamed before they can be processed by Perl.
1177
1178Older releases of VOS (prior to OpenVOS Release 17.0) limit file
1179names to 32 or fewer characters, prohibit file names from
1180starting with a C<-> character, and prohibit file names from
1181containing any character matching C<< tr/ !#%&'()*;<=>?// >>.
1182
1183Newer releases of VOS (OpenVOS Release 17.0 or later) support a
1184feature known as extended names. On these releases, file names
1185can contain up to 255 characters, are prohibited from starting
1186with a C<-> character, and the set of prohibited characters is
1187reduced to any character matching C<< tr/#%*<>?// >>. There are
c69ca1d4 1188restrictions involving spaces and apostrophes: these characters
10fb90aa
PG
1189must not begin or end a name, nor can they immediately precede or
1190follow a period. Additionally, a space must not immediately
1191precede another space or hyphen. Specifically, the following
1192character combinations are prohibited: space-space,
1193space-hyphen, period-space, space-period, period-apostrophe,
1194apostrophe-period, leading or trailing space, and leading or
1195trailing apostrophe. Although an extended file name is limited
1196to 255 characters, a path name is still limited to 256
1197characters.
1198
1199The value of C<$^O> on VOS is "VOS". To determine the
1200architecture that you are running on without resorting to loading
1201all of C<%Config> you can examine the content of the @INC array
1202like so:
495c5fdc 1203
24e8e380 1204 if ($^O =~ /VOS/) {
495c5fdc
PG
1205 print "I'm on a Stratus box!\n";
1206 } else {
1207 print "I'm not on a Stratus box!\n";
1208 die;
1209 }
1210
495c5fdc
PG
1211Also see:
1212
1213=over 4
1214
c997b287 1215=item *
495c5fdc 1216
cc07ed0b 1217F<README.vos> (installed as L<perlvos>)
c997b287
GS
1218
1219=item *
1220
1221The VOS mailing list.
495c5fdc
PG
1222
1223There is no specific mailing list for Perl on VOS. You can post
10fb90aa
PG
1224comments to the comp.sys.stratus newsgroup, or use the contact
1225information located in the distribution files on the Stratus
1226Anonymous FTP site.
495c5fdc 1227
c997b287
GS
1228=item *
1229
500f1b69 1230VOS Perl on the web at L<http://ftp.stratus.com/pub/vos/posix/posix.html>
495c5fdc
PG
1231
1232=back
1233
e41182b5
GS
1234=head2 EBCDIC Platforms
1235
1236Recent versions of Perl have been ported to platforms such as OS/400 on
d1e3b762
GS
1237AS/400 minicomputers as well as OS/390, VM/ESA, and BS2000 for S/390
1238Mainframes. Such computers use EBCDIC character sets internally (usually
0cc436d0
GS
1239Character Code Set ID 0037 for OS/400 and either 1047 or POSIX-BC for S/390
1240systems). On the mainframe perl currently works under the "Unix system
1241services for OS/390" (formerly known as OpenEdition), VM/ESA OpenEdition, or
1242the BS200 POSIX-BC system (BS2000 is supported in perl 5.6 and greater).
522b859a
JH
1243See L<perlos390> for details. Note that for OS/400 there is also a port of
1244Perl 5.8.1/5.9.0 or later to the PASE which is ASCII-based (as opposed to
1245ILE which is EBCDIC-based), see L<perlos400>.
e41182b5 1246
7c5ffed3
JH
1247As of R2.5 of USS for OS/390 and Version 2.3 of VM/ESA these Unix
1248sub-systems do not support the C<#!> shebang trick for script invocation.
1249Hence, on OS/390 and VM/ESA perl scripts can be executed with a header
1250similar to the following simple script:
e41182b5
GS
1251
1252 : # use perl
1253 eval 'exec /usr/local/bin/perl -S $0 ${1+"$@"}'
1254 if 0;
1255 #!/usr/local/bin/perl # just a comment really
1256
1257 print "Hello from perl!\n";
1258
d1e3b762
GS
1259OS/390 will support the C<#!> shebang trick in release 2.8 and beyond.
1260Calls to C<system> and backticks can use POSIX shell syntax on all
1261S/390 systems.
1262
b7df3edc 1263On the AS/400, if PERL5 is in your library list, you may need
6ab3f9cb
GS
1264to wrap your perl scripts in a CL procedure to invoke them like so:
1265
1266 BEGIN
1267 CALL PGM(PERL5/PERL) PARM('/QOpenSys/hello.pl')
1268 ENDPGM
1269
1270This will invoke the perl script F<hello.pl> in the root of the
1271QOpenSys file system. On the AS/400 calls to C<system> or backticks
1272must use CL syntax.
1273
e41182b5 1274On these platforms, bear in mind that the EBCDIC character set may have
0a47030a
GS
1275an effect on what happens with some perl functions (such as C<chr>,
1276C<pack>, C<print>, C<printf>, C<ord>, C<sort>, C<sprintf>, C<unpack>), as
1277well as bit-fiddling with ASCII constants using operators like C<^>, C<&>
1278and C<|>, not to mention dealing with socket interfaces to ASCII computers
6ab3f9cb 1279(see L<"Newlines">).
e41182b5 1280
b7df3edc
GS
1281Fortunately, most web servers for the mainframe will correctly
1282translate the C<\n> in the following statement to its ASCII equivalent
1283(C<\r> is the same under both Unix and OS/390 & VM/ESA):
e41182b5
GS
1284
1285 print "Content-type: text/html\r\n\r\n";
1286
d1e3b762 1287The values of C<$^O> on some of these platforms includes:
e41182b5 1288
d1e3b762
GS
1289 uname $^O $Config{'archname'}
1290 --------------------------------------------
1291 OS/390 os390 os390
1292 OS400 os400 os400
1293 POSIX-BC posix-bc BS2000-posix-bc
1294 VM/ESA vmesa vmesa
3c075c7d 1295
e41182b5
GS
1296Some simple tricks for determining if you are running on an EBCDIC
1297platform could include any of the following (perhaps all):
1298
ce7b6f06 1299 if ("\t" eq "\005") { print "EBCDIC may be spoken here!\n"; }
e41182b5
GS
1300
1301 if (ord('A') == 193) { print "EBCDIC may be spoken here!\n"; }
1302
1303 if (chr(169) eq 'z') { print "EBCDIC may be spoken here!\n"; }
1304
b7df3edc 1305One thing you may not want to rely on is the EBCDIC encoding
0a47030a
GS
1306of punctuation characters since these may differ from code page to code
1307page (and once your module or script is rumoured to work with EBCDIC,
1308folks will want it to work with all EBCDIC character sets).
e41182b5
GS
1309
1310Also see:
1311
1312=over 4
1313
c997b287
GS
1314=item *
1315
dc5c060f 1316L<perlos390>, F<README.os390>, F<perlbs2000>, F<README.vmesa>,
bb462878 1317L<perlebcdic>.
c997b287
GS
1318
1319=item *
e41182b5
GS
1320
1321The perl-mvs@perl.org list is for discussion of porting issues as well as
1322general usage issues for all EBCDIC Perls. Send a message body of
1323"subscribe perl-mvs" to majordomo@perl.org.
1324
7ee27b7c 1325=item *
c997b287
GS
1326
1327AS/400 Perl information at
500f1b69 1328L<http://as400.rochester.ibm.com/>
d1e3b762 1329as well as on CPAN in the F<ports/> directory.
e41182b5
GS
1330
1331=back
1332
b8099c3d
CN
1333=head2 Acorn RISC OS
1334
b7df3edc
GS
1335Because Acorns use ASCII with newlines (C<\n>) in text files as C<\012> like
1336Unix, and because Unix filename emulation is turned on by default,
1337most simple scripts will probably work "out of the box". The native
6ab3f9cb 1338filesystem is modular, and individual filesystems are free to be
0a47030a 1339case-sensitive or insensitive, and are usually case-preserving. Some
b7df3edc 1340native filesystems have name length limits, which file and directory
6ab3f9cb
GS
1341names are silently truncated to fit. Scripts should be aware that the
1342standard filesystem currently has a name length limit of B<10>
1343characters, with up to 77 items in a directory, but other filesystems
0a47030a 1344may not impose such limitations.
b8099c3d
CN
1345
1346Native filenames are of the form
1347
6ab3f9cb 1348 Filesystem#Special_Field::DiskName.$.Directory.Directory.File
dd9f0070 1349
b8099c3d
CN
1350where
1351
1352 Special_Field is not usually present, but may contain . and $ .
1353 Filesystem =~ m|[A-Za-z0-9_]|
1354 DsicName =~ m|[A-Za-z0-9_/]|
1355 $ represents the root directory
1356 . is the path separator
1357 @ is the current directory (per filesystem but machine global)
1358 ^ is the parent directory
1359 Directory and File =~ m|[^\0- "\.\$\%\&:\@\\^\|\177]+|
1360
1361The default filename translation is roughly C<tr|/.|./|;>
1362
6ab3f9cb 1363Note that C<"ADFS::HardDisk.$.File" ne 'ADFS::HardDisk.$.File'> and that
0a47030a
GS
1364the second stage of C<$> interpolation in regular expressions will fall
1365foul of the C<$.> if scripts are not careful.
1366
1367Logical paths specified by system variables containing comma-separated
b7df3edc 1368search lists are also allowed; hence C<System:Modules> is a valid
0a47030a 1369filename, and the filesystem will prefix C<Modules> with each section of
6ab3f9cb 1370C<System$Path> until a name is made that points to an object on disk.
b7df3edc 1371Writing to a new file C<System:Modules> would be allowed only if
0a47030a
GS
1372C<System$Path> contains a single item list. The filesystem will also
1373expand system variables in filenames if enclosed in angle brackets, so
c47ff5f1 1374C<< <System$Dir>.Modules >> would look for the file
0a47030a 1375S<C<$ENV{'System$Dir'} . 'Modules'>>. The obvious implication of this is
c47ff5f1 1376that B<fully qualified filenames can start with C<< <> >>> and should
0a47030a 1377be protected when C<open> is used for input.
b8099c3d
CN
1378
1379Because C<.> was in use as a directory separator and filenames could not
1380be assumed to be unique after 10 characters, Acorn implemented the C
1381compiler to strip the trailing C<.c> C<.h> C<.s> and C<.o> suffix from
1382filenames specified in source code and store the respective files in
b7df3edc 1383subdirectories named after the suffix. Hence files are translated:
b8099c3d
CN
1384
1385 foo.h h.foo
1386 C:foo.h C:h.foo (logical path variable)
1387 sys/os.h sys.h.os (C compiler groks Unix-speak)
1388 10charname.c c.10charname
1389 10charname.o o.10charname
1390 11charname_.c c.11charname (assuming filesystem truncates at 10)
1391
1392The Unix emulation library's translation of filenames to native assumes
b7df3edc
GS
1393that this sort of translation is required, and it allows a user-defined list
1394of known suffixes that it will transpose in this fashion. This may
92863ac5
KW
1395seem transparent, but consider that with these rules F<foo/bar/baz.h>
1396and F<foo/bar/h/baz> both map to F<foo.bar.h.baz>, and that C<readdir> and
0a47030a 1397C<glob> cannot and do not attempt to emulate the reverse mapping. Other
6ab3f9cb 1398C<.>'s in filenames are translated to C</>.
0a47030a 1399
b7df3edc 1400As implied above, the environment accessed through C<%ENV> is global, and
0a47030a 1401the convention is that program specific environment variables are of the
6ab3f9cb
GS
1402form C<Program$Name>. Each filesystem maintains a current directory,
1403and the current filesystem's current directory is the B<global> current
b7df3edc
GS
1404directory. Consequently, sociable programs don't change the current
1405directory but rely on full pathnames, and programs (and Makefiles) cannot
0a47030a
GS
1406assume that they can spawn a child process which can change the current
1407directory without affecting its parent (and everyone else for that
1408matter).
1409
b7df3edc
GS
1410Because native operating system filehandles are global and are currently
1411allocated down from 255, with 0 being a reserved value, the Unix emulation
0a47030a
GS
1412library emulates Unix filehandles. Consequently, you can't rely on
1413passing C<STDIN>, C<STDOUT>, or C<STDERR> to your children.
1414
1415The desire of users to express filenames of the form
c47ff5f1 1416C<< <Foo$Dir>.Bar >> on the command line unquoted causes problems,
0a47030a 1417too: C<``> command output capture has to perform a guessing game. It
c47ff5f1 1418assumes that a string C<< <[^<>]+\$[^<>]> >> is a
0a47030a 1419reference to an environment variable, whereas anything else involving
c47ff5f1 1420C<< < >> or C<< > >> is redirection, and generally manages to be 99%
0a47030a
GS
1421right. Of course, the problem remains that scripts cannot rely on any
1422Unix tools being available, or that any tools found have Unix-like command
1423line arguments.
1424
b7df3edc
GS
1425Extensions and XS are, in theory, buildable by anyone using free
1426tools. In practice, many don't, as users of the Acorn platform are
1427used to binary distributions. MakeMaker does run, but no available
1428make currently copes with MakeMaker's makefiles; even if and when
1429this should be fixed, the lack of a Unix-like shell will cause
1430problems with makefile rules, especially lines of the form C<cd
1431sdbm && make all>, and anything using quoting.
b8099c3d
CN
1432
1433"S<RISC OS>" is the proper name for the operating system, but the value
1434in C<$^O> is "riscos" (because we don't like shouting).
1435
e41182b5
GS
1436=head2 Other perls
1437
b7df3edc 1438Perl has been ported to many platforms that do not fit into any of
cd86ed9d
JV
1439the categories listed above. Some, such as AmigaOS, BeOS, HP MPE/iX,
1440QNX, Plan 9, and VOS, have been well-integrated into the standard
1441Perl source code kit. You may need to see the F<ports/> directory
1442on CPAN for information, and possibly binaries, for the likes of:
1443aos, Atari ST, lynxos, riscos, Novell Netware, Tandem Guardian,
1444I<etc.> (Yes, we know that some of these OSes may fall under the
1445Unix category, but we are not a standards body.)
e41182b5 1446
d1e3b762
GS
1447Some approximate operating system names and their C<$^O> values
1448in the "OTHER" category include:
1449
1450 OS $^O $Config{'archname'}
1451 ------------------------------------------
1452 Amiga DOS amigaos m68k-amigos
cec2c193 1453 BeOS beos
d1e3b762
GS
1454 MPE/iX mpeix PA-RISC1.1
1455
e41182b5
GS
1456See also:
1457
1458=over 4
1459
c997b287
GS
1460=item *
1461
1462Amiga, F<README.amiga> (installed as L<perlamiga>).
1463
1464=item *
d1e3b762 1465
c997b287 1466Be OS, F<README.beos>
e41182b5 1467
c997b287
GS
1468=item *
1469
1470HP 300 MPE/iX, F<README.mpeix> and Mark Bixby's web page
500f1b69 1471L<http://www.bixby.org/mark/porting.html>
c997b287
GS
1472
1473=item *
e41182b5 1474
6ab3f9cb 1475A free perl5-based PERL.NLM for Novell Netware is available in
500f1b69 1476precompiled binary and source code form from L<http://www.novell.com/>
6ab3f9cb 1477as well as from CPAN.
e41182b5 1478
13a2d996 1479=item *
c997b287 1480
e6f03d26 1481S<Plan 9>, F<README.plan9>
d1e3b762 1482
e41182b5
GS
1483=back
1484
e41182b5
GS
1485=head1 FUNCTION IMPLEMENTATIONS
1486
b7df3edc
GS
1487Listed below are functions that are either completely unimplemented
1488or else have been implemented differently on various platforms.
1489Following each description will be, in parentheses, a list of
1490platforms that the description applies to.
e41182b5 1491
b7df3edc
GS
1492The list may well be incomplete, or even wrong in some places. When
1493in doubt, consult the platform-specific README files in the Perl
1494source distribution, and any other documentation resources accompanying
1495a given port.
e41182b5 1496
0a47030a 1497Be aware, moreover, that even among Unix-ish systems there are variations.
e41182b5 1498
b7df3edc
GS
1499For many functions, you can also query C<%Config>, exported by
1500default from the Config module. For example, to check whether the
1501platform has the C<lstat> call, check C<$Config{d_lstat}>. See
1502L<Config> for a full description of available variables.
e41182b5
GS
1503
1504=head2 Alphabetical Listing of Perl Functions
1505
1506=over 8
1507
e41182b5
GS
1508=item -X
1509
038ae9a4
SH
1510C<-w> only inspects the read-only file attribute (FILE_ATTRIBUTE_READONLY),
1511which determines whether the directory can be deleted, not whether it can
1512be written to. Directories always have read and write access unless denied
1513by discretionary access control lists (DACLs). (S<Win32>)
1514
b7df3edc
GS
1515C<-r>, C<-w>, C<-x>, and C<-o> tell whether the file is accessible,
1516which may not reflect UIC-based file protections. (VMS)
e41182b5 1517
b8099c3d
CN
1518C<-s> by name on an open file will return the space reserved on disk,
1519rather than the current extent. C<-s> on an open filehandle returns the
b7df3edc 1520current size. (S<RISC OS>)
b8099c3d 1521
e41182b5 1522C<-R>, C<-W>, C<-X>, C<-O> are indistinguishable from C<-r>, C<-w>,
204ad8d5 1523C<-x>, C<-o>. (Win32, VMS, S<RISC OS>)
e41182b5 1524
287a962e 1525C<-g>, C<-k>, C<-l>, C<-u>, C<-A> are not particularly meaningful.
b8099c3d 1526(Win32, VMS, S<RISC OS>)
e41182b5 1527
287a962e
JD
1528C<-p> is not particularly meaningful. (VMS, S<RISC OS>)
1529
e41182b5
GS
1530C<-d> is true if passed a device spec without an explicit directory.
1531(VMS)
1532
e41182b5 1533C<-x> (or C<-X>) determine if a file ends in one of the executable
b7df3edc 1534suffixes. C<-S> is meaningless. (Win32)
e41182b5 1535
b8099c3d
CN
1536C<-x> (or C<-X>) determine if a file has an executable file type.
1537(S<RISC OS>)
1538
aca72608
JD
1539=item alarm
1540
1541Emulated using timers that must be explicitly polled whenever Perl
1542wants to dispatch "safe signals" and therefore cannot interrupt
1543blocking system calls. (Win32)
1544
47cd99a4 1545=item atan2
519bc777
RGS
1546
1547Due to issues with various CPUs, math libraries, compilers, and standards,
1548results for C<atan2()> may vary depending on any combination of the above.
1549Perl attempts to conform to the Open Group/IEEE standards for the results
1550returned from C<atan2()>, but cannot force the issue if the system Perl is
1551run on does not allow it. (Tru64, HP-UX 10.20)
1552
1553The current version of the standards for C<atan2()> is available at
1554L<http://www.opengroup.org/onlinepubs/009695399/functions/atan2.html>.
1555
47cd99a4 1556=item binmode
e41182b5 1557
204ad8d5 1558Meaningless. (S<RISC OS>)
e41182b5
GS
1559
1560Reopens file and restores pointer; if function fails, underlying
1561filehandle may be closed, or pointer may be in a different position.
1562(VMS)
1563
1564The value returned by C<tell> may be affected after the call, and
1565the filehandle may be flushed. (Win32)
1566
47cd99a4 1567=item chmod
e41182b5 1568
e41182b5
GS
1569Only good for changing "owner" read-write access, "group", and "other"
1570bits are meaningless. (Win32)
1571
b8099c3d
CN
1572Only good for changing "owner" and "other" read-write access. (S<RISC OS>)
1573
495c5fdc
PG
1574Access permissions are mapped onto VOS access-control list changes. (VOS)
1575
4e51f8e4 1576The actual permissions set depend on the value of the C<CYGWIN>
789f0d36 1577in the SYSTEM environment settings. (Cygwin)
4e51f8e4 1578
47cd99a4 1579=item chown
e41182b5 1580
204ad8d5 1581Not implemented. (Win32, S<Plan 9>, S<RISC OS>)
e41182b5
GS
1582
1583Does nothing, but won't fail. (Win32)
1584
3fd80bd6
PG
1585A little funky, because VOS's notion of ownership is a little funky (VOS).
1586
e41182b5
GS
1587=item chroot
1588
204ad8d5 1589Not implemented. (Win32, VMS, S<Plan 9>, S<RISC OS>, VOS, VM/ESA)
e41182b5 1590
47cd99a4 1591=item crypt
e41182b5
GS
1592
1593May not be available if library or source was not provided when building
b8099c3d 1594perl. (Win32)
e41182b5 1595
47cd99a4 1596=item dbmclose
e41182b5 1597
e6f03d26 1598Not implemented. (VMS, S<Plan 9>, VOS)
e41182b5 1599
47cd99a4 1600=item dbmopen
e41182b5 1601
e6f03d26 1602Not implemented. (VMS, S<Plan 9>, VOS)
e41182b5 1603
47cd99a4 1604=item dump
e41182b5 1605
204ad8d5 1606Not useful. (S<RISC OS>)
e41182b5 1607
84d78eb7 1608Not supported. (Cygwin, Win32)
e41182b5 1609
b8099c3d 1610Invokes VMS debugger. (VMS)
e41182b5 1611
47cd99a4 1612=item exec
e41182b5 1613
7c5ffed3 1614Implemented via Spawn. (VM/ESA)
3c075c7d 1615
0f897271
GS
1616Does not automatically flush output handles on some platforms.
1617(SunOS, Solaris, HP-UX)
1618
af8bb25a
FC
1619Not supported. (Symbian OS)
1620
fe12c0e8
MS
1621=item exit
1622
e1020413 1623Emulates Unix exit() (which considers C<exit 1> to indicate an error) by
fe12c0e8
MS
1624mapping the C<1> to SS$_ABORT (C<44>). This behavior may be overridden
1625with the pragma C<use vmsish 'exit'>. As with the CRTL's exit()
1626function, C<exit 0> is also mapped to an exit status of SS$_NORMAL
1627(C<1>); this mapping cannot be overridden. Any other argument to exit()
016930a6
JM
1628is used directly as Perl's exit status. On VMS, unless the future
1629POSIX_EXIT mode is enabled, the exit code should always be a valid
1630VMS exit code and not a generic number. When the POSIX_EXIT mode is
1631enabled, a generic number will be encoded in a method compatible with
1632the C library _POSIX_EXIT macro so that it can be decoded by other
1633programs, particularly ones written in C, like the GNV package. (VMS)
fe12c0e8 1634
bef2c191
RB
1635C<exit()> resets file pointers, which is a problem when called
1636from a child process (created by C<fork()>) in C<BEGIN>.
1637A workaround is to use C<POSIX::_exit>. (Solaris)
1638
1639 exit unless $Config{archname} =~ /\bsolaris\b/;
1640 require POSIX and POSIX::_exit(0);
1641
47cd99a4 1642=item fcntl
e41182b5 1643
016930a6 1644Not implemented. (Win32)
6a065175 1645
016930a6 1646Some functions available based on the version of VMS. (VMS)
e41182b5 1647
47cd99a4 1648=item flock
e41182b5 1649
204ad8d5 1650Not implemented (VMS, S<RISC OS>, VOS).
e41182b5 1651
e41182b5
GS
1652=item fork
1653
204ad8d5 1654Not implemented. (AmigaOS, S<RISC OS>, VM/ESA, VMS)
0f897271
GS
1655
1656Emulated using multiple interpreters. See L<perlfork>. (Win32)
1657
1658Does not automatically flush output handles on some platforms.
1659(SunOS, Solaris, HP-UX)
e41182b5
GS
1660
1661=item getlogin
1662
204ad8d5 1663Not implemented. (S<RISC OS>)
e41182b5 1664
47cd99a4 1665=item getpgrp
e41182b5 1666
204ad8d5 1667Not implemented. (Win32, VMS, S<RISC OS>)
e41182b5
GS
1668
1669=item getppid
1670
204ad8d5 1671Not implemented. (Win32, S<RISC OS>)
e41182b5 1672
47cd99a4 1673=item getpriority
e41182b5 1674
204ad8d5 1675Not implemented. (Win32, VMS, S<RISC OS>, VOS, VM/ESA)
e41182b5 1676
47cd99a4 1677=item getpwnam
e41182b5 1678
204ad8d5 1679Not implemented. (Win32)
e41182b5 1680
b8099c3d
CN
1681Not useful. (S<RISC OS>)
1682
47cd99a4 1683=item getgrnam
e41182b5 1684
204ad8d5 1685Not implemented. (Win32, VMS, S<RISC OS>)
e41182b5 1686
47cd99a4 1687=item getnetbyname
e41182b5 1688
204ad8d5 1689Not implemented. (Win32, S<Plan 9>)
e41182b5 1690
47cd99a4 1691=item getpwuid
e41182b5 1692
204ad8d5 1693Not implemented. (Win32)
e41182b5 1694
b8099c3d
CN
1695Not useful. (S<RISC OS>)
1696
47cd99a4 1697=item getgrgid
e41182b5 1698
204ad8d5 1699Not implemented. (Win32, VMS, S<RISC OS>)
e41182b5 1700
47cd99a4 1701=item getnetbyaddr
e41182b5 1702
204ad8d5 1703Not implemented. (Win32, S<Plan 9>)
e41182b5 1704
47cd99a4 1705=item getprotobynumber
e41182b5 1706
47cd99a4 1707=item getservbyport
e41182b5 1708
e41182b5
GS
1709=item getpwent
1710
204ad8d5 1711Not implemented. (Win32, VM/ESA)
e41182b5
GS
1712
1713=item getgrent
1714
204ad8d5 1715Not implemented. (Win32, VMS, VM/ESA)
e41182b5 1716
ef5a6dd7
JH
1717=item gethostbyname
1718
1719C<gethostbyname('localhost')> does not work everywhere: you may have
204ad8d5 1720to use C<gethostbyname('127.0.0.1')>. (S<Irix 5>)
ef5a6dd7 1721
e41182b5
GS
1722=item gethostent
1723
204ad8d5 1724Not implemented. (Win32)
e41182b5
GS
1725
1726=item getnetent
1727
204ad8d5 1728Not implemented. (Win32, S<Plan 9>)
e41182b5
GS
1729
1730=item getprotoent
1731
204ad8d5 1732Not implemented. (Win32, S<Plan 9>)
e41182b5
GS
1733
1734=item getservent
1735
e6f03d26 1736Not implemented. (Win32, S<Plan 9>)
e41182b5 1737
47cd99a4 1738=item sethostent
e41182b5 1739
204ad8d5 1740Not implemented. (Win32, S<Plan 9>, S<RISC OS>)
e41182b5 1741
47cd99a4 1742=item setnetent
e41182b5 1743
204ad8d5 1744Not implemented. (Win32, S<Plan 9>, S<RISC OS>)
e41182b5 1745
47cd99a4 1746=item setprotoent
e41182b5 1747
204ad8d5 1748Not implemented. (Win32, S<Plan 9>, S<RISC OS>)
e41182b5 1749
47cd99a4 1750=item setservent
e41182b5 1751
e6f03d26 1752Not implemented. (S<Plan 9>, Win32, S<RISC OS>)
e41182b5
GS
1753
1754=item endpwent
1755
204ad8d5 1756Not implemented. (MPE/iX, VM/ESA, Win32)
e41182b5
GS
1757
1758=item endgrent
1759
204ad8d5 1760Not implemented. (MPE/iX, S<RISC OS>, VM/ESA, VMS, Win32)
e41182b5
GS
1761
1762=item endhostent
1763
204ad8d5 1764Not implemented. (Win32)
e41182b5
GS
1765
1766=item endnetent
1767
204ad8d5 1768Not implemented. (Win32, S<Plan 9>)
e41182b5
GS
1769
1770=item endprotoent
1771
204ad8d5 1772Not implemented. (Win32, S<Plan 9>)
e41182b5
GS
1773
1774=item endservent
1775
e6f03d26 1776Not implemented. (S<Plan 9>, Win32)
e41182b5
GS
1777
1778=item getsockopt SOCKET,LEVEL,OPTNAME
1779
e6f03d26 1780Not implemented. (S<Plan 9>)
e41182b5 1781
e41182b5
GS
1782=item glob
1783
63f87e49
GS
1784This operator is implemented via the File::Glob extension on most
1785platforms. See L<File::Glob> for portability information.
b8099c3d 1786
62aa5637
MS
1787=item gmtime
1788
461d5a49
MS
1789In theory, gmtime() is reliable from -2**63 to 2**63-1. However,
1790because work arounds in the implementation use floating point numbers,
1791it will become inaccurate as the time gets larger. This is a bug and
1792will be fixed in the future.
62aa5637 1793
10fb90aa
PG
1794On VOS, time values are 32-bit quantities.
1795
e41182b5
GS
1796=item ioctl FILEHANDLE,FUNCTION,SCALAR
1797
1798Not implemented. (VMS)
1799
1800Available only for socket handles, and it does what the ioctlsocket() call
1801in the Winsock API does. (Win32)
1802
b8099c3d
CN
1803Available only for socket handles. (S<RISC OS>)
1804
47cd99a4 1805=item kill
e41182b5 1806
862b5365 1807Not implemented, hence not useful for taint checking. (S<RISC OS>)
e41182b5 1808
63f87e49
GS
1809C<kill()> doesn't have the semantics of C<raise()>, i.e. it doesn't send
1810a signal to the identified process like it does on Unix platforms.
1811Instead C<kill($sig, $pid)> terminates the process identified by $pid,
1812and makes it exit immediately with exit status $sig. As in Unix, if
1813$sig is 0 and the specified process exists, it returns true without
1814actually terminating it. (Win32)
e41182b5 1815
d0302514
JD
1816C<kill(-9, $pid)> will terminate the process specified by $pid and
1817recursively all child processes owned by it. This is different from
1818the Unix semantics, where the signal will be delivered to all
1819processes in the same process group as the process specified by
1820$pid. (Win32)
1821
016930a6
JM
1822Is not supported for process identification number of 0 or negative
1823numbers. (VMS)
1824
47cd99a4 1825=item link
e41182b5 1826
10fb90aa 1827Not implemented. (MPE/iX, S<RISC OS>, VOS)
e41182b5 1828
433acd8a
JH
1829Link count not updated because hard links are not quite that hard
1830(They are sort of half-way between hard and soft links). (AmigaOS)
1831
63d6c08b
JD
1832Hard links are implemented on Win32 under NTFS only. They are
1833natively supported on Windows 2000 and later. On Windows NT they
1834are implemented using the Windows POSIX subsystem support and the
1835Perl process will need Administrator or Backup Operator privileges
1836to create hard links.
a3dfe201 1837
016930a6
JM
1838Available on 64 bit OpenVMS 8.2 and later. (VMS)
1839
62aa5637
MS
1840=item localtime
1841
a61fc69c 1842localtime() has the same range as L</gmtime>, but because time zone
dc164757
MS
1843rules change its accuracy for historical and future times may degrade
1844but usually by no more than an hour.
62aa5637 1845
e41182b5
GS
1846=item lstat
1847
016930a6 1848Not implemented. (S<RISC OS>)
e41182b5 1849
63f87e49 1850Return values (especially for device and inode) may be bogus. (Win32)
e41182b5 1851
47cd99a4 1852=item msgctl
e41182b5 1853
47cd99a4 1854=item msgget
e41182b5 1855
47cd99a4 1856=item msgsnd
e41182b5 1857
47cd99a4 1858=item msgrcv
e41182b5 1859
204ad8d5 1860Not implemented. (Win32, VMS, S<Plan 9>, S<RISC OS>, VOS)
e41182b5 1861
47cd99a4 1862=item open
e41182b5 1863
204ad8d5 1864open to C<|-> and C<-|> are unsupported. (Win32, S<RISC OS>)
e41182b5 1865
0f897271
GS
1866Opening a process does not automatically flush output handles on some
1867platforms. (SunOS, Solaris, HP-UX)
1868
e41182b5
GS
1869=item readlink
1870
b8099c3d 1871Not implemented. (Win32, VMS, S<RISC OS>)
e41182b5 1872
47cd99a4 1873=item rename
c9b2b9d4
SS
1874
1875Can't move directories between directories on different logical volumes. (Win32)
1876
3ba4b5c1
JD
1877=item rewinddir
1878
1879Will not cause readdir() to re-read the directory stream. The entries
1880already read before the rewinddir() call will just be returned again
1881from a cache buffer. (Win32)
1882
47cd99a4 1883=item select
e41182b5 1884
689c5c24 1885Only implemented on sockets. (Win32, VMS)
e41182b5 1886
b8099c3d
CN
1887Only reliable on sockets. (S<RISC OS>)
1888
76e05f0b 1889Note that the C<select FILEHANDLE> form is generally portable.
63f87e49 1890
47cd99a4 1891=item semctl
e41182b5 1892
47cd99a4 1893=item semget
e41182b5 1894
47cd99a4 1895=item semop
e41182b5 1896
10fb90aa 1897Not implemented. (Win32, VMS, S<RISC OS>)
e41182b5 1898
a3dfe201
GS
1899=item setgrent
1900
10fb90aa 1901Not implemented. (MPE/iX, VMS, Win32, S<RISC OS>)
a3dfe201 1902
47cd99a4 1903=item setpgrp
e41182b5 1904
204ad8d5 1905Not implemented. (Win32, VMS, S<RISC OS>, VOS)
e41182b5 1906
47cd99a4 1907=item setpriority
e41182b5 1908
204ad8d5 1909Not implemented. (Win32, VMS, S<RISC OS>, VOS)
e41182b5 1910
a3dfe201
GS
1911=item setpwent
1912
10fb90aa 1913Not implemented. (MPE/iX, Win32, S<RISC OS>)
a3dfe201 1914
47cd99a4 1915=item setsockopt
e41182b5 1916
e6f03d26 1917Not implemented. (S<Plan 9>)
e41182b5 1918
47cd99a4 1919=item shmctl
e41182b5 1920
47cd99a4 1921=item shmget
e41182b5 1922
47cd99a4 1923=item shmread
e41182b5 1924
47cd99a4 1925=item shmwrite
e41182b5 1926
204ad8d5 1927Not implemented. (Win32, VMS, S<RISC OS>, VOS)
e41182b5 1928
47cd99a4 1929=item sockatmark
80cbd5ad
JH
1930
1931A relatively recent addition to socket functions, may not
e1020413 1932be implemented even in Unix platforms.
80cbd5ad 1933
47cd99a4 1934=item socketpair
e41182b5 1935
10fb90aa
PG
1936Not implemented. (S<RISC OS>, VM/ESA)
1937
1938Available on OpenVOS Release 17.0 or later. (VOS)
016930a6
JM
1939
1940Available on 64 bit OpenVMS 8.2 and later. (VMS)
e41182b5 1941
e41182b5
GS
1942=item stat
1943
d62e1b7f
JH
1944Platforms that do not have rdev, blksize, or blocks will return these
1945as '', so numeric comparison or manipulation of these fields may cause
1946'not numeric' warnings.
1947
3f1f789b 1948ctime not supported on UFS (S<Mac OS X>).
e41182b5 1949
95a3fe12
MS
1950ctime is creation time instead of inode change time (Win32).
1951
e41182b5
GS
1952device and inode are not meaningful. (Win32)
1953
1954device and inode are not necessarily reliable. (VMS)
1955
b8099c3d
CN
1956mtime, atime and ctime all return the last modification time. Device and
1957inode are not necessarily reliable. (S<RISC OS>)
1958
d62e1b7f
JH
1959dev, rdev, blksize, and blocks are not available. inode is not
1960meaningful and will differ between stat calls on the same file. (os2)
1961
73e9292c
JH
1962some versions of cygwin when doing a stat("foo") and if not finding it
1963may then attempt to stat("foo.exe") (Cygwin)
1964
1fafdf34
JD
1965On Win32 stat() needs to open the file to determine the link count
1966and update attributes that may have been changed through hard links.
1967Setting ${^WIN32_SLOPPY_STAT} to a true value speeds up stat() by
1968not performing this operation. (Win32)
1969
47cd99a4 1970=item symlink
e41182b5 1971
c73b03b7
JM
1972Not implemented. (Win32, S<RISC OS>)
1973
1974Implemented on 64 bit VMS 8.3. VMS requires the symbolic link to be in Unix
1975syntax if it is intended to resolve to a valid path.
e41182b5 1976
47cd99a4 1977=item syscall
e41182b5 1978
204ad8d5 1979Not implemented. (Win32, VMS, S<RISC OS>, VOS, VM/ESA)
e41182b5 1980
47cd99a4 1981=item sysopen
f34d0673 1982
dd9f0070 1983The traditional "0", "1", and "2" MODEs are implemented with different
322422de
GS
1984numeric values on some systems. The flags exported by C<Fcntl>
1985(O_RDONLY, O_WRONLY, O_RDWR) should work everywhere though. (S<Mac
7c5ffed3 1986OS>, OS/390, VM/ESA)
f34d0673 1987
47cd99a4 1988=item system
e41182b5 1989
e41182b5 1990As an optimization, may not call the command shell specified in
b7df3edc 1991C<$ENV{PERL5SHELL}>. C<system(1, @args)> spawns an external
e41182b5
GS
1992process and immediately returns its process designator, without
1993waiting for it to terminate. Return value may be used subsequently
63f87e49
GS
1994in C<wait> or C<waitpid>. Failure to spawn() a subprocess is indicated
1995by setting $? to "255 << 8". C<$?> is set in a way compatible with
1996Unix (i.e. the exitstatus of the subprocess is obtained by "$? >> 8",
1997as described in the documentation). (Win32)
e41182b5 1998
b8099c3d
CN
1999There is no shell to process metacharacters, and the native standard is
2000to pass a command line terminated by "\n" "\r" or "\0" to the spawned
c47ff5f1 2001program. Redirection such as C<< > foo >> is performed (if at all) by
b8099c3d
CN
2002the run time library of the spawned program. C<system> I<list> will call
2003the Unix emulation library's C<exec> emulation, which attempts to provide
2004emulation of the stdin, stdout, stderr in force in the parent, providing
2005the child program uses a compatible version of the emulation library.
2006I<scalar> will call the native command line direct and no such emulation
2007of a child Unix program will exists. Mileage B<will> vary. (S<RISC OS>)
2008
0f897271
GS
2009Does not automatically flush output handles on some platforms.
2010(SunOS, Solaris, HP-UX)
2011
9bc98430
CB
2012The return value is POSIX-like (shifted up by 8 bits), which only allows
2013room for a made-up value derived from the severity bits of the native
201432-bit condition code (unless overridden by C<use vmsish 'status'>).
016930a6
JM
2015If the native condition code is one that has a POSIX value encoded, the
2016POSIX value will be decoded to extract the expected exit value.
9bc98430
CB
2017For more details see L<perlvms/$?>. (VMS)
2018
e41182b5
GS
2019=item times
2020
63f87e49
GS
2021"cumulative" times will be bogus. On anything other than Windows NT
2022or Windows 2000, "system" time will be bogus, and "user" time is
2023actually the time returned by the clock() function in the C runtime
2024library. (Win32)
e41182b5 2025
b8099c3d
CN
2026Not useful. (S<RISC OS>)
2027
47cd99a4 2028=item truncate
e41182b5 2029
6d738113 2030Not implemented. (Older versions of VMS)
e41182b5 2031
3fd80bd6 2032Truncation to same-or-shorter lengths only. (VOS)
495c5fdc 2033
4cfdb94f 2034If a FILEHANDLE is supplied, it must be writable and opened in append
e71a7dc8 2035mode (i.e., use C<<< open(FH, '>>filename') >>>
4cfdb94f
GS
2036or C<sysopen(FH,...,O_APPEND|O_RDWR)>. If a filename is supplied, it
2037should not be held open elsewhere. (Win32)
2038
e41182b5
GS
2039=item umask
2040
2041Returns undef where unavailable, as of version 5.005.
2042
b7df3edc
GS
2043C<umask> works but the correct permissions are set only when the file
2044is finally closed. (AmigaOS)
433acd8a 2045
47cd99a4 2046=item utime
e41182b5 2047
204ad8d5 2048Only the modification time is updated. (S<BeOS>, VMS, S<RISC OS>)
e41182b5 2049
322422de
GS
2050May not behave as expected. Behavior depends on the C runtime
2051library's implementation of utime(), and the filesystem being
2052used. The FAT filesystem typically does not support an "access
2053time" field, and it may limit timestamps to a granularity of
2054two seconds. (Win32)
e41182b5
GS
2055
2056=item wait
2057
47cd99a4 2058=item waitpid
e41182b5 2059
e41182b5 2060Can only be applied to process handles returned for processes spawned
a6f858fb 2061using C<system(1, ...)> or pseudo processes created with C<fork()>. (Win32)
e41182b5 2062
b8099c3d
CN
2063Not useful. (S<RISC OS>)
2064
e41182b5
GS
2065=back
2066
2067
7c35b6af 2068=head1 Supported Platforms
ba58ab26 2069
7c35b6af
RGS
2070The following platforms are known to build Perl 5.12 (as of April 2010,
2071its release date) from the standard source code distribution available
500f1b69 2072at L<http://www.cpan.org/src>
bb377ba2 2073
bb377ba2
JV
2074=over
2075
2076=item Linux (x86, ARM, IA64)
2077
e0d9a2c8 2078=item HP-UX
bb377ba2
JV
2079
2080=item AIX
2081
2082=item Win32
2083
2084=over
2085
2086=item Windows 2000
2087
2088=item Windows XP
2089
2090=item Windows Server 2003
2091
2092=item Windows Vista
2093
2094=item Windows Server 2008
2095
3b665c47
JD
2096=item Windows 7
2097
bb377ba2
JV
2098=back
2099
2d9ede6e
JH
2100=item Cygwin
2101
bb377ba2
JV
2102=item Solaris (x86, SPARC)
2103
1b0ab010
JV
2104=item OpenVMS
2105
2106=over
2107
2108=item Alpha (7.2 and later)
2109
2110=item I64 (8.2 and later)
2111
2112=back
bb377ba2
JV
2113
2114=item Symbian
2115
2116=item NetBSD
2117
2118=item FreeBSD
2119
2d8e9a35
CBW
2120=item Debian GNU/kFreeBSD
2121
bb377ba2
JV
2122=item Haiku
2123
2124=item Irix (6.5. What else?)
2125
2126=item OpenBSD
2127
2128=item Dragonfly BSD
2129
a62bfce3
CBW
2130=item QNX Neutrino RTOS (6.5.0)
2131
bb377ba2
JV
2132=item MirOS BSD
2133
2134Caveats:
2135
2136=over
2137
2138=item time_t issues that may or may not be fixed
2139
2140=back
2141
bb377ba2
JV
2142=item Symbian (Series 60 v3, 3.2 and 5 - what else?)
2143
10fb90aa 2144=item Stratus VOS / OpenVOS
bb377ba2
JV
2145
2146=item AIX
2147
2148=back
2149
8cbe99e5 2150=head1 EOL Platforms (Perl 5.14)
bb377ba2
JV
2151
2152The following platforms were supported by a previous version of
2153Perl but have been officially removed from Perl's source code
2154as of 5.12:
2155
2156=over
2157
2158=item Atari MiNT
2159
2160=item Apollo Domain/OS
2161
2162=item Apple Mac OS 8/9
2163
2164=item Tenon Machten
2165
2166=back
2167
8cbe99e5
JD
2168The following platforms were supported up to 5.10. They may still
2169have worked in 5.12, but supporting code has been removed for 5.14:
bb377ba2
JV
2170
2171=over
2172
2173=item Windows 95
2174
2175=item Windows 98
2176
2177=item Windows ME
2178
2179=item Windows NT4
2180
2181=back
2182
2183=head1 Supported Platforms (Perl 5.8)
2184
2185As of July 2002 (the Perl release 5.8.0), the following platforms were
cec2c193 2186able to build Perl from the standard source code distribution
500f1b69 2187available at L<http://www.cpan.org/src/>
cec2c193
JH
2188
2189 AIX
2190 BeOS
6f683aa2 2191 BSD/OS (BSDi)
cec2c193
JH
2192 Cygwin
2193 DG/UX
811b48f2 2194 DOS DJGPP 1)
cec2c193
JH
2195 DYNIX/ptx
2196 EPOC R5
2197 FreeBSD
6f683aa2 2198 HI-UXMPP (Hitachi) (5.8.0 worked but we didn't know it)
cec2c193
JH
2199 HP-UX
2200 IRIX
2201 Linux
8939ba94 2202 Mac OS Classic
6f683aa2 2203 Mac OS X (Darwin)
cec2c193
JH
2204 MPE/iX
2205 NetBSD
2206 NetWare
2207 NonStop-UX
6f683aa2 2208 ReliantUNIX (formerly SINIX)
cec2c193 2209 OpenBSD
6f683aa2 2210 OpenVMS (formerly VMS)
3ebac25b 2211 Open UNIX (Unixware) (since Perl 5.8.1/5.9.0)
cec2c193 2212 OS/2
522b859a 2213 OS/400 (using the PASE) (since Perl 5.8.1/5.9.0)
70de81db 2214 PowerUX
6f683aa2 2215 POSIX-BC (formerly BS2000)
cec2c193
JH
2216 QNX
2217 Solaris
70de81db 2218 SunOS 4
6f683aa2
JH
2219 SUPER-UX (NEC)
2220 Tru64 UNIX (formerly DEC OSF/1, Digital UNIX)
cec2c193
JH
2221 UNICOS
2222 UNICOS/mk
2223 UTS
2224 VOS
811b48f2 2225 Win95/98/ME/2K/XP 2)
c40b5d1d 2226 WinCE
6f683aa2 2227 z/OS (formerly OS/390)
cec2c193 2228 VM/ESA
ba58ab26 2229
811b48f2
JH
2230 1) in DOS mode either the DOS or OS/2 ports can be used
2231 2) compilers: Borland, MinGW (GCC), VC6
cec2c193 2232
c40b5d1d 2233The following platforms worked with the previous releases (5.6 and
cec2c193
JH
22345.7), but we did not manage either to fix or to test these in time
2235for the 5.8.0 release. There is a very good chance that many of these
70de81db 2236will work fine with the 5.8.0.
cec2c193 2237
8da2b1be 2238 BSD/OS
cec2c193
JH
2239 DomainOS
2240 Hurd
2241 LynxOS
2242 MachTen
2243 PowerMAX
2244 SCO SV
cec2c193
JH
2245 SVR4
2246 Unixware
2247 Windows 3.1
ba58ab26 2248
70de81db
JH
2249Known to be broken for 5.8.0 (but 5.6.1 and 5.7.2 can be used):
2250
2251 AmigaOS
2252
ba58ab26 2253The following platforms have been known to build Perl from source in
fd46a41b
JH
2254the past (5.005_03 and earlier), but we haven't been able to verify
2255their status for the current release, either because the
2256hardware/software platforms are rare or because we don't have an
2257active champion on these platforms--or both. They used to work,
2258though, so go ahead and try compiling them, and let perlbug@perl.org
2259of any trouble.
ba58ab26 2260
cec2c193
JH
2261 3b1
2262 A/UX
cec2c193
JH
2263 ConvexOS
2264 CX/UX
2265 DC/OSx
2266 DDE SMES
2267 DOS EMX
2268 Dynix
2269 EP/IX
2270 ESIX
2271 FPS
2272 GENIX
2273 Greenhills
2274 ISC
2275 MachTen 68k
cec2c193
JH
2276 MPC
2277 NEWS-OS
2278 NextSTEP
2279 OpenSTEP
2280 Opus
2281 Plan 9
cec2c193 2282 RISC/os
8da2b1be 2283 SCO ODT/OSR
cec2c193
JH
2284 Stellar
2285 SVR2
2286 TI1500
2287 TitanOS
2288 Ultrix
2289 Unisys Dynix
ba58ab26
JH
2290
2291The following platforms have their own source code distributions and
500f1b69 2292binaries available via L<http://www.cpan.org/ports/>
ba58ab26 2293
cec2c193 2294 Perl release
ba58ab26 2295
522b859a 2296 OS/400 (ILE) 5.005_02
cec2c193 2297 Tandem Guardian 5.004
ba58ab26
JH
2298
2299The following platforms have only binaries available via
500f1b69 2300L<http://www.cpan.org/ports/index.html> :
ba58ab26 2301
cec2c193 2302 Perl release
ba58ab26 2303
cec2c193
JH
2304 Acorn RISCOS 5.005_02
2305 AOS 5.002
2306 LynxOS 5.004_02
ba58ab26
JH
2307
2308Although we do suggest that you always build your own Perl from
2309the source code, both for maximal configurability and for security,
2310in case you are in a hurry you can check
500f1b69 2311L<http://www.cpan.org/ports/index.html> for binary distributions.
ba58ab26 2312
c997b287
GS
2313=head1 SEE ALSO
2314
aa6f04ce 2315L<perlaix>, L<perlamiga>, L<perlbeos>, L<perlbs2000>,
18a271bd 2316L<perlce>, L<perlcygwin>, L<perldgux>, L<perldos>, L<perlepoc>,
469e7be4 2317L<perlebcdic>, L<perlfreebsd>, L<perlhurd>, L<perlhpux>, L<perlirix>,
e94c1c05 2318L<perlmacos>, L<perlmacosx>, L<perlmpeix>,
522b859a
JH
2319L<perlnetware>, L<perlos2>, L<perlos390>, L<perlos400>,
2320L<perlplan9>, L<perlqnx>, L<perlsolaris>, L<perltru64>,
2321L<perlunicode>, L<perlvmesa>, L<perlvms>, L<perlvos>,
2322L<perlwin32>, and L<Win32>.
c997b287 2323
e41182b5
GS
2324=head1 AUTHORS / CONTRIBUTORS
2325
06e9666b 2326Abigail <abigail@foad.org>,
c47ff5f1
GS
2327Charles Bailey <bailey@newman.upenn.edu>,
2328Graham Barr <gbarr@pobox.com>,
2329Tom Christiansen <tchrist@perl.com>,
06e9666b 2330Nicholas Clark <nick@ccl4.org>,
c47ff5f1 2331Thomas Dorner <Thomas.Dorner@start.de>,
06e9666b
A
2332Andy Dougherty <doughera@lafayette.edu>,
2333Dominic Dunlop <domo@computer.org>,
2334Neale Ferguson <neale@vma.tabnsw.com.au>,
c47ff5f1 2335David J. Fiander <davidf@mks.com>,
3fd80bd6 2336Paul Green <Paul.Green@stratus.com>,
06e9666b 2337M.J.T. Guy <mjtg@cam.ac.uk>,
61f30a5e 2338Jarkko Hietaniemi <jhi@iki.fi>,
c47ff5f1 2339Luther Huffman <lutherh@stratcom.com>,
06e9666b
A
2340Nick Ing-Simmons <nick@ing-simmons.net>,
2341Andreas J. KE<ouml>nig <a.koenig@mind.de>,
c47ff5f1
GS
2342Markus Laker <mlaker@contax.co.uk>,
2343Andrew M. Langmead <aml@world.std.com>,
2344Larry Moore <ljmoore@freespace.net>,
2345Paul Moore <Paul.Moore@uk.origin-it.com>,
2346Chris Nandor <pudge@pobox.com>,
1afc07ec 2347Matthias Neeracher <neeracher@mac.com>,
e71a7dc8 2348Philip Newton <pne@cpan.org>,
c47ff5f1
GS
2349Gary Ng <71564.1743@CompuServe.COM>,
2350Tom Phoenix <rootbeer@teleport.com>,
2351AndrE<eacute> Pirard <A.Pirard@ulg.ac.be>,
2352Peter Prymmer <pvhp@forte.com>,
2353Hugo van der Sanden <hv@crypt0.demon.co.uk>,
2354Gurusamy Sarathy <gsar@activestate.com>,
2355Paul J. Schinder <schinder@pobox.com>,
2356Michael G Schwern <schwern@pobox.com>,
06e9666b 2357Dan Sugalski <dan@sidhe.org>,
bbe548ff 2358Nathan Torkington <gnat@frii.com>,
016930a6 2359John Malmberg <wb8tyw@qsl.net>