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