Skip to content

Commit 7269b5f

Browse files
authored
Update README.md
Added more documetation.
1 parent 15ae245 commit 7269b5f

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,28 @@ This tool makes an AES encrypted backup of some folder directly in the cloud. Th
55
Even the Metadata like filenames are encrypted, so nobody will be able to see any information about the data you uploaded.
66

77
## usage
8+
### Windows
9+
Windows users can use the native exe version or the java implementation. The parameters are the same for all Versions.
10+
11+
### Linux
12+
Linux users can use the native version or the java implementation. The parameters are the same for all Versions.
13+
14+
### OSX
15+
OSX users can use the java implementation. The parameters are the same for all Versions.
16+
17+
### general call syntax
18+
```crypt2cloud [--backup | --restore | --list] --password PASSWORD --plaindir DIRECTORY --cryptdir DIRECTORY [--path SUBPATH]```
19+
20+
for tha java version use this
21+
22+
```java -jar crypt2cloud.jar [--backup | --restore | --list] --password PASSWORD --plaindir DIRECTORY --cryptdir DIRECTORY [--path SUBPATH]```
23+
24+
*--backup* will store plain files into the crypted directory.\
25+
*--restore* will restore plain files from the crypted directory.\
26+
*--list* will list the files stored in the crypted directory.\
27+
*--path* will limit the operation to only the given path. Useful to limit restore to single files or directories, or if you know, that backup only needs to be performed on some directories.
28+
29+
### examples
830
Make sure you have mounted your cloud folder. We asume you used */media/cloud* in this examples.
931

1032
To backup data in the folder */data/private* use this command.

0 commit comments

Comments
 (0)