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