Network discover utility from Max Holtzberg

git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@5137 42af7a65-404d-4744-a932-0658087f49c3

1 files changed, 22 insertions, 0 deletions

diff --git a/apps/examples/README.txt b/apps/examples/README.txt
index 52d7279da..0d327ebfb 100644
--- a/apps/examples/README.txt
+++ b/apps/examples/README.txt
@@ -275,6 +275,28 @@ examples/dhcpd
 
   CONFIGURED_APPS += uiplib
 
+examples/discover
+^^^^^^^^^^^^^^^^^
+
+  This example execises netutils/discover utility.  This example initializes
+  and starts the UDP discover daemon. This daemon is useful for discovering
+  devices in local networks, especially with DHCP configured devices.  It
+  listens for UDP broadcasts which also can include a device class so that
+  groups of devices can be discovered. It is also possible to address all
+  classes with a kind of broadcast discover.
+
+  This example will automatically be built as an NSH built-in if
+  CONFIG_NSH_BUILTIN_APPS is selected.  Otherwise, it will be a standalone
+  program with entry point "discover_main".
+
+  NuttX configuration settings:
+
+    CONFIG_EXAMPLE_DISCOVER_DHCPC - DHCP Client
+    CONFIG_EXAMPLE_DISCOVER_NOMAC - Use canned MAC address
+    CONFIG_EXAMPLE_DISCOVER_IPADDR - Target IP address
+    CONFIG_EXAMPLE_DISCOVER_DRIPADDR - Router IP address
+    CONFIG_EXAMPLE_DISCOVER_NETMASK - Network Mask
+
 examples/ftpc
 ^^^^^^^^^^^^^