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