ftpiiu_plugin/README.md

# ftpd

FTP Server for 3DS/Switch/Linux.

## Features

- Appears to work well with a variety of clients.
- 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-3ds.cia

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

NRO: https://mtheall.com/~mtheall/ftpd-nx.nro

CIA QR Code

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

## Build and install

You must set up the [development environment](https://devkitpro.org/wiki/Getting_Started).

### 3DSX

The following pacman packages are required to build `ftpd-3ds.3dsx`:

    3dstools
    devkitARM
    libctru

They are available as part of the `3ds-dev` meta-package.

Build `ftpd-3ds.3dsx`:

    make 3dsx

### NRO

The following pacman packages are required to build `ftpd-nx.nro`:

    devkitA64
    libnx
    switch-tools

They are available as part of the `switch-dev` meta-package.

Build `ftpd-nx.nro`:

    make nro

## Supported Commands

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

## Planned Commands

- STOU
Release ftpd v2.3 2018-09-24 15:45:27 +02:00			`# ftpd`
Create README.md 2014-11-26 08:44:02 +01:00
Release ftpd v2.3 2018-09-24 15:45:27 +02:00			`FTP Server for 3DS/Switch/Linux.`
Create README.md 2014-11-26 08:44:02 +01:00
Release ftpd v2.3 2018-09-24 15:45:27 +02:00			`## 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.`
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.`

Release ftpd v2.3 2018-09-24 15:45:27 +02:00			`## Latest Builds`
Adjust whitespace in README.md 2016-06-15 05:41:24 +02:00
v3.0.0-rc1 2020-04-05 21:16:16 +02:00			`CIA: https://mtheall.com/~mtheall/ftpd-3ds.cia`
Adjust whitespace in README.md 2016-06-15 05:41:24 +02:00
v3.0.0-rc1 2020-04-05 21:16:16 +02:00			`3DSX: https://mtheall.com/~mtheall/ftpd-3ds.3dsx`
Add link to 3dsx build 2016-06-15 04:51:49 +02:00
v3.0.0-rc1 2020-04-05 21:16:16 +02:00			`NRO: https://mtheall.com/~mtheall/ftpd-nx.nro`
Release ftpd v2.3 2018-09-24 15:45:27 +02:00
Add link to 3dsx build 2016-06-15 04:51:49 +02:00			`CIA QR Code`
Add QR to CIA build in README.md 2016-06-15 03:06:16 +02:00
v3.0.0-rc1 2020-04-05 21:16:16 +02:00			`![ftpd-3ds.cia](https://github.com/mtheall/ftpd/raw/master/ftpd_qr.png)`
Add QR to CIA build in README.md 2016-06-15 03:06:16 +02:00
Release ftpd v2.3 2018-09-24 15:45:27 +02:00			`## Build and install`

			`You must set up the [development environment](https://devkitpro.org/wiki/Getting_Started).`

			`### 3DSX`

v3.0.0-rc1 2020-04-05 21:16:16 +02:00			The following pacman packages are required to build `ftpd-3ds.3dsx`:
Release ftpd v2.3 2018-09-24 15:45:27 +02:00
			`3dstools`
			`devkitARM`
			`libctru`

			They are available as part of the `3ds-dev` meta-package.

v3.0.0-rc1 2020-04-05 21:16:16 +02:00			Build `ftpd-3ds.3dsx`:
Release ftpd v2.3 2018-09-24 15:45:27 +02:00
			`make 3dsx`

			`### NRO`

v3.0.0-rc1 2020-04-05 21:16:16 +02:00			The following pacman packages are required to build `ftpd-nx.nro`:
Release ftpd v2.3 2018-09-24 15:45:27 +02:00
			`devkitA64`
			`libnx`
			`switch-tools`
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
Release ftpd v2.3 2018-09-24 15:45:27 +02:00			They are available as part of the `switch-dev` meta-package.
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
v3.0.0-rc1 2020-04-05 21:16:16 +02:00			Build `ftpd-nx.nro`:
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
Release ftpd v2.3 2018-09-24 15:45:27 +02:00			`make nro`
Fixed some errors Fixed some errors by mtheall request, 2014-12-21 19:23:19 +01:00
Release ftpd v2.3 2018-09-24 15:45:27 +02:00			`## Supported Commands`
Create README.md 2014-11-26 08:44:02 +01:00
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`
Add MLSD and MLST commands 2017-11-02 06:47:18 +01:00			`- MLSD`
			`- MLST`
Create README.md 2014-11-26 08:44:02 +01:00			`- 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`
Add SIZE command to README.md 2016-06-22 05:26:51 +02:00			`- SIZE`
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			`- 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`

Release ftpd v2.3 2018-09-24 15:45:27 +02:00			`## Planned Commands`
Create README.md 2014-11-26 08:44:02 +01:00
			`- STOU`