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