random-background: add bgSupport documentation

On NixOS it is necessary to set `bgSupport = true` when creating a
Home Manager desktop manager session. Otherwise NixOS will add code
that sets the background, overriding the effort made by the
`random-background` module.

Fixes #955
Pull request #956
This commit is contained in:
Gregory Oakes 2019-12-25 10:16:27 -08:00 committed by Robert Helgesson
parent 0f1c9f25cf
commit a12a8f7977
No known key found for this signature in database
GPG key ID: 36BDAA14C2797E89

View file

@ -22,7 +22,17 @@ in
options = { options = {
services.random-background = { services.random-background = {
enable = mkEnableOption "random desktop background"; enable = mkEnableOption "" // {
description = ''
Whether to enable random desktop background.
</para><para>
Note, if you are using NixOS and have set up a custom
desktop manager session for Home Manager, then the session
configuration must have the <option>bgSupport</option>
option set to <literal>true</literal> or the background
image set by this module may be overwritten.
'';
};
imageDirectory = mkOption { imageDirectory = mkOption {
type = types.str; type = types.str;