From 8f8a9f01909ba29e2b781310baeeaaddc3f15f0d Mon Sep 17 00:00:00 2001 From: "Gerald W. Carter" Date: Tue, 22 Apr 2008 10:09:40 -0500 Subject: Moving docs tree to docs-xml to make room for generated docs in the release tarball. (This used to be commit 9f672c26d63955f613088489c6efbdc08b5b2d14) --- docs-xml/smbdotconf/base/bindinterfacesonly.xml | 69 +++++++++++++++++++++++++ docs-xml/smbdotconf/base/comment.xml | 18 +++++++ docs-xml/smbdotconf/base/configbackend.xml | 26 ++++++++++ docs-xml/smbdotconf/base/displaycharset.xml | 17 ++++++ docs-xml/smbdotconf/base/doscharset.xml | 17 ++++++ docs-xml/smbdotconf/base/interfaces.xml | 55 ++++++++++++++++++++ docs-xml/smbdotconf/base/netbiosaliases.xml | 17 ++++++ docs-xml/smbdotconf/base/netbiosname.xml | 22 ++++++++ docs-xml/smbdotconf/base/netbiosscope.xml | 12 +++++ docs-xml/smbdotconf/base/path.xml | 31 +++++++++++ docs-xml/smbdotconf/base/realm.xml | 15 ++++++ docs-xml/smbdotconf/base/serverstring.xml | 21 ++++++++ docs-xml/smbdotconf/base/unixcharset.xml | 19 +++++++ docs-xml/smbdotconf/base/workgroup.xml | 15 ++++++ 14 files changed, 354 insertions(+) create mode 100644 docs-xml/smbdotconf/base/bindinterfacesonly.xml create mode 100644 docs-xml/smbdotconf/base/comment.xml create mode 100644 docs-xml/smbdotconf/base/configbackend.xml create mode 100644 docs-xml/smbdotconf/base/displaycharset.xml create mode 100644 docs-xml/smbdotconf/base/doscharset.xml create mode 100644 docs-xml/smbdotconf/base/interfaces.xml create mode 100644 docs-xml/smbdotconf/base/netbiosaliases.xml create mode 100644 docs-xml/smbdotconf/base/netbiosname.xml create mode 100644 docs-xml/smbdotconf/base/netbiosscope.xml create mode 100644 docs-xml/smbdotconf/base/path.xml create mode 100644 docs-xml/smbdotconf/base/realm.xml create mode 100644 docs-xml/smbdotconf/base/serverstring.xml create mode 100644 docs-xml/smbdotconf/base/unixcharset.xml create mode 100644 docs-xml/smbdotconf/base/workgroup.xml (limited to 'docs-xml/smbdotconf/base') diff --git a/docs-xml/smbdotconf/base/bindinterfacesonly.xml b/docs-xml/smbdotconf/base/bindinterfacesonly.xml new file mode 100644 index 0000000000..bccac4a0da --- /dev/null +++ b/docs-xml/smbdotconf/base/bindinterfacesonly.xml @@ -0,0 +1,69 @@ + + + This global parameter allows the Samba admin + to limit what interfaces on a machine will serve SMB requests. It + affects file service smbd + 8 and name service nmbd + 8 in a slightly different ways. + + + For name service it causes nmbd to bind to ports 137 and 138 on the + interfaces listed in the parameter. nmbd + also binds to the "all addresses" interface (0.0.0.0) on ports 137 and 138 for the purposes of + reading broadcast messages. If this option is not set then nmbd will + service name requests on all of these sockets. If is set then + nmbd will check the source address of any packets coming in on the + broadcast sockets and discard any that don't match the broadcast addresses of the interfaces in the + parameter list. As unicast packets are received on the other sockets it + allows nmbd to refuse to serve names to machines that send packets that + arrive through any interfaces not listed in the list. IP Source address + spoofing does defeat this simple check, however, so it must not be used seriously as a security feature for + nmbd. + + + + For file service it causes smbd + 8 to bind only to the interface list given in the parameter. This restricts the networks that smbd will + serve to packets coming in those interfaces. Note that you should not use this parameter for machines that + are serving PPP or other intermittent or non-broadcast network interfaces as it will not cope with + non-permanent interfaces. + + + + If is set then unless the network address + 127.0.0.1 is added to the parameter list + smbpasswd 8 and + swat 8 may not work as + expected due to the reasons covered below. + + + + To change a users SMB password, the smbpasswd by default connects to the + localhost - 127.0.0.1 address as an SMB client to issue the password change request. If + is set then unless the network address + 127.0.0.1 is added to the parameter list then smbpasswd will fail to connect in it's default mode. smbpasswd can be forced to use the primary IP interface of the local host by using + its smbpasswd 8 -r remote machine parameter, with remote + machine set to the IP name of the primary interface of the local host. + + + + The swat status page tries to connect with smbd and nmbd at the address + 127.0.0.1 to determine if they are running. Not adding 127.0.0.1 + will cause smbd and nmbd to always show + "not running" even if they really are. This can prevent swat + from starting/stopping/restarting smbd and nmbd. + + + +no + diff --git a/docs-xml/smbdotconf/base/comment.xml b/docs-xml/smbdotconf/base/comment.xml new file mode 100644 index 0000000000..ce3b574ddf --- /dev/null +++ b/docs-xml/smbdotconf/base/comment.xml @@ -0,0 +1,18 @@ + + + This is a text field that is seen next to a share + when a client does a queries the server, either via the network + neighborhood or via net view to list what shares + are available. + + If you want to set the string that is displayed next to the + machine name then see the parameter. + + +No comment +Fred's Files + diff --git a/docs-xml/smbdotconf/base/configbackend.xml b/docs-xml/smbdotconf/base/configbackend.xml new file mode 100644 index 0000000000..f9da134555 --- /dev/null +++ b/docs-xml/smbdotconf/base/configbackend.xml @@ -0,0 +1,26 @@ + + + + This controls the backend for storing the configuration. + Possible values are file (the default) + and registry. + When registry + is encountered while loading smb.conf, + the configuration read so far is dropped and the global + options are read from registry instead. So this triggers a + registry only configuration. Share definitions are not read + immediately but instead registry + shares is set to yes. + + + Note: This option can not be set inside the registry + configuration itself. + + +file +registry + diff --git a/docs-xml/smbdotconf/base/displaycharset.xml b/docs-xml/smbdotconf/base/displaycharset.xml new file mode 100644 index 0000000000..5bace5b6b0 --- /dev/null +++ b/docs-xml/smbdotconf/base/displaycharset.xml @@ -0,0 +1,17 @@ + + + + Specifies the charset that samba will use to print messages to stdout and stderr. + The default value is "LOCALE", which means automatically set, depending on the + current locale. The value should generally be the same as the value of the parameter + . + + + +"LOCALE" or "ASCII" (depending on the system) +UTF8 + diff --git a/docs-xml/smbdotconf/base/doscharset.xml b/docs-xml/smbdotconf/base/doscharset.xml new file mode 100644 index 0000000000..4b5872ce38 --- /dev/null +++ b/docs-xml/smbdotconf/base/doscharset.xml @@ -0,0 +1,17 @@ + + + DOS SMB clients assume the server has + the same charset as they do. This option specifies which + charset Samba should talk to DOS clients. + + + The default depends on which charsets you have installed. + Samba tries to use charset 850 but falls back to ASCII in + case it is not available. Run testparm + 1 to check the default on your system. + + diff --git a/docs-xml/smbdotconf/base/interfaces.xml b/docs-xml/smbdotconf/base/interfaces.xml new file mode 100644 index 0000000000..2b13200ea6 --- /dev/null +++ b/docs-xml/smbdotconf/base/interfaces.xml @@ -0,0 +1,55 @@ + + + This option allows you to override the default + network interfaces list that Samba will use for browsing, name + registration and other NBT traffic. By default Samba will query + the kernel for the list of all active interfaces and use any + interfaces except 127.0.0.1 that are broadcast capable. + + The option takes a list of interface strings. Each string + can be in any of the following forms: + + + a network interface name (such as eth0). + This may include shell-like wildcards so eth* will match + any interface starting with the substring "eth" + + an IP address. In this case the netmask is + determined from the list of interfaces obtained from the + kernel + + an IP/mask pair. + + a broadcast/mask pair. + + + The "mask" parameters can either be a bit length (such + as 24 for a C class network) or a full netmask in dotted + decimal form. + + The "IP" parameters above can either be a full dotted + decimal IP address or a hostname which will be looked up via + the OS's normal hostname resolution mechanisms. + + + By default Samba enables all active interfaces that are broadcast capable + except the loopback adaptor (IP address 127.0.0.1). + + + + The example below configures three network interfaces corresponding + to the eth0 device and IP addresses 192.168.2.10 and 192.168.3.10. + The netmasks of the latter two interfaces would be set to 255.255.255.0. + + + +bind interfaces only + +eth0 192.168.2.10/24 192.168.3.10/255.255.255.0 + + + diff --git a/docs-xml/smbdotconf/base/netbiosaliases.xml b/docs-xml/smbdotconf/base/netbiosaliases.xml new file mode 100644 index 0000000000..5d58fc2397 --- /dev/null +++ b/docs-xml/smbdotconf/base/netbiosaliases.xml @@ -0,0 +1,17 @@ + + + This is a list of NetBIOS names that nmbd will + advertise as additional names by which the Samba server is known. This allows one machine + to appear in browse lists under multiple names. If a machine is acting as a browse server + or logon server none of these names will be advertised as either browse server or logon + servers, only the primary name of the machine will be advertised with these capabilities. + + +netbios name +empty string (no additional names) +TEST TEST1 TEST2 + diff --git a/docs-xml/smbdotconf/base/netbiosname.xml b/docs-xml/smbdotconf/base/netbiosname.xml new file mode 100644 index 0000000000..3e00bf16b9 --- /dev/null +++ b/docs-xml/smbdotconf/base/netbiosname.xml @@ -0,0 +1,22 @@ + + + + This sets the NetBIOS name by which a Samba server is known. By default it is the same as the first component + of the host's DNS name. If a machine is a browse server or logon server this name (or the first component of + the hosts DNS name) will be the name that these services are advertised under. + + + + There is a bug in Samba-3 that breaks operation of browsing and access to shares if the netbios name + is set to the literal name PIPE. To avoid this problem, do not name your Samba-3 + server PIPE. + + + +netbios aliases +machine DNS name +MYNAME + diff --git a/docs-xml/smbdotconf/base/netbiosscope.xml b/docs-xml/smbdotconf/base/netbiosscope.xml new file mode 100644 index 0000000000..253d0b5a16 --- /dev/null +++ b/docs-xml/smbdotconf/base/netbiosscope.xml @@ -0,0 +1,12 @@ + + + This sets the NetBIOS scope that Samba will + operate under. This should not be set unless every machine + on your LAN also sets this value. + + + diff --git a/docs-xml/smbdotconf/base/path.xml b/docs-xml/smbdotconf/base/path.xml new file mode 100644 index 0000000000..7828e62441 --- /dev/null +++ b/docs-xml/smbdotconf/base/path.xml @@ -0,0 +1,31 @@ + +directory + + This parameter specifies a directory to which + the user of the service is to be given access. In the case of + printable services, this is where print data will spool prior to + being submitted to the host for printing. + + For a printable service offering guest access, the service + should be readonly and the path should be world-writeable and + have the sticky bit set. This is not mandatory of course, but + you probably won't get the results you expect if you do + otherwise. + + Any occurrences of %u in the path + will be replaced with the UNIX username that the client is using + on this connection. Any occurrences of %m + will be replaced by the NetBIOS name of the machine they are + connecting from. These replacements are very useful for setting + up pseudo home directories for users. + +Note that this path will be based on + if one was specified. + + + + /home/fred + diff --git a/docs-xml/smbdotconf/base/realm.xml b/docs-xml/smbdotconf/base/realm.xml new file mode 100644 index 0000000000..98c7e285e6 --- /dev/null +++ b/docs-xml/smbdotconf/base/realm.xml @@ -0,0 +1,15 @@ + + + This option specifies the kerberos realm to use. The realm is + used as the ADS equivalent of the NT4 domain. It + is usually set to the DNS name of the kerberos server. + + + + +mysambabox.mycompany.com + diff --git a/docs-xml/smbdotconf/base/serverstring.xml b/docs-xml/smbdotconf/base/serverstring.xml new file mode 100644 index 0000000000..275e31ac49 --- /dev/null +++ b/docs-xml/smbdotconf/base/serverstring.xml @@ -0,0 +1,21 @@ + + + This controls what string will show up in the printer comment box in print + manager and next to the IPC connection in net view. It + can be any string that you wish to show to your users. + + It also sets what will appear in browse lists next + to the machine name. + + A %v will be replaced with the Samba + version number. + + A %h will be replaced with the + hostname. + +Samba %v +University of GNUs Samba Server + diff --git a/docs-xml/smbdotconf/base/unixcharset.xml b/docs-xml/smbdotconf/base/unixcharset.xml new file mode 100644 index 0000000000..c4032c2ea2 --- /dev/null +++ b/docs-xml/smbdotconf/base/unixcharset.xml @@ -0,0 +1,19 @@ + + + Specifies the charset the unix machine + Samba runs on uses. Samba needs to know this in order to be able to + convert text to the charsets other SMB clients use. + + + This is also the charset Samba will use when specifying arguments + to scripts that it invokes. + + + +UTF8 +ASCII + diff --git a/docs-xml/smbdotconf/base/workgroup.xml b/docs-xml/smbdotconf/base/workgroup.xml new file mode 100644 index 0000000000..d62c3d5e12 --- /dev/null +++ b/docs-xml/smbdotconf/base/workgroup.xml @@ -0,0 +1,15 @@ + + + This controls what workgroup your server will + appear to be in when queried by clients. Note that this parameter + also controls the Domain name used with + the domain + setting. + +WORKGROUP +MYGROUP + -- cgit