Mercurial > hg > octave-lyh
comparison scripts/miscellaneous/copyfile.m @ 12211:11faa69c4eaa
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 | 72c96de7a403 |
comparison
equal
deleted
inserted
replaced
12210:cd6f7f4f53a3 | 12211:11faa69c4eaa |
---|---|
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}] =} copyfile (@var{f1}, @var{f2}, @var{force}) | 20 ## @deftypefn {Function File} {[@var{status}, @var{msg}, @var{msgid}] =} copyfile (@var{f1}, @var{f2}) |
21 ## @deftypefnx {Function File} {[@var{status}, @var{msg}, @var{msgid}] =} copyfile (@var{f1}, @var{f2}, 'f') | |
21 ## Copy the file @var{f1} to the new name @var{f2}. The name @var{f1} | 22 ## Copy 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. If @var{force} is given and equals | 24 ## names, @var{f2} must be a directory. If the force flag 'f' is given then |
24 ## the string "f" the copy operation will be forced. | 25 ## existing destination files will be overwritten without prompting. |
25 ## | 26 ## |
26 ## 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 |
27 ## character strings. Otherwise, @var{status} is 0, @var{msg} contains a\n\ | 28 ## character strings. Otherwise, @var{status} is 0, @var{msg} contains a |
28 ## system-dependent error message, and @var{msgid} contains a unique\n\ | 29 ## system-dependent error message, and @var{msgid} contains a unique |
29 ## message identifier.\n\ | 30 ## message identifier. |
30 ## @seealso{glob, movefile} | 31 ## @seealso{movefile} |
31 ## @end deftypefn | 32 ## @end deftypefn |
32 | 33 |
33 function [status, msg, msgid] = copyfile (f1, f2, force) | 34 function [status, msg, msgid] = copyfile (f1, f2, force) |
34 | 35 |
35 max_cmd_line = 1024; | 36 max_cmd_line = 1024; |