xref: /onnv-gate/usr/src/cmd/perl/5.8.4/distrib/pod/perlport.pod (revision 0:68f95e015346)
1*0Sstevel@tonic-gate=head1 NAME
2*0Sstevel@tonic-gate
3*0Sstevel@tonic-gateperlport - Writing portable Perl
4*0Sstevel@tonic-gate
5*0Sstevel@tonic-gate=head1 DESCRIPTION
6*0Sstevel@tonic-gate
7*0Sstevel@tonic-gatePerl runs on numerous operating systems.  While most of them share
8*0Sstevel@tonic-gatemuch in common, they also have their own unique features.
9*0Sstevel@tonic-gate
10*0Sstevel@tonic-gateThis document is meant to help you to find out what constitutes portable
11*0Sstevel@tonic-gatePerl code.  That way once you make a decision to write portably,
12*0Sstevel@tonic-gateyou know where the lines are drawn, and you can stay within them.
13*0Sstevel@tonic-gate
14*0Sstevel@tonic-gateThere is a tradeoff between taking full advantage of one particular
15*0Sstevel@tonic-gatetype of computer and taking advantage of a full range of them.
16*0Sstevel@tonic-gateNaturally, as you broaden your range and become more diverse, the
17*0Sstevel@tonic-gatecommon factors drop, and you are left with an increasingly smaller
18*0Sstevel@tonic-gatearea of common ground in which you can operate to accomplish a
19*0Sstevel@tonic-gateparticular task.  Thus, when you begin attacking a problem, it is
20*0Sstevel@tonic-gateimportant to consider under which part of the tradeoff curve you
21*0Sstevel@tonic-gatewant to operate.  Specifically, you must decide whether it is
22*0Sstevel@tonic-gateimportant that the task that you are coding have the full generality
23*0Sstevel@tonic-gateof being portable, or whether to just get the job done right now.
24*0Sstevel@tonic-gateThis is the hardest choice to be made.  The rest is easy, because
25*0Sstevel@tonic-gatePerl provides many choices, whichever way you want to approach your
26*0Sstevel@tonic-gateproblem.
27*0Sstevel@tonic-gate
28*0Sstevel@tonic-gateLooking at it another way, writing portable code is usually about
29*0Sstevel@tonic-gatewillfully limiting your available choices.  Naturally, it takes
30*0Sstevel@tonic-gatediscipline and sacrifice to do that.  The product of portability
31*0Sstevel@tonic-gateand convenience may be a constant.  You have been warned.
32*0Sstevel@tonic-gate
33*0Sstevel@tonic-gateBe aware of two important points:
34*0Sstevel@tonic-gate
35*0Sstevel@tonic-gate=over 4
36*0Sstevel@tonic-gate
37*0Sstevel@tonic-gate=item Not all Perl programs have to be portable
38*0Sstevel@tonic-gate
39*0Sstevel@tonic-gateThere is no reason you should not use Perl as a language to glue Unix
40*0Sstevel@tonic-gatetools together, or to prototype a Macintosh application, or to manage the
41*0Sstevel@tonic-gateWindows registry.  If it makes no sense to aim for portability for one
42*0Sstevel@tonic-gatereason or another in a given program, then don't bother.
43*0Sstevel@tonic-gate
44*0Sstevel@tonic-gate=item Nearly all of Perl already I<is> portable
45*0Sstevel@tonic-gate
46*0Sstevel@tonic-gateDon't be fooled into thinking that it is hard to create portable Perl
47*0Sstevel@tonic-gatecode.  It isn't.  Perl tries its level-best to bridge the gaps between
48*0Sstevel@tonic-gatewhat's available on different platforms, and all the means available to
49*0Sstevel@tonic-gateuse those features.  Thus almost all Perl code runs on any machine
50*0Sstevel@tonic-gatewithout modification.  But there are some significant issues in
51*0Sstevel@tonic-gatewriting portable code, and this document is entirely about those issues.
52*0Sstevel@tonic-gate
53*0Sstevel@tonic-gate=back
54*0Sstevel@tonic-gate
55*0Sstevel@tonic-gateHere's the general rule: When you approach a task commonly done
56*0Sstevel@tonic-gateusing a whole range of platforms, think about writing portable
57*0Sstevel@tonic-gatecode.  That way, you don't sacrifice much by way of the implementation
58*0Sstevel@tonic-gatechoices you can avail yourself of, and at the same time you can give
59*0Sstevel@tonic-gateyour users lots of platform choices.  On the other hand, when you have to
60*0Sstevel@tonic-gatetake advantage of some unique feature of a particular platform, as is
61*0Sstevel@tonic-gateoften the case with systems programming (whether for Unix, Windows,
62*0Sstevel@tonic-gateS<Mac OS>, VMS, etc.), consider writing platform-specific code.
63*0Sstevel@tonic-gate
64*0Sstevel@tonic-gateWhen the code will run on only two or three operating systems, you
65*0Sstevel@tonic-gatemay need to consider only the differences of those particular systems.
66*0Sstevel@tonic-gateThe important thing is to decide where the code will run and to be
67*0Sstevel@tonic-gatedeliberate in your decision.
68*0Sstevel@tonic-gate
69*0Sstevel@tonic-gateThe material below is separated into three main sections: main issues of
70*0Sstevel@tonic-gateportability (L<"ISSUES">, platform-specific issues (L<"PLATFORMS">, and
71*0Sstevel@tonic-gatebuilt-in perl functions that behave differently on various ports
72*0Sstevel@tonic-gate(L<"FUNCTION IMPLEMENTATIONS">.
73*0Sstevel@tonic-gate
74*0Sstevel@tonic-gateThis information should not be considered complete; it includes possibly
75*0Sstevel@tonic-gatetransient information about idiosyncrasies of some of the ports, almost
76*0Sstevel@tonic-gateall of which are in a state of constant evolution.  Thus, this material
77*0Sstevel@tonic-gateshould be considered a perpetual work in progress
78*0Sstevel@tonic-gate(C<< <IMG SRC="yellow_sign.gif" ALT="Under Construction"> >>).
79*0Sstevel@tonic-gate
80*0Sstevel@tonic-gate=head1 ISSUES
81*0Sstevel@tonic-gate
82*0Sstevel@tonic-gate=head2 Newlines
83*0Sstevel@tonic-gate
84*0Sstevel@tonic-gateIn most operating systems, lines in files are terminated by newlines.
85*0Sstevel@tonic-gateJust what is used as a newline may vary from OS to OS.  Unix
86*0Sstevel@tonic-gatetraditionally uses C<\012>, one type of DOSish I/O uses C<\015\012>,
87*0Sstevel@tonic-gateand S<Mac OS> uses C<\015>.
88*0Sstevel@tonic-gate
89*0Sstevel@tonic-gatePerl uses C<\n> to represent the "logical" newline, where what is
90*0Sstevel@tonic-gatelogical may depend on the platform in use.  In MacPerl, C<\n> always
91*0Sstevel@tonic-gatemeans C<\015>.  In DOSish perls, C<\n> usually means C<\012>, but
92*0Sstevel@tonic-gatewhen accessing a file in "text" mode, STDIO translates it to (or
93*0Sstevel@tonic-gatefrom) C<\015\012>, depending on whether you're reading or writing.
94*0Sstevel@tonic-gateUnix does the same thing on ttys in canonical mode.  C<\015\012>
95*0Sstevel@tonic-gateis commonly referred to as CRLF.
96*0Sstevel@tonic-gate
97*0Sstevel@tonic-gateA common cause of unportable programs is the misuse of chop() to trim
98*0Sstevel@tonic-gatenewlines:
99*0Sstevel@tonic-gate
100*0Sstevel@tonic-gate    # XXX UNPORTABLE!
101*0Sstevel@tonic-gate    while(<FILE>) {
102*0Sstevel@tonic-gate        chop;
103*0Sstevel@tonic-gate        @array = split(/:/);
104*0Sstevel@tonic-gate        #...
105*0Sstevel@tonic-gate    }
106*0Sstevel@tonic-gate
107*0Sstevel@tonic-gateYou can get away with this on Unix and Mac OS (they have a single
108*0Sstevel@tonic-gatecharacter end-of-line), but the same program will break under DOSish
109*0Sstevel@tonic-gateperls because you're only chop()ing half the end-of-line.  Instead,
110*0Sstevel@tonic-gatechomp() should be used to trim newlines.  The Dunce::Files module can
111*0Sstevel@tonic-gatehelp audit your code for misuses of chop().
112*0Sstevel@tonic-gate
113*0Sstevel@tonic-gateWhen dealing with binary files (or text files in binary mode) be sure
114*0Sstevel@tonic-gateto explicitly set $/ to the appropriate value for your file format
115*0Sstevel@tonic-gatebefore using chomp().
116*0Sstevel@tonic-gate
117*0Sstevel@tonic-gateBecause of the "text" mode translation, DOSish perls have limitations
118*0Sstevel@tonic-gatein using C<seek> and C<tell> on a file accessed in "text" mode.
119*0Sstevel@tonic-gateStick to C<seek>-ing to locations you got from C<tell> (and no
120*0Sstevel@tonic-gateothers), and you are usually free to use C<seek> and C<tell> even
121*0Sstevel@tonic-gatein "text" mode.  Using C<seek> or C<tell> or other file operations
122*0Sstevel@tonic-gatemay be non-portable.  If you use C<binmode> on a file, however, you
123*0Sstevel@tonic-gatecan usually C<seek> and C<tell> with arbitrary values in safety.
124*0Sstevel@tonic-gate
125*0Sstevel@tonic-gateA common misconception in socket programming is that C<\n> eq C<\012>
126*0Sstevel@tonic-gateeverywhere.  When using protocols such as common Internet protocols,
127*0Sstevel@tonic-gateC<\012> and C<\015> are called for specifically, and the values of
128*0Sstevel@tonic-gatethe logical C<\n> and C<\r> (carriage return) are not reliable.
129*0Sstevel@tonic-gate
130*0Sstevel@tonic-gate    print SOCKET "Hi there, client!\r\n";      # WRONG
131*0Sstevel@tonic-gate    print SOCKET "Hi there, client!\015\012";  # RIGHT
132*0Sstevel@tonic-gate
133*0Sstevel@tonic-gateHowever, using C<\015\012> (or C<\cM\cJ>, or C<\x0D\x0A>) can be tedious
134*0Sstevel@tonic-gateand unsightly, as well as confusing to those maintaining the code.  As
135*0Sstevel@tonic-gatesuch, the Socket module supplies the Right Thing for those who want it.
136*0Sstevel@tonic-gate
137*0Sstevel@tonic-gate    use Socket qw(:DEFAULT :crlf);
138*0Sstevel@tonic-gate    print SOCKET "Hi there, client!$CRLF"      # RIGHT
139*0Sstevel@tonic-gate
140*0Sstevel@tonic-gateWhen reading from a socket, remember that the default input record
141*0Sstevel@tonic-gateseparator C<$/> is C<\n>, but robust socket code will recognize as
142*0Sstevel@tonic-gateeither C<\012> or C<\015\012> as end of line:
143*0Sstevel@tonic-gate
144*0Sstevel@tonic-gate    while (<SOCKET>) {
145*0Sstevel@tonic-gate        # ...
146*0Sstevel@tonic-gate    }
147*0Sstevel@tonic-gate
148*0Sstevel@tonic-gateBecause both CRLF and LF end in LF, the input record separator can
149*0Sstevel@tonic-gatebe set to LF and any CR stripped later.  Better to write:
150*0Sstevel@tonic-gate
151*0Sstevel@tonic-gate    use Socket qw(:DEFAULT :crlf);
152*0Sstevel@tonic-gate    local($/) = LF;      # not needed if $/ is already \012
153*0Sstevel@tonic-gate
154*0Sstevel@tonic-gate    while (<SOCKET>) {
155*0Sstevel@tonic-gate        s/$CR?$LF/\n/;   # not sure if socket uses LF or CRLF, OK
156*0Sstevel@tonic-gate    #   s/\015?\012/\n/; # same thing
157*0Sstevel@tonic-gate    }
158*0Sstevel@tonic-gate
159*0Sstevel@tonic-gateThis example is preferred over the previous one--even for Unix
160*0Sstevel@tonic-gateplatforms--because now any C<\015>'s (C<\cM>'s) are stripped out
161*0Sstevel@tonic-gate(and there was much rejoicing).
162*0Sstevel@tonic-gate
163*0Sstevel@tonic-gateSimilarly, functions that return text data--such as a function that
164*0Sstevel@tonic-gatefetches a web page--should sometimes translate newlines before
165*0Sstevel@tonic-gatereturning the data, if they've not yet been translated to the local
166*0Sstevel@tonic-gatenewline representation.  A single line of code will often suffice:
167*0Sstevel@tonic-gate
168*0Sstevel@tonic-gate    $data =~ s/\015?\012/\n/g;
169*0Sstevel@tonic-gate    return $data;
170*0Sstevel@tonic-gate
171*0Sstevel@tonic-gateSome of this may be confusing.  Here's a handy reference to the ASCII CR
172*0Sstevel@tonic-gateand LF characters.  You can print it out and stick it in your wallet.
173*0Sstevel@tonic-gate
174*0Sstevel@tonic-gate    LF  eq  \012  eq  \x0A  eq  \cJ  eq  chr(10)  eq  ASCII 10
175*0Sstevel@tonic-gate    CR  eq  \015  eq  \x0D  eq  \cM  eq  chr(13)  eq  ASCII 13
176*0Sstevel@tonic-gate
177*0Sstevel@tonic-gate             | Unix | DOS  | Mac  |
178*0Sstevel@tonic-gate        ---------------------------
179*0Sstevel@tonic-gate        \n   |  LF  |  LF  |  CR  |
180*0Sstevel@tonic-gate        \r   |  CR  |  CR  |  LF  |
181*0Sstevel@tonic-gate        \n * |  LF  | CRLF |  CR  |
182*0Sstevel@tonic-gate        \r * |  CR  |  CR  |  LF  |
183*0Sstevel@tonic-gate        ---------------------------
184*0Sstevel@tonic-gate        * text-mode STDIO
185*0Sstevel@tonic-gate
186*0Sstevel@tonic-gateThe Unix column assumes that you are not accessing a serial line
187*0Sstevel@tonic-gate(like a tty) in canonical mode.  If you are, then CR on input becomes
188*0Sstevel@tonic-gate"\n", and "\n" on output becomes CRLF.
189*0Sstevel@tonic-gate
190*0Sstevel@tonic-gateThese are just the most common definitions of C<\n> and C<\r> in Perl.
191*0Sstevel@tonic-gateThere may well be others.  For example, on an EBCDIC implementation
192*0Sstevel@tonic-gatesuch as z/OS (OS/390) or OS/400 (using the ILE, the PASE is ASCII-based)
193*0Sstevel@tonic-gatethe above material is similar to "Unix" but the code numbers change:
194*0Sstevel@tonic-gate
195*0Sstevel@tonic-gate    LF  eq  \025  eq  \x15  eq  \cU  eq  chr(21)  eq  CP-1047 21
196*0Sstevel@tonic-gate    LF  eq  \045  eq  \x25  eq           chr(37)  eq  CP-0037 37
197*0Sstevel@tonic-gate    CR  eq  \015  eq  \x0D  eq  \cM  eq  chr(13)  eq  CP-1047 13
198*0Sstevel@tonic-gate    CR  eq  \015  eq  \x0D  eq  \cM  eq  chr(13)  eq  CP-0037 13
199*0Sstevel@tonic-gate
200*0Sstevel@tonic-gate             | z/OS | OS/400 |
201*0Sstevel@tonic-gate        ----------------------
202*0Sstevel@tonic-gate        \n   |  LF  |  LF    |
203*0Sstevel@tonic-gate        \r   |  CR  |  CR    |
204*0Sstevel@tonic-gate        \n * |  LF  |  LF    |
205*0Sstevel@tonic-gate        \r * |  CR  |  CR    |
206*0Sstevel@tonic-gate        ----------------------
207*0Sstevel@tonic-gate        * text-mode STDIO
208*0Sstevel@tonic-gate
209*0Sstevel@tonic-gate=head2 Numbers endianness and Width
210*0Sstevel@tonic-gate
211*0Sstevel@tonic-gateDifferent CPUs store integers and floating point numbers in different
212*0Sstevel@tonic-gateorders (called I<endianness>) and widths (32-bit and 64-bit being the
213*0Sstevel@tonic-gatemost common today).  This affects your programs when they attempt to transfer
214*0Sstevel@tonic-gatenumbers in binary format from one CPU architecture to another,
215*0Sstevel@tonic-gateusually either "live" via network connection, or by storing the
216*0Sstevel@tonic-gatenumbers to secondary storage such as a disk file or tape.
217*0Sstevel@tonic-gate
218*0Sstevel@tonic-gateConflicting storage orders make utter mess out of the numbers.  If a
219*0Sstevel@tonic-gatelittle-endian host (Intel, VAX) stores 0x12345678 (305419896 in
220*0Sstevel@tonic-gatedecimal), a big-endian host (Motorola, Sparc, PA) reads it as
221*0Sstevel@tonic-gate0x78563412 (2018915346 in decimal).  Alpha and MIPS can be either:
222*0Sstevel@tonic-gateDigital/Compaq used/uses them in little-endian mode; SGI/Cray uses
223*0Sstevel@tonic-gatethem in big-endian mode.  To avoid this problem in network (socket)
224*0Sstevel@tonic-gateconnections use the C<pack> and C<unpack> formats C<n> and C<N>, the
225*0Sstevel@tonic-gate"network" orders.  These are guaranteed to be portable.
226*0Sstevel@tonic-gate
227*0Sstevel@tonic-gateYou can explore the endianness of your platform by unpacking a
228*0Sstevel@tonic-gatedata structure packed in native format such as:
229*0Sstevel@tonic-gate
230*0Sstevel@tonic-gate    print unpack("h*", pack("s2", 1, 2)), "\n";
231*0Sstevel@tonic-gate    # '10002000' on e.g. Intel x86 or Alpha 21064 in little-endian mode
232*0Sstevel@tonic-gate    # '00100020' on e.g. Motorola 68040
233*0Sstevel@tonic-gate
234*0Sstevel@tonic-gateIf you need to distinguish between endian architectures you could use
235*0Sstevel@tonic-gateeither of the variables set like so:
236*0Sstevel@tonic-gate
237*0Sstevel@tonic-gate    $is_big_endian   = unpack("h*", pack("s", 1)) =~ /01/;
238*0Sstevel@tonic-gate    $is_little_endian = unpack("h*", pack("s", 1)) =~ /^1/;
239*0Sstevel@tonic-gate
240*0Sstevel@tonic-gateDiffering widths can cause truncation even between platforms of equal
241*0Sstevel@tonic-gateendianness.  The platform of shorter width loses the upper parts of the
242*0Sstevel@tonic-gatenumber.  There is no good solution for this problem except to avoid
243*0Sstevel@tonic-gatetransferring or storing raw binary numbers.
244*0Sstevel@tonic-gate
245*0Sstevel@tonic-gateOne can circumnavigate both these problems in two ways.  Either
246*0Sstevel@tonic-gatetransfer and store numbers always in text format, instead of raw
247*0Sstevel@tonic-gatebinary, or else consider using modules like Data::Dumper (included in
248*0Sstevel@tonic-gatethe standard distribution as of Perl 5.005) and Storable (included as
249*0Sstevel@tonic-gateof perl 5.8).  Keeping all data as text significantly simplifies matters.
250*0Sstevel@tonic-gate
251*0Sstevel@tonic-gateThe v-strings are portable only up to v2147483647 (0x7FFFFFFF), that's
252*0Sstevel@tonic-gatehow far EBCDIC, or more precisely UTF-EBCDIC will go.
253*0Sstevel@tonic-gate
254*0Sstevel@tonic-gate=head2 Files and Filesystems
255*0Sstevel@tonic-gate
256*0Sstevel@tonic-gateMost platforms these days structure files in a hierarchical fashion.
257*0Sstevel@tonic-gateSo, it is reasonably safe to assume that all platforms support the
258*0Sstevel@tonic-gatenotion of a "path" to uniquely identify a file on the system.  How
259*0Sstevel@tonic-gatethat path is really written, though, differs considerably.
260*0Sstevel@tonic-gate
261*0Sstevel@tonic-gateAlthough similar, file path specifications differ between Unix,
262*0Sstevel@tonic-gateWindows, S<Mac OS>, OS/2, VMS, VOS, S<RISC OS>, and probably others.
263*0Sstevel@tonic-gateUnix, for example, is one of the few OSes that has the elegant idea
264*0Sstevel@tonic-gateof a single root directory.
265*0Sstevel@tonic-gate
266*0Sstevel@tonic-gateDOS, OS/2, VMS, VOS, and Windows can work similarly to Unix with C</>
267*0Sstevel@tonic-gateas path separator, or in their own idiosyncratic ways (such as having
268*0Sstevel@tonic-gateseveral root directories and various "unrooted" device files such NIL:
269*0Sstevel@tonic-gateand LPT:).
270*0Sstevel@tonic-gate
271*0Sstevel@tonic-gateS<Mac OS> uses C<:> as a path separator instead of C</>.
272*0Sstevel@tonic-gate
273*0Sstevel@tonic-gateThe filesystem may support neither hard links (C<link>) nor
274*0Sstevel@tonic-gatesymbolic links (C<symlink>, C<readlink>, C<lstat>).
275*0Sstevel@tonic-gate
276*0Sstevel@tonic-gateThe filesystem may support neither access timestamp nor change
277*0Sstevel@tonic-gatetimestamp (meaning that about the only portable timestamp is the
278*0Sstevel@tonic-gatemodification timestamp), or one second granularity of any timestamps
279*0Sstevel@tonic-gate(e.g. the FAT filesystem limits the time granularity to two seconds).
280*0Sstevel@tonic-gate
281*0Sstevel@tonic-gateThe "inode change timestamp" (the C<-C> filetest) may really be the
282*0Sstevel@tonic-gate"creation timestamp" (which it is not in UNIX).
283*0Sstevel@tonic-gate
284*0Sstevel@tonic-gateVOS perl can emulate Unix filenames with C</> as path separator.  The
285*0Sstevel@tonic-gatenative pathname characters greater-than, less-than, number-sign, and
286*0Sstevel@tonic-gatepercent-sign are always accepted.
287*0Sstevel@tonic-gate
288*0Sstevel@tonic-gateS<RISC OS> perl can emulate Unix filenames with C</> as path
289*0Sstevel@tonic-gateseparator, or go native and use C<.> for path separator and C<:> to
290*0Sstevel@tonic-gatesignal filesystems and disk names.
291*0Sstevel@tonic-gate
292*0Sstevel@tonic-gateDon't assume UNIX filesystem access semantics: that read, write,
293*0Sstevel@tonic-gateand execute are all the permissions there are, and even if they exist,
294*0Sstevel@tonic-gatethat their semantics (for example what do r, w, and x mean on
295*0Sstevel@tonic-gatea directory) are the UNIX ones.  The various UNIX/POSIX compatibility
296*0Sstevel@tonic-gatelayers usually try to make interfaces like chmod() work, but sometimes
297*0Sstevel@tonic-gatethere simply is no good mapping.
298*0Sstevel@tonic-gate
299*0Sstevel@tonic-gateIf all this is intimidating, have no (well, maybe only a little)
300*0Sstevel@tonic-gatefear.  There are modules that can help.  The File::Spec modules
301*0Sstevel@tonic-gateprovide methods to do the Right Thing on whatever platform happens
302*0Sstevel@tonic-gateto be running the program.
303*0Sstevel@tonic-gate
304*0Sstevel@tonic-gate    use File::Spec::Functions;
305*0Sstevel@tonic-gate    chdir(updir());        # go up one directory
306*0Sstevel@tonic-gate    $file = catfile(curdir(), 'temp', 'file.txt');
307*0Sstevel@tonic-gate    # on Unix and Win32, './temp/file.txt'
308*0Sstevel@tonic-gate    # on Mac OS, ':temp:file.txt'
309*0Sstevel@tonic-gate    # on VMS, '[.temp]file.txt'
310*0Sstevel@tonic-gate
311*0Sstevel@tonic-gateFile::Spec is available in the standard distribution as of version
312*0Sstevel@tonic-gate5.004_05.  File::Spec::Functions is only in File::Spec 0.7 and later,
313*0Sstevel@tonic-gateand some versions of perl come with version 0.6.  If File::Spec
314*0Sstevel@tonic-gateis not updated to 0.7 or later, you must use the object-oriented
315*0Sstevel@tonic-gateinterface from File::Spec (or upgrade File::Spec).
316*0Sstevel@tonic-gate
317*0Sstevel@tonic-gateIn general, production code should not have file paths hardcoded.
318*0Sstevel@tonic-gateMaking them user-supplied or read from a configuration file is
319*0Sstevel@tonic-gatebetter, keeping in mind that file path syntax varies on different
320*0Sstevel@tonic-gatemachines.
321*0Sstevel@tonic-gate
322*0Sstevel@tonic-gateThis is especially noticeable in scripts like Makefiles and test suites,
323*0Sstevel@tonic-gatewhich often assume C</> as a path separator for subdirectories.
324*0Sstevel@tonic-gate
325*0Sstevel@tonic-gateAlso of use is File::Basename from the standard distribution, which
326*0Sstevel@tonic-gatesplits a pathname into pieces (base filename, full path to directory,
327*0Sstevel@tonic-gateand file suffix).
328*0Sstevel@tonic-gate
329*0Sstevel@tonic-gateEven when on a single platform (if you can call Unix a single platform),
330*0Sstevel@tonic-gateremember not to count on the existence or the contents of particular
331*0Sstevel@tonic-gatesystem-specific files or directories, like F</etc/passwd>,
332*0Sstevel@tonic-gateF</etc/sendmail.conf>, F</etc/resolv.conf>, or even F</tmp/>.  For
333*0Sstevel@tonic-gateexample, F</etc/passwd> may exist but not contain the encrypted
334*0Sstevel@tonic-gatepasswords, because the system is using some form of enhanced security.
335*0Sstevel@tonic-gateOr it may not contain all the accounts, because the system is using NIS.
336*0Sstevel@tonic-gateIf code does need to rely on such a file, include a description of the
337*0Sstevel@tonic-gatefile and its format in the code's documentation, then make it easy for
338*0Sstevel@tonic-gatethe user to override the default location of the file.
339*0Sstevel@tonic-gate
340*0Sstevel@tonic-gateDon't assume a text file will end with a newline.  They should,
341*0Sstevel@tonic-gatebut people forget.
342*0Sstevel@tonic-gate
343*0Sstevel@tonic-gateDo not have two files or directories of the same name with different
344*0Sstevel@tonic-gatecase, like F<test.pl> and F<Test.pl>, as many platforms have
345*0Sstevel@tonic-gatecase-insensitive (or at least case-forgiving) filenames.  Also, try
346*0Sstevel@tonic-gatenot to have non-word characters (except for C<.>) in the names, and
347*0Sstevel@tonic-gatekeep them to the 8.3 convention, for maximum portability, onerous a
348*0Sstevel@tonic-gateburden though this may appear.
349*0Sstevel@tonic-gate
350*0Sstevel@tonic-gateLikewise, when using the AutoSplit module, try to keep your functions to
351*0Sstevel@tonic-gate8.3 naming and case-insensitive conventions; or, at the least,
352*0Sstevel@tonic-gatemake it so the resulting files have a unique (case-insensitively)
353*0Sstevel@tonic-gatefirst 8 characters.
354*0Sstevel@tonic-gate
355*0Sstevel@tonic-gateWhitespace in filenames is tolerated on most systems, but not all,
356*0Sstevel@tonic-gateand even on systems where it might be tolerated, some utilities
357*0Sstevel@tonic-gatemight become confused by such whitespace.
358*0Sstevel@tonic-gate
359*0Sstevel@tonic-gateMany systems (DOS, VMS) cannot have more than one C<.> in their filenames.
360*0Sstevel@tonic-gate
361*0Sstevel@tonic-gateDon't assume C<< > >> won't be the first character of a filename.
362*0Sstevel@tonic-gateAlways use C<< < >> explicitly to open a file for reading, or even
363*0Sstevel@tonic-gatebetter, use the three-arg version of open, unless you want the user to
364*0Sstevel@tonic-gatebe able to specify a pipe open.
365*0Sstevel@tonic-gate
366*0Sstevel@tonic-gate    open(FILE, '<', $existing_file) or die $!;
367*0Sstevel@tonic-gate
368*0Sstevel@tonic-gateIf filenames might use strange characters, it is safest to open it
369*0Sstevel@tonic-gatewith C<sysopen> instead of C<open>.  C<open> is magic and can
370*0Sstevel@tonic-gatetranslate characters like C<< > >>, C<< < >>, and C<|>, which may
371*0Sstevel@tonic-gatebe the wrong thing to do.  (Sometimes, though, it's the right thing.)
372*0Sstevel@tonic-gateThree-arg open can also help protect against this translation in cases
373*0Sstevel@tonic-gatewhere it is undesirable.
374*0Sstevel@tonic-gate
375*0Sstevel@tonic-gateDon't use C<:> as a part of a filename since many systems use that for
376*0Sstevel@tonic-gatetheir own semantics (Mac OS Classic for separating pathname components,
377*0Sstevel@tonic-gatemany networking schemes and utilities for separating the nodename and
378*0Sstevel@tonic-gatethe pathname, and so on).  For the same reasons, avoid C<@>, C<;> and
379*0Sstevel@tonic-gateC<|>.
380*0Sstevel@tonic-gate
381*0Sstevel@tonic-gateDon't assume that in pathnames you can collapse two leading slashes
382*0Sstevel@tonic-gateC<//> into one: some networking and clustering filesystems have special
383*0Sstevel@tonic-gatesemantics for that.  Let the operating system to sort it out.
384*0Sstevel@tonic-gate
385*0Sstevel@tonic-gateThe I<portable filename characters> as defined by ANSI C are
386*0Sstevel@tonic-gate
387*0Sstevel@tonic-gate 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
388*0Sstevel@tonic-gate 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
389*0Sstevel@tonic-gate 0 1 2 3 4 5 6 7 8 9
390*0Sstevel@tonic-gate . _ -
391*0Sstevel@tonic-gate
392*0Sstevel@tonic-gateand the "-" shouldn't be the first character.  If you want to be
393*0Sstevel@tonic-gatehypercorrect, stay case-insensitive and within the 8.3 naming
394*0Sstevel@tonic-gateconvention (all the files and directories have to be unique within one
395*0Sstevel@tonic-gatedirectory if their names are lowercased and truncated to eight
396*0Sstevel@tonic-gatecharacters before the C<.>, if any, and to three characters after the
397*0Sstevel@tonic-gateC<.>, if any).  (And do not use C<.>s in directory names.)
398*0Sstevel@tonic-gate
399*0Sstevel@tonic-gate=head2 System Interaction
400*0Sstevel@tonic-gate
401*0Sstevel@tonic-gateNot all platforms provide a command line.  These are usually platforms
402*0Sstevel@tonic-gatethat rely primarily on a Graphical User Interface (GUI) for user
403*0Sstevel@tonic-gateinteraction.  A program requiring a command line interface might
404*0Sstevel@tonic-gatenot work everywhere.  This is probably for the user of the program
405*0Sstevel@tonic-gateto deal with, so don't stay up late worrying about it.
406*0Sstevel@tonic-gate
407*0Sstevel@tonic-gateSome platforms can't delete or rename files held open by the system,
408*0Sstevel@tonic-gatethis limitation may also apply to changing filesystem metainformation
409*0Sstevel@tonic-gatelike file permissions or owners.  Remember to C<close> files when you
410*0Sstevel@tonic-gateare done with them.  Don't C<unlink> or C<rename> an open file.  Don't
411*0Sstevel@tonic-gateC<tie> or C<open> a file already tied or opened; C<untie> or C<close>
412*0Sstevel@tonic-gateit first.
413*0Sstevel@tonic-gate
414*0Sstevel@tonic-gateDon't open the same file more than once at a time for writing, as some
415*0Sstevel@tonic-gateoperating systems put mandatory locks on such files.
416*0Sstevel@tonic-gate
417*0Sstevel@tonic-gateDon't assume that write/modify permission on a directory gives the
418*0Sstevel@tonic-gateright to add or delete files/directories in that directory.  That is
419*0Sstevel@tonic-gatefilesystem specific: in some filesystems you need write/modify
420*0Sstevel@tonic-gatepermission also (or even just) in the file/directory itself.  In some
421*0Sstevel@tonic-gatefilesystems (AFS, DFS) the permission to add/delete directory entries
422*0Sstevel@tonic-gateis a completely separate permission.
423*0Sstevel@tonic-gate
424*0Sstevel@tonic-gateDon't assume that a single C<unlink> completely gets rid of the file:
425*0Sstevel@tonic-gatesome filesystems (most notably the ones in VMS) have versioned
426*0Sstevel@tonic-gatefilesystems, and unlink() removes only the most recent one (it doesn't
427*0Sstevel@tonic-gateremove all the versions because by default the native tools on those
428*0Sstevel@tonic-gateplatforms remove just the most recent version, too).  The portable
429*0Sstevel@tonic-gateidiom to remove all the versions of a file is
430*0Sstevel@tonic-gate
431*0Sstevel@tonic-gate    1 while unlink "file";
432*0Sstevel@tonic-gate
433*0Sstevel@tonic-gateThis will terminate if the file is undeleteable for some reason
434*0Sstevel@tonic-gate(protected, not there, and so on).
435*0Sstevel@tonic-gate
436*0Sstevel@tonic-gateDon't count on a specific environment variable existing in C<%ENV>.
437*0Sstevel@tonic-gateDon't count on C<%ENV> entries being case-sensitive, or even
438*0Sstevel@tonic-gatecase-preserving.  Don't try to clear %ENV by saying C<%ENV = ();>, or,
439*0Sstevel@tonic-gateif you really have to, make it conditional on C<$^O ne 'VMS'> since in
440*0Sstevel@tonic-gateVMS the C<%ENV> table is much more than a per-process key-value string
441*0Sstevel@tonic-gatetable.
442*0Sstevel@tonic-gate
443*0Sstevel@tonic-gateDon't count on signals or C<%SIG> for anything.
444*0Sstevel@tonic-gate
445*0Sstevel@tonic-gateDon't count on filename globbing.  Use C<opendir>, C<readdir>, and
446*0Sstevel@tonic-gateC<closedir> instead.
447*0Sstevel@tonic-gate
448*0Sstevel@tonic-gateDon't count on per-program environment variables, or per-program current
449*0Sstevel@tonic-gatedirectories.
450*0Sstevel@tonic-gate
451*0Sstevel@tonic-gateDon't count on specific values of C<$!>, neither numeric nor
452*0Sstevel@tonic-gateespecially the strings values-- users may switch their locales causing
453*0Sstevel@tonic-gateerror messages to be translated into their languages.  If you can
454*0Sstevel@tonic-gatetrust a POSIXish environment, you can portably use the symbols defined
455*0Sstevel@tonic-gateby the Errno module, like ENOENT.  And don't trust on the values of C<$!>
456*0Sstevel@tonic-gateat all except immediately after a failed system call.
457*0Sstevel@tonic-gate
458*0Sstevel@tonic-gate=head2 Command names versus file pathnames
459*0Sstevel@tonic-gate
460*0Sstevel@tonic-gateDon't assume that the name used to invoke a command or program with
461*0Sstevel@tonic-gateC<system> or C<exec> can also be used to test for the existence of the
462*0Sstevel@tonic-gatefile that holds the executable code for that command or program.
463*0Sstevel@tonic-gateFirst, many systems have "internal" commands that are built-in to the
464*0Sstevel@tonic-gateshell or OS and while these commands can be invoked, there is no
465*0Sstevel@tonic-gatecorresponding file.  Second, some operating systems (e.g., Cygwin,
466*0Sstevel@tonic-gateDJGPP, OS/2, and VOS) have required suffixes for executable files;
467*0Sstevel@tonic-gatethese suffixes are generally permitted on the command name but are not
468*0Sstevel@tonic-gaterequired.  Thus, a command like "perl" might exist in a file named
469*0Sstevel@tonic-gate"perl", "perl.exe", or "perl.pm", depending on the operating system.
470*0Sstevel@tonic-gateThe variable "_exe" in the Config module holds the executable suffix,
471*0Sstevel@tonic-gateif any.  Third, the VMS port carefully sets up $^X and
472*0Sstevel@tonic-gate$Config{perlpath} so that no further processing is required.  This is
473*0Sstevel@tonic-gatejust as well, because the matching regular expression used below would
474*0Sstevel@tonic-gatethen have to deal with a possible trailing version number in the VMS
475*0Sstevel@tonic-gatefile name.
476*0Sstevel@tonic-gate
477*0Sstevel@tonic-gateTo convert $^X to a file pathname, taking account of the requirements
478*0Sstevel@tonic-gateof the various operating system possibilities, say:
479*0Sstevel@tonic-gate  use Config;
480*0Sstevel@tonic-gate  $thisperl = $^X;
481*0Sstevel@tonic-gate  if ($^O ne 'VMS')
482*0Sstevel@tonic-gate     {$thisperl .= $Config{_exe} unless $thisperl =~ m/$Config{_exe}$/i;}
483*0Sstevel@tonic-gate
484*0Sstevel@tonic-gateTo convert $Config{perlpath} to a file pathname, say:
485*0Sstevel@tonic-gate  use Config;
486*0Sstevel@tonic-gate  $thisperl = $Config{perlpath};
487*0Sstevel@tonic-gate  if ($^O ne 'VMS')
488*0Sstevel@tonic-gate     {$thisperl .= $Config{_exe} unless $thisperl =~ m/$Config{_exe}$/i;}
489*0Sstevel@tonic-gate
490*0Sstevel@tonic-gate=head2 Networking
491*0Sstevel@tonic-gate
492*0Sstevel@tonic-gateDon't assume that you can reach the public Internet.
493*0Sstevel@tonic-gate
494*0Sstevel@tonic-gateDon't assume that there is only one way to get through firewalls
495*0Sstevel@tonic-gateto the public Internet.
496*0Sstevel@tonic-gate
497*0Sstevel@tonic-gateDon't assume that you can reach outside world through any other port
498*0Sstevel@tonic-gatethan 80, or some web proxy.  ftp is blocked by many firewalls.
499*0Sstevel@tonic-gate
500*0Sstevel@tonic-gateDon't assume that you can send email by connecting to the local SMTP port.
501*0Sstevel@tonic-gate
502*0Sstevel@tonic-gateDon't assume that you can reach yourself or any node by the name
503*0Sstevel@tonic-gate'localhost'.  The same goes for '127.0.0.1'.  You will have to try both.
504*0Sstevel@tonic-gate
505*0Sstevel@tonic-gateDon't assume that the host has only one network card, or that it
506*0Sstevel@tonic-gatecan't bind to many virtual IP addresses.
507*0Sstevel@tonic-gate
508*0Sstevel@tonic-gateDon't assume a particular network device name.
509*0Sstevel@tonic-gate
510*0Sstevel@tonic-gateDon't assume a particular set of ioctl()s will work.
511*0Sstevel@tonic-gate
512*0Sstevel@tonic-gateDon't assume that you can ping hosts and get replies.
513*0Sstevel@tonic-gate
514*0Sstevel@tonic-gateDon't assume that any particular port (service) will respond.
515*0Sstevel@tonic-gate
516*0Sstevel@tonic-gateDon't assume that Sys::Hostname() (or any other API or command)
517*0Sstevel@tonic-gatereturns either a fully qualified hostname or a non-qualified hostname:
518*0Sstevel@tonic-gateit all depends on how the system had been configured.  Also remember
519*0Sstevel@tonic-gatethings like DHCP and NAT-- the hostname you get back might not be very
520*0Sstevel@tonic-gateuseful.
521*0Sstevel@tonic-gate
522*0Sstevel@tonic-gateAll the above "don't":s may look daunting, and they are -- but the key
523*0Sstevel@tonic-gateis to degrade gracefully if one cannot reach the particular network
524*0Sstevel@tonic-gateservice one wants.  Croaking or hanging do not look very professional.
525*0Sstevel@tonic-gate
526*0Sstevel@tonic-gate=head2 Interprocess Communication (IPC)
527*0Sstevel@tonic-gate
528*0Sstevel@tonic-gateIn general, don't directly access the system in code meant to be
529*0Sstevel@tonic-gateportable.  That means, no C<system>, C<exec>, C<fork>, C<pipe>,
530*0Sstevel@tonic-gateC<``>, C<qx//>, C<open> with a C<|>, nor any of the other things
531*0Sstevel@tonic-gatethat makes being a perl hacker worth being.
532*0Sstevel@tonic-gate
533*0Sstevel@tonic-gateCommands that launch external processes are generally supported on
534*0Sstevel@tonic-gatemost platforms (though many of them do not support any type of
535*0Sstevel@tonic-gateforking).  The problem with using them arises from what you invoke
536*0Sstevel@tonic-gatethem on.  External tools are often named differently on different
537*0Sstevel@tonic-gateplatforms, may not be available in the same location, might accept
538*0Sstevel@tonic-gatedifferent arguments, can behave differently, and often present their
539*0Sstevel@tonic-gateresults in a platform-dependent way.  Thus, you should seldom depend
540*0Sstevel@tonic-gateon them to produce consistent results. (Then again, if you're calling
541*0Sstevel@tonic-gateI<netstat -a>, you probably don't expect it to run on both Unix and CP/M.)
542*0Sstevel@tonic-gate
543*0Sstevel@tonic-gateOne especially common bit of Perl code is opening a pipe to B<sendmail>:
544*0Sstevel@tonic-gate
545*0Sstevel@tonic-gate    open(MAIL, '|/usr/lib/sendmail -t')
546*0Sstevel@tonic-gate	or die "cannot fork sendmail: $!";
547*0Sstevel@tonic-gate
548*0Sstevel@tonic-gateThis is fine for systems programming when sendmail is known to be
549*0Sstevel@tonic-gateavailable.  But it is not fine for many non-Unix systems, and even
550*0Sstevel@tonic-gatesome Unix systems that may not have sendmail installed.  If a portable
551*0Sstevel@tonic-gatesolution is needed, see the various distributions on CPAN that deal
552*0Sstevel@tonic-gatewith it.  Mail::Mailer and Mail::Send in the MailTools distribution are
553*0Sstevel@tonic-gatecommonly used, and provide several mailing methods, including mail,
554*0Sstevel@tonic-gatesendmail, and direct SMTP (via Net::SMTP) if a mail transfer agent is
555*0Sstevel@tonic-gatenot available.  Mail::Sendmail is a standalone module that provides
556*0Sstevel@tonic-gatesimple, platform-independent mailing.
557*0Sstevel@tonic-gate
558*0Sstevel@tonic-gateThe Unix System V IPC (C<msg*(), sem*(), shm*()>) is not available
559*0Sstevel@tonic-gateeven on all Unix platforms.
560*0Sstevel@tonic-gate
561*0Sstevel@tonic-gateDo not use either the bare result of C<pack("N", 10, 20, 30, 40)> or
562*0Sstevel@tonic-gatebare v-strings (such as C<v10.20.30.40>) to represent IPv4 addresses:
563*0Sstevel@tonic-gateboth forms just pack the four bytes into network order.  That this
564*0Sstevel@tonic-gatewould be equal to the C language C<in_addr> struct (which is what the
565*0Sstevel@tonic-gatesocket code internally uses) is not guaranteed.  To be portable use
566*0Sstevel@tonic-gatethe routines of the Socket extension, such as C<inet_aton()>,
567*0Sstevel@tonic-gateC<inet_ntoa()>, and C<sockaddr_in()>.
568*0Sstevel@tonic-gate
569*0Sstevel@tonic-gateThe rule of thumb for portable code is: Do it all in portable Perl, or
570*0Sstevel@tonic-gateuse a module (that may internally implement it with platform-specific
571*0Sstevel@tonic-gatecode, but expose a common interface).
572*0Sstevel@tonic-gate
573*0Sstevel@tonic-gate=head2 External Subroutines (XS)
574*0Sstevel@tonic-gate
575*0Sstevel@tonic-gateXS code can usually be made to work with any platform, but dependent
576*0Sstevel@tonic-gatelibraries, header files, etc., might not be readily available or
577*0Sstevel@tonic-gateportable, or the XS code itself might be platform-specific, just as Perl
578*0Sstevel@tonic-gatecode might be.  If the libraries and headers are portable, then it is
579*0Sstevel@tonic-gatenormally reasonable to make sure the XS code is portable, too.
580*0Sstevel@tonic-gate
581*0Sstevel@tonic-gateA different type of portability issue arises when writing XS code:
582*0Sstevel@tonic-gateavailability of a C compiler on the end-user's system.  C brings
583*0Sstevel@tonic-gatewith it its own portability issues, and writing XS code will expose
584*0Sstevel@tonic-gateyou to some of those.  Writing purely in Perl is an easier way to
585*0Sstevel@tonic-gateachieve portability.
586*0Sstevel@tonic-gate
587*0Sstevel@tonic-gate=head2 Standard Modules
588*0Sstevel@tonic-gate
589*0Sstevel@tonic-gateIn general, the standard modules work across platforms.  Notable
590*0Sstevel@tonic-gateexceptions are the CPAN module (which currently makes connections to external
591*0Sstevel@tonic-gateprograms that may not be available), platform-specific modules (like
592*0Sstevel@tonic-gateExtUtils::MM_VMS), and DBM modules.
593*0Sstevel@tonic-gate
594*0Sstevel@tonic-gateThere is no one DBM module available on all platforms.
595*0Sstevel@tonic-gateSDBM_File and the others are generally available on all Unix and DOSish
596*0Sstevel@tonic-gateports, but not in MacPerl, where only NBDM_File and DB_File are
597*0Sstevel@tonic-gateavailable.
598*0Sstevel@tonic-gate
599*0Sstevel@tonic-gateThe good news is that at least some DBM module should be available, and
600*0Sstevel@tonic-gateAnyDBM_File will use whichever module it can find.  Of course, then
601*0Sstevel@tonic-gatethe code needs to be fairly strict, dropping to the greatest common
602*0Sstevel@tonic-gatefactor (e.g., not exceeding 1K for each record), so that it will
603*0Sstevel@tonic-gatework with any DBM module.  See L<AnyDBM_File> for more details.
604*0Sstevel@tonic-gate
605*0Sstevel@tonic-gate=head2 Time and Date
606*0Sstevel@tonic-gate
607*0Sstevel@tonic-gateThe system's notion of time of day and calendar date is controlled in
608*0Sstevel@tonic-gatewidely different ways.  Don't assume the timezone is stored in C<$ENV{TZ}>,
609*0Sstevel@tonic-gateand even if it is, don't assume that you can control the timezone through
610*0Sstevel@tonic-gatethat variable.  Don't assume anything about the three-letter timezone
611*0Sstevel@tonic-gateabbreviations (for example that MST would be the Mountain Standard Time,
612*0Sstevel@tonic-gateit's been known to stand for Moscow Standard Time).  If you need to
613*0Sstevel@tonic-gateuse timezones, express them in some unambiguous format like the
614*0Sstevel@tonic-gateexact number of minutes offset from UTC, or the POSIX timezone
615*0Sstevel@tonic-gateformat.
616*0Sstevel@tonic-gate
617*0Sstevel@tonic-gateDon't assume that the epoch starts at 00:00:00, January 1, 1970,
618*0Sstevel@tonic-gatebecause that is OS- and implementation-specific.  It is better to
619*0Sstevel@tonic-gatestore a date in an unambiguous representation.  The ISO 8601 standard
620*0Sstevel@tonic-gatedefines YYYY-MM-DD as the date format, or YYYY-MM-DDTHH-MM-SS
621*0Sstevel@tonic-gate(that's a literal "T" separating the date from the time).
622*0Sstevel@tonic-gatePlease do use the ISO 8601 instead of making us to guess what
623*0Sstevel@tonic-gatedate 02/03/04 might be.  ISO 8601 even sorts nicely as-is.
624*0Sstevel@tonic-gateA text representation (like "1987-12-18") can be easily converted
625*0Sstevel@tonic-gateinto an OS-specific value using a module like Date::Parse.
626*0Sstevel@tonic-gateAn array of values, such as those returned by C<localtime>, can be
627*0Sstevel@tonic-gateconverted to an OS-specific representation using Time::Local.
628*0Sstevel@tonic-gate
629*0Sstevel@tonic-gateWhen calculating specific times, such as for tests in time or date modules,
630*0Sstevel@tonic-gateit may be appropriate to calculate an offset for the epoch.
631*0Sstevel@tonic-gate
632*0Sstevel@tonic-gate    require Time::Local;
633*0Sstevel@tonic-gate    $offset = Time::Local::timegm(0, 0, 0, 1, 0, 70);
634*0Sstevel@tonic-gate
635*0Sstevel@tonic-gateThe value for C<$offset> in Unix will be C<0>, but in Mac OS will be
636*0Sstevel@tonic-gatesome large number.  C<$offset> can then be added to a Unix time value
637*0Sstevel@tonic-gateto get what should be the proper value on any system.
638*0Sstevel@tonic-gate
639*0Sstevel@tonic-gateOn Windows (at least), you shouldn't pass a negative value to C<gmtime> or
640*0Sstevel@tonic-gateC<localtime>.
641*0Sstevel@tonic-gate
642*0Sstevel@tonic-gate=head2 Character sets and character encoding
643*0Sstevel@tonic-gate
644*0Sstevel@tonic-gateAssume very little about character sets.
645*0Sstevel@tonic-gate
646*0Sstevel@tonic-gateAssume nothing about numerical values (C<ord>, C<chr>) of characters.
647*0Sstevel@tonic-gateDo not use explicit code point ranges (like \xHH-\xHH); use for
648*0Sstevel@tonic-gateexample symbolic character classes like C<[:print:]>.
649*0Sstevel@tonic-gate
650*0Sstevel@tonic-gateDo not assume that the alphabetic characters are encoded contiguously
651*0Sstevel@tonic-gate(in the numeric sense).  There may be gaps.
652*0Sstevel@tonic-gate
653*0Sstevel@tonic-gateDo not assume anything about the ordering of the characters.
654*0Sstevel@tonic-gateThe lowercase letters may come before or after the uppercase letters;
655*0Sstevel@tonic-gatethe lowercase and uppercase may be interlaced so that both `a' and `A'
656*0Sstevel@tonic-gatecome before `b'; the accented and other international characters may
657*0Sstevel@tonic-gatebe interlaced so that E<auml> comes before `b'.
658*0Sstevel@tonic-gate
659*0Sstevel@tonic-gate=head2 Internationalisation
660*0Sstevel@tonic-gate
661*0Sstevel@tonic-gateIf you may assume POSIX (a rather large assumption), you may read
662*0Sstevel@tonic-gatemore about the POSIX locale system from L<perllocale>.  The locale
663*0Sstevel@tonic-gatesystem at least attempts to make things a little bit more portable,
664*0Sstevel@tonic-gateor at least more convenient and native-friendly for non-English
665*0Sstevel@tonic-gateusers.  The system affects character sets and encoding, and date
666*0Sstevel@tonic-gateand time formatting--amongst other things.
667*0Sstevel@tonic-gate
668*0Sstevel@tonic-gateIf you really want to be international, you should consider Unicode.
669*0Sstevel@tonic-gateSee L<perluniintro> and L<perlunicode> for more information.
670*0Sstevel@tonic-gate
671*0Sstevel@tonic-gateIf you want to use non-ASCII bytes (outside the bytes 0x00..0x7f) in
672*0Sstevel@tonic-gatethe "source code" of your code, to be portable you have to be explicit
673*0Sstevel@tonic-gateabout what bytes they are.  Someone might for example be using your
674*0Sstevel@tonic-gatecode under a UTF-8 locale, in which case random native bytes might be
675*0Sstevel@tonic-gateillegal ("Malformed UTF-8 ...")  This means that for example embedding
676*0Sstevel@tonic-gateISO 8859-1 bytes beyond 0x7f into your strings might cause trouble
677*0Sstevel@tonic-gatelater.  If the bytes are native 8-bit bytes, you can use the C<bytes>
678*0Sstevel@tonic-gatepragma.  If the bytes are in a string (regular expression being a
679*0Sstevel@tonic-gatecurious string), you can often also use the C<\xHH> notation instead
680*0Sstevel@tonic-gateof embedding the bytes as-is.  If they are in some particular legacy
681*0Sstevel@tonic-gateencoding (ether single-byte or something more complicated), you can
682*0Sstevel@tonic-gateuse the C<encoding> pragma.  (If you want to write your code in UTF-8,
683*0Sstevel@tonic-gateyou can use either the C<utf8> pragma, or the C<encoding> pragma.)
684*0Sstevel@tonic-gateThe C<bytes> and C<utf8> pragmata are available since Perl 5.6.0, and
685*0Sstevel@tonic-gatethe C<encoding> pragma since Perl 5.8.0.
686*0Sstevel@tonic-gate
687*0Sstevel@tonic-gate=head2 System Resources
688*0Sstevel@tonic-gate
689*0Sstevel@tonic-gateIf your code is destined for systems with severely constrained (or
690*0Sstevel@tonic-gatemissing!) virtual memory systems then you want to be I<especially> mindful
691*0Sstevel@tonic-gateof avoiding wasteful constructs such as:
692*0Sstevel@tonic-gate
693*0Sstevel@tonic-gate    # NOTE: this is no longer "bad" in perl5.005
694*0Sstevel@tonic-gate    for (0..10000000) {}                       # bad
695*0Sstevel@tonic-gate    for (my $x = 0; $x <= 10000000; ++$x) {}   # good
696*0Sstevel@tonic-gate
697*0Sstevel@tonic-gate    @lines = <VERY_LARGE_FILE>;                # bad
698*0Sstevel@tonic-gate
699*0Sstevel@tonic-gate    while (<FILE>) {$file .= $_}               # sometimes bad
700*0Sstevel@tonic-gate    $file = join('', <FILE>);                  # better
701*0Sstevel@tonic-gate
702*0Sstevel@tonic-gateThe last two constructs may appear unintuitive to most people.  The
703*0Sstevel@tonic-gatefirst repeatedly grows a string, whereas the second allocates a
704*0Sstevel@tonic-gatelarge chunk of memory in one go.  On some systems, the second is
705*0Sstevel@tonic-gatemore efficient that the first.
706*0Sstevel@tonic-gate
707*0Sstevel@tonic-gate=head2 Security
708*0Sstevel@tonic-gate
709*0Sstevel@tonic-gateMost multi-user platforms provide basic levels of security, usually
710*0Sstevel@tonic-gateimplemented at the filesystem level.  Some, however, do
711*0Sstevel@tonic-gatenot-- unfortunately.  Thus the notion of user id, or "home" directory,
712*0Sstevel@tonic-gateor even the state of being logged-in, may be unrecognizable on many
713*0Sstevel@tonic-gateplatforms.  If you write programs that are security-conscious, it
714*0Sstevel@tonic-gateis usually best to know what type of system you will be running
715*0Sstevel@tonic-gateunder so that you can write code explicitly for that platform (or
716*0Sstevel@tonic-gateclass of platforms).
717*0Sstevel@tonic-gate
718*0Sstevel@tonic-gateDon't assume the UNIX filesystem access semantics: the operating
719*0Sstevel@tonic-gatesystem or the filesystem may be using some ACL systems, which are
720*0Sstevel@tonic-gatericher languages than the usual rwx.  Even if the rwx exist,
721*0Sstevel@tonic-gatetheir semantics might be different.
722*0Sstevel@tonic-gate
723*0Sstevel@tonic-gate(From security viewpoint testing for permissions before attempting to
724*0Sstevel@tonic-gatedo something is silly anyway: if one tries this, there is potential
725*0Sstevel@tonic-gatefor race conditions-- someone or something might change the
726*0Sstevel@tonic-gatepermissions between the permissions check and the actual operation.
727*0Sstevel@tonic-gateJust try the operation.)
728*0Sstevel@tonic-gate
729*0Sstevel@tonic-gateDon't assume the UNIX user and group semantics: especially, don't
730*0Sstevel@tonic-gateexpect the C<< $< >> and C<< $> >> (or the C<$(> and C<$)>) to work
731*0Sstevel@tonic-gatefor switching identities (or memberships).
732*0Sstevel@tonic-gate
733*0Sstevel@tonic-gateDon't assume set-uid and set-gid semantics. (And even if you do,
734*0Sstevel@tonic-gatethink twice: set-uid and set-gid are a known can of security worms.)
735*0Sstevel@tonic-gate
736*0Sstevel@tonic-gate=head2 Style
737*0Sstevel@tonic-gate
738*0Sstevel@tonic-gateFor those times when it is necessary to have platform-specific code,
739*0Sstevel@tonic-gateconsider keeping the platform-specific code in one place, making porting
740*0Sstevel@tonic-gateto other platforms easier.  Use the Config module and the special
741*0Sstevel@tonic-gatevariable C<$^O> to differentiate platforms, as described in
742*0Sstevel@tonic-gateL<"PLATFORMS">.
743*0Sstevel@tonic-gate
744*0Sstevel@tonic-gateBe careful in the tests you supply with your module or programs.
745*0Sstevel@tonic-gateModule code may be fully portable, but its tests might not be.  This
746*0Sstevel@tonic-gateoften happens when tests spawn off other processes or call external
747*0Sstevel@tonic-gateprograms to aid in the testing, or when (as noted above) the tests
748*0Sstevel@tonic-gateassume certain things about the filesystem and paths.  Be careful not
749*0Sstevel@tonic-gateto depend on a specific output style for errors, such as when checking
750*0Sstevel@tonic-gateC<$!> after a failed system call.  Using C<$!> for anything else than
751*0Sstevel@tonic-gatedisplaying it as output is doubtful (though see the Errno module for
752*0Sstevel@tonic-gatetesting reasonably portably for error value). Some platforms expect
753*0Sstevel@tonic-gatea certain output format, and Perl on those platforms may have been
754*0Sstevel@tonic-gateadjusted accordingly.  Most specifically, don't anchor a regex when
755*0Sstevel@tonic-gatetesting an error value.
756*0Sstevel@tonic-gate
757*0Sstevel@tonic-gate=head1 CPAN Testers
758*0Sstevel@tonic-gate
759*0Sstevel@tonic-gateModules uploaded to CPAN are tested by a variety of volunteers on
760*0Sstevel@tonic-gatedifferent platforms.  These CPAN testers are notified by mail of each
761*0Sstevel@tonic-gatenew upload, and reply to the list with PASS, FAIL, NA (not applicable to
762*0Sstevel@tonic-gatethis platform), or UNKNOWN (unknown), along with any relevant notations.
763*0Sstevel@tonic-gate
764*0Sstevel@tonic-gateThe purpose of the testing is twofold: one, to help developers fix any
765*0Sstevel@tonic-gateproblems in their code that crop up because of lack of testing on other
766*0Sstevel@tonic-gateplatforms; two, to provide users with information about whether
767*0Sstevel@tonic-gatea given module works on a given platform.
768*0Sstevel@tonic-gate
769*0Sstevel@tonic-gate=over 4
770*0Sstevel@tonic-gate
771*0Sstevel@tonic-gate=item Mailing list: cpan-testers@perl.org
772*0Sstevel@tonic-gate
773*0Sstevel@tonic-gate=item Testing results: http://testers.cpan.org/
774*0Sstevel@tonic-gate
775*0Sstevel@tonic-gate=back
776*0Sstevel@tonic-gate
777*0Sstevel@tonic-gate=head1 PLATFORMS
778*0Sstevel@tonic-gate
779*0Sstevel@tonic-gateAs of version 5.002, Perl is built with a C<$^O> variable that
780*0Sstevel@tonic-gateindicates the operating system it was built on.  This was implemented
781*0Sstevel@tonic-gateto help speed up code that would otherwise have to C<use Config>
782*0Sstevel@tonic-gateand use the value of C<$Config{osname}>.  Of course, to get more
783*0Sstevel@tonic-gatedetailed information about the system, looking into C<%Config> is
784*0Sstevel@tonic-gatecertainly recommended.
785*0Sstevel@tonic-gate
786*0Sstevel@tonic-gateC<%Config> cannot always be trusted, however, because it was built
787*0Sstevel@tonic-gateat compile time.  If perl was built in one place, then transferred
788*0Sstevel@tonic-gateelsewhere, some values may be wrong.  The values may even have been
789*0Sstevel@tonic-gateedited after the fact.
790*0Sstevel@tonic-gate
791*0Sstevel@tonic-gate=head2 Unix
792*0Sstevel@tonic-gate
793*0Sstevel@tonic-gatePerl works on a bewildering variety of Unix and Unix-like platforms (see
794*0Sstevel@tonic-gatee.g. most of the files in the F<hints/> directory in the source code kit).
795*0Sstevel@tonic-gateOn most of these systems, the value of C<$^O> (hence C<$Config{'osname'}>,
796*0Sstevel@tonic-gatetoo) is determined either by lowercasing and stripping punctuation from the
797*0Sstevel@tonic-gatefirst field of the string returned by typing C<uname -a> (or a similar command)
798*0Sstevel@tonic-gateat the shell prompt or by testing the file system for the presence of
799*0Sstevel@tonic-gateuniquely named files such as a kernel or header file.  Here, for example,
800*0Sstevel@tonic-gateare a few of the more popular Unix flavors:
801*0Sstevel@tonic-gate
802*0Sstevel@tonic-gate    uname         $^O        $Config{'archname'}
803*0Sstevel@tonic-gate    --------------------------------------------
804*0Sstevel@tonic-gate    AIX           aix        aix
805*0Sstevel@tonic-gate    BSD/OS        bsdos      i386-bsdos
806*0Sstevel@tonic-gate    Darwin        darwin     darwin
807*0Sstevel@tonic-gate    dgux          dgux       AViiON-dgux
808*0Sstevel@tonic-gate    DYNIX/ptx     dynixptx   i386-dynixptx
809*0Sstevel@tonic-gate    FreeBSD       freebsd    freebsd-i386
810*0Sstevel@tonic-gate    Linux         linux      arm-linux
811*0Sstevel@tonic-gate    Linux         linux      i386-linux
812*0Sstevel@tonic-gate    Linux         linux      i586-linux
813*0Sstevel@tonic-gate    Linux         linux      ppc-linux
814*0Sstevel@tonic-gate    HP-UX         hpux       PA-RISC1.1
815*0Sstevel@tonic-gate    IRIX          irix       irix
816*0Sstevel@tonic-gate    Mac OS X      darwin     darwin
817*0Sstevel@tonic-gate    MachTen PPC   machten    powerpc-machten
818*0Sstevel@tonic-gate    NeXT 3        next       next-fat
819*0Sstevel@tonic-gate    NeXT 4        next       OPENSTEP-Mach
820*0Sstevel@tonic-gate    openbsd       openbsd    i386-openbsd
821*0Sstevel@tonic-gate    OSF1          dec_osf    alpha-dec_osf
822*0Sstevel@tonic-gate    reliantunix-n svr4       RM400-svr4
823*0Sstevel@tonic-gate    SCO_SV        sco_sv     i386-sco_sv
824*0Sstevel@tonic-gate    SINIX-N       svr4       RM400-svr4
825*0Sstevel@tonic-gate    sn4609        unicos     CRAY_C90-unicos
826*0Sstevel@tonic-gate    sn6521        unicosmk   t3e-unicosmk
827*0Sstevel@tonic-gate    sn9617        unicos     CRAY_J90-unicos
828*0Sstevel@tonic-gate    SunOS         solaris    sun4-solaris
829*0Sstevel@tonic-gate    SunOS         solaris    i86pc-solaris
830*0Sstevel@tonic-gate    SunOS4        sunos      sun4-sunos
831*0Sstevel@tonic-gate
832*0Sstevel@tonic-gateBecause the value of C<$Config{archname}> may depend on the
833*0Sstevel@tonic-gatehardware architecture, it can vary more than the value of C<$^O>.
834*0Sstevel@tonic-gate
835*0Sstevel@tonic-gate=head2 DOS and Derivatives
836*0Sstevel@tonic-gate
837*0Sstevel@tonic-gatePerl has long been ported to Intel-style microcomputers running under
838*0Sstevel@tonic-gatesystems like PC-DOS, MS-DOS, OS/2, and most Windows platforms you can
839*0Sstevel@tonic-gatebring yourself to mention (except for Windows CE, if you count that).
840*0Sstevel@tonic-gateUsers familiar with I<COMMAND.COM> or I<CMD.EXE> style shells should
841*0Sstevel@tonic-gatebe aware that each of these file specifications may have subtle
842*0Sstevel@tonic-gatedifferences:
843*0Sstevel@tonic-gate
844*0Sstevel@tonic-gate    $filespec0 = "c:/foo/bar/file.txt";
845*0Sstevel@tonic-gate    $filespec1 = "c:\\foo\\bar\\file.txt";
846*0Sstevel@tonic-gate    $filespec2 = 'c:\foo\bar\file.txt';
847*0Sstevel@tonic-gate    $filespec3 = 'c:\\foo\\bar\\file.txt';
848*0Sstevel@tonic-gate
849*0Sstevel@tonic-gateSystem calls accept either C</> or C<\> as the path separator.
850*0Sstevel@tonic-gateHowever, many command-line utilities of DOS vintage treat C</> as
851*0Sstevel@tonic-gatethe option prefix, so may get confused by filenames containing C</>.
852*0Sstevel@tonic-gateAside from calling any external programs, C</> will work just fine,
853*0Sstevel@tonic-gateand probably better, as it is more consistent with popular usage,
854*0Sstevel@tonic-gateand avoids the problem of remembering what to backwhack and what
855*0Sstevel@tonic-gatenot to.
856*0Sstevel@tonic-gate
857*0Sstevel@tonic-gateThe DOS FAT filesystem can accommodate only "8.3" style filenames.  Under
858*0Sstevel@tonic-gatethe "case-insensitive, but case-preserving" HPFS (OS/2) and NTFS (NT)
859*0Sstevel@tonic-gatefilesystems you may have to be careful about case returned with functions
860*0Sstevel@tonic-gatelike C<readdir> or used with functions like C<open> or C<opendir>.
861*0Sstevel@tonic-gate
862*0Sstevel@tonic-gateDOS also treats several filenames as special, such as AUX, PRN,
863*0Sstevel@tonic-gateNUL, CON, COM1, LPT1, LPT2, etc.  Unfortunately, sometimes these
864*0Sstevel@tonic-gatefilenames won't even work if you include an explicit directory
865*0Sstevel@tonic-gateprefix.  It is best to avoid such filenames, if you want your code
866*0Sstevel@tonic-gateto be portable to DOS and its derivatives.  It's hard to know what
867*0Sstevel@tonic-gatethese all are, unfortunately.
868*0Sstevel@tonic-gate
869*0Sstevel@tonic-gateUsers of these operating systems may also wish to make use of
870*0Sstevel@tonic-gatescripts such as I<pl2bat.bat> or I<pl2cmd> to
871*0Sstevel@tonic-gateput wrappers around your scripts.
872*0Sstevel@tonic-gate
873*0Sstevel@tonic-gateNewline (C<\n>) is translated as C<\015\012> by STDIO when reading from
874*0Sstevel@tonic-gateand writing to files (see L<"Newlines">).  C<binmode(FILEHANDLE)>
875*0Sstevel@tonic-gatewill keep C<\n> translated as C<\012> for that filehandle.  Since it is a
876*0Sstevel@tonic-gateno-op on other systems, C<binmode> should be used for cross-platform code
877*0Sstevel@tonic-gatethat deals with binary data.  That's assuming you realize in advance
878*0Sstevel@tonic-gatethat your data is in binary.  General-purpose programs should
879*0Sstevel@tonic-gateoften assume nothing about their data.
880*0Sstevel@tonic-gate
881*0Sstevel@tonic-gateThe C<$^O> variable and the C<$Config{archname}> values for various
882*0Sstevel@tonic-gateDOSish perls are as follows:
883*0Sstevel@tonic-gate
884*0Sstevel@tonic-gate     OS            $^O      $Config{archname}   ID    Version
885*0Sstevel@tonic-gate     --------------------------------------------------------
886*0Sstevel@tonic-gate     MS-DOS        dos        ?
887*0Sstevel@tonic-gate     PC-DOS        dos        ?
888*0Sstevel@tonic-gate     OS/2          os2        ?
889*0Sstevel@tonic-gate     Windows 3.1   ?          ?                 0      3 01
890*0Sstevel@tonic-gate     Windows 95    MSWin32    MSWin32-x86       1      4 00
891*0Sstevel@tonic-gate     Windows 98    MSWin32    MSWin32-x86       1      4 10
892*0Sstevel@tonic-gate     Windows ME    MSWin32    MSWin32-x86       1      ?
893*0Sstevel@tonic-gate     Windows NT    MSWin32    MSWin32-x86       2      4 xx
894*0Sstevel@tonic-gate     Windows NT    MSWin32    MSWin32-ALPHA     2      4 xx
895*0Sstevel@tonic-gate     Windows NT    MSWin32    MSWin32-ppc       2      4 xx
896*0Sstevel@tonic-gate     Windows 2000  MSWin32    MSWin32-x86       2      5 xx
897*0Sstevel@tonic-gate     Windows XP    MSWin32    MSWin32-x86       2      ?
898*0Sstevel@tonic-gate     Windows CE    MSWin32    ?                 3
899*0Sstevel@tonic-gate     Cygwin        cygwin     ?
900*0Sstevel@tonic-gate
901*0Sstevel@tonic-gateThe various MSWin32 Perl's can distinguish the OS they are running on
902*0Sstevel@tonic-gatevia the value of the fifth element of the list returned from
903*0Sstevel@tonic-gateWin32::GetOSVersion().  For example:
904*0Sstevel@tonic-gate
905*0Sstevel@tonic-gate    if ($^O eq 'MSWin32') {
906*0Sstevel@tonic-gate        my @os_version_info = Win32::GetOSVersion();
907*0Sstevel@tonic-gate        print +('3.1','95','NT')[$os_version_info[4]],"\n";
908*0Sstevel@tonic-gate    }
909*0Sstevel@tonic-gate
910*0Sstevel@tonic-gateThere are also Win32::IsWinNT() and Win32::IsWin95(), try C<perldoc Win32>,
911*0Sstevel@tonic-gateand as of libwin32 0.19 (not part of the core Perl distribution)
912*0Sstevel@tonic-gateWin32::GetOSName().  The very portable POSIX::uname() will work too:
913*0Sstevel@tonic-gate
914*0Sstevel@tonic-gate    c:\> perl -MPOSIX -we "print join '|', uname"
915*0Sstevel@tonic-gate    Windows NT|moonru|5.0|Build 2195 (Service Pack 2)|x86
916*0Sstevel@tonic-gate
917*0Sstevel@tonic-gateAlso see:
918*0Sstevel@tonic-gate
919*0Sstevel@tonic-gate=over 4
920*0Sstevel@tonic-gate
921*0Sstevel@tonic-gate=item *
922*0Sstevel@tonic-gate
923*0Sstevel@tonic-gateThe djgpp environment for DOS, http://www.delorie.com/djgpp/
924*0Sstevel@tonic-gateand L<perldos>.
925*0Sstevel@tonic-gate
926*0Sstevel@tonic-gate=item *
927*0Sstevel@tonic-gate
928*0Sstevel@tonic-gateThe EMX environment for DOS, OS/2, etc. emx@iaehv.nl,
929*0Sstevel@tonic-gatehttp://www.leo.org/pub/comp/os/os2/leo/gnu/emx+gcc/index.html or
930*0Sstevel@tonic-gateftp://hobbes.nmsu.edu/pub/os2/dev/emx/  Also L<perlos2>.
931*0Sstevel@tonic-gate
932*0Sstevel@tonic-gate=item *
933*0Sstevel@tonic-gate
934*0Sstevel@tonic-gateBuild instructions for Win32 in L<perlwin32>, or under the Cygnus environment
935*0Sstevel@tonic-gatein L<perlcygwin>.
936*0Sstevel@tonic-gate
937*0Sstevel@tonic-gate=item *
938*0Sstevel@tonic-gate
939*0Sstevel@tonic-gateThe C<Win32::*> modules in L<Win32>.
940*0Sstevel@tonic-gate
941*0Sstevel@tonic-gate=item *
942*0Sstevel@tonic-gate
943*0Sstevel@tonic-gateThe ActiveState Pages, http://www.activestate.com/
944*0Sstevel@tonic-gate
945*0Sstevel@tonic-gate=item *
946*0Sstevel@tonic-gate
947*0Sstevel@tonic-gateThe Cygwin environment for Win32; F<README.cygwin> (installed
948*0Sstevel@tonic-gateas L<perlcygwin>), http://www.cygwin.com/
949*0Sstevel@tonic-gate
950*0Sstevel@tonic-gate=item *
951*0Sstevel@tonic-gate
952*0Sstevel@tonic-gateThe U/WIN environment for Win32,
953*0Sstevel@tonic-gatehttp://www.research.att.com/sw/tools/uwin/
954*0Sstevel@tonic-gate
955*0Sstevel@tonic-gate=item *
956*0Sstevel@tonic-gate
957*0Sstevel@tonic-gateBuild instructions for OS/2, L<perlos2>
958*0Sstevel@tonic-gate
959*0Sstevel@tonic-gate=back
960*0Sstevel@tonic-gate
961*0Sstevel@tonic-gate=head2 S<Mac OS>
962*0Sstevel@tonic-gate
963*0Sstevel@tonic-gateAny module requiring XS compilation is right out for most people, because
964*0Sstevel@tonic-gateMacPerl is built using non-free (and non-cheap!) compilers.  Some XS
965*0Sstevel@tonic-gatemodules that can work with MacPerl are built and distributed in binary
966*0Sstevel@tonic-gateform on CPAN.
967*0Sstevel@tonic-gate
968*0Sstevel@tonic-gateDirectories are specified as:
969*0Sstevel@tonic-gate
970*0Sstevel@tonic-gate    volume:folder:file              for absolute pathnames
971*0Sstevel@tonic-gate    volume:folder:                  for absolute pathnames
972*0Sstevel@tonic-gate    :folder:file                    for relative pathnames
973*0Sstevel@tonic-gate    :folder:                        for relative pathnames
974*0Sstevel@tonic-gate    :file                           for relative pathnames
975*0Sstevel@tonic-gate    file                            for relative pathnames
976*0Sstevel@tonic-gate
977*0Sstevel@tonic-gateFiles are stored in the directory in alphabetical order.  Filenames are
978*0Sstevel@tonic-gatelimited to 31 characters, and may include any character except for
979*0Sstevel@tonic-gatenull and C<:>, which is reserved as the path separator.
980*0Sstevel@tonic-gate
981*0Sstevel@tonic-gateInstead of C<flock>, see C<FSpSetFLock> and C<FSpRstFLock> in the
982*0Sstevel@tonic-gateMac::Files module, or C<chmod(0444, ...)> and C<chmod(0666, ...)>.
983*0Sstevel@tonic-gate
984*0Sstevel@tonic-gateIn the MacPerl application, you can't run a program from the command line;
985*0Sstevel@tonic-gateprograms that expect C<@ARGV> to be populated can be edited with something
986*0Sstevel@tonic-gatelike the following, which brings up a dialog box asking for the command
987*0Sstevel@tonic-gateline arguments.
988*0Sstevel@tonic-gate
989*0Sstevel@tonic-gate    if (!@ARGV) {
990*0Sstevel@tonic-gate        @ARGV = split /\s+/, MacPerl::Ask('Arguments?');
991*0Sstevel@tonic-gate    }
992*0Sstevel@tonic-gate
993*0Sstevel@tonic-gateA MacPerl script saved as a "droplet" will populate C<@ARGV> with the full
994*0Sstevel@tonic-gatepathnames of the files dropped onto the script.
995*0Sstevel@tonic-gate
996*0Sstevel@tonic-gateMac users can run programs under a type of command line interface
997*0Sstevel@tonic-gateunder MPW (Macintosh Programmer's Workshop, a free development
998*0Sstevel@tonic-gateenvironment from Apple).  MacPerl was first introduced as an MPW
999*0Sstevel@tonic-gatetool, and MPW can be used like a shell:
1000*0Sstevel@tonic-gate
1001*0Sstevel@tonic-gate    perl myscript.plx some arguments
1002*0Sstevel@tonic-gate
1003*0Sstevel@tonic-gateToolServer is another app from Apple that provides access to MPW tools
1004*0Sstevel@tonic-gatefrom MPW and the MacPerl app, which allows MacPerl programs to use
1005*0Sstevel@tonic-gateC<system>, backticks, and piped C<open>.
1006*0Sstevel@tonic-gate
1007*0Sstevel@tonic-gate"S<Mac OS>" is the proper name for the operating system, but the value
1008*0Sstevel@tonic-gatein C<$^O> is "MacOS".  To determine architecture, version, or whether
1009*0Sstevel@tonic-gatethe application or MPW tool version is running, check:
1010*0Sstevel@tonic-gate
1011*0Sstevel@tonic-gate    $is_app    = $MacPerl::Version =~ /App/;
1012*0Sstevel@tonic-gate    $is_tool   = $MacPerl::Version =~ /MPW/;
1013*0Sstevel@tonic-gate    ($version) = $MacPerl::Version =~ /^(\S+)/;
1014*0Sstevel@tonic-gate    $is_ppc    = $MacPerl::Architecture eq 'MacPPC';
1015*0Sstevel@tonic-gate    $is_68k    = $MacPerl::Architecture eq 'Mac68K';
1016*0Sstevel@tonic-gate
1017*0Sstevel@tonic-gateS<Mac OS X>, based on NeXT's OpenStep OS, runs MacPerl natively, under the
1018*0Sstevel@tonic-gate"Classic" environment.  There is no "Carbon" version of MacPerl to run
1019*0Sstevel@tonic-gateunder the primary Mac OS X environment.  S<Mac OS X> and its Open Source
1020*0Sstevel@tonic-gateversion, Darwin, both run Unix perl natively.
1021*0Sstevel@tonic-gate
1022*0Sstevel@tonic-gateAlso see:
1023*0Sstevel@tonic-gate
1024*0Sstevel@tonic-gate=over 4
1025*0Sstevel@tonic-gate
1026*0Sstevel@tonic-gate=item *
1027*0Sstevel@tonic-gate
1028*0Sstevel@tonic-gateMacPerl Development, http://dev.macperl.org/ .
1029*0Sstevel@tonic-gate
1030*0Sstevel@tonic-gate=item *
1031*0Sstevel@tonic-gate
1032*0Sstevel@tonic-gateThe MacPerl Pages, http://www.macperl.com/ .
1033*0Sstevel@tonic-gate
1034*0Sstevel@tonic-gate=item *
1035*0Sstevel@tonic-gate
1036*0Sstevel@tonic-gateThe MacPerl mailing lists, http://lists.perl.org/ .
1037*0Sstevel@tonic-gate
1038*0Sstevel@tonic-gate=back
1039*0Sstevel@tonic-gate
1040*0Sstevel@tonic-gate=head2 VMS
1041*0Sstevel@tonic-gate
1042*0Sstevel@tonic-gatePerl on VMS is discussed in L<perlvms> in the perl distribution.
1043*0Sstevel@tonic-gatePerl on VMS can accept either VMS- or Unix-style file
1044*0Sstevel@tonic-gatespecifications as in either of the following:
1045*0Sstevel@tonic-gate
1046*0Sstevel@tonic-gate    $ perl -ne "print if /perl_setup/i" SYS$LOGIN:LOGIN.COM
1047*0Sstevel@tonic-gate    $ perl -ne "print if /perl_setup/i" /sys$login/login.com
1048*0Sstevel@tonic-gate
1049*0Sstevel@tonic-gatebut not a mixture of both as in:
1050*0Sstevel@tonic-gate
1051*0Sstevel@tonic-gate    $ perl -ne "print if /perl_setup/i" sys$login:/login.com
1052*0Sstevel@tonic-gate    Can't open sys$login:/login.com: file specification syntax error
1053*0Sstevel@tonic-gate
1054*0Sstevel@tonic-gateInteracting with Perl from the Digital Command Language (DCL) shell
1055*0Sstevel@tonic-gateoften requires a different set of quotation marks than Unix shells do.
1056*0Sstevel@tonic-gateFor example:
1057*0Sstevel@tonic-gate
1058*0Sstevel@tonic-gate    $ perl -e "print ""Hello, world.\n"""
1059*0Sstevel@tonic-gate    Hello, world.
1060*0Sstevel@tonic-gate
1061*0Sstevel@tonic-gateThere are several ways to wrap your perl scripts in DCL F<.COM> files, if
1062*0Sstevel@tonic-gateyou are so inclined.  For example:
1063*0Sstevel@tonic-gate
1064*0Sstevel@tonic-gate    $ write sys$output "Hello from DCL!"
1065*0Sstevel@tonic-gate    $ if p1 .eqs. ""
1066*0Sstevel@tonic-gate    $ then perl -x 'f$environment("PROCEDURE")
1067*0Sstevel@tonic-gate    $ else perl -x - 'p1 'p2 'p3 'p4 'p5 'p6 'p7 'p8
1068*0Sstevel@tonic-gate    $ deck/dollars="__END__"
1069*0Sstevel@tonic-gate    #!/usr/bin/perl
1070*0Sstevel@tonic-gate
1071*0Sstevel@tonic-gate    print "Hello from Perl!\n";
1072*0Sstevel@tonic-gate
1073*0Sstevel@tonic-gate    __END__
1074*0Sstevel@tonic-gate    $ endif
1075*0Sstevel@tonic-gate
1076*0Sstevel@tonic-gateDo take care with C<$ ASSIGN/nolog/user SYS$COMMAND: SYS$INPUT> if your
1077*0Sstevel@tonic-gateperl-in-DCL script expects to do things like C<< $read = <STDIN>; >>.
1078*0Sstevel@tonic-gate
1079*0Sstevel@tonic-gateFilenames are in the format "name.extension;version".  The maximum
1080*0Sstevel@tonic-gatelength for filenames is 39 characters, and the maximum length for
1081*0Sstevel@tonic-gateextensions is also 39 characters.  Version is a number from 1 to
1082*0Sstevel@tonic-gate32767.  Valid characters are C</[A-Z0-9$_-]/>.
1083*0Sstevel@tonic-gate
1084*0Sstevel@tonic-gateVMS's RMS filesystem is case-insensitive and does not preserve case.
1085*0Sstevel@tonic-gateC<readdir> returns lowercased filenames, but specifying a file for
1086*0Sstevel@tonic-gateopening remains case-insensitive.  Files without extensions have a
1087*0Sstevel@tonic-gatetrailing period on them, so doing a C<readdir> with a file named F<A.;5>
1088*0Sstevel@tonic-gatewill return F<a.> (though that file could be opened with
1089*0Sstevel@tonic-gateC<open(FH, 'A')>).
1090*0Sstevel@tonic-gate
1091*0Sstevel@tonic-gateRMS had an eight level limit on directory depths from any rooted logical
1092*0Sstevel@tonic-gate(allowing 16 levels overall) prior to VMS 7.2.  Hence
1093*0Sstevel@tonic-gateC<PERL_ROOT:[LIB.2.3.4.5.6.7.8]> is a valid directory specification but
1094*0Sstevel@tonic-gateC<PERL_ROOT:[LIB.2.3.4.5.6.7.8.9]> is not.  F<Makefile.PL> authors might
1095*0Sstevel@tonic-gatehave to take this into account, but at least they can refer to the former
1096*0Sstevel@tonic-gateas C</PERL_ROOT/lib/2/3/4/5/6/7/8/>.
1097*0Sstevel@tonic-gate
1098*0Sstevel@tonic-gateThe VMS::Filespec module, which gets installed as part of the build
1099*0Sstevel@tonic-gateprocess on VMS, is a pure Perl module that can easily be installed on
1100*0Sstevel@tonic-gatenon-VMS platforms and can be helpful for conversions to and from RMS
1101*0Sstevel@tonic-gatenative formats.
1102*0Sstevel@tonic-gate
1103*0Sstevel@tonic-gateWhat C<\n> represents depends on the type of file opened.  It usually
1104*0Sstevel@tonic-gaterepresents C<\012> but it could also be C<\015>, C<\012>, C<\015\012>,
1105*0Sstevel@tonic-gateC<\000>, C<\040>, or nothing depending on the file organiztion and
1106*0Sstevel@tonic-gaterecord format.  The VMS::Stdio module provides access to the
1107*0Sstevel@tonic-gatespecial fopen() requirements of files with unusual attributes on VMS.
1108*0Sstevel@tonic-gate
1109*0Sstevel@tonic-gateTCP/IP stacks are optional on VMS, so socket routines might not be
1110*0Sstevel@tonic-gateimplemented.  UDP sockets may not be supported.
1111*0Sstevel@tonic-gate
1112*0Sstevel@tonic-gateThe value of C<$^O> on OpenVMS is "VMS".  To determine the architecture
1113*0Sstevel@tonic-gatethat you are running on without resorting to loading all of C<%Config>
1114*0Sstevel@tonic-gateyou can examine the content of the C<@INC> array like so:
1115*0Sstevel@tonic-gate
1116*0Sstevel@tonic-gate    if (grep(/VMS_AXP/, @INC)) {
1117*0Sstevel@tonic-gate        print "I'm on Alpha!\n";
1118*0Sstevel@tonic-gate
1119*0Sstevel@tonic-gate    } elsif (grep(/VMS_VAX/, @INC)) {
1120*0Sstevel@tonic-gate        print "I'm on VAX!\n";
1121*0Sstevel@tonic-gate
1122*0Sstevel@tonic-gate    } else {
1123*0Sstevel@tonic-gate        print "I'm not so sure about where $^O is...\n";
1124*0Sstevel@tonic-gate    }
1125*0Sstevel@tonic-gate
1126*0Sstevel@tonic-gateOn VMS, perl determines the UTC offset from the C<SYS$TIMEZONE_DIFFERENTIAL>
1127*0Sstevel@tonic-gatelogical name.  Although the VMS epoch began at 17-NOV-1858 00:00:00.00,
1128*0Sstevel@tonic-gatecalls to C<localtime> are adjusted to count offsets from
1129*0Sstevel@tonic-gate01-JAN-1970 00:00:00.00, just like Unix.
1130*0Sstevel@tonic-gate
1131*0Sstevel@tonic-gateAlso see:
1132*0Sstevel@tonic-gate
1133*0Sstevel@tonic-gate=over 4
1134*0Sstevel@tonic-gate
1135*0Sstevel@tonic-gate=item *
1136*0Sstevel@tonic-gate
1137*0Sstevel@tonic-gateF<README.vms> (installed as L<README_vms>), L<perlvms>
1138*0Sstevel@tonic-gate
1139*0Sstevel@tonic-gate=item *
1140*0Sstevel@tonic-gate
1141*0Sstevel@tonic-gatevmsperl list, majordomo@perl.org
1142*0Sstevel@tonic-gate
1143*0Sstevel@tonic-gate(Put the words C<subscribe vmsperl> in message body.)
1144*0Sstevel@tonic-gate
1145*0Sstevel@tonic-gate=item *
1146*0Sstevel@tonic-gate
1147*0Sstevel@tonic-gatevmsperl on the web, http://www.sidhe.org/vmsperl/index.html
1148*0Sstevel@tonic-gate
1149*0Sstevel@tonic-gate=back
1150*0Sstevel@tonic-gate
1151*0Sstevel@tonic-gate=head2 VOS
1152*0Sstevel@tonic-gate
1153*0Sstevel@tonic-gatePerl on VOS is discussed in F<README.vos> in the perl distribution
1154*0Sstevel@tonic-gate(installed as L<perlvos>).  Perl on VOS can accept either VOS- or
1155*0Sstevel@tonic-gateUnix-style file specifications as in either of the following:
1156*0Sstevel@tonic-gate
1157*0Sstevel@tonic-gate    C<< $ perl -ne "print if /perl_setup/i" >system>notices >>
1158*0Sstevel@tonic-gate    C<< $ perl -ne "print if /perl_setup/i" /system/notices >>
1159*0Sstevel@tonic-gate
1160*0Sstevel@tonic-gateor even a mixture of both as in:
1161*0Sstevel@tonic-gate
1162*0Sstevel@tonic-gate    C<< $ perl -ne "print if /perl_setup/i" >system/notices >>
1163*0Sstevel@tonic-gate
1164*0Sstevel@tonic-gateEven though VOS allows the slash character to appear in object
1165*0Sstevel@tonic-gatenames, because the VOS port of Perl interprets it as a pathname
1166*0Sstevel@tonic-gatedelimiting character, VOS files, directories, or links whose names
1167*0Sstevel@tonic-gatecontain a slash character cannot be processed.  Such files must be
1168*0Sstevel@tonic-gaterenamed before they can be processed by Perl.  Note that VOS limits
1169*0Sstevel@tonic-gatefile names to 32 or fewer characters.
1170*0Sstevel@tonic-gate
1171*0Sstevel@tonic-gatePerl on VOS can be built using two different compilers and two different
1172*0Sstevel@tonic-gateversions of the POSIX runtime.  The recommended method for building full
1173*0Sstevel@tonic-gatePerl is with the GNU C compiler and the generally-available version of
1174*0Sstevel@tonic-gateVOS POSIX support.  See F<README.vos> (installed as L<perlvos>) for
1175*0Sstevel@tonic-gaterestrictions that apply when Perl is built using the VOS Standard C
1176*0Sstevel@tonic-gatecompiler or the alpha version of VOS POSIX support.
1177*0Sstevel@tonic-gate
1178*0Sstevel@tonic-gateThe value of C<$^O> on VOS is "VOS".  To determine the architecture that
1179*0Sstevel@tonic-gateyou are running on without resorting to loading all of C<%Config> you
1180*0Sstevel@tonic-gatecan examine the content of the @INC array like so:
1181*0Sstevel@tonic-gate
1182*0Sstevel@tonic-gate    if ($^O =~ /VOS/) {
1183*0Sstevel@tonic-gate        print "I'm on a Stratus box!\n";
1184*0Sstevel@tonic-gate    } else {
1185*0Sstevel@tonic-gate        print "I'm not on a Stratus box!\n";
1186*0Sstevel@tonic-gate        die;
1187*0Sstevel@tonic-gate    }
1188*0Sstevel@tonic-gate
1189*0Sstevel@tonic-gate    if (grep(/860/, @INC)) {
1190*0Sstevel@tonic-gate        print "This box is a Stratus XA/R!\n";
1191*0Sstevel@tonic-gate
1192*0Sstevel@tonic-gate    } elsif (grep(/7100/, @INC)) {
1193*0Sstevel@tonic-gate        print "This box is a Stratus HP 7100 or 8xxx!\n";
1194*0Sstevel@tonic-gate
1195*0Sstevel@tonic-gate    } elsif (grep(/8000/, @INC)) {
1196*0Sstevel@tonic-gate        print "This box is a Stratus HP 8xxx!\n";
1197*0Sstevel@tonic-gate
1198*0Sstevel@tonic-gate    } else {
1199*0Sstevel@tonic-gate        print "This box is a Stratus 68K!\n";
1200*0Sstevel@tonic-gate    }
1201*0Sstevel@tonic-gate
1202*0Sstevel@tonic-gateAlso see:
1203*0Sstevel@tonic-gate
1204*0Sstevel@tonic-gate=over 4
1205*0Sstevel@tonic-gate
1206*0Sstevel@tonic-gate=item *
1207*0Sstevel@tonic-gate
1208*0Sstevel@tonic-gateF<README.vos> (installed as L<perlvos>)
1209*0Sstevel@tonic-gate
1210*0Sstevel@tonic-gate=item *
1211*0Sstevel@tonic-gate
1212*0Sstevel@tonic-gateThe VOS mailing list.
1213*0Sstevel@tonic-gate
1214*0Sstevel@tonic-gateThere is no specific mailing list for Perl on VOS.  You can post
1215*0Sstevel@tonic-gatecomments to the comp.sys.stratus newsgroup, or subscribe to the general
1216*0Sstevel@tonic-gateStratus mailing list.  Send a letter with "subscribe Info-Stratus" in
1217*0Sstevel@tonic-gatethe message body to majordomo@list.stratagy.com.
1218*0Sstevel@tonic-gate
1219*0Sstevel@tonic-gate=item *
1220*0Sstevel@tonic-gate
1221*0Sstevel@tonic-gateVOS Perl on the web at http://ftp.stratus.com/pub/vos/posix/posix.html
1222*0Sstevel@tonic-gate
1223*0Sstevel@tonic-gate=back
1224*0Sstevel@tonic-gate
1225*0Sstevel@tonic-gate=head2 EBCDIC Platforms
1226*0Sstevel@tonic-gate
1227*0Sstevel@tonic-gateRecent versions of Perl have been ported to platforms such as OS/400 on
1228*0Sstevel@tonic-gateAS/400 minicomputers as well as OS/390, VM/ESA, and BS2000 for S/390
1229*0Sstevel@tonic-gateMainframes.  Such computers use EBCDIC character sets internally (usually
1230*0Sstevel@tonic-gateCharacter Code Set ID 0037 for OS/400 and either 1047 or POSIX-BC for S/390
1231*0Sstevel@tonic-gatesystems).  On the mainframe perl currently works under the "Unix system
1232*0Sstevel@tonic-gateservices for OS/390" (formerly known as OpenEdition), VM/ESA OpenEdition, or
1233*0Sstevel@tonic-gatethe BS200 POSIX-BC system (BS2000 is supported in perl 5.6 and greater).
1234*0Sstevel@tonic-gateSee L<perlos390> for details.  Note that for OS/400 there is also a port of
1235*0Sstevel@tonic-gatePerl 5.8.1/5.9.0 or later to the PASE which is ASCII-based (as opposed to
1236*0Sstevel@tonic-gateILE which is EBCDIC-based), see L<perlos400>.
1237*0Sstevel@tonic-gate
1238*0Sstevel@tonic-gateAs of R2.5 of USS for OS/390 and Version 2.3 of VM/ESA these Unix
1239*0Sstevel@tonic-gatesub-systems do not support the C<#!> shebang trick for script invocation.
1240*0Sstevel@tonic-gateHence, on OS/390 and VM/ESA perl scripts can be executed with a header
1241*0Sstevel@tonic-gatesimilar to the following simple script:
1242*0Sstevel@tonic-gate
1243*0Sstevel@tonic-gate    : # use perl
1244*0Sstevel@tonic-gate        eval 'exec /usr/local/bin/perl -S $0 ${1+"$@"}'
1245*0Sstevel@tonic-gate            if 0;
1246*0Sstevel@tonic-gate    #!/usr/local/bin/perl     # just a comment really
1247*0Sstevel@tonic-gate
1248*0Sstevel@tonic-gate    print "Hello from perl!\n";
1249*0Sstevel@tonic-gate
1250*0Sstevel@tonic-gateOS/390 will support the C<#!> shebang trick in release 2.8 and beyond.
1251*0Sstevel@tonic-gateCalls to C<system> and backticks can use POSIX shell syntax on all
1252*0Sstevel@tonic-gateS/390 systems.
1253*0Sstevel@tonic-gate
1254*0Sstevel@tonic-gateOn the AS/400, if PERL5 is in your library list, you may need
1255*0Sstevel@tonic-gateto wrap your perl scripts in a CL procedure to invoke them like so:
1256*0Sstevel@tonic-gate
1257*0Sstevel@tonic-gate    BEGIN
1258*0Sstevel@tonic-gate      CALL PGM(PERL5/PERL) PARM('/QOpenSys/hello.pl')
1259*0Sstevel@tonic-gate    ENDPGM
1260*0Sstevel@tonic-gate
1261*0Sstevel@tonic-gateThis will invoke the perl script F<hello.pl> in the root of the
1262*0Sstevel@tonic-gateQOpenSys file system.  On the AS/400 calls to C<system> or backticks
1263*0Sstevel@tonic-gatemust use CL syntax.
1264*0Sstevel@tonic-gate
1265*0Sstevel@tonic-gateOn these platforms, bear in mind that the EBCDIC character set may have
1266*0Sstevel@tonic-gatean effect on what happens with some perl functions (such as C<chr>,
1267*0Sstevel@tonic-gateC<pack>, C<print>, C<printf>, C<ord>, C<sort>, C<sprintf>, C<unpack>), as
1268*0Sstevel@tonic-gatewell as bit-fiddling with ASCII constants using operators like C<^>, C<&>
1269*0Sstevel@tonic-gateand C<|>, not to mention dealing with socket interfaces to ASCII computers
1270*0Sstevel@tonic-gate(see L<"Newlines">).
1271*0Sstevel@tonic-gate
1272*0Sstevel@tonic-gateFortunately, most web servers for the mainframe will correctly
1273*0Sstevel@tonic-gatetranslate the C<\n> in the following statement to its ASCII equivalent
1274*0Sstevel@tonic-gate(C<\r> is the same under both Unix and OS/390 & VM/ESA):
1275*0Sstevel@tonic-gate
1276*0Sstevel@tonic-gate    print "Content-type: text/html\r\n\r\n";
1277*0Sstevel@tonic-gate
1278*0Sstevel@tonic-gateThe values of C<$^O> on some of these platforms includes:
1279*0Sstevel@tonic-gate
1280*0Sstevel@tonic-gate    uname         $^O        $Config{'archname'}
1281*0Sstevel@tonic-gate    --------------------------------------------
1282*0Sstevel@tonic-gate    OS/390        os390      os390
1283*0Sstevel@tonic-gate    OS400         os400      os400
1284*0Sstevel@tonic-gate    POSIX-BC      posix-bc   BS2000-posix-bc
1285*0Sstevel@tonic-gate    VM/ESA        vmesa      vmesa
1286*0Sstevel@tonic-gate
1287*0Sstevel@tonic-gateSome simple tricks for determining if you are running on an EBCDIC
1288*0Sstevel@tonic-gateplatform could include any of the following (perhaps all):
1289*0Sstevel@tonic-gate
1290*0Sstevel@tonic-gate    if ("\t" eq "\05")   { print "EBCDIC may be spoken here!\n"; }
1291*0Sstevel@tonic-gate
1292*0Sstevel@tonic-gate    if (ord('A') == 193) { print "EBCDIC may be spoken here!\n"; }
1293*0Sstevel@tonic-gate
1294*0Sstevel@tonic-gate    if (chr(169) eq 'z') { print "EBCDIC may be spoken here!\n"; }
1295*0Sstevel@tonic-gate
1296*0Sstevel@tonic-gateOne thing you may not want to rely on is the EBCDIC encoding
1297*0Sstevel@tonic-gateof punctuation characters since these may differ from code page to code
1298*0Sstevel@tonic-gatepage (and once your module or script is rumoured to work with EBCDIC,
1299*0Sstevel@tonic-gatefolks will want it to work with all EBCDIC character sets).
1300*0Sstevel@tonic-gate
1301*0Sstevel@tonic-gateAlso see:
1302*0Sstevel@tonic-gate
1303*0Sstevel@tonic-gate=over 4
1304*0Sstevel@tonic-gate
1305*0Sstevel@tonic-gate=item *
1306*0Sstevel@tonic-gate
1307*0Sstevel@tonic-gate*
1308*0Sstevel@tonic-gate
1309*0Sstevel@tonic-gateL<perlos390>, F<README.os390>, F<perlbs2000>, F<README.vmesa>,
1310*0Sstevel@tonic-gateL<perlebcdic>.
1311*0Sstevel@tonic-gate
1312*0Sstevel@tonic-gate=item *
1313*0Sstevel@tonic-gate
1314*0Sstevel@tonic-gateThe perl-mvs@perl.org list is for discussion of porting issues as well as
1315*0Sstevel@tonic-gategeneral usage issues for all EBCDIC Perls.  Send a message body of
1316*0Sstevel@tonic-gate"subscribe perl-mvs" to majordomo@perl.org.
1317*0Sstevel@tonic-gate
1318*0Sstevel@tonic-gate=item  *
1319*0Sstevel@tonic-gate
1320*0Sstevel@tonic-gateAS/400 Perl information at
1321*0Sstevel@tonic-gatehttp://as400.rochester.ibm.com/
1322*0Sstevel@tonic-gateas well as on CPAN in the F<ports/> directory.
1323*0Sstevel@tonic-gate
1324*0Sstevel@tonic-gate=back
1325*0Sstevel@tonic-gate
1326*0Sstevel@tonic-gate=head2 Acorn RISC OS
1327*0Sstevel@tonic-gate
1328*0Sstevel@tonic-gateBecause Acorns use ASCII with newlines (C<\n>) in text files as C<\012> like
1329*0Sstevel@tonic-gateUnix, and because Unix filename emulation is turned on by default,
1330*0Sstevel@tonic-gatemost simple scripts will probably work "out of the box".  The native
1331*0Sstevel@tonic-gatefilesystem is modular, and individual filesystems are free to be
1332*0Sstevel@tonic-gatecase-sensitive or insensitive, and are usually case-preserving.  Some
1333*0Sstevel@tonic-gatenative filesystems have name length limits, which file and directory
1334*0Sstevel@tonic-gatenames are silently truncated to fit.  Scripts should be aware that the
1335*0Sstevel@tonic-gatestandard filesystem currently has a name length limit of B<10>
1336*0Sstevel@tonic-gatecharacters, with up to 77 items in a directory, but other filesystems
1337*0Sstevel@tonic-gatemay not impose such limitations.
1338*0Sstevel@tonic-gate
1339*0Sstevel@tonic-gateNative filenames are of the form
1340*0Sstevel@tonic-gate
1341*0Sstevel@tonic-gate    Filesystem#Special_Field::DiskName.$.Directory.Directory.File
1342*0Sstevel@tonic-gate
1343*0Sstevel@tonic-gatewhere
1344*0Sstevel@tonic-gate
1345*0Sstevel@tonic-gate    Special_Field is not usually present, but may contain . and $ .
1346*0Sstevel@tonic-gate    Filesystem =~ m|[A-Za-z0-9_]|
1347*0Sstevel@tonic-gate    DsicName   =~ m|[A-Za-z0-9_/]|
1348*0Sstevel@tonic-gate    $ represents the root directory
1349*0Sstevel@tonic-gate    . is the path separator
1350*0Sstevel@tonic-gate    @ is the current directory (per filesystem but machine global)
1351*0Sstevel@tonic-gate    ^ is the parent directory
1352*0Sstevel@tonic-gate    Directory and File =~ m|[^\0- "\.\$\%\&:\@\\^\|\177]+|
1353*0Sstevel@tonic-gate
1354*0Sstevel@tonic-gateThe default filename translation is roughly C<tr|/.|./|;>
1355*0Sstevel@tonic-gate
1356*0Sstevel@tonic-gateNote that C<"ADFS::HardDisk.$.File" ne 'ADFS::HardDisk.$.File'> and that
1357*0Sstevel@tonic-gatethe second stage of C<$> interpolation in regular expressions will fall
1358*0Sstevel@tonic-gatefoul of the C<$.> if scripts are not careful.
1359*0Sstevel@tonic-gate
1360*0Sstevel@tonic-gateLogical paths specified by system variables containing comma-separated
1361*0Sstevel@tonic-gatesearch lists are also allowed; hence C<System:Modules> is a valid
1362*0Sstevel@tonic-gatefilename, and the filesystem will prefix C<Modules> with each section of
1363*0Sstevel@tonic-gateC<System$Path> until a name is made that points to an object on disk.
1364*0Sstevel@tonic-gateWriting to a new file C<System:Modules> would be allowed only if
1365*0Sstevel@tonic-gateC<System$Path> contains a single item list.  The filesystem will also
1366*0Sstevel@tonic-gateexpand system variables in filenames if enclosed in angle brackets, so
1367*0Sstevel@tonic-gateC<< <System$Dir>.Modules >> would look for the file
1368*0Sstevel@tonic-gateS<C<$ENV{'System$Dir'} . 'Modules'>>.  The obvious implication of this is
1369*0Sstevel@tonic-gatethat B<fully qualified filenames can start with C<< <> >>> and should
1370*0Sstevel@tonic-gatebe protected when C<open> is used for input.
1371*0Sstevel@tonic-gate
1372*0Sstevel@tonic-gateBecause C<.> was in use as a directory separator and filenames could not
1373*0Sstevel@tonic-gatebe assumed to be unique after 10 characters, Acorn implemented the C
1374*0Sstevel@tonic-gatecompiler to strip the trailing C<.c> C<.h> C<.s> and C<.o> suffix from
1375*0Sstevel@tonic-gatefilenames specified in source code and store the respective files in
1376*0Sstevel@tonic-gatesubdirectories named after the suffix.  Hence files are translated:
1377*0Sstevel@tonic-gate
1378*0Sstevel@tonic-gate    foo.h           h.foo
1379*0Sstevel@tonic-gate    C:foo.h         C:h.foo        (logical path variable)
1380*0Sstevel@tonic-gate    sys/os.h        sys.h.os       (C compiler groks Unix-speak)
1381*0Sstevel@tonic-gate    10charname.c    c.10charname
1382*0Sstevel@tonic-gate    10charname.o    o.10charname
1383*0Sstevel@tonic-gate    11charname_.c   c.11charname   (assuming filesystem truncates at 10)
1384*0Sstevel@tonic-gate
1385*0Sstevel@tonic-gateThe Unix emulation library's translation of filenames to native assumes
1386*0Sstevel@tonic-gatethat this sort of translation is required, and it allows a user-defined list
1387*0Sstevel@tonic-gateof known suffixes that it will transpose in this fashion.  This may
1388*0Sstevel@tonic-gateseem transparent, but consider that with these rules C<foo/bar/baz.h>
1389*0Sstevel@tonic-gateand C<foo/bar/h/baz> both map to C<foo.bar.h.baz>, and that C<readdir> and
1390*0Sstevel@tonic-gateC<glob> cannot and do not attempt to emulate the reverse mapping.  Other
1391*0Sstevel@tonic-gateC<.>'s in filenames are translated to C</>.
1392*0Sstevel@tonic-gate
1393*0Sstevel@tonic-gateAs implied above, the environment accessed through C<%ENV> is global, and
1394*0Sstevel@tonic-gatethe convention is that program specific environment variables are of the
1395*0Sstevel@tonic-gateform C<Program$Name>.  Each filesystem maintains a current directory,
1396*0Sstevel@tonic-gateand the current filesystem's current directory is the B<global> current
1397*0Sstevel@tonic-gatedirectory.  Consequently, sociable programs don't change the current
1398*0Sstevel@tonic-gatedirectory but rely on full pathnames, and programs (and Makefiles) cannot
1399*0Sstevel@tonic-gateassume that they can spawn a child process which can change the current
1400*0Sstevel@tonic-gatedirectory without affecting its parent (and everyone else for that
1401*0Sstevel@tonic-gatematter).
1402*0Sstevel@tonic-gate
1403*0Sstevel@tonic-gateBecause native operating system filehandles are global and are currently
1404*0Sstevel@tonic-gateallocated down from 255, with 0 being a reserved value, the Unix emulation
1405*0Sstevel@tonic-gatelibrary emulates Unix filehandles.  Consequently, you can't rely on
1406*0Sstevel@tonic-gatepassing C<STDIN>, C<STDOUT>, or C<STDERR> to your children.
1407*0Sstevel@tonic-gate
1408*0Sstevel@tonic-gateThe desire of users to express filenames of the form
1409*0Sstevel@tonic-gateC<< <Foo$Dir>.Bar >> on the command line unquoted causes problems,
1410*0Sstevel@tonic-gatetoo: C<``> command output capture has to perform a guessing game.  It
1411*0Sstevel@tonic-gateassumes that a string C<< <[^<>]+\$[^<>]> >> is a
1412*0Sstevel@tonic-gatereference to an environment variable, whereas anything else involving
1413*0Sstevel@tonic-gateC<< < >> or C<< > >> is redirection, and generally manages to be 99%
1414*0Sstevel@tonic-gateright.  Of course, the problem remains that scripts cannot rely on any
1415*0Sstevel@tonic-gateUnix tools being available, or that any tools found have Unix-like command
1416*0Sstevel@tonic-gateline arguments.
1417*0Sstevel@tonic-gate
1418*0Sstevel@tonic-gateExtensions and XS are, in theory, buildable by anyone using free
1419*0Sstevel@tonic-gatetools.  In practice, many don't, as users of the Acorn platform are
1420*0Sstevel@tonic-gateused to binary distributions.  MakeMaker does run, but no available
1421*0Sstevel@tonic-gatemake currently copes with MakeMaker's makefiles; even if and when
1422*0Sstevel@tonic-gatethis should be fixed, the lack of a Unix-like shell will cause
1423*0Sstevel@tonic-gateproblems with makefile rules, especially lines of the form C<cd
1424*0Sstevel@tonic-gatesdbm && make all>, and anything using quoting.
1425*0Sstevel@tonic-gate
1426*0Sstevel@tonic-gate"S<RISC OS>" is the proper name for the operating system, but the value
1427*0Sstevel@tonic-gatein C<$^O> is "riscos" (because we don't like shouting).
1428*0Sstevel@tonic-gate
1429*0Sstevel@tonic-gate=head2 Other perls
1430*0Sstevel@tonic-gate
1431*0Sstevel@tonic-gatePerl has been ported to many platforms that do not fit into any of
1432*0Sstevel@tonic-gatethe categories listed above.  Some, such as AmigaOS, Atari MiNT,
1433*0Sstevel@tonic-gateBeOS, HP MPE/iX, QNX, Plan 9, and VOS, have been well-integrated
1434*0Sstevel@tonic-gateinto the standard Perl source code kit.  You may need to see the
1435*0Sstevel@tonic-gateF<ports/> directory on CPAN for information, and possibly binaries,
1436*0Sstevel@tonic-gatefor the likes of: aos, Atari ST, lynxos, riscos, Novell Netware,
1437*0Sstevel@tonic-gateTandem Guardian, I<etc.>  (Yes, we know that some of these OSes may
1438*0Sstevel@tonic-gatefall under the Unix category, but we are not a standards body.)
1439*0Sstevel@tonic-gate
1440*0Sstevel@tonic-gateSome approximate operating system names and their C<$^O> values
1441*0Sstevel@tonic-gatein the "OTHER" category include:
1442*0Sstevel@tonic-gate
1443*0Sstevel@tonic-gate    OS            $^O        $Config{'archname'}
1444*0Sstevel@tonic-gate    ------------------------------------------
1445*0Sstevel@tonic-gate    Amiga DOS     amigaos    m68k-amigos
1446*0Sstevel@tonic-gate    BeOS          beos
1447*0Sstevel@tonic-gate    MPE/iX        mpeix      PA-RISC1.1
1448*0Sstevel@tonic-gate
1449*0Sstevel@tonic-gateSee also:
1450*0Sstevel@tonic-gate
1451*0Sstevel@tonic-gate=over 4
1452*0Sstevel@tonic-gate
1453*0Sstevel@tonic-gate=item *
1454*0Sstevel@tonic-gate
1455*0Sstevel@tonic-gateAmiga, F<README.amiga> (installed as L<perlamiga>).
1456*0Sstevel@tonic-gate
1457*0Sstevel@tonic-gate=item *
1458*0Sstevel@tonic-gate
1459*0Sstevel@tonic-gateAtari, F<README.mint> and Guido Flohr's web page
1460*0Sstevel@tonic-gatehttp://stud.uni-sb.de/~gufl0000/
1461*0Sstevel@tonic-gate
1462*0Sstevel@tonic-gate=item *
1463*0Sstevel@tonic-gate
1464*0Sstevel@tonic-gateBe OS, F<README.beos>
1465*0Sstevel@tonic-gate
1466*0Sstevel@tonic-gate=item *
1467*0Sstevel@tonic-gate
1468*0Sstevel@tonic-gateHP 300 MPE/iX, F<README.mpeix> and Mark Bixby's web page
1469*0Sstevel@tonic-gatehttp://www.bixby.org/mark/perlix.html
1470*0Sstevel@tonic-gate
1471*0Sstevel@tonic-gate=item *
1472*0Sstevel@tonic-gate
1473*0Sstevel@tonic-gateA free perl5-based PERL.NLM for Novell Netware is available in
1474*0Sstevel@tonic-gateprecompiled binary and source code form from http://www.novell.com/
1475*0Sstevel@tonic-gateas well as from CPAN.
1476*0Sstevel@tonic-gate
1477*0Sstevel@tonic-gate=item  *
1478*0Sstevel@tonic-gate
1479*0Sstevel@tonic-gateS<Plan 9>, F<README.plan9>
1480*0Sstevel@tonic-gate
1481*0Sstevel@tonic-gate=back
1482*0Sstevel@tonic-gate
1483*0Sstevel@tonic-gate=head1 FUNCTION IMPLEMENTATIONS
1484*0Sstevel@tonic-gate
1485*0Sstevel@tonic-gateListed below are functions that are either completely unimplemented
1486*0Sstevel@tonic-gateor else have been implemented differently on various platforms.
1487*0Sstevel@tonic-gateFollowing each description will be, in parentheses, a list of
1488*0Sstevel@tonic-gateplatforms that the description applies to.
1489*0Sstevel@tonic-gate
1490*0Sstevel@tonic-gateThe list may well be incomplete, or even wrong in some places.  When
1491*0Sstevel@tonic-gatein doubt, consult the platform-specific README files in the Perl
1492*0Sstevel@tonic-gatesource distribution, and any other documentation resources accompanying
1493*0Sstevel@tonic-gatea given port.
1494*0Sstevel@tonic-gate
1495*0Sstevel@tonic-gateBe aware, moreover, that even among Unix-ish systems there are variations.
1496*0Sstevel@tonic-gate
1497*0Sstevel@tonic-gateFor many functions, you can also query C<%Config>, exported by
1498*0Sstevel@tonic-gatedefault from the Config module.  For example, to check whether the
1499*0Sstevel@tonic-gateplatform has the C<lstat> call, check C<$Config{d_lstat}>.  See
1500*0Sstevel@tonic-gateL<Config> for a full description of available variables.
1501*0Sstevel@tonic-gate
1502*0Sstevel@tonic-gate=head2 Alphabetical Listing of Perl Functions
1503*0Sstevel@tonic-gate
1504*0Sstevel@tonic-gate=over 8
1505*0Sstevel@tonic-gate
1506*0Sstevel@tonic-gate=item -X FILEHANDLE
1507*0Sstevel@tonic-gate
1508*0Sstevel@tonic-gate=item -X EXPR
1509*0Sstevel@tonic-gate
1510*0Sstevel@tonic-gate=item -X
1511*0Sstevel@tonic-gate
1512*0Sstevel@tonic-gateC<-r>, C<-w>, and C<-x> have a limited meaning only; directories
1513*0Sstevel@tonic-gateand applications are executable, and there are no uid/gid
1514*0Sstevel@tonic-gateconsiderations.  C<-o> is not supported.  (S<Mac OS>)
1515*0Sstevel@tonic-gate
1516*0Sstevel@tonic-gateC<-r>, C<-w>, C<-x>, and C<-o> tell whether the file is accessible,
1517*0Sstevel@tonic-gatewhich may not reflect UIC-based file protections.  (VMS)
1518*0Sstevel@tonic-gate
1519*0Sstevel@tonic-gateC<-s> returns the size of the data fork, not the total size of data fork
1520*0Sstevel@tonic-gateplus resource fork.  (S<Mac OS>).
1521*0Sstevel@tonic-gate
1522*0Sstevel@tonic-gateC<-s> by name on an open file will return the space reserved on disk,
1523*0Sstevel@tonic-gaterather than the current extent.  C<-s> on an open filehandle returns the
1524*0Sstevel@tonic-gatecurrent size.  (S<RISC OS>)
1525*0Sstevel@tonic-gate
1526*0Sstevel@tonic-gateC<-R>, C<-W>, C<-X>, C<-O> are indistinguishable from C<-r>, C<-w>,
1527*0Sstevel@tonic-gateC<-x>, C<-o>. (S<Mac OS>, Win32, VMS, S<RISC OS>)
1528*0Sstevel@tonic-gate
1529*0Sstevel@tonic-gateC<-b>, C<-c>, C<-k>, C<-g>, C<-p>, C<-u>, C<-A> are not implemented.
1530*0Sstevel@tonic-gate(S<Mac OS>)
1531*0Sstevel@tonic-gate
1532*0Sstevel@tonic-gateC<-g>, C<-k>, C<-l>, C<-p>, C<-u>, C<-A> are not particularly meaningful.
1533*0Sstevel@tonic-gate(Win32, VMS, S<RISC OS>)
1534*0Sstevel@tonic-gate
1535*0Sstevel@tonic-gateC<-d> is true if passed a device spec without an explicit directory.
1536*0Sstevel@tonic-gate(VMS)
1537*0Sstevel@tonic-gate
1538*0Sstevel@tonic-gateC<-T> and C<-B> are implemented, but might misclassify Mac text files
1539*0Sstevel@tonic-gatewith foreign characters; this is the case will all platforms, but may
1540*0Sstevel@tonic-gateaffect S<Mac OS> often.  (S<Mac OS>)
1541*0Sstevel@tonic-gate
1542*0Sstevel@tonic-gateC<-x> (or C<-X>) determine if a file ends in one of the executable
1543*0Sstevel@tonic-gatesuffixes.  C<-S> is meaningless.  (Win32)
1544*0Sstevel@tonic-gate
1545*0Sstevel@tonic-gateC<-x> (or C<-X>) determine if a file has an executable file type.
1546*0Sstevel@tonic-gate(S<RISC OS>)
1547*0Sstevel@tonic-gate
1548*0Sstevel@tonic-gate=item binmode FILEHANDLE
1549*0Sstevel@tonic-gate
1550*0Sstevel@tonic-gateMeaningless.  (S<Mac OS>, S<RISC OS>)
1551*0Sstevel@tonic-gate
1552*0Sstevel@tonic-gateReopens file and restores pointer; if function fails, underlying
1553*0Sstevel@tonic-gatefilehandle may be closed, or pointer may be in a different position.
1554*0Sstevel@tonic-gate(VMS)
1555*0Sstevel@tonic-gate
1556*0Sstevel@tonic-gateThe value returned by C<tell> may be affected after the call, and
1557*0Sstevel@tonic-gatethe filehandle may be flushed. (Win32)
1558*0Sstevel@tonic-gate
1559*0Sstevel@tonic-gate=item chmod LIST
1560*0Sstevel@tonic-gate
1561*0Sstevel@tonic-gateOnly limited meaning.  Disabling/enabling write permission is mapped to
1562*0Sstevel@tonic-gatelocking/unlocking the file. (S<Mac OS>)
1563*0Sstevel@tonic-gate
1564*0Sstevel@tonic-gateOnly good for changing "owner" read-write access, "group", and "other"
1565*0Sstevel@tonic-gatebits are meaningless. (Win32)
1566*0Sstevel@tonic-gate
1567*0Sstevel@tonic-gateOnly good for changing "owner" and "other" read-write access. (S<RISC OS>)
1568*0Sstevel@tonic-gate
1569*0Sstevel@tonic-gateAccess permissions are mapped onto VOS access-control list changes. (VOS)
1570*0Sstevel@tonic-gate
1571*0Sstevel@tonic-gateThe actual permissions set depend on the value of the C<CYGWIN>
1572*0Sstevel@tonic-gatein the SYSTEM environment settings.  (Cygwin)
1573*0Sstevel@tonic-gate
1574*0Sstevel@tonic-gate=item chown LIST
1575*0Sstevel@tonic-gate
1576*0Sstevel@tonic-gateNot implemented. (S<Mac OS>, Win32, S<Plan 9>, S<RISC OS>, VOS)
1577*0Sstevel@tonic-gate
1578*0Sstevel@tonic-gateDoes nothing, but won't fail. (Win32)
1579*0Sstevel@tonic-gate
1580*0Sstevel@tonic-gate=item chroot FILENAME
1581*0Sstevel@tonic-gate
1582*0Sstevel@tonic-gate=item chroot
1583*0Sstevel@tonic-gate
1584*0Sstevel@tonic-gateNot implemented. (S<Mac OS>, Win32, VMS, S<Plan 9>, S<RISC OS>, VOS, VM/ESA)
1585*0Sstevel@tonic-gate
1586*0Sstevel@tonic-gate=item crypt PLAINTEXT,SALT
1587*0Sstevel@tonic-gate
1588*0Sstevel@tonic-gateMay not be available if library or source was not provided when building
1589*0Sstevel@tonic-gateperl. (Win32)
1590*0Sstevel@tonic-gate
1591*0Sstevel@tonic-gateNot implemented. (VOS)
1592*0Sstevel@tonic-gate
1593*0Sstevel@tonic-gate=item dbmclose HASH
1594*0Sstevel@tonic-gate
1595*0Sstevel@tonic-gateNot implemented. (VMS, S<Plan 9>, VOS)
1596*0Sstevel@tonic-gate
1597*0Sstevel@tonic-gate=item dbmopen HASH,DBNAME,MODE
1598*0Sstevel@tonic-gate
1599*0Sstevel@tonic-gateNot implemented. (VMS, S<Plan 9>, VOS)
1600*0Sstevel@tonic-gate
1601*0Sstevel@tonic-gate=item dump LABEL
1602*0Sstevel@tonic-gate
1603*0Sstevel@tonic-gateNot useful. (S<Mac OS>, S<RISC OS>)
1604*0Sstevel@tonic-gate
1605*0Sstevel@tonic-gateNot implemented. (Win32)
1606*0Sstevel@tonic-gate
1607*0Sstevel@tonic-gateInvokes VMS debugger. (VMS)
1608*0Sstevel@tonic-gate
1609*0Sstevel@tonic-gate=item exec LIST
1610*0Sstevel@tonic-gate
1611*0Sstevel@tonic-gateNot implemented. (S<Mac OS>)
1612*0Sstevel@tonic-gate
1613*0Sstevel@tonic-gateImplemented via Spawn. (VM/ESA)
1614*0Sstevel@tonic-gate
1615*0Sstevel@tonic-gateDoes not automatically flush output handles on some platforms.
1616*0Sstevel@tonic-gate(SunOS, Solaris, HP-UX)
1617*0Sstevel@tonic-gate
1618*0Sstevel@tonic-gate=item exit EXPR
1619*0Sstevel@tonic-gate
1620*0Sstevel@tonic-gate=item exit
1621*0Sstevel@tonic-gate
1622*0Sstevel@tonic-gateEmulates UNIX exit() (which considers C<exit 1> to indicate an error) by
1623*0Sstevel@tonic-gatemapping the C<1> to SS$_ABORT (C<44>).  This behavior may be overridden
1624*0Sstevel@tonic-gatewith the pragma C<use vmsish 'exit'>.  As with the CRTL's exit()
1625*0Sstevel@tonic-gatefunction, C<exit 0> is also mapped to an exit status of SS$_NORMAL
1626*0Sstevel@tonic-gate(C<1>); this mapping cannot be overridden.  Any other argument to exit()
1627*0Sstevel@tonic-gateis used directly as Perl's exit status. (VMS)
1628*0Sstevel@tonic-gate
1629*0Sstevel@tonic-gate=item fcntl FILEHANDLE,FUNCTION,SCALAR
1630*0Sstevel@tonic-gate
1631*0Sstevel@tonic-gateNot implemented. (Win32, VMS)
1632*0Sstevel@tonic-gate
1633*0Sstevel@tonic-gate=item flock FILEHANDLE,OPERATION
1634*0Sstevel@tonic-gate
1635*0Sstevel@tonic-gateNot implemented (S<Mac OS>, VMS, S<RISC OS>, VOS).
1636*0Sstevel@tonic-gate
1637*0Sstevel@tonic-gateAvailable only on Windows NT (not on Windows 95). (Win32)
1638*0Sstevel@tonic-gate
1639*0Sstevel@tonic-gate=item fork
1640*0Sstevel@tonic-gate
1641*0Sstevel@tonic-gateNot implemented. (S<Mac OS>, AmigaOS, S<RISC OS>, VOS, VM/ESA, VMS)
1642*0Sstevel@tonic-gate
1643*0Sstevel@tonic-gateEmulated using multiple interpreters.  See L<perlfork>.  (Win32)
1644*0Sstevel@tonic-gate
1645*0Sstevel@tonic-gateDoes not automatically flush output handles on some platforms.
1646*0Sstevel@tonic-gate(SunOS, Solaris, HP-UX)
1647*0Sstevel@tonic-gate
1648*0Sstevel@tonic-gate=item getlogin
1649*0Sstevel@tonic-gate
1650*0Sstevel@tonic-gateNot implemented. (S<Mac OS>, S<RISC OS>)
1651*0Sstevel@tonic-gate
1652*0Sstevel@tonic-gate=item getpgrp PID
1653*0Sstevel@tonic-gate
1654*0Sstevel@tonic-gateNot implemented. (S<Mac OS>, Win32, VMS, S<RISC OS>, VOS)
1655*0Sstevel@tonic-gate
1656*0Sstevel@tonic-gate=item getppid
1657*0Sstevel@tonic-gate
1658*0Sstevel@tonic-gateNot implemented. (S<Mac OS>, Win32, S<RISC OS>)
1659*0Sstevel@tonic-gate
1660*0Sstevel@tonic-gate=item getpriority WHICH,WHO
1661*0Sstevel@tonic-gate
1662*0Sstevel@tonic-gateNot implemented. (S<Mac OS>, Win32, VMS, S<RISC OS>, VOS, VM/ESA)
1663*0Sstevel@tonic-gate
1664*0Sstevel@tonic-gate=item getpwnam NAME
1665*0Sstevel@tonic-gate
1666*0Sstevel@tonic-gateNot implemented. (S<Mac OS>, Win32)
1667*0Sstevel@tonic-gate
1668*0Sstevel@tonic-gateNot useful. (S<RISC OS>)
1669*0Sstevel@tonic-gate
1670*0Sstevel@tonic-gate=item getgrnam NAME
1671*0Sstevel@tonic-gate
1672*0Sstevel@tonic-gateNot implemented. (S<Mac OS>, Win32, VMS, S<RISC OS>)
1673*0Sstevel@tonic-gate
1674*0Sstevel@tonic-gate=item getnetbyname NAME
1675*0Sstevel@tonic-gate
1676*0Sstevel@tonic-gateNot implemented. (S<Mac OS>, Win32, S<Plan 9>)
1677*0Sstevel@tonic-gate
1678*0Sstevel@tonic-gate=item getpwuid UID
1679*0Sstevel@tonic-gate
1680*0Sstevel@tonic-gateNot implemented. (S<Mac OS>, Win32)
1681*0Sstevel@tonic-gate
1682*0Sstevel@tonic-gateNot useful. (S<RISC OS>)
1683*0Sstevel@tonic-gate
1684*0Sstevel@tonic-gate=item getgrgid GID
1685*0Sstevel@tonic-gate
1686*0Sstevel@tonic-gateNot implemented. (S<Mac OS>, Win32, VMS, S<RISC OS>)
1687*0Sstevel@tonic-gate
1688*0Sstevel@tonic-gate=item getnetbyaddr ADDR,ADDRTYPE
1689*0Sstevel@tonic-gate
1690*0Sstevel@tonic-gateNot implemented. (S<Mac OS>, Win32, S<Plan 9>)
1691*0Sstevel@tonic-gate
1692*0Sstevel@tonic-gate=item getprotobynumber NUMBER
1693*0Sstevel@tonic-gate
1694*0Sstevel@tonic-gateNot implemented. (S<Mac OS>)
1695*0Sstevel@tonic-gate
1696*0Sstevel@tonic-gate=item getservbyport PORT,PROTO
1697*0Sstevel@tonic-gate
1698*0Sstevel@tonic-gateNot implemented. (S<Mac OS>)
1699*0Sstevel@tonic-gate
1700*0Sstevel@tonic-gate=item getpwent
1701*0Sstevel@tonic-gate
1702*0Sstevel@tonic-gateNot implemented. (S<Mac OS>, Win32, VM/ESA)
1703*0Sstevel@tonic-gate
1704*0Sstevel@tonic-gate=item getgrent
1705*0Sstevel@tonic-gate
1706*0Sstevel@tonic-gateNot implemented. (S<Mac OS>, Win32, VMS, VM/ESA)
1707*0Sstevel@tonic-gate
1708*0Sstevel@tonic-gate=item gethostbyname
1709*0Sstevel@tonic-gate
1710*0Sstevel@tonic-gateC<gethostbyname('localhost')> does not work everywhere: you may have
1711*0Sstevel@tonic-gateto use C<gethostbyname('127.0.0.1')>. (S<Mac OS>, S<Irix 5>)
1712*0Sstevel@tonic-gate
1713*0Sstevel@tonic-gate=item gethostent
1714*0Sstevel@tonic-gate
1715*0Sstevel@tonic-gateNot implemented. (S<Mac OS>, Win32)
1716*0Sstevel@tonic-gate
1717*0Sstevel@tonic-gate=item getnetent
1718*0Sstevel@tonic-gate
1719*0Sstevel@tonic-gateNot implemented. (S<Mac OS>, Win32, S<Plan 9>)
1720*0Sstevel@tonic-gate
1721*0Sstevel@tonic-gate=item getprotoent
1722*0Sstevel@tonic-gate
1723*0Sstevel@tonic-gateNot implemented. (S<Mac OS>, Win32, S<Plan 9>)
1724*0Sstevel@tonic-gate
1725*0Sstevel@tonic-gate=item getservent
1726*0Sstevel@tonic-gate
1727*0Sstevel@tonic-gateNot implemented. (Win32, S<Plan 9>)
1728*0Sstevel@tonic-gate
1729*0Sstevel@tonic-gate=item sethostent STAYOPEN
1730*0Sstevel@tonic-gate
1731*0Sstevel@tonic-gateNot implemented. (S<Mac OS>, Win32, S<Plan 9>, S<RISC OS>)
1732*0Sstevel@tonic-gate
1733*0Sstevel@tonic-gate=item setnetent STAYOPEN
1734*0Sstevel@tonic-gate
1735*0Sstevel@tonic-gateNot implemented. (S<Mac OS>, Win32, S<Plan 9>, S<RISC OS>)
1736*0Sstevel@tonic-gate
1737*0Sstevel@tonic-gate=item setprotoent STAYOPEN
1738*0Sstevel@tonic-gate
1739*0Sstevel@tonic-gateNot implemented. (S<Mac OS>, Win32, S<Plan 9>, S<RISC OS>)
1740*0Sstevel@tonic-gate
1741*0Sstevel@tonic-gate=item setservent STAYOPEN
1742*0Sstevel@tonic-gate
1743*0Sstevel@tonic-gateNot implemented. (S<Plan 9>, Win32, S<RISC OS>)
1744*0Sstevel@tonic-gate
1745*0Sstevel@tonic-gate=item endpwent
1746*0Sstevel@tonic-gate
1747*0Sstevel@tonic-gateNot implemented. (S<Mac OS>, MPE/iX, VM/ESA, Win32)
1748*0Sstevel@tonic-gate
1749*0Sstevel@tonic-gate=item endgrent
1750*0Sstevel@tonic-gate
1751*0Sstevel@tonic-gateNot implemented. (S<Mac OS>, MPE/iX, S<RISC OS>, VM/ESA, VMS, Win32)
1752*0Sstevel@tonic-gate
1753*0Sstevel@tonic-gate=item endhostent
1754*0Sstevel@tonic-gate
1755*0Sstevel@tonic-gateNot implemented. (S<Mac OS>, Win32)
1756*0Sstevel@tonic-gate
1757*0Sstevel@tonic-gate=item endnetent
1758*0Sstevel@tonic-gate
1759*0Sstevel@tonic-gateNot implemented. (S<Mac OS>, Win32, S<Plan 9>)
1760*0Sstevel@tonic-gate
1761*0Sstevel@tonic-gate=item endprotoent
1762*0Sstevel@tonic-gate
1763*0Sstevel@tonic-gateNot implemented. (S<Mac OS>, Win32, S<Plan 9>)
1764*0Sstevel@tonic-gate
1765*0Sstevel@tonic-gate=item endservent
1766*0Sstevel@tonic-gate
1767*0Sstevel@tonic-gateNot implemented. (S<Plan 9>, Win32)
1768*0Sstevel@tonic-gate
1769*0Sstevel@tonic-gate=item getsockopt SOCKET,LEVEL,OPTNAME
1770*0Sstevel@tonic-gate
1771*0Sstevel@tonic-gateNot implemented. (S<Plan 9>)
1772*0Sstevel@tonic-gate
1773*0Sstevel@tonic-gate=item glob EXPR
1774*0Sstevel@tonic-gate
1775*0Sstevel@tonic-gate=item glob
1776*0Sstevel@tonic-gate
1777*0Sstevel@tonic-gateThis operator is implemented via the File::Glob extension on most
1778*0Sstevel@tonic-gateplatforms.  See L<File::Glob> for portability information.
1779*0Sstevel@tonic-gate
1780*0Sstevel@tonic-gate=item ioctl FILEHANDLE,FUNCTION,SCALAR
1781*0Sstevel@tonic-gate
1782*0Sstevel@tonic-gateNot implemented. (VMS)
1783*0Sstevel@tonic-gate
1784*0Sstevel@tonic-gateAvailable only for socket handles, and it does what the ioctlsocket() call
1785*0Sstevel@tonic-gatein the Winsock API does. (Win32)
1786*0Sstevel@tonic-gate
1787*0Sstevel@tonic-gateAvailable only for socket handles. (S<RISC OS>)
1788*0Sstevel@tonic-gate
1789*0Sstevel@tonic-gate=item kill SIGNAL, LIST
1790*0Sstevel@tonic-gate
1791*0Sstevel@tonic-gateC<kill(0, LIST)> is implemented for the sake of taint checking;
1792*0Sstevel@tonic-gateuse with other signals is unimplemented. (S<Mac OS>)
1793*0Sstevel@tonic-gate
1794*0Sstevel@tonic-gateNot implemented, hence not useful for taint checking. (S<RISC OS>)
1795*0Sstevel@tonic-gate
1796*0Sstevel@tonic-gateC<kill()> doesn't have the semantics of C<raise()>, i.e. it doesn't send
1797*0Sstevel@tonic-gatea signal to the identified process like it does on Unix platforms.
1798*0Sstevel@tonic-gateInstead C<kill($sig, $pid)> terminates the process identified by $pid,
1799*0Sstevel@tonic-gateand makes it exit immediately with exit status $sig.  As in Unix, if
1800*0Sstevel@tonic-gate$sig is 0 and the specified process exists, it returns true without
1801*0Sstevel@tonic-gateactually terminating it. (Win32)
1802*0Sstevel@tonic-gate
1803*0Sstevel@tonic-gate=item link OLDFILE,NEWFILE
1804*0Sstevel@tonic-gate
1805*0Sstevel@tonic-gateNot implemented. (S<Mac OS>, MPE/iX, VMS, S<RISC OS>)
1806*0Sstevel@tonic-gate
1807*0Sstevel@tonic-gateLink count not updated because hard links are not quite that hard
1808*0Sstevel@tonic-gate(They are sort of half-way between hard and soft links). (AmigaOS)
1809*0Sstevel@tonic-gate
1810*0Sstevel@tonic-gateHard links are implemented on Win32 (Windows NT and Windows 2000)
1811*0Sstevel@tonic-gateunder NTFS only.
1812*0Sstevel@tonic-gate
1813*0Sstevel@tonic-gate=item lstat FILEHANDLE
1814*0Sstevel@tonic-gate
1815*0Sstevel@tonic-gate=item lstat EXPR
1816*0Sstevel@tonic-gate
1817*0Sstevel@tonic-gate=item lstat
1818*0Sstevel@tonic-gate
1819*0Sstevel@tonic-gateNot implemented. (VMS, S<RISC OS>)
1820*0Sstevel@tonic-gate
1821*0Sstevel@tonic-gateReturn values (especially for device and inode) may be bogus. (Win32)
1822*0Sstevel@tonic-gate
1823*0Sstevel@tonic-gate=item msgctl ID,CMD,ARG
1824*0Sstevel@tonic-gate
1825*0Sstevel@tonic-gate=item msgget KEY,FLAGS
1826*0Sstevel@tonic-gate
1827*0Sstevel@tonic-gate=item msgsnd ID,MSG,FLAGS
1828*0Sstevel@tonic-gate
1829*0Sstevel@tonic-gate=item msgrcv ID,VAR,SIZE,TYPE,FLAGS
1830*0Sstevel@tonic-gate
1831*0Sstevel@tonic-gateNot implemented. (S<Mac OS>, Win32, VMS, S<Plan 9>, S<RISC OS>, VOS)
1832*0Sstevel@tonic-gate
1833*0Sstevel@tonic-gate=item open FILEHANDLE,EXPR
1834*0Sstevel@tonic-gate
1835*0Sstevel@tonic-gate=item open FILEHANDLE
1836*0Sstevel@tonic-gate
1837*0Sstevel@tonic-gateThe C<|> variants are supported only if ToolServer is installed.
1838*0Sstevel@tonic-gate(S<Mac OS>)
1839*0Sstevel@tonic-gate
1840*0Sstevel@tonic-gateopen to C<|-> and C<-|> are unsupported. (S<Mac OS>, Win32, S<RISC OS>)
1841*0Sstevel@tonic-gate
1842*0Sstevel@tonic-gateOpening a process does not automatically flush output handles on some
1843*0Sstevel@tonic-gateplatforms.  (SunOS, Solaris, HP-UX)
1844*0Sstevel@tonic-gate
1845*0Sstevel@tonic-gate=item pipe READHANDLE,WRITEHANDLE
1846*0Sstevel@tonic-gate
1847*0Sstevel@tonic-gateVery limited functionality. (MiNT)
1848*0Sstevel@tonic-gate
1849*0Sstevel@tonic-gate=item readlink EXPR
1850*0Sstevel@tonic-gate
1851*0Sstevel@tonic-gate=item readlink
1852*0Sstevel@tonic-gate
1853*0Sstevel@tonic-gateNot implemented. (Win32, VMS, S<RISC OS>)
1854*0Sstevel@tonic-gate
1855*0Sstevel@tonic-gate=item select RBITS,WBITS,EBITS,TIMEOUT
1856*0Sstevel@tonic-gate
1857*0Sstevel@tonic-gateOnly implemented on sockets. (Win32, VMS)
1858*0Sstevel@tonic-gate
1859*0Sstevel@tonic-gateOnly reliable on sockets. (S<RISC OS>)
1860*0Sstevel@tonic-gate
1861*0Sstevel@tonic-gateNote that the C<select FILEHANDLE> form is generally portable.
1862*0Sstevel@tonic-gate
1863*0Sstevel@tonic-gate=item semctl ID,SEMNUM,CMD,ARG
1864*0Sstevel@tonic-gate
1865*0Sstevel@tonic-gate=item semget KEY,NSEMS,FLAGS
1866*0Sstevel@tonic-gate
1867*0Sstevel@tonic-gate=item semop KEY,OPSTRING
1868*0Sstevel@tonic-gate
1869*0Sstevel@tonic-gateNot implemented. (S<Mac OS>, Win32, VMS, S<RISC OS>, VOS)
1870*0Sstevel@tonic-gate
1871*0Sstevel@tonic-gate=item setgrent
1872*0Sstevel@tonic-gate
1873*0Sstevel@tonic-gateNot implemented. (S<Mac OS>, MPE/iX, VMS, Win32, S<RISC OS>)
1874*0Sstevel@tonic-gate
1875*0Sstevel@tonic-gate=item setpgrp PID,PGRP
1876*0Sstevel@tonic-gate
1877*0Sstevel@tonic-gateNot implemented. (S<Mac OS>, Win32, VMS, S<RISC OS>, VOS)
1878*0Sstevel@tonic-gate
1879*0Sstevel@tonic-gate=item setpriority WHICH,WHO,PRIORITY
1880*0Sstevel@tonic-gate
1881*0Sstevel@tonic-gateNot implemented. (S<Mac OS>, Win32, VMS, S<RISC OS>, VOS)
1882*0Sstevel@tonic-gate
1883*0Sstevel@tonic-gate=item setpwent
1884*0Sstevel@tonic-gate
1885*0Sstevel@tonic-gateNot implemented. (S<Mac OS>, MPE/iX, Win32, S<RISC OS>)
1886*0Sstevel@tonic-gate
1887*0Sstevel@tonic-gate=item setsockopt SOCKET,LEVEL,OPTNAME,OPTVAL
1888*0Sstevel@tonic-gate
1889*0Sstevel@tonic-gateNot implemented. (S<Plan 9>)
1890*0Sstevel@tonic-gate
1891*0Sstevel@tonic-gate=item shmctl ID,CMD,ARG
1892*0Sstevel@tonic-gate
1893*0Sstevel@tonic-gate=item shmget KEY,SIZE,FLAGS
1894*0Sstevel@tonic-gate
1895*0Sstevel@tonic-gate=item shmread ID,VAR,POS,SIZE
1896*0Sstevel@tonic-gate
1897*0Sstevel@tonic-gate=item shmwrite ID,STRING,POS,SIZE
1898*0Sstevel@tonic-gate
1899*0Sstevel@tonic-gateNot implemented. (S<Mac OS>, Win32, VMS, S<RISC OS>, VOS)
1900*0Sstevel@tonic-gate
1901*0Sstevel@tonic-gate=item sockatmark SOCKET
1902*0Sstevel@tonic-gate
1903*0Sstevel@tonic-gateA relatively recent addition to socket functions, may not
1904*0Sstevel@tonic-gatebe implemented even in UNIX platforms.
1905*0Sstevel@tonic-gate
1906*0Sstevel@tonic-gate=item socketpair SOCKET1,SOCKET2,DOMAIN,TYPE,PROTOCOL
1907*0Sstevel@tonic-gate
1908*0Sstevel@tonic-gateNot implemented. (Win32, VMS, S<RISC OS>, VOS, VM/ESA)
1909*0Sstevel@tonic-gate
1910*0Sstevel@tonic-gate=item stat FILEHANDLE
1911*0Sstevel@tonic-gate
1912*0Sstevel@tonic-gate=item stat EXPR
1913*0Sstevel@tonic-gate
1914*0Sstevel@tonic-gate=item stat
1915*0Sstevel@tonic-gate
1916*0Sstevel@tonic-gatePlatforms that do not have rdev, blksize, or blocks will return these
1917*0Sstevel@tonic-gateas '', so numeric comparison or manipulation of these fields may cause
1918*0Sstevel@tonic-gate'not numeric' warnings.
1919*0Sstevel@tonic-gate
1920*0Sstevel@tonic-gatemtime and atime are the same thing, and ctime is creation time instead of
1921*0Sstevel@tonic-gateinode change time. (S<Mac OS>).
1922*0Sstevel@tonic-gate
1923*0Sstevel@tonic-gatectime not supported on UFS (S<Mac OS X>).
1924*0Sstevel@tonic-gate
1925*0Sstevel@tonic-gatectime is creation time instead of inode change time  (Win32).
1926*0Sstevel@tonic-gate
1927*0Sstevel@tonic-gatedevice and inode are not meaningful.  (Win32)
1928*0Sstevel@tonic-gate
1929*0Sstevel@tonic-gatedevice and inode are not necessarily reliable.  (VMS)
1930*0Sstevel@tonic-gate
1931*0Sstevel@tonic-gatemtime, atime and ctime all return the last modification time.  Device and
1932*0Sstevel@tonic-gateinode are not necessarily reliable.  (S<RISC OS>)
1933*0Sstevel@tonic-gate
1934*0Sstevel@tonic-gatedev, rdev, blksize, and blocks are not available.  inode is not
1935*0Sstevel@tonic-gatemeaningful and will differ between stat calls on the same file.  (os2)
1936*0Sstevel@tonic-gate
1937*0Sstevel@tonic-gatesome versions of cygwin when doing a stat("foo") and if not finding it
1938*0Sstevel@tonic-gatemay then attempt to stat("foo.exe") (Cygwin)
1939*0Sstevel@tonic-gate
1940*0Sstevel@tonic-gate=item symlink OLDFILE,NEWFILE
1941*0Sstevel@tonic-gate
1942*0Sstevel@tonic-gateNot implemented. (Win32, VMS, S<RISC OS>)
1943*0Sstevel@tonic-gate
1944*0Sstevel@tonic-gate=item syscall LIST
1945*0Sstevel@tonic-gate
1946*0Sstevel@tonic-gateNot implemented. (S<Mac OS>, Win32, VMS, S<RISC OS>, VOS, VM/ESA)
1947*0Sstevel@tonic-gate
1948*0Sstevel@tonic-gate=item sysopen FILEHANDLE,FILENAME,MODE,PERMS
1949*0Sstevel@tonic-gate
1950*0Sstevel@tonic-gateThe traditional "0", "1", and "2" MODEs are implemented with different
1951*0Sstevel@tonic-gatenumeric values on some systems.  The flags exported by C<Fcntl>
1952*0Sstevel@tonic-gate(O_RDONLY, O_WRONLY, O_RDWR) should work everywhere though.  (S<Mac
1953*0Sstevel@tonic-gateOS>, OS/390, VM/ESA)
1954*0Sstevel@tonic-gate
1955*0Sstevel@tonic-gate=item system LIST
1956*0Sstevel@tonic-gate
1957*0Sstevel@tonic-gateIn general, do not assume the UNIX/POSIX semantics that you can shift
1958*0Sstevel@tonic-gateC<$?> right by eight to get the exit value, or that C<$? & 127>
1959*0Sstevel@tonic-gatewould give you the number of the signal that terminated the program,
1960*0Sstevel@tonic-gateor that C<$? & 128> would test true if the program was terminated by a
1961*0Sstevel@tonic-gatecoredump.  Instead, use the POSIX W*() interfaces: for example, use
1962*0Sstevel@tonic-gateWIFEXITED($?) and WEXITVALUE($?) to test for a normal exit and the exit
1963*0Sstevel@tonic-gatevalue, WIFSIGNALED($?) and WTERMSIG($?) for a signal exit and the
1964*0Sstevel@tonic-gatesignal.  Core dumping is not a portable concept, so there's no portable
1965*0Sstevel@tonic-gateway to test for that.
1966*0Sstevel@tonic-gate
1967*0Sstevel@tonic-gateOnly implemented if ToolServer is installed. (S<Mac OS>)
1968*0Sstevel@tonic-gate
1969*0Sstevel@tonic-gateAs an optimization, may not call the command shell specified in
1970*0Sstevel@tonic-gateC<$ENV{PERL5SHELL}>.  C<system(1, @args)> spawns an external
1971*0Sstevel@tonic-gateprocess and immediately returns its process designator, without
1972*0Sstevel@tonic-gatewaiting for it to terminate.  Return value may be used subsequently
1973*0Sstevel@tonic-gatein C<wait> or C<waitpid>.  Failure to spawn() a subprocess is indicated
1974*0Sstevel@tonic-gateby setting $? to "255 << 8".  C<$?> is set in a way compatible with
1975*0Sstevel@tonic-gateUnix (i.e. the exitstatus of the subprocess is obtained by "$? >> 8",
1976*0Sstevel@tonic-gateas described in the documentation).  (Win32)
1977*0Sstevel@tonic-gate
1978*0Sstevel@tonic-gateThere is no shell to process metacharacters, and the native standard is
1979*0Sstevel@tonic-gateto pass a command line terminated by "\n" "\r" or "\0" to the spawned
1980*0Sstevel@tonic-gateprogram.  Redirection such as C<< > foo >> is performed (if at all) by
1981*0Sstevel@tonic-gatethe run time library of the spawned program.  C<system> I<list> will call
1982*0Sstevel@tonic-gatethe Unix emulation library's C<exec> emulation, which attempts to provide
1983*0Sstevel@tonic-gateemulation of the stdin, stdout, stderr in force in the parent, providing
1984*0Sstevel@tonic-gatethe child program uses a compatible version of the emulation library.
1985*0Sstevel@tonic-gateI<scalar> will call the native command line direct and no such emulation
1986*0Sstevel@tonic-gateof a child Unix program will exists.  Mileage B<will> vary.  (S<RISC OS>)
1987*0Sstevel@tonic-gate
1988*0Sstevel@tonic-gateFar from being POSIX compliant.  Because there may be no underlying
1989*0Sstevel@tonic-gate/bin/sh tries to work around the problem by forking and execing the
1990*0Sstevel@tonic-gatefirst token in its argument string.  Handles basic redirection
1991*0Sstevel@tonic-gate("<" or ">") on its own behalf. (MiNT)
1992*0Sstevel@tonic-gate
1993*0Sstevel@tonic-gateDoes not automatically flush output handles on some platforms.
1994*0Sstevel@tonic-gate(SunOS, Solaris, HP-UX)
1995*0Sstevel@tonic-gate
1996*0Sstevel@tonic-gateThe return value is POSIX-like (shifted up by 8 bits), which only allows
1997*0Sstevel@tonic-gateroom for a made-up value derived from the severity bits of the native
1998*0Sstevel@tonic-gate32-bit condition code (unless overridden by C<use vmsish 'status'>).
1999*0Sstevel@tonic-gateFor more details see L<perlvms/$?>. (VMS)
2000*0Sstevel@tonic-gate
2001*0Sstevel@tonic-gate=item times
2002*0Sstevel@tonic-gate
2003*0Sstevel@tonic-gateOnly the first entry returned is nonzero. (S<Mac OS>)
2004*0Sstevel@tonic-gate
2005*0Sstevel@tonic-gate"cumulative" times will be bogus.  On anything other than Windows NT
2006*0Sstevel@tonic-gateor Windows 2000, "system" time will be bogus, and "user" time is
2007*0Sstevel@tonic-gateactually the time returned by the clock() function in the C runtime
2008*0Sstevel@tonic-gatelibrary. (Win32)
2009*0Sstevel@tonic-gate
2010*0Sstevel@tonic-gateNot useful. (S<RISC OS>)
2011*0Sstevel@tonic-gate
2012*0Sstevel@tonic-gate=item truncate FILEHANDLE,LENGTH
2013*0Sstevel@tonic-gate
2014*0Sstevel@tonic-gate=item truncate EXPR,LENGTH
2015*0Sstevel@tonic-gate
2016*0Sstevel@tonic-gateNot implemented. (Older versions of VMS)
2017*0Sstevel@tonic-gate
2018*0Sstevel@tonic-gateTruncation to zero-length only. (VOS)
2019*0Sstevel@tonic-gate
2020*0Sstevel@tonic-gateIf a FILEHANDLE is supplied, it must be writable and opened in append
2021*0Sstevel@tonic-gatemode (i.e., use C<<< open(FH, '>>filename') >>>
2022*0Sstevel@tonic-gateor C<sysopen(FH,...,O_APPEND|O_RDWR)>.  If a filename is supplied, it
2023*0Sstevel@tonic-gateshould not be held open elsewhere. (Win32)
2024*0Sstevel@tonic-gate
2025*0Sstevel@tonic-gate=item umask EXPR
2026*0Sstevel@tonic-gate
2027*0Sstevel@tonic-gate=item umask
2028*0Sstevel@tonic-gate
2029*0Sstevel@tonic-gateReturns undef where unavailable, as of version 5.005.
2030*0Sstevel@tonic-gate
2031*0Sstevel@tonic-gateC<umask> works but the correct permissions are set only when the file
2032*0Sstevel@tonic-gateis finally closed. (AmigaOS)
2033*0Sstevel@tonic-gate
2034*0Sstevel@tonic-gate=item utime LIST
2035*0Sstevel@tonic-gate
2036*0Sstevel@tonic-gateOnly the modification time is updated. (S<BeOS>, S<Mac OS>, VMS, S<RISC OS>)
2037*0Sstevel@tonic-gate
2038*0Sstevel@tonic-gateMay not behave as expected.  Behavior depends on the C runtime
2039*0Sstevel@tonic-gatelibrary's implementation of utime(), and the filesystem being
2040*0Sstevel@tonic-gateused.  The FAT filesystem typically does not support an "access
2041*0Sstevel@tonic-gatetime" field, and it may limit timestamps to a granularity of
2042*0Sstevel@tonic-gatetwo seconds. (Win32)
2043*0Sstevel@tonic-gate
2044*0Sstevel@tonic-gate=item wait
2045*0Sstevel@tonic-gate
2046*0Sstevel@tonic-gate=item waitpid PID,FLAGS
2047*0Sstevel@tonic-gate
2048*0Sstevel@tonic-gateNot implemented. (S<Mac OS>, VOS)
2049*0Sstevel@tonic-gate
2050*0Sstevel@tonic-gateCan only be applied to process handles returned for processes spawned
2051*0Sstevel@tonic-gateusing C<system(1, ...)> or pseudo processes created with C<fork()>. (Win32)
2052*0Sstevel@tonic-gate
2053*0Sstevel@tonic-gateNot useful. (S<RISC OS>)
2054*0Sstevel@tonic-gate
2055*0Sstevel@tonic-gate=back
2056*0Sstevel@tonic-gate
2057*0Sstevel@tonic-gate=head1 CHANGES
2058*0Sstevel@tonic-gate
2059*0Sstevel@tonic-gate=over 4
2060*0Sstevel@tonic-gate
2061*0Sstevel@tonic-gate=item v1.48, 02 February 2001
2062*0Sstevel@tonic-gate
2063*0Sstevel@tonic-gateVarious updates from perl5-porters over the past year, supported
2064*0Sstevel@tonic-gateplatforms update from Jarkko Hietaniemi.
2065*0Sstevel@tonic-gate
2066*0Sstevel@tonic-gate=item v1.47, 22 March 2000
2067*0Sstevel@tonic-gate
2068*0Sstevel@tonic-gateVarious cleanups from Tom Christiansen, including migration of
2069*0Sstevel@tonic-gatelong platform listings from L<perl>.
2070*0Sstevel@tonic-gate
2071*0Sstevel@tonic-gate=item v1.46, 12 February 2000
2072*0Sstevel@tonic-gate
2073*0Sstevel@tonic-gateUpdates for VOS and MPE/iX. (Peter Prymmer)  Other small changes.
2074*0Sstevel@tonic-gate
2075*0Sstevel@tonic-gate=item v1.45, 20 December 1999
2076*0Sstevel@tonic-gate
2077*0Sstevel@tonic-gateSmall changes from 5.005_63 distribution, more changes to EBCDIC info.
2078*0Sstevel@tonic-gate
2079*0Sstevel@tonic-gate=item v1.44, 19 July 1999
2080*0Sstevel@tonic-gate
2081*0Sstevel@tonic-gateA bunch of updates from Peter Prymmer for C<$^O> values,
2082*0Sstevel@tonic-gateendianness, File::Spec, VMS, BS2000, OS/400.
2083*0Sstevel@tonic-gate
2084*0Sstevel@tonic-gate=item v1.43, 24 May 1999
2085*0Sstevel@tonic-gate
2086*0Sstevel@tonic-gateAdded a lot of cleaning up from Tom Christiansen.
2087*0Sstevel@tonic-gate
2088*0Sstevel@tonic-gate=item v1.42, 22 May 1999
2089*0Sstevel@tonic-gate
2090*0Sstevel@tonic-gateAdded notes about tests, sprintf/printf, and epoch offsets.
2091*0Sstevel@tonic-gate
2092*0Sstevel@tonic-gate=item v1.41, 19 May 1999
2093*0Sstevel@tonic-gate
2094*0Sstevel@tonic-gateLots more little changes to formatting and content.
2095*0Sstevel@tonic-gate
2096*0Sstevel@tonic-gateAdded a bunch of C<$^O> and related values
2097*0Sstevel@tonic-gatefor various platforms; fixed mail and web addresses, and added
2098*0Sstevel@tonic-gateand changed miscellaneous notes.  (Peter Prymmer)
2099*0Sstevel@tonic-gate
2100*0Sstevel@tonic-gate=item v1.40, 11 April 1999
2101*0Sstevel@tonic-gate
2102*0Sstevel@tonic-gateMiscellaneous changes.
2103*0Sstevel@tonic-gate
2104*0Sstevel@tonic-gate=item v1.39, 11 February 1999
2105*0Sstevel@tonic-gate
2106*0Sstevel@tonic-gateChanges from Jarkko and EMX URL fixes Michael Schwern.  Additional
2107*0Sstevel@tonic-gatenote about newlines added.
2108*0Sstevel@tonic-gate
2109*0Sstevel@tonic-gate=item v1.38, 31 December 1998
2110*0Sstevel@tonic-gate
2111*0Sstevel@tonic-gateMore changes from Jarkko.
2112*0Sstevel@tonic-gate
2113*0Sstevel@tonic-gate=item v1.37, 19 December 1998
2114*0Sstevel@tonic-gate
2115*0Sstevel@tonic-gateMore minor changes.  Merge two separate version 1.35 documents.
2116*0Sstevel@tonic-gate
2117*0Sstevel@tonic-gate=item v1.36, 9 September 1998
2118*0Sstevel@tonic-gate
2119*0Sstevel@tonic-gateUpdated for Stratus VOS.  Also known as version 1.35.
2120*0Sstevel@tonic-gate
2121*0Sstevel@tonic-gate=item v1.35, 13 August 1998
2122*0Sstevel@tonic-gate
2123*0Sstevel@tonic-gateIntegrate more minor changes, plus addition of new sections under
2124*0Sstevel@tonic-gateL<"ISSUES">: L<"Numbers endianness and Width">,
2125*0Sstevel@tonic-gateL<"Character sets and character encoding">,
2126*0Sstevel@tonic-gateL<"Internationalisation">.
2127*0Sstevel@tonic-gate
2128*0Sstevel@tonic-gate=item v1.33, 06 August 1998
2129*0Sstevel@tonic-gate
2130*0Sstevel@tonic-gateIntegrate more minor changes.
2131*0Sstevel@tonic-gate
2132*0Sstevel@tonic-gate=item v1.32, 05 August 1998
2133*0Sstevel@tonic-gate
2134*0Sstevel@tonic-gateIntegrate more minor changes.
2135*0Sstevel@tonic-gate
2136*0Sstevel@tonic-gate=item v1.30, 03 August 1998
2137*0Sstevel@tonic-gate
2138*0Sstevel@tonic-gateMajor update for RISC OS, other minor changes.
2139*0Sstevel@tonic-gate
2140*0Sstevel@tonic-gate=item v1.23, 10 July 1998
2141*0Sstevel@tonic-gate
2142*0Sstevel@tonic-gateFirst public release with perl5.005.
2143*0Sstevel@tonic-gate
2144*0Sstevel@tonic-gate=back
2145*0Sstevel@tonic-gate
2146*0Sstevel@tonic-gate=head1 Supported Platforms
2147*0Sstevel@tonic-gate
2148*0Sstevel@tonic-gateAs of September 2003 (the Perl release 5.8.1), the following platforms
2149*0Sstevel@tonic-gateare able to build Perl from the standard source code distribution
2150*0Sstevel@tonic-gateavailable at http://www.cpan.org/src/index.html
2151*0Sstevel@tonic-gate
2152*0Sstevel@tonic-gate        AIX
2153*0Sstevel@tonic-gate        BeOS
2154*0Sstevel@tonic-gate        BSD/OS          (BSDi)
2155*0Sstevel@tonic-gate        Cygwin
2156*0Sstevel@tonic-gate        DG/UX
2157*0Sstevel@tonic-gate        DOS DJGPP       1)
2158*0Sstevel@tonic-gate        DYNIX/ptx
2159*0Sstevel@tonic-gate        EPOC R5
2160*0Sstevel@tonic-gate        FreeBSD
2161*0Sstevel@tonic-gate        HI-UXMPP        (Hitachi) (5.8.0 worked but we didn't know it)
2162*0Sstevel@tonic-gate        HP-UX
2163*0Sstevel@tonic-gate        IRIX
2164*0Sstevel@tonic-gate        Linux
2165*0Sstevel@tonic-gate        LynxOS
2166*0Sstevel@tonic-gate        Mac OS Classic
2167*0Sstevel@tonic-gate        Mac OS X        (Darwin)
2168*0Sstevel@tonic-gate        MPE/iX
2169*0Sstevel@tonic-gate        NetBSD
2170*0Sstevel@tonic-gate        NetWare
2171*0Sstevel@tonic-gate        NonStop-UX
2172*0Sstevel@tonic-gate        ReliantUNIX     (formerly SINIX)
2173*0Sstevel@tonic-gate        OpenBSD
2174*0Sstevel@tonic-gate        OpenVMS         (formerly VMS)
2175*0Sstevel@tonic-gate        Open UNIX       (Unixware) (since Perl 5.8.1/5.9.0)
2176*0Sstevel@tonic-gate        OS/2
2177*0Sstevel@tonic-gate        OS/400          (using the PASE) (since Perl 5.8.1/5.9.0)
2178*0Sstevel@tonic-gate        PowerUX
2179*0Sstevel@tonic-gate        POSIX-BC        (formerly BS2000)
2180*0Sstevel@tonic-gate        QNX
2181*0Sstevel@tonic-gate        Solaris
2182*0Sstevel@tonic-gate        SunOS 4
2183*0Sstevel@tonic-gate        SUPER-UX        (NEC)
2184*0Sstevel@tonic-gate        SVR4
2185*0Sstevel@tonic-gate        Tru64 UNIX      (formerly DEC OSF/1, Digital UNIX)
2186*0Sstevel@tonic-gate        UNICOS
2187*0Sstevel@tonic-gate        UNICOS/mk
2188*0Sstevel@tonic-gate        UTS
2189*0Sstevel@tonic-gate        VOS
2190*0Sstevel@tonic-gate        Win95/98/ME/2K/XP 2)
2191*0Sstevel@tonic-gate        WinCE
2192*0Sstevel@tonic-gate        z/OS            (formerly OS/390)
2193*0Sstevel@tonic-gate        VM/ESA
2194*0Sstevel@tonic-gate
2195*0Sstevel@tonic-gate        1) in DOS mode either the DOS or OS/2 ports can be used
2196*0Sstevel@tonic-gate        2) compilers: Borland, MinGW (GCC), VC6
2197*0Sstevel@tonic-gate
2198*0Sstevel@tonic-gateThe following platforms worked with the previous releases (5.6 and
2199*0Sstevel@tonic-gate5.7), but we did not manage either to fix or to test these in time
2200*0Sstevel@tonic-gatefor the 5.8.1 release.  There is a very good chance that many of these
2201*0Sstevel@tonic-gatewill work fine with the 5.8.1.
2202*0Sstevel@tonic-gate
2203*0Sstevel@tonic-gate        DomainOS
2204*0Sstevel@tonic-gate        Hurd
2205*0Sstevel@tonic-gate        MachTen
2206*0Sstevel@tonic-gate        PowerMAX
2207*0Sstevel@tonic-gate        SCO SV
2208*0Sstevel@tonic-gate        Unixware
2209*0Sstevel@tonic-gate        Windows 3.1
2210*0Sstevel@tonic-gate
2211*0Sstevel@tonic-gateKnown to be broken for 5.8.0 and 5.8.1 (but 5.6.1 and 5.7.2 can be used):
2212*0Sstevel@tonic-gate
2213*0Sstevel@tonic-gate	AmigaOS
2214*0Sstevel@tonic-gate
2215*0Sstevel@tonic-gateThe following platforms have been known to build Perl from source in
2216*0Sstevel@tonic-gatethe past (5.005_03 and earlier), but we haven't been able to verify
2217*0Sstevel@tonic-gatetheir status for the current release, either because the
2218*0Sstevel@tonic-gatehardware/software platforms are rare or because we don't have an
2219*0Sstevel@tonic-gateactive champion on these platforms--or both.  They used to work,
2220*0Sstevel@tonic-gatethough, so go ahead and try compiling them, and let perlbug@perl.org
2221*0Sstevel@tonic-gateof any trouble.
2222*0Sstevel@tonic-gate
2223*0Sstevel@tonic-gate        3b1
2224*0Sstevel@tonic-gate        A/UX
2225*0Sstevel@tonic-gate        ConvexOS
2226*0Sstevel@tonic-gate        CX/UX
2227*0Sstevel@tonic-gate        DC/OSx
2228*0Sstevel@tonic-gate        DDE SMES
2229*0Sstevel@tonic-gate        DOS EMX
2230*0Sstevel@tonic-gate        Dynix
2231*0Sstevel@tonic-gate        EP/IX
2232*0Sstevel@tonic-gate        ESIX
2233*0Sstevel@tonic-gate        FPS
2234*0Sstevel@tonic-gate        GENIX
2235*0Sstevel@tonic-gate        Greenhills
2236*0Sstevel@tonic-gate        ISC
2237*0Sstevel@tonic-gate        MachTen 68k
2238*0Sstevel@tonic-gate        MiNT
2239*0Sstevel@tonic-gate        MPC
2240*0Sstevel@tonic-gate        NEWS-OS
2241*0Sstevel@tonic-gate        NextSTEP
2242*0Sstevel@tonic-gate        OpenSTEP
2243*0Sstevel@tonic-gate        Opus
2244*0Sstevel@tonic-gate        Plan 9
2245*0Sstevel@tonic-gate        RISC/os
2246*0Sstevel@tonic-gate        SCO ODT/OSR
2247*0Sstevel@tonic-gate        Stellar
2248*0Sstevel@tonic-gate        SVR2
2249*0Sstevel@tonic-gate        TI1500
2250*0Sstevel@tonic-gate        TitanOS
2251*0Sstevel@tonic-gate        Ultrix
2252*0Sstevel@tonic-gate        Unisys Dynix
2253*0Sstevel@tonic-gate
2254*0Sstevel@tonic-gateThe following platforms have their own source code distributions and
2255*0Sstevel@tonic-gatebinaries available via http://www.cpan.org/ports/
2256*0Sstevel@tonic-gate
2257*0Sstevel@tonic-gate                                Perl release
2258*0Sstevel@tonic-gate
2259*0Sstevel@tonic-gate        OS/400 (ILE)            5.005_02
2260*0Sstevel@tonic-gate        Tandem Guardian         5.004
2261*0Sstevel@tonic-gate
2262*0Sstevel@tonic-gateThe following platforms have only binaries available via
2263*0Sstevel@tonic-gatehttp://www.cpan.org/ports/index.html :
2264*0Sstevel@tonic-gate
2265*0Sstevel@tonic-gate                                Perl release
2266*0Sstevel@tonic-gate
2267*0Sstevel@tonic-gate        Acorn RISCOS            5.005_02
2268*0Sstevel@tonic-gate        AOS                     5.002
2269*0Sstevel@tonic-gate        LynxOS                  5.004_02
2270*0Sstevel@tonic-gate
2271*0Sstevel@tonic-gateAlthough we do suggest that you always build your own Perl from
2272*0Sstevel@tonic-gatethe source code, both for maximal configurability and for security,
2273*0Sstevel@tonic-gatein case you are in a hurry you can check
2274*0Sstevel@tonic-gatehttp://www.cpan.org/ports/index.html for binary distributions.
2275*0Sstevel@tonic-gate
2276*0Sstevel@tonic-gate=head1 SEE ALSO
2277*0Sstevel@tonic-gate
2278*0Sstevel@tonic-gateL<perlaix>, L<perlamiga>, L<perlapollo>, L<perlbeos>, L<perlbs2000>,
2279*0Sstevel@tonic-gateL<perlce>, L<perlcygwin>, L<perldgux>, L<perldos>, L<perlepoc>,
2280*0Sstevel@tonic-gateL<perlebcdic>, L<perlfreebsd>, L<perlhurd>, L<perlhpux>, L<perlirix>,
2281*0Sstevel@tonic-gateL<perlmachten>, L<perlmacos>, L<perlmacosx>, L<perlmint>, L<perlmpeix>,
2282*0Sstevel@tonic-gateL<perlnetware>, L<perlos2>, L<perlos390>, L<perlos400>,
2283*0Sstevel@tonic-gateL<perlplan9>, L<perlqnx>, L<perlsolaris>, L<perltru64>,
2284*0Sstevel@tonic-gateL<perlunicode>, L<perlvmesa>, L<perlvms>, L<perlvos>,
2285*0Sstevel@tonic-gateL<perlwin32>, and L<Win32>.
2286*0Sstevel@tonic-gate
2287*0Sstevel@tonic-gate=head1 AUTHORS / CONTRIBUTORS
2288*0Sstevel@tonic-gate
2289*0Sstevel@tonic-gateAbigail <abigail@foad.org>,
2290*0Sstevel@tonic-gateCharles Bailey <bailey@newman.upenn.edu>,
2291*0Sstevel@tonic-gateGraham Barr <gbarr@pobox.com>,
2292*0Sstevel@tonic-gateTom Christiansen <tchrist@perl.com>,
2293*0Sstevel@tonic-gateNicholas Clark <nick@ccl4.org>,
2294*0Sstevel@tonic-gateThomas Dorner <Thomas.Dorner@start.de>,
2295*0Sstevel@tonic-gateAndy Dougherty <doughera@lafayette.edu>,
2296*0Sstevel@tonic-gateDominic Dunlop <domo@computer.org>,
2297*0Sstevel@tonic-gateNeale Ferguson <neale@vma.tabnsw.com.au>,
2298*0Sstevel@tonic-gateDavid J. Fiander <davidf@mks.com>,
2299*0Sstevel@tonic-gatePaul Green <Paul_Green@stratus.com>,
2300*0Sstevel@tonic-gateM.J.T. Guy <mjtg@cam.ac.uk>,
2301*0Sstevel@tonic-gateJarkko Hietaniemi <jhi@iki.fi>,
2302*0Sstevel@tonic-gateLuther Huffman <lutherh@stratcom.com>,
2303*0Sstevel@tonic-gateNick Ing-Simmons <nick@ing-simmons.net>,
2304*0Sstevel@tonic-gateAndreas J. KE<ouml>nig <a.koenig@mind.de>,
2305*0Sstevel@tonic-gateMarkus Laker <mlaker@contax.co.uk>,
2306*0Sstevel@tonic-gateAndrew M. Langmead <aml@world.std.com>,
2307*0Sstevel@tonic-gateLarry Moore <ljmoore@freespace.net>,
2308*0Sstevel@tonic-gatePaul Moore <Paul.Moore@uk.origin-it.com>,
2309*0Sstevel@tonic-gateChris Nandor <pudge@pobox.com>,
2310*0Sstevel@tonic-gateMatthias Neeracher <neeracher@mac.com>,
2311*0Sstevel@tonic-gatePhilip Newton <pne@cpan.org>,
2312*0Sstevel@tonic-gateGary Ng <71564.1743@CompuServe.COM>,
2313*0Sstevel@tonic-gateTom Phoenix <rootbeer@teleport.com>,
2314*0Sstevel@tonic-gateAndrE<eacute> Pirard <A.Pirard@ulg.ac.be>,
2315*0Sstevel@tonic-gatePeter Prymmer <pvhp@forte.com>,
2316*0Sstevel@tonic-gateHugo van der Sanden <hv@crypt0.demon.co.uk>,
2317*0Sstevel@tonic-gateGurusamy Sarathy <gsar@activestate.com>,
2318*0Sstevel@tonic-gatePaul J. Schinder <schinder@pobox.com>,
2319*0Sstevel@tonic-gateMichael G Schwern <schwern@pobox.com>,
2320*0Sstevel@tonic-gateDan Sugalski <dan@sidhe.org>,
2321*0Sstevel@tonic-gateNathan Torkington <gnat@frii.com>.
2322*0Sstevel@tonic-gate
2323