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