diff --git a/options.xhtml b/options.xhtml index f6492757a..e9e340c1d 100644 --- a/options.xhtml +++ b/options.xhtml @@ -51741,6 +51741,132 @@ An attribute set containing a remote type and options.

} +

Declared by:

+ + +
+ +<home-manager/modules/programs/rclone.nix> + +
+ +
+ + programs.rclone.remotes.<name>.mounts + + +
+
+

An attribute set mapping remote file paths to their corresponding mount +point configurations.

For each entry, to perform the equivalent of +rclone mount remote:path/to/files /path/to/local/mount — as described in the +rclone documentation https://rclone.org/commands/rclone_mount/ — we create +a key-value pair like this: +"path/to/files/on/remote" = { ... }.

+ +

Type: +attribute set of (submodule)

+ +

Default: +{ }

+ +

Example:

{
+  "path/to/files" = {
+    enable = true;
+    mountPoint = "/home/alice/rclone-mount";
+    options = {
+      dir-cache-time = "5000h";
+      poll-interval = "10s";
+      umask = "002";
+      user-agent = "Laptop";
+    };
+  };
+}
+
+
+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/rclone.nix> + +
+
+
+ + programs.rclone.remotes.<name>.mounts.<name>.enable + + +
+
+

Whether to enable this mount.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/rclone.nix> + +
+
+
+ + programs.rclone.remotes.<name>.mounts.<name>.mountPoint + + +
+
+

A local file path specifying the location of the mount point.

+ +

Type: +string

+ +

Default: +null

+ +

Example: +"/home/alice/my-remote"

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/rclone.nix> + +
+
+
+ + programs.rclone.remotes.<name>.mounts.<name>.options + + +
+
+

An attribute set of option values passed to rclone mount. To set +a boolean option, assign it true or false. See +https://nixos.org/manual/nixpkgs/stable/#function-library-lib.cli.toGNUCommandLineShell +for more details on the format.

Some caching options are set by default, namely vfs-cache-mode = "full" +and cache-dir. These can be overridden if desired.

+ +

Type: +attribute set of (null or boolean or signed integer or floating point number or string)

+ +

Default: +{ }

+

Declared by: