pyrox.dev
Merge pull request #13324 from zimbatm/doc-from-wiki
Converting the wiki to documentation
zimbatm.tngl.sh
+15
-2
nixos/modules/services/hardware/sane.nix
+15
-2
nixos/modules/services/hardware/sane.nix
···
21
21
hardware.sane.enable = mkOption {
22
22
type = types.bool;
23
23
default = false;
24
-
description = "Enable support for SANE scanners.";
24
+
description = ''
25
+
Enable support for SANE scanners.
26
+
27
+
<note><para>
28
+
Users in the "scanner" group will gain access to the scanner.
29
+
</para></note>
30
+
'';
25
31
};
26
32
27
33
hardware.sane.snapshot = mkOption {
···
33
39
hardware.sane.extraBackends = mkOption {
34
40
type = types.listOf types.path;
35
41
default = [];
36
-
description = "Packages providing extra SANE backends to enable.";
42
+
description = ''
43
+
Packages providing extra SANE backends to enable.
44
+
45
+
<note><para>
46
+
The example contains the package for HP scanners.
47
+
</para></note>
48
+
'';
49
+
example = literalExample "[ pkgs.hplipWithPlugin ]";
37
50
};
38
51
39
52
hardware.sane.configDir = mkOption {
+17
-3
nixos/modules/services/network-filesystems/samba.nix
+17
-3
nixos/modules/services/network-filesystems/samba.nix
···
79
79
description = ''
80
80
Whether to enable Samba, which provides file and print
81
81
services to Windows clients through the SMB/CIFS protocol.
82
+
83
+
<note>
84
+
<para>If you use the firewall consider adding the following:</para>
85
+
<programlisting>
86
+
networking.firewall.allowedTCPPorts = [ 139 445 ];
87
+
networking.firewall.allowedUDPPorts = [ 137 138 ];
88
+
</programlisting>
89
+
</note>
82
90
'';
83
91
};
84
92
···
86
94
type = types.package;
87
95
default = pkgs.samba;
88
96
defaultText = "pkgs.samba";
89
-
example = literalExample "pkgs.samba4";
97
+
example = literalExample "pkgs.samba3";
90
98
description = ''
91
99
Defines which package should be used for the samba server.
92
100
'';
···
118
126
description = ''
119
127
Additional global section and extra section lines go in here.
120
128
'';
129
+
example = ''
130
+
guest account = nobody
131
+
map to guest = bad user
132
+
'';
121
133
};
122
134
123
135
configText = mkOption {
···
154
166
'';
155
167
type = types.attrsOf (types.attrsOf types.unspecified);
156
168
example =
157
-
{ srv =
158
-
{ path = "/srv";
169
+
{ public =
170
+
{ path = "/srv/public";
159
171
"read only" = true;
172
+
browseable = "yes";
173
+
"guest ok" = "yes";
160
174
comment = "Public samba share.";
161
175
};
162
176
};