docs: auto generate backend options documentation

This inserts the output of "rclone help backend xxx" into the help pages for each backend.
2025-12-06 00:03:32 +00: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/googlecloudstorage.md
+++ b/docs/content/googlecloudstorage.md
@@ -229,5 +229,163 @@ Google google cloud storage stores md5sums natively and rclone stores
 modification times as metadata on the object, under the "mtime" key in
 RFC3339 format accurate to 1ns.

-<!--- autogenerated options start - edit in backend/backend.go options  -->
-<!--- autogenerated options stop  -->
+<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/googlecloudstorage/googlecloudstorage.go then run make backenddocs -->
+### Standard Options
+
+Here are the standard options specific to google cloud storage (Google Cloud Storage (this is not Google Drive)).
+
+#### --gcs-client-id
+
+Google Application Client Id
+Leave blank normally.
+
+- Config:      client_id
+- Env Var:     RCLONE_GCS_CLIENT_ID
+- Type:        string
+- Default:     ""
+
+#### --gcs-client-secret
+
+Google Application Client Secret
+Leave blank normally.
+
+- Config:      client_secret
+- Env Var:     RCLONE_GCS_CLIENT_SECRET
+- Type:        string
+- Default:     ""
+
+#### --gcs-project-number
+
+Project number.
+Optional - needed only for list/create/delete buckets - see your developer console.
+
+- Config:      project_number
+- Env Var:     RCLONE_GCS_PROJECT_NUMBER
+- Type:        string
+- Default:     ""
+
+#### --gcs-service-account-file
+
+Service Account Credentials JSON file path
+Leave blank normally.
+Needed only if you want use SA instead of interactive login.
+
+- Config:      service_account_file
+- Env Var:     RCLONE_GCS_SERVICE_ACCOUNT_FILE
+- Type:        string
+- Default:     ""
+
+#### --gcs-service-account-credentials
+
+Service Account Credentials JSON blob
+Leave blank normally.
+Needed only if you want use SA instead of interactive login.
+
+- Config:      service_account_credentials
+- Env Var:     RCLONE_GCS_SERVICE_ACCOUNT_CREDENTIALS
+- Type:        string
+- Default:     ""
+
+#### --gcs-object-acl
+
+Access Control List for new objects.
+
+- Config:      object_acl
+- Env Var:     RCLONE_GCS_OBJECT_ACL
+- Type:        string
+- Default:     ""
+- Examples:
+    - "authenticatedRead"
+        - Object owner gets OWNER access, and all Authenticated Users get READER access.
+    - "bucketOwnerFullControl"
+        - Object owner gets OWNER access, and project team owners get OWNER access.
+    - "bucketOwnerRead"
+        - Object owner gets OWNER access, and project team owners get READER access.
+    - "private"
+        - Object owner gets OWNER access [default if left blank].
+    - "projectPrivate"
+        - Object owner gets OWNER access, and project team members get access according to their roles.
+    - "publicRead"
+        - Object owner gets OWNER access, and all Users get READER access.
+
+#### --gcs-bucket-acl
+
+Access Control List for new buckets.
+
+- Config:      bucket_acl
+- Env Var:     RCLONE_GCS_BUCKET_ACL
+- Type:        string
+- Default:     ""
+- Examples:
+    - "authenticatedRead"
+        - Project team owners get OWNER access, and all Authenticated Users get READER access.
+    - "private"
+        - Project team owners get OWNER access [default if left blank].
+    - "projectPrivate"
+        - Project team members get access according to their roles.
+    - "publicRead"
+        - Project team owners get OWNER access, and all Users get READER access.
+    - "publicReadWrite"
+        - Project team owners get OWNER access, and all Users get WRITER access.
+
+#### --gcs-location
+
+Location for the newly created buckets.
+
+- Config:      location
+- Env Var:     RCLONE_GCS_LOCATION
+- Type:        string
+- Default:     ""
+- Examples:
+    - ""
+        - Empty for default location (US).
+    - "asia"
+        - Multi-regional location for Asia.
+    - "eu"
+        - Multi-regional location for Europe.
+    - "us"
+        - Multi-regional location for United States.
+    - "asia-east1"
+        - Taiwan.
+    - "asia-northeast1"
+        - Tokyo.
+    - "asia-southeast1"
+        - Singapore.
+    - "australia-southeast1"
+        - Sydney.
+    - "europe-west1"
+        - Belgium.
+    - "europe-west2"
+        - London.
+    - "us-central1"
+        - Iowa.
+    - "us-east1"
+        - South Carolina.
+    - "us-east4"
+        - Northern Virginia.
+    - "us-west1"
+        - Oregon.
+
+#### --gcs-storage-class
+
+The storage class to use when storing objects in Google Cloud Storage.
+
+- Config:      storage_class
+- Env Var:     RCLONE_GCS_STORAGE_CLASS
+- Type:        string
+- Default:     ""
+- Examples:
+    - ""
+        - Default
+    - "MULTI_REGIONAL"
+        - Multi-regional storage class
+    - "REGIONAL"
+        - Regional storage class
+    - "NEARLINE"
+        - Nearline storage class
+    - "COLDLINE"
+        - Coldline storage class
+    - "DURABLE_REDUCED_AVAILABILITY"
+        - Durable reduced availability storage class
+
+<!--- autogenerated options stop -->