1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
|
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>FTP Objects (GNU Octave (version 10.3.0))</title>
<meta name="description" content="FTP Objects (GNU Octave (version 10.3.0))">
<meta name="keywords" content="FTP Objects (GNU Octave (version 10.3.0))">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Concept-Index.html" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Networking-Utilities.html" rel="up" title="Networking Utilities">
<link href="WWW-Access.html" rel="next" title="WWW Access">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
span:hover a.copiable-link {visibility: visible}
strong.def-name {font-family: monospace; font-weight: bold; font-size: larger}
-->
</style>
<link rel="stylesheet" type="text/css" href="octave.css">
</head>
<body lang="en">
<div class="subsection-level-extent" id="FTP-Objects">
<div class="nav-panel">
<p>
Next: <a href="WWW-Access.html" accesskey="n" rel="next">WWW Access</a>, Up: <a href="Networking-Utilities.html" accesskey="u" rel="up">Networking Utilities</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h4 class="subsection" id="FTP-Objects-1"><span>36.4.1 FTP Objects<a class="copiable-link" href="#FTP-Objects-1"> ¶</a></span></h4>
<p>Octave supports the FTP protocol through an object-oriented interface.
Use the function <code class="code">ftp</code> to create an FTP object which represents the
connection. All FTP functions take an FTP object as the first argument.
</p>
<a class="anchor" id="XREF_0040ftp_002fftp"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-ftp"><span><code class="def-type"><var class="var">f</var> =</code> <strong class="def-name">ftp</strong> <code class="def-code-arguments">(<var class="var">host</var>)</code><a class="copiable-link" href="#index-ftp"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-ftp-1"><span><code class="def-type"><var class="var">f</var> =</code> <strong class="def-name">ftp</strong> <code class="def-code-arguments">(<var class="var">host</var>, <var class="var">username</var>, <var class="var">password</var>)</code><a class="copiable-link" href="#index-ftp-1"> ¶</a></span></dt>
<dd><p>Connect to the FTP server <var class="var">host</var> with <var class="var">username</var> and <var class="var">password</var>.
</p>
<p>If <var class="var">username</var> and <var class="var">password</var> are not specified, user
<code class="code">"anonymous"</code> with no password is used. The returned FTP object
<var class="var">f</var> represents the established FTP connection.
</p>
<p>The list of actions for an FTP object are shown below. All functions
require an FTP object as the first argument.
</p>
<table class="multitable">
<thead><tr><th width="15%">Method</th><th width="80%">Description</th></tr></thead>
<tbody><tr><td width="15%">ascii</td><td width="80%">Set transfer type to ascii</td></tr>
<tr><td width="15%">binary</td><td width="80%">Set transfer type to binary</td></tr>
<tr><td width="15%">cd</td><td width="80%">Change remote working directory</td></tr>
<tr><td width="15%">close</td><td width="80%">Close FTP connection</td></tr>
<tr><td width="15%">delete</td><td width="80%">Delete remote file</td></tr>
<tr><td width="15%">dir</td><td width="80%">List remote directory contents</td></tr>
<tr><td width="15%">mget</td><td width="80%">Download remote files</td></tr>
<tr><td width="15%">mkdir</td><td width="80%">Create remote directory</td></tr>
<tr><td width="15%">mput</td><td width="80%">Upload local files</td></tr>
<tr><td width="15%">rename</td><td width="80%">Rename remote file or directory</td></tr>
<tr><td width="15%">rmdir</td><td width="80%">Remove remote directory</td></tr>
</tbody>
</table>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREF_0040ftp_002fascii">@ftp/ascii</a>, <a class="ref" href="#XREF_0040ftp_002fbinary">@ftp/binary</a>, <a class="ref" href="#XREF_0040ftp_002fcd">@ftp/cd</a>, <a class="ref" href="#XREF_0040ftp_002fclose">@ftp/close</a>, <a class="ref" href="#XREF_0040ftp_002fdelete">@ftp/delete</a>, <a class="ref" href="#XREF_0040ftp_002fdir">@ftp/dir</a>, <a class="ref" href="#XREF_0040ftp_002fmget">@ftp/mget</a>, <a class="ref" href="#XREF_0040ftp_002fmkdir">@ftp/mkdir</a>, <a class="ref" href="#XREF_0040ftp_002fmput">@ftp/mput</a>, <a class="ref" href="#XREF_0040ftp_002frename">@ftp/rename</a>, <a class="ref" href="#XREF_0040ftp_002frmdir">@ftp/rmdir</a>.
</p></dd></dl>
<a class="anchor" id="XREF_0040ftp_002fclose"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-close-7"><span><strong class="def-name">close</strong> <code class="def-code-arguments">(<var class="var">f</var>)</code><a class="copiable-link" href="#index-close-7"> ¶</a></span></dt>
<dd><p>Close the FTP connection represented by the FTP object <var class="var">f</var>.
</p>
<p><var class="var">f</var> is an FTP object returned by the <code class="code">ftp</code> function.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREF_0040ftp_002fftp">@ftp/ftp</a>.
</p></dd></dl>
<a class="anchor" id="XREF_0040ftp_002fmget"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-mget"><span><strong class="def-name">mget</strong> <code class="def-code-arguments">(<var class="var">f</var>, <var class="var">file</var>)</code><a class="copiable-link" href="#index-mget"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-mget-1"><span><strong class="def-name">mget</strong> <code class="def-code-arguments">(<var class="var">f</var>, <var class="var">dir</var>)</code><a class="copiable-link" href="#index-mget-1"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-mget-2"><span><strong class="def-name">mget</strong> <code class="def-code-arguments">(<var class="var">f</var>, <var class="var">remote_name</var>, <var class="var">target</var>)</code><a class="copiable-link" href="#index-mget-2"> ¶</a></span></dt>
<dd><p>Download a remote file <var class="var">file</var> or directory <var class="var">dir</var> to the local
directory on the FTP connection <var class="var">f</var>.
</p>
<p><var class="var">f</var> is an FTP object returned by the <code class="code">ftp</code> function.
</p>
<p>The arguments <var class="var">file</var> and <var class="var">dir</var> can include wildcards and any
files or directories on the remote server that match will be downloaded.
</p>
<p>If a third string argument <var class="var">target</var> is given, then it must indicate
the path to the local destination directory. <var class="var">target</var> may be a
relative or absolute path.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREF_0040ftp_002fmput">@ftp/mput</a>, <a class="ref" href="#XREF_0040ftp_002fftp">@ftp/ftp</a>.
</p></dd></dl>
<a class="anchor" id="XREF_0040ftp_002fmput"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-mput"><span><strong class="def-name">mput</strong> <code class="def-code-arguments">(<var class="var">f</var>, <var class="var">file</var>)</code><a class="copiable-link" href="#index-mput"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-mput-1"><span><code class="def-type"><var class="var">file_list</var> =</code> <strong class="def-name">mput</strong> <code class="def-code-arguments">(<var class="var">f</var>, <var class="var">file</var>)</code><a class="copiable-link" href="#index-mput-1"> ¶</a></span></dt>
<dd><p>Upload the local file <var class="var">file</var> into the current remote directory on the
FTP connection <var class="var">f</var>.
</p>
<p><var class="var">f</var> is an FTP object returned by the <code class="code">ftp</code> function.
</p>
<p>The argument <var class="var">file</var> is passed through the <code class="code">glob</code> function and any
files that match the wildcards in <var class="var">file</var> will be uploaded.
</p>
<p>The optional output argument <var class="var">file_list</var> contains a cell array of
strings with the names of the uploaded files.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREF_0040ftp_002fmget">@ftp/mget</a>, <a class="ref" href="#XREF_0040ftp_002fmkdir">@ftp/mkdir</a>, <a class="ref" href="#XREF_0040ftp_002fftp">@ftp/ftp</a>.
</p></dd></dl>
<a class="anchor" id="XREF_0040ftp_002fcd"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-cd"><span><code class="def-type"><var class="var">cwd</var> =</code> <strong class="def-name">cd</strong> <code class="def-code-arguments">(<var class="var">f</var>)</code><a class="copiable-link" href="#index-cd"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-cd-1"><span><strong class="def-name">cd</strong> <code class="def-code-arguments">(<var class="var">f</var>, <var class="var">path</var>)</code><a class="copiable-link" href="#index-cd-1"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-cd-2"><span><code class="def-type"><var class="var">new_cwd</var> =</code> <strong class="def-name">cd</strong> <code class="def-code-arguments">(<var class="var">f</var>, <var class="var">path</var>)</code><a class="copiable-link" href="#index-cd-2"> ¶</a></span></dt>
<dd><p>Get or set the remote directory on the FTP connection <var class="var">f</var>.
</p>
<p><var class="var">f</var> is an FTP object returned by the <code class="code">ftp</code> function.
</p>
<p>If <var class="var">path</var> is not specified, return the remote current working
directory. Otherwise, set the remote directory to <var class="var">path</var> and return
the new remote working directory.
</p>
<p>If the directory does not exist, an error message is printed and the
working directory is not changed.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREF_0040ftp_002fdir">@ftp/dir</a>, <a class="ref" href="#XREF_0040ftp_002fftp">@ftp/ftp</a>.
</p></dd></dl>
<a class="anchor" id="XREF_0040ftp_002fdir"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-dir"><span><strong class="def-name">dir</strong> <code class="def-code-arguments">(<var class="var">f</var>)</code><a class="copiable-link" href="#index-dir"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-dir-1"><span><code class="def-type"><var class="var">lst</var> =</code> <strong class="def-name">dir</strong> <code class="def-code-arguments">(<var class="var">f</var>)</code><a class="copiable-link" href="#index-dir-1"> ¶</a></span></dt>
<dd><p>List the current directory in verbose form for the FTP connection <var class="var">f</var>.
</p>
<p><var class="var">f</var> is an FTP object returned by the <code class="code">ftp</code> function.
</p>
<p>If the optional output <var class="var">lst</var> is requested return a struct array
with one entry per file with the fields <code class="code">name</code>, <code class="code">date</code>,
<code class="code">bytes</code>, <code class="code">isdir</code>, <code class="code">datenum</code>.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREF_0040ftp_002fcd">@ftp/cd</a>, <a class="ref" href="#XREF_0040ftp_002fmkdir">@ftp/mkdir</a>, <a class="ref" href="#XREF_0040ftp_002frmdir">@ftp/rmdir</a>, <a class="ref" href="#XREF_0040ftp_002fftp">@ftp/ftp</a>.
</p></dd></dl>
<a class="anchor" id="XREF_0040ftp_002fascii"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-ascii"><span><strong class="def-name">ascii</strong> <code class="def-code-arguments">(<var class="var">f</var>)</code><a class="copiable-link" href="#index-ascii"> ¶</a></span></dt>
<dd><p>Set the FTP connection <var class="var">f</var> to use ASCII mode for transfers.
</p>
<p>ASCII mode is only appropriate for text files as it will convert the
remote host’s newline representation to the local host’s newline
representation.
</p>
<p><var class="var">f</var> is an FTP object returned by the <code class="code">ftp</code> function.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREF_0040ftp_002fbinary">@ftp/binary</a>, <a class="ref" href="#XREF_0040ftp_002fftp">@ftp/ftp</a>.
</p></dd></dl>
<a class="anchor" id="XREF_0040ftp_002fbinary"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-binary"><span><strong class="def-name">binary</strong> <code class="def-code-arguments">(<var class="var">f</var>)</code><a class="copiable-link" href="#index-binary"> ¶</a></span></dt>
<dd><p>Set the FTP connection <var class="var">f</var> to use binary mode for transfers.
</p>
<p>In binary mode there is no conversion of newlines from the remote
representation to the local representation.
</p>
<p><var class="var">f</var> is an FTP object returned by the <code class="code">ftp</code> function.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREF_0040ftp_002fascii">@ftp/ascii</a>, <a class="ref" href="#XREF_0040ftp_002fftp">@ftp/ftp</a>.
</p></dd></dl>
<a class="anchor" id="XREF_0040ftp_002fdelete"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-delete-5"><span><strong class="def-name">delete</strong> <code class="def-code-arguments">(<var class="var">f</var>, <var class="var">file</var>)</code><a class="copiable-link" href="#index-delete-5"> ¶</a></span></dt>
<dd><p>Delete the remote file <var class="var">file</var> over the FTP connection <var class="var">f</var>.
</p>
<p><var class="var">f</var> is an FTP object returned by the <code class="code">ftp</code> function.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREF_0040ftp_002frmdir">@ftp/rmdir</a>, <a class="ref" href="#XREF_0040ftp_002frename">@ftp/rename</a>, <a class="ref" href="#XREF_0040ftp_002fftp">@ftp/ftp</a>.
</p></dd></dl>
<a class="anchor" id="XREF_0040ftp_002frename"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-rename-2"><span><strong class="def-name">rename</strong> <code class="def-code-arguments">(<var class="var">f</var>, <var class="var">oldname</var>, <var class="var">newname</var>)</code><a class="copiable-link" href="#index-rename-2"> ¶</a></span></dt>
<dd><p>Rename or move the remote file or directory <var class="var">oldname</var> to <var class="var">newname</var>,
over the FTP connection <var class="var">f</var>.
</p>
<p><var class="var">f</var> is an FTP object returned by the <code class="code">ftp</code> function.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREF_0040ftp_002fdelete">@ftp/delete</a>, <a class="ref" href="#XREF_0040ftp_002frmdir">@ftp/rmdir</a>, <a class="ref" href="#XREF_0040ftp_002fftp">@ftp/ftp</a>.
</p></dd></dl>
<a class="anchor" id="XREF_0040ftp_002fmkdir"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-mkdir-5"><span><strong class="def-name">mkdir</strong> <code class="def-code-arguments">(<var class="var">f</var>, <var class="var">path</var>)</code><a class="copiable-link" href="#index-mkdir-5"> ¶</a></span></dt>
<dd><p>Create the remote directory <var class="var">path</var>, over the FTP connection <var class="var">f</var>.
</p>
<p><var class="var">f</var> is an FTP object returned by the <code class="code">ftp</code> function.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREF_0040ftp_002frmdir">@ftp/rmdir</a>, <a class="ref" href="#XREF_0040ftp_002fftp">@ftp/ftp</a>.
</p></dd></dl>
<a class="anchor" id="XREF_0040ftp_002frmdir"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-rmdir-3"><span><strong class="def-name">rmdir</strong> <code class="def-code-arguments">(<var class="var">f</var>, <var class="var">path</var>)</code><a class="copiable-link" href="#index-rmdir-3"> ¶</a></span></dt>
<dd><p>Remove the remote directory <var class="var">path</var>, over the FTP connection <var class="var">f</var>.
</p>
<p><var class="var">f</var> is an FTP object returned by the <code class="code">ftp</code> function.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREF_0040ftp_002fdelete">@ftp/delete</a>, <a class="ref" href="#XREF_0040ftp_002fmkdir">@ftp/mkdir</a>, <a class="ref" href="#XREF_0040ftp_002frename">@ftp/rename</a>, <a class="ref" href="#XREF_0040ftp_002fftp">@ftp/ftp</a>.
</p></dd></dl>
</div>
<hr>
<div class="nav-panel">
<p>
Next: <a href="WWW-Access.html">WWW Access</a>, Up: <a href="Networking-Utilities.html">Networking Utilities</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>
|
