1 # File/Copy.pm. Written in 1994 by Aaron Sherman <ajs@ajs.com>. This
2 # source code has been placed in the public domain by the author.
3 # Please be kind and preserve the documentation.
13 @EXPORT_OK=qw(copy cp);
15 $File::Copy::VERSION = '1.5';
16 $File::Copy::Too_Big = 1024 * 1024 * 2;
19 # Version of File::Copy
20 return $File::Copy::VERSION;
24 croak("Usage: copy( file1, file2 [, buffersize]) ")
25 unless(@_ == 2 || @_ == 3);
27 if (($^O eq 'VMS' or $^O eq 'os2') && ref(\$to) ne 'GLOB' &&
28 !(defined ref $to and (ref($to) eq 'GLOB' ||
29 ref($to) eq 'FileHandle' || ref($to) eq 'VMS::Stdio')))
30 { return File::Copy::syscopy($_[0],$_[1]) }
37 my ($size, $status, $r, $buf);
42 if (ref(\$from) eq 'GLOB') {
44 } elsif (defined ref $from and
45 (ref($from) eq 'GLOB' || ref($from) eq 'FileHandle' ||
46 ref($from) eq 'VMS::Stdio')) {
49 open(FROM,"<$from")||goto(fail_open1);
54 if (ref(\$to) eq 'GLOB') {
56 } elsif (defined ref $to and
57 (ref($to) eq 'GLOB' || ref($to) eq 'FileHandle' ||
58 ref($to) eq 'VMS::Stdio')) {
61 open(TO,">$to")||goto(fail_open2);
67 $size = shift(@_) + 0;
68 croak("Bad buffer size for copy: $size\n") unless ($size > 0);
71 $size = 1024 if ($size < 512);
72 $size = $File::Copy::Too_Big if ($size > $File::Copy::Too_Big);
76 while(defined($r = read(FROM,$buf,$size)) && $r > 0) {
77 if (syswrite (TO,$buf,$r) != $r) {
81 goto fail_inner unless(defined($r));
82 close(TO) || goto fail_open2 if $closeto;
83 close(FROM) || goto fail_open1 if $closefrom;
87 # All of these contortions try to preserve error messages...
93 $! = $status unless $!;
100 $! = $status unless $!;
109 # &syscopy is an XSUB under OS/2
110 *syscopy = ($^O eq 'VMS' ? \&rmscopy : \©) unless $^O eq 'os2';
118 File::Copy - Copy files or filehandles
124 copy("file1","file2");
125 copy("Copy.pm",\*STDOUT);'
130 $n=FileHandle->new("/dev/null","r");
135 The File::Copy module provides a basic function C<copy> which takes two
136 parameters: a file to copy from and a file to copy to. Either
137 argument may be a string, a FileHandle reference or a FileHandle
138 glob. Obviously, if the first argument is a filehandle of some
139 sort, it will be read from, and if it is a file I<name> it will
140 be opened for reading. Likewise, the second argument will be
141 written to (and created if need be). Note that passing in
142 files as handles instead of names may lead to loss of information
143 on some operating systems; it is recommended that you use file
144 names whenever possible.
146 An optional third parameter can be used to specify the buffer
147 size used for copying. This is the number of bytes from the
148 first file, that wil be held in memory at any given time, before
149 being written to the second file. The default buffer size depends
150 upon the file, but will generally be the whole file (up to 2Mb), or
151 1k for filehandles that do not reference files (eg. sockets).
153 You may use the syntax C<use File::Copy "cp"> to get at the
154 "cp" alias for this function. The syntax is I<exactly> the same.
156 File::Copy also provides the C<syscopy> routine, which copies the
157 file specified in the first parameter to the file specified in the
158 second parameter, preserving OS-specific attributes and file
159 structure. For Unix systems, this is equivalent to the simple
160 C<copy> routine. For VMS systems, this calls the C<rmscopy>
161 routine (see below). For OS/2 systems, this calls the C<syscopy>
164 =head2 Special behavior under VMS
166 If the second argument to C<copy> is not a file handle for an
167 already opened file, then C<copy> will perform an RMS copy of
168 the input file to a new output file, in order to preserve file
169 attributes, indexed file structure, I<etc.> The buffer size
170 parameter is ignored. If the second argument to C<copy> is a
171 Perl handle to an opened file, then data is copied using Perl
172 operators, and no effort is made to preserve file attributes
175 The RMS copy routine may also be called directly under VMS
176 as C<File::Copy::rmscopy> (or C<File::Copy::syscopy>, which
177 is just an alias for this routine).
179 =item rmscopy($from,$to[,$date_flag])
181 The first and second arguments may be strings, typeglobs, or
182 typeglob references; they are used in all cases to obtain the
183 I<filespec> of the input and output files, respectively. The
184 name and type of the input file are used as defaults for the
185 output file, if necessary.
187 A new version of the output file is always created, which
188 inherits the structure and RMS attributes of the input file,
189 except for owner and protections (and possibly timestamps;
190 see below). All data from the input file is copied to the
191 output file; if either of the first two parameters to C<rmscopy>
192 is a file handle, its position is unchanged. (Note that this
193 means a file handle pointing to the output file will be
194 associated with an old version of that file after C<rmscopy>
195 returns, not the newly created version.)
197 The third parameter is an integer flag, which tells C<rmscopy>
198 how to handle timestamps. If it is < 0, none of the input file's
199 timestamps are propagated to the output file. If it is > 0, then
200 it is interpreted as a bitmask: if bit 0 (the LSB) is set, then
201 timestamps other than the revision date are propagated; if bit 1
202 is set, the revision date is propagated. If the third parameter
203 to C<rmscopy> is 0, then it behaves much like the DCL COPY command:
204 if the name or type of the output file was explicitly specified,
205 then no timestamps are propagated, but if they were taken implicitly
206 from the input filespec, then all timestamps other than the
207 revision date are propagated. If this parameter is not supplied,
210 Like C<copy>, C<rmscopy> returns 1 on success. If an error occurs,
211 it sets C<$!>, deletes the output file, and returns 0.
215 Returns 1 on success, 0 on failure. $! will be set if an error was
220 File::Copy was written by Aaron Sherman I<E<lt>ajs@ajs.comE<gt>> in 1995.
221 The VMS-specific code was added by Charles Bailey
222 I<E<lt>bailey@genetics.upenn.eduE<gt>> in March 1996.