Mercurial > octave
diff scripts/miscellaneous/movefile.m @ 25040:328518881291 stable
Add command forms to documentation of copyfile, mkdir, movefile.
* copyfile.m, mkdir.m, movefile.m: Add command forms to documentation.
| author | Rik <rik@octave.org> |
|---|---|
| date | Wed, 28 Mar 2018 13:12:01 -0700 |
| parents | 194eb4bd202b |
| children | 6652d3823428 |
line wrap: on
line diff
--- a/scripts/miscellaneous/movefile.m Wed Mar 28 13:11:00 2018 -0700 +++ b/scripts/miscellaneous/movefile.m Wed Mar 28 13:12:01 2018 -0700 @@ -17,16 +17,22 @@ ## <https://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {} {} movefile (@var{f1}) +## @deftypefn {} {} movefile @var{f1} +## @deftypefnx {} {} movefile @var{f1} @var{f2} +## @deftypefnx {} {} movefile @var{f1} @var{f2} f +## @deftypefnx {} {} movefile (@var{f1}) ## @deftypefnx {} {} movefile (@var{f1}, @var{f2}) ## @deftypefnx {} {} movefile (@var{f1}, @var{f2}, 'f') ## @deftypefnx {} {[@var{status}, @var{msg}, @var{msgid}] =} movefile (@dots{}) -## Move the source files or directories @var{f1} to the destination @var{f2}. +## Move the source file or directory @var{f1} to the destination @var{f2}. ## -## The name @var{f1} may contain globbing patterns. If @var{f1} expands to -## multiple filenames, @var{f2} must be a directory. If no destination -## @var{f2} is specified then the destination is the present working directory. -## If @var{f2} is a filename then @var{f1} is renamed to @var{f2}. +## The name @var{f1} may contain globbing patterns, or may be a cell array of +## strings. If @var{f1} expands to multiple filenames, @var{f2} must be a +## directory. +## +## If no destination @var{f2} is specified then the destination is the present +## working directory. If @var{f2} is a filename then @var{f1} is renamed to +## @var{f2}. ## ## When the force flag @qcode{'f'} is given any existing files will be ## overwritten without prompting.