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