From 5e08fcceb9f40d4d8213ae4794b5366088b62550 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?P=C3=A9ter=20Dimitrov?= Date: Tue, 27 Mar 2018 16:42:55 +0200 Subject: tftp: Improve documentation Change-Id: Ie23a40e7159fe632cf5514ac617de17c5d5b5ce2 --- lib/tftp/doc/src/tftp.xml | 46 +--------------------------------------------- 1 file changed, 1 insertion(+), 45 deletions(-) (limited to 'lib/tftp/doc/src/tftp.xml') 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 @@ tftp Trivial FTP. -

This is a complete implementation of the following IETF standards:

- - RFC 1350, The TFTP Protocol (revision 2) - RFC 2347, TFTP Option Extension - RFC 2348, TFTP Blocksize Option - RFC 2349, TFTP Timeout Interval and Transfer Size Options - -

The only feature that not is implemented is - the "netascii" transfer mode.

-

The start/1 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.

-

On the client side, - function read_file/3 - and write_file/3 - spawn a temporary client process establishing - contact with a TFTP daemon and perform the file transfer.

-

tftp uses a callback module to handle the file - transfer. Two such callback modules are provided, - tftp_binary and tftp_file. See - read_file/3 and - write_file/3 for details. - You can also implement your own callback modules, see - CALLBACK FUNCTIONS. - A callback module provided by - the user is registered using option callback, see - DATA TYPES.

+

Interface module for the tftp application.

- -
- TFTP SERVER SERVICE START/STOP - -

A TFTP server can be started dynamically - (when tftp is already started) by calling the tftp application - API tftp:start(ServiceConfig). - The ServiceConfig for TFTP is described in - the DATA TYPES - section.

- -

The TFTP server can be stopped using tftp:stop_service(Pid).

-

The TPFT client is of such a temporary nature that it is not - handled as a service in the tftp service framework.

- -
-
DATA TYPES -- cgit v1.2.3