linux-wallpaperengine: add examples and clarify options usage
This commit is contained in:
parent
8fd20c8d48
commit
05fd3babab
1 changed files with 8 additions and 1 deletions
|
|
@ -21,6 +21,7 @@ in
|
|||
type = types.nullOr types.path;
|
||||
default = null;
|
||||
description = "Path to the assets directory.";
|
||||
example = "~/.local/share/Steam/steamapps/common/wallpaper_engine/assets";
|
||||
};
|
||||
|
||||
clamping = mkOption {
|
||||
|
|
@ -42,17 +43,23 @@ in
|
|||
monitor = mkOption {
|
||||
type = types.str;
|
||||
description = "Which monitor to display the wallpaper.";
|
||||
example = "HDMI-A-1";
|
||||
};
|
||||
|
||||
wallpaperId = mkOption {
|
||||
type = types.str;
|
||||
description = "Wallpaper ID to be used.";
|
||||
description = "Wallpaper to be used. Can either be a Steam Workshop ID or the path to the background folder.";
|
||||
example = "3527223773";
|
||||
};
|
||||
|
||||
extraOptions = mkOption {
|
||||
type = types.listOf types.str;
|
||||
default = [ ];
|
||||
description = "Extra arguments to pass to the linux-wallpaperengine command for this wallpaper.";
|
||||
example = [
|
||||
"--scaling fill"
|
||||
"--fps 12"
|
||||
];
|
||||
};
|
||||
|
||||
scaling = mkOption {
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue