extern/rclone
1
0
Fork 0
mirror of https://github.com/rclone/rclone.git synced 2024-11-22 16:34:30 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: move documentation for options from docs/content into backends

Browse Source 
In the following commit, the documentation will be autogenerated.
This commit is contained in:
Nick Craig-Wood 2018-10-01 18:36:15 +01:00
parent 14128656db
commit a9273c5da5
42 changed files with 474 additions and 702 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
backend/amazonclouddrive/amazonclouddrive.go
View File

@ -97,13 +97,42 @@ func init() {
Hide: fs.OptionHideBoth, Hide: fs.OptionHideBoth,
Advanced: true, Advanced: true,
}, { }, {
Name: "upload_wait_per_gb", Name: "upload_wait_per_gb",
Help: "Additional time per GB to wait after a failed complete upload to see if it appears.", Help: `Additional time per GB to wait after a failed complete upload to see if it appears.
Sometimes Amazon Drive gives an error when a file has been fully
uploaded but the file appears anyway after a little while. This
happens sometimes for files over 1GB in size and nearly every time for
files bigger than 10GB. This parameter controls the time rclone waits
for the file to appear.
The default value for this parameter is 3 minutes per GB, so by
default it will wait 3 minutes for every GB uploaded to see if the
file appears.
You can disable this feature by setting it to 0. This may cause
conflict errors as rclone retries the failed upload but the file will
most likely appear correctly eventually.
These values were determined empirically by observing lots of uploads
of big files for a range of file sizes.
Upload with the "-v" flag to see more info about what rclone is doing
in this situation.`,
Default: fs.Duration(180 * time.Second), Default: fs.Duration(180 * time.Second),
Advanced: true, Advanced: true,
}, { }, {
Name: "templink_threshold", Name: "templink_threshold",
Help: "Files >= this size will be downloaded via their tempLink.", Help: `Files >= this size will be downloaded via their tempLink.
Files this size or more will be downloaded via their "tempLink". This
is to work around a problem with Amazon Drive which blocks downloads
of files bigger than about 10GB. The default for this is 9GB which
shouldn't need to be changed.
To download files above this threshold, rclone requests a "tempLink"
which downloads the file through a temporary URL directly from the
underlying S3 storage.`,
Default: defaultTempLinkThreshold, Default: defaultTempLinkThreshold,
Advanced: true, Advanced: true,
}}, }},

35
backend/azureblob/azureblob.go
View File

@ -73,23 +73,44 @@ func init() {
Advanced: true, Advanced: true,
}, { }, {
Name: "upload_cutoff", Name: "upload_cutoff",
Help: "Cutoff for switching to chunked upload.", Help: "Cutoff for switching to chunked upload (<= 256MB).",
Default: fs.SizeSuffix(defaultUploadCutoff), Default: fs.SizeSuffix(defaultUploadCutoff),
Advanced: true, Advanced: true,
}, { }, {
Name: "chunk_size", Name: "chunk_size",
Help: "Upload chunk size. Must fit in memory.", Help: `Upload chunk size (<= 100MB).
Note that this is stored in memory and there may be up to
"--transfers" chunks stored at once in memory.`,
Default: fs.SizeSuffix(defaultChunkSize), Default: fs.SizeSuffix(defaultChunkSize),
Advanced: true, Advanced: true,
}, { }, {
Name: "list_chunk", Name: "list_chunk",
Help: "Size of blob list.", Help: `Size of blob list.
This sets the number of blobs requested in each listing chunk. Default
is the maximum, 5000. "List blobs" requests are permitted 2 minutes
per megabyte to complete. If an operation is taking longer than 2
minutes per megabyte on average, it will time out (
[source](https://docs.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-blob-service-operations#exceptions-to-default-timeout-interval)
). This can be used to limit the number of blobs items to return, to
avoid the time out.`,
Default: maxListChunkSize, Default: maxListChunkSize,
Advanced: true, Advanced: true,
}, { }, {
Name: "access_tier", Name: "access_tier",
Help: "Access tier of blob, supports hot, cool and archive tiers.\nArchived blobs can be restored by setting access tier to hot or cool." + Help: `Access tier of blob: hot, cool or archive.
" Leave blank if you intend to use default access tier, which is set at account level",
Archived blobs can be restored by setting access tier to hot or
cool. Leave blank if you intend to use default access tier, which is
set at account level
If there is no "access tier" specified, rclone doesn't apply any tier.
rclone performs "Set Tier" operation on blobs while uploading, if objects
are not modified, specifying "access tier" to new one will have no effect.
If blobs are in "archive tier" at remote, trying to perform data transfer
operations from remote will not be allowed. User should first restore by
tiering blob to "Hot" or "Cool".`,
Advanced: true, Advanced: true,
}}, }},
}) })

33
backend/b2/b2.go
View File

@ -77,14 +77,24 @@ func init() {
Help: "Endpoint for the service.\nLeave blank normally.", Help: "Endpoint for the service.\nLeave blank normally.",
Advanced: true, Advanced: true,
}, { }, {
Name: "test_mode", Name: "test_mode",
Help: "A flag string for X-Bz-Test-Mode header for debugging.", Help: `A flag string for X-Bz-Test-Mode header for debugging.
This is for debugging purposes only. Setting it to one of the strings
below will cause b2 to return specific errors:
* "fail_some_uploads"
* "expire_some_account_authorization_tokens"
* "force_cap_exceeded"
These will be set in the "X-Bz-Test-Mode" header which is documented
in the [b2 integrations checklist](https://www.backblaze.com/b2/docs/integration_checklist.html).`,
Default: "", Default: "",
Hide: fs.OptionHideConfigurator, Hide: fs.OptionHideConfigurator,
Advanced: true, Advanced: true,
}, { }, {
Name: "versions", Name: "versions",
Help: "Include old versions in directory listings.", Help: "Include old versions in directory listings.\nNote that when using this no file write operations are permitted,\nso you can't upload files or delete them.",
Default: false, Default: false,
Advanced: true, Advanced: true,
}, { }, {
@ -92,13 +102,22 @@ func init() {
Help: "Permanently delete files on remote removal, otherwise hide files.", Help: "Permanently delete files on remote removal, otherwise hide files.",
Default: false, Default: false,
}, { }, {
Name: "upload_cutoff", Name: "upload_cutoff",
Help: "Cutoff for switching to chunked upload.", Help: `Cutoff for switching to chunked upload.
Files above this size will be uploaded in chunks of "--b2-chunk-size".
This value should be set no larger than 4.657GiB (== 5GB).`,
Default: fs.SizeSuffix(defaultUploadCutoff), Default: fs.SizeSuffix(defaultUploadCutoff),
Advanced: true, Advanced: true,
}, { }, {
Name: "chunk_size", Name: "chunk_size",
Help: "Upload chunk size. Must fit in memory.", Help: `Upload chunk size. Must fit in memory.
When uploading large files, chunk the file into this size. Note that
these chunks are buffered in memory and there might a maximum of
"--transfers" chunks in progress at once. 5,000,000 Bytes is the
minimim size.`,
Default: fs.SizeSuffix(defaultChunkSize), Default: fs.SizeSuffix(defaultChunkSize),
Advanced: true, Advanced: true,
}}, }},

2
backend/box/box.go
View File

