summaryrefslogtreecommitdiff
path: root/apps/examples/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'apps/examples/README.txt')
-rw-r--r--apps/examples/README.txt15
1 files changed, 15 insertions, 0 deletions
diff --git a/apps/examples/README.txt b/apps/examples/README.txt
index a8216be39..f14037e72 100644
--- a/apps/examples/README.txt
+++ b/apps/examples/README.txt
@@ -48,6 +48,21 @@ examples/dhcpd
CONFIGURED_APPS += uiplib
+examples/ftpc
+^^^^^^^^^^^^^
+
+ This is a simple FTP client shell used to exercise the capabilities
+ of the FTPC library (apps/netutils/ftpc). This example is configured
+ to that it will only work as a "built-in" program that can be run from
+ NSH when CONFIG_NSH_BUILTIN_APPS is defined.
+
+ From NSH, the startup command line is then:
+
+ ftpc xx.xx.xx.xx[:pp]
+
+ where xx.xx.xx.xx is the IP address of the FTP server and pp is an
+ optional port number.
+
examples/hello
^^^^^^^^^^^^^^