Update GUIDE.md

Fix include/exclude pattern description in GUIDE.md

DESIGN.md

@@ -137,7 +137,7 @@ hasn't been found, the next file, if there is one, will be read in and the chunk
 files were packed into a big tar file which is then split into chunks.
 
 The *content* field of a file indicates the indexes of starting and ending chunks and the corresponding offsets. For
-instance, *fiel1* starts at chunk 0 offset 0 while ends at chunk 2 offset 6108, immediately followed by *file2*.
+instance, *file1* starts at chunk 0 offset 0 while ends at chunk 2 offset 6108, immediately followed by *file2*.
 
 The backup procedure can run in one of two modes. In the default quick mode, only modified or new files are scanned. Chunks only
 referenced by old files that have been modified are removed from the chunk sequence, and then chunks referenced by new 
@@ -210,6 +210,6 @@ Chunk content is encrypted by AES-GCM, with an encryption key that is the HMAC-S
 
 The snapshot is encrypted by AES-GCM too, using an encrypt key that is the HMAC-SHA256 of the file path with the *File Key* as the secret key.
 
-There four random keys are saved in a file named 'config' in the file storage, encrypted with a master key derived from the PBKDF2 function on
+These four random keys are saved in a file named 'config' in the storage, encrypted with a master key derived from the PBKDF2 function on
 the storage password chosen by the user.
 

GUIDE.md

@@ -51,6 +51,8 @@ OPTIONS:
    -hash                      detect file differences by hash (rather than size and timestamp)
    -t <tag>                   assign a tag to the backup
    -stats                     show statistics during and after backup
+   -threads <n>               number of uploading threads (Backblaze only)
+   -limit-rate <kB/s>         the maximum upload rate (in kilobytes/sec)   
    -vss                       enable the Volume Shadow Copy service (Windows only)
    -storage <storage name>    backup to the specified storage instead of the default one
 ```
@@ -61,9 +63,13 @@ Otherwise, every file is scanned to detect changes.
 
 You can assign a tag to the snapshot so that later you can refer to it by tag in other commands.
 
-If the -stats option is specified, statistical information such as transfer speed, number of chunks will be displayed
+If the -stats option is specified, statistical information such as transfer speed, the number of chunks will be displayed
 throughout the backup procedure.
 
+The -threads option can be used to specify more than one thread to upload chunks.  Currently this option is available only when the Backblaze B2 storage is selected.
+
+The -limit-rate option sets a cape on the maximum upload rate.
+
 The -vss option works on Windows only to turn on the Volume Shadow Copy service such that files opened by other
 processes with exclusive locks can be read as usual.
 
@@ -86,6 +92,7 @@ OPTIONS:
    -overwrite               overwrite existing files in the repository
    -delete                  delete files not in the snapshot
    -stats                   show statistics during and after restore
+   -limit-rate <kB/s>	    the maximum download rate (in kilobytes/sec)
    -storage <storage name>  restore from the specified storage instead of the default one
 ```
 
@@ -99,6 +106,8 @@ The -delete option indicates that files not in the snapshot will be removed.
 If the -stats option is specified, statistical information such as transfer speed, number of chunks will be displayed
 throughout the restore procedure.
 
+The -limit-rate option sets a cape on the maximum upload rate.
+
 When the repository can have multiple storages (added by the *add* command), you can select the storage to restore from by specifying the storage name.
 
 Unlike the *backup* procedure that reading the include/exclude patterns from a file, the *restore* procedure reads them
@@ -160,7 +169,7 @@ OPTIONS:
    -fossils                 search fossils if a chunk can't be found
    -resurrect               turn referenced fossils back into chunks
    -files                   verify the integrity of every file
-   -stats 			show deduplication statistics (imply -all and all revisions)
+   -stats                   show deduplication statistics (imply -all and all revisions)
    -storage <storage name>  retrieve snapshots from the specified storage```
 ```
 The *check* command checks, for each specified snapshot, that all referenced chunks exist in the storage.
@@ -398,7 +407,7 @@ OPTIONS:
    -no-restore[=true]       restore from this storage is prohibited
    -no-save-password[=true] don't save password or access keys to keychain/keyring
    -key                     add a key/password whose value is supplied by the -value option
