Mercurial > octave
annotate scripts/@ftp/dir.m @ 32632:2e484f9f1f18 stable
maint: update Octave Project Developers copyright for the new year
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Fri, 22 Dec 2023 12:08:17 -0500 |
parents | 597f3ee61a48 |
children |
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 ## |
32632
2e484f9f1f18
maint: update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents:
31706
diff
changeset
|
3 ## Copyright (C) 2009-2024 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 -*- | |
30561
1c6e04afe50d
doc: improvements to documentation for classes in scripts/ dir.
Rik <rik@octave.org>
parents:
29358
diff
changeset
|
27 ## @deftypefn {} {} dir (@var{f}) |
1c6e04afe50d
doc: improvements to documentation for classes in scripts/ dir.
Rik <rik@octave.org>
parents:
29358
diff
changeset
|
28 ## @deftypefnx {} {@var{lst} =} dir (@var{f}) |
20174
d9341b422488
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
29 ## List the current directory in verbose form for the FTP connection @var{f}. |
14217
7912e682aa30
doc: Update docstrings for @ftp class.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
30 ## |
7912e682aa30
doc: Update docstrings for @ftp class.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
31 ## @var{f} is an FTP object returned by the @code{ftp} function. |
30561
1c6e04afe50d
doc: improvements to documentation for classes in scripts/ dir.
Rik <rik@octave.org>
parents:
29358
diff
changeset
|
32 ## |
1c6e04afe50d
doc: improvements to documentation for classes in scripts/ dir.
Rik <rik@octave.org>
parents:
29358
diff
changeset
|
33 ## If the optional output @var{lst} is requested return a struct array |
1c6e04afe50d
doc: improvements to documentation for classes in scripts/ dir.
Rik <rik@octave.org>
parents:
29358
diff
changeset
|
34 ## with one entry per file with the fields @code{name}, @code{date}, |
1c6e04afe50d
doc: improvements to documentation for classes in scripts/ dir.
Rik <rik@octave.org>
parents:
29358
diff
changeset
|
35 ## @code{bytes}, @code{isdir}, @code{datenum}. |
30567
3eeaba530a03
doc: Add @seealso links to @ftp method functions.
Rik <rik@octave.org>
parents:
30565
diff
changeset
|
36 ## @seealso{@ftp/cd, @ftp/mkdir, @ftp/rmdir, @ftp/ftp} |
9880 | 37 ## @end deftypefn |
38 | |
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11104
diff
changeset
|
39 function lst = dir (f) |
9880 | 40 if (nargout == 0) |
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11104
diff
changeset
|
41 __ftp_dir__ (f.curlhandle); |
9880 | 42 else |
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
11104
diff
changeset
|
43 lst = __ftp_dir__ (f.curlhandle); |
9880 | 44 endif |
45 endfunction | |
17338
1c89599167a6
maint: End m-files with 1 blank line.
Rik <rik@octave.org>
parents:
14217
diff
changeset
|
46 |
19307
0f70468a56cd
Remove interactive ftp functions from list of functions missing BIST tests.
Mike Sander <msander@cogeco.ca>
parents:
17744
diff
changeset
|
47 |
0f70468a56cd
Remove interactive ftp functions from list of functions missing BIST tests.
Mike Sander <msander@cogeco.ca>
parents:
17744
diff
changeset
|
48 ## 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
|
49 %!assert (1) |