This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
[perl #71000] Wrong variable name in warning
[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 $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(FILE, '<', $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 $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 $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)
522returns either a fully qualified hostname or a non-qualified hostname:
523it all depends on how the system had been configured. Also remember
524things like DHCP and NAT-- the hostname you get back might not be very
525useful.
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 to 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 $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 # NOTE: this is no longer "bad" in perl5.005
693 for (0..10000000) {} # bad
694 for (my $x = 0; $x <= 10000000; ++$x) {} # good
695
696 @lines = <VERY_LARGE_FILE>; # bad
697
698 while (<FILE>) {$file .= $_} # sometimes bad
699 $file = join('', <FILE>); # better
700
701The last two constructs may appear unintuitive to most people. The
702first repeatedly grows a string, whereas the second allocates a
703large chunk of memory in one go. On some systems, the second is
704more efficient that the first.
705
706=head2 Security
707
708Most multi-user platforms provide basic levels of security, usually
709implemented at the filesystem level. Some, however, do
710not-- unfortunately. Thus the notion of user id, or "home" directory,
711or even the state of being logged-in, may be unrecognizable on many
712platforms. If you write programs that are security-conscious, it
713is usually best to know what type of system you will be running
714under so that you can write code explicitly for that platform (or
715class of platforms).
716
717Don't assume the UNIX filesystem access semantics: the operating
718system or the filesystem may be using some ACL systems, which are
719richer languages than the usual rwx. Even if the rwx exist,
720their semantics might be different.
721
722(From security viewpoint testing for permissions before attempting to
723do something is silly anyway: if one tries this, there is potential
724for race conditions-- someone or something might change the
725permissions between the permissions check and the actual operation.
726Just try the operation.)
727
728Don't assume the UNIX user and group semantics: especially, don't
729expect the C<< $< >> and C<< $> >> (or the C<$(> and C<$)>) to work
730for switching identities (or memberships).
731
732Don't assume set-uid and set-gid semantics. (And even if you do,
733think twice: set-uid and set-gid are a known can of security worms.)
734
735=head2 Style
736
737For those times when it is necessary to have platform-specific code,
738consider keeping the platform-specific code in one place, making porting
739to other platforms easier. Use the Config module and the special
740variable C<$^O> to differentiate platforms, as described in
741L<"PLATFORMS">.
742
743Be careful in the tests you supply with your module or programs.
744Module code may be fully portable, but its tests might not be. This
745often happens when tests spawn off other processes or call external
746programs to aid in the testing, or when (as noted above) the tests
747assume certain things about the filesystem and paths. Be careful not
748to depend on a specific output style for errors, such as when checking
749C<$!> after a failed system call. Using C<$!> for anything else than
750displaying it as output is doubtful (though see the Errno module for
751testing reasonably portably for error value). Some platforms expect
752a certain output format, and Perl on those platforms may have been
753adjusted accordingly. Most specifically, don't anchor a regex when
754testing an error value.
755
756=head1 CPAN Testers
757
758Modules uploaded to CPAN are tested by a variety of volunteers on
759different platforms. These CPAN testers are notified by mail of each
760new upload, and reply to the list with PASS, FAIL, NA (not applicable to
761this platform), or UNKNOWN (unknown), along with any relevant notations.
762
763The purpose of the testing is twofold: one, to help developers fix any
764problems in their code that crop up because of lack of testing on other
765platforms; two, to provide users with information about whether
766a given module works on a given platform.
767
768Also see:
769
770=over 4
771
772=item *
773
774Mailing list: cpan-testers@perl.org
775
776=item *
777
778Testing results: http://testers.cpan.org/
779
780=back
781
782=head1 PLATFORMS
783
784As of version 5.002, Perl is built with a C<$^O> variable that
785indicates the operating system it was built on. This was implemented
786to help speed up code that would otherwise have to C<use Config>
787and use the value of C<$Config{osname}>. Of course, to get more
788detailed information about the system, looking into C<%Config> is
789certainly recommended.
790
791C<%Config> cannot always be trusted, however, because it was built
792at compile time. If perl was built in one place, then transferred
793elsewhere, some values may be wrong. The values may even have been
794edited after the fact.
795
796=head2 Unix
797
798Perl works on a bewildering variety of Unix and Unix-like platforms (see
799e.g. most of the files in the F<hints/> directory in the source code kit).
800On most of these systems, the value of C<$^O> (hence C<$Config{'osname'}>,
801too) is determined either by lowercasing and stripping punctuation from the
802first field of the string returned by typing C<uname -a> (or a similar command)
803at the shell prompt or by testing the file system for the presence of
804uniquely named files such as a kernel or header file. Here, for example,
805are a few of the more popular Unix flavors:
806
807 uname $^O $Config{'archname'}
808 --------------------------------------------
809 AIX aix aix
810 BSD/OS bsdos i386-bsdos
811 Darwin darwin darwin
812 dgux dgux AViiON-dgux
813 DYNIX/ptx dynixptx i386-dynixptx
814 FreeBSD freebsd freebsd-i386
815 Haiku haiku BePC-haiku
816 Linux linux arm-linux
817 Linux linux i386-linux
818 Linux linux i586-linux
819 Linux linux ppc-linux
820 HP-UX hpux PA-RISC1.1
821 IRIX irix irix
822 Mac OS X darwin darwin
823 NeXT 3 next next-fat
824 NeXT 4 next OPENSTEP-Mach
825 openbsd openbsd i386-openbsd
826 OSF1 dec_osf alpha-dec_osf
827 reliantunix-n svr4 RM400-svr4
828 SCO_SV sco_sv i386-sco_sv
829 SINIX-N svr4 RM400-svr4
830 sn4609 unicos CRAY_C90-unicos
831 sn6521 unicosmk t3e-unicosmk
832 sn9617 unicos CRAY_J90-unicos
833 SunOS solaris sun4-solaris
834 SunOS solaris i86pc-solaris
835 SunOS4 sunos sun4-sunos
836
837Because the value of C<$Config{archname}> may depend on the
838hardware architecture, it can vary more than the value of C<$^O>.
839
840=head2 DOS and Derivatives
841
842Perl has long been ported to Intel-style microcomputers running under
843systems like PC-DOS, MS-DOS, OS/2, and most Windows platforms you can
844bring yourself to mention (except for Windows CE, if you count that).
845Users familiar with I<COMMAND.COM> or I<CMD.EXE> style shells should
846be aware that each of these file specifications may have subtle
847differences:
848
849 $filespec0 = "c:/foo/bar/file.txt";
850 $filespec1 = "c:\\foo\\bar\\file.txt";
851 $filespec2 = 'c:\foo\bar\file.txt';
852 $filespec3 = 'c:\\foo\\bar\\file.txt';
853
854System calls accept either C</> or C<\> as the path separator.
855However, many command-line utilities of DOS vintage treat C</> as
856the option prefix, so may get confused by filenames containing C</>.
857Aside from calling any external programs, C</> will work just fine,
858and probably better, as it is more consistent with popular usage,
859and avoids the problem of remembering what to backwhack and what
860not to.
861
862The DOS FAT filesystem can accommodate only "8.3" style filenames. Under
863the "case-insensitive, but case-preserving" HPFS (OS/2) and NTFS (NT)
864filesystems you may have to be careful about case returned with functions
865like C<readdir> or used with functions like C<open> or C<opendir>.
866
867DOS also treats several filenames as special, such as AUX, PRN,
868NUL, CON, COM1, LPT1, LPT2, etc. Unfortunately, sometimes these
869filenames won't even work if you include an explicit directory
870prefix. It is best to avoid such filenames, if you want your code
871to be portable to DOS and its derivatives. It's hard to know what
872these all are, unfortunately.
873
874Users of these operating systems may also wish to make use of
875scripts such as I<pl2bat.bat> or I<pl2cmd> to
876put wrappers around your scripts.
877
878Newline (C<\n>) is translated as C<\015\012> by STDIO when reading from
879and writing to files (see L<"Newlines">). C<binmode(FILEHANDLE)>
880will keep C<\n> translated as C<\012> for that filehandle. Since it is a
881no-op on other systems, C<binmode> should be used for cross-platform code
882that deals with binary data. That's assuming you realize in advance
883that your data is in binary. General-purpose programs should
884often assume nothing about their data.
885
886The C<$^O> variable and the C<$Config{archname}> values for various
887DOSish perls are as follows:
888
889 OS $^O $Config{archname} ID Version
890 --------------------------------------------------------
891 MS-DOS dos ?
892 PC-DOS dos ?
893 OS/2 os2 ?
894 Windows 3.1 ? ? 0 3 01
895 Windows 95 MSWin32 MSWin32-x86 1 4 00
896 Windows 98 MSWin32 MSWin32-x86 1 4 10
897 Windows ME MSWin32 MSWin32-x86 1 ?
898 Windows NT MSWin32 MSWin32-x86 2 4 xx
899 Windows NT MSWin32 MSWin32-ALPHA 2 4 xx
900 Windows NT MSWin32 MSWin32-ppc 2 4 xx
901 Windows 2000 MSWin32 MSWin32-x86 2 5 00
902 Windows XP MSWin32 MSWin32-x86 2 5 01
903 Windows 2003 MSWin32 MSWin32-x86 2 5 02
904 Windows CE MSWin32 ? 3
905 Cygwin cygwin cygwin
906
907The various MSWin32 Perl's can distinguish the OS they are running on
908via the value of the fifth element of the list returned from
909Win32::GetOSVersion(). For example:
910
911 if ($^O eq 'MSWin32') {
912 my @os_version_info = Win32::GetOSVersion();
913 print +('3.1','95','NT')[$os_version_info[4]],"\n";
914 }
915
916There are also Win32::IsWinNT() and Win32::IsWin95(), try C<perldoc Win32>,
917and as of libwin32 0.19 (not part of the core Perl distribution)
918Win32::GetOSName(). The very portable POSIX::uname() will work too:
919
920 c:\> perl -MPOSIX -we "print join '|', uname"
921 Windows NT|moonru|5.0|Build 2195 (Service Pack 2)|x86
922
923Also see:
924
925=over 4
926
927=item *
928
929The djgpp environment for DOS, http://www.delorie.com/djgpp/
930and L<perldos>.
931
932=item *
933
934The EMX environment for DOS, OS/2, etc. emx@iaehv.nl,
935ftp://hobbes.nmsu.edu/pub/os2/dev/emx/ Also L<perlos2>.
936
937=item *
938
939Build instructions for Win32 in L<perlwin32>, or under the Cygnus environment
940in L<perlcygwin>.
941
942=item *
943
944The C<Win32::*> modules in L<Win32>.
945
946=item *
947
948The ActiveState Pages, http://www.activestate.com/
949
950=item *
951
952The Cygwin environment for Win32; F<README.cygwin> (installed
953as L<perlcygwin>), http://www.cygwin.com/
954
955=item *
956
957The U/WIN environment for Win32,
958http://www.research.att.com/sw/tools/uwin/
959
960=item *
961
962Build instructions for OS/2, L<perlos2>
963
964=back
965
966=head2 VMS
967
968Perl on VMS is discussed in L<perlvms> in the perl distribution.
969
970The official name of VMS as of this writing is OpenVMS.
971
972Perl on VMS can accept either VMS- or Unix-style file
973specifications as in either of the following:
974
975 $ perl -ne "print if /perl_setup/i" SYS$LOGIN:LOGIN.COM
976 $ perl -ne "print if /perl_setup/i" /sys$login/login.com
977
978but not a mixture of both as in:
979
980 $ perl -ne "print if /perl_setup/i" sys$login:/login.com
981 Can't open sys$login:/login.com: file specification syntax error
982
983Interacting with Perl from the Digital Command Language (DCL) shell
984often requires a different set of quotation marks than Unix shells do.
985For example:
986
987 $ perl -e "print ""Hello, world.\n"""
988 Hello, world.
989
990There are several ways to wrap your perl scripts in DCL F<.COM> files, if
991you are so inclined. For example:
992
993 $ write sys$output "Hello from DCL!"
994 $ if p1 .eqs. ""
995 $ then perl -x 'f$environment("PROCEDURE")
996 $ else perl -x - 'p1 'p2 'p3 'p4 'p5 'p6 'p7 'p8
997 $ deck/dollars="__END__"
998 #!/usr/bin/perl
999
1000 print "Hello from Perl!\n";
1001
1002 __END__
1003 $ endif
1004
1005Do take care with C<$ ASSIGN/nolog/user SYS$COMMAND: SYS$INPUT> if your
1006perl-in-DCL script expects to do things like C<< $read = <STDIN>; >>.
1007
1008The VMS operating system has two filesystems, known as ODS-2 and ODS-5.
1009
1010For ODS-2, filenames are in the format "name.extension;version". The
1011maximum length for filenames is 39 characters, and the maximum length for
1012extensions is also 39 characters. Version is a number from 1 to
101332767. Valid characters are C</[A-Z0-9$_-]/>.
1014
1015The ODS-2 filesystem is case-insensitive and does not preserve case.
1016Perl simulates this by converting all filenames to lowercase internally.
1017
1018For ODS-5, filenames may have almost any character in them and can include
1019Unicode characters. Characters that could be misinterpreted by the DCL
1020shell or file parsing utilities need to be prefixed with the C<^>
1021character, or replaced with hexadecimal characters prefixed with the
1022C<^> character. Such prefixing is only needed with the pathnames are
1023in VMS format in applications. Programs that can accept the UNIX format
1024of pathnames do not need the escape characters. The maximum length for
1025filenames is 255 characters. The ODS-5 file system can handle both
1026a case preserved and a case sensitive mode.
1027
1028ODS-5 is only available on the OpenVMS for 64 bit platforms.
1029
1030Support for the extended file specifications is being done as optional
1031settings to preserve backward compatibility with Perl scripts that
1032assume the previous VMS limitations.
1033
1034In general routines on VMS that get a UNIX format file specification
1035should return it in a UNIX format, and when they get a VMS format
1036specification they should return a VMS format unless they are documented
1037to do a conversion.
1038
1039For routines that generate return a file specification, VMS allows setting
1040if the C library which Perl is built on if it will be returned in VMS
1041format or in UNIX format.
1042
1043With the ODS-2 file system, there is not much difference in syntax of
1044filenames without paths for VMS or UNIX. With the extended character
1045set available with ODS-5 there can be a significant difference.
1046
1047Because of this, existing Perl scripts written for VMS were sometimes
1048treating VMS and UNIX filenames interchangeably. Without the extended
1049character set enabled, this behavior will mostly be maintained for
1050backwards compatibility.
1051
1052When extended characters are enabled with ODS-5, the handling of
1053UNIX formatted file specifications is to that of a UNIX system.
1054
1055VMS file specifications without extensions have a trailing dot. An
1056equivalent UNIX file specification should not show the trailing dot.
1057
1058The result of all of this, is that for VMS, for portable scripts, you
1059can not depend on Perl to present the filenames in lowercase, to be
1060case sensitive, and that the filenames could be returned in either
1061UNIX or VMS format.
1062
1063And if a routine returns a file specification, unless it is intended to
1064convert it, it should return it in the same format as it found it.
1065
1066C<readdir> by default has traditionally returned lowercased filenames.
1067When the ODS-5 support is enabled, it will return the exact case of the
1068filename on the disk.
1069
1070Files without extensions have a trailing period on them, so doing a
1071C<readdir> in the default mode with a file named F<A.;5> will
1072return F<a.> when VMS is (though that file could be opened with
1073C<open(FH, 'A')>).
1074
1075With support for extended file specifications and if C<opendir> was
1076given a UNIX format directory, a file named F<A.;5> will return F<a>
1077and optionally in the exact case on the disk. When C<opendir> is given
1078a VMS format directory, then C<readdir> should return F<a.>, and
1079again with the optionally the exact case.
1080
1081RMS had an eight level limit on directory depths from any rooted logical
1082(allowing 16 levels overall) prior to VMS 7.2, and even with versions of
1083VMS on VAX up through 7.3. Hence C<PERL_ROOT:[LIB.2.3.4.5.6.7.8]> is a
1084valid directory specification but C<PERL_ROOT:[LIB.2.3.4.5.6.7.8.9]> is
1085not. F<Makefile.PL> authors might have to take this into account, but at
1086least they can refer to the former as C</PERL_ROOT/lib/2/3/4/5/6/7/8/>.
1087
1088Pumpkings and module integrators can easily see whether files with too many
1089directory levels have snuck into the core by running the following in the
1090top-level source directory:
1091
1092 $ perl -ne "$_=~s/\s+.*//; print if scalar(split /\//) > 8;" < MANIFEST
1093
1094
1095The VMS::Filespec module, which gets installed as part of the build
1096process on VMS, is a pure Perl module that can easily be installed on
1097non-VMS platforms and can be helpful for conversions to and from RMS
1098native formats. It is also now the only way that you should check to
1099see if VMS is in a case sensitive mode.
1100
1101What C<\n> represents depends on the type of file opened. It usually
1102represents C<\012> but it could also be C<\015>, C<\012>, C<\015\012>,
1103C<\000>, C<\040>, or nothing depending on the file organization and
1104record format. The VMS::Stdio module provides access to the
1105special fopen() requirements of files with unusual attributes on VMS.
1106
1107TCP/IP stacks are optional on VMS, so socket routines might not be
1108implemented. UDP sockets may not be supported.
1109
1110The TCP/IP library support for all current versions of VMS is dynamically
1111loaded if present, so even if the routines are configured, they may
1112return a status indicating that they are not implemented.
1113
1114The value of C<$^O> on OpenVMS is "VMS". To determine the architecture
1115that you are running on without resorting to loading all of C<%Config>
1116you can examine the content of the C<@INC> array like so:
1117
1118 if (grep(/VMS_AXP/, @INC)) {
1119 print "I'm on Alpha!\n";
1120
1121 } elsif (grep(/VMS_VAX/, @INC)) {
1122 print "I'm on VAX!\n";
1123
1124 } elsif (grep(/VMS_IA64/, @INC)) {
1125 print "I'm on IA64!\n";
1126
1127 } else {
1128 print "I'm not so sure about where $^O is...\n";
1129 }
1130
1131In general, the significant differences should only be if Perl is running
1132on VMS_VAX or one of the 64 bit OpenVMS platforms.
1133
1134On VMS, perl determines the UTC offset from the C<SYS$TIMEZONE_DIFFERENTIAL>
1135logical name. Although the VMS epoch began at 17-NOV-1858 00:00:00.00,
1136calls to C<localtime> are adjusted to count offsets from
113701-JAN-1970 00:00:00.00, just like Unix.
1138
1139Also see:
1140
1141=over 4
1142
1143=item *
1144
1145F<README.vms> (installed as L<README_vms>), L<perlvms>
1146
1147=item *
1148
1149vmsperl list, vmsperl-subscribe@perl.org
1150
1151=item *
1152
1153vmsperl on the web, http://www.sidhe.org/vmsperl/index.html
1154
1155=back
1156
1157=head2 VOS
1158
1159Perl on VOS is discussed in F<README.vos> in the perl distribution
1160(installed as L<perlvos>). Perl on VOS can accept either VOS- or
1161Unix-style file specifications as in either 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 names
1173contain a slash character cannot be processed. Such files must be
1174renamed before they can be processed by Perl. Note that VOS limits
1175file names to 32 or fewer characters, file names cannot start with a
1176C<-> character, or contain any character matching C<< tr/ !%&'()*+;<>?// >>
1177
1178The value of C<$^O> on VOS is "VOS". To determine the architecture that
1179you are running on without resorting to loading all of C<%Config> you
1180can examine the content of the @INC array like so:
1181
1182 if ($^O =~ /VOS/) {
1183 print "I'm on a Stratus box!\n";
1184 } else {
1185 print "I'm not on a Stratus box!\n";
1186 die;
1187 }
1188
1189Also see:
1190
1191=over 4
1192
1193=item *
1194
1195F<README.vos> (installed as L<perlvos>)
1196
1197=item *
1198
1199The VOS mailing list.
1200
1201There is no specific mailing list for Perl on VOS. You can post
1202comments to the comp.sys.stratus newsgroup, or subscribe to the general
1203Stratus mailing list. Send a letter with "subscribe Info-Stratus" in
1204the message body to majordomo@list.stratagy.com.
1205
1206=item *
1207
1208VOS Perl on the web at http://ftp.stratus.com/pub/vos/posix/posix.html
1209
1210=back
1211
1212=head2 EBCDIC Platforms
1213
1214Recent versions of Perl have been ported to platforms such as OS/400 on
1215AS/400 minicomputers as well as OS/390, VM/ESA, and BS2000 for S/390
1216Mainframes. Such computers use EBCDIC character sets internally (usually
1217Character Code Set ID 0037 for OS/400 and either 1047 or POSIX-BC for S/390
1218systems). On the mainframe perl currently works under the "Unix system
1219services for OS/390" (formerly known as OpenEdition), VM/ESA OpenEdition, or
1220the BS200 POSIX-BC system (BS2000 is supported in perl 5.6 and greater).
1221See L<perlos390> for details. Note that for OS/400 there is also a port of
1222Perl 5.8.1/5.9.0 or later to the PASE which is ASCII-based (as opposed to
1223ILE which is EBCDIC-based), see L<perlos400>.
1224
1225As of R2.5 of USS for OS/390 and Version 2.3 of VM/ESA these Unix
1226sub-systems do not support the C<#!> shebang trick for script invocation.
1227Hence, on OS/390 and VM/ESA perl scripts can be executed with a header
1228similar to the following simple script:
1229
1230 : # use perl
1231 eval 'exec /usr/local/bin/perl -S $0 ${1+"$@"}'
1232 if 0;
1233 #!/usr/local/bin/perl # just a comment really
1234
1235 print "Hello from perl!\n";
1236
1237OS/390 will support the C<#!> shebang trick in release 2.8 and beyond.
1238Calls to C<system> and backticks can use POSIX shell syntax on all
1239S/390 systems.
1240
1241On the AS/400, if PERL5 is in your library list, you may need
1242to wrap your perl scripts in a CL procedure to invoke them like so:
1243
1244 BEGIN
1245 CALL PGM(PERL5/PERL) PARM('/QOpenSys/hello.pl')
1246 ENDPGM
1247
1248This will invoke the perl script F<hello.pl> in the root of the
1249QOpenSys file system. On the AS/400 calls to C<system> or backticks
1250must use CL syntax.
1251
1252On these platforms, bear in mind that the EBCDIC character set may have
1253an effect on what happens with some perl functions (such as C<chr>,
1254C<pack>, C<print>, C<printf>, C<ord>, C<sort>, C<sprintf>, C<unpack>), as
1255well as bit-fiddling with ASCII constants using operators like C<^>, C<&>
1256and C<|>, not to mention dealing with socket interfaces to ASCII computers
1257(see L<"Newlines">).
1258
1259Fortunately, most web servers for the mainframe will correctly
1260translate the C<\n> in the following statement to its ASCII equivalent
1261(C<\r> is the same under both Unix and OS/390 & VM/ESA):
1262
1263 print "Content-type: text/html\r\n\r\n";
1264
1265The values of C<$^O> on some of these platforms includes:
1266
1267 uname $^O $Config{'archname'}
1268 --------------------------------------------
1269 OS/390 os390 os390
1270 OS400 os400 os400
1271 POSIX-BC posix-bc BS2000-posix-bc
1272 VM/ESA vmesa vmesa
1273
1274Some simple tricks for determining if you are running on an EBCDIC
1275platform could include any of the following (perhaps all):
1276
1277 if ("\t" eq "\05") { print "EBCDIC may be spoken here!\n"; }
1278
1279 if (ord('A') == 193) { print "EBCDIC may be spoken here!\n"; }
1280
1281 if (chr(169) eq 'z') { print "EBCDIC may be spoken here!\n"; }
1282
1283One thing you may not want to rely on is the EBCDIC encoding
1284of punctuation characters since these may differ from code page to code
1285page (and once your module or script is rumoured to work with EBCDIC,
1286folks will want it to work with all EBCDIC character sets).
1287
1288Also see:
1289
1290=over 4
1291
1292=item *
1293
1294L<perlos390>, F<README.os390>, F<perlbs2000>, F<README.vmesa>,
1295L<perlebcdic>.
1296
1297=item *
1298
1299The perl-mvs@perl.org list is for discussion of porting issues as well as
1300general usage issues for all EBCDIC Perls. Send a message body of
1301"subscribe perl-mvs" to majordomo@perl.org.
1302
1303=item *
1304
1305AS/400 Perl information at
1306http://as400.rochester.ibm.com/
1307as well as on CPAN in the F<ports/> directory.
1308
1309=back
1310
1311=head2 Acorn RISC OS
1312
1313Because Acorns use ASCII with newlines (C<\n>) in text files as C<\012> like
1314Unix, and because Unix filename emulation is turned on by default,
1315most simple scripts will probably work "out of the box". The native
1316filesystem is modular, and individual filesystems are free to be
1317case-sensitive or insensitive, and are usually case-preserving. Some
1318native filesystems have name length limits, which file and directory
1319names are silently truncated to fit. Scripts should be aware that the
1320standard filesystem currently has a name length limit of B<10>
1321characters, with up to 77 items in a directory, but other filesystems
1322may not impose such limitations.
1323
1324Native filenames are of the form
1325
1326 Filesystem#Special_Field::DiskName.$.Directory.Directory.File
1327
1328where
1329
1330 Special_Field is not usually present, but may contain . and $ .
1331 Filesystem =~ m|[A-Za-z0-9_]|
1332 DsicName =~ m|[A-Za-z0-9_/]|
1333 $ represents the root directory
1334 . is the path separator
1335 @ is the current directory (per filesystem but machine global)
1336 ^ is the parent directory
1337 Directory and File =~ m|[^\0- "\.\$\%\&:\@\\^\|\177]+|
1338
1339The default filename translation is roughly C<tr|/.|./|;>
1340
1341Note that C<"ADFS::HardDisk.$.File" ne 'ADFS::HardDisk.$.File'> and that
1342the second stage of C<$> interpolation in regular expressions will fall
1343foul of the C<$.> if scripts are not careful.
1344
1345Logical paths specified by system variables containing comma-separated
1346search lists are also allowed; hence C<System:Modules> is a valid
1347filename, and the filesystem will prefix C<Modules> with each section of
1348C<System$Path> until a name is made that points to an object on disk.
1349Writing to a new file C<System:Modules> would be allowed only if
1350C<System$Path> contains a single item list. The filesystem will also
1351expand system variables in filenames if enclosed in angle brackets, so
1352C<< <System$Dir>.Modules >> would look for the file
1353S<C<$ENV{'System$Dir'} . 'Modules'>>. The obvious implication of this is
1354that B<fully qualified filenames can start with C<< <> >>> and should
1355be protected when C<open> is used for input.
1356
1357Because C<.> was in use as a directory separator and filenames could not
1358be assumed to be unique after 10 characters, Acorn implemented the C
1359compiler to strip the trailing C<.c> C<.h> C<.s> and C<.o> suffix from
1360filenames specified in source code and store the respective files in
1361subdirectories named after the suffix. Hence files are translated:
1362
1363 foo.h h.foo
1364 C:foo.h C:h.foo (logical path variable)
1365 sys/os.h sys.h.os (C compiler groks Unix-speak)
1366 10charname.c c.10charname
1367 10charname.o o.10charname
1368 11charname_.c c.11charname (assuming filesystem truncates at 10)
1369
1370The Unix emulation library's translation of filenames to native assumes
1371that this sort of translation is required, and it allows a user-defined list
1372of known suffixes that it will transpose in this fashion. This may
1373seem transparent, but consider that with these rules C<foo/bar/baz.h>
1374and C<foo/bar/h/baz> both map to C<foo.bar.h.baz>, and that C<readdir> and
1375C<glob> cannot and do not attempt to emulate the reverse mapping. Other
1376C<.>'s in filenames are translated to C</>.
1377
1378As implied above, the environment accessed through C<%ENV> is global, and
1379the convention is that program specific environment variables are of the
1380form C<Program$Name>. Each filesystem maintains a current directory,
1381and the current filesystem's current directory is the B<global> current
1382directory. Consequently, sociable programs don't change the current
1383directory but rely on full pathnames, and programs (and Makefiles) cannot
1384assume that they can spawn a child process which can change the current
1385directory without affecting its parent (and everyone else for that
1386matter).
1387
1388Because native operating system filehandles are global and are currently
1389allocated down from 255, with 0 being a reserved value, the Unix emulation
1390library emulates Unix filehandles. Consequently, you can't rely on
1391passing C<STDIN>, C<STDOUT>, or C<STDERR> to your children.
1392
1393The desire of users to express filenames of the form
1394C<< <Foo$Dir>.Bar >> on the command line unquoted causes problems,
1395too: C<``> command output capture has to perform a guessing game. It
1396assumes that a string C<< <[^<>]+\$[^<>]> >> is a
1397reference to an environment variable, whereas anything else involving
1398C<< < >> or C<< > >> is redirection, and generally manages to be 99%
1399right. Of course, the problem remains that scripts cannot rely on any
1400Unix tools being available, or that any tools found have Unix-like command
1401line arguments.
1402
1403Extensions and XS are, in theory, buildable by anyone using free
1404tools. In practice, many don't, as users of the Acorn platform are
1405used to binary distributions. MakeMaker does run, but no available
1406make currently copes with MakeMaker's makefiles; even if and when
1407this should be fixed, the lack of a Unix-like shell will cause
1408problems with makefile rules, especially lines of the form C<cd
1409sdbm && make all>, and anything using quoting.
1410
1411"S<RISC OS>" is the proper name for the operating system, but the value
1412in C<$^O> is "riscos" (because we don't like shouting).
1413
1414=head2 Other perls
1415
1416Perl has been ported to many platforms that do not fit into any of
1417the categories listed above. Some, such as AmigaOS, BeOS, HP MPE/iX,
1418QNX, Plan 9, and VOS, have been well-integrated into the standard
1419Perl source code kit. You may need to see the F<ports/> directory
1420on CPAN for information, and possibly binaries, for the likes of:
1421aos, Atari ST, lynxos, riscos, Novell Netware, Tandem Guardian,
1422I<etc.> (Yes, we know that some of these OSes may fall under the
1423Unix category, but we are not a standards body.)
1424
1425Some approximate operating system names and their C<$^O> values
1426in the "OTHER" category include:
1427
1428 OS $^O $Config{'archname'}
1429 ------------------------------------------
1430 Amiga DOS amigaos m68k-amigos
1431 BeOS beos
1432 MPE/iX mpeix PA-RISC1.1
1433
1434See also:
1435
1436=over 4
1437
1438=item *
1439
1440Amiga, F<README.amiga> (installed as L<perlamiga>).
1441
1442=item *
1443
1444Be OS, F<README.beos>
1445
1446=item *
1447
1448HP 300 MPE/iX, F<README.mpeix> and Mark Bixby's web page
1449http://www.bixby.org/mark/porting.html
1450
1451=item *
1452
1453A free perl5-based PERL.NLM for Novell Netware is available in
1454precompiled binary and source code form from http://www.novell.com/
1455as well as from CPAN.
1456
1457=item *
1458
1459S<Plan 9>, F<README.plan9>
1460
1461=back
1462
1463=head1 FUNCTION IMPLEMENTATIONS
1464
1465Listed below are functions that are either completely unimplemented
1466or else have been implemented differently on various platforms.
1467Following each description will be, in parentheses, a list of
1468platforms that the description applies to.
1469
1470The list may well be incomplete, or even wrong in some places. When
1471in doubt, consult the platform-specific README files in the Perl
1472source distribution, and any other documentation resources accompanying
1473a given port.
1474
1475Be aware, moreover, that even among Unix-ish systems there are variations.
1476
1477For many functions, you can also query C<%Config>, exported by
1478default from the Config module. For example, to check whether the
1479platform has the C<lstat> call, check C<$Config{d_lstat}>. See
1480L<Config> for a full description of available variables.
1481
1482=head2 Alphabetical Listing of Perl Functions
1483
1484=over 8
1485
1486=item -X
1487
1488C<-w> only inspects the read-only file attribute (FILE_ATTRIBUTE_READONLY),
1489which determines whether the directory can be deleted, not whether it can
1490be written to. Directories always have read and write access unless denied
1491by discretionary access control lists (DACLs). (S<Win32>)
1492
1493C<-r>, C<-w>, C<-x>, and C<-o> tell whether the file is accessible,
1494which may not reflect UIC-based file protections. (VMS)
1495
1496C<-s> by name on an open file will return the space reserved on disk,
1497rather than the current extent. C<-s> on an open filehandle returns the
1498current size. (S<RISC OS>)
1499
1500C<-R>, C<-W>, C<-X>, C<-O> are indistinguishable from C<-r>, C<-w>,
1501C<-x>, C<-o>. (Win32, VMS, S<RISC OS>)
1502
1503C<-g>, C<-k>, C<-l>, C<-u>, C<-A> are not particularly meaningful.
1504(Win32, VMS, S<RISC OS>)
1505
1506C<-p> is not particularly meaningful. (VMS, S<RISC OS>)
1507
1508C<-d> is true if passed a device spec without an explicit directory.
1509(VMS)
1510
1511C<-x> (or C<-X>) determine if a file ends in one of the executable
1512suffixes. C<-S> is meaningless. (Win32)
1513
1514C<-x> (or C<-X>) determine if a file has an executable file type.
1515(S<RISC OS>)
1516
1517=item atan2
1518
1519Due to issues with various CPUs, math libraries, compilers, and standards,
1520results for C<atan2()> may vary depending on any combination of the above.
1521Perl attempts to conform to the Open Group/IEEE standards for the results
1522returned from C<atan2()>, but cannot force the issue if the system Perl is
1523run on does not allow it. (Tru64, HP-UX 10.20)
1524
1525The current version of the standards for C<atan2()> is available at
1526L<http://www.opengroup.org/onlinepubs/009695399/functions/atan2.html>.
1527
1528=item binmode
1529
1530Meaningless. (S<RISC OS>)
1531
1532Reopens file and restores pointer; if function fails, underlying
1533filehandle may be closed, or pointer may be in a different position.
1534(VMS)
1535
1536The value returned by C<tell> may be affected after the call, and
1537the filehandle may be flushed. (Win32)
1538
1539=item chmod
1540
1541Only good for changing "owner" read-write access, "group", and "other"
1542bits are meaningless. (Win32)
1543
1544Only good for changing "owner" and "other" read-write access. (S<RISC OS>)
1545
1546Access permissions are mapped onto VOS access-control list changes. (VOS)
1547
1548The actual permissions set depend on the value of the C<CYGWIN>
1549in the SYSTEM environment settings. (Cygwin)
1550
1551=item chown
1552
1553Not implemented. (Win32, S<Plan 9>, S<RISC OS>)
1554
1555Does nothing, but won't fail. (Win32)
1556
1557A little funky, because VOS's notion of ownership is a little funky (VOS).
1558
1559=item chroot
1560
1561Not implemented. (Win32, VMS, S<Plan 9>, S<RISC OS>, VOS, VM/ESA)
1562
1563=item crypt
1564
1565May not be available if library or source was not provided when building
1566perl. (Win32)
1567
1568=item dbmclose
1569
1570Not implemented. (VMS, S<Plan 9>, VOS)
1571
1572=item dbmopen
1573
1574Not implemented. (VMS, S<Plan 9>, VOS)
1575
1576=item dump
1577
1578Not useful. (S<RISC OS>)
1579
1580Not supported. (Cygwin, Win32)
1581
1582Invokes VMS debugger. (VMS)
1583
1584=item exec
1585
1586Implemented via Spawn. (VM/ESA)
1587
1588Does not automatically flush output handles on some platforms.
1589(SunOS, Solaris, HP-UX)
1590
1591=item exit
1592
1593Emulates UNIX exit() (which considers C<exit 1> to indicate an error) by
1594mapping the C<1> to SS$_ABORT (C<44>). This behavior may be overridden
1595with the pragma C<use vmsish 'exit'>. As with the CRTL's exit()
1596function, C<exit 0> is also mapped to an exit status of SS$_NORMAL
1597(C<1>); this mapping cannot be overridden. Any other argument to exit()
1598is used directly as Perl's exit status. On VMS, unless the future
1599POSIX_EXIT mode is enabled, the exit code should always be a valid
1600VMS exit code and not a generic number. When the POSIX_EXIT mode is
1601enabled, a generic number will be encoded in a method compatible with
1602the C library _POSIX_EXIT macro so that it can be decoded by other
1603programs, particularly ones written in C, like the GNV package. (VMS)
1604
1605=item fcntl
1606
1607Not implemented. (Win32)
1608Some functions available based on the version of VMS. (VMS)
1609
1610=item flock
1611
1612Not implemented (VMS, S<RISC OS>, VOS).
1613
1614Available only on Windows NT (not on Windows 95). (Win32)
1615
1616=item fork
1617
1618Not implemented. (AmigaOS, S<RISC OS>, VM/ESA, VMS)
1619
1620Emulated using multiple interpreters. See L<perlfork>. (Win32)
1621
1622Does not automatically flush output handles on some platforms.
1623(SunOS, Solaris, HP-UX)
1624
1625=item getlogin
1626
1627Not implemented. (S<RISC OS>)
1628
1629=item getpgrp
1630
1631Not implemented. (Win32, VMS, S<RISC OS>)
1632
1633=item getppid
1634
1635Not implemented. (Win32, S<RISC OS>)
1636
1637=item getpriority
1638
1639Not implemented. (Win32, VMS, S<RISC OS>, VOS, VM/ESA)
1640
1641=item getpwnam
1642
1643Not implemented. (Win32)
1644
1645Not useful. (S<RISC OS>)
1646
1647=item getgrnam
1648
1649Not implemented. (Win32, VMS, S<RISC OS>)
1650
1651=item getnetbyname
1652
1653Not implemented. (Win32, S<Plan 9>)
1654
1655=item getpwuid
1656
1657Not implemented. (Win32)
1658
1659Not useful. (S<RISC OS>)
1660
1661=item getgrgid
1662
1663Not implemented. (Win32, VMS, S<RISC OS>)
1664
1665=item getnetbyaddr
1666
1667Not implemented. (Win32, S<Plan 9>)
1668
1669=item getprotobynumber
1670
1671=item getservbyport
1672
1673=item getpwent
1674
1675Not implemented. (Win32, VM/ESA)
1676
1677=item getgrent
1678
1679Not implemented. (Win32, VMS, VM/ESA)
1680
1681=item gethostbyname
1682
1683C<gethostbyname('localhost')> does not work everywhere: you may have
1684to use C<gethostbyname('127.0.0.1')>. (S<Irix 5>)
1685
1686=item gethostent
1687
1688Not implemented. (Win32)
1689
1690=item getnetent
1691
1692Not implemented. (Win32, S<Plan 9>)
1693
1694=item getprotoent
1695
1696Not implemented. (Win32, S<Plan 9>)
1697
1698=item getservent
1699
1700Not implemented. (Win32, S<Plan 9>)
1701
1702=item sethostent
1703
1704Not implemented. (Win32, S<Plan 9>, S<RISC OS>)
1705
1706=item setnetent
1707
1708Not implemented. (Win32, S<Plan 9>, S<RISC OS>)
1709
1710=item setprotoent
1711
1712Not implemented. (Win32, S<Plan 9>, S<RISC OS>)
1713
1714=item setservent
1715
1716Not implemented. (S<Plan 9>, Win32, S<RISC OS>)
1717
1718=item endpwent
1719
1720Not implemented. (MPE/iX, VM/ESA, Win32)
1721
1722=item endgrent
1723
1724Not implemented. (MPE/iX, S<RISC OS>, VM/ESA, VMS, Win32)
1725
1726=item endhostent
1727
1728Not implemented. (Win32)
1729
1730=item endnetent
1731
1732Not implemented. (Win32, S<Plan 9>)
1733
1734=item endprotoent
1735
1736Not implemented. (Win32, S<Plan 9>)
1737
1738=item endservent
1739
1740Not implemented. (S<Plan 9>, Win32)
1741
1742=item getsockopt SOCKET,LEVEL,OPTNAME
1743
1744Not implemented. (S<Plan 9>)
1745
1746=item glob
1747
1748This operator is implemented via the File::Glob extension on most
1749platforms. See L<File::Glob> for portability information.
1750
1751=item gmtime
1752
1753In theory, gmtime() is reliable from -2**63 to 2**63-1. However,
1754because work arounds in the implementation use floating point numbers,
1755it will become inaccurate as the time gets larger. This is a bug and
1756will be fixed in the future.
1757
1758=item ioctl FILEHANDLE,FUNCTION,SCALAR
1759
1760Not implemented. (VMS)
1761
1762Available only for socket handles, and it does what the ioctlsocket() call
1763in the Winsock API does. (Win32)
1764
1765Available only for socket handles. (S<RISC OS>)
1766
1767=item kill
1768
1769Not implemented, hence not useful for taint checking. (S<RISC OS>)
1770
1771C<kill()> doesn't have the semantics of C<raise()>, i.e. it doesn't send
1772a signal to the identified process like it does on Unix platforms.
1773Instead C<kill($sig, $pid)> terminates the process identified by $pid,
1774and makes it exit immediately with exit status $sig. As in Unix, if
1775$sig is 0 and the specified process exists, it returns true without
1776actually terminating it. (Win32)
1777
1778C<kill(-9, $pid)> will terminate the process specified by $pid and
1779recursively all child processes owned by it. This is different from
1780the Unix semantics, where the signal will be delivered to all
1781processes in the same process group as the process specified by
1782$pid. (Win32)
1783
1784Is not supported for process identification number of 0 or negative
1785numbers. (VMS)
1786
1787=item link
1788
1789Not implemented. (MPE/iX, S<RISC OS>)
1790
1791Link count not updated because hard links are not quite that hard
1792(They are sort of half-way between hard and soft links). (AmigaOS)
1793
1794Hard links are implemented on Win32 under NTFS only. They are
1795natively supported on Windows 2000 and later. On Windows NT they
1796are implemented using the Windows POSIX subsystem support and the
1797Perl process will need Administrator or Backup Operator privileges
1798to create hard links.
1799
1800Available on 64 bit OpenVMS 8.2 and later. (VMS)
1801
1802=item localtime
1803
1804localtime() has the same range as L<gmtime>, but because time zone
1805rules change its accuracy for historical and future times may degrade
1806but usually by no more than an hour.
1807
1808=item lstat
1809
1810Not implemented. (S<RISC OS>)
1811
1812Return values (especially for device and inode) may be bogus. (Win32)
1813
1814=item msgctl
1815
1816=item msgget
1817
1818=item msgsnd
1819
1820=item msgrcv
1821
1822Not implemented. (Win32, VMS, S<Plan 9>, S<RISC OS>, VOS)
1823
1824=item open
1825
1826open to C<|-> and C<-|> are unsupported. (Win32, S<RISC OS>)
1827
1828Opening a process does not automatically flush output handles on some
1829platforms. (SunOS, Solaris, HP-UX)
1830
1831=item readlink
1832
1833Not implemented. (Win32, VMS, S<RISC OS>)
1834
1835=item rename
1836
1837Can't move directories between directories on different logical volumes. (Win32)
1838
1839=item select
1840
1841Only implemented on sockets. (Win32, VMS)
1842
1843Only reliable on sockets. (S<RISC OS>)
1844
1845Note that the C<select FILEHANDLE> form is generally portable.
1846
1847=item semctl
1848
1849=item semget
1850
1851=item semop
1852
1853Not implemented. ( Win32, VMS, S<RISC OS>, VOS)
1854
1855=item setgrent
1856
1857Not implemented. (MPE/iX, VMS, Win32, S<RISC OS>, VOS)
1858
1859=item setpgrp
1860
1861Not implemented. (Win32, VMS, S<RISC OS>, VOS)
1862
1863=item setpriority
1864
1865Not implemented. (Win32, VMS, S<RISC OS>, VOS)
1866
1867=item setpwent
1868
1869Not implemented. (MPE/iX, Win32, S<RISC OS>, VOS)
1870
1871=item setsockopt
1872
1873Not implemented. (S<Plan 9>)
1874
1875=item shmctl
1876
1877=item shmget
1878
1879=item shmread
1880
1881=item shmwrite
1882
1883Not implemented. (Win32, VMS, S<RISC OS>, VOS)
1884
1885=item sockatmark
1886
1887A relatively recent addition to socket functions, may not
1888be implemented even in UNIX platforms.
1889
1890=item socketpair
1891
1892Not implemented. (S<RISC OS>, VOS, VM/ESA)
1893
1894Available on 64 bit OpenVMS 8.2 and later. (VMS)
1895
1896=item stat
1897
1898Platforms that do not have rdev, blksize, or blocks will return these
1899as '', so numeric comparison or manipulation of these fields may cause
1900'not numeric' warnings.
1901
1902ctime not supported on UFS (S<Mac OS X>).
1903
1904ctime is creation time instead of inode change time (Win32).
1905
1906device and inode are not meaningful. (Win32)
1907
1908device and inode are not necessarily reliable. (VMS)
1909
1910mtime, atime and ctime all return the last modification time. Device and
1911inode are not necessarily reliable. (S<RISC OS>)
1912
1913dev, rdev, blksize, and blocks are not available. inode is not
1914meaningful and will differ between stat calls on the same file. (os2)
1915
1916some versions of cygwin when doing a stat("foo") and if not finding it
1917may then attempt to stat("foo.exe") (Cygwin)
1918
1919On Win32 stat() needs to open the file to determine the link count
1920and update attributes that may have been changed through hard links.
1921Setting ${^WIN32_SLOPPY_STAT} to a true value speeds up stat() by
1922not performing this operation. (Win32)
1923
1924=item symlink
1925
1926Not implemented. (Win32, S<RISC OS>)
1927
1928Implemented on 64 bit VMS 8.3. VMS requires the symbolic link to be in Unix
1929syntax if it is intended to resolve to a valid path.
1930
1931=item syscall
1932
1933Not implemented. (Win32, VMS, S<RISC OS>, VOS, VM/ESA)
1934
1935=item sysopen
1936
1937The traditional "0", "1", and "2" MODEs are implemented with different
1938numeric values on some systems. The flags exported by C<Fcntl>
1939(O_RDONLY, O_WRONLY, O_RDWR) should work everywhere though. (S<Mac
1940OS>, OS/390, VM/ESA)
1941
1942=item system
1943
1944As an optimization, may not call the command shell specified in
1945C<$ENV{PERL5SHELL}>. C<system(1, @args)> spawns an external
1946process and immediately returns its process designator, without
1947waiting for it to terminate. Return value may be used subsequently
1948in C<wait> or C<waitpid>. Failure to spawn() a subprocess is indicated
1949by setting $? to "255 << 8". C<$?> is set in a way compatible with
1950Unix (i.e. the exitstatus of the subprocess is obtained by "$? >> 8",
1951as described in the documentation). (Win32)
1952
1953There is no shell to process metacharacters, and the native standard is
1954to pass a command line terminated by "\n" "\r" or "\0" to the spawned
1955program. Redirection such as C<< > foo >> is performed (if at all) by
1956the run time library of the spawned program. C<system> I<list> will call
1957the Unix emulation library's C<exec> emulation, which attempts to provide
1958emulation of the stdin, stdout, stderr in force in the parent, providing
1959the child program uses a compatible version of the emulation library.
1960I<scalar> will call the native command line direct and no such emulation
1961of a child Unix program will exists. Mileage B<will> vary. (S<RISC OS>)
1962
1963Does not automatically flush output handles on some platforms.
1964(SunOS, Solaris, HP-UX)
1965
1966The return value is POSIX-like (shifted up by 8 bits), which only allows
1967room for a made-up value derived from the severity bits of the native
196832-bit condition code (unless overridden by C<use vmsish 'status'>).
1969If the native condition code is one that has a POSIX value encoded, the
1970POSIX value will be decoded to extract the expected exit value.
1971For more details see L<perlvms/$?>. (VMS)
1972
1973=item times
1974
1975"cumulative" times will be bogus. On anything other than Windows NT
1976or Windows 2000, "system" time will be bogus, and "user" time is
1977actually the time returned by the clock() function in the C runtime
1978library. (Win32)
1979
1980Not useful. (S<RISC OS>)
1981
1982=item truncate
1983
1984Not implemented. (Older versions of VMS)
1985
1986Truncation to same-or-shorter lengths only. (VOS)
1987
1988If a FILEHANDLE is supplied, it must be writable and opened in append
1989mode (i.e., use C<<< open(FH, '>>filename') >>>
1990or C<sysopen(FH,...,O_APPEND|O_RDWR)>. If a filename is supplied, it
1991should not be held open elsewhere. (Win32)
1992
1993=item umask
1994
1995Returns undef where unavailable, as of version 5.005.
1996
1997C<umask> works but the correct permissions are set only when the file
1998is finally closed. (AmigaOS)
1999
2000=item utime
2001
2002Only the modification time is updated. (S<BeOS>, VMS, S<RISC OS>)
2003
2004May not behave as expected. Behavior depends on the C runtime
2005library's implementation of utime(), and the filesystem being
2006used. The FAT filesystem typically does not support an "access
2007time" field, and it may limit timestamps to a granularity of
2008two seconds. (Win32)
2009
2010=item wait
2011
2012=item waitpid
2013
2014Can only be applied to process handles returned for processes spawned
2015using C<system(1, ...)> or pseudo processes created with C<fork()>. (Win32)
2016
2017Not useful. (S<RISC OS>)
2018
2019=back
2020
2021
2022=head1 Supported Platforms (Perl 5.12)
2023
2024
2025As of _____ 20??, (The release of Perl 5.12), the following platforms are
2026known to build Perl from the standard source code distribution available
2027at http://www.cpan.org/src
2028
2029
2030=over
2031
2032=item Linux (x86, ARM, IA64)
2033
2034=item HP-UX
2035
2036=item AIX
2037
2038=item Win32
2039
2040=over
2041
2042=item Windows 2000
2043
2044=item Windows XP
2045
2046=item Windows Server 2003
2047
2048=item Windows Vista
2049
2050=item Windows Server 2008
2051
2052=item Windows 7
2053
2054=back
2055
2056=item Cygwin
2057
2058=item Solaris (x86, SPARC)
2059
2060=item OpenVMS
2061
2062=over
2063
2064=item Alpha (7.2 and later)
2065
2066=item I64 (8.2 and later)
2067
2068=back
2069
2070=item Symbian
2071
2072=item NetBSD
2073
2074=item FreeBSD
2075
2076=item Haiku
2077
2078=item Irix (6.5. What else?)
2079
2080=item OpenBSD
2081
2082=item Dragonfly BSD
2083
2084=item MirOS BSD
2085
2086Caveats:
2087
2088=over
2089
2090=item time_t issues that may or may not be fixed
2091
2092=back
2093
2094
2095=item Symbian (Series 60 v3, 3.2 and 5 - what else?)
2096
2097=item Stratus VOS
2098
2099=item AIX
2100
2101=back
2102
2103=head1 EOL Platforms (Perl 5.12)
2104
2105The following platforms were supported by a previous version of
2106Perl but have been officially removed from Perl's source code
2107as of 5.12:
2108
2109=over
2110
2111=item Atari MiNT
2112
2113=item Apollo Domain/OS
2114
2115=item Apple Mac OS 8/9
2116
2117=item Tenon Machten
2118
2119=back
2120
2121The following platforms may still work as of Perl 5.12, but Perl's
2122developers have made an explicit decision to discontinue support for
2123them:
2124
2125=over
2126
2127=item Windows 95
2128
2129=item Windows 98
2130
2131=item Windows ME
2132
2133=item Windows NT4
2134
2135=back
2136
2137=head1 Supported Platforms (Perl 5.8)
2138
2139As of July 2002 (the Perl release 5.8.0), the following platforms were
2140able to build Perl from the standard source code distribution
2141available at http://www.cpan.org/src/
2142
2143 AIX
2144 BeOS
2145 BSD/OS (BSDi)
2146 Cygwin
2147 DG/UX
2148 DOS DJGPP 1)
2149 DYNIX/ptx
2150 EPOC R5
2151 FreeBSD
2152 HI-UXMPP (Hitachi) (5.8.0 worked but we didn't know it)
2153 HP-UX
2154 IRIX
2155 Linux
2156 Mac OS Classic
2157 Mac OS X (Darwin)
2158 MPE/iX
2159 NetBSD
2160 NetWare
2161 NonStop-UX
2162 ReliantUNIX (formerly SINIX)
2163 OpenBSD
2164 OpenVMS (formerly VMS)
2165 Open UNIX (Unixware) (since Perl 5.8.1/5.9.0)
2166 OS/2
2167 OS/400 (using the PASE) (since Perl 5.8.1/5.9.0)
2168 PowerUX
2169 POSIX-BC (formerly BS2000)
2170 QNX
2171 Solaris
2172 SunOS 4
2173 SUPER-UX (NEC)
2174 Tru64 UNIX (formerly DEC OSF/1, Digital UNIX)
2175 UNICOS
2176 UNICOS/mk
2177 UTS
2178 VOS
2179 Win95/98/ME/2K/XP 2)
2180 WinCE
2181 z/OS (formerly OS/390)
2182 VM/ESA
2183
2184 1) in DOS mode either the DOS or OS/2 ports can be used
2185 2) compilers: Borland, MinGW (GCC), VC6
2186
2187The following platforms worked with the previous releases (5.6 and
21885.7), but we did not manage either to fix or to test these in time
2189for the 5.8.0 release. There is a very good chance that many of these
2190will work fine with the 5.8.0.
2191
2192 BSD/OS
2193 DomainOS
2194 Hurd
2195 LynxOS
2196 MachTen
2197 PowerMAX
2198 SCO SV
2199 SVR4
2200 Unixware
2201 Windows 3.1
2202
2203Known to be broken for 5.8.0 (but 5.6.1 and 5.7.2 can be used):
2204
2205 AmigaOS
2206
2207The following platforms have been known to build Perl from source in
2208the past (5.005_03 and earlier), but we haven't been able to verify
2209their status for the current release, either because the
2210hardware/software platforms are rare or because we don't have an
2211active champion on these platforms--or both. They used to work,
2212though, so go ahead and try compiling them, and let perlbug@perl.org
2213of any trouble.
2214
2215 3b1
2216 A/UX
2217 ConvexOS
2218 CX/UX
2219 DC/OSx
2220 DDE SMES
2221 DOS EMX
2222 Dynix
2223 EP/IX
2224 ESIX
2225 FPS
2226 GENIX
2227 Greenhills
2228 ISC
2229 MachTen 68k
2230 MPC
2231 NEWS-OS
2232 NextSTEP
2233 OpenSTEP
2234 Opus
2235 Plan 9
2236 RISC/os
2237 SCO ODT/OSR
2238 Stellar
2239 SVR2
2240 TI1500
2241 TitanOS
2242 Ultrix
2243 Unisys Dynix
2244
2245The following platforms have their own source code distributions and
2246binaries available via http://www.cpan.org/ports/
2247
2248 Perl release
2249
2250 OS/400 (ILE) 5.005_02
2251 Tandem Guardian 5.004
2252
2253The following platforms have only binaries available via
2254http://www.cpan.org/ports/index.html :
2255
2256 Perl release
2257
2258 Acorn RISCOS 5.005_02
2259 AOS 5.002
2260 LynxOS 5.004_02
2261
2262Although we do suggest that you always build your own Perl from
2263the source code, both for maximal configurability and for security,
2264in case you are in a hurry you can check
2265http://www.cpan.org/ports/index.html for binary distributions.
2266
2267=head1 SEE ALSO
2268
2269L<perlaix>, L<perlamiga>, L<perlapollo>, L<perlbeos>, L<perlbs2000>,
2270L<perlce>, L<perlcygwin>, L<perldgux>, L<perldos>, L<perlepoc>,
2271L<perlebcdic>, L<perlfreebsd>, L<perlhurd>, L<perlhpux>, L<perlirix>,
2272L<perlmacos>, L<perlmacosx>, L<perlmpeix>,
2273L<perlnetware>, L<perlos2>, L<perlos390>, L<perlos400>,
2274L<perlplan9>, L<perlqnx>, L<perlsolaris>, L<perltru64>,
2275L<perlunicode>, L<perlvmesa>, L<perlvms>, L<perlvos>,
2276L<perlwin32>, and L<Win32>.
2277
2278=head1 AUTHORS / CONTRIBUTORS
2279
2280Abigail <abigail@foad.org>,
2281Charles Bailey <bailey@newman.upenn.edu>,
2282Graham Barr <gbarr@pobox.com>,
2283Tom Christiansen <tchrist@perl.com>,
2284Nicholas Clark <nick@ccl4.org>,
2285Thomas Dorner <Thomas.Dorner@start.de>,
2286Andy Dougherty <doughera@lafayette.edu>,
2287Dominic Dunlop <domo@computer.org>,
2288Neale Ferguson <neale@vma.tabnsw.com.au>,
2289David J. Fiander <davidf@mks.com>,
2290Paul Green <Paul.Green@stratus.com>,
2291M.J.T. Guy <mjtg@cam.ac.uk>,
2292Jarkko Hietaniemi <jhi@iki.fi>,
2293Luther Huffman <lutherh@stratcom.com>,
2294Nick Ing-Simmons <nick@ing-simmons.net>,
2295Andreas J. KE<ouml>nig <a.koenig@mind.de>,
2296Markus Laker <mlaker@contax.co.uk>,
2297Andrew M. Langmead <aml@world.std.com>,
2298Larry Moore <ljmoore@freespace.net>,
2299Paul Moore <Paul.Moore@uk.origin-it.com>,
2300Chris Nandor <pudge@pobox.com>,
2301Matthias Neeracher <neeracher@mac.com>,
2302Philip Newton <pne@cpan.org>,
2303Gary Ng <71564.1743@CompuServe.COM>,
2304Tom Phoenix <rootbeer@teleport.com>,
2305AndrE<eacute> Pirard <A.Pirard@ulg.ac.be>,
2306Peter Prymmer <pvhp@forte.com>,
2307Hugo van der Sanden <hv@crypt0.demon.co.uk>,
2308Gurusamy Sarathy <gsar@activestate.com>,
2309Paul J. Schinder <schinder@pobox.com>,
2310Michael G Schwern <schwern@pobox.com>,
2311Dan Sugalski <dan@sidhe.org>,
2312Nathan Torkington <gnat@frii.com>.
2313John Malmberg <wb8tyw@qsl.net>