<?xml version="1.0" encoding="utf-8" ?> <!-- for emacs: -*- coding: utf-8 -*- -->
<!-- Apache may like this line in the file .htaccess: AddCharset utf-8 .html -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN" "http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg-flat.dtd" >
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head><title>copyFile(String,String)</title>
<link rel="stylesheet" type="text/css" href="../../../../Macaulay2/Style/doc.css"/>
</head>
<body>
<table class="buttons">
<tr>
<td><div><a href="_move__File_lp__String_cm__String_rp.html">next</a> | <a href="_file__Time.html">previous</a> | <a href="_move__File_lp__String_cm__String_rp.html">forward</a> | <a href="_file__Time.html">backward</a> | <a href="_file_spmanipulation.html">up</a> | <a href="index.html">top</a> | <a href="master.html">index</a> | <a href="toc.html">toc</a> | <a href="http://www.math.uiuc.edu/Macaulay2/">Macaulay2 web site</a></div>
</td>
</tr>
</table>
<div><a href="index.html" title="">Macaulay2Doc</a> > <a href="___The_sp__Macaulay2_splanguage.html" title="">The Macaulay2 language</a> > <a href="_file_spmanipulation.html" title="Unix file manipulation functions">file manipulation</a> > <a href="_copy__File_lp__String_cm__String_rp.html" title="">copyFile(String,String)</a></div>
<hr/>
<div><h1>copyFile(String,String)</h1>
<div class="single"><h2>Synopsis</h2>
<ul><li><div class="list"><dl class="element"><dt class="heading">Usage: </dt><dd class="value"><div><tt>copyFile(src,dst)</tt></div>
</dd></dl>
</div>
</li>
<li><span>Function: <a href="_copy__File_lp__String_cm__String_rp.html" title="">copyFile</a></span></li>
<li><div class="single">Inputs:<ul><li><span><tt>src</tt>, <span>a <a href="___String.html">string</a></span>, the filename or path to an existing regular file</span></li>
<li><span><tt>dst</tt>, <span>a <a href="___String.html">string</a></span>, the filename or path to the copy to be made</span></li>
</ul>
</div>
</li>
<li><div class="single">Consequences:<ul><li>the file may be copied</li>
</ul>
</div>
</li>
<li><div class="single"><a href="_using_spfunctions_spwith_spoptional_spinputs.html">Optional inputs</a>:<ul><li><span><tt>UpdateOnly => </tt><span><span>a <a href="___Boolean.html">Boolean value</a></span>, <span>default value false</span>, whether to copy file only if the destination file does not exist or is older than the source file</span></span></li>
<li><span><tt>Verbose => </tt><span><span>a <a href="___Boolean.html">Boolean value</a></span>, <span>default value false</span>, whether to report individual file operations</span></span></li>
</ul>
</div>
</li>
</ul>
</div>
<div class="single"><h2>Description</h2>
<div><table class="examples"><tr><td><pre>i1 : src = temporaryFileName()
o1 = /tmp/M2-12869-1</pre>
</td></tr>
<tr><td><pre>i2 : dst = temporaryFileName()
o2 = /tmp/M2-12869-2</pre>
</td></tr>
<tr><td><pre>i3 : src << "hi there" << close
o3 = /tmp/M2-12869-1
o3 : File</pre>
</td></tr>
<tr><td><pre>i4 : copyFile(src,dst,Verbose=>true)
--copying: /tmp/M2-12869-1 -> /tmp/M2-12869-2</pre>
</td></tr>
<tr><td><pre>i5 : get dst
o5 = hi there</pre>
</td></tr>
<tr><td><pre>i6 : copyFile(src,dst,Verbose=>true,UpdateOnly => true)
--skipping: /tmp/M2-12869-1 not newer than /tmp/M2-12869-2</pre>
</td></tr>
<tr><td><pre>i7 : src << "ho there" << close
o7 = /tmp/M2-12869-1
o7 : File</pre>
</td></tr>
<tr><td><pre>i8 : copyFile(src,dst,Verbose=>true,UpdateOnly => true)
--skipping: /tmp/M2-12869-1 not newer than /tmp/M2-12869-2</pre>
</td></tr>
<tr><td><pre>i9 : get dst
o9 = hi there</pre>
</td></tr>
<tr><td><pre>i10 : removeFile src</pre>
</td></tr>
<tr><td><pre>i11 : removeFile dst</pre>
</td></tr>
</table>
</div>
</div>
<div class="single"><h2>See also</h2>
<ul><li><span><a href="_copy__Directory_lp__String_cm__String_rp.html" title="">copyDirectory</a></span></li>
<li><span><a href="_symlink__Directory_lp__String_cm__String_rp.html" title="make symbolic links for all files in a directory tree">symlinkDirectory</a> -- make symbolic links for all files in a directory tree</span></li>
</ul>
</div>
</div>
</body>
</html>
