source: for-distributions/trunk/bin/windows/perl/lib/Pod/perlport.pod@ 14489

Last change on this file since 14489 was 14489, checked in by oranfry, 17 years ago

upgrading to perl 5.8

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