/usr/share/doc/sludge/SLUDGEDevKitHelp/renameFile.html is in sludge-doc 2.1.2-3build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<TITLE>renameFile</TITLE>
<link rel="stylesheet" type="text/css" href="style.css" />
</head>
<BODY>
<HR>
<div align="center"><img id="headerGraphic" src="images/sludge300.png" alt="SLUDGE"/></div>
<h2>renameFile</h2>
<HR>
<H3>Syntax:</H3>
<P>
<pre class="syntax">renameFile (<i>oldFilename, newFilename</i>);</pre>
</P>
<H3>Purpose:</H3>
<P>
Renames the file specified by <i>oldFilename</i> to <i>newFilename</i> - which should both be strings, not file handles. If you're writing a custom save game mechanism, you may require this functionality... so here it is. The strings <i>oldFilename</i> and <i>newFilename</i> shouldn't contain any of the characters ":", "/" and "\" - a precaution to make it more difficult to write malicious code.
</P>
<P>
This function supports filename bodging - for details see the <a href="bodgeFilenames.html">bodgeFilenames</a> command.
</P>
<H3>Return value:</H3>
<P>
The command returns TRUE if the renaming was a success, FALSE otherwise.
</P>
<H3>See also: </H3>
<P>
<a href="fileExists.html">fileExists</a>
</P>
<P>
<a href="getMatchingFiles.html">getMatchingFiles</a>
</P>
<P>
<a href="loadGame.html">loadGame</a>
</P>
<P>
<a href="saveGame.html">saveGame</a>
</P>
<P>
<a href="deleteFile.html">deleteFile</a>
</P>
<P class="copyright-notice">SLUDGE and this SLUDGE documentation are <A HREF="Copyright.html">copyright</A> Hungry Software and contributors 2000-2011
</P>
<HR>
</BODY>
</html>
|