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

Converting the wiki to documentation

+32 -5
+15 -2
nixos/modules/services/hardware/sane.nix
··· 21 hardware.sane.enable = mkOption { 22 type = types.bool; 23 default = false; 24 - description = "Enable support for SANE scanners."; 25 }; 26 27 hardware.sane.snapshot = mkOption { ··· 33 hardware.sane.extraBackends = mkOption { 34 type = types.listOf types.path; 35 default = []; 36 - description = "Packages providing extra SANE backends to enable."; 37 }; 38 39 hardware.sane.configDir = mkOption {
··· 21 hardware.sane.enable = mkOption { 22 type = types.bool; 23 default = false; 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 + ''; 31 }; 32 33 hardware.sane.snapshot = mkOption { ··· 39 hardware.sane.extraBackends = mkOption { 40 type = types.listOf types.path; 41 default = []; 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 ]"; 50 }; 51 52 hardware.sane.configDir = mkOption {
+17 -3
nixos/modules/services/network-filesystems/samba.nix
··· 79 description = '' 80 Whether to enable Samba, which provides file and print 81 services to Windows clients through the SMB/CIFS protocol. 82 ''; 83 }; 84 ··· 86 type = types.package; 87 default = pkgs.samba; 88 defaultText = "pkgs.samba"; 89 - example = literalExample "pkgs.samba4"; 90 description = '' 91 Defines which package should be used for the samba server. 92 ''; ··· 118 description = '' 119 Additional global section and extra section lines go in here. 120 ''; 121 }; 122 123 configText = mkOption { ··· 154 ''; 155 type = types.attrsOf (types.attrsOf types.unspecified); 156 example = 157 - { srv = 158 - { path = "/srv"; 159 "read only" = true; 160 comment = "Public samba share."; 161 }; 162 };
··· 79 description = '' 80 Whether to enable Samba, which provides file and print 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> 90 ''; 91 }; 92 ··· 94 type = types.package; 95 default = pkgs.samba; 96 defaultText = "pkgs.samba"; 97 + example = literalExample "pkgs.samba3"; 98 description = '' 99 Defines which package should be used for the samba server. 100 ''; ··· 126 description = '' 127 Additional global section and extra section lines go in here. 128 ''; 129 + example = '' 130 + guest account = nobody 131 + map to guest = bad user 132 + ''; 133 }; 134 135 configText = mkOption { ··· 166 ''; 167 type = types.attrsOf (types.attrsOf types.unspecified); 168 example = 169 + { public = 170 + { path = "/srv/public"; 171 "read only" = true; 172 + browseable = "yes"; 173 + "guest ok" = "yes"; 174 comment = "Public samba share."; 175 }; 176 };