Update README.md

README.md

@@ -2,7 +2,7 @@
 
 filefox: The fastest way to get from here to there.
 
-Version v1.3; (C) 2018 Alynna Trypnotk; GPL3
+Version v3.1; (C) 2018 Alynna Trypnotk; GPL3
 
 Sick of slow transfers using rsync or copying over the network?
 
@@ -11,43 +11,47 @@ Do you wish there was just a way to get your files from here to there?
 Try this.
 
 Features:
+* Defaults can be changed at the top of the script and overriden anytime with options.
 * Resumable file transfers (Will check what files are already present, or you can restart from scratch)
 * Fast file selection (Sends a list of what's already on the remote host and excludes them from the copy)
-* RSYNC based file selection (Will sync what rsync says needs to be synced, but do the sync in filefox.  Slowest to get started to copy.)
-* Progress readout while copying.
+* Progress readout while copying.  Shows both how much data is transferred and how much is going over the connection.
 * lzop -1 compression as default, fast enough to keep your network saturated.  Won't slow you down.
 * LZOP not doing it for you?  Swap the compressor with any other stream based compressor (must take data from stdin, send out stdout, and take the -d option to decompress.  Almost all compression programs do this.)
+* IPv6 friendly.
 * Sets up over SSH, copies over faster unencrypted socket.
+** OpenSSL encryption over the link can be enabled.  
 * Change sizes of blocks, buffers and timeouts, and save the defaults to the script.
-
-Bugs / Potential bugs:
-* "Fast" resume mode attempts to do no more than to check of the remote files existence.  You may want to use 'rsync' after to ensure all data made it there OK.
-* RSYNC based file selection may not work in all cases.  If it does not and you find a solution please present it.
+* Uses rsync to verify the transfer and 'catch it up' afterwords.
 ```
+filefox: The fastest way to get from here to there.
+Version 3.1 (C) 2018 Alynna Trypnotk; GPL3
  Syntax:
   filefox [options] <user@host> <local-dir> <remote-dir>
  Options:
   -n; --new             Start transfer fresh without finding out what files exist in the destination.
                         Best for starting a new transfer.
-  -f; --fast            Scan the destination for the existence of files only, does not compare times
-                        or file sizes.  (DEFAULT)
-  -r; --rsync           Uses rsync to determine which files should be copied, then copies them using
-                        filefox.  Can catch files that didn't transfer properly that --fast doesn't
-                        catch.
-  -r=<opts>
-  -rsync=<opts>         Adds additional options to rsync when doing an "rsync" bbased transfer.
-  --compressor="<prog>[ opts]"
-  -c="<prog>[ opts]"    Uses a different compressor than the default "lzop -1".
-                        This can be any stream based compressor on your system that uses the -d option
+  -r; --resume          (DEFAULT) Scan the destination for the existence of files and skip them.
+                        WARNING: does not compare times, file sizes, or file integrity.
+  -v; --verify          (DEFAULT) Check the copy with rsync after doing the copy.  This occurs at the
+                        end of the copy and is used with 'fast' to copy any files that changed and make
+                        sure that the copy is good.
+  -v0; --no-verify      Skip rsync verification check after copy.
+  -y; --encrypt         Pipe through OpenSSL encryption (Slower)
+  -y0; --no-encrypt     (DEFAULT) Do not encrypt (Fast)
+  --compressor="<prog>" Uses a different compressor than the default "lzop -1".
+  -c="<prog>"           This can be any stream based compressor on your system that uses the -d option
                         to specify decompression.
   -k; --privatekey      Do not ask for an SSH password at the beginning, assume private key present.
-  -w; --password        Ask for an ssh password and attempt to use it via SSHPASS.  (DEFAULT)
+  -w; --password        (DEFAULT) Ask for an ssh password and attempt to use it via SSHPASS.
   -q; --prerequisites   Install prerequisite programs.  Works on debian based systems.  For other
   -p=<port>             Connect on different port
   --port=<port>          Default port: 65432
+  -l=<bytespec>         Limit bandwidth to <bytes>, K M G T can be used
+  --limit=<bytespec>     Default limit: 0
   -s=<blocksize>        Set blocksize of TAR records and socat transfer size
   --blocksize=<port>     Default blocksize: 65536
   -b=<bufsize>          Total TCP buffer size
-  --buffer=<bufsize>     Default buffer size: 16777216
+  --buffer=<bufsize>     Default buffer size: 1048576
   -t=<secs>             Total inactivity tolerance
-  --timeout=<port>       Default inactivity tolerance: 60```
+  --timeout=<port>       Default inactivity tolerance: 60 
+```