@ -85,7 +85,7 @@ func init() {
Help: "Box App Client Secret\nLeave blank normally.", Help: "Box App Client Secret\nLeave blank normally.",
}, { }, {
Name: "upload_cutoff", Name: "upload_cutoff",
Help: "Cutoff for switching to multipart upload.", Help: "Cutoff for switching to multipart upload (>= 50MB).",
Default: fs.SizeSuffix(defaultUploadCutoff), Default: fs.SizeSuffix(defaultUploadCutoff),
Advanced: true, Advanced: true,
}, { }, {

165
backend/cache/cache.go vendored
View File

@ -87,8 +87,12 @@ func init() {
Help: "Skip all certificate verifications when connecting to the Plex server", Help: "Skip all certificate verifications when connecting to the Plex server",
Advanced: true, Advanced: true,
}, { }, {
Name: "chunk_size", Name: "chunk_size",
Help: "The size of a chunk. Lower value good for slow connections but can affect seamless reading.", Help: `The size of a chunk (partial file data).
Use lower numbers for slower connections. If the chunk size is
changed, any downloaded chunks will be invalid and cache-chunk-path
will need to be cleared or unexpected EOF errors will occur.`,
Default: DefCacheChunkSize, Default: DefCacheChunkSize,
Examples: []fs.OptionExample{{ Examples: []fs.OptionExample{{
Value: "1m", Value: "1m",
@ -101,8 +105,10 @@ func init() {
Help: "10 MB", Help: "10 MB",
}}, }},
}, { }, {
Name: "info_age", Name: "info_age",
Help: "How much time should object info (file size, file hashes etc) be stored in cache.\nUse a very high value if you don't plan on changing the source FS from outside the cache.\nAccepted units are: \"s\", \"m\", \"h\".", Help: `How long to cache file structure information (directory listings, file size, times etc).
If all write operations are done through the cache then you can safely make
this value very large as the cache store will also be updated in real time.`,
Default: DefCacheInfoAge, Default: DefCacheInfoAge,
Examples: []fs.OptionExample{{ Examples: []fs.OptionExample{{
Value: "1h", Value: "1h",
@ -115,8 +121,11 @@ func init() {
Help: "48 hours", Help: "48 hours",
}}, }},
}, { }, {
Name: "chunk_total_size", Name: "chunk_total_size",
Help: "The maximum size of stored chunks. When the storage grows beyond this size, the oldest chunks will be deleted.", Help: `The total size that the chunks can take up on the local disk.
If the cache exceeds this value then it will start to delete the
oldest chunks until it goes under this value.`,
Default: DefCacheTotalChunkSize, Default: DefCacheTotalChunkSize,
Examples: []fs.OptionExample{{ Examples: []fs.OptionExample{{
Value: "500M", Value: "500M",
@ -131,63 +140,143 @@ func init() {
}, { }, {
Name: "db_path", Name: "db_path",
Default: filepath.Join(config.CacheDir, "cache-backend"), Default: filepath.Join(config.CacheDir, "cache-backend"),
Help: "Directory to cache DB", Help: "Directory to store file structure metadata DB.\nThe remote name is used as the DB file name.",
Advanced: true, Advanced: true,
}, { }, {
Name: "chunk_path", Name: "chunk_path",
Default: filepath.Join(config.CacheDir, "cache-backend"), Default: filepath.Join(config.CacheDir, "cache-backend"),
Help: "Directory to cache chunk files", Help: `Directory to cache chunk files.
Path to where partial file data (chunks) are stored locally. The remote
name is appended to the final path.
This config follows the "--cache-db-path". If you specify a custom
location for "--cache-db-path" and don't specify one for "--cache-chunk-path"
then "--cache-chunk-path" will use the same path as "--cache-db-path".`,
Advanced: true, Advanced: true,
}, { }, {
Name: "db_purge", Name: "db_purge",
Default: false, Default: false,
Help: "Purge the cache DB before", Help: "Clear all the cached data for this remote on start.",
Hide: fs.OptionHideConfigurator, Hide: fs.OptionHideConfigurator,
Advanced: true, Advanced: true,
}, { }, {
Name: "chunk_clean_interval", Name: "chunk_clean_interval",
Default: DefCacheChunkCleanInterval, Default: DefCacheChunkCleanInterval,
Help: "Interval at which chunk cleanup runs", Help: `How often should the cache perform cleanups of the chunk storage.
The default value should be ok for most people. If you find that the
cache goes over "cache-chunk-total-size" too often then try to lower
this value to force it to perform cleanups more often.`,
Advanced: true, Advanced: true,
}, { }, {
Name: "read_retries", Name: "read_retries",
Default: DefCacheReadRetries, Default: DefCacheReadRetries,
Help: "How many times to retry a read from a cache storage", Help: `How many times to retry a read from a cache storage.
Since reading from a cache stream is independent from downloading file
data, readers can get to a point where there's no more data in the
cache. Most of the times this can indicate a connectivity issue if
cache isn't able to provide file data anymore.
For really slow connections, increase this to a point where the stream is
able to provide data but your experience will be very stuttering.`,
Advanced: true, Advanced: true,
}, { }, {
Name: "workers", Name: "workers",
Default: DefCacheTotalWorkers, Default: DefCacheTotalWorkers,
Help: "How many workers should run in parallel to download chunks", Help: `How many workers should run in parallel to download chunks.
Higher values will mean more parallel processing (better CPU needed)
and more concurrent requests on the cloud provider. This impacts
several aspects like the cloud provider API limits, more stress on the
hardware that rclone runs on but it also means that streams will be
more fluid and data will be available much more faster to readers.
**Note**: If the optional Plex integration is enabled then this
setting will adapt to the type of reading performed and the value
specified here will be used as a maximum number of workers to use.`,
Advanced: true, Advanced: true,
}, { }, {
Name: "chunk_no_memory", Name: "chunk_no_memory",
Default: DefCacheChunkNoMemory, Default: DefCacheChunkNoMemory,
Help: "Disable the in-memory cache for storing chunks during streaming", Help: `Disable the in-memory cache for storing chunks during streaming.
By default, cache will keep file data during streaming in RAM as well
to provide it to readers as fast as possible.
This transient data is evicted as soon as it is read and the number of
chunks stored doesn't exceed the number of workers. However, depending
on other settings like "cache-chunk-size" and "cache-workers" this footprint
can increase if there are parallel streams too (multiple files being read
at the same time).
If the hardware permits it, use this feature to provide an overall better
performance during streaming but it can also be disabled if RAM is not
available on the local machine.`,
Advanced: true, Advanced: true,
}, { }, {
Name: "rps", Name: "rps",
Default: int(DefCacheRps), Default: int(DefCacheRps),
Help: "Limits the number of requests per second to the source FS. -1 disables the rate limiter", Help: `Limits the number of requests per second to the source FS (-1 to disable)
This setting places a hard limit on the number of requests per second
that cache will be doing to the cloud provider remote and try to
respect that value by setting waits between reads.
If you find that you're getting banned or limited on the cloud
provider through cache and know that a smaller number of requests per
second will allow you to work with it then you can use this setting
for that.
A good balance of all the other settings should make this setting
useless but it is available to set for more special cases.
**NOTE**: This will limit the number of requests during streams but
other API calls to the cloud provider like directory listings will
still pass.`,
Advanced: true, Advanced: true,
}, { }, {
Name: "writes", Name: "writes",
Default: DefCacheWrites, Default: DefCacheWrites,
Help: "Will cache file data on writes through the FS", Help: `Cache file data on writes through the FS
If you need to read files immediately after you upload them through
cache you can enable this flag to have their data stored in the
cache store at the same time during upload.`,
Advanced: true, Advanced: true,
}, { }, {
Name: "tmp_upload_path", Name: "tmp_upload_path",
Default: "", Default: "",
Help: "Directory to keep temporary files until they are uploaded to the cloud storage", Help: `Directory to keep temporary files until they are uploaded.
This is the path where cache will use as a temporary storage for new
files that need to be uploaded to the cloud provider.
Specifying a value will enable this feature. Without it, it is
completely disabled and files will be uploaded directly to the cloud
provider`,
Advanced: true, Advanced: true,
}, { }, {
Name: "tmp_wait_time", Name: "tmp_wait_time",
Default: DefCacheTmpWaitTime, Default: DefCacheTmpWaitTime,
Help: "How long should files be stored in local cache before being uploaded", Help: `How long should files be stored in local cache before being uploaded
This is the duration that a file must wait in the temporary location
_cache-tmp-upload-path_ before it is selected for upload.
Note that only one file is uploaded at a time and it can take longer
to start the upload if a queue formed for this purpose.`,
Advanced: true, Advanced: true,
}, { }, {
Name: "db_wait_time", Name: "db_wait_time",
Default: DefCacheDbWaitTime, Default: DefCacheDbWaitTime,
Help: "How long to wait for the DB to be available - 0 is unlimited", Help: `How long to wait for the DB to be available - 0 is unlimited
Only one process can have the DB open at any one time, so rclone waits
for this duration for the DB to become available before it gives an
error.
If you set it to 0 then it will wait forever.`,
Advanced: true, Advanced: true,
}}, }},
}) })

12
backend/crypt/crypt.go
View File

@ -67,8 +67,16 @@ func init() {
Help: "Password or pass phrase for salt. Optional but recommended.\nShould be different to the previous password.", Help: "Password or pass phrase for salt. Optional but recommended.\nShould be different to the previous password.",
IsPassword: true, IsPassword: true,
}, { }, {
Name: "show_mapping", Name: "show_mapping",
Help: "For all files listed show how the names encrypt.", Help: `For all files listed show how the names encrypt.
If this flag is set then for each file that the remote is asked to
list, it will log (at level INFO) a line stating the decrypted file
name and the encrypted file name.
This is so you can work out which encrypted names are which decrypted
names just in case you need to do something with the encrypted file
names, or for debugging purposes.`,
Default: false, Default: false,
Hide: fs.OptionHideConfigurator, Hide: fs.OptionHideConfigurator,
Advanced: true, Advanced: true,

81
backend/drive/drive.go
View File

@ -207,22 +207,29 @@ func init() {
}, { }, {
Name: "use_trash", Name: "use_trash",
Default: true, Default: true,
Help: "Send files to the trash instead of deleting permanently.", Help: "Send files to the trash instead of deleting permanently.\nDefaults to true, namely sending files to the trash.\nUse `--drive-use-trash=false` to delete files permanently instead.",
Advanced: true, Advanced: true,
}, { }, {
Name: "skip_gdocs", Name: "skip_gdocs",
Default: false, Default: false,
Help: "Skip google documents in all listings.", Help: "Skip google documents in all listings.\nIf given, gdocs practically become invisible to rclone.",
Advanced: true, Advanced: true,
}, { }, {
Name: "shared_with_me", Name: "shared_with_me",
Default: false, Default: false,
Help: "Only show files that are shared with me", Help: `Only show files that are shared with me.
Instructs rclone to operate on your "Shared with me" folder (where
Google Drive lets you access the files and folders others have shared
with you).
This works both with the "list" (lsd, lsl, etc) and the "copy"
commands (copy, sync, etc), and with all other commands too.`,
Advanced: true, Advanced: true,
}, { }, {
Name: "trashed_only", Name: "trashed_only",
Default: false, Default: false,
Help: "Only show files that are in the trash", Help: "Only show files that are in the trash.\nThis will show trashed files in their original directory structure.",
Advanced: true, Advanced: true,
}, { }, {
Name: "formats", Name: "formats",
@ -246,9 +253,25 @@ func init() {
Help: "Allow the filetype to change when uploading Google docs (e.g. file.doc to file.docx). This will confuse sync and reupload every time.", Help: "Allow the filetype to change when uploading Google docs (e.g. file.doc to file.docx). This will confuse sync and reupload every time.",
Advanced: true, Advanced: true,
}, { }, {
Name: "use_created_date", Name: "use_created_date",
Default: false, Default: false,
Help: "Use created date instead of modified date.", Help: `Use file created date instead of modified date.,
Useful when downloading data and you want the creation date used in
place of the last modified date.
**WARNING**: This flag may have some unexpected consequences.
When uploading to your drive all files will be overwritten unless they
haven't been modified since their creation. And the inverse will occur
while downloading. This side effect can be avoided by using the
"--checksum" flag.
This feature was implemented to retain photos capture date as recorded
by google photos. You will first need to check the "Create a Google
Photos folder" option in your google drive settings. You can then copy
or move the photos locally and use the date the image was taken
(created) set as the modification date.`,
Advanced: true, Advanced: true,
}, { }, {
Name: "list_chunk", Name: "list_chunk",
@ -261,9 +284,18 @@ func init() {
Help: "Impersonate this user when using a service account.", Help: "Impersonate this user when using a service account.",
Advanced: true, Advanced: true,
}, { }, {
Name: "alternate_export", Name: "alternate_export",
Default: false, Default: false,
Help: "Use alternate export URLs for google documents export.", Help: `Use alternate export URLs for google documents export.,
If this option is set this instructs rclone to use an alternate set of
export URLs for drive documents. Users have reported that the
official export URLs can't export large documents, whereas these
unofficial ones can.
See rclone issue [#2243](https://github.com/ncw/rclone/issues/2243) for background,
[this google drive issue](https://issuetracker.google.com/issues/36761333) and
[this helpful post](https://www.labnol.org/internet/direct-links-for-google-drive/28356/).`,
Advanced: true, Advanced: true,
}, { }, {
Name: "upload_cutoff", Name: "upload_cutoff",
@ -271,19 +303,30 @@ func init() {
Help: "Cutoff for switching to chunked upload", Help: "Cutoff for switching to chunked upload",
Advanced: true, Advanced: true,
}, { }, {
Name: "chunk_size", Name: "chunk_size",
Default: defaultChunkSize, Default: defaultChunkSize,
Help: "Upload chunk size. Must a power of 2 >= 256k.", Help: `Upload chunk size. Must a power of 2 >= 256k.
Making this larger will improve performance, but note that each chunk
is buffered in memory one per transfer.
Reducing this will reduce memory usage but decrease performance.`,
Advanced: true, Advanced: true,
}, { }, {
Name: "acknowledge_abuse", Name: "acknowledge_abuse",
Default: false, Default: false,
Help: "Set to allow files which return cannotDownloadAbusiveFile to be downloaded.", Help: `Set to allow files which return cannotDownloadAbusiveFile to be downloaded.
If downloading a file returns the error "This file has been identified
as malware or spam and cannot be downloaded" with the error code
"cannotDownloadAbusiveFile" then supply this flag to rclone to
indicate you acknowledge the risks of downloading the file and rclone
will download it anyway.`,
Advanced: true, Advanced: true,
}, { }, {
Name: "keep_revision_forever", Name: "keep_revision_forever",
Default: false, Default: false,
Help: "Keep new head revision forever.", Help: "Keep new head revision of each file forever.",
Advanced: true, Advanced: true,
}, { }, {
Name: "v2_download_min_size", Name: "v2_download_min_size",

11
backend/dropbox/dropbox.go
View File

@ -120,8 +120,15 @@ func init() {
Name: config.ConfigClientSecret, Name: config.ConfigClientSecret,
Help: "Dropbox App Client Secret\nLeave blank normally.", Help: "Dropbox App Client Secret\nLeave blank normally.",
}, { }, {
Name: "chunk_size", Name: "chunk_size",
Help: fmt.Sprintf("Upload chunk size. Max %v.", fs.SizeSuffix(maxChunkSize)), Help: fmt.Sprintf(`Upload chunk size. (< %v).
Any files larger than this will be uploaded in chunks of this size.
Note that chunks are buffered in memory (one at a time) so rclone can
deal with retries. Setting this larger will increase the speed
slightly (at most 10%% for 128MB in tests) at the cost of using more
memory. It can be set smaller if you are tight on memory.`, fs.SizeSuffix(maxChunkSize)),
Default: fs.SizeSuffix(defaultChunkSize), Default: fs.SizeSuffix(defaultChunkSize),
Advanced: true, Advanced: true,
}}, }},

2
backend/jottacloud/jottacloud.go
View File

@ -80,7 +80,7 @@ func init() {
Advanced: true, Advanced: true,
}, { }, {
Name: "unlink", Name: "unlink",
Help: "Remove existing public link to file/folder with link command rather than creating.", Help: "Remove existing public link to file/folder with link command rather than creating.\nDefault is false, meaning link command will create or retrieve public link.",
Default: false, Default: false,
Advanced: true, Advanced: true,
}}, }},

