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