From 13da1b8d2898976e6dace99d1b819297b1ce35d6 Mon Sep 17 00:00:00 2001 From: Nick Craig-Wood Date: Sat, 14 Nov 2015 11:38:35 +0000 Subject: [PATCH] Add docs for fs specific options - fixes #210 --- docs/content/drive.md | 23 +++++++++++++++++++++++ docs/content/dropbox.md | 10 ++++++++++ docs/content/onedrive.md | 15 +++++++++++++++ docs/content/swift.md | 10 ++++++++++ 4 files changed, 58 insertions(+) diff --git a/docs/content/drive.md b/docs/content/drive.md index 33642f58a..87ea0f234 100644 --- a/docs/content/drive.md +++ b/docs/content/drive.md @@ -104,6 +104,29 @@ By default rclone will delete files permanently when requested. If sending them to the trash is required instead then use the `--drive-use-trash` flag. +### Specific options ### + +Here are the command line options specific to this cloud storage +system. + +#### --drive-chunk-size=SIZE #### + +Upload chunk size. Must a power of 2 >= 256k. Default value is 256kB. + +#### --drive-full-list #### + +Use a full listing for directory list. More data but usually +quicker. On by default, disable with `--full-drive-list=false`. + +#### --drive-upload-cutoff=SIZE #### + +File size cutoff for switching to chunked upload. Default is 256kB. + +#### --drive-use-trash #### + +Send files to the trash instead of deleting permanently. Defaults to +off, namely deleting files permanently. + ### Limitations ### Drive has quite a lot of rate limiting. This causes rclone to be diff --git a/docs/content/dropbox.md b/docs/content/dropbox.md index 499967e07..e1f69591c 100644 --- a/docs/content/dropbox.md +++ b/docs/content/dropbox.md @@ -76,6 +76,16 @@ To copy a local directory to a dropbox directory called backup Dropbox doesn't have the capability of storing modification times or MD5SUMs so syncs will effectively have the `--size-only` flag set. +### Specific options ### + +Here are the command line options specific to this cloud storage +system. + +#### --dropbox-chunk-size=SIZE #### + +Upload chunk size. Max 150M. The default is 128MB. Note that this +isn't buffered into memory. + ### Limitations ### Note that Dropbox is case insensitive so you can't have a file called diff --git a/docs/content/onedrive.md b/docs/content/onedrive.md index e5d277e5a..c0d41790e 100644 --- a/docs/content/onedrive.md +++ b/docs/content/onedrive.md @@ -95,6 +95,21 @@ doesn't provide an API to permanently delete files, nor to empty the trash, so you will have to do that with one of Microsoft's apps or via the One Drive website. +### Specific options ### + +Here are the command line options specific to this cloud storage +system. + +#### --onedrive-chunk-size=SIZE #### + +Above this size files will be chunked - must be multiple of 320k. The +default is 10MB. Note that the chunks will be buffered into memory. + +#### --onedrive-upload-cutoff=SIZE #### + +Cutoff for switching to chunked upload - must be <= 100MB. The default +is 10MB. + ### Limitations ### Note that One Drive is case insensitive so you can't have a diff --git a/docs/content/swift.md b/docs/content/swift.md index 154f57262..50b9dd6ba 100644 --- a/docs/content/swift.md +++ b/docs/content/swift.md @@ -87,6 +87,16 @@ excess files in the container. rclone sync /home/local/directory remote:container +### Specific options ### + +Here are the command line options specific to this cloud storage +system. + +#### --swift-chunk-size=SIZE #### + +Above this size files will be chunked into a _segments container. The +default for this is 5GB which is its maximum value. + ### Modified time ### The modified time is stored as metadata on the object as