Merge pull request #13324 from zimbatm/doc-from-wiki

Converting the wiki to documentation

zimbatm 76f5cf3f 8106d61c

Changed files
+32 -5
nixos
modules
services
hardware
network-filesystems
+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 {
+17 -3
nixos/modules/services/network-filesystems/samba.nix
···
description = ''
Whether to enable Samba, which provides file and print
services to Windows clients through the SMB/CIFS protocol.
+
+
<note>
+
<para>If you use the firewall consider adding the following:</para>
+
<programlisting>
+
networking.firewall.allowedTCPPorts = [ 139 445 ];
+
networking.firewall.allowedUDPPorts = [ 137 138 ];
+
</programlisting>
+
</note>
'';
};
···
type = types.package;
default = pkgs.samba;
defaultText = "pkgs.samba";
-
example = literalExample "pkgs.samba4";
+
example = literalExample "pkgs.samba3";
description = ''
Defines which package should be used for the samba server.
'';
···
description = ''
Additional global section and extra section lines go in here.
'';
+
example = ''
+
guest account = nobody
+
map to guest = bad user
+
'';
};
configText = mkOption {
···
'';
type = types.attrsOf (types.attrsOf types.unspecified);
example =
-
{ srv =
-
{ path = "/srv";
+
{ public =
+
{ path = "/srv/public";
"read only" = true;
+
browseable = "yes";
+
"guest ok" = "yes";
comment = "Public samba share.";
};
};