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