diff --git a/options.xhtml b/options.xhtml index addc8a9ee..891343b54 100644 --- a/options.xhtml +++ b/options.xhtml @@ -90333,6 +90333,242 @@ list of absolute path

+
+ + xdg.cacheFile + + +
+
+

Attribute set of files to link into the user’s XDG +cache home.

+ +

Type: +attribute set of (submodule)

+ +

Default: +{ }

+ +

Declared by:

+ + +
+ +<home-manager/modules/misc/xdg.nix> + +
+
+
+ + xdg.cacheFile.<name>.enable + + +
+
+

Whether this file should be generated. This option allows specific +files to be disabled.

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ + +
+ +<home-manager/modules/misc/xdg.nix> + +
+
+
+ + xdg.cacheFile.<name>.executable + + +
+
+

Set the execute bit. If null, defaults to the mode +of the source file or to false +for files created through the text option.

+ +

Type: +null or boolean

+ +

Default: +null

+ +

Declared by:

+ + +
+ +<home-manager/modules/misc/xdg.nix> + +
+
+
+ + xdg.cacheFile.<name>.force + + +
+
+

Whether the target path should be unconditionally replaced +by the managed file source. Warning, this will silently +delete the target regardless of whether it is a file or +link.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<home-manager/modules/misc/xdg.nix> + +
+
+
+ + xdg.cacheFile.<name>.onChange + + +
+
+

Shell commands to run when file has changed between +generations. The script will be run +after the new files have been linked +into place.

Note, this code is always run when recursive is +enabled.

+ +

Type: +strings concatenated with “\n”

+ +

Default: +""

+ +

Declared by:

+ + +
+ +<home-manager/modules/misc/xdg.nix> + +
+
+
+ + xdg.cacheFile.<name>.recursive + + +
+
+

If the file source is a directory, then this option +determines whether the directory should be recursively +linked to the target location. This option has no effect +if the source is a file.

If false (the default) then the target +will be a symbolic link to the source directory. If +true then the target will be a +directory structure matching the source’s but whose leafs +are symbolic links to the files of the source directory.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<home-manager/modules/misc/xdg.nix> + +
+
+
+ + xdg.cacheFile.<name>.source + + +
+
+

Path of the source file or directory. If +xdg.cacheFile.<name>.text +is non-null then this option will automatically point to a file +containing that text.

+ +

Type: +absolute path

+ +

Declared by:

+ + +
+ +<home-manager/modules/misc/xdg.nix> + +
+
+
+ + xdg.cacheFile.<name>.target + + +
+
+

Path to target file relative to xdg.cacheHome.

+ +

Type: +string

+ +

Default: +name

+ +

Declared by:

+ + +
+ +<home-manager/modules/misc/xdg.nix> + +
+
+
+ + xdg.cacheFile.<name>.text + + +
+
+

Text of the file. If this option is null then +xdg.cacheFile.<name>.source +must be set.

+ +

Type: +null or strings concatenated with “\n”

+ +

Default: +null

+ +

Declared by:

+ + +
+ +<home-manager/modules/misc/xdg.nix> + +
+
xdg.cacheHome