summary refs log tree commit diff
path: root/nixos/modules/services/hardware
diff options
context:
space:
mode:
authorzimbatm <zimbatm@zimbatm.com>2016-02-21 19:55:39 +0000
committerzimbatm <zimbatm@zimbatm.com>2016-02-25 19:36:46 +0000
commit93a0306e7955bc8086b6fb8a95fa2227e760c8a7 (patch)
tree0402d4f847833564a69b58ea9fca38e97ab576be /nixos/modules/services/hardware
parente3aa635e68ca3cae0676229324cd7f04c0818601 (diff)
downloadnixlib-93a0306e7955bc8086b6fb8a95fa2227e760c8a7.tar
nixlib-93a0306e7955bc8086b6fb8a95fa2227e760c8a7.tar.gz
nixlib-93a0306e7955bc8086b6fb8a95fa2227e760c8a7.tar.bz2
nixlib-93a0306e7955bc8086b6fb8a95fa2227e760c8a7.tar.lz
nixlib-93a0306e7955bc8086b6fb8a95fa2227e760c8a7.tar.xz
nixlib-93a0306e7955bc8086b6fb8a95fa2227e760c8a7.tar.zst
nixlib-93a0306e7955bc8086b6fb8a95fa2227e760c8a7.zip
sane module: add more documentation
Imported from https://nixos.org/wiki/Scanners
Diffstat (limited to 'nixos/modules/services/hardware')
-rw-r--r--nixos/modules/services/hardware/sane.nix17
1 files changed, 15 insertions, 2 deletions
diff --git a/nixos/modules/services/hardware/sane.nix b/nixos/modules/services/hardware/sane.nix
index 56504cd2361d..a34037403123 100644
--- a/nixos/modules/services/hardware/sane.nix
+++ b/nixos/modules/services/hardware/sane.nix
@@ -21,7 +21,13 @@ in
     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 {
@@ -33,7 +39,14 @@ in
     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 {