.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13 .\" .\" Standard preamble: .\" ======================================================================== .de Sh \" Subsection heading .br .if t .Sp .ne 5 .PP \fB\\$1\fR .PP .. .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. | will give a .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' .\" expand to `' in nroff, nothing in troff, for use with C<>. .tr \(*W-|\(bv\*(Tr .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .\" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .hy 0 .if n .na .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "PERLPORT 1" .TH PERLPORT 1 "2002-11-24" "perl v5.8.0" "Perl Programmers Reference Guide" .SH "NAME" perlport \- Writing portable Perl .SH "DESCRIPTION" .IX Header "DESCRIPTION" Perl runs on numerous operating systems. While most of them share much in common, they also have their own unique features. .PP This document is meant to help you to find out what constitutes portable Perl code. That way once you make a decision to write portably, you know where the lines are drawn, and you can stay within them. .PP There is a tradeoff between taking full advantage of one particular type of computer and taking advantage of a full range of them. Naturally, as you broaden your range and become more diverse, the common factors drop, and you are left with an increasingly smaller area of common ground in which you can operate to accomplish a particular task. Thus, when you begin attacking a problem, it is important to consider under which part of the tradeoff curve you want to operate. Specifically, you must decide whether it is important that the task that you are coding have the full generality of being portable, or whether to just get the job done right now. This is the hardest choice to be made. The rest is easy, because Perl provides many choices, whichever way you want to approach your problem. .PP Looking at it another way, writing portable code is usually about willfully limiting your available choices. Naturally, it takes discipline and sacrifice to do that. The product of portability and convenience may be a constant. You have been warned. .PP Be aware of two important points: .IP "Not all Perl programs have to be portable" 4 .IX Item "Not all Perl programs have to be portable" There is no reason you should not use Perl as a language to glue Unix tools together, or to prototype a Macintosh application, or to manage the Windows registry. If it makes no sense to aim for portability for one reason or another in a given program, then don't bother. .IP "Nearly all of Perl already \fIis\fR portable" 4 .IX Item "Nearly all of Perl already is portable" Don't be fooled into thinking that it is hard to create portable Perl code. It isn't. Perl tries its level-best to bridge the gaps between what's available on different platforms, and all the means available to use those features. Thus almost all Perl code runs on any machine without modification. But there are some significant issues in writing portable code, and this document is entirely about those issues. .PP Here's the general rule: When you approach a task commonly done using a whole range of platforms, think about writing portable code. That way, you don't sacrifice much by way of the implementation choices you can avail yourself of, and at the same time you can give your users lots of platform choices. On the other hand, when you have to take advantage of some unique feature of a particular platform, as is often the case with systems programming (whether for Unix, Windows, Mac\ \s-1OS\s0, \s-1VMS\s0, etc.), consider writing platform-specific code. .PP When the code will run on only two or three operating systems, you may need to consider only the differences of those particular systems. The important thing is to decide where the code will run and to be deliberate in your decision. .PP The material below is separated into three main sections: main issues of portability (\*(L"\s-1ISSUES\s0\*(R", platform-specific issues (\*(L"\s-1PLATFORMS\s0\*(R", and built-in perl functions that behave differently on various ports (\*(L"\s-1FUNCTION\s0 \s-1IMPLEMENTATIONS\s0\*(R". .PP This information should not be considered complete; it includes possibly transient information about idiosyncrasies of some of the ports, almost all of which are in a state of constant evolution. Thus, this material should be considered a perpetual work in progress (\f(CW\*(C`Under Construction\*(C'\fR). .SH "ISSUES" .IX Header "ISSUES" .Sh "Newlines" .IX Subsection "Newlines" In most operating systems, lines in files are terminated by newlines. Just what is used as a newline may vary from \s-1OS\s0 to \s-1OS\s0. Unix traditionally uses \f(CW\*(C`\e012\*(C'\fR, one type of DOSish I/O uses \f(CW\*(C`\e015\e012\*(C'\fR, and Mac\ \s-1OS\s0 uses \f(CW\*(C`\e015\*(C'\fR. .PP Perl uses \f(CW\*(C`\en\*(C'\fR to represent the \*(L"logical\*(R" newline, where what is logical may depend on the platform in use. In MacPerl, \f(CW\*(C`\en\*(C'\fR always means \f(CW\*(C`\e015\*(C'\fR. In DOSish perls, \f(CW\*(C`\en\*(C'\fR usually means \f(CW\*(C`\e012\*(C'\fR, but when accessing a file in \*(L"text\*(R" mode, \s-1STDIO\s0 translates it to (or from) \f(CW\*(C`\e015\e012\*(C'\fR, depending on whether you're reading or writing. Unix does the same thing on ttys in canonical mode. \f(CW\*(C`\e015\e012\*(C'\fR is commonly referred to as \s-1CRLF\s0. .PP A common cause of unportable programs is the misuse of \fIchop()\fR to trim newlines: .PP .Vb 6 \& # XXX UNPORTABLE! \& while() { \& chop; \& @array = split(/:/); \& #... \& } .Ve .PP You can get away with this on Unix and Mac \s-1OS\s0 (they have a single character end\-of\-line), but the same program will break under DOSish perls because you're only \fIchop()\fRing half the end\-of\-line. Instead, \&\fIchomp()\fR should be used to trim newlines. The Dunce::Files module can help audit your code for misuses of \fIchop()\fR. .PP When dealing with binary files (or text files in binary mode) be sure to explicitly set $/ to the appropriate value for your file format before using \fIchomp()\fR. .PP Because of the \*(L"text\*(R" mode translation, DOSish perls have limitations in using \f(CW\*(C`seek\*(C'\fR and \f(CW\*(C`tell\*(C'\fR on a file accessed in \*(L"text\*(R" mode. Stick to \f(CW\*(C`seek\*(C'\fR\-ing to locations you got from \f(CW\*(C`tell\*(C'\fR (and no others), and you are usually free to use \f(CW\*(C`seek\*(C'\fR and \f(CW\*(C`tell\*(C'\fR even in \*(L"text\*(R" mode. Using \f(CW\*(C`seek\*(C'\fR or \f(CW\*(C`tell\*(C'\fR or other file operations may be non\-portable. If you use \f(CW\*(C`binmode\*(C'\fR on a file, however, you can usually \f(CW\*(C`seek\*(C'\fR and \f(CW\*(C`tell\*(C'\fR with arbitrary values in safety. .PP A common misconception in socket programming is that \f(CW\*(C`\en\*(C'\fR eq \f(CW\*(C`\e012\*(C'\fR everywhere. When using protocols such as common Internet protocols, \&\f(CW\*(C`\e012\*(C'\fR and \f(CW\*(C`\e015\*(C'\fR are called for specifically, and the values of the logical \f(CW\*(C`\en\*(C'\fR and \f(CW\*(C`\er\*(C'\fR (carriage return) are not reliable. .PP .Vb 2 \& print SOCKET "Hi there, client!\er\en"; # WRONG \& print SOCKET "Hi there, client!\e015\e012"; # RIGHT .Ve .PP However, using \f(CW\*(C`\e015\e012\*(C'\fR (or \f(CW\*(C`\ecM\ecJ\*(C'\fR, or \f(CW\*(C`\ex0D\ex0A\*(C'\fR) can be tedious and unsightly, as well as confusing to those maintaining the code. As such, the Socket module supplies the Right Thing for those who want it. .PP .Vb 2 \& use Socket qw(:DEFAULT :crlf); \& print SOCKET "Hi there, client!$CRLF" # RIGHT .Ve .PP When reading from a socket, remember that the default input record separator \f(CW$/\fR is \f(CW\*(C`\en\*(C'\fR, but robust socket code will recognize as either \f(CW\*(C`\e012\*(C'\fR or \f(CW\*(C`\e015\e012\*(C'\fR as end of line: .PP .Vb 3 \& while () { \& # ... \& } .Ve .PP Because both \s-1CRLF\s0 and \s-1LF\s0 end in \s-1LF\s0, the input record separator can be set to \s-1LF\s0 and any \s-1CR\s0 stripped later. Better to write: .PP .Vb 2 \& use Socket qw(:DEFAULT :crlf); \& local($/) = LF; # not needed if $/ is already \e012 .Ve .PP .Vb 4 \& while () { \& s/$CR?$LF/\en/; # not sure if socket uses LF or CRLF, OK \& # s/\e015?\e012/\en/; # same thing \& } .Ve .PP This example is preferred over the previous one\*(--even for Unix platforms\*(--because now any \f(CW\*(C`\e015\*(C'\fR's (\f(CW\*(C`\ecM\*(C'\fR's) are stripped out (and there was much rejoicing). .PP Similarly, functions that return text data\*(--such as a function that fetches a web page\*(--should sometimes translate newlines before returning the data, if they've not yet been translated to the local newline representation. A single line of code will often suffice: .PP .Vb 2 \& $data =~ s/\e015?\e012/\en/g; \& return $data; .Ve .PP Some of this may be confusing. Here's a handy reference to the \s-1ASCII\s0 \s-1CR\s0 and \s-1LF\s0 characters. You can print it out and stick it in your wallet. .PP .Vb 2 \& LF eq \e012 eq \ex0A eq \ecJ eq chr(10) eq ASCII 10 \& CR eq \e015 eq \ex0D eq \ecM eq chr(13) eq ASCII 13 .Ve .PP .Vb 8 \& | Unix | DOS | Mac | \& --------------------------- \& \en | LF | LF | CR | \& \er | CR | CR | LF | \& \en * | LF | CRLF | CR | \& \er * | CR | CR | LF | \& --------------------------- \& * text-mode STDIO .Ve .PP The Unix column assumes that you are not accessing a serial line (like a tty) in canonical mode. If you are, then \s-1CR\s0 on input becomes \&\*(L"\en\*(R", and \*(L"\en\*(R" on output becomes \s-1CRLF\s0. .PP These are just the most common definitions of \f(CW\*(C`\en\*(C'\fR and \f(CW\*(C`\er\*(C'\fR in Perl. There may well be others. For example, on an \s-1EBCDIC\s0 implementation such as z/OS or \s-1OS/400\s0 the above material is similar to \*(L"Unix\*(R" but the code numbers change: .PP .Vb 4 \& LF eq \e025 eq \ex15 eq chr(21) eq CP-1047 21 \& LF eq \e045 eq \ex25 eq \ecU eq chr(37) eq CP-0037 37 \& CR eq \e015 eq \ex0D eq \ecM eq chr(13) eq CP-1047 13 \& CR eq \e015 eq \ex0D eq \ecM eq chr(13) eq CP-0037 13 .Ve .PP .Vb 8 \& | z/OS | OS/400 | \& ---------------------- \& \en | LF | LF | \& \er | CR | CR | \& \en * | LF | LF | \& \er * | CR | CR | \& ---------------------- \& * text-mode STDIO .Ve .Sh "Numbers endianness and Width" .IX Subsection "Numbers endianness and Width" Different CPUs store integers and floating point numbers in different orders (called \fIendianness\fR) and widths (32\-bit and 64\-bit being the most common today). This affects your programs when they attempt to transfer numbers in binary format from one \s-1CPU\s0 architecture to another, usually either \*(L"live\*(R" via network connection, or by storing the numbers to secondary storage such as a disk file or tape. .PP Conflicting storage orders make utter mess out of the numbers. If a little-endian host (Intel, \s-1VAX\s0) stores 0x12345678 (305419896 in decimal), a big-endian host (Motorola, Sparc, \s-1PA\s0) reads it as 0x78563412 (2018915346 in decimal). Alpha and \s-1MIPS\s0 can be either: Digital/Compaq used/uses them in little-endian mode; SGI/Cray uses them in big-endian mode. To avoid this problem in network (socket) connections use the \f(CW\*(C`pack\*(C'\fR and \f(CW\*(C`unpack\*(C'\fR formats \f(CW\*(C`n\*(C'\fR and \f(CW\*(C`N\*(C'\fR, the \&\*(L"network\*(R" orders. These are guaranteed to be portable. .PP You can explore the endianness of your platform by unpacking a data structure packed in native format such as: .PP .Vb 3 \& print unpack("h*", pack("s2", 1, 2)), "\en"; \& # '10002000' on e.g. Intel x86 or Alpha 21064 in little-endian mode \& # '00100020' on e.g. Motorola 68040 .Ve .PP If you need to distinguish between endian architectures you could use either of the variables set like so: .PP .Vb 2 \& $is_big_endian = unpack("h*", pack("s", 1)) =~ /01/; \& $is_little_endian = unpack("h*", pack("s", 1)) =~ /^1/; .Ve .PP Differing widths can cause truncation even between platforms of equal endianness. The platform of shorter width loses the upper parts of the number. There is no good solution for this problem except to avoid transferring or storing raw binary numbers. .PP One can circumnavigate both these problems in two ways. Either transfer and store numbers always in text format, instead of raw binary, or else consider using modules like Data::Dumper (included in the standard distribution as of Perl 5.005) and Storable (included as of perl 5.8). Keeping all data as text significantly simplifies matters. .PP The v\-strings are portable only up to v2147483647 (0x7FFFFFFF), that's how far \s-1EBCDIC\s0, or more precisely UTF-EBCDIC will go. .Sh "Files and Filesystems" .IX Subsection "Files and Filesystems" Most platforms these days structure files in a hierarchical fashion. So, it is reasonably safe to assume that all platforms support the notion of a \*(L"path\*(R" to uniquely identify a file on the system. How that path is really written, though, differs considerably. .PP Although similar, file path specifications differ between Unix, Windows, Mac\ \s-1OS\s0, \s-1OS/2\s0, \s-1VMS\s0, \s-1VOS\s0, \s-1RISC\s0\ \s-1OS\s0, and probably others. Unix, for example, is one of the few OSes that has the elegant idea of a single root directory. .PP \&\s-1DOS\s0, \s-1OS/2\s0, \s-1VMS\s0, \s-1VOS\s0, and Windows can work similarly to Unix with \f(CW\*(C`/\*(C'\fR as path separator, or in their own idiosyncratic ways (such as having several root directories and various \*(L"unrooted\*(R" device files such \s-1NIL:\s0 and \s-1LPT:\s0). .PP Mac\ \s-1OS\s0 uses \f(CW\*(C`:\*(C'\fR as a path separator instead of \f(CW\*(C`/\*(C'\fR. .PP The filesystem may support neither hard links (\f(CW\*(C`link\*(C'\fR) nor symbolic links (\f(CW\*(C`symlink\*(C'\fR, \f(CW\*(C`readlink\*(C'\fR, \f(CW\*(C`lstat\*(C'\fR). .PP The filesystem may support neither access timestamp nor change timestamp (meaning that about the only portable timestamp is the modification timestamp), or one second granularity of any timestamps (e.g. the \s-1FAT\s0 filesystem limits the time granularity to two seconds). .PP The \*(L"inode change timestamp\*(R" (the \f(CW\*(C`\-C\*(C'\fR filetest) may really be the \&\*(L"creation timestamp\*(R" (which it is not in \s-1UNIX\s0). .PP \&\s-1VOS\s0 perl can emulate Unix filenames with \f(CW\*(C`/\*(C'\fR as path separator. The native pathname characters greater\-than, less\-than, number\-sign, and percent-sign are always accepted. .PP \&\s-1RISC\s0\ \s-1OS\s0 perl can emulate Unix filenames with \f(CW\*(C`/\*(C'\fR as path separator, or go native and use \f(CW\*(C`.\*(C'\fR for path separator and \f(CW\*(C`:\*(C'\fR to signal filesystems and disk names. .PP Don't assume \s-1UNIX\s0 filesystem access semantics: that read, write, and execute are all the permissions there are, and even if they exist, that their semantics (for example what do r, w, and x mean on a directory) are the \s-1UNIX\s0 ones. The various \s-1UNIX/POSIX\s0 compatibility layers usually try to make interfaces like \fIchmod()\fR work, but sometimes there simply is no good mapping. .PP If all this is intimidating, have no (well, maybe only a little) fear. There are modules that can help. The File::Spec modules provide methods to do the Right Thing on whatever platform happens to be running the program. .PP .Vb 6 \& use File::Spec::Functions; \& chdir(updir()); # go up one directory \& $file = catfile(curdir(), 'temp', 'file.txt'); \& # on Unix and Win32, './temp/file.txt' \& # on Mac OS, ':temp:file.txt' \& # on VMS, '[.temp]file.txt' .Ve .PP File::Spec is available in the standard distribution as of version 5.004_05. File::Spec::Functions is only in File::Spec 0.7 and later, and some versions of perl come with version 0.6. If File::Spec is not updated to 0.7 or later, you must use the object-oriented interface from File::Spec (or upgrade File::Spec). .PP In general, production code should not have file paths hardcoded. Making them user-supplied or read from a configuration file is better, keeping in mind that file path syntax varies on different machines. .PP This is especially noticeable in scripts like Makefiles and test suites, which often assume \f(CW\*(C`/\*(C'\fR as a path separator for subdirectories. .PP Also of use is File::Basename from the standard distribution, which splits a pathname into pieces (base filename, full path to directory, and file suffix). .PP Even when on a single platform (if you can call Unix a single platform), remember not to count on the existence or the contents of particular system-specific files or directories, like \fI/etc/passwd\fR, \&\fI/etc/sendmail.conf\fR, \fI/etc/resolv.conf\fR, or even \fI/tmp/\fR. For example, \fI/etc/passwd\fR may exist but not contain the encrypted passwords, because the system is using some form of enhanced security. Or it may not contain all the accounts, because the system is using \s-1NIS\s0. If code does need to rely on such a file, include a description of the file and its format in the code's documentation, then make it easy for the user to override the default location of the file. .PP Don't assume a text file will end with a newline. They should, but people forget. .PP Do not have two files or directories of the same name with different case, like \fItest.pl\fR and \fITest.pl\fR, as many platforms have case-insensitive (or at least case\-forgiving) filenames. Also, try not to have non-word characters (except for \f(CW\*(C`.\*(C'\fR) in the names, and keep them to the 8.3 convention, for maximum portability, onerous a burden though this may appear. .PP Likewise, when using the AutoSplit module, try to keep your functions to 8.3 naming and case-insensitive conventions; or, at the least, make it so the resulting files have a unique (case\-insensitively) first 8 characters. .PP Whitespace in filenames is tolerated on most systems, but not all, and even on systems where it might be tolerated, some utilities might become confused by such whitespace. .PP Many systems (\s-1DOS\s0, \s-1VMS\s0) cannot have more than one \f(CW\*(C`.\*(C'\fR in their filenames. .PP Don't assume \f(CW\*(C`>\*(C'\fR won't be the first character of a filename. Always use \f(CW\*(C`<\*(C'\fR explicitly to open a file for reading, or even better, use the three-arg version of open, unless you want the user to be able to specify a pipe open. .PP .Vb 1 \& open(FILE, '<', $existing_file) or die $!; .Ve .PP If filenames might use strange characters, it is safest to open it with \f(CW\*(C`sysopen\*(C'\fR instead of \f(CW\*(C`open\*(C'\fR. \f(CW\*(C`open\*(C'\fR is magic and can translate characters like \f(CW\*(C`>\*(C'\fR, \f(CW\*(C`<\*(C'\fR, and \f(CW\*(C`|\*(C'\fR, which may be the wrong thing to do. (Sometimes, though, it's the right thing.) Three-arg open can also help protect against this translation in cases where it is undesirable. .PP Don't use \f(CW\*(C`:\*(C'\fR as a part of a filename since many systems use that for their own semantics (Mac \s-1OS\s0 Classic for separating pathname components, many networking schemes and utilities for separating the nodename and the pathname, and so on). For the same reasons, avoid \f(CW\*(C`@\*(C'\fR, \f(CW\*(C`;\*(C'\fR and \&\f(CW\*(C`|\*(C'\fR. .PP Don't assume that in pathnames you can collapse two leading slashes \&\f(CW\*(C`//\*(C'\fR into one: some networking and clustering filesystems have special semantics for that. Let the operating system to sort it out. .PP The \fIportable filename characters\fR as defined by \s-1ANSI\s0 C are .PP .Vb 4 \& 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 \& 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 \& 0 1 2 3 4 5 6 7 8 9 \& . _ - .Ve .PP and the \*(L"\-\*(R" shouldn't be the first character. If you want to be hypercorrect, stay case-insensitive and within the 8.3 naming convention (all the files and directories have to be unique within one directory if their names are lowercased and truncated to eight characters before the \f(CW\*(C`.\*(C'\fR, if any, and to three characters after the \&\f(CW\*(C`.\*(C'\fR, if any). (And do not use \f(CW\*(C`.\*(C'\fRs in directory names.) .Sh "System Interaction" .IX Subsection "System Interaction" Not all platforms provide a command line. These are usually platforms that rely primarily on a Graphical User Interface (\s-1GUI\s0) for user interaction. A program requiring a command line interface might not work everywhere. This is probably for the user of the program to deal with, so don't stay up late worrying about it. .PP Some platforms can't delete or rename files held open by the system. Remember to \f(CW\*(C`close\*(C'\fR files when you are done with them. Don't \&\f(CW\*(C`unlink\*(C'\fR or \f(CW\*(C`rename\*(C'\fR an open file. Don't \f(CW\*(C`tie\*(C'\fR or \f(CW\*(C`open\*(C'\fR a file already tied or opened; \f(CW\*(C`untie\*(C'\fR or \f(CW\*(C`close\*(C'\fR it first. .PP Don't open the same file more than once at a time for writing, as some operating systems put mandatory locks on such files. .PP Don't assume that write/modify permission on a directory gives the right to add or delete files/directories in that directory. That is filesystem specific: in some filesystems you need write/modify permission also (or even just) in the file/directory itself. In some filesystems (\s-1AFS\s0, \s-1DFS\s0) the permission to add/delete directory entries is a completely separate permission. .PP Don't assume that a single \f(CW\*(C`unlink\*(C'\fR completely gets rid of the file: some filesystems (most notably the ones in \s-1VMS\s0) have versioned filesystems, and \fIunlink()\fR removes only the most recent one (it doesn't remove all the versions because by default the native tools on those platforms remove just the most recent version, too). The portable idiom to remove all the versions of a file is .PP .Vb 1 \& 1 while unlink "file"; .Ve .PP This will terminate if the file is undeleteable for some reason (protected, not there, and so on). .PP Don't count on a specific environment variable existing in \f(CW%ENV\fR. Don't count on \f(CW%ENV\fR entries being case\-sensitive, or even case\-preserving. Don't try to clear \f(CW%ENV\fR by saying \f(CW\*(C`%ENV = ();\*(C'\fR, or, if you really have to, make it conditional on \f(CW\*(C`$^O ne 'VMS'\*(C'\fR since in \&\s-1VMS\s0 the \f(CW%ENV\fR table is much more than a per-process key-value string table. .PP Don't count on signals or \f(CW%SIG\fR for anything. .PP Don't count on filename globbing. Use \f(CW\*(C`opendir\*(C'\fR, \f(CW\*(C`readdir\*(C'\fR, and \&\f(CW\*(C`closedir\*(C'\fR instead. .PP Don't count on per-program environment variables, or per-program current directories. .PP Don't count on specific values of \f(CW$!\fR. .Sh "Command names versus file pathnames" .IX Subsection "Command names versus file pathnames" Don't assume that the name used to invoke a command or program with \&\f(CW\*(C`system\*(C'\fR or \f(CW\*(C`exec\*(C'\fR can also be used to test for the existence of the file that holds the executable code for that command or program. First, many systems have \*(L"internal\*(R" commands that are built-in to the shell or \s-1OS\s0 and while these commands can be invoked, there is no corresponding file. Second, some operating systems (e.g., Cygwin, \&\s-1DJGPP\s0, \s-1OS/2\s0, and \s-1VOS\s0) have required suffixes for executable files; these suffixes are generally permitted on the command name but are not required. Thus, a command like \*(L"perl\*(R" might exist in a file named \&\*(L"perl\*(R", \*(L"perl.exe\*(R", or \*(L"perl.pm\*(R", depending on the operating system. The variable \*(L"_exe\*(R" in the Config module holds the executable suffix, if any. Third, the \s-1VMS\s0 port carefully sets up $^X and \&\f(CW$Config\fR{perlpath} so that no further processing is required. This is just as well, because the matching regular expression used below would then have to deal with a possible trailing version number in the \s-1VMS\s0 file name. .PP To convert $^X to a file pathname, taking account of the requirements of the various operating system possibilities, say: use Config; \f(CW$thisperl\fR = $^X; if ($^O ne '\s-1VMS\s0') {$thisperl .= \f(CW$Config\fR{_exe} unless \f(CW$thisperl\fR =~ m/$Config{_exe}$/i;} .PP To convert \f(CW$Config\fR{perlpath} to a file pathname, say: use Config; \f(CW$thisperl\fR = \f(CW$Config\fR{perlpath}; if ($^O ne '\s-1VMS\s0') {$thisperl .= \f(CW$Config\fR{_exe} unless \f(CW$thisperl\fR =~ m/$Config{_exe}$/i;} .Sh "Interprocess Communication (\s-1IPC\s0)" .IX Subsection "Interprocess Communication (IPC)" In general, don't directly access the system in code meant to be portable. That means, no \f(CW\*(C`system\*(C'\fR, \f(CW\*(C`exec\*(C'\fR, \f(CW\*(C`fork\*(C'\fR, \f(CW\*(C`pipe\*(C'\fR, \&\f(CW``\fR, \f(CW\*(C`qx//\*(C'\fR, \f(CW\*(C`open\*(C'\fR with a \f(CW\*(C`|\*(C'\fR, nor any of the other things that makes being a perl hacker worth being. .PP Commands that launch external processes are generally supported on most platforms (though many of them do not support any type of forking). The problem with using them arises from what you invoke them on. External tools are often named differently on different platforms, may not be available in the same location, might accept different arguments, can behave differently, and often present their results in a platform-dependent way. Thus, you should seldom depend on them to produce consistent results. (Then again, if you're calling \&\fInetstat \-a\fR, you probably don't expect it to run on both Unix and \s-1CP/M\s0.) .PP One especially common bit of Perl code is opening a pipe to \fBsendmail\fR: .PP .Vb 2 \& open(MAIL, '|/usr/lib/sendmail -t') \& or die "cannot fork sendmail: $!"; .Ve .PP This is fine for systems programming when sendmail is known to be available. But it is not fine for many non-Unix systems, and even some Unix systems that may not have sendmail installed. If a portable solution is needed, see the various distributions on \s-1CPAN\s0 that deal with it. Mail::Mailer and Mail::Send in the MailTools distribution are commonly used, and provide several mailing methods, including mail, sendmail, and direct \s-1SMTP\s0 (via Net::SMTP) if a mail transfer agent is not available. Mail::Sendmail is a standalone module that provides simple, platform-independent mailing. .PP The Unix System V \s-1IPC\s0 (\f(CW\*(C`msg*(), sem*(), shm*()\*(C'\fR) is not available even on all Unix platforms. .PP Do not use either the bare result of \f(CW\*(C`pack("N", 10, 20, 30, 40)\*(C'\fR or bare v\-strings (such as \f(CW\*(C`v10.20.30.40\*(C'\fR) to represent IPv4 addresses: both forms just pack the four bytes into network order. That this would be equal to the C language \f(CW\*(C`in_addr\*(C'\fR struct (which is what the socket code internally uses) is not guaranteed. To be portable use the routines of the Socket extension, such as \f(CW\*(C`inet_aton()\*(C'\fR, \&\f(CW\*(C`inet_ntoa()\*(C'\fR, and \f(CW\*(C`sockaddr_in()\*(C'\fR. .PP The rule of thumb for portable code is: Do it all in portable Perl, or use a module (that may internally implement it with platform-specific code, but expose a common interface). .Sh "External Subroutines (\s-1XS\s0)" .IX Subsection "External Subroutines (XS)" \&\s-1XS\s0 code can usually be made to work with any platform, but dependent libraries, header files, etc., might not be readily available or portable, or the \s-1XS\s0 code itself might be platform\-specific, just as Perl code might be. If the libraries and headers are portable, then it is normally reasonable to make sure the \s-1XS\s0 code is portable, too. .PP A different type of portability issue arises when writing \s-1XS\s0 code: availability of a C compiler on the end\-user's system. C brings with it its own portability issues, and writing \s-1XS\s0 code will expose you to some of those. Writing purely in Perl is an easier way to achieve portability. .Sh "Standard Modules" .IX Subsection "Standard Modules" In general, the standard modules work across platforms. Notable exceptions are the \s-1CPAN\s0 module (which currently makes connections to external programs that may not be available), platform-specific modules (like ExtUtils::MM_VMS), and \s-1DBM\s0 modules. .PP There is no one \s-1DBM\s0 module available on all platforms. SDBM_File and the others are generally available on all Unix and DOSish ports, but not in MacPerl, where only NBDM_File and DB_File are available. .PP The good news is that at least some \s-1DBM\s0 module should be available, and AnyDBM_File will use whichever module it can find. Of course, then the code needs to be fairly strict, dropping to the greatest common factor (e.g., not exceeding 1K for each record), so that it will work with any \s-1DBM\s0 module. See AnyDBM_File for more details. .Sh "Time and Date" .IX Subsection "Time and Date" The system's notion of time of day and calendar date is controlled in widely different ways. Don't assume the timezone is stored in \f(CW$ENV{TZ}\fR, and even if it is, don't assume that you can control the timezone through that variable. .PP Don't assume that the epoch starts at 00:00:00, January 1, 1970, because that is \s-1OS\-\s0 and implementation\-specific. It is better to store a date in an unambiguous representation. The \s-1ISO\-8601\s0 standard defines \&\*(L"\s-1YYYY\-MM\-DD\s0\*(R" as the date format. A text representation (like \*(L"1987\-12\-18\*(R") can be easily converted into an OS-specific value using a module like Date::Parse. An array of values, such as those returned by \&\f(CW\*(C`localtime\*(C'\fR, can be converted to an OS-specific representation using Time::Local. .PP When calculating specific times, such as for tests in time or date modules, it may be appropriate to calculate an offset for the epoch. .PP .Vb 2 \& require Time::Local; \& $offset = Time::Local::timegm(0, 0, 0, 1, 0, 70); .Ve .PP The value for \f(CW$offset\fR in Unix will be \f(CW0\fR, but in Mac \s-1OS\s0 will be some large number. \f(CW$offset\fR can then be added to a Unix time value to get what should be the proper value on any system. .Sh "Character sets and character encoding" .IX Subsection "Character sets and character encoding" Assume very little about character sets. .PP Assume nothing about numerical values (\f(CW\*(C`ord\*(C'\fR, \f(CW\*(C`chr\*(C'\fR) of characters. Do not use explicit code point ranges (like \exHH\-\exHH); use for example symbolic character classes like \f(CW\*(C`[:print:]\*(C'\fR. .PP Do not assume that the alphabetic characters are encoded contiguously (in the numeric sense). There may be gaps. .PP Do not assume anything about the ordering of the characters. The lowercase letters may come before or after the uppercase letters; the lowercase and uppercase may be interlaced so that both `a' and `A' come before `b'; the accented and other international characters may be interlaced so that a\*: comes before `b'. .Sh "Internationalisation" .IX Subsection "Internationalisation" If you may assume \s-1POSIX\s0 (a rather large assumption), you may read more about the \s-1POSIX\s0 locale system from perllocale. The locale system at least attempts to make things a little bit more portable, or at least more convenient and native-friendly for non-English users. The system affects character sets and encoding, and date and time formatting\*(--amongst other things. .Sh "System Resources" .IX Subsection "System Resources" If your code is destined for systems with severely constrained (or missing!) virtual memory systems then you want to be \fIespecially\fR mindful of avoiding wasteful constructs such as: .PP .Vb 3 \& # NOTE: this is no longer "bad" in perl5.005 \& for (0..10000000) {} # bad \& for (my $x = 0; $x <= 10000000; ++$x) {} # good .Ve .PP .Vb 1 \& @lines = ; # bad .Ve .PP .Vb 2 \& while () {$file .= $_} # sometimes bad \& $file = join('', ); # better .Ve .PP The last two constructs may appear unintuitive to most people. The first repeatedly grows a string, whereas the second allocates a large chunk of memory in one go. On some systems, the second is more efficient that the first. .Sh "Security" .IX Subsection "Security" Most multi-user platforms provide basic levels of security, usually implemented at the filesystem level. Some, however, do not\*(-- unfortunately. Thus the notion of user id, or \*(L"home\*(R" directory, or even the state of being logged\-in, may be unrecognizable on many platforms. If you write programs that are security\-conscious, it is usually best to know what type of system you will be running under so that you can write code explicitly for that platform (or class of platforms). .PP Don't assume the \s-1UNIX\s0 filesystem access semantics: the operating system or the filesystem may be using some \s-1ACL\s0 systems, which are richer languages than the usual rwx. Even if the rwx exist, their semantics might be different. .PP (From security viewpoint testing for permissions before attempting to do something is silly anyway: if one tries this, there is potential for race conditions\*(-- someone or something might change the permissions between the permissions check and the actual operation. Just try the operation.) .PP Don't assume the \s-1UNIX\s0 user and group semantics: especially, don't expect the \f(CW$<\fR and \f(CW$>\fR (or the \f(CW$(\fR and \f(CW$)\fR) to work for switching identities (or memberships). .PP Don't assume set-uid and set-gid semantics. (And even if you do, think twice: set-uid and set-gid are a known can of security worms.) .Sh "Style" .IX Subsection "Style" For those times when it is necessary to have platform-specific code, consider keeping the platform-specific code in one place, making porting to other platforms easier. Use the Config module and the special variable \f(CW$^O\fR to differentiate platforms, as described in \&\*(L"\s-1PLATFORMS\s0\*(R". .PP Be careful in the tests you supply with your module or programs. Module code may be fully portable, but its tests might not be. This often happens when tests spawn off other processes or call external programs to aid in the testing, or when (as noted above) the tests assume certain things about the filesystem and paths. Be careful not to depend on a specific output style for errors, such as when checking \f(CW$!\fR after a system call. Some platforms expect a certain output format, and perl on those platforms may have been adjusted accordingly. Most specifically, don't anchor a regex when testing an error value. .SH "CPAN Testers" .IX Header "CPAN Testers" Modules uploaded to \s-1CPAN\s0 are tested by a variety of volunteers on different platforms. These \s-1CPAN\s0 testers are notified by mail of each new upload, and reply to the list with \s-1PASS\s0, \s-1FAIL\s0, \s-1NA\s0 (not applicable to this platform), or \s-1UNKNOWN\s0 (unknown), along with any relevant notations. .PP The purpose of the testing is twofold: one, to help developers fix any problems in their code that crop up because of lack of testing on other platforms; two, to provide users with information about whether a given module works on a given platform. .IP "Mailing list: cpan\-testers@perl.org" 4 .IX Item "Mailing list: cpan-testers@perl.org" .PD 0 .IP "Testing results: http://testers.cpan.org/" 4 .IX Item "Testing results: http://testers.cpan.org/" .PD .SH "PLATFORMS" .IX Header "PLATFORMS" As of version 5.002, Perl is built with a \f(CW$^O\fR variable that indicates the operating system it was built on. This was implemented to help speed up code that would otherwise have to \f(CW\*(C`use Config\*(C'\fR and use the value of \f(CW$Config{osname}\fR. Of course, to get more detailed information about the system, looking into \f(CW%Config\fR is certainly recommended. .PP \&\f(CW%Config\fR cannot always be trusted, however, because it was built at compile time. If perl was built in one place, then transferred elsewhere, some values may be wrong. The values may even have been edited after the fact. .Sh "Unix" .IX Subsection "Unix" Perl works on a bewildering variety of Unix and Unix-like platforms (see e.g. most of the files in the \fIhints/\fR directory in the source code kit). On most of these systems, the value of \f(CW$^O\fR (hence \f(CW$Config{'osname'}\fR, too) is determined either by lowercasing and stripping punctuation from the first field of the string returned by typing \f(CW\*(C`uname \-a\*(C'\fR (or a similar command) at the shell prompt or by testing the file system for the presence of uniquely named files such as a kernel or header file. Here, for example, are a few of the more popular Unix flavors: .PP .Vb 29 \& uname $^O $Config{'archname'} \& -------------------------------------------- \& AIX aix aix \& BSD/OS bsdos i386-bsdos \& Darwin darwin darwin \& dgux dgux AViiON-dgux \& DYNIX/ptx dynixptx i386-dynixptx \& FreeBSD freebsd freebsd-i386 \& Linux linux arm-linux \& Linux linux i386-linux \& Linux linux i586-linux \& Linux linux ppc-linux \& HP-UX hpux PA-RISC1.1 \& IRIX irix irix \& Mac OS X darwin darwin \& MachTen PPC machten powerpc-machten \& NeXT 3 next next-fat \& NeXT 4 next OPENSTEP-Mach \& openbsd openbsd i386-openbsd \& OSF1 dec_osf alpha-dec_osf \& reliantunix-n svr4 RM400-svr4 \& SCO_SV sco_sv i386-sco_sv \& SINIX-N svr4 RM400-svr4 \& sn4609 unicos CRAY_C90-unicos \& sn6521 unicosmk t3e-unicosmk \& sn9617 unicos CRAY_J90-unicos \& SunOS solaris sun4-solaris \& SunOS solaris i86pc-solaris \& SunOS4 sunos sun4-sunos .Ve .PP Because the value of \f(CW$Config{archname}\fR may depend on the hardware architecture, it can vary more than the value of \f(CW$^O\fR. .Sh "\s-1DOS\s0 and Derivatives" .IX Subsection "DOS and Derivatives" Perl has long been ported to Intel-style microcomputers running under systems like \s-1PC\-DOS\s0, \s-1MS\-DOS\s0, \s-1OS/2\s0, and most Windows platforms you can bring yourself to mention (except for Windows \s-1CE\s0, if you count that). Users familiar with \fI\s-1COMMAND\s0.COM\fR or \fI\s-1CMD\s0.EXE\fR style shells should be aware that each of these file specifications may have subtle differences: .PP .Vb 4 \& $filespec0 = "c:/foo/bar/file.txt"; \& $filespec1 = "c:\e\efoo\e\ebar\e\efile.txt"; \& $filespec2 = 'c:\efoo\ebar\efile.txt'; \& $filespec3 = 'c:\e\efoo\e\ebar\e\efile.txt'; .Ve .PP System calls accept either \f(CW\*(C`/\*(C'\fR or \f(CW\*(C`\e\*(C'\fR as the path separator. However, many command-line utilities of \s-1DOS\s0 vintage treat \f(CW\*(C`/\*(C'\fR as the option prefix, so may get confused by filenames containing \f(CW\*(C`/\*(C'\fR. Aside from calling any external programs, \f(CW\*(C`/\*(C'\fR will work just fine, and probably better, as it is more consistent with popular usage, and avoids the problem of remembering what to backwhack and what not to. .PP The \s-1DOS\s0 \s-1FAT\s0 filesystem can accommodate only \*(L"8.3\*(R" style filenames. Under the \*(L"case\-insensitive, but case\-preserving\*(R" \s-1HPFS\s0 (\s-1OS/2\s0) and \s-1NTFS\s0 (\s-1NT\s0) filesystems you may have to be careful about case returned with functions like \f(CW\*(C`readdir\*(C'\fR or used with functions like \f(CW\*(C`open\*(C'\fR or \f(CW\*(C`opendir\*(C'\fR. .PP \&\s-1DOS\s0 also treats several filenames as special, such as \s-1AUX\s0, \s-1PRN\s0, \&\s-1NUL\s0, \s-1CON\s0, \s-1COM1\s0, \s-1LPT1\s0, \s-1LPT2\s0, etc. Unfortunately, sometimes these filenames won't even work if you include an explicit directory prefix. It is best to avoid such filenames, if you want your code to be portable to \s-1DOS\s0 and its derivatives. It's hard to know what these all are, unfortunately. .PP Users of these operating systems may also wish to make use of scripts such as \fIpl2bat.bat\fR or \fIpl2cmd\fR to put wrappers around your scripts. .PP Newline (\f(CW\*(C`\en\*(C'\fR) is translated as \f(CW\*(C`\e015\e012\*(C'\fR by \s-1STDIO\s0 when reading from and writing to files (see \*(L"Newlines\*(R"). \f(CW\*(C`binmode(FILEHANDLE)\*(C'\fR will keep \f(CW\*(C`\en\*(C'\fR translated as \f(CW\*(C`\e012\*(C'\fR for that filehandle. Since it is a no-op on other systems, \f(CW\*(C`binmode\*(C'\fR should be used for cross-platform code that deals with binary data. That's assuming you realize in advance that your data is in binary. General-purpose programs should often assume nothing about their data. .PP The \f(CW$^O\fR variable and the \f(CW$Config{archname}\fR values for various DOSish perls are as follows: .PP .Vb 16 \& OS $^O $Config{archname} ID Version \& -------------------------------------------------------- \& MS-DOS dos ? \& PC-DOS dos ? \& OS/2 os2 ? \& Windows 3.1 ? ? 0 3 01 \& Windows 95 MSWin32 MSWin32-x86 1 4 00 \& Windows 98 MSWin32 MSWin32-x86 1 4 10 \& Windows ME MSWin32 MSWin32-x86 1 ? \& Windows NT MSWin32 MSWin32-x86 2 4 xx \& Windows NT MSWin32 MSWin32-ALPHA 2 4 xx \& Windows NT MSWin32 MSWin32-ppc 2 4 xx \& Windows 2000 MSWin32 MSWin32-x86 2 5 xx \& Windows XP MSWin32 MSWin32-x86 2 ? \& Windows CE MSWin32 ? 3 \& Cygwin cygwin ? .Ve .PP The various MSWin32 Perl's can distinguish the \s-1OS\s0 they are running on via the value of the fifth element of the list returned from \&\fIWin32::GetOSVersion()\fR. For example: .PP .Vb 4 \& if ($^O eq 'MSWin32') { \& my @os_version_info = Win32::GetOSVersion(); \& print +('3.1','95','NT')[$os_version_info[4]],"\en"; \& } .Ve .PP There are also \fIWin32::IsWinNT()\fR and \fIWin32::IsWin95()\fR, try \f(CW\*(C`perldoc Win32\*(C'\fR, and as of libwin32 0.19 (not part of the core Perl distribution) \&\fIWin32::GetOSName()\fR. The very portable \fIPOSIX::uname()\fR will work too: .PP .Vb 2 \& c:\e> perl -MPOSIX -we "print join '|', uname" \& Windows NT|moonru|5.0|Build 2195 (Service Pack 2)|x86 .Ve .PP Also see: .IP "\(bu" 4 The djgpp environment for \s-1DOS\s0, http://www.delorie.com/djgpp/ and perldos. .IP "\(bu" 4 The \s-1EMX\s0 environment for \s-1DOS\s0, \s-1OS/2\s0, etc. emx@iaehv.nl, http://www.leo.org/pub/comp/os/os2/leo/gnu/emx+gcc/index.html or ftp://hobbes.nmsu.edu/pub/os2/dev/emx/ Also perlos2. .IP "\(bu" 4 Build instructions for Win32 in perlwin32, or under the Cygnus environment in perlcygwin. .IP "\(bu" 4 The \f(CW\*(C`Win32::*\*(C'\fR modules in Win32. .IP "\(bu" 4 The ActiveState Pages, http://www.activestate.com/ .IP "\(bu" 4 The Cygwin environment for Win32; \fI\s-1README\s0.cygwin\fR (installed as perlcygwin), http://www.cygwin.com/ .IP "\(bu" 4 The U/WIN environment for Win32, http://www.research.att.com/sw/tools/uwin/ .IP "\(bu" 4 Build instructions for \s-1OS/2\s0, perlos2 .Sh "Mac\ \s-1OS\s0" .IX Subsection "MacOS" Any module requiring \s-1XS\s0 compilation is right out for most people, because MacPerl is built using non-free (and non\-cheap!) compilers. Some \s-1XS\s0 modules that can work with MacPerl are built and distributed in binary form on \s-1CPAN\s0. .PP Directories are specified as: .PP .Vb 6 \& volume:folder:file for absolute pathnames \& volume:folder: for absolute pathnames \& :folder:file for relative pathnames \& :folder: for relative pathnames \& :file for relative pathnames \& file for relative pathnames .Ve .PP Files are stored in the directory in alphabetical order. Filenames are limited to 31 characters, and may include any character except for null and \f(CW\*(C`:\*(C'\fR, which is reserved as the path separator. .PP Instead of \f(CW\*(C`flock\*(C'\fR, see \f(CW\*(C`FSpSetFLock\*(C'\fR and \f(CW\*(C`FSpRstFLock\*(C'\fR in the Mac::Files module, or \f(CW\*(C`chmod(0444, ...)\*(C'\fR and \f(CW\*(C`chmod(0666, ...)\*(C'\fR. .PP In the MacPerl application, you can't run a program from the command line; programs that expect \f(CW@ARGV\fR to be populated can be edited with something like the following, which brings up a dialog box asking for the command line arguments. .PP .Vb 3 \& if (!@ARGV) { \& @ARGV = split /\es+/, MacPerl::Ask('Arguments?'); \& } .Ve .PP A MacPerl script saved as a \*(L"droplet\*(R" will populate \f(CW@ARGV\fR with the full pathnames of the files dropped onto the script. .PP Mac users can run programs under a type of command line interface under \s-1MPW\s0 (Macintosh Programmer's Workshop, a free development environment from Apple). MacPerl was first introduced as an \s-1MPW\s0 tool, and \s-1MPW\s0 can be used like a shell: .PP .Vb 1 \& perl myscript.plx some arguments .Ve .PP ToolServer is another app from Apple that provides access to \s-1MPW\s0 tools from \s-1MPW\s0 and the MacPerl app, which allows MacPerl programs to use \&\f(CW\*(C`system\*(C'\fR, backticks, and piped \f(CW\*(C`open\*(C'\fR. .PP "Mac\ \s-1OS\s0" is the proper name for the operating system, but the value in \f(CW$^O\fR is \*(L"MacOS\*(R". To determine architecture, version, or whether the application or \s-1MPW\s0 tool version is running, check: .PP .Vb 5 \& $is_app = $MacPerl::Version =~ /App/; \& $is_tool = $MacPerl::Version =~ /MPW/; \& ($version) = $MacPerl::Version =~ /^(\eS+)/; \& $is_ppc = $MacPerl::Architecture eq 'MacPPC'; \& $is_68k = $MacPerl::Architecture eq 'Mac68K'; .Ve .PP Mac\ \s-1OS\s0\ X, based on NeXT's OpenStep \s-1OS\s0, runs MacPerl natively, under the \&\*(L"Classic\*(R" environment. There is no \*(L"Carbon\*(R" version of MacPerl to run under the primary Mac \s-1OS\s0 X environment. Mac\ \s-1OS\s0\ X and its Open Source version, Darwin, both run Unix perl natively. .PP Also see: .IP "\(bu" 4 MacPerl Development, http://dev.macperl.org/ . .IP "\(bu" 4 The MacPerl Pages, http://www.macperl.com/ . .IP "\(bu" 4 The MacPerl mailing lists, http://lists.perl.org/ . .Sh "\s-1VMS\s0" .IX Subsection "VMS" Perl on \s-1VMS\s0 is discussed in perlvms in the perl distribution. Perl on \s-1VMS\s0 can accept either \s-1VMS\-\s0 or Unix-style file specifications as in either of the following: .PP .Vb 2 \& $ perl -ne "print if /perl_setup/i" SYS$LOGIN:LOGIN.COM \& $ perl -ne "print if /perl_setup/i" /sys$login/login.com .Ve .PP but not a mixture of both as in: .PP .Vb 2 \& $ perl -ne "print if /perl_setup/i" sys$login:/login.com \& Can't open sys$login:/login.com: file specification syntax error .Ve .PP Interacting with Perl from the Digital Command Language (\s-1DCL\s0) shell often requires a different set of quotation marks than Unix shells do. For example: .PP .Vb 2 \& $ perl -e "print ""Hello, world.\en""" \& Hello, world. .Ve .PP There are several ways to wrap your perl scripts in \s-1DCL\s0 \fI.COM\fR files, if you are so inclined. For example: .PP .Vb 6 \& $ write sys$output "Hello from DCL!" \& $ if p1 .eqs. "" \& $ then perl -x 'f$environment("PROCEDURE") \& $ else perl -x - 'p1 'p2 'p3 'p4 'p5 'p6 'p7 'p8 \& $ deck/dollars="__END__" \& #!/usr/bin/perl .Ve .PP .Vb 1 \& print "Hello from Perl!\en"; .Ve .PP .Vb 2 \& __END__ \& $ endif .Ve .PP Do take care with \f(CW\*(C`$ ASSIGN/nolog/user SYS$COMMAND: SYS$INPUT\*(C'\fR if your perl-in-DCL script expects to do things like \f(CW\*(C`$read = ;\*(C'\fR. .PP Filenames are in the format \*(L"name.extension;version\*(R". The maximum length for filenames is 39 characters, and the maximum length for extensions is also 39 characters. Version is a number from 1 to 32767. Valid characters are \f(CW\*(C`/[A\-Z0\-9$_\-]/\*(C'\fR. .PP \&\s-1VMS\s0's \s-1RMS\s0 filesystem is case-insensitive and does not preserve case. \&\f(CW\*(C`readdir\*(C'\fR returns lowercased filenames, but specifying a file for opening remains case\-insensitive. Files without extensions have a trailing period on them, so doing a \f(CW\*(C`readdir\*(C'\fR with a file named \fIA.;5\fR will return \fIa.\fR (though that file could be opened with \&\f(CW\*(C`open(FH, 'A')\*(C'\fR). .PP \&\s-1RMS\s0 had an eight level limit on directory depths from any rooted logical (allowing 16 levels overall) prior to \s-1VMS\s0 7.2. Hence \&\f(CW\*(C`PERL_ROOT:[LIB.2.3.4.5.6.7.8]\*(C'\fR is a valid directory specification but \&\f(CW\*(C`PERL_ROOT:[LIB.2.3.4.5.6.7.8.9]\*(C'\fR is not. \fIMakefile.PL\fR authors might have to take this into account, but at least they can refer to the former as \f(CW\*(C`/PERL_ROOT/lib/2/3/4/5/6/7/8/\*(C'\fR. .PP The VMS::Filespec module, which gets installed as part of the build process on \s-1VMS\s0, is a pure Perl module that can easily be installed on non-VMS platforms and can be helpful for conversions to and from \s-1RMS\s0 native formats. .PP What \f(CW\*(C`\en\*(C'\fR represents depends on the type of file opened. It usually represents \f(CW\*(C`\e012\*(C'\fR but it could also be \f(CW\*(C`\e015\*(C'\fR, \f(CW\*(C`\e012\*(C'\fR, \f(CW\*(C`\e015\e012\*(C'\fR, \&\f(CW\*(C`\e000\*(C'\fR, \f(CW\*(C`\e040\*(C'\fR, or nothing depending on the file organiztion and record format. The VMS::Stdio module provides access to the special \fIfopen()\fR requirements of files with unusual attributes on \s-1VMS\s0. .PP \&\s-1TCP/IP\s0 stacks are optional on \s-1VMS\s0, so socket routines might not be implemented. \s-1UDP\s0 sockets may not be supported. .PP The value of \f(CW$^O\fR on OpenVMS is \*(L"\s-1VMS\s0\*(R". To determine the architecture that you are running on without resorting to loading all of \f(CW%Config\fR you can examine the content of the \f(CW@INC\fR array like so: .PP .Vb 2 \& if (grep(/VMS_AXP/, @INC)) { \& print "I'm on Alpha!\en"; .Ve .PP .Vb 2 \& } elsif (grep(/VMS_VAX/, @INC)) { \& print "I'm on VAX!\en"; .Ve .PP .Vb 3 \& } else { \& print "I'm not so sure about where $^O is...\en"; \& } .Ve .PP On \s-1VMS\s0, perl determines the \s-1UTC\s0 offset from the \f(CW\*(C`SYS$TIMEZONE_DIFFERENTIAL\*(C'\fR logical name. Although the \s-1VMS\s0 epoch began at 17\-NOV\-1858 00:00:00.00, calls to \f(CW\*(C`localtime\*(C'\fR are adjusted to count offsets from 01\-JAN\-1970 00:00:00.00, just like Unix. .PP Also see: .IP "\(bu" 4 \&\fI\s-1README\s0.vms\fR (installed as README_vms), perlvms .IP "\(bu" 4 vmsperl list, majordomo@perl.org .Sp (Put the words \f(CW\*(C`subscribe vmsperl\*(C'\fR in message body.) .IP "\(bu" 4 vmsperl on the web, http://www.sidhe.org/vmsperl/index.html .Sh "\s-1VOS\s0" .IX Subsection "VOS" Perl on \s-1VOS\s0 is discussed in \fI\s-1README\s0.vos\fR in the perl distribution (installed as perlvos). Perl on \s-1VOS\s0 can accept either \s-1VOS\-\s0 or Unix-style file specifications as in either of the following: .PP .Vb 2 \& C<< $ perl -ne "print if /perl_setup/i" >system>notices >> \& C<< $ perl -ne "print if /perl_setup/i" /system/notices >> .Ve .PP or even a mixture of both as in: .PP .Vb 1 \& C<< $ perl -ne "print if /perl_setup/i" >system/notices >> .Ve .PP Even though \s-1VOS\s0 allows the slash character to appear in object names, because the \s-1VOS\s0 port of Perl interprets it as a pathname delimiting character, \s-1VOS\s0 files, directories, or links whose names contain a slash character cannot be processed. Such files must be renamed before they can be processed by Perl. Note that \s-1VOS\s0 limits file names to 32 or fewer characters. .PP Perl on \s-1VOS\s0 can be built using two different compilers and two different versions of the \s-1POSIX\s0 runtime. The recommended method for building full Perl is with the \s-1GNU\s0 C compiler and the generally-available version of \&\s-1VOS\s0 \s-1POSIX\s0 support. See \fI\s-1README\s0.vos\fR (installed as perlvos) for restrictions that apply when Perl is built using the \s-1VOS\s0 Standard C compiler or the alpha version of \s-1VOS\s0 \s-1POSIX\s0 support. .PP The value of \f(CW$^O\fR on \s-1VOS\s0 is \*(L"\s-1VOS\s0\*(R". To determine the architecture that you are running on without resorting to loading all of \f(CW%Config\fR you can examine the content of the \f(CW@INC\fR array like so: .PP .Vb 6 \& if ($^O =~ /VOS/) { \& print "I'm on a Stratus box!\en"; \& } else { \& print "I'm not on a Stratus box!\en"; \& die; \& } .Ve .PP .Vb 2 \& if (grep(/860/, @INC)) { \& print "This box is a Stratus XA/R!\en"; .Ve .PP .Vb 2 \& } elsif (grep(/7100/, @INC)) { \& print "This box is a Stratus HP 7100 or 8xxx!\en"; .Ve .PP .Vb 2 \& } elsif (grep(/8000/, @INC)) { \& print "This box is a Stratus HP 8xxx!\en"; .Ve .PP .Vb 3 \& } else { \& print "This box is a Stratus 68K!\en"; \& } .Ve .PP Also see: .IP "\(bu" 4 \&\fI\s-1README\s0.vos\fR (installed as perlvos) .IP "\(bu" 4 The \s-1VOS\s0 mailing list. .Sp There is no specific mailing list for Perl on \s-1VOS\s0. You can post comments to the comp.sys.stratus newsgroup, or subscribe to the general Stratus mailing list. Send a letter with \*(L"subscribe Info\-Stratus\*(R" in the message body to majordomo@list.stratagy.com. .IP "\(bu" 4 \&\s-1VOS\s0 Perl on the web at http://ftp.stratus.com/pub/vos/posix/posix.html .Sh "\s-1EBCDIC\s0 Platforms" .IX Subsection "EBCDIC Platforms" Recent versions of Perl have been ported to platforms such as \s-1OS/400\s0 on \&\s-1AS/400\s0 minicomputers as well as \s-1OS/390\s0, \s-1VM/ESA\s0, and \s-1BS2000\s0 for S/390 Mainframes. Such computers use \s-1EBCDIC\s0 character sets internally (usually Character Code Set \s-1ID\s0 0037 for \s-1OS/400\s0 and either 1047 or POSIX-BC for S/390 systems). On the mainframe perl currently works under the \*(L"Unix system services for \s-1OS/390\s0\*(R" (formerly known as OpenEdition), \s-1VM/ESA\s0 OpenEdition, or the \s-1BS200\s0 POSIX-BC system (\s-1BS2000\s0 is supported in perl 5.6 and greater). See perlos390 for details. .PP As of R2.5 of \s-1USS\s0 for \s-1OS/390\s0 and Version 2.3 of \s-1VM/ESA\s0 these Unix sub-systems do not support the \f(CW\*(C`#!\*(C'\fR shebang trick for script invocation. Hence, on \s-1OS/390\s0 and \s-1VM/ESA\s0 perl scripts can be executed with a header similar to the following simple script: .PP .Vb 4 \& : # use perl \& eval 'exec /usr/local/bin/perl -S $0 ${1+"$@"}' \& if 0; \& #!/usr/local/bin/perl # just a comment really .Ve .PP .Vb 1 \& print "Hello from perl!\en"; .Ve .PP \&\s-1OS/390\s0 will support the \f(CW\*(C`#!\*(C'\fR shebang trick in release 2.8 and beyond. Calls to \f(CW\*(C`system\*(C'\fR and backticks can use \s-1POSIX\s0 shell syntax on all S/390 systems. .PP On the \s-1AS/400\s0, if \s-1PERL5\s0 is in your library list, you may need to wrap your perl scripts in a \s-1CL\s0 procedure to invoke them like so: .PP .Vb 3 \& BEGIN \& CALL PGM(PERL5/PERL) PARM('/QOpenSys/hello.pl') \& ENDPGM .Ve .PP This will invoke the perl script \fIhello.pl\fR in the root of the QOpenSys file system. On the \s-1AS/400\s0 calls to \f(CW\*(C`system\*(C'\fR or backticks must use \s-1CL\s0 syntax. .PP On these platforms, bear in mind that the \s-1EBCDIC\s0 character set may have an effect on what happens with some perl functions (such as \f(CW\*(C`chr\*(C'\fR, \&\f(CW\*(C`pack\*(C'\fR, \f(CW\*(C`print\*(C'\fR, \f(CW\*(C`printf\*(C'\fR, \f(CW\*(C`ord\*(C'\fR, \f(CW\*(C`sort\*(C'\fR, \f(CW\*(C`sprintf\*(C'\fR, \f(CW\*(C`unpack\*(C'\fR), as well as bit-fiddling with \s-1ASCII\s0 constants using operators like \f(CW\*(C`^\*(C'\fR, \f(CW\*(C`&\*(C'\fR and \f(CW\*(C`|\*(C'\fR, not to mention dealing with socket interfaces to \s-1ASCII\s0 computers (see \*(L"Newlines\*(R"). .PP Fortunately, most web servers for the mainframe will correctly translate the \f(CW\*(C`\en\*(C'\fR in the following statement to its \s-1ASCII\s0 equivalent (\f(CW\*(C`\er\*(C'\fR is the same under both Unix and \s-1OS/390\s0 & \s-1VM/ESA\s0): .PP .Vb 1 \& print "Content-type: text/html\er\en\er\en"; .Ve .PP The values of \f(CW$^O\fR on some of these platforms includes: .PP .Vb 6 \& uname $^O $Config{'archname'} \& -------------------------------------------- \& OS/390 os390 os390 \& OS400 os400 os400 \& POSIX-BC posix-bc BS2000-posix-bc \& VM/ESA vmesa vmesa .Ve .PP Some simple tricks for determining if you are running on an \s-1EBCDIC\s0 platform could include any of the following (perhaps all): .PP .Vb 1 \& if ("\et" eq "\e05") { print "EBCDIC may be spoken here!\en"; } .Ve .PP .Vb 1 \& if (ord('A') == 193) { print "EBCDIC may be spoken here!\en"; } .Ve .PP .Vb 1 \& if (chr(169) eq 'z') { print "EBCDIC may be spoken here!\en"; } .Ve .PP One thing you may not want to rely on is the \s-1EBCDIC\s0 encoding of punctuation characters since these may differ from code page to code page (and once your module or script is rumoured to work with \s-1EBCDIC\s0, folks will want it to work with all \s-1EBCDIC\s0 character sets). .PP Also see: .IP "\(bu" 4 * .Sp perlos390, \fI\s-1README\s0.os390\fR, \fIperlbs2000\fR, \fI\s-1README\s0.vmesa\fR, perlebcdic. .IP "\(bu" 4 The perl\-mvs@perl.org list is for discussion of porting issues as well as general usage issues for all \s-1EBCDIC\s0 Perls. Send a message body of \&\*(L"subscribe perl\-mvs\*(R" to majordomo@perl.org. .IP "\(bu" 4 \&\s-1AS/400\s0 Perl information at http://as400.rochester.ibm.com/ as well as on \s-1CPAN\s0 in the \fIports/\fR directory. .Sh "Acorn \s-1RISC\s0 \s-1OS\s0" .IX Subsection "Acorn RISC OS" Because Acorns use \s-1ASCII\s0 with newlines (\f(CW\*(C`\en\*(C'\fR) in text files as \f(CW\*(C`\e012\*(C'\fR like Unix, and because Unix filename emulation is turned on by default, most simple scripts will probably work \*(L"out of the box\*(R". The native filesystem is modular, and individual filesystems are free to be case-sensitive or insensitive, and are usually case\-preserving. Some native filesystems have name length limits, which file and directory names are silently truncated to fit. Scripts should be aware that the standard filesystem currently has a name length limit of \fB10\fR characters, with up to 77 items in a directory, but other filesystems may not impose such limitations. .PP Native filenames are of the form .PP .Vb 1 \& Filesystem#Special_Field::DiskName.$.Directory.Directory.File .Ve .PP where .PP .Vb 8 \& Special_Field is not usually present, but may contain . and $ . \& Filesystem =~ m|[A-Za-z0-9_]| \& DsicName =~ m|[A-Za-z0-9_/]| \& $ represents the root directory \& . is the path separator \& @ is the current directory (per filesystem but machine global) \& ^ is the parent directory \& Directory and File =~ m|[^\e0- "\e.\e$\e%\e&:\e@\e\e^\e|\e177]+| .Ve .PP The default filename translation is roughly \f(CW\*(C`tr|/.|./|;\*(C'\fR .PP Note that \f(CW\*(C`"ADFS::HardDisk.$.File" ne 'ADFS::HardDisk.$.File'\*(C'\fR and that the second stage of \f(CW\*(C`$\*(C'\fR interpolation in regular expressions will fall foul of the \f(CW$.\fR if scripts are not careful. .PP Logical paths specified by system variables containing comma-separated search lists are also allowed; hence \f(CW\*(C`System:Modules\*(C'\fR is a valid filename, and the filesystem will prefix \f(CW\*(C`Modules\*(C'\fR with each section of \&\f(CW\*(C`System$Path\*(C'\fR until a name is made that points to an object on disk. Writing to a new file \f(CW\*(C`System:Modules\*(C'\fR would be allowed only if \&\f(CW\*(C`System$Path\*(C'\fR contains a single item list. The filesystem will also expand system variables in filenames if enclosed in angle brackets, so \&\f(CW\*(C`.Modules\*(C'\fR would look for the file \&\f(CW\*(C`$ENV{'System$Dir'}\ .\ 'Modules'\*(C'\fR. The obvious implication of this is that \fBfully qualified filenames can start with \f(CB\*(C`<>\*(C'\fB\fR and should be protected when \f(CW\*(C`open\*(C'\fR is used for input. .PP Because \f(CW\*(C`.\*(C'\fR was in use as a directory separator and filenames could not be assumed to be unique after 10 characters, Acorn implemented the C compiler to strip the trailing \f(CW\*(C`.c\*(C'\fR \f(CW\*(C`.h\*(C'\fR \f(CW\*(C`.s\*(C'\fR and \f(CW\*(C`.o\*(C'\fR suffix from filenames specified in source code and store the respective files in subdirectories named after the suffix. Hence files are translated: .PP .Vb 6 \& foo.h h.foo \& C:foo.h C:h.foo (logical path variable) \& sys/os.h sys.h.os (C compiler groks Unix-speak) \& 10charname.c c.10charname \& 10charname.o o.10charname \& 11charname_.c c.11charname (assuming filesystem truncates at 10) .Ve .PP The Unix emulation library's translation of filenames to native assumes that this sort of translation is required, and it allows a user-defined list of known suffixes that it will transpose in this fashion. This may seem transparent, but consider that with these rules \f(CW\*(C`foo/bar/baz.h\*(C'\fR and \f(CW\*(C`foo/bar/h/baz\*(C'\fR both map to \f(CW\*(C`foo.bar.h.baz\*(C'\fR, and that \f(CW\*(C`readdir\*(C'\fR and \&\f(CW\*(C`glob\*(C'\fR cannot and do not attempt to emulate the reverse mapping. Other \&\f(CW\*(C`.\*(C'\fR's in filenames are translated to \f(CW\*(C`/\*(C'\fR. .PP As implied above, the environment accessed through \f(CW%ENV\fR is global, and the convention is that program specific environment variables are of the form \f(CW\*(C`Program$Name\*(C'\fR. Each filesystem maintains a current directory, and the current filesystem's current directory is the \fBglobal\fR current directory. Consequently, sociable programs don't change the current directory but rely on full pathnames, and programs (and Makefiles) cannot assume that they can spawn a child process which can change the current directory without affecting its parent (and everyone else for that matter). .PP Because native operating system filehandles are global and are currently allocated down from 255, with 0 being a reserved value, the Unix emulation library emulates Unix filehandles. Consequently, you can't rely on passing \f(CW\*(C`STDIN\*(C'\fR, \f(CW\*(C`STDOUT\*(C'\fR, or \f(CW\*(C`STDERR\*(C'\fR to your children. .PP The desire of users to express filenames of the form \&\f(CW\*(C`.Bar\*(C'\fR on the command line unquoted causes problems, too: \f(CW``\fR command output capture has to perform a guessing game. It assumes that a string \f(CW\*(C`<[^<>]+\e$[^<>]>\*(C'\fR is a reference to an environment variable, whereas anything else involving \&\f(CW\*(C`<\*(C'\fR or \f(CW\*(C`>\*(C'\fR is redirection, and generally manages to be 99% right. Of course, the problem remains that scripts cannot rely on any Unix tools being available, or that any tools found have Unix-like command line arguments. .PP Extensions and \s-1XS\s0 are, in theory, buildable by anyone using free tools. In practice, many don't, as users of the Acorn platform are used to binary distributions. MakeMaker does run, but no available make currently copes with MakeMaker's makefiles; even if and when this should be fixed, the lack of a Unix-like shell will cause problems with makefile rules, especially lines of the form \f(CW\*(C`cd sdbm && make all\*(C'\fR, and anything using quoting. .PP "\s-1RISC\s0\ \s-1OS\s0" is the proper name for the operating system, but the value in \f(CW$^O\fR is \*(L"riscos\*(R" (because we don't like shouting). .Sh "Other perls" .IX Subsection "Other perls" Perl has been ported to many platforms that do not fit into any of the categories listed above. Some, such as AmigaOS, Atari MiNT, BeOS, \s-1HP\s0 MPE/iX, \s-1QNX\s0, Plan 9, and \s-1VOS\s0, have been well-integrated into the standard Perl source code kit. You may need to see the \&\fIports/\fR directory on \s-1CPAN\s0 for information, and possibly binaries, for the likes of: aos, Atari \s-1ST\s0, lynxos, riscos, Novell Netware, Tandem Guardian, \fIetc.\fR (Yes, we know that some of these OSes may fall under the Unix category, but we are not a standards body.) .PP Some approximate operating system names and their \f(CW$^O\fR values in the \*(L"\s-1OTHER\s0\*(R" category include: .PP .Vb 5 \& OS $^O $Config{'archname'} \& ------------------------------------------ \& Amiga DOS amigaos m68k-amigos \& BeOS beos \& MPE/iX mpeix PA-RISC1.1 .Ve .PP See also: .IP "\(bu" 4 Amiga, \fI\s-1README\s0.amiga\fR (installed as perlamiga). .IP "\(bu" 4 Atari, \fI\s-1README\s0.mint\fR and Guido Flohr's web page http://stud.uni\-sb.de/~gufl0000/ .IP "\(bu" 4 Be \s-1OS\s0, \fI\s-1README\s0.beos\fR .IP "\(bu" 4 \&\s-1HP\s0 300 MPE/iX, \fI\s-1README\s0.mpeix\fR and Mark Bixby's web page http://www.bixby.org/mark/perlix.html .IP "\(bu" 4 A free perl5\-based \s-1PERL\s0.NLM for Novell Netware is available in precompiled binary and source code form from http://www.novell.com/ as well as from \s-1CPAN\s0. .IP "\(bu" 4 Plan\ 9, \fI\s-1README\s0.plan9\fR .SH "FUNCTION IMPLEMENTATIONS" .IX Header "FUNCTION IMPLEMENTATIONS" Listed below are functions that are either completely unimplemented or else have been implemented differently on various platforms. Following each description will be, in parentheses, a list of platforms that the description applies to. .PP The list may well be incomplete, or even wrong in some places. When in doubt, consult the platform-specific \s-1README\s0 files in the Perl source distribution, and any other documentation resources accompanying a given port. .PP Be aware, moreover, that even among Unix-ish systems there are variations. .PP For many functions, you can also query \f(CW%Config\fR, exported by default from the Config module. For example, to check whether the platform has the \f(CW\*(C`lstat\*(C'\fR call, check \f(CW$Config{d_lstat}\fR. See Config for a full description of available variables. .Sh "Alphabetical Listing of Perl Functions" .IX Subsection "Alphabetical Listing of Perl Functions" .IP "\-X \s-1FILEHANDLE\s0" 8 .IX Item "-X FILEHANDLE" .PD 0 .IP "\-X \s-1EXPR\s0" 8 .IX Item "-X EXPR" .IP "\-X" 8 .IX Item "-X" .PD \&\f(CW\*(C`\-r\*(C'\fR, \f(CW\*(C`\-w\*(C'\fR, and \f(CW\*(C`\-x\*(C'\fR have a limited meaning only; directories and applications are executable, and there are no uid/gid considerations. \f(CW\*(C`\-o\*(C'\fR is not supported. (Mac\ \s-1OS\s0) .Sp \&\f(CW\*(C`\-r\*(C'\fR, \f(CW\*(C`\-w\*(C'\fR, \f(CW\*(C`\-x\*(C'\fR, and \f(CW\*(C`\-o\*(C'\fR tell whether the file is accessible, which may not reflect UIC-based file protections. (\s-1VMS\s0) .Sp \&\f(CW\*(C`\-s\*(C'\fR returns the size of the data fork, not the total size of data fork plus resource fork. (Mac\ \s-1OS\s0). .Sp \&\f(CW\*(C`\-s\*(C'\fR by name on an open file will return the space reserved on disk, rather than the current extent. \f(CW\*(C`\-s\*(C'\fR on an open filehandle returns the current size. (\s-1RISC\s0\ \s-1OS\s0) .Sp \&\f(CW\*(C`\-R\*(C'\fR, \f(CW\*(C`\-W\*(C'\fR, \f(CW\*(C`\-X\*(C'\fR, \f(CW\*(C`\-O\*(C'\fR are indistinguishable from \f(CW\*(C`\-r\*(C'\fR, \f(CW\*(C`\-w\*(C'\fR, \&\f(CW\*(C`\-x\*(C'\fR, \f(CW\*(C`\-o\*(C'\fR. (Mac\ \s-1OS\s0, Win32, \s-1VMS\s0, \s-1RISC\s0\ \s-1OS\s0) .Sp \&\f(CW\*(C`\-b\*(C'\fR, \f(CW\*(C`\-c\*(C'\fR, \f(CW\*(C`\-k\*(C'\fR, \f(CW\*(C`\-g\*(C'\fR, \f(CW\*(C`\-p\*(C'\fR, \f(CW\*(C`\-u\*(C'\fR, \f(CW\*(C`\-A\*(C'\fR are not implemented. (Mac\ \s-1OS\s0) .Sp \&\f(CW\*(C`\-g\*(C'\fR, \f(CW\*(C`\-k\*(C'\fR, \f(CW\*(C`\-l\*(C'\fR, \f(CW\*(C`\-p\*(C'\fR, \f(CW\*(C`\-u\*(C'\fR, \f(CW\*(C`\-A\*(C'\fR are not particularly meaningful. (Win32, \s-1VMS\s0, \s-1RISC\s0\ \s-1OS\s0) .Sp \&\f(CW\*(C`\-d\*(C'\fR is true if passed a device spec without an explicit directory. (\s-1VMS\s0) .Sp \&\f(CW\*(C`\-T\*(C'\fR and \f(CW\*(C`\-B\*(C'\fR are implemented, but might misclassify Mac text files with foreign characters; this is the case will all platforms, but may affect Mac\ \s-1OS\s0 often. (Mac\ \s-1OS\s0) .Sp \&\f(CW\*(C`\-x\*(C'\fR (or \f(CW\*(C`\-X\*(C'\fR) determine if a file ends in one of the executable suffixes. \f(CW\*(C`\-S\*(C'\fR is meaningless. (Win32) .Sp \&\f(CW\*(C`\-x\*(C'\fR (or \f(CW\*(C`\-X\*(C'\fR) determine if a file has an executable file type. (\s-1RISC\s0\ \s-1OS\s0) .IP "alarm \s-1SECONDS\s0" 8 .IX Item "alarm SECONDS" .PD 0 .IP "alarm" 8 .IX Item "alarm" .PD Not implemented. (Win32) .IP "binmode \s-1FILEHANDLE\s0" 8 .IX Item "binmode FILEHANDLE" Meaningless. (Mac\ \s-1OS\s0, \s-1RISC\s0\ \s-1OS\s0) .Sp Reopens file and restores pointer; if function fails, underlying filehandle may be closed, or pointer may be in a different position. (\s-1VMS\s0) .Sp The value returned by \f(CW\*(C`tell\*(C'\fR may be affected after the call, and the filehandle may be flushed. (Win32) .IP "chmod \s-1LIST\s0" 8 .IX Item "chmod LIST" Only limited meaning. Disabling/enabling write permission is mapped to locking/unlocking the file. (Mac\ \s-1OS\s0) .Sp Only good for changing \*(L"owner\*(R" read-write access, \*(L"group\*(R", and \*(L"other\*(R" bits are meaningless. (Win32) .Sp Only good for changing \*(L"owner\*(R" and \*(L"other\*(R" read-write access. (\s-1RISC\s0\ \s-1OS\s0) .Sp Access permissions are mapped onto \s-1VOS\s0 access-control list changes. (\s-1VOS\s0) .Sp The actual permissions set depend on the value of the \f(CW\*(C`CYGWIN\*(C'\fR in the \s-1SYSTEM\s0 environment settings. (Cygwin) .IP "chown \s-1LIST\s0" 8 .IX Item "chown LIST" Not implemented. (Mac\ \s-1OS\s0, Win32, Plan\ 9, \s-1RISC\s0\ \s-1OS\s0, \s-1VOS\s0) .Sp Does nothing, but won't fail. (Win32) .IP "chroot \s-1FILENAME\s0" 8 .IX Item "chroot FILENAME" .PD 0 .IP "chroot" 8 .IX Item "chroot" .PD Not implemented. (Mac\ \s-1OS\s0, Win32, \s-1VMS\s0, Plan\ 9, \s-1RISC\s0\ \s-1OS\s0, \s-1VOS\s0, \s-1VM/ESA\s0) .IP "crypt \s-1PLAINTEXT\s0,SALT" 8 .IX Item "crypt PLAINTEXT,SALT" May not be available if library or source was not provided when building perl. (Win32) .Sp Not implemented. (\s-1VOS\s0) .IP "dbmclose \s-1HASH\s0" 8 .IX Item "dbmclose HASH" Not implemented. (\s-1VMS\s0, Plan\ 9, \s-1VOS\s0) .IP "dbmopen \s-1HASH\s0,DBNAME,MODE" 8 .IX Item "dbmopen HASH,DBNAME,MODE" Not implemented. (\s-1VMS\s0, Plan\ 9, \s-1VOS\s0) .IP "dump \s-1LABEL\s0" 8 .IX Item "dump LABEL" Not useful. (Mac\ \s-1OS\s0, \s-1RISC\s0\ \s-1OS\s0) .Sp Not implemented. (Win32) .Sp Invokes \s-1VMS\s0 debugger. (\s-1VMS\s0) .IP "exec \s-1LIST\s0" 8 .IX Item "exec LIST" Not implemented. (Mac\ \s-1OS\s0) .Sp Implemented via Spawn. (\s-1VM/ESA\s0) .Sp Does not automatically flush output handles on some platforms. (SunOS, Solaris, \s-1HP\-UX\s0) .IP "exit \s-1EXPR\s0" 8 .IX Item "exit EXPR" .PD 0 .IP "exit" 8 .IX Item "exit" .PD Emulates \s-1UNIX\s0 \fIexit()\fR (which considers \f(CW\*(C`exit 1\*(C'\fR to indicate an error) by mapping the \f(CW1\fR to \s-1SS$_ABORT\s0 (\f(CW44\fR). This behavior may be overridden with the pragma \f(CW\*(C`use vmsish 'exit'\*(C'\fR. As with the \s-1CRTL\s0's \fIexit()\fR function, \f(CW\*(C`exit 0\*(C'\fR is also mapped to an exit status of \s-1SS$_NORMAL\s0 (\f(CW1\fR); this mapping cannot be overridden. Any other argument to \fIexit()\fR is used directly as Perl's exit status. (\s-1VMS\s0) .IP "fcntl \s-1FILEHANDLE\s0,FUNCTION,SCALAR" 8 .IX Item "fcntl FILEHANDLE,FUNCTION,SCALAR" Not implemented. (Win32, \s-1VMS\s0) .IP "flock \s-1FILEHANDLE\s0,OPERATION" 8 .IX Item "flock FILEHANDLE,OPERATION" Not implemented (Mac\ \s-1OS\s0, \s-1VMS\s0, \s-1RISC\s0\ \s-1OS\s0, \s-1VOS\s0). .Sp Available only on Windows \s-1NT\s0 (not on Windows 95). (Win32) .IP "fork" 8 .IX Item "fork" Not implemented. (Mac\ \s-1OS\s0, AmigaOS, \s-1RISC\s0\ \s-1OS\s0, \s-1VOS\s0, \s-1VM/ESA\s0, \s-1VMS\s0) .Sp Emulated using multiple interpreters. See perlfork. (Win32) .Sp Does not automatically flush output handles on some platforms. (SunOS, Solaris, \s-1HP\-UX\s0) .IP "getlogin" 8 .IX Item "getlogin" Not implemented. (Mac\ \s-1OS\s0, \s-1RISC\s0\ \s-1OS\s0) .IP "getpgrp \s-1PID\s0" 8 .IX Item "getpgrp PID" Not implemented. (Mac\ \s-1OS\s0, Win32, \s-1VMS\s0, \s-1RISC\s0\ \s-1OS\s0, \s-1VOS\s0) .IP "getppid" 8 .IX Item "getppid" Not implemented. (Mac\ \s-1OS\s0, Win32, \s-1RISC\s0\ \s-1OS\s0) .IP "getpriority \s-1WHICH\s0,WHO" 8 .IX Item "getpriority WHICH,WHO" Not implemented. (Mac\ \s-1OS\s0, Win32, \s-1VMS\s0, \s-1RISC\s0\ \s-1OS\s0, \s-1VOS\s0, \s-1VM/ESA\s0) .IP "getpwnam \s-1NAME\s0" 8 .IX Item "getpwnam NAME" Not implemented. (Mac\ \s-1OS\s0, Win32) .Sp Not useful. (\s-1RISC\s0\ \s-1OS\s0) .IP "getgrnam \s-1NAME\s0" 8 .IX Item "getgrnam NAME" Not implemented. (Mac\ \s-1OS\s0, Win32, \s-1VMS\s0, \s-1RISC\s0\ \s-1OS\s0) .IP "getnetbyname \s-1NAME\s0" 8 .IX Item "getnetbyname NAME" Not implemented. (Mac\ \s-1OS\s0, Win32, Plan\ 9) .IP "getpwuid \s-1UID\s0" 8 .IX Item "getpwuid UID" Not implemented. (Mac\ \s-1OS\s0, Win32) .Sp Not useful. (\s-1RISC\s0\ \s-1OS\s0) .IP "getgrgid \s-1GID\s0" 8 .IX Item "getgrgid GID" Not implemented. (Mac\ \s-1OS\s0, Win32, \s-1VMS\s0, \s-1RISC\s0\ \s-1OS\s0) .IP "getnetbyaddr \s-1ADDR\s0,ADDRTYPE" 8 .IX Item "getnetbyaddr ADDR,ADDRTYPE" Not implemented. (Mac\ \s-1OS\s0, Win32, Plan\ 9) .IP "getprotobynumber \s-1NUMBER\s0" 8 .IX Item "getprotobynumber NUMBER" Not implemented. (Mac\ \s-1OS\s0) .IP "getservbyport \s-1PORT\s0,PROTO" 8 .IX Item "getservbyport PORT,PROTO" Not implemented. (Mac\ \s-1OS\s0) .IP "getpwent" 8 .IX Item "getpwent" Not implemented. (Mac\ \s-1OS\s0, Win32, \s-1VM/ESA\s0) .IP "getgrent" 8 .IX Item "getgrent" Not implemented. (Mac\ \s-1OS\s0, Win32, \s-1VMS\s0, \s-1VM/ESA\s0) .IP "gethostent" 8 .IX Item "gethostent" Not implemented. (Mac\ \s-1OS\s0, Win32) .IP "getnetent" 8 .IX Item "getnetent" Not implemented. (Mac\ \s-1OS\s0, Win32, Plan\ 9) .IP "getprotoent" 8 .IX Item "getprotoent" Not implemented. (Mac\ \s-1OS\s0, Win32, Plan\ 9) .IP "getservent" 8 .IX Item "getservent" Not implemented. (Win32, Plan\ 9) .IP "sethostent \s-1STAYOPEN\s0" 8 .IX Item "sethostent STAYOPEN" Not implemented. (Mac\ \s-1OS\s0, Win32, Plan\ 9, \s-1RISC\s0\ \s-1OS\s0) .IP "setnetent \s-1STAYOPEN\s0" 8 .IX Item "setnetent STAYOPEN" Not implemented. (Mac\ \s-1OS\s0, Win32, Plan\ 9, \s-1RISC\s0\ \s-1OS\s0) .IP "setprotoent \s-1STAYOPEN\s0" 8 .IX Item "setprotoent STAYOPEN" Not implemented. (Mac\ \s-1OS\s0, Win32, Plan\ 9, \s-1RISC\s0\ \s-1OS\s0) .IP "setservent \s-1STAYOPEN\s0" 8 .IX Item "setservent STAYOPEN" Not implemented. (Plan\ 9, Win32, \s-1RISC\s0\ \s-1OS\s0) .IP "endpwent" 8 .IX Item "endpwent" Not implemented. (Mac\ \s-1OS\s0, MPE/iX, \s-1VM/ESA\s0, Win32) .IP "endgrent" 8 .IX Item "endgrent" Not implemented. (Mac\ \s-1OS\s0, MPE/iX, \s-1RISC\s0\ \s-1OS\s0, \s-1VM/ESA\s0, \s-1VMS\s0, Win32) .IP "endhostent" 8 .IX Item "endhostent" Not implemented. (Mac\ \s-1OS\s0, Win32) .IP "endnetent" 8 .IX Item "endnetent" Not implemented. (Mac\ \s-1OS\s0, Win32, Plan\ 9) .IP "endprotoent" 8 .IX Item "endprotoent" Not implemented. (Mac\ \s-1OS\s0, Win32, Plan\ 9) .IP "endservent" 8 .IX Item "endservent" Not implemented. (Plan\ 9, Win32) .IP "getsockopt \s-1SOCKET\s0,LEVEL,OPTNAME" 8 .IX Item "getsockopt SOCKET,LEVEL,OPTNAME" Not implemented. (Plan\ 9) .IP "glob \s-1EXPR\s0" 8 .IX Item "glob EXPR" .PD 0 .IP "glob" 8 .IX Item "glob" .PD This operator is implemented via the File::Glob extension on most platforms. See File::Glob for portability information. .IP "ioctl \s-1FILEHANDLE\s0,FUNCTION,SCALAR" 8 .IX Item "ioctl FILEHANDLE,FUNCTION,SCALAR" Not implemented. (\s-1VMS\s0) .Sp Available only for socket handles, and it does what the \fIioctlsocket()\fR call in the Winsock \s-1API\s0 does. (Win32) .Sp Available only for socket handles. (\s-1RISC\s0\ \s-1OS\s0) .IP "kill \s-1SIGNAL\s0, \s-1LIST\s0" 8 .IX Item "kill SIGNAL, LIST" \&\f(CW\*(C`kill(0, LIST)\*(C'\fR is implemented for the sake of taint checking; use with other signals is unimplemented. (Mac\ \s-1OS\s0) .Sp Not implemented, hence not useful for taint checking. (\s-1RISC\s0\ \s-1OS\s0) .Sp \&\f(CW\*(C`kill()\*(C'\fR doesn't have the semantics of \f(CW\*(C`raise()\*(C'\fR, i.e. it doesn't send a signal to the identified process like it does on Unix platforms. Instead \f(CW\*(C`kill($sig, $pid)\*(C'\fR terminates the process identified by \f(CW$pid\fR, and makes it exit immediately with exit status \f(CW$sig\fR. As in Unix, if \&\f(CW$sig\fR is 0 and the specified process exists, it returns true without actually terminating it. (Win32) .IP "link \s-1OLDFILE\s0,NEWFILE" 8 .IX Item "link OLDFILE,NEWFILE" Not implemented. (Mac\ \s-1OS\s0, MPE/iX, \s-1VMS\s0, \s-1RISC\s0\ \s-1OS\s0) .Sp Link count not updated because hard links are not quite that hard (They are sort of half-way between hard and soft links). (AmigaOS) .Sp Hard links are implemented on Win32 (Windows \s-1NT\s0 and Windows 2000) under \s-1NTFS\s0 only. .IP "lstat \s-1FILEHANDLE\s0" 8 .IX Item "lstat FILEHANDLE" .PD 0 .IP "lstat \s-1EXPR\s0" 8 .IX Item "lstat EXPR" .IP "lstat" 8 .IX Item "lstat" .PD Not implemented. (\s-1VMS\s0, \s-1RISC\s0\ \s-1OS\s0) .Sp Return values (especially for device and inode) may be bogus. (Win32) .IP "msgctl \s-1ID\s0,CMD,ARG" 8 .IX Item "msgctl ID,CMD,ARG" .PD 0 .IP "msgget \s-1KEY\s0,FLAGS" 8 .IX Item "msgget KEY,FLAGS" .IP "msgsnd \s-1ID\s0,MSG,FLAGS" 8 .IX Item "msgsnd ID,MSG,FLAGS" .IP "msgrcv \s-1ID\s0,VAR,SIZE,TYPE,FLAGS" 8 .IX Item "msgrcv ID,VAR,SIZE,TYPE,FLAGS" .PD Not implemented. (Mac\ \s-1OS\s0, Win32, \s-1VMS\s0, Plan\ 9, \s-1RISC\s0\ \s-1OS\s0, \s-1VOS\s0) .IP "open \s-1FILEHANDLE\s0,EXPR" 8 .IX Item "open FILEHANDLE,EXPR" .PD 0 .IP "open \s-1FILEHANDLE\s0" 8 .IX Item "open FILEHANDLE" .PD The \f(CW\*(C`|\*(C'\fR variants are supported only if ToolServer is installed. (Mac\ \s-1OS\s0) .Sp open to \f(CW\*(C`|\-\*(C'\fR and \f(CW\*(C`\-|\*(C'\fR are unsupported. (Mac\ \s-1OS\s0, Win32, \s-1RISC\s0\ \s-1OS\s0) .Sp Opening a process does not automatically flush output handles on some platforms. (SunOS, Solaris, \s-1HP\-UX\s0) .IP "pipe \s-1READHANDLE\s0,WRITEHANDLE" 8 .IX Item "pipe READHANDLE,WRITEHANDLE" Very limited functionality. (MiNT) .IP "readlink \s-1EXPR\s0" 8 .IX Item "readlink EXPR" .PD 0 .IP "readlink" 8 .IX Item "readlink" .PD Not implemented. (Win32, \s-1VMS\s0, \s-1RISC\s0\ \s-1OS\s0) .IP "select \s-1RBITS\s0,WBITS,EBITS,TIMEOUT" 8 .IX Item "select RBITS,WBITS,EBITS,TIMEOUT" Only implemented on sockets. (Win32, \s-1VMS\s0) .Sp Only reliable on sockets. (\s-1RISC\s0\ \s-1OS\s0) .Sp Note that the \f(CW\*(C`select FILEHANDLE\*(C'\fR form is generally portable. .IP "semctl \s-1ID\s0,SEMNUM,CMD,ARG" 8 .IX Item "semctl ID,SEMNUM,CMD,ARG" .PD 0 .IP "semget \s-1KEY\s0,NSEMS,FLAGS" 8 .IX Item "semget KEY,NSEMS,FLAGS" .IP "semop \s-1KEY\s0,OPSTRING" 8 .IX Item "semop KEY,OPSTRING" .PD Not implemented. (Mac\ \s-1OS\s0, Win32, \s-1VMS\s0, \s-1RISC\s0\ \s-1OS\s0, \s-1VOS\s0) .IP "setgrent" 8 .IX Item "setgrent" Not implemented. (Mac\ \s-1OS\s0, MPE/iX, \s-1VMS\s0, Win32, \s-1RISC\s0\ \s-1OS\s0) .IP "setpgrp \s-1PID\s0,PGRP" 8 .IX Item "setpgrp PID,PGRP" Not implemented. (Mac\ \s-1OS\s0, Win32, \s-1VMS\s0, \s-1RISC\s0\ \s-1OS\s0, \s-1VOS\s0) .IP "setpriority \s-1WHICH\s0,WHO,PRIORITY" 8 .IX Item "setpriority WHICH,WHO,PRIORITY" Not implemented. (Mac\ \s-1OS\s0, Win32, \s-1VMS\s0, \s-1RISC\s0\ \s-1OS\s0, \s-1VOS\s0) .IP "setpwent" 8 .IX Item "setpwent" Not implemented. (Mac\ \s-1OS\s0, MPE/iX, Win32, \s-1RISC\s0\ \s-1OS\s0) .IP "setsockopt \s-1SOCKET\s0,LEVEL,OPTNAME,OPTVAL" 8 .IX Item "setsockopt SOCKET,LEVEL,OPTNAME,OPTVAL" Not implemented. (Plan\ 9) .IP "shmctl \s-1ID\s0,CMD,ARG" 8 .IX Item "shmctl ID,CMD,ARG" .PD 0 .IP "shmget \s-1KEY\s0,SIZE,FLAGS" 8 .IX Item "shmget KEY,SIZE,FLAGS" .IP "shmread \s-1ID\s0,VAR,POS,SIZE" 8 .IX Item "shmread ID,VAR,POS,SIZE" .IP "shmwrite \s-1ID\s0,STRING,POS,SIZE" 8 .IX Item "shmwrite ID,STRING,POS,SIZE" .PD Not implemented. (Mac\ \s-1OS\s0, Win32, \s-1VMS\s0, \s-1RISC\s0\ \s-1OS\s0, \s-1VOS\s0) .IP "sockatmark \s-1SOCKET\s0" 8 .IX Item "sockatmark SOCKET" A relatively recent addition to socket functions, may not be implemented even in \s-1UNIX\s0 platforms. .IP "socketpair \s-1SOCKET1\s0,SOCKET2,DOMAIN,TYPE,PROTOCOL" 8 .IX Item "socketpair SOCKET1,SOCKET2,DOMAIN,TYPE,PROTOCOL" Not implemented. (Win32, \s-1VMS\s0, \s-1RISC\s0\ \s-1OS\s0, \s-1VOS\s0, \s-1VM/ESA\s0) .IP "stat \s-1FILEHANDLE\s0" 8 .IX Item "stat FILEHANDLE" .PD 0 .IP "stat \s-1EXPR\s0" 8 .IX Item "stat EXPR" .IP "stat" 8 .IX Item "stat" .PD Platforms that do not have rdev, blksize, or blocks will return these as '', so numeric comparison or manipulation of these fields may cause \&'not numeric' warnings. .Sp mtime and atime are the same thing, and ctime is creation time instead of inode change time. (Mac\ \s-1OS\s0). .Sp ctime not supported on \s-1UFS\s0 (Mac\ \s-1OS\s0\ X). .Sp ctime is creation time instead of inode change time (Win32). .Sp device and inode are not meaningful. (Win32) .Sp device and inode are not necessarily reliable. (\s-1VMS\s0) .Sp mtime, atime and ctime all return the last modification time. Device and inode are not necessarily reliable. (\s-1RISC\s0\ \s-1OS\s0) .Sp dev, rdev, blksize, and blocks are not available. inode is not meaningful and will differ between stat calls on the same file. (os2) .Sp some versions of cygwin when doing a stat(\*(L"foo\*(R") and if not finding it may then attempt to stat(\*(L"foo.exe\*(R") (Cygwin) .IP "symlink \s-1OLDFILE\s0,NEWFILE" 8 .IX Item "symlink OLDFILE,NEWFILE" Not implemented. (Win32, \s-1VMS\s0, \s-1RISC\s0\ \s-1OS\s0) .IP "syscall \s-1LIST\s0" 8 .IX Item "syscall LIST" Not implemented. (Mac\ \s-1OS\s0, Win32, \s-1VMS\s0, \s-1RISC\s0\ \s-1OS\s0, \s-1VOS\s0, \s-1VM/ESA\s0) .IP "sysopen \s-1FILEHANDLE\s0,FILENAME,MODE,PERMS" 8 .IX Item "sysopen FILEHANDLE,FILENAME,MODE,PERMS" The traditional \*(L"0\*(R", \*(L"1\*(R", and \*(L"2\*(R" MODEs are implemented with different numeric values on some systems. The flags exported by \f(CW\*(C`Fcntl\*(C'\fR (O_RDONLY, O_WRONLY, O_RDWR) should work everywhere though. (Mac\ \s-1OS\s0, \s-1OS/390\s0, \s-1VM/ESA\s0) .IP "system \s-1LIST\s0" 8 .IX Item "system LIST" In general, do not assume the \s-1UNIX/POSIX\s0 semantics that you can shift \&\f(CW$?\fR right by eight to get the exit value, or that \f(CW\*(C`$? & 127\*(C'\fR would give you the number of the signal that terminated the program, or that \f(CW\*(C`$? & 128\*(C'\fR would test true if the program was terminated by a coredump. Instead, use the \s-1POSIX\s0 W*() interfaces: for example, use \&\s-1WIFEXITED\s0($?) and \s-1WEXITVALUE\s0($?) to test for a normal exit and the exit value, \s-1WIFSIGNALED\s0($?) and \s-1WTERMSIG\s0($?) for a signal exit and the signal. Core dumping is not a portable concept, so there's no portable way to test for that. .Sp Only implemented if ToolServer is installed. (Mac\ \s-1OS\s0) .Sp As an optimization, may not call the command shell specified in \&\f(CW$ENV{PERL5SHELL}\fR. \f(CW\*(C`system(1, @args)\*(C'\fR spawns an external process and immediately returns its process designator, without waiting for it to terminate. Return value may be used subsequently in \f(CW\*(C`wait\*(C'\fR or \f(CW\*(C`waitpid\*(C'\fR. Failure to \fIspawn()\fR a subprocess is indicated by setting $? to \*(L"255 << 8\*(R". \f(CW$?\fR is set in a way compatible with Unix (i.e. the exitstatus of the subprocess is obtained by \*(L"$? >> 8\*(R", as described in the documentation). (Win32) .Sp There is no shell to process metacharacters, and the native standard is to pass a command line terminated by \*(L"\en\*(R" \*(L"\er\*(R" or \*(L"\e0\*(R" to the spawned program. Redirection such as \f(CW\*(C`> foo\*(C'\fR is performed (if at all) by the run time library of the spawned program. \f(CW\*(C`system\*(C'\fR \fIlist\fR will call the Unix emulation library's \f(CW\*(C`exec\*(C'\fR emulation, which attempts to provide emulation of the stdin, stdout, stderr in force in the parent, providing the child program uses a compatible version of the emulation library. \&\fIscalar\fR will call the native command line direct and no such emulation of a child Unix program will exists. Mileage \fBwill\fR vary. (\s-1RISC\s0\ \s-1OS\s0) .Sp Far from being \s-1POSIX\s0 compliant. Because there may be no underlying /bin/sh tries to work around the problem by forking and execing the first token in its argument string. Handles basic redirection (\*(L"<\*(R" or \*(L">\*(R") on its own behalf. (MiNT) .Sp Does not automatically flush output handles on some platforms. (SunOS, Solaris, \s-1HP\-UX\s0) .Sp The return value is POSIX-like (shifted up by 8 bits), which only allows room for a made-up value derived from the severity bits of the native 32\-bit condition code (unless overridden by \f(CW\*(C`use vmsish 'status'\*(C'\fR). For more details see \*(L"$?\*(R" in perlvms. (\s-1VMS\s0) .IP "times" 8 .IX Item "times" Only the first entry returned is nonzero. (Mac\ \s-1OS\s0) .Sp \&\*(L"cumulative\*(R" times will be bogus. On anything other than Windows \s-1NT\s0 or Windows 2000, \*(L"system\*(R" time will be bogus, and \*(L"user\*(R" time is actually the time returned by the \fIclock()\fR function in the C runtime library. (Win32) .Sp Not useful. (\s-1RISC\s0\ \s-1OS\s0) .IP "truncate \s-1FILEHANDLE\s0,LENGTH" 8 .IX Item "truncate FILEHANDLE,LENGTH" .PD 0 .IP "truncate \s-1EXPR\s0,LENGTH" 8 .IX Item "truncate EXPR,LENGTH" .PD Not implemented. (Older versions of \s-1VMS\s0) .Sp Truncation to zero-length only. (\s-1VOS\s0) .Sp If a \s-1FILEHANDLE\s0 is supplied, it must be writable and opened in append mode (i.e., use \f(CW\*(C`open(FH, '>>filename')\*(C'\fR or \f(CW\*(C`sysopen(FH,...,O_APPEND|O_RDWR)\*(C'\fR. If a filename is supplied, it should not be held open elsewhere. (Win32) .IP "umask \s-1EXPR\s0" 8 .IX Item "umask EXPR" .PD 0 .IP "umask" 8 .IX Item "umask" .PD Returns undef where unavailable, as of version 5.005. .Sp \&\f(CW\*(C`umask\*(C'\fR works but the correct permissions are set only when the file is finally closed. (AmigaOS) .IP "utime \s-1LIST\s0" 8 .IX Item "utime LIST" Only the modification time is updated. (BeOS, Mac\ \s-1OS\s0, \s-1VMS\s0, \s-1RISC\s0\ \s-1OS\s0) .Sp May not behave as expected. Behavior depends on the C runtime library's implementation of \fIutime()\fR, and the filesystem being used. The \s-1FAT\s0 filesystem typically does not support an \*(L"access time\*(R" field, and it may limit timestamps to a granularity of two seconds. (Win32) .IP "wait" 8 .IX Item "wait" .PD 0 .IP "waitpid \s-1PID\s0,FLAGS" 8 .IX Item "waitpid PID,FLAGS" .PD Not implemented. (Mac\ \s-1OS\s0, \s-1VOS\s0) .Sp Can only be applied to process handles returned for processes spawned using \f(CW\*(C`system(1, ...)\*(C'\fR or pseudo processes created with \f(CW\*(C`fork()\*(C'\fR. (Win32) .Sp Not useful. (\s-1RISC\s0\ \s-1OS\s0) .SH "CHANGES" .IX Header "CHANGES" .IP "v1.48, 02 February 2001" 4 .IX Item "v1.48, 02 February 2001" Various updates from perl5\-porters over the past year, supported platforms update from Jarkko Hietaniemi. .IP "v1.47, 22 March 2000" 4 .IX Item "v1.47, 22 March 2000" Various cleanups from Tom Christiansen, including migration of long platform listings from perl. .IP "v1.46, 12 February 2000" 4 .IX Item "v1.46, 12 February 2000" Updates for \s-1VOS\s0 and MPE/iX. (Peter Prymmer) Other small changes. .IP "v1.45, 20 December 1999" 4 .IX Item "v1.45, 20 December 1999" Small changes from 5.005_63 distribution, more changes to \s-1EBCDIC\s0 info. .IP "v1.44, 19 July 1999" 4 .IX Item "v1.44, 19 July 1999" A bunch of updates from Peter Prymmer for \f(CW$^O\fR values, endianness, File::Spec, \s-1VMS\s0, \s-1BS2000\s0, \s-1OS/400\s0. .IP "v1.43, 24 May 1999" 4 .IX Item "v1.43, 24 May 1999" Added a lot of cleaning up from Tom Christiansen. .IP "v1.42, 22 May 1999" 4 .IX Item "v1.42, 22 May 1999" Added notes about tests, sprintf/printf, and epoch offsets. .IP "v1.41, 19 May 1999" 4 .IX Item "v1.41, 19 May 1999" Lots more little changes to formatting and content. .Sp Added a bunch of \f(CW$^O\fR and related values for various platforms; fixed mail and web addresses, and added and changed miscellaneous notes. (Peter Prymmer) .IP "v1.40, 11 April 1999" 4 .IX Item "v1.40, 11 April 1999" Miscellaneous changes. .IP "v1.39, 11 February 1999" 4 .IX Item "v1.39, 11 February 1999" Changes from Jarkko and \s-1EMX\s0 \s-1URL\s0 fixes Michael Schwern. Additional note about newlines added. .IP "v1.38, 31 December 1998" 4 .IX Item "v1.38, 31 December 1998" More changes from Jarkko. .IP "v1.37, 19 December 1998" 4 .IX Item "v1.37, 19 December 1998" More minor changes. Merge two separate version 1.35 documents. .IP "v1.36, 9 September 1998" 4 .IX Item "v1.36, 9 September 1998" Updated for Stratus \s-1VOS\s0. Also known as version 1.35. .IP "v1.35, 13 August 1998" 4 .IX Item "v1.35, 13 August 1998" Integrate more minor changes, plus addition of new sections under \&\*(L"\s-1ISSUES\s0\*(R": \*(L"Numbers endianness and Width\*(R", \&\*(L"Character sets and character encoding\*(R", \&\*(L"Internationalisation\*(R". .IP "v1.33, 06 August 1998" 4 .IX Item "v1.33, 06 August 1998" Integrate more minor changes. .IP "v1.32, 05 August 1998" 4 .IX Item "v1.32, 05 August 1998" Integrate more minor changes. .IP "v1.30, 03 August 1998" 4 .IX Item "v1.30, 03 August 1998" Major update for \s-1RISC\s0 \s-1OS\s0, other minor changes. .IP "v1.23, 10 July 1998" 4 .IX Item "v1.23, 10 July 1998" First public release with perl5.005. .SH "Supported Platforms" .IX Header "Supported Platforms" As of June 2002 (the Perl release 5.8.0), the following platforms are able to build Perl from the standard source code distribution available at http://www.cpan.org/src/index.html .PP .Vb 36 \& AIX \& BeOS \& Cygwin \& DG/UX \& DOS DJGPP 1) \& DYNIX/ptx \& EPOC R5 \& FreeBSD \& HP-UX \& IRIX \& Linux \& Mac OS Classic \& Mac OS X (Darwin) \& MPE/iX \& NetBSD \& NetWare \& NonStop-UX \& ReliantUNIX (SINIX) \& OpenBSD \& OpenVMS (VMS) \& OS/2 \& PowerUX \& POSIX-BC (BS2000) \& QNX \& Solaris \& SunOS 4 \& SUPER-UX \& Tru64 UNIX (DEC OSF/1, Digital UNIX) \& UNICOS \& UNICOS/mk \& UTS \& VOS \& Win95/98/ME/2K/XP 2) \& WinCE \& z/OS (OS/390) \& VM/ESA .Ve .PP .Vb 2 \& 1) in DOS mode either the DOS or OS/2 ports can be used \& 2) compilers: Borland, MinGW (GCC), VC6 .Ve .PP The following platforms worked with the previous releases (5.6 and 5.7), but we did not manage either to fix or to test these in time for the 5.8.0 release. There is a very good chance that many of these will work fine with the 5.8.0. .PP .Vb 10 \& BSD/OS \& DomainOS \& Hurd \& LynxOS \& MachTen \& PowerMAX \& SCO SV \& SVR4 \& Unixware \& Windows 3.1 .Ve .PP Known to be broken for 5.8.0 (but 5.6.1 and 5.7.2 can be used): .PP .Vb 1 \& AmigaOS .Ve .PP The following platforms have been known to build Perl from source in the past (5.005_03 and earlier), but we haven't been able to verify their status for the current release, either because the hardware/software platforms are rare or because we don't have an active champion on these platforms\*(--or both. They used to work, though, so go ahead and try compiling them, and let perlbug@perl.org of any trouble. .PP .Vb 30 \& 3b1 \& A/UX \& ConvexOS \& CX/UX \& DC/OSx \& DDE SMES \& DOS EMX \& Dynix \& EP/IX \& ESIX \& FPS \& GENIX \& Greenhills \& ISC \& MachTen 68k \& MiNT \& MPC \& NEWS-OS \& NextSTEP \& OpenSTEP \& Opus \& Plan 9 \& RISC/os \& SCO ODT/OSR \& Stellar \& SVR2 \& TI1500 \& TitanOS \& Ultrix \& Unisys Dynix .Ve .PP The following platforms have their own source code distributions and binaries available via http://www.cpan.org/ports/ .PP .Vb 1 \& Perl release .Ve .PP .Vb 2 \& OS/400 5.005_02 \& Tandem Guardian 5.004 .Ve .PP The following platforms have only binaries available via http://www.cpan.org/ports/index.html : .PP .Vb 1 \& Perl release .Ve .PP .Vb 3 \& Acorn RISCOS 5.005_02 \& AOS 5.002 \& LynxOS 5.004_02 .Ve .PP Although we do suggest that you always build your own Perl from the source code, both for maximal configurability and for security, in case you are in a hurry you can check http://www.cpan.org/ports/index.html for binary distributions. .SH "SEE ALSO" .IX Header "SEE ALSO" perlaix, perlamiga, perlapollo, perlbeos, perlbs2000, perlce, perlcygwin, perldgux, perldos, perlepoc, perlebcdic, perlfreebsd, perlhurd, perlhpux, perlirix, perlmachten, perlmacos, perlmint, perlmpeix, perlnetware, perlos2, perlos390, perlplan9, perlqnx, perlsolaris, perltru64, perlunicode, perlvmesa, perlvms, perlvos, perlwin32, and Win32. .SH "AUTHORS / CONTRIBUTORS" .IX Header "AUTHORS / CONTRIBUTORS" Abigail , Charles Bailey , Graham Barr , Tom Christiansen , Nicholas Clark , Thomas Dorner , Andy Dougherty , Dominic Dunlop , Neale Ferguson , David J. Fiander , Paul Green , M.J.T. Guy , Jarkko Hietaniemi , Luther Huffman , Nick Ing-Simmons , Andreas J. Ko\*:nig , Markus Laker , Andrew M. Langmead , Larry Moore , Paul Moore , Chris Nandor , Matthias Neeracher , Philip Newton , Gary Ng <71564.1743@CompuServe.COM>, Tom Phoenix , Andre\*' Pirard , Peter Prymmer , Hugo van der Sanden , Gurusamy Sarathy , Paul J. Schinder , Michael G Schwern , Dan Sugalski , Nathan Torkington .