diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 25 |
1 files changed, 12 insertions, 13 deletions
@@ -1,37 +1,39 @@ -RusTFTP -======= +# RusTFTP A client and server implementation of the Trivial File Transfer Protocol, written in Rust. [](https://crates.io/crates/rtftp) - Currently supported: + * RFC 1350 (TFTP revision 2) * RFC 2347 (Option Extension) * RFC 2348 (Blocksize Option) * RFC 2349 (Timeout Interval and Transfer Size Options) Non-standard options: + * blksize2: block size as a power of 2 * utimeout: timeout in microseconds - Use cargo to build the binaries (output dir is `target/release/`): -``` -$ cargo build --release + +```bash +cargo build --release ``` To directly download, compile and install the binaries: -``` -$ cargo install rtftp + +```bash +cargo install rtftp ``` +## Usage ### Client -``` +```bash $ ./rtftpc --help RusTFTP @@ -45,10 +47,9 @@ Options: -n, --netascii use netascii mode (instead of octet) ``` - ### Server -``` +```bash $ ./rtftpd --help RusTFTP @@ -64,7 +65,6 @@ Options: -t, --threads N number of worker threads (default: 2) ``` - ## Notes As the block number is two bytes long, the number of blocks is limited @@ -73,7 +73,6 @@ To support the transfer of files larger than 65535 blocks, it will wrap around after reaching the maximum and start at 0 again, which is not defined in the standard. - ## License This program is free software: you can redistribute it and/or modify |