Mercurial > octave-nkf

comparison scripts/miscellaneous/movefile.m @ 12291:b6840c49fbdb release-3-4-x

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add S_ISBLK and family of functions to documentation. Improve docstrings for functions in System Utilities::File Utilities.
author Rik <octave@nomad.inbox5.com>
date Sat, 29 Jan 2011 21:28:38 -0800
parents c792872f8942
children 1536ed546219
comparison
equal deleted inserted replaced
12290:75a496c7a3df 12291:b6840c49fbdb
15 ## You should have received a copy of the GNU General Public License 15 ## You should have received a copy of the GNU General Public License
16 ## along with Octave; see the file COPYING. If not, see 16 ## along with Octave; see the file COPYING. If not, see
17 ## <http://www.gnu.org/licenses/>. 17 ## <http://www.gnu.org/licenses/>.
18 18
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {[@var{status}, @var{msg}, @var{msgid}] =} movefile (@var{f1}, @var{f2}) 20 ## @deftypefn {Function File} {[@var{status}, @var{msg}, @var{msgid}] =} movefile (@var{f1}, @var{f2})
21 ## @deftypefnx {Function File} {[@var{status}, @var{msg}, @var{msgid}] =} movefile (@var{f1}, @var{f2}, 'f')
21 ## Move the file @var{f1} to the new name @var{f2}. The name @var{f1} 22 ## Move the file @var{f1} to the new name @var{f2}. The name @var{f1}
22 ## may contain globbing patterns. If @var{f1} expands to multiple file 23 ## may contain globbing patterns. If @var{f1} expands to multiple file
23 ## names, @var{f2} must be a directory. 24 ## names, @var{f2} must be a directory. If the force flag 'f' is given
25 ## then any existing files will be overwritten without prompting.
24 ## 26 ##
25 ## If successful, @var{status} is 1, with @var{msg} and @var{msgid} empty\n\ 27 ## If successful, @var{status} is 1, with @var{msg} and @var{msgid} empty
26 ## character strings. Otherwise, @var{status} is 0, @var{msg} contains a\n\ 28 ## character strings. Otherwise, @var{status} is 0, @var{msg} contains a
27 ## system-dependent error message, and @var{msgid} contains a unique\n\ 29 ## system-dependent error message, and @var{msgid} contains a unique
28 ## message identifier.\n\ 30 ## message identifier.
29 ## @seealso{glob} 31 ## @seealso{rename, copyfile}
30 ## @end deftypefn 32 ## @end deftypefn
31 33
32 function [status, msg, msgid] = movefile (f1, f2, force) 34 function [status, msg, msgid] = movefile (f1, f2, force)
33 35
34 max_cmd_line = 1024; 36 max_cmd_line = 1024;