Mercurial > octave
annotate scripts/@ftp/mget.m @ 30567:3eeaba530a03
doc: Add @seealso links to @ftp method functions.
* ascii.m, binary.m, cd.m, close.m, delete.m, dir.m, ftp.m, mget.m, mkdir.m,
mput.m, rename.m, rmdir.m: Add @seealso links to @ftp method functions.
author | Rik <rik@octave.org> |
---|---|
date | Wed, 29 Dec 2021 11:05:20 -0800 |
parents | 796f54d4ddbf |
children | 597f3ee61a48 |
rev | line source |
---|---|
27923
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
1 ######################################################################## |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
2 ## |
30564
796f54d4ddbf
update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents:
29358
diff
changeset
|
3 ## Copyright (C) 2009-2022 The Octave Project Developers |
27918
b442ec6dda5c
use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
4 ## |
27923
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
5 ## See the file COPYRIGHT.md in the top-level directory of this |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
6 ## distribution or <https://octave.org/copyright/>. |
9880 | 7 ## |
11104 | 8 ## This file is part of Octave. |
9880 | 9 ## |
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
10 ## Octave is free software: you can redistribute it and/or modify it |
11104 | 11 ## under the terms of the GNU General Public License as published by |
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
12 ## the Free Software Foundation, either version 3 of the License, or |
22755
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
13 ## (at your option) any later version. |
11104 | 14 ## |
15 ## Octave is distributed in the hope that it will be useful, but | |
16 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
22755
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
18 ## GNU General Public License for more details. |
9880 | 19 ## |
20 ## You should have received a copy of the GNU General Public License | |
11104 | 21 ## along with Octave; see the file COPYING. If not, see |
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
22 ## <https://www.gnu.org/licenses/>. |
27923
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
23 ## |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
24 ######################################################################## |
9880 | 25 |
26 ## -*- texinfo -*- | |
20852
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
20716
diff
changeset
|
27 ## @deftypefn {} {} mget (@var{f}, @var{file}) |
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
20716
diff
changeset
|
28 ## @deftypefnx {} {} mget (@var{f}, @var{dir}) |
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
20716
diff
changeset
|
29 ## @deftypefnx {} {} mget (@var{f}, @var{remote_name}, @var{target}) |
12575
d0b799dafede
Grammarcheck files for 3.4.1 release.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
30 ## Download a remote file @var{file} or directory @var{dir} to the local |
20174
d9341b422488
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
31 ## directory on the FTP connection @var{f}. |
d9341b422488
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
32 ## |
d9341b422488
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
33 ## @var{f} is an FTP object returned by the @code{ftp} function. |
9880 | 34 ## |
35 ## The arguments @var{file} and @var{dir} can include wildcards and any | |
36 ## files or directories on the remote server that match will be downloaded. | |
37 ## | |
20710
73800f39da6f
@ftp/mget: honor the TARGET argument
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
20174
diff
changeset
|
38 ## If a third string argument @var{target} is given, then it must indicate |
20716
1ecee53513d7
doc: Peridodic grammar check of documentation.
Rik <rik@octave.org>
parents:
20710
diff
changeset
|
39 ## the path to the local destination directory. @var{target} may be a |
20710
73800f39da6f
@ftp/mget: honor the TARGET argument
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
20174
diff
changeset
|
40 ## relative or absolute path. |
30567
3eeaba530a03
doc: Add @seealso links to @ftp method functions.
Rik <rik@octave.org>
parents:
30564
diff
changeset
|
41 ## @seealso{@ftp/mput, @ftp/ftp} |
9880 | 42 ## @end deftypefn |
43 | |
20710
73800f39da6f
@ftp/mget: honor the TARGET argument
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
20174
diff
changeset
|
44 function mget (f, file, target = "") |
73800f39da6f
@ftp/mget: honor the TARGET argument
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
20174
diff
changeset
|
45 __ftp_mget__ (f.curlhandle, file, target); |
9880 | 46 endfunction |
17338
1c89599167a6
maint: End m-files with 1 blank line.
Rik <rik@octave.org>
parents:
14217
diff
changeset
|
47 |
19307
0f70468a56cd
Remove interactive ftp functions from list of functions missing BIST tests.
Mike Sander <msander@cogeco.ca>
parents:
17744
diff
changeset
|
48 |
0f70468a56cd
Remove interactive ftp functions from list of functions missing BIST tests.
Mike Sander <msander@cogeco.ca>
parents:
17744
diff
changeset
|
49 ## No test possible for interactive function. |
0f70468a56cd
Remove interactive ftp functions from list of functions missing BIST tests.
Mike Sander <msander@cogeco.ca>
parents:
17744
diff
changeset
|
50 %!assert (1) |