docs: auto generate backend options documentation

This inserts the output of "rclone help backend xxx" into the help pages for each backend.
2025-12-11 22:14:05 +01:00 · 2018-10-01 20:48:54 +01:00
parent a9273c5da5
commit 78b9bd77f5
29 changed files with 2829 additions and 57 deletions
--- a/docs/content/amazonclouddrive.md
+++ b/docs/content/amazonclouddrive.md
@@ -173,8 +173,110 @@ 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
 `amazon.co.uk` email and password should work here just fine.

-<!--- autogenerated options start - edit in backend/backend.go options  -->
-<!--- autogenerated options stop  -->
+<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/amazonclouddrive/amazonclouddrive.go then run make backenddocs -->
+### Standard Options
+
+Here are the standard options specific to amazon cloud drive (Amazon Drive).
+
+#### --acd-client-id
+
+Amazon Application Client ID.
+
+- Config:      client_id
+- Env Var:     RCLONE_ACD_CLIENT_ID
+- Type:        string
+- Default:     ""
+
+#### --acd-client-secret
+
+Amazon Application Client Secret.
+
+- Config:      client_secret
+- Env Var:     RCLONE_ACD_CLIENT_SECRET
+- Type:        string
+- Default:     ""
+
+### Advanced Options
+
+Here are the advanced options specific to amazon cloud drive (Amazon Drive).
+
+#### --acd-auth-url
+
+Auth server URL.
+Leave blank to use Amazon's.
+
+- Config:      auth_url
+- Env Var:     RCLONE_ACD_AUTH_URL
+- Type:        string
+- Default:     ""
+
+#### --acd-token-url
+
+Token server url.
+leave blank to use Amazon's.
+
+- Config:      token_url
+- Env Var:     RCLONE_ACD_TOKEN_URL
+- Type:        string
+- Default:     ""
+
+#### --acd-checkpoint
+
+Checkpoint for internal polling (debug).
+
+- Config:      checkpoint
+- Env Var:     RCLONE_ACD_CHECKPOINT
+- Type:        string
+- Default:     ""
+
+#### --acd-upload-wait-per-gb
+
+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.
+
+- Config:      upload_wait_per_gb
+- Env Var:     RCLONE_ACD_UPLOAD_WAIT_PER_GB
+- Type:        Duration
+- Default:     3m0s
+
+#### --acd-templink-threshold
+
+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.
+
+- Config:      templink_threshold
+- Env Var:     RCLONE_ACD_TEMPLINK_THRESHOLD
+- Type:        SizeSuffix
+- Default:     9G
+
+<!--- autogenerated options stop -->

 ### Limitations ###