docs: auto generate backend options documentation

This inserts the output of "rclone help backend xxx" into the help pages for each backend.
2025-06-05 20:34:39 +08: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/azureblob.md
+++ b/docs/content/azureblob.md
@ -168,8 +168,112 @@ 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
 blocks.

-<!--- autogenerated options start - edit in backend/backend.go options  -->
-<!--- autogenerated options stop  -->
+<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/azureblob/azureblob.go then run make backenddocs -->
+### Standard Options
+
+Here are the standard options specific to azureblob (Microsoft Azure Blob Storage).
+
+#### --azureblob-account
+
+Storage Account Name (leave blank to use connection string or SAS URL)
+
+- Config:      account
+- Env Var:     RCLONE_AZUREBLOB_ACCOUNT
+- Type:        string
+- Default:     ""
+
+#### --azureblob-key
+
+Storage Account Key (leave blank to use connection string or SAS URL)
+
+- Config:      key
+- Env Var:     RCLONE_AZUREBLOB_KEY
+- Type:        string
+- Default:     ""
+
+#### --azureblob-sas-url
+
+SAS URL for container level access only
+(leave blank if using account/key or connection string)
+
+- Config:      sas_url
+- Env Var:     RCLONE_AZUREBLOB_SAS_URL
+- Type:        string
+- Default:     ""
+
+### Advanced Options
+
+Here are the advanced options specific to azureblob (Microsoft Azure Blob Storage).
+
+#### --azureblob-endpoint
+
+Endpoint for the service
+Leave blank normally.
+
+- Config:      endpoint
+- Env Var:     RCLONE_AZUREBLOB_ENDPOINT
+- Type:        string
+- Default:     ""
+
+#### --azureblob-upload-cutoff
+
+Cutoff for switching to chunked upload (<= 256MB).
+
+- Config:      upload_cutoff
+- Env Var:     RCLONE_AZUREBLOB_UPLOAD_CUTOFF
+- Type:        SizeSuffix
+- Default:     256M
+
+#### --azureblob-chunk-size
+
+Upload chunk size (<= 100MB).
+
+Note that this is stored in memory and there may be up to
+"--transfers" chunks stored at once in memory.
+
+- Config:      chunk_size
+- Env Var:     RCLONE_AZUREBLOB_CHUNK_SIZE
+- Type:        SizeSuffix
+- Default:     4M
+
+#### --azureblob-list-chunk
+
+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.
+
+- Config:      list_chunk
+- Env Var:     RCLONE_AZUREBLOB_LIST_CHUNK
+- Type:        int
+- Default:     5000
+
+#### --azureblob-access-tier
+
+Access tier of blob: hot, cool or archive.
+
+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".
+
+- Config:      access_tier
+- Env Var:     RCLONE_AZUREBLOB_ACCESS_TIER
+- Type:        string
+- Default:     ""
+
+<!--- autogenerated options stop -->

 ### Limitations ###