-   -value  			          the value of the key/password
+   -value                   the value of the key/password
    -storage <storage name>  use the specified storage instead of the default one
 ```
 
@@ -444,16 +453,25 @@ destination storage and is required.
 
 ## Include/Exclude Patterns
 
-An include pattern starts with -, and an exclude pattern starts with +.  Patterns may contain wildcard characters such as * and ? with their normal meaning.
+An include pattern starts with +, and an exclude pattern starts with -.  Patterns may contain wildcard characters such as * and ? with their normal meaning.
 
 When matching a path against a list of patterns, the path is compared with the part after + or -, one pattern at a time.  Therefore, the order of the patterns is significant.  If a match with an include pattern is found, the path is said to be included without further comparisons.  If a match with an exclude pattern is found, the path is said to be excluded without further comparison.  If a match is not found, the path will be excluded if all patterns are include patterns, but included otherwise.
 
-Note that the path in Duplicacy for a directory always ends with a /, even on Windows.  The path of a file does not end with a /.  This can be used to exclude directories only.
+Patterns ending with a / apply to directories only, and patterns not ending with a / apply to files only.  When a directory is excluded, all files and subdirectires under it will also be excluded.  Note that the path separator is always /, even on Windows.
+
+The following pattern list includes only files under the directory foo/ but not files under the subdirectory foo/bar:
+
+```
+-foo/bar/
++foo/*
+-*
+```
 
 For the *backup* command, the include/exclude patterns are read from a file named *filters* under the *.duplicacy* directory.
 
 For the *restore* command, the include/exclude patterns are specified as the command line arguments.
 
+
 ## Managing Passwords
 
 Duplicacy will attempt to retrieve in three ways the storage password and the storage-specific access tokens/keys.
@@ -466,12 +484,16 @@ Duplicacy will attempt to retrieve in three ways the storage password and the st
 |:----------------:|:----------------:|:----------------:|:----------------:|
 | storage password | DUPLICACY_PASSWORD | DUPLICACY_&lt;STORAGENAME&gt;_PASSWORD | password |
 | sftp password | DUPLICACY_SSH_PASSWORD | DUPLICACY_&lt;STORAGENAME&gt;_SSH_PASSWORD | ssh_password |
+| sftp key file | DUPLICACY_SSH_KEY_FILE | DUPLICACY_&lt;STORAGENAME&gt;_SSH_KEY_FILE | ssh_keyfile |
 | Dropbox Token | DUPLICACY_DROPBOX_TOKEN | DUPLICACY_&lt;STORAGENAME>&gt;_DROPBOX_TOKEN | dropbox_token |
 | S3 Access ID | DUPLICACY_S3_ID | DUPLICACY_&lt;STORAGENAME&gt;_S3_ID | s3_id |
 | S3 Secret Key | DUPLICACY_S3_SECRET | DUPLICACY_&lt;STORAGENAME&gt;_S3_SECRET | s3_secret |
 | BackBlaze Account ID | DUPLICACY_B2_ID | DUPLICACY_&lt;STORAGENAME&gt;_B2_ID | b2_id |
 | Backblaze Application Key | DUPLICACY_B2_KEY | DUPLICACY_&lt;STORAGENAME&gt;_B2_KEY | b2_key |
 | Azure Access Key | DUPLICACY_AZURE_KEY | DUPLICACY_&lt;STORAGENAME&gt;_AZURE_KEY | azure_key |
+| Google Drive Token File | DUPLICACY_GCD_TOKEN | DUPLICACY_&lt;STORAGENAME&gt;_GCD_TOKEN | gcd_token |
+| Microsoft OneDrive Token File | DUPLICACY_ONE_TOKEN | DUPLICACY_&lt;STORAGENAME&gt;_ONE_TOKEN | one_token |
+| Hubic Token File | DUPLICACY_HUBIC_TOKEN | DUPLICACY_&lt;STORAGENAME&gt;_HUBIC_TOKEN | hubic_token |
 
 Note that the passwords stored in the environment variable and the preference need to be in plaintext and thus are insecure and should be avoided whenever possible.
 

README.md

@@ -1,12 +1,12 @@
-# Duplicacy: A new generation cloud backup tool
+# Duplicacy: A lock-free deduplication cloud backup tool
 
-Duplicacy is a new generation cross-platform cloud backup tool based on the idea of [Lock-Free Dedeuplication]([design document](https://github.com/gilbertchen/duplicacy-beta/blob/master/DESIGN.md)).  Duplicacy is the only backup tool capable of cross-computer deduplication which allows multiple computers to back up to the same storage simultaneously without using any locks (thus readily amenable to various cloud storage services).
+Duplicacy is a new generation cross-platform cloud backup tool based on the idea of [Lock-Free Deduplication](https://github.com/gilbertchen/duplicacy-beta/blob/master/DESIGN.md).  It is the only cloud backup tool that allows multiple computers to back up to the same storage simultaneously without using any locks (thus readily amenable to various cloud storage services).
 
-The repository hosts design documents as well as binary releases of the command line version.  There is also a Duplicacy GUI frontend built for Windows and Mac OS X downloadable from https://duplicacy.com.  The source code of the command line version is available to the commerical users of the Duplicacy GUI version upon request.
+The repository hosts design documents as well as binary releases of the command line version.  There is also a Duplicacy GUI frontend built for Windows and Mac OS X downloadable from https://duplicacy.com.  The source code of the command line version is available to the commercial users of the Duplicacy GUI version upon request.
 
 ## Features
 
-Duplicacy currently supports major cloud storage providers (Amazon S3, Google Cloud Storage, Microsoft Azure, Dropbox, and Backblaze) and offers all essential features of a modern backup tool:
+Duplicacy currently supports major cloud storage providers (Amazon S3, Google Cloud Storage, Microsoft Azure, Dropbox, Backblaze, Google Drive, Microsoft OneDrive, and Hubic) and offers all essential features of a modern backup tool:
 
 * Incremental backup: only back up what has been changed
 * Full snapshot : although each backup is incremental, it must behave like a full snapshot for easy restore and deletion
@@ -163,7 +163,37 @@ Storage URL: b2://bucket
 
 You'll need to input the account id and application key.
 
-Backblaze offers perhaps the least expensive cloud storage at 0.5 cent per GB per month.  Unfortunately their API does not support file renaming, so the -exclusive option is required when pruning old backups.  This means concurrent access and deletion can't be permitted at the same time.
+Backblaze's B2 storage is not only the least expensive (at 0.5 cent per GB per month), but also the fastest.  We have been working closely with their developers to leverage the full potentials provided by the B2 API in order to maximumize the transfer speed.  As a result, the B2 storage is the only one to support the multi-threading option which can easily max out your upload link.
+
+#### Google Drive
+
+```
+Storage URL: gcd://path/to/storage
+```
+
+To use Google Drive as the storage,  you first need to download a token file from https://duplicacy.com/gcd_start by
+authorizing Duplicacy to access your Google Drive, and then enter the path to this token file to Duplicacy when prompted.
+
+#### Microsoft OneDrive
+
+```
+Storage URL: one://path/to/storage
+```
+
+To use Microsoft OneDrive as the storage,  you first need to download a token file from https://duplicacy.com/one_start by
+authorizing Duplicacy to access your OneDrive, and then enter the path to this token file to Duplicacy when prompted.
+
+#### Hubic
+
+```
+Storage URL: hubic://path/to/storage
+```
+
+To use Hubic as the storage,  you first need to download a token file from https://duplicacy.com/hubic_start by
+authorizing Duplicacy to access your Hubic drive, and then enter the path to this token file to Duplicacy when prompted.
+
+Hubic offers the most free space (25GB) of all major cloud providers and there is no bandwidth charge (same as Google Drive and OneDrive), so it may be worth a try.
+
 
 ## Comparison with Other Backup Tools
 
@@ -197,10 +227,13 @@ The following table compares the feature lists of all these backup tools:
 | Encryption         | Yes       | Yes | Yes               | Yes             | Yes               | **Yes**       |
 | Deletion           | No        | No  | Yes               | Yes             | No                | **Yes**       |
 | Concurrent Access  | No        | No  | Exclusive locking | Not recommended | Exclusive locking | **Lock-free** |
-| Cloud Support      | Extensive | No  | No                | No              | S3 only           | **S3, GCS, Azure, Dropbox, Backblaze**|
+| Cloud Support      | Extensive | No  | No                | No              | S3 only           | **S3, GCS, Azure, Dropbox, Backblaze, Google Drive, OneDrive, and Hubic**|
 | Snapshot Migration | No        | No  | No                | No              | No                | **Yes**       |
 
 
-##License
 
-Duplicacy is free for personal use but any commercial use must be accompanied by a valid [subscription](https://duplicacy.com/buy.html).  This applies to both the CLI and GUI versions.
+## License
+
+Duplicacy CLI is free for personal use without restrictions.
+
+For commercial use, a valid [commercial license](https://duplicacy.com/buy.html) is required for each computer on which backups will be created.  There are no restrictions if Duplicacy CLI is used to restore files from backups or check the integrity of backups.