diff options
Diffstat (limited to 'docs/docbook/smbdotconf/protocol')
24 files changed, 448 insertions, 0 deletions
diff --git a/docs/docbook/smbdotconf/protocol/announceas.xml b/docs/docbook/smbdotconf/protocol/announceas.xml new file mode 100644 index 0000000000..b063fcc1b7 --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/announceas.xml @@ -0,0 +1,21 @@ +<samba:parameter name="announce as" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This specifies what type of server <citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> will announce itself as, to a network neighborhood browse + list. By default this is set to Windows NT. The valid options + are : "NT Server" (which can also be written as "NT"), + "NT Workstation", "Win95" or "WfW" meaning Windows NT Server, + Windows NT Workstation, Windows 95 and Windows for Workgroups + respectively. Do not change this parameter unless you have a + specific need to stop Samba appearing as an NT server as this + may prevent Samba servers from participating as browser servers + correctly.</para> + + <para>Default: <command moreinfo="none">announce as = NT Server</command></para> + + <para>Example: <command moreinfo="none">announce as = Win95</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/announceversion.xml b/docs/docbook/smbdotconf/protocol/announceversion.xml new file mode 100644 index 0000000000..217004b5fc --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/announceversion.xml @@ -0,0 +1,15 @@ +<samba:parameter name="announce version" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This specifies the major and minor version numbers + that nmbd will use when announcing itself as a server. The default + is 4.9. Do not change this parameter unless you have a specific + need to set a Samba server to be a downlevel server.</para> + + <para>Default: <command moreinfo="none">announce version = 4.9</command></para> + + <para>Example: <command moreinfo="none">announce version = 2.0</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/disablenetbios.xml b/docs/docbook/smbdotconf/protocol/disablenetbios.xml new file mode 100644 index 0000000000..2fe92d00b7 --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/disablenetbios.xml @@ -0,0 +1,18 @@ +<samba:parameter name="disable netbios" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Enabling this parameter will disable netbios support + in Samba. Netbios is the only available form of browsing in + all windows versions except for 2000 and XP. </para> + + <note><para>Note that clients that only support netbios won't be able to + see your samba server when netbios support is disabled. + </para></note> + + <para>Default: <command moreinfo="none">disable netbios = no</command></para> + + <para>Example: <command moreinfo="none">disable netbios = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/largereadwrite.xml b/docs/docbook/smbdotconf/protocol/largereadwrite.xml new file mode 100644 index 0000000000..25c58899c4 --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/largereadwrite.xml @@ -0,0 +1,18 @@ +<samba:parameter name="large readwrite" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter determines whether or not + <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> supports the new 64k + streaming read and write varient SMB requests introduced with + Windows 2000. Note that due to Windows 2000 client redirector bugs + this requires Samba to be running on a 64-bit capable operating + system such as IRIX, Solaris or a Linux 2.4 kernel. Can improve + performance by 10% with Windows 2000 clients. Defaults to on. Not as + tested as some other Samba code paths.</para> + + <para>Default: <command moreinfo="none">large readwrite = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/maxmux.xml b/docs/docbook/smbdotconf/protocol/maxmux.xml new file mode 100644 index 0000000000..c05487fdca --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/maxmux.xml @@ -0,0 +1,12 @@ +<samba:parameter name="max mux" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option controls the maximum number of + outstanding simultaneous SMB operations that Samba tells the client + it will allow. You should never need to set this parameter.</para> + + <para>Default: <command moreinfo="none">max mux = 50</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/maxprotocol.xml b/docs/docbook/smbdotconf/protocol/maxprotocol.xml new file mode 100644 index 0000000000..3f4e917828 --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/maxprotocol.xml @@ -0,0 +1,48 @@ +<samba:parameter name="max protocol" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>The value of the parameter (a string) is the highest + protocol level that will be supported by the server.</para> + + <para>Possible values are :</para> + <itemizedlist> + <listitem> + <para><constant>CORE</constant>: Earliest version. No + concept of user names.</para> + </listitem> + + <listitem> + <para><constant>COREPLUS</constant>: Slight improvements on + CORE for efficiency.</para> + </listitem> + + <listitem> + <para><constant>LANMAN1</constant>: First <emphasis> + modern</emphasis> version of the protocol. Long filename + support.</para> + </listitem> + + <listitem> + <para><constant>LANMAN2</constant>: Updates to Lanman1 protocol.</para> + </listitem> + + <listitem> + <para><constant>NT1</constant>: Current up to date version of the protocol. + Used by Windows NT. Known as CIFS.</para> + </listitem> + </itemizedlist> + + <para>Normally this option should not be set as the automatic + negotiation phase in the SMB protocol takes care of choosing + the appropriate protocol.</para> + + <para>See also <link linkend="MINPROTOCOL"><parameter moreinfo="none">min + protocol</parameter></link></para> + + <para>Default: <command moreinfo="none">max protocol = NT1</command></para> + + <para>Example: <command moreinfo="none">max protocol = LANMAN1</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/maxttl.xml b/docs/docbook/smbdotconf/protocol/maxttl.xml new file mode 100644 index 0000000000..63c2b57ad7 --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/maxttl.xml @@ -0,0 +1,14 @@ +<samba:parameter name="max ttl" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option tells <citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> what the default 'time to live' + of NetBIOS names should be (in seconds) when <command moreinfo="none">nmbd</command> is + requesting a name using either a broadcast packet or from a WINS server. You should + never need to change this parameter. The default is 3 days.</para> + + <para>Default: <command moreinfo="none">max ttl = 259200</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/maxwinsttl.xml b/docs/docbook/smbdotconf/protocol/maxwinsttl.xml new file mode 100644 index 0000000000..eafacc28fa --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/maxwinsttl.xml @@ -0,0 +1,18 @@ +<samba:parameter name="max wins ttl" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option tells <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> when acting as a WINS server (<link linkend="WINSSUPPORT"> + <parameter moreinfo="none">wins support = yes</parameter></link>) what the maximum + 'time to live' of NetBIOS names that <command moreinfo="none">nmbd</command> + will grant will be (in seconds). You should never need to change this + parameter. The default is 6 days (518400 seconds).</para> + + <para>See also the <link linkend="MINWINSTTL"><parameter moreinfo="none">min + wins ttl</parameter></link> parameter.</para> + + <para>Default: <command moreinfo="none">max wins ttl = 518400</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/maxxmit.xml b/docs/docbook/smbdotconf/protocol/maxxmit.xml new file mode 100644 index 0000000000..3125b8d3b9 --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/maxxmit.xml @@ -0,0 +1,16 @@ +<samba:parameter name="max xmit" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option controls the maximum packet size + that will be negotiated by Samba. The default is 65535, which + is the maximum. In some cases you may find you get better performance + with a smaller value. A value below 2048 is likely to cause problems. + </para> + + <para>Default: <command moreinfo="none">max xmit = 65535</command></para> + + <para>Example: <command moreinfo="none">max xmit = 8192</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/minprotocol.xml b/docs/docbook/smbdotconf/protocol/minprotocol.xml new file mode 100644 index 0000000000..f382701948 --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/minprotocol.xml @@ -0,0 +1,23 @@ +<samba:parameter name="min protocol" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>The value of the parameter (a string) is the + lowest SMB protocol dialect than Samba will support. Please refer + to the <link linkend="MAXPROTOCOL"><parameter moreinfo="none">max protocol</parameter></link> + parameter for a list of valid protocol names and a brief description + of each. You may also wish to refer to the C source code in + <filename moreinfo="none">source/smbd/negprot.c</filename> for a listing of known protocol + dialects supported by clients.</para> + + <para>If you are viewing this parameter as a security measure, you should + also refer to the <link linkend="LANMANAUTH"><parameter moreinfo="none">lanman + auth</parameter></link> parameter. Otherwise, you should never need + to change this parameter.</para> + + <para>Default : <command moreinfo="none">min protocol = CORE</command></para> + + <para>Example : <command moreinfo="none">min protocol = NT1</command> # disable DOS clients</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/minwinsttl.xml b/docs/docbook/smbdotconf/protocol/minwinsttl.xml new file mode 100644 index 0000000000..8ad1a5600f --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/minwinsttl.xml @@ -0,0 +1,16 @@ +<samba:parameter name="min wins ttl" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option tells <citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> + when acting as a WINS server (<link linkend="WINSSUPPORT"><parameter moreinfo="none"> + wins support = yes</parameter></link>) what the minimum 'time to live' + of NetBIOS names that <command moreinfo="none">nmbd</command> will grant will be (in + seconds). You should never need to change this parameter. The default + is 6 hours (21600 seconds).</para> + + <para>Default: <command moreinfo="none">min wins ttl = 21600</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/nameresolveorder.xml b/docs/docbook/smbdotconf/protocol/nameresolveorder.xml new file mode 100644 index 0000000000..897d04ad1c --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/nameresolveorder.xml @@ -0,0 +1,58 @@ +<samba:parameter name="name resolve order" + context="G" + advanced="1" wizard="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option is used by the programs in the Samba + suite to determine what naming services to use and in what order + to resolve host names to IP addresses. The option takes a space + separated string of name resolution options.</para> + + <para>The options are: "lmhosts", "host", + "wins" and "bcast". They cause names to be + resolved as follows:</para> + + <itemizedlist> + <listitem> + <para><constant>lmhosts</constant> : Lookup an IP + address in the Samba lmhosts file. If the line in lmhosts has + no name type attached to the NetBIOS name (see the <ulink url="lmhosts.5.html">lmhosts(5)</ulink> for details) then + any name type matches for lookup.</para> + </listitem> + + <listitem> + <para><constant>host</constant> : Do a standard host + name to IP address resolution, using the system <filename moreinfo="none">/etc/hosts + </filename>, NIS, or DNS lookups. This method of name resolution + is operating system depended for instance on IRIX or Solaris this + may be controlled by the <filename moreinfo="none">/etc/nsswitch.conf</filename> + file. Note that this method is only used if the NetBIOS name + type being queried is the 0x20 (server) name type, otherwise + it is ignored.</para> + </listitem> + + <listitem> + <para><constant>wins</constant> : Query a name with + the IP address listed in the <link linkend="WINSSERVER"><parameter moreinfo="none"> + wins server</parameter></link> parameter. If no WINS server has + been specified this method will be ignored.</para> + </listitem> + + <listitem> + <para><constant>bcast</constant> : Do a broadcast on + each of the known local interfaces listed in the <link linkend="INTERFACES"><parameter moreinfo="none">interfaces</parameter></link> + parameter. This is the least reliable of the name resolution + methods as it depends on the target host being on a locally + connected subnet.</para> + </listitem> + </itemizedlist> + + <para>Default: <command moreinfo="none">name resolve order = lmhosts host wins bcast</command></para> + + <para>Example: <command moreinfo="none">name resolve order = lmhosts bcast host</command></para> + + <para>This will cause the local lmhosts file to be examined + first, followed by a broadcast attempt, followed by a normal + system hostname lookup.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/ntaclsupport.xml b/docs/docbook/smbdotconf/protocol/ntaclsupport.xml new file mode 100644 index 0000000000..64276d51c3 --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/ntaclsupport.xml @@ -0,0 +1,14 @@ +<samba:parameter name="nt acl support" + context="S" + advanced="1" wizard="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This boolean parameter controls whether <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> will attempt to map + UNIX permissions into Windows NT access control lists. + This parameter was formally a global parameter in releases + prior to 2.2.2.</para> + + <para>Default: <command moreinfo="none">nt acl support = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/ntpipesupport.xml b/docs/docbook/smbdotconf/protocol/ntpipesupport.xml new file mode 100644 index 0000000000..e5c42a7696 --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/ntpipesupport.xml @@ -0,0 +1,15 @@ +<samba:parameter name="nt pipe support" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This boolean parameter controls whether + <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> will allow Windows NT + clients to connect to the NT SMB specific <constant>IPC$</constant> + pipes. This is a developer debugging option and can be left + alone.</para> + + <para>Default: <command moreinfo="none">nt pipe support = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/ntstatussupport.xml b/docs/docbook/smbdotconf/protocol/ntstatussupport.xml new file mode 100644 index 0000000000..ecb19128ee --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/ntstatussupport.xml @@ -0,0 +1,17 @@ +<samba:parameter name="nt status support" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This boolean parameter controls whether <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> will negotiate NT specific status + support with Windows NT/2k/XP clients. This is a developer debugging option and should be left alone. + If this option is set to <constant>no</constant> then Samba offers + exactly the same DOS error codes that versions prior to Samba 2.2.3 + reported.</para> + + <para>You should not need to ever disable this parameter.</para> + + <para>Default: <command moreinfo="none">nt status support = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/protocol.xml b/docs/docbook/smbdotconf/protocol/protocol.xml new file mode 100644 index 0000000000..19926649c0 --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/protocol.xml @@ -0,0 +1,9 @@ +<samba:parameter name="protocol" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Synonym for <link linkend="MAXPROTOCOL"> + <parameter moreinfo="none">max protocol</parameter></link>.</para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/readbmpx.xml b/docs/docbook/smbdotconf/protocol/readbmpx.xml new file mode 100644 index 0000000000..0298407cef --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/readbmpx.xml @@ -0,0 +1,15 @@ +<samba:parameter name="read bmpx" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This boolean parameter controls whether + <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> will support the "Read + Block Multiplex" SMB. This is now rarely used and defaults to + <constant>no</constant>. You should never need to set this + parameter.</para> + + <para>Default: <command moreinfo="none">read bmpx = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/readraw.xml b/docs/docbook/smbdotconf/protocol/readraw.xml new file mode 100644 index 0000000000..6b24f39d68 --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/readraw.xml @@ -0,0 +1,24 @@ +<samba:parameter name="read raw" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter controls whether or not the server + will support the raw read SMB requests when transferring data + to clients.</para> + + <para>If enabled, raw reads allow reads of 65535 bytes in + one packet. This typically provides a major performance benefit. + </para> + + <para>However, some clients either negotiate the allowable + block size incorrectly or are incapable of supporting larger block + sizes, and for these clients you may need to disable raw reads.</para> + + <para>In general this parameter should be viewed as a system tuning + tool and left severely alone. See also <link linkend="WRITERAW"> + <parameter moreinfo="none">write raw</parameter></link>.</para> + + <para>Default: <command moreinfo="none">read raw = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/smbports.xml b/docs/docbook/smbdotconf/protocol/smbports.xml new file mode 100644 index 0000000000..9d06c37964 --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/smbports.xml @@ -0,0 +1,10 @@ +<samba:parameter name="smb ports" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Specifies which ports the server should listen on for SMB traffic.</para> + + <para>Default: <command moreinfo="none">smb ports = 445 139</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/timeserver.xml b/docs/docbook/smbdotconf/protocol/timeserver.xml new file mode 100644 index 0000000000..d78f9a456d --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/timeserver.xml @@ -0,0 +1,12 @@ +<samba:parameter name="time server" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter determines if <citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> advertises itself as a time server to Windows + clients.</para> + + <para>Default: <command moreinfo="none">time server = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/unicode.xml b/docs/docbook/smbdotconf/protocol/unicode.xml new file mode 100644 index 0000000000..be93cb61e2 --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/unicode.xml @@ -0,0 +1,13 @@ +<samba:parameter name="unicode" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>Specifies whether Samba should try + to use unicode on the wire by default. Note: This does NOT + mean that samba will assume that the unix machine uses unicode! + </para> + + <para>Default: <command moreinfo="none">unicode = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/unixextensions.xml b/docs/docbook/smbdotconf/protocol/unixextensions.xml new file mode 100644 index 0000000000..2f68b9605e --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/unixextensions.xml @@ -0,0 +1,15 @@ +<samba:parameter name="unix extensions" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This boolean parameter controls whether Samba + implments the CIFS UNIX extensions, as defined by HP. + These extensions enable Samba to better serve UNIX CIFS clients + by supporting features such as symbolic links, hard links, etc... + These extensions require a similarly enabled client, and are of + no current use to Windows clients.</para> + + <para>Default: <command moreinfo="none">unix extensions = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/usespnego.xml b/docs/docbook/smbdotconf/protocol/usespnego.xml new file mode 100644 index 0000000000..88c9f1df7a --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/usespnego.xml @@ -0,0 +1,15 @@ +<samba:parameter name="use spnego" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para> This variable controls controls whether samba will try + to use Simple and Protected NEGOciation (as specified by rfc2478) with + WindowsXP and Windows2000sp2 clients to agree upon an authentication mechanism. + Unless further issues are discovered with our SPNEGO + implementation, there is no reason this should ever be + disabled.</para> + + <para>Default: <emphasis>use spnego = yes</emphasis></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/protocol/writeraw.xml b/docs/docbook/smbdotconf/protocol/writeraw.xml new file mode 100644 index 0000000000..e71c54cabd --- /dev/null +++ b/docs/docbook/smbdotconf/protocol/writeraw.xml @@ -0,0 +1,12 @@ +<samba:parameter name="write raw" + context="G" + developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This parameter controls whether or not the server + will support raw write SMB's when transferring data from clients. + You should never need to change this parameter.</para> + + <para>Default: <command moreinfo="none">write raw = yes</command></para> +</listitem> +</samba:parameter> |