ftpiiu_plugin/README.md

ftpd
====

FTP Server for 3DS.

Features
--------

- Appears to work well with a variety of clients.
- Also compiles for Linux.
- Supports multiple simultaneous clients. The 3DS itself only appears to support enough sockets to perform 4-5 simultaneous data transfers, so it will help if you limit your FTP client to this many parallel requests.
- Cutting-edge graphics.

Latest Builds
-------------

CIA: https://mtheall.com/~mtheall/ftpd.cia

3DSX: https://mtheall.com/~mtheall/ftpd.3dsx

CIA QR Code

![ftpd.cia](https://github.com/mtheall/ftpd/raw/master/ftpd_qr.png)

Build and install
------------------

You must first install and set up [devkitARM and libctru](http://3dbrew.org/wiki/Setting_up_Development_Environment).
Clone this repository and cd in the resulting directory.

    make

Copy the `ftpd.3dsx` file to your SD card and launch it.

Supported Commands
------------------

- ABOR
- ALLO (no-op)
- APPE
- CDUP
- CWD
- DELE
- FEAT
- HELP
- LIST
- MDTM
- MKD
- MODE (no-op)
- NLST
- NOOP
- OPTS
- PASS (no-op)
- PASV
- PORT
- PWD
- QUIT
- REST
- RETR
- RMD
- RNFR
- RNTO
- STAT
- STOR
- STRU (no-op)
- SYST
- TYPE (no-op)
- USER (no-op)
- XCUP
- XCWD
- XMKD
- XPWD
- XRMD

Planned Commands
----------------

- STOU
Remove all brony branding 2016-01-26 06:46:52 +01:00			`ftpd`
			`====`
Create README.md 2014-11-26 08:44:02 +01:00
			`FTP Server for 3DS.`

			`Features`
			`--------`
Adjust whitespace in README.md 2016-06-15 05:41:24 +02:00
Create README.md 2014-11-26 08:44:02 +01:00			`- Appears to work well with a variety of clients.`
			`- Also compiles for Linux.`
v2.0 2016-01-16 01:04:09 +01:00			`- Supports multiple simultaneous clients. The 3DS itself only appears to support enough sockets to perform 4-5 simultaneous data transfers, so it will help if you limit your FTP client to this many parallel requests.`
Create README.md 2014-11-26 08:44:02 +01:00			`- Cutting-edge graphics.`

Add link to 3dsx build 2016-06-15 04:51:49 +02:00			`Latest Builds`
			`-------------`
Adjust whitespace in README.md 2016-06-15 05:41:24 +02:00
Add link to 3dsx build 2016-06-15 04:51:49 +02:00			`CIA: https://mtheall.com/~mtheall/ftpd.cia`
Adjust whitespace in README.md 2016-06-15 05:41:24 +02:00
Add link to 3dsx build 2016-06-15 04:51:49 +02:00			`3DSX: https://mtheall.com/~mtheall/ftpd.3dsx`

			`CIA QR Code`
Add QR to CIA build in README.md 2016-06-15 03:06:16 +02:00
			`![ftpd.cia](https://github.com/mtheall/ftpd/raw/master/ftpd_qr.png)`

Fixes #14 ; added some docs This added info fixes #14 and provides some info on how to build and install this software. 2014-12-21 17:48:10 +01:00			`Build and install`
			`------------------`

Fixed some errors Fixed some errors by mtheall request, 2014-12-21 19:23:19 +01:00			`You must first install and set up [devkitARM and libctru](http://3dbrew.org/wiki/Setting_up_Development_Environment).`
Fixes #14 ; added some docs This added info fixes #14 and provides some info on how to build and install this software. 2014-12-21 17:48:10 +01:00			`Clone this repository and cd in the resulting directory.`

Fixed some errors Fixed some errors by mtheall request, 2014-12-21 19:23:19 +01:00			`make`
Fixes #14 ; added some docs This added info fixes #14 and provides some info on how to build and install this software. 2014-12-21 17:48:10 +01:00
Remove all brony branding 2016-01-26 06:46:52 +01:00			Copy the `ftpd.3dsx` file to your SD card and launch it.
Fixed some errors Fixed some errors by mtheall request, 2014-12-21 19:23:19 +01:00
Create README.md 2014-11-26 08:44:02 +01:00			`Supported Commands`
			`------------------`

Remove coloring from linux build. Terminate loop when canceling waiting for wifi. Implement ABOR, HELP, and STAT. - STAT (no argument) during a transfer gives the current file's offset. - STAT (no argument) outside of transfer will return server uptime. - STAT (with argument) is the same as LIST but with the data traveling over the command socket. Allow ABOR, STAT, and QUIT to occur during transfer. Support telnet interrupt (discard data up to Data Mark past TCP urgent mark). Support arguments for LIST and STAT. Escape \r in response as per telnet standard. Some clients don't like this but they are out of spec. Unescape \r\0 in request as per telnet standard. Some clients don't properly escape this but they are out of spec. Support commands broken across multiple recv(). Escape quotes on PWD response. Added much more documentation. 2016-01-22 02:25:22 +01:00			`- ABOR`
			`- ALLO (no-op)`
Add APPE command 2016-01-16 00:28:59 +01:00			`- APPE`
Create README.md 2014-11-26 08:44:02 +01:00			`- CDUP`
			`- CWD`
			`- DELE`
Remove coloring from linux build. Terminate loop when canceling waiting for wifi. Implement ABOR, HELP, and STAT. - STAT (no argument) during a transfer gives the current file's offset. - STAT (no argument) outside of transfer will return server uptime. - STAT (with argument) is the same as LIST but with the data traveling over the command socket. Allow ABOR, STAT, and QUIT to occur during transfer. Support telnet interrupt (discard data up to Data Mark past TCP urgent mark). Support arguments for LIST and STAT. Escape \r in response as per telnet standard. Some clients don't like this but they are out of spec. Unescape \r\0 in request as per telnet standard. Some clients don't properly escape this but they are out of spec. Support commands broken across multiple recv(). Escape quotes on PWD response. Added much more documentation. 2016-01-22 02:25:22 +01:00			`- FEAT`
			`- HELP`
Create README.md 2014-11-26 08:44:02 +01:00			`- LIST`
Add a few missing commands to README 2016-01-23 01:57:33 +01:00			`- MDTM`
Create README.md 2014-11-26 08:44:02 +01:00			`- MKD`
			`- MODE (no-op)`
Add NLST command 2016-01-16 00:47:18 +01:00			`- NLST`
Create README.md 2014-11-26 08:44:02 +01:00			`- NOOP`
Add a few missing commands to README 2016-01-23 01:57:33 +01:00			`- OPTS`
Create README.md 2014-11-26 08:44:02 +01:00			`- PASS (no-op)`
			`- PASV`
			`- PORT`
			`- PWD`
			`- QUIT`
Add REST command 2016-01-19 00:46:03 +01:00			`- REST`
Create README.md 2014-11-26 08:44:02 +01:00			`- RETR`
			`- RMD`
			`- RNFR`
Remove coloring from linux build. Terminate loop when canceling waiting for wifi. Implement ABOR, HELP, and STAT. - STAT (no argument) during a transfer gives the current file's offset. - STAT (no argument) outside of transfer will return server uptime. - STAT (with argument) is the same as LIST but with the data traveling over the command socket. Allow ABOR, STAT, and QUIT to occur during transfer. Support telnet interrupt (discard data up to Data Mark past TCP urgent mark). Support arguments for LIST and STAT. Escape \r in response as per telnet standard. Some clients don't like this but they are out of spec. Unescape \r\0 in request as per telnet standard. Some clients don't properly escape this but they are out of spec. Support commands broken across multiple recv(). Escape quotes on PWD response. Added much more documentation. 2016-01-22 02:25:22 +01:00			`- RNTO`
			`- STAT`
Create README.md 2014-11-26 08:44:02 +01:00			`- STOR`
			`- STRU (no-op)`
			`- SYST`
			`- TYPE (no-op)`
			`- USER (no-op)`
			`- XCUP`
Add a few missing commands to README 2016-01-23 01:57:33 +01:00			`- XCWD`
Create README.md 2014-11-26 08:44:02 +01:00			`- XMKD`
			`- XPWD`
			`- XRMD`

			`Planned Commands`
			`----------------`

			`- STOU`