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/tuning/aioreadsize.xml | 22 +++++++ docs-xml/smbdotconf/tuning/aiowritesize.xml | 22 +++++++ .../smbdotconf/tuning/allocationroundupsize.xml | 20 ++++++ docs-xml/smbdotconf/tuning/blocksize.xml | 27 ++++++++ docs-xml/smbdotconf/tuning/deadtime.xml | 28 ++++++++ docs-xml/smbdotconf/tuning/getwdcache.xml | 13 ++++ docs-xml/smbdotconf/tuning/hostnamelookups.xml | 16 +++++ docs-xml/smbdotconf/tuning/keepalive.xml | 20 ++++++ docs-xml/smbdotconf/tuning/maxconnections.xml | 17 +++++ docs-xml/smbdotconf/tuning/maxdisksize.xml | 28 ++++++++ docs-xml/smbdotconf/tuning/maxopenfiles.xml | 20 ++++++ docs-xml/smbdotconf/tuning/maxsmbdprocesses.xml | 18 ++++++ docs-xml/smbdotconf/tuning/minprintspace.xml | 16 +++++ docs-xml/smbdotconf/tuning/namecachetimeout.xml | 15 +++++ .../smbdotconf/tuning/paranoidserversecurity.xml | 19 ++++++ docs-xml/smbdotconf/tuning/socketoptions.xml | 75 ++++++++++++++++++++++ docs-xml/smbdotconf/tuning/strictallocate.xml | 24 +++++++ docs-xml/smbdotconf/tuning/strictsync.xml | 24 +++++++ docs-xml/smbdotconf/tuning/syncalways.xml | 21 ++++++ docs-xml/smbdotconf/tuning/usemmap.xml | 18 ++++++ docs-xml/smbdotconf/tuning/usesendfile.xml | 17 +++++ docs-xml/smbdotconf/tuning/writecachesize.xml | 28 ++++++++ 22 files changed, 508 insertions(+) create mode 100644 docs-xml/smbdotconf/tuning/aioreadsize.xml create mode 100644 docs-xml/smbdotconf/tuning/aiowritesize.xml create mode 100644 docs-xml/smbdotconf/tuning/allocationroundupsize.xml create mode 100644 docs-xml/smbdotconf/tuning/blocksize.xml create mode 100644 docs-xml/smbdotconf/tuning/deadtime.xml create mode 100644 docs-xml/smbdotconf/tuning/getwdcache.xml create mode 100644 docs-xml/smbdotconf/tuning/hostnamelookups.xml create mode 100644 docs-xml/smbdotconf/tuning/keepalive.xml create mode 100644 docs-xml/smbdotconf/tuning/maxconnections.xml create mode 100644 docs-xml/smbdotconf/tuning/maxdisksize.xml create mode 100644 docs-xml/smbdotconf/tuning/maxopenfiles.xml create mode 100644 docs-xml/smbdotconf/tuning/maxsmbdprocesses.xml create mode 100644 docs-xml/smbdotconf/tuning/minprintspace.xml create mode 100644 docs-xml/smbdotconf/tuning/namecachetimeout.xml create mode 100644 docs-xml/smbdotconf/tuning/paranoidserversecurity.xml create mode 100644 docs-xml/smbdotconf/tuning/socketoptions.xml create mode 100644 docs-xml/smbdotconf/tuning/strictallocate.xml create mode 100644 docs-xml/smbdotconf/tuning/strictsync.xml create mode 100644 docs-xml/smbdotconf/tuning/syncalways.xml create mode 100644 docs-xml/smbdotconf/tuning/usemmap.xml create mode 100644 docs-xml/smbdotconf/tuning/usesendfile.xml create mode 100644 docs-xml/smbdotconf/tuning/writecachesize.xml (limited to 'docs-xml/smbdotconf/tuning') diff --git a/docs-xml/smbdotconf/tuning/aioreadsize.xml b/docs-xml/smbdotconf/tuning/aioreadsize.xml new file mode 100644 index 0000000000..082cf5ddfd --- /dev/null +++ b/docs-xml/smbdotconf/tuning/aioreadsize.xml @@ -0,0 +1,22 @@ + + + If Samba has been built with asynchronous I/O support and this + integer parameter is set to non-zero value, + Samba will read from file asynchronously when size of request is bigger + than this value. Note that it happens only for non-chained and non-chaining + reads and when not using write cache. + + Current implementation of asynchronous I/O in Samba 3.0 does support + only up to 10 outstanding asynchronous requests, read and write combined. + + write cache size + aio write size + + +0 +16384 Use asynchronous I/O for reads bigger than 16KB + request size + diff --git a/docs-xml/smbdotconf/tuning/aiowritesize.xml b/docs-xml/smbdotconf/tuning/aiowritesize.xml new file mode 100644 index 0000000000..e33a60e98e --- /dev/null +++ b/docs-xml/smbdotconf/tuning/aiowritesize.xml @@ -0,0 +1,22 @@ + + + If Samba has been built with asynchronous I/O support and this + integer parameter is set to non-zero value, + Samba will write to file asynchronously when size of request is bigger + than this value. Note that it happens only for non-chained and non-chaining + reads and when not using write cache. + + Current implementation of asynchronous I/O in Samba 3.0 does support + only up to 10 outstanding asynchronous requests, read and write combined. + + write cache size + aio read size + + +0 +16384 Use asynchronous I/O for writes bigger than 16KB + request size + diff --git a/docs-xml/smbdotconf/tuning/allocationroundupsize.xml b/docs-xml/smbdotconf/tuning/allocationroundupsize.xml new file mode 100644 index 0000000000..5fc013b5a0 --- /dev/null +++ b/docs-xml/smbdotconf/tuning/allocationroundupsize.xml @@ -0,0 +1,20 @@ + + + This parameter allows an administrator to tune the + allocation size reported to Windows clients. The default + size of 1Mb generally results in improved Windows client + performance. However, rounding the allocation size may cause + difficulties for some applications, e.g. MS Visual Studio. + If the MS Visual Studio compiler starts to crash with an + internal error, set this parameter to zero for this share. + + + The integer parameter specifies the roundup size in bytes. + + +1048576 +0(to disable roundups) + diff --git a/docs-xml/smbdotconf/tuning/blocksize.xml b/docs-xml/smbdotconf/tuning/blocksize.xml new file mode 100644 index 0000000000..1a0cc545a3 --- /dev/null +++ b/docs-xml/smbdotconf/tuning/blocksize.xml @@ -0,0 +1,27 @@ + + + This parameter controls the behavior of smbd + 8 when reporting disk free + sizes. By default, this reports a disk block size of 1024 bytes. + + + Changing this parameter may have some effect on the + efficiency of client writes, this is not yet confirmed. This + parameter was added to allow advanced administrators to change + it (usually to a higher value) and test the effect it has on + client write performance without re-compiling the code. As this + is an experimental option it may be removed in a future release. + + + Changing this option does not change the disk free reporting + size, just the block size unit reported to the client. + + + +1024 +4096 + + diff --git a/docs-xml/smbdotconf/tuning/deadtime.xml b/docs-xml/smbdotconf/tuning/deadtime.xml new file mode 100644 index 0000000000..51b76bd85a --- /dev/null +++ b/docs-xml/smbdotconf/tuning/deadtime.xml @@ -0,0 +1,28 @@ + + + The value of the parameter (a decimal integer) + represents the number of minutes of inactivity before a connection + is considered dead, and it is disconnected. The deadtime only takes + effect if the number of open files is zero. + + This is useful to stop a server's resources being + exhausted by a large number of inactive connections. + + Most clients have an auto-reconnect feature when a + connection is broken so in most cases this parameter should be + transparent to users. + + Using this parameter with a timeout of a few minutes + is recommended for most systems. + + A deadtime of zero indicates that no auto-disconnection + should be performed. + + +0 +15 + diff --git a/docs-xml/smbdotconf/tuning/getwdcache.xml b/docs-xml/smbdotconf/tuning/getwdcache.xml new file mode 100644 index 0000000000..74d30c28e5 --- /dev/null +++ b/docs-xml/smbdotconf/tuning/getwdcache.xml @@ -0,0 +1,13 @@ + + + This is a tuning option. When this is enabled a + caching algorithm will be used to reduce the time taken for getwd() + calls. This can have a significant impact on performance, especially + when the parameter is set to no. + + +yes + diff --git a/docs-xml/smbdotconf/tuning/hostnamelookups.xml b/docs-xml/smbdotconf/tuning/hostnamelookups.xml new file mode 100644 index 0000000000..68f4ec4f40 --- /dev/null +++ b/docs-xml/smbdotconf/tuning/hostnamelookups.xml @@ -0,0 +1,16 @@ + + + Specifies whether samba should use (expensive) + hostname lookups or use the ip addresses instead. An example place + where hostname lookups are currently used is when checking + the hosts deny and hosts allow. + + + +no +yes + diff --git a/docs-xml/smbdotconf/tuning/keepalive.xml b/docs-xml/smbdotconf/tuning/keepalive.xml new file mode 100644 index 0000000000..0586365512 --- /dev/null +++ b/docs-xml/smbdotconf/tuning/keepalive.xml @@ -0,0 +1,20 @@ + + + The value of the parameter (an integer) represents + the number of seconds between keepalive + packets. If this parameter is zero, no keepalive packets will be + sent. Keepalive packets, if sent, allow the server to tell whether + a client is still present and responding. + + Keepalives should, in general, not be needed if the socket + has the SO_KEEPALIVE attribute set on it by default. (see ). +Basically you should only use this option if you strike difficulties. + + +300 +600 + diff --git a/docs-xml/smbdotconf/tuning/maxconnections.xml b/docs-xml/smbdotconf/tuning/maxconnections.xml new file mode 100644 index 0000000000..1e3043b2f7 --- /dev/null +++ b/docs-xml/smbdotconf/tuning/maxconnections.xml @@ -0,0 +1,17 @@ + + + This option allows the number of simultaneous connections to a service to be limited. + If max connections is greater than 0 then connections + will be refused if this number of connections to the service are already open. A value + of zero mean an unlimited number of connections may be made. + + Record lock files are used to implement this feature. The lock files will be stored in + the directory specified by the option. + + +0 +10 + diff --git a/docs-xml/smbdotconf/tuning/maxdisksize.xml b/docs-xml/smbdotconf/tuning/maxdisksize.xml new file mode 100644 index 0000000000..ee53105a8a --- /dev/null +++ b/docs-xml/smbdotconf/tuning/maxdisksize.xml @@ -0,0 +1,28 @@ + + + This option allows you to put an upper limit + on the apparent size of disks. If you set this option to 100 + then all shares will appear to be not larger than 100 MB in + size. + + Note that this option does not limit the amount of + data you can put on the disk. In the above case you could still + store much more than 100 MB on the disk, but if a client ever asks + for the amount of free disk space or the total disk size then the + result will be bounded by the amount specified in max + disk size. + + This option is primarily useful to work around bugs + in some pieces of software that can't handle very large disks, + particularly disks over 1GB in size. + + A max disk size of 0 means no limit. + + +0 +1000 + diff --git a/docs-xml/smbdotconf/tuning/maxopenfiles.xml b/docs-xml/smbdotconf/tuning/maxopenfiles.xml new file mode 100644 index 0000000000..ea0a33980a --- /dev/null +++ b/docs-xml/smbdotconf/tuning/maxopenfiles.xml @@ -0,0 +1,20 @@ + + + This parameter limits the maximum number of + open files that one smbd + 8 file + serving process may have open for a client at any one time. The + default for this parameter is set very high (10,000) as Samba uses + only one bit per unopened file. + + The limit of the number of open files is usually set + by the UNIX per-process file descriptor limit rather than + this parameter so you should never need to touch this parameter. + + +10000 + diff --git a/docs-xml/smbdotconf/tuning/maxsmbdprocesses.xml b/docs-xml/smbdotconf/tuning/maxsmbdprocesses.xml new file mode 100644 index 0000000000..677d731aa9 --- /dev/null +++ b/docs-xml/smbdotconf/tuning/maxsmbdprocesses.xml @@ -0,0 +1,18 @@ + + + This parameter limits the maximum number of smbd + 8 processes concurrently running on a system and is intended + as a stopgap to prevent degrading service to clients in the event that the server has insufficient + resources to handle more than this number of connections. Remember that under normal operating + conditions, each user will have an smbd + 8 associated with him or her to handle connections to all + shares from a given host. + + +0 +1000 + diff --git a/docs-xml/smbdotconf/tuning/minprintspace.xml b/docs-xml/smbdotconf/tuning/minprintspace.xml new file mode 100644 index 0000000000..706e4a70cf --- /dev/null +++ b/docs-xml/smbdotconf/tuning/minprintspace.xml @@ -0,0 +1,16 @@ + + + This sets the minimum amount of free disk + space that must be available before a user will be able to spool + a print job. It is specified in kilobytes. The default is 0, which + means a user can always spool a print job. + + +printing +0 +2000 + diff --git a/docs-xml/smbdotconf/tuning/namecachetimeout.xml b/docs-xml/smbdotconf/tuning/namecachetimeout.xml new file mode 100644 index 0000000000..32ad55f1d0 --- /dev/null +++ b/docs-xml/smbdotconf/tuning/namecachetimeout.xml @@ -0,0 +1,15 @@ + + + Specifies the number of seconds it takes before + entries in samba's hostname resolve cache time out. If + the timeout is set to 0. the caching is disabled. + + + +660 +0 + diff --git a/docs-xml/smbdotconf/tuning/paranoidserversecurity.xml b/docs-xml/smbdotconf/tuning/paranoidserversecurity.xml new file mode 100644 index 0000000000..e5c2fe0ad1 --- /dev/null +++ b/docs-xml/smbdotconf/tuning/paranoidserversecurity.xml @@ -0,0 +1,19 @@ + + + Some version of NT 4.x allow non-guest + users with a bad passowrd. When this option is enabled, samba will not + use a broken NT 4.x server as password server, but instead complain + to the logs and exit. + + + Disabling this option prevents Samba from making + this check, which involves deliberatly attempting a + bad logon to the remote server. + + +yes + diff --git a/docs-xml/smbdotconf/tuning/socketoptions.xml b/docs-xml/smbdotconf/tuning/socketoptions.xml new file mode 100644 index 0000000000..7a5c221939 --- /dev/null +++ b/docs-xml/smbdotconf/tuning/socketoptions.xml @@ -0,0 +1,75 @@ + + + This option allows you to set socket options + to be used when talking with the client. + + Socket options are controls on the networking layer + of the operating systems which allow the connection to be + tuned. + + This option will typically be used to tune your Samba server + for optimal performance for your local network. There is no way + that Samba can know what the optimal parameters are for your net, + so you must experiment and choose them yourself. We strongly + suggest you read the appropriate documentation for your operating + system first (perhaps man + setsockopt will help). + + You may find that on some systems Samba will say + "Unknown socket option" when you supply an option. This means you + either incorrectly typed it or you need to add an include file + to includes.h for your OS. If the latter is the case please + send the patch to + samba-technical@samba.org. + + Any of the supported socket options may be combined + in any way you like, as long as your OS allows it. + + This is the list of socket options currently settable + using this option: + + + SO_KEEPALIVE + SO_REUSEADDR + SO_BROADCAST + TCP_NODELAY + IPTOS_LOWDELAY + IPTOS_THROUGHPUT + SO_SNDBUF * + SO_RCVBUF * + SO_SNDLOWAT * + SO_RCVLOWAT * + + + Those marked with a '*' take an integer + argument. The others can optionally take a 1 or 0 argument to enable + or disable the option, by default they will be enabled if you + don't specify 1 or 0. + + To specify an argument use the syntax SOME_OPTION = VALUE + for example SO_SNDBUF = 8192. Note that you must + not have any spaces before or after the = sign. + + If you are on a local network then a sensible option + might be: + + socket options = IPTOS_LOWDELAY + + If you have a local network then you could try: + + socket options = IPTOS_LOWDELAY TCP_NODELAY + + If you are on a wide area network then perhaps try + setting IPTOS_THROUGHPUT. + + Note that several of the options may cause your Samba + server to fail completely. Use these options with caution! + + +TCP_NODELAY +IPTOS_LOWDELAY + diff --git a/docs-xml/smbdotconf/tuning/strictallocate.xml b/docs-xml/smbdotconf/tuning/strictallocate.xml new file mode 100644 index 0000000000..2606f2028b --- /dev/null +++ b/docs-xml/smbdotconf/tuning/strictallocate.xml @@ -0,0 +1,24 @@ + + + This is a boolean that controls the handling of + disk space allocation in the server. When this is set to yes + the server will change from UNIX behaviour of not committing real + disk storage blocks when a file is extended to the Windows behaviour + of actually forcing the disk system to allocate real storage blocks + when a file is created or extended to be a given size. In UNIX + terminology this means that Samba will stop creating sparse files. + This can be slow on some systems. + + When strict allocate is no the server does sparse + disk block allocation when a file is extended. + + Setting this to yes can help Samba return + out of quota messages on systems that are restricting the disk quota + of users. + + +no + diff --git a/docs-xml/smbdotconf/tuning/strictsync.xml b/docs-xml/smbdotconf/tuning/strictsync.xml new file mode 100644 index 0000000000..0d33845513 --- /dev/null +++ b/docs-xml/smbdotconf/tuning/strictsync.xml @@ -0,0 +1,24 @@ + + + Many Windows applications (including the Windows 98 explorer + shell) seem to confuse flushing buffer contents to disk with doing + a sync to disk. Under UNIX, a sync call forces the process to be + suspended until the kernel has ensured that all outstanding data in + kernel disk buffers has been safely stored onto stable storage. + This is very slow and should only be done rarely. Setting this + parameter to no (the default) means that + smbd + 8 ignores the Windows + applications requests for a sync call. There is only a possibility + of losing data if the operating system itself that Samba is running + on crashes, so there is little danger in this default setting. In + addition, this fixes many performance problems that people have + reported with the new Windows98 explorer shell file copies. + + +sync always +no + diff --git a/docs-xml/smbdotconf/tuning/syncalways.xml b/docs-xml/smbdotconf/tuning/syncalways.xml new file mode 100644 index 0000000000..5d8eb2d568 --- /dev/null +++ b/docs-xml/smbdotconf/tuning/syncalways.xml @@ -0,0 +1,21 @@ + + + This is a boolean parameter that controls + whether writes will always be written to stable storage before + the write call returns. If this is no then the server will be + guided by the client's request in each write call (clients can + set a bit indicating that a particular write should be synchronous). + If this is yes then every write will be followed by a fsync() + call to ensure the data is written to disk. Note that + the strict sync parameter must be set to + yes in order for this parameter to have + any affect. + + +strict sync + +no + diff --git a/docs-xml/smbdotconf/tuning/usemmap.xml b/docs-xml/smbdotconf/tuning/usemmap.xml new file mode 100644 index 0000000000..c23fc35840 --- /dev/null +++ b/docs-xml/smbdotconf/tuning/usemmap.xml @@ -0,0 +1,18 @@ + + + This global parameter determines if the tdb internals of Samba can + depend on mmap working correctly on the running system. Samba requires a coherent + mmap/read-write system memory cache. Currently only HPUX does not have such a + coherent cache, and so this parameter is set to no by + default on HPUX. On all other systems this parameter should be left alone. This + parameter is provided to help the Samba developers track down problems with + the tdb internal code. + + + +yes + diff --git a/docs-xml/smbdotconf/tuning/usesendfile.xml b/docs-xml/smbdotconf/tuning/usesendfile.xml new file mode 100644 index 0000000000..e721531fed --- /dev/null +++ b/docs-xml/smbdotconf/tuning/usesendfile.xml @@ -0,0 +1,17 @@ + + + If this parameter is yes, and the sendfile() + system call is supported by the underlying operating system, then some SMB read calls + (mainly ReadAndX and ReadRaw) will use the more efficient sendfile system call for files that + are exclusively oplocked. This may make more efficient use of the system CPU's + and cause Samba to be faster. Samba automatically turns this off for clients + that use protocol levels lower than NT LM 0.12 and when it detects a client is + Windows 9x (using sendfile from Linux will cause these clients to fail). + + + +false + diff --git a/docs-xml/smbdotconf/tuning/writecachesize.xml b/docs-xml/smbdotconf/tuning/writecachesize.xml new file mode 100644 index 0000000000..12965b4048 --- /dev/null +++ b/docs-xml/smbdotconf/tuning/writecachesize.xml @@ -0,0 +1,28 @@ + + + If this integer parameter is set to non-zero value, + Samba will create an in-memory cache for each oplocked file + (it does not do this for + non-oplocked files). All writes that the client does not request + to be flushed directly to disk will be stored in this cache if possible. + The cache is flushed onto disk when a write comes in whose offset + would not fit into the cache or when the file is closed by the client. + Reads for the file are also served from this cache if the data is stored + within it. + + This cache allows Samba to batch client writes into a more + efficient write size for RAID disks (i.e. writes may be tuned to + be the RAID stripe size) and can improve performance on systems + where the disk subsystem is a bottleneck but there is free + memory for userspace programs. + + The integer parameter specifies the size of this cache + (per oplocked file) in bytes. + + +0 +262144 for a 256k cache size per file + -- cgit