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