1
0
mirror of https://github.com/gilbertchen/duplicacy synced 2025-12-06 00:03:38 +00:00

Compare commits

...

8 Commits

Author SHA1 Message Date
gilbertchen
78b164cdfb Update GUIDE.md 2017-04-24 21:21:08 -04:00
gilbertchen
6c3f4a6992 Update GUIDE.md 2017-04-24 21:20:10 -04:00
gilbertchen
8cb6635ba6 Update GUIDE.md 2017-03-22 10:06:23 -04:00
gilbertchen
ee56652c90 Update README.md 2017-03-20 23:03:10 -04:00
gilbertchen
cd7f18f284 Update GUIDE.md 2017-03-02 12:50:43 -05:00
gilbertchen
18766c86dc Merge pull request #42 from danthelion/patch-1
Fix include/exclude pattern description in GUIDE.md
2017-02-24 10:28:28 -05:00
Daniel Palma
f8d2671038 Fix include/exclude pattern description in GUIDE.md
Include/Exclude pattern prefixes have been switched up in the documentation. It could cause some confusion. :)
2017-02-24 10:45:03 +01:00
gilbertchen
1d12fa3dd8 Update GUIDE.md 2017-01-29 10:42:42 -05:00
2 changed files with 26 additions and 6 deletions

View File

@@ -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,6 +484,7 @@ 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 |

View File

@@ -231,7 +231,8 @@ The following table compares the feature lists of all these backup tools:
| Snapshot Migration | No | No | No | No | No | **Yes** |
##License
## License
Duplicacy CLI is free for personal use without restrictions.