aboutsummaryrefslogtreecommitdiffstats
path: root/lib/tftp/doc/src/tftp.xml
diff options
context:
space:
mode:
authorPéter Dimitrov <[email protected]>2018-03-27 16:42:55 +0200
committerPéter Dimitrov <[email protected]>2018-03-28 10:19:38 +0200
commit5e08fcceb9f40d4d8213ae4794b5366088b62550 (patch)
tree8620eaf6d5f2b035ccd780d84ec7e4506b7555f1 /lib/tftp/doc/src/tftp.xml
parent6fc2b7bf5eb331fdc1c0fb93758dad5a741da4fa (diff)
downloadotp-5e08fcceb9f40d4d8213ae4794b5366088b62550.tar.gz
otp-5e08fcceb9f40d4d8213ae4794b5366088b62550.tar.bz2
otp-5e08fcceb9f40d4d8213ae4794b5366088b62550.zip
tftp: Improve documentation
Change-Id: Ie23a40e7159fe632cf5514ac617de17c5d5b5ce2
Diffstat (limited to 'lib/tftp/doc/src/tftp.xml')
-rw-r--r--lib/tftp/doc/src/tftp.xml46
1 files changed, 1 insertions, 45 deletions
diff --git a/lib/tftp/doc/src/tftp.xml b/lib/tftp/doc/src/tftp.xml
index c4d6a4e6d0..481e5446ad 100644
--- a/lib/tftp/doc/src/tftp.xml
+++ b/lib/tftp/doc/src/tftp.xml
@@ -31,53 +31,9 @@
<module>tftp</module>
<modulesummary>Trivial FTP.</modulesummary>
<description>
- <p>This is a complete implementation of the following IETF standards:</p>
- <list type="bulleted">
- <item>RFC 1350, The TFTP Protocol (revision 2)</item>
- <item>RFC 2347, TFTP Option Extension</item>
- <item>RFC 2348, TFTP Blocksize Option</item>
- <item>RFC 2349, TFTP Timeout Interval and Transfer Size Options</item>
- </list>
- <p>The only feature that not is implemented is
- the "netascii" transfer mode.</p>
- <p>The <seealso marker="#start/1">start/1</seealso> function starts
- a daemon process listening for UDP packets on a port. When it
- receives a request for read or write, it spawns a temporary server
- process handling the transfer.</p>
- <p>On the client side,
- function <seealso marker="#read_file/3">read_file/3</seealso>
- and <seealso marker="#write_file/3">write_file/3</seealso>
- spawn a temporary client process establishing
- contact with a TFTP daemon and perform the file transfer.</p>
- <p><c>tftp</c> uses a callback module to handle the file
- transfer. Two such callback modules are provided,
- <c>tftp_binary</c> and <c>tftp_file</c>. See
- <seealso marker="#read_file/3">read_file/3</seealso> and
- <seealso marker="#write_file/3">write_file/3</seealso> for details.
- You can also implement your own callback modules, see
- <seealso marker="#tftp_callback">CALLBACK FUNCTIONS</seealso>.
- A callback module provided by
- the user is registered using option <c>callback</c>, see
- <seealso marker="#options">DATA TYPES</seealso>.</p>
+ <p>Interface module for the <c>tftp</c> application.</p>
</description>
-
- <section>
- <title>TFTP SERVER SERVICE START/STOP</title>
-
- <p>A TFTP server can be started dynamically
- (when <c>tftp</c> is already started) by calling the <c>tftp</c> application
- API <c>tftp:start(ServiceConfig)</c>.
- The <c>ServiceConfig</c> for TFTP is described in
- the <seealso marker="#options">DATA TYPES</seealso>
- section.</p>
-
- <p>The TFTP server can be stopped using <c>tftp:stop_service(Pid)</c>.</p>
- <p>The TPFT client is of such a temporary nature that it is not
- handled as a service in the <c>tftp</c> service framework.</p>
-
- </section>
-
<section>
<marker id="options"></marker>
<title>DATA TYPES</title>