X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/071e02c6b6b4837fa9cf0b6d4c749994e02638d7..f3ec62b5c689d9c66b07a57df76ca83881ce3fe3:/Projects/Webserver/Webserver.txt diff --git a/Projects/Webserver/Webserver.txt b/Projects/Webserver/Webserver.txt index f20189c62..ddb06590a 100644 --- a/Projects/Webserver/Webserver.txt +++ b/Projects/Webserver/Webserver.txt @@ -3,16 +3,16 @@ * This file contains special DoxyGen information for the generation of the main page and other special * documentation pages. It is not a project source file. */ - + /** \mainpage uIP Powered Webserver Project * - * \section SSec_Compat Project Compatibility: + * \section Sec_Compat Project Compatibility: * * The following list indicates what microcontrollers are compatible with this project. * - * - Series 7 USB AVRs + * - Series 7 USB AVRs (AT90USBxxx7) * - * \section SSec_Info USB Information: + * \section Sec_Info USB Information: * * The following table gives a rundown of the USB utilization of this project. * @@ -26,7 +26,7 @@ * Communications Device Class (CDC) \n * Mass Storage Device * - * + * * USB Subclass: * Remote NDIS (Microsoft Proprietary CDC Class Networking Standard) \n * Bulk-Only Transport @@ -45,29 +45,29 @@ * * * - * \section SSec_Description Project Description: + * \section Sec_Description Project Description: * * Simple HTTP webserver project. This project combines the LUFA library with the uIP TCP/IP full network stack and FatFS - * library to create a RNDIS host capable of serving out HTTP webpages to multiple hosts simultaneously. This project + * library to create a RNDIS host capable of serving out HTTP web pages to multiple hosts simultaneously. This project * demonstrates how the libraries can be combined into a robust network enabled application, with the addition of a RNDIS * network device. * * To use this project, plug the USB AVR into a computer, so that it enumerates as a standard Mass Storage device. Load * HTML files onto the disk, so that they can be served out to clients -- the default file to serve should be called * index.htm. Filenames must be in 8.3 format for them to be retrieved correctly by the webserver, and the total - * requested file path must be equal to or less than the maximum URI length (\see \ref SSec_Options). + * requested file path must be equal to or less than the maximum URI length (\see \ref Sec_Options). * * When attached to a RNDIS class device, such as a USB (desktop) modem, the system will enumerate the device, set the * appropriate parameters needed for connectivity and begin listening for new HTTP connections on port 80 and TELNET * connections on port 23. The device IP, netmask and default gateway IP must be set to values appropriate for the RNDIS - * device being used for this project to work if the DHCP client is disabled (see \ref SSec_Options) - otherwise, the device + * device being used for this project to work if the DHCP client is disabled (see \ref Sec_Options) - otherwise, the device * will query the network's DHCP server for these parameters automatically. * - * When properly configured, the webserver can be accessed from any HTTP webrowser by typing in the device's statically or + * When properly configured, the webserver can be accessed from any HTTP web browser by typing in the device's statically or * dynamically allocated IP address. The TELNET client can be accessed via any network socket app by connecting to the device * on port 23 on the device's statically or dynamically allocated IP address. * - * \section SSec_Options Project Options + * \section Sec_Options Project Options * * The following defines can be found in this project, which can control the project behaviour when defined, or changed in value. * @@ -79,13 +79,13 @@ * * * ENABLE_TELNET_SERVER - * Makefile CDEFS - * When defined, this enables the TELNET server in addition to the HTTP webserver, which listens for incomming connections + * Makefile LUFA_OPTS + * When defined, this enables the TELNET server in addition to the HTTP webserver, which listens for incoming connections * and processes user commands. * * * ENABLE_DHCP_CLIENT - * Makefile CDEFS + * Makefile LUFA_OPTS * When defined, this enables the DHCP client for dynamic IP allocation of the network settings from a DHCP server. * * @@ -106,8 +106,9 @@ * * * MAX_URI_LENGTH - * Makefile CDEFS - * Maximum length of a URI for the Webserver. This is the maximum file path, including subdirectories and seperators. + * Makefile LUFA_OPTS + * Maximum length of a URI for the Webserver. This is the maximum file path, including subdirectories and separators. * * - */ \ No newline at end of file + */ +