26
backend/local/local.go
View File

@ -49,19 +49,33 @@ func init() {
ShortOpt: "L", ShortOpt: "L",
Advanced: true, Advanced: true,
}, { }, {
Name: "skip_links", Name: "skip_links",
Help: "Don't warn about skipped symlinks.", Help: `Don't warn about skipped symlinks.
This flag disables warning messages on skipped symlinks or junction
points, as you explicitly acknowledge that they should be skipped.`,
Default: false, Default: false,
NoPrefix: true, NoPrefix: true,
Advanced: true, Advanced: true,
}, { }, {
Name: "no_unicode_normalization", Name: "no_unicode_normalization",
Help: "Don't apply unicode normalization to paths and filenames", Help: `Don't apply unicode normalization to paths and filenames (Deprecated)
This flag is deprecated now. Rclone no longer normalizes unicode file
names, but it compares them with unicode normalization in the sync
routine instead.`,
Default: false, Default: false,
Advanced: true, Advanced: true,
}, { }, {
Name: "no_check_updated", Name: "no_check_updated",
Help: "Don't check to see if the files change during upload", Help: `Don't check to see if the files change during upload
Normally rclone checks the size and modification time of files as they
are being uploaded and aborts with a message which starts "can't copy
- source file is being updated" if the file changes during upload.
However on some file systems this modification time check may fail (eg
[Glusterfs #2206](https://github.com/ncw/rclone/issues/2206)) so this
check can be disabled with this flag.`,
Default: false, Default: false,
Advanced: true, Advanced: true,
}, { }, {

15
backend/mega/mega.go
View File

@ -63,13 +63,20 @@ func init() {
Required: true, Required: true,
IsPassword: true, IsPassword: true,
}, { }, {
Name: "debug", Name: "debug",
Help: "Output more debug from Mega.", Help: `Output more debug from Mega.
If this flag is set (along with -vv) it will print further debugging
information from the mega backend.`,
Default: false, Default: false,
Advanced: true, Advanced: true,
}, { }, {
Name: "hard_delete", Name: "hard_delete",
Help: "Delete files permanently rather than putting them into the trash.", Help: `Delete files permanently rather than putting them into the trash.
Normally the mega backend will put all deletions into the trash rather
than permanently deleting them. If you specify this then rclone will
permanently delete objects instead.`,
Default: false, Default: false,
Advanced: true, Advanced: true,
}}, }},

