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