aboutsummaryrefslogtreecommitdiffstats
path: root/lib/inets/doc/src/ftp_client.xml
diff options
context:
space:
mode:
authortmanevik <[email protected]>2015-07-03 09:34:23 +0200
committerIngela Anderton Andin <[email protected]>2015-09-01 14:39:38 +0200
commitc54168c72bb42f8ffb0e341fd56cd81a89b53430 (patch)
tree46ee3c434f5ae72c3f9a548d6c3d01e8011b4930 /lib/inets/doc/src/ftp_client.xml
parented9ad11c9e1a1681cae44c2c2b48bf70ea68ae43 (diff)
downloadotp-c54168c72bb42f8ffb0e341fd56cd81a89b53430.tar.gz
otp-c54168c72bb42f8ffb0e341fd56cd81a89b53430.tar.bz2
otp-c54168c72bb42f8ffb0e341fd56cd81a89b53430.zip
Inets User Guide
Editorial Changes
Diffstat (limited to 'lib/inets/doc/src/ftp_client.xml')
-rw-r--r--lib/inets/doc/src/ftp_client.xml53
1 files changed, 25 insertions, 28 deletions
diff --git a/lib/inets/doc/src/ftp_client.xml b/lib/inets/doc/src/ftp_client.xml
index 2f5b8abb5f..84fa064551 100644
--- a/lib/inets/doc/src/ftp_client.xml
+++ b/lib/inets/doc/src/ftp_client.xml
@@ -34,38 +34,27 @@
</header>
<section>
- <title>Introduction</title>
+ <title>Getting Started</title>
- <p>Ftp clients are consider to be rather temporary and are
- for that reason only started and stopped during
- runtime and can not be started at application startup.
- Due to the design of FTP client API, letting some
- functions return intermediate results, only the process
- that started the ftp client will be able to access it in
- order to preserve sane semantics. (This could be solved
- by changing the API and using the concept of a controlling
- process more in line with other OTP applications, but
- that is perhaps something for the future.)
- If the process that started the ftp session
- dies the ftp client process will terminate.</p>
+ <p>FTP clients are considered to be rather temporary. Thus,
+ they are only started and stopped during runtime and cannot
+ be started at application startup.
+ The FTP client API is designed to allow some functions to
+ return intermediate results. This implies that only the process
+ that started the FTP client can access it with
+ preserved sane semantics. (This can be solved
+ by changing the API, using the concept of a controlling
+ process as with other OTP applications, but
+ that is something for future releases of <c>Inets</c>.)
+ If the process that started the FTP session
+ dies, the FTP client process terminates.</p>
- <p>The client supports ipv6 as long as the underlying mechanisms
- also do so. </p>
+ <p>The client supports IPv6 as long as the underlying mechanisms
+ also do so.</p>
- </section>
-
- <section>
- <title>Using the FTP Client API</title>
- <p>The following is a simple example of an ftp session, where
+ <p>The following is a simple example of an FTP session, where
the user <c>guest</c> with password <c>password</c> logs on to
- the remote host <c>erlang.org</c>, and where the file
- <c>appl.erl</c> is transferred from the remote to the local
- host. When the session is opened, the current directory at
- the remote host is <c>/home/guest</c>, and <c>/home/fred</c>
- at the local host. Before transferring the file, the current
- local directory is changed to <c>/home/eproj/examples</c>, and
- the remote directory is set to
- <c>/home/guest/appl/examples</c>.</p>
+ the remote host <c>erlang.org</c>:</p>
<code type="erl"><![CDATA[
1> inets:start().
ok
@@ -86,6 +75,14 @@
9> inets:stop(ftpc, Pid).
ok
]]></code>
+ <p> The file
+ <c>appl.erl</c> is transferred from the remote to the local
+ host. When the session is opened, the current directory at
+ the remote host is <c>/home/guest</c>, and <c>/home/fred</c>
+ at the local host. Before transferring the file, the current
+ local directory is changed to <c>/home/eproj/examples</c>, and
+ the remote directory is set to
+ <c>/home/guest/appl/examples</c>.</p>
</section>
</chapter>