nuttx/Documentation
Swatantra Yadav a4b6b8b8bf Documentation/netutils: add comprehensive guide for ftpd
Provide a complete documentation guide for the ftpd (FTP server) network
utility in Documentation/applications/netutils/ftpd/index.rst, replacing
the previous 6-line placeholder stub.

Includes:
- Protocol architecture overview (control/data connection separation, multi-session worker pthreads, VFS mapping)
- Security considerations regarding unencrypted plaintext FTP credentials, mandatory credential hardening, home directory isolation, and encrypted password authentication
- Comprehensive supported RFC 959 / RFC 2428 / RFC 3659 FTP commands reference table
- Configuration options table and networking prerequisites (CONFIG_NETUTILS_FTPD, worker stack size, buffer sizes)
- NSH terminal usage (ftpd -4 / -6, ftpd_stop) with address-family flag requirements and configured account placeholders
- External client connection walkthroughs (FTP CLI, cURL) using configured account and anonymous workflows
- Public C API reference for types, account flags, and lifecycle functions (ftpd_open, ftpd_adduser, ftpd_session, ftpd_close)
- Complete, runnable C application example demonstrating multi-user server setup, signal-driven termination (SIGINT/SIGTERM) with atomic sig_atomic_t state, POSIX kill stop routine, and credential placeholders
- Embedded design and resource tuning guidelines (stack sizing, flash/SD card I/O buffering, and NAT passive mode)

Addresses #11081

Assisted-by: Google Gemini
Signed-off-by: Swatantra Yadav <maverickswatantra@gmail.com>
2026-10-09 12:08:21 +08:00
..
_extensions Documentation: brand new layout for NuttX documentation. 2026-10-08 01:40:54 +08:00
_static Documentation: brand new layout for NuttX documentation. 2026-10-08 01:40:54 +08:00
_templates Documentation: brand new layout for NuttX documentation. 2026-10-08 01:40:54 +08:00
about Documentation: brand new layout for NuttX documentation. 2026-10-08 01:40:54 +08:00
applications Documentation/netutils: add comprehensive guide for ftpd 2026-10-09 12:08:21 +08:00
components Documentation: brand new layout for NuttX documentation. 2026-10-08 01:40:54 +08:00
contributing Documentation: brand new layout for NuttX documentation. 2026-10-08 01:40:54 +08:00
debugging Documentation: brand new layout for NuttX documentation. 2026-10-08 01:40:54 +08:00
developing Documentation: brand new layout for NuttX documentation. 2026-10-08 01:40:54 +08:00
faq
guides arch/arm64: Implement up_addrenv_fork() and provide POSIX fork(). 2026-10-08 09:35:07 -03:00
implementation Documentation: brand new layout for NuttX documentation. 2026-10-08 01:40:54 +08:00
introduction Documentation: brand new layout for NuttX documentation. 2026-10-08 01:40:54 +08:00
logos
os Documentation/mtd: Update maximum capacity for W25 SPI NOR flashes. 2026-10-08 16:17:04 -03:00
platforms boards/nrf54l15-tag: add board support 2026-10-09 11:48:02 +08:00
quickstart Documentation: brand new layout for NuttX documentation. 2026-10-08 01:40:54 +08:00
reference Documentation: brand new layout for NuttX documentation. 2026-10-08 01:40:54 +08:00
ReleaseNotes Documentation: brand new layout for NuttX documentation. 2026-10-08 01:40:54 +08:00
standards docs/pthread: Document pthread_sigqueue 2026-09-21 14:53:26 +08:00
testing Documentation: brand new layout for NuttX documentation. 2026-10-08 01:40:54 +08:00
.gitignore
conf.py Documentation: brand new layout for NuttX documentation. 2026-10-08 01:40:54 +08:00
glossary.rst
index.rst Documentation: brand new layout for NuttX documentation. 2026-10-08 01:40:54 +08:00
known-warnings.txt
legacy_README.md Documentation: Point the buildroot links at the repository that still exists. 2026-09-13 18:29:40 -03:00
make.bat
Makefile
Pipfile Documentation: brand new layout for NuttX documentation. 2026-10-08 01:40:54 +08:00
Pipfile.lock Documentation: brand new layout for NuttX documentation. 2026-10-08 01:40:54 +08:00
redirects.py Documentation: brand new layout for NuttX documentation. 2026-10-08 01:40:54 +08:00
security.rst
substitutions.rst