17
backend/onedrive/onedrive.go
View File

@ -212,8 +212,11 @@ func init() {
Name: config.ConfigClientSecret, Name: config.ConfigClientSecret,
Help: "Microsoft App Client Secret\nLeave blank normally.", Help: "Microsoft App Client Secret\nLeave blank normally.",
}, { }, {
Name: "chunk_size", Name: "chunk_size",
Help: "Chunk size to upload files with - must be multiple of 320k.", Help: `Chunk size to upload files with - must be multiple of 320k.
Above this size files will be chunked - must be multiple of 320k. Note
that the chunks will be buffered into memory.`,
Default: fs.SizeSuffix(10 * 1024 * 1024), Default: fs.SizeSuffix(10 * 1024 * 1024),
Advanced: true, Advanced: true,
}, { }, {
@ -227,8 +230,14 @@ func init() {
Default: "", Default: "",
Advanced: true, Advanced: true,
}, { }, {
Name: "expose_onenote_files", Name: "expose_onenote_files",
Help: "If true, OneNote files will show up in directory listing (see docs)", Help: `Set to make OneNote files show up in directory listings.
By default rclone will hide OneNote files in directory listings because
operations like "Open" and "Update" won't work on them. But this
behaviour may also prevent you from deleting them. If you want to
delete OneNote files or otherwise want them to show up in directory
listing, set this option.`,
Default: false, Default: false,
Advanced: true, Advanced: true,
}}, }},

37
backend/s3/s3.go
View File

@ -517,7 +517,7 @@ func init() {
}}, }},
}, { }, {
Name: "storage_class", Name: "storage_class",
Help: "The storage class to use when storing objects in S3.", Help: "The storage class to use when storing new objects in S3.",
Provider: "AWS", Provider: "AWS",
Examples: []fs.OptionExample{{ Examples: []fs.OptionExample{{
Value: "", Value: "",
@ -536,8 +536,17 @@ func init() {
Help: "One Zone Infrequent Access storage class", Help: "One Zone Infrequent Access storage class",
}}, }},
}, { }, {
Name: "chunk_size", Name: "chunk_size",
Help: "Chunk size to use for uploading", Help: `Chunk size to use for uploading.
Any files larger than this will be uploaded in chunks of this
size. The default is 5MB. The minimum is 5MB.
Note that "--s3-upload-concurrency" chunks of this size are buffered
in memory per transfer.
If you are transferring large files over high speed links and you have
enough memory, then increasing this will speed up the transfers.`,
Default: fs.SizeSuffix(s3manager.MinUploadPartSize), Default: fs.SizeSuffix(s3manager.MinUploadPartSize),
Advanced: true, Advanced: true,
}, { }, {
@ -551,13 +560,27 @@ func init() {
Hide: fs.OptionHideBoth, Hide: fs.OptionHideBoth,
Advanced: true, Advanced: true,
}, { }, {
Name: "upload_concurrency", Name: "upload_concurrency",
Help: "Concurrency for multipart uploads.", Help: `Concurrency for multipart uploads.
This is the number of chunks of the same file that are uploaded
concurrently.
If you are uploading small numbers of large file over high speed link
and these uploads do not fully utilize your bandwidth, then increasing
this may help to speed up the transfers.`,
Default: 2, Default: 2,
Advanced: true, Advanced: true,
}, { }, {
Name: "force_path_style", Name: "force_path_style",
Help: "If true use path style access if false use virtual hosted style.\nSome providers (eg Aliyun OSS or Netease COS) require this.", Help: `If true use path style access if false use virtual hosted style.
If this is true (the default) then rclone will use path style access,
if false then rclone will use virtual path style. See [the AWS S3
docs](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro)
for more info.
Some providers (eg Aliyun OSS or Netease COS) require this set to false.`,
Default: true, Default: true,
Advanced: true, Advanced: true,
}}, }},

17
backend/sftp/sftp.go
View File

