sane module: add more documentation

Imported from https://nixos.org/wiki/Scanners

zimbatm 93a0306e e3aa635e

Changed files
+15 -2
nixos
modules
services
hardware
+15 -2
nixos/modules/services/hardware/sane.nix
···
hardware.sane.enable = mkOption {
type = types.bool;
default = false;
-
description = "Enable support for SANE scanners.";
+
description = ''
+
Enable support for SANE scanners.
+
+
<note><para>
+
Users in the "scanner" group will gain access to the scanner.
+
</para></note>
+
'';
};
hardware.sane.snapshot = mkOption {
···
hardware.sane.extraBackends = mkOption {
type = types.listOf types.path;
default = [];
-
description = "Packages providing extra SANE backends to enable.";
+
description = ''
+
Packages providing extra SANE backends to enable.
+
+
<note><para>
+
The example contains the package for HP scanners.
+
</para></note>
+
'';
+
example = literalExample "[ pkgs.hplipWithPlugin ]";
};
hardware.sane.configDir = mkOption {