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