@ -90,9 +90,20 @@ func init() {
Help: "Allow asking for SFTP password when needed.", Help: "Allow asking for SFTP password when needed.",
Advanced: true, Advanced: true,
}, { }, {
Name: "path_override", Name: "path_override",
Default: "", Default: "",
Help: "Override path used by SSH connection.", Help: `Override path used by SSH connection.
This allows checksum calculation when SFTP and SSH paths are
different. This issue affects among others Synology NAS boxes.
Shared folders can be found in directories representing volumes
rclone sync /home/local/directory remote:/directory --ssh-path-override /volume2/directory
Home directory can be found in a shared folder called "home"
rclone sync /home/local/directory remote:/home/directory --ssh-path-override /volume1/homes/USER/directory`,
Advanced: true, Advanced: true,
}, { }, {
Name: "set_modtime", Name: "set_modtime",

16
backend/swift/swift.go
View File

@ -33,8 +33,11 @@ const (
// SharedOptions are shared between swift and hubic // SharedOptions are shared between swift and hubic
var SharedOptions = []fs.Option{{ var SharedOptions = []fs.Option{{
Name: "chunk_size", Name: "chunk_size",
Help: "Above this size files will be chunked into a _segments container.", Help: `Above this size files will be chunked into a _segments container.
Above this size files will be chunked into a _segments container. The
default for this is 5GB which is its maximum value.`,
Default: fs.SizeSuffix(5 * 1024 * 1024 * 1024), Default: fs.SizeSuffix(5 * 1024 * 1024 * 1024),
Advanced: true, Advanced: true,
}} }}
@ -129,8 +132,13 @@ func init() {
Value: "admin", Value: "admin",
}}, }},
}, { }, {
Name: "storage_policy", Name: "storage_policy",
Help: "The storage policy to use when creating a new container", Help: `The storage policy to use when creating a new container
This applies the specified storage policy when creating a new
container. The policy cannot be changed afterwards. The allowed
configuration values and their meaning depend on your Swift storage
provider.`,
Default: "", Default: "",
Examples: []fs.OptionExample{{ Examples: []fs.OptionExample{{
Help: "Default", Help: "Default",

2
backend/union/union.go
View File

@ -19,7 +19,7 @@ import (
func init() { func init() {
fsi := &fs.RegInfo{ fsi := &fs.RegInfo{
Name: "union", Name: "union",
Description: "Builds a stackable unification remote, which can appear to merge the contents of several remotes", Description: "A stackable unification remote, which can appear to merge the contents of several remotes",
NewFs: NewFs, NewFs: NewFs,
Options: []fs.Option{{ Options: []fs.Option{{
Name: "remotes", Name: "remotes",

2
docs/content/alias.md
View File

@ -128,3 +128,5 @@ Copy another local directory to the alias directory called source
rclone copy /home/source remote:source rclone copy /home/source remote:source
<!--- autogenerated options start - edit in backend/backend.go options -->
<!--- autogenerated options stop -->

39
docs/content/amazonclouddrive.md
View File

@ -173,43 +173,8 @@ Let's say you usually use `amazon.co.uk`. When you authenticate with
rclone it will take you to an `amazon.com` page to log in. Your rclone it will take you to an `amazon.com` page to log in. Your
`amazon.co.uk` email and password should work here just fine. `amazon.co.uk` email and password should work here just fine.
### Specific options ### <!--- autogenerated options start - edit in backend/backend.go options -->
<!--- autogenerated options stop -->
Here are the command line options specific to this cloud storage
system.
#### --acd-templink-threshold=SIZE ####
Files this size or more will be downloaded via their `tempLink`. This
is to work around a problem with Amazon Drive which blocks downloads
of files bigger than about 10GB. The default for this is 9GB which
shouldn't need to be changed.
To download files above this threshold, rclone requests a `tempLink`
which downloads the file through a temporary URL directly from the
underlying S3 storage.
#### --acd-upload-wait-per-gb=TIME ####
Sometimes Amazon Drive gives an error when a file has been fully
uploaded but the file appears anyway after a little while. This
happens sometimes for files over 1GB in size and nearly every time for
files bigger than 10GB. This parameter controls the time rclone waits
for the file to appear.
The default value for this parameter is 3 minutes per GB, so by
default it will wait 3 minutes for every GB uploaded to see if the
file appears.
You can disable this feature by setting it to 0. This may cause
conflict errors as rclone retries the failed upload but the file will
most likely appear correctly eventually.
These values were determined empirically by observing lots of uploads
of big files for a range of file sizes.
Upload with the `-v` flag to see more info about what rclone is doing
in this situation.
### Limitations ### ### Limitations ###

35
docs/content/azureblob.md
View File

@ -168,39 +168,8 @@ upload which means that there is a limit of 9.5TB of multipart uploads
in progress as Azure won't allow more than that amount of uncommitted in progress as Azure won't allow more than that amount of uncommitted
blocks. blocks.
### Specific options ### <!--- autogenerated options start - edit in backend/backend.go options -->
<!--- autogenerated options stop -->
Here are the command line options specific to this cloud storage
system.
#### --azureblob-upload-cutoff=SIZE ####
Cutoff for switching to chunked upload - must be <= 256MB. The default
is 256MB.
#### --azureblob-chunk-size=SIZE ####
Upload chunk size. Default 4MB. Note that this is stored in memory
and there may be up to `--transfers` chunks stored at once in memory.
This can be at most 100MB.
#### --azureblob-list-chunk=SIZE ####
List blob limit. Default is the maximum, 5000. `List blobs` requests
are permitted 2 minutes per megabyte to complete. If an operation is
taking longer than 2 minutes per megabyte on average, it will time out ( [source](https://docs.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-blob-service-operations#exceptions-to-default-timeout-interval) ). This limit the number of blobs items to return, to avoid the time out.
#### --azureblob-access-tier=Hot/Cool/Archive ####
Azure storage supports blob tiering, you can configure tier in advanced
settings or supply flag while performing data transfer operations.
If there is no `access tier` specified, rclone doesn't apply any tier.
rclone performs `Set Tier` operation on blobs while uploading, if objects
are not modified, specifying `access tier` to new one will have no effect.
If blobs are in `archive tier` at remote, trying to perform data transfer
operations from remote will not be allowed. User should first restore by
tiering blob to `Hot` or `Cool`.
### Limitations ### ### Limitations ###

46
docs/content/b2.md
View File

@ -265,46 +265,10 @@ start and finish the upload) and another 2 requests for each chunk:
/b2api/v1/b2_finish_large_file /b2api/v1/b2_finish_large_file
``` ```
### Specific options ### #### Versions ####
Here are the command line options specific to this cloud storage Versions can be viewd with the `--b2-versions` flag. When it is set
system. rclone will show and act on older versions of files. For example
#### --b2-chunk-size valuee=SIZE ####
When uploading large files chunk the file into this size. Note that
these chunks are buffered in memory and there might a maximum of
`--transfers` chunks in progress at once. 5,000,000 Bytes is the
minimim size (default 96M).
#### --b2-upload-cutoff=SIZE ####
Cutoff for switching to chunked upload (default 190.735 MiB == 200
MB). Files above this size will be uploaded in chunks of
`--b2-chunk-size`.
This value should be set no larger than 4.657GiB (== 5GB) as this is
the largest file size that can be uploaded.
#### --b2-test-mode=FLAG ####
This is for debugging purposes only.
Setting FLAG to one of the strings below will cause b2 to return
specific errors for debugging purposes.
* `fail_some_uploads`
* `expire_some_account_authorization_tokens`
* `force_cap_exceeded`
These will be set in the `X-Bz-Test-Mode` header which is documented
in the [b2 integrations
checklist](https://www.backblaze.com/b2/docs/integration_checklist.html).
#### --b2-versions ####
When set rclone will show and act on older versions of files. For example
Listing without `--b2-versions` Listing without `--b2-versions`
@ -329,3 +293,7 @@ server to the nearest millisecond appended to them.
Note that when using `--b2-versions` no file write operations are Note that when using `--b2-versions` no file write operations are
permitted, so you can't upload files or delete them. permitted, so you can't upload files or delete them.
<!--- autogenerated options start - edit in backend/backend.go options -->
<!--- autogenerated options stop -->

15
docs/content/box.md
View File

@ -217,19 +217,8 @@ normally 8MB so increasing `--transfers` will increase memory use.
Depending on the enterprise settings for your user, the item will Depending on the enterprise settings for your user, the item will
either be actually deleted from Box or moved to the trash. either be actually deleted from Box or moved to the trash.
### Specific options ### <!--- autogenerated options start - edit in backend/backend.go options -->
<!--- autogenerated options stop -->
Here are the command line options specific to this cloud storage
system.
#### --box-upload-cutoff=SIZE ####
Cutoff for switching to chunked upload - must be >= 50MB. The default
is 50MB.
#### --box-commit-retries int ####
Max number of times to try committing a multipart file. (default 100)
### Limitations ### ### Limitations ###

167
docs/content/cache.md
View File

@ -290,168 +290,5 @@ Params:
- **remote** = path to remote **(required)** - **remote** = path to remote **(required)**
- **withData** = true/false to delete cached data (chunks) as well _(optional, false by default)_ - **withData** = true/false to delete cached data (chunks) as well _(optional, false by default)_
### Specific options ### <!--- autogenerated options start - edit in backend/backend.go options -->
<!--- autogenerated options stop -->
Here are the command line options specific to this cloud storage
system.
#### --cache-db-path=PATH ####
Path to where the file structure metadata (DB) is stored locally. The remote
name is used as the DB file name.
**Default**: <rclone default cache path>/cache-backend/<remote name>
**Example**: /.cache/cache-backend/test-cache
#### --cache-chunk-path=PATH ####
Path to where partial file data (chunks) is stored locally. The remote
name is appended to the final path.
This config follows the `--cache-db-path`. If you specify a custom
location for `--cache-db-path` and don't specify one for `--cache-chunk-path`
then `--cache-chunk-path` will use the same path as `--cache-db-path`.
**Default**: <rclone default cache path>/cache-backend/<remote name>
**Example**: /.cache/cache-backend/test-cache
#### --cache-db-purge ####
Flag to clear all the cached data for this remote on start.
**Default**: not set
#### --cache-chunk-size=SIZE ####
The size of a chunk (partial file data). Use lower numbers for slower
connections. If the chunk size is changed, any downloaded chunks will be invalid and cache-chunk-path will need to be cleared or unexpected EOF errors will occur.
**Default**: 5M
#### --cache-chunk-total-size=SIZE ####
The total size that the chunks can take up on the local disk. If `cache`
exceeds this value then it will start to the delete the oldest chunks until
it goes under this value.
**Default**: 10G
#### --cache-chunk-clean-interval=DURATION ####
How often should `cache` perform cleanups of the chunk storage. The default value
should be ok for most people. If you find that `cache` goes over `cache-chunk-total-size`
too often then try to lower this value to force it to perform cleanups more often.
**Default**: 1m
#### --cache-info-age=DURATION ####
How long to keep file structure information (directory listings, file size,
mod times etc) locally.
If all write operations are done through `cache` then you can safely make
this value very large as the cache store will also be updated in real time.
**Default**: 6h
#### --cache-read-retries=RETRIES ####
How many times to retry a read from a cache storage.
Since reading from a `cache` stream is independent from downloading file data,
readers can get to a point where there's no more data in the cache.
Most of the times this can indicate a connectivity issue if `cache` isn't
able to provide file data anymore.
For really slow connections, increase this to a point where the stream is
able to provide data but your experience will be very stuttering.
**Default**: 10
#### --cache-workers=WORKERS ####
How many workers should run in parallel to download chunks.
Higher values will mean more parallel processing (better CPU needed) and
more concurrent requests on the cloud provider.
This impacts several aspects like the cloud provider API limits, more stress
on the hardware that rclone runs on but it also means that streams will
be more fluid and data will be available much more faster to readers.
**Note**: If the optional Plex integration is enabled then this setting
will adapt to the type of reading performed and the value specified here will be used
as a maximum number of workers to use.
**Default**: 4
#### --cache-chunk-no-memory ####
By default, `cache` will keep file data during streaming in RAM as well
to provide it to readers as fast as possible.
This transient data is evicted as soon as it is read and the number of
chunks stored doesn't exceed the number of workers. However, depending
on other settings like `cache-chunk-size` and `cache-workers` this footprint
can increase if there are parallel streams too (multiple files being read
at the same time).
If the hardware permits it, use this feature to provide an overall better
performance during streaming but it can also be disabled if RAM is not
available on the local machine.
**Default**: not set
#### --cache-rps=NUMBER ####
This setting places a hard limit on the number of requests per second that `cache`
will be doing to the cloud provider remote and try to respect that value
by setting waits between reads.
If you find that you're getting banned or limited on the cloud provider
through cache and know that a smaller number of requests per second will
allow you to work with it then you can use this setting for that.
A good balance of all the other settings should make this
setting useless but it is available to set for more special cases.
**NOTE**: This will limit the number of requests during streams but other
API calls to the cloud provider like directory listings will still pass.
**Default**: disabled
#### --cache-writes ####
If you need to read files immediately after you upload them through `cache`
you can enable this flag to have their data stored in the cache store at the
same time during upload.
**Default**: not set
#### --cache-tmp-upload-path=PATH ####
This is the path where `cache` will use as a temporary storage for new files
that need to be uploaded to the cloud provider.
Specifying a value will enable this feature. Without it, it is completely disabled
and files will be uploaded directly to the cloud provider
**Default**: empty
#### --cache-tmp-wait-time=DURATION ####
This is the duration that a file must wait in the temporary location
_cache-tmp-upload-path_ before it is selected for upload.
Note that only one file is uploaded at a time and it can take longer to
start the upload if a queue formed for this purpose.
**Default**: 15m
#### --cache-db-wait-time=DURATION ####
Only one process can have the DB open at any one time, so rclone waits
for this duration for the DB to become available before it gives an
error.
If you set it to 0 then it will wait forever.
**Default**: 1s

16
docs/content/crypt.md
View File

@ -294,20 +294,8 @@ Note that you should use the `rclone cryptcheck` command to check the
integrity of a crypted remote instead of `rclone check` which can't integrity of a crypted remote instead of `rclone check` which can't
check the checksums properly. check the checksums properly.
### Specific options ### <!--- autogenerated options start - edit in backend/backend.go options -->
<!--- autogenerated options stop -->
Here are the command line options specific to this cloud storage
system.
#### --crypt-show-mapping ####
If this flag is set then for each file that the remote is asked to
list, it will log (at level INFO) a line stating the decrypted file
name and the encrypted file name.
This is so you can work out which encrypted names are which decrypted
names just in case you need to do something with the encrypted file
names, or for debugging purposes.
## Backing up a crypted remote ## ## Backing up a crypted remote ##

101
docs/content/drive.md
View File

@ -388,33 +388,7 @@ Drive, the size of all files in the Trash and the space used by other
Google services such as Gmail. This command does not take any path Google services such as Gmail. This command does not take any path
arguments. arguments.
### Specific options ### #### Import/Export of google documents ####
Here are the command line options specific to this cloud storage
system.
#### --drive-acknowledge-abuse ####
If downloading a file returns the error `This file has been identified
as malware or spam and cannot be downloaded` with the error code
`cannotDownloadAbusiveFile` then supply this flag to rclone to
indicate you acknowledge the risks of downloading the file and rclone
will download it anyway.
#### --drive-auth-owner-only ####
Only consider files owned by the authenticated user.
#### --drive-chunk-size=SIZE ####
Upload chunk size. Must a power of 2 >= 256k. Default value is 8 MB.
Making this larger will improve performance, but note that each chunk
is buffered in memory one per transfer.
Reducing this will reduce memory usage but decrease performance.
#### --drive-export-formats / --drive-import-formats ####
Google documents can be exported from and uploaded to Google Drive. Google documents can be exported from and uploaded to Google Drive.
@ -509,77 +483,8 @@ Google Documents.
| url | INI style link file | macOS, Windows | | url | INI style link file | macOS, Windows |
| webloc | macOS specific XML format | macOS | | webloc | macOS specific XML format | macOS |
#### --drive-alternate-export #### <!--- autogenerated options start - edit in backend/backend.go options -->
<!--- autogenerated options stop -->
If this option is set this instructs rclone to use an alternate set of
export URLs for drive documents. Users have reported that the
official export URLs can't export large documents, whereas these
unofficial ones can.
See rclone issue [#2243](https://github.com/ncw/rclone/issues/2243) for background,
[this google drive issue](https://issuetracker.google.com/issues/36761333) and
[this helpful post](https://www.labnol.org/internet/direct-links-for-google-drive/28356/).
#### --drive-impersonate user ####
When using a service account, this instructs rclone to impersonate the user passed in.
#### --drive-keep-revision-forever ####
Keeps new head revision of the file forever.
#### --drive-list-chunk int ####
Size of listing chunk 100-1000. 0 to disable. (default 1000)
#### --drive-shared-with-me ####
Instructs rclone to operate on your "Shared with me" folder (where
Google Drive lets you access the files and folders others have shared
with you).
This works both with the "list" (lsd, lsl, etc) and the "copy"
commands (copy, sync, etc), and with all other commands too.
#### --drive-skip-gdocs ####
Skip google documents in all listings. If given, gdocs practically become invisible to rclone.
#### --drive-trashed-only ####
Only show files that are in the trash. This will show trashed files
in their original directory structure.
#### --drive-upload-cutoff=SIZE ####
File size cutoff for switching to chunked upload. Default is 8 MB.
#### --drive-use-trash ####
Controls whether files are sent to the trash or deleted
permanently. Defaults to true, namely sending files to the trash. Use
`--drive-use-trash=false` to delete files permanently instead.
#### --drive-use-created-date ####
Use the file creation date in place of the modification date. Defaults
to false.
Useful when downloading data and you want the creation date used in
place of the last modified date.
**WARNING**: This flag may have some unexpected consequences.
When uploading to your drive all files will be overwritten unless they
haven't been modified since their creation. And the inverse will occur
while downloading. This side effect can be avoided by using the
`--checksum` flag.
This feature was implemented to retain photos capture date as recorded
by google photos. You will first need to check the "Create a Google
Photos folder" option in your google drive settings. You can then copy
or move the photos locally and use the date the image was taken
(created) set as the modification date.
### Limitations ### ### Limitations ###

16
docs/content/dropbox.md
View File

@ -123,20 +123,8 @@ Dropbox supports [its own hash
type](https://www.dropbox.com/developers/reference/content-hash) which type](https://www.dropbox.com/developers/reference/content-hash) which
is checked for all transfers. is checked for all transfers.
### Specific options ### <!--- autogenerated options start - edit in backend/backend.go options -->
<!--- autogenerated options stop -->
Here are the command line options specific to this cloud storage
system.
#### --dropbox-chunk-size=SIZE ####
Any files larger than this will be uploaded in chunks of this
size. The default is 48MB. The maximum is 150MB.
Note that chunks are buffered in memory (one at a time) so rclone can
deal with retries. Setting this larger will increase the speed
slightly (at most 10% for 128MB in tests) at the cost of using more
memory. It can be set smaller if you are tight on memory.
### Limitations ### ### Limitations ###

3
docs/content/ftp.md
View File

@ -119,6 +119,9 @@ will be time of upload.
FTP does not support any checksums. FTP does not support any checksums.
<!--- autogenerated options start - edit in backend/backend.go options -->
<!--- autogenerated options stop -->
### Limitations ### ### Limitations ###
Note that since FTP isn't HTTP based the following flags don't work Note that since FTP isn't HTTP based the following flags don't work

3
docs/content/googlecloudstorage.md
View File

@ -228,3 +228,6 @@ docs](/docs/#fast-list) for more details.
Google google cloud storage stores md5sums natively and rclone stores Google google cloud storage stores md5sums natively and rclone stores
modification times as metadata on the object, under the "mtime" key in modification times as metadata on the object, under the "mtime" key in
RFC3339 format accurate to 1ns. RFC3339 format accurate to 1ns.
<!--- autogenerated options start - edit in backend/backend.go options -->
<!--- autogenerated options stop -->

3
docs/content/http.md
View File

@ -125,3 +125,6 @@ Since the http remote only has one config parameter it is easy to use
without a config file: without a config file:
rclone lsd --http-url https://beta.rclone.org :http: rclone lsd --http-url https://beta.rclone.org :http:
<!--- autogenerated options start - edit in backend/backend.go options -->
<!--- autogenerated options stop -->

3
docs/content/hubic.md
View File

@ -128,6 +128,9 @@ amongst others) for storing the modification time for an object.
Note that Hubic wraps the Swift backend, so most of the properties of Note that Hubic wraps the Swift backend, so most of the properties of
are the same. are the same.
<!--- autogenerated options start - edit in backend/backend.go options -->
<!--- autogenerated options stop -->
### Limitations ### ### Limitations ###
This uses the normal OpenStack Swift mechanism to refresh the Swift This uses the normal OpenStack Swift mechanism to refresh the Swift

24
docs/content/jottacloud.md
View File

@ -124,6 +124,9 @@ To view your current quota you can use the `rclone about remote:`
command which will display your usage limit (unless it is unlimited) command which will display your usage limit (unless it is unlimited)
and the current usage. and the current usage.
<!--- autogenerated options start - edit in backend/backend.go options -->
<!--- autogenerated options stop -->
### Limitations ### ### Limitations ###
Note that Jottacloud is case insensitive so you can't have a file called Note that Jottacloud is case insensitive so you can't have a file called
@ -133,27 +136,6 @@ There are quite a few characters that can't be in Jottacloud file names. Rclone
Jottacloud only supports filenames up to 255 characters in length. Jottacloud only supports filenames up to 255 characters in length.
### Specific options ###
Here are the command line options specific to this cloud storage
system.
#### --jottacloud-md5-memory-limit SizeSuffix
Files bigger than this will be cached on disk to calculate the MD5 if
required. (default 10M)
#### --jottacloud-hard-delete ####
Controls whether files are sent to the trash or deleted
permanently. Defaults to false, namely sending files to the trash.
Use `--jottacloud-hard-delete=true` to delete files permanently instead.
#### --jottacloud-unlink ####
Set to true to make the link command remove existing public link to file/folder.
Default is false, meaning link command will create or retrieve public link.
### Troubleshooting ### ### Troubleshooting ###
Jottacloud exhibits some inconsistent behaviours regarding deleted files and folders which may cause Copy, Move and DirMove operations to previously deleted paths to fail. Emptying the trash should help in such cases. Jottacloud exhibits some inconsistent behaviours regarding deleted files and folders which may cause Copy, Move and DirMove operations to previously deleted paths to fail. Emptying the trash should help in such cases.

44
docs/content/local.md
View File

@ -75,17 +75,13 @@ This will use UNC paths on `c:\src` but not on `z:\dst`.
Of course this will cause problems if the absolute path length of a Of course this will cause problems if the absolute path length of a
file exceeds 258 characters on z, so only use this option if you have to. file exceeds 258 characters on z, so only use this option if you have to.
### Specific options ### ### Symlinks / Junction points
Here are the command line options specific to local storage
#### --copy-links, -L ####
Normally rclone will ignore symlinks or junction points (which behave Normally rclone will ignore symlinks or junction points (which behave
like symlinks under Windows). like symlinks under Windows).
If you supply this flag then rclone will follow the symlink and copy If you supply `--copy-links` or `-L` then rclone will follow the
the pointed to file or directory. symlink and copy the pointed to file or directory.
This flag applies to all commands. This flag applies to all commands.
@ -120,28 +116,13 @@ $ rclone -L ls /tmp/a
6 b/one 6 b/one
``` ```
#### --local-no-check-updated #### ### Restricting filesystems with --one-file-system
Don't check to see if the files change during upload. Normally rclone will recurse through filesystems as mounted.
Normally rclone checks the size and modification time of files as they However if you set `--one-file-system` or `-x` this tells rclone to
are being uploaded and aborts with a message which starts `can't copy stay in the filesystem specified by the root and not to recurse into
- source file is being updated` if the file changes during upload. different file systems.
However on some file systems this modification time check may fail (eg
[Glusterfs #2206](https://github.com/ncw/rclone/issues/2206)) so this
check can be disabled with this flag.
#### --local-no-unicode-normalization ####
This flag is deprecated now. Rclone no longer normalizes unicode file
names, but it compares them with unicode normalization in the sync
routine instead.
#### --one-file-system, -x ####
This tells rclone to stay in the filesystem specified by the root and
not to recurse into different file systems.
For example if you have a directory hierarchy like this For example if you have a directory hierarchy like this
@ -176,10 +157,7 @@ treats a bind mount to the same device as being on the same
filesystem. filesystem.
**NB** This flag is only available on Unix based systems. On systems **NB** This flag is only available on Unix based systems. On systems
where it isn't supported (eg Windows) it will not appear as an valid where it isn't supported (eg Windows) it will be ignored.
flag.
#### --skip-links #### <!--- autogenerated options start - edit in backend/backend.go options -->
<!--- autogenerated options stop -->
This flag disables warning messages on skipped symlinks or junction
points, as you explicitly acknowledge that they should be skipped.

18
docs/content/mega.md
View File

@ -96,22 +96,8 @@ messages in the log about duplicates.
Use `rclone dedupe` to fix duplicated files. Use `rclone dedupe` to fix duplicated files.
### Specific options ### <!--- autogenerated options start - edit in backend/backend.go options -->
<!--- autogenerated options stop -->
Here are the command line options specific to this cloud storage
system.
#### --mega-debug ####
If this flag is set (along with `-vv`) it will print further debugging
information from the mega backend.
#### --mega-hard-delete ####
Normally the mega backend will put all deletions into the trash rather
than permanently deleting them. If you specify this flag (or set it
in the advanced config) then rclone will permanently delete objects
instead.
### Limitations ### ### Limitations ###

18
docs/content/onedrive.md
View File

@ -155,22 +155,8 @@ 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 trash, so you will have to do that with one of Microsoft's apps or via
the OneDrive website. the OneDrive website.
### Specific options ### <!--- autogenerated options start - edit in backend/backend.go options -->
<!--- autogenerated options stop -->
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-expose-onenote-files ####
By default rclone will hide OneNote files in directory listing because operations like `Open`
and `Update` won't work on them. But this behaviour may also prevent you from deleting them.
If you want to delete OneNote files or otherwise want them to show up in directory listing,
set this flag.
### Limitations ### ### Limitations ###

9
docs/content/opendrive.md
View File

@ -93,13 +93,8 @@ OpenDrive allows modification times to be set on objects accurate to 1
second. These will be used to detect whether objects need syncing or second. These will be used to detect whether objects need syncing or
not. not.
### Deleting files ### <!--- autogenerated options start - edit in backend/backend.go options -->
<!--- autogenerated options stop -->
Any files you delete with rclone will end up in the trash. Amazon
don't provide an API to permanently delete files, nor to empty the
trash, so you will have to do that with one of Amazon's apps or via
the OpenDrive website. As of November 17, 2016, files are
automatically deleted by Amazon from the trash after 30 days.
### Limitations ### ### Limitations ###

3
docs/content/pcloud.md
View File

@ -133,3 +133,6 @@ pCloud supports MD5 and SHA1 type hashes, so you can use the
Deleted files will be moved to the trash. Your subscription level Deleted files will be moved to the trash. Your subscription level
will determine how long items stay in the trash. `rclone cleanup` can will determine how long items stay in the trash. `rclone cleanup` can
be used to empty the trash. be used to empty the trash.
<!--- autogenerated options start - edit in backend/backend.go options -->
<!--- autogenerated options stop -->

2
docs/content/qingstor.md
View File

@ -152,3 +152,5 @@ credentials. In order of precedence:
- Access Key ID: `QS_ACCESS_KEY_ID` or `QS_ACCESS_KEY` - Access Key ID: `QS_ACCESS_KEY_ID` or `QS_ACCESS_KEY`
- Secret Access Key: `QS_SECRET_ACCESS_KEY` or `QS_SECRET_KEY` - Secret Access Key: `QS_SECRET_ACCESS_KEY` or `QS_SECRET_KEY`
<!--- autogenerated options start - edit in backend/backend.go options -->
<!--- autogenerated options stop -->

52
docs/content/s3.md
View File

@ -370,56 +370,8 @@ tries to access the data you will see an error like below.
In this case you need to [restore](http://docs.aws.amazon.com/AmazonS3/latest/user-guide/restore-archived-objects.html) In this case you need to [restore](http://docs.aws.amazon.com/AmazonS3/latest/user-guide/restore-archived-objects.html)
the object(s) in question before using rclone. the object(s) in question before using rclone.
### Specific options ### <!--- autogenerated options start - edit in backend/backend.go options -->
<!--- autogenerated options stop -->
Here are the command line options specific to this cloud storage
system.
#### --s3-acl=STRING ####
Canned ACL used when creating buckets and/or storing objects in S3.
For more info visit the [canned ACL docs](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl).
#### --s3-storage-class=STRING ####
Storage class to upload new objects with.
Available options include:
- STANDARD - default storage class
- STANDARD_IA - for less frequently accessed data (e.g backups)
- ONEZONE_IA - for storing data in only one Availability Zone
- REDUCED_REDUNDANCY (only for noncritical, reproducible data, has lower redundancy)
#### --s3-chunk-size=SIZE ####
Any files larger than this will be uploaded in chunks of this
size. The default is 5MB. The minimum is 5MB.
Note that 2 chunks of this size are buffered in memory per transfer.
If you are transferring large files over high speed links and you have
enough memory, then increasing this will speed up the transfers.
#### --s3-force-path-style=BOOL ####
If this is true (the default) then rclone will use path style access,
if false then rclone will use virtual path style. See [the AWS S3
docs](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro)
for more info.
Some providers (eg Aliyun OSS or Netease COS) require this set to
`false`. It can also be set in the config in the advanced section.
#### --s3-upload-concurrency ####
Number of chunks of the same file that are uploaded concurrently.
Default is 2.
If you are uploading small amount of large file over high speed link
and these uploads do not fully utilize your bandwidth, then increasing
this may help to speed up the transfers.
### Anonymous access to public buckets ### ### Anonymous access to public buckets ###

25
docs/content/sftp.md
View File

@ -147,28 +147,6 @@ And then at the end of the session
These commands can be used in scripts of course. These commands can be used in scripts of course.
### Specific options ###
Here are the command line options specific to this remote.
#### --sftp-ask-password ####
Ask for the SFTP password if needed when no password has been configured.
#### --ssh-path-override ####
Override path used by SSH connection. Allows checksum calculation when
SFTP and SSH paths are different. This issue affects among others Synology
NAS boxes.
Shared folders can be found in directories representing volumes
rclone sync /home/local/directory remote:/directory --ssh-path-override /volume2/directory
Home directory can be found in a shared folder called `homes`
rclone sync /home/local/directory remote:/home/directory --ssh-path-override /volume1/homes/USER/directory
### Modified time ### ### Modified time ###
Modified times are stored on the server to 1 second precision. Modified times are stored on the server to 1 second precision.
@ -180,6 +158,9 @@ upload (for example, certain configurations of ProFTPd with mod_sftp). If you
are using one of these servers, you can set the option `set_modtime = false` in are using one of these servers, you can set the option `set_modtime = false` in
your RClone backend configuration to disable this behaviour. your RClone backend configuration to disable this behaviour.
<!--- autogenerated options start - edit in backend/backend.go options -->
<!--- autogenerated options stop -->
### Limitations ### ### Limitations ###
SFTP supports checksums if the same login has shell access and `md5sum` SFTP supports checksums if the same login has shell access and `md5sum`

16
docs/content/swift.md
View File

@ -261,20 +261,8 @@ sufficient to determine if it is "dirty". By using `--update` along with
`--use-server-modtime`, you can avoid the extra API call and simply upload `--use-server-modtime`, you can avoid the extra API call and simply upload
files whose local modtime is newer than the time it was last uploaded. files whose local modtime is newer than the time it was last uploaded.
### Specific options ### <!--- autogenerated options start - edit in backend/backend.go options -->
<!--- autogenerated options stop -->
Here are the command line options specific to this cloud storage
system.
#### --swift-storage-policy=STRING ####
Apply the specified storage policy when creating a new container. The policy
cannot be changed afterwards. The allowed configuration values and their
meaning depend on your Swift storage provider.
#### --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 ### ### Modified time ###

2
docs/content/union.md
View File

@ -142,3 +142,5 @@ Copy another local directory to the union directory called source, which will be
rclone copy C:\source remote:source rclone copy C:\source remote:source
<!--- autogenerated options start - edit in backend/backend.go options -->
<!--- autogenerated options stop -->

3
docs/content/webdav.md
View File

@ -101,6 +101,9 @@ Owncloud or Nextcloud rclone will support modified times.
Hashes are not supported. Hashes are not supported.
<!--- autogenerated options start - edit in backend/backend.go options -->
<!--- autogenerated options stop -->
## Provider notes ## ## Provider notes ##
See below for notes on specific providers. See below for notes on specific providers.

3
docs/content/yandex.md
View File

@ -127,3 +127,6 @@ MD5 checksums are natively supported by Yandex Disk.
If you wish to empty your trash you can use the `rclone cleanup remote:` If you wish to empty your trash you can use the `rclone cleanup remote:`
command which will permanently delete all your trashed files. This command command which will permanently delete all your trashed files. This command
does not take any path arguments. does not take any path arguments.
<!--- autogenerated options start - edit in backend/backend.go options -->
<!--- autogenerated options stop -->