From 510064b14e8fddafe615f8c707023fcc3f84f094 Mon Sep 17 00:00:00 2001 From: Gerald Carter Date: Fri, 10 Oct 2003 16:21:39 +0000 Subject: removing docs from HEAD (This used to be commit 820903ef5a062b4b9824c33ee035c68a39c8eeb0) --- docs/docbook/smbdotconf/tuning/blocksize.xml | 22 ------- .../smbdotconf/tuning/changenotifytimeout.xml | 20 ------ docs/docbook/smbdotconf/tuning/deadtime.xml | 27 -------- docs/docbook/smbdotconf/tuning/getwdcache.xml | 14 ---- docs/docbook/smbdotconf/tuning/hostnamelookups.xml | 16 ----- docs/docbook/smbdotconf/tuning/keepalive.xml | 21 ------ docs/docbook/smbdotconf/tuning/maxconnections.xml | 18 ------ docs/docbook/smbdotconf/tuning/maxdisksize.xml | 28 -------- docs/docbook/smbdotconf/tuning/maxopenfiles.xml | 19 ------ .../docbook/smbdotconf/tuning/maxsmbdprocesses.xml | 18 ------ docs/docbook/smbdotconf/tuning/minprintspace.xml | 18 ------ .../docbook/smbdotconf/tuning/namecachetimeout.xml | 15 ----- .../smbdotconf/tuning/paranoidserversecurity.xml | 18 ------ docs/docbook/smbdotconf/tuning/readsize.xml | 29 --------- docs/docbook/smbdotconf/tuning/socketoptions.xml | 75 ---------------------- docs/docbook/smbdotconf/tuning/strictallocate.xml | 23 ------- docs/docbook/smbdotconf/tuning/strictsync.xml | 25 -------- docs/docbook/smbdotconf/tuning/syncalways.xml | 21 ------ docs/docbook/smbdotconf/tuning/usemmap.xml | 17 ----- docs/docbook/smbdotconf/tuning/usesendfile.xml | 15 ----- docs/docbook/smbdotconf/tuning/writecachesize.xml | 30 --------- 21 files changed, 489 deletions(-) delete mode 100644 docs/docbook/smbdotconf/tuning/blocksize.xml delete mode 100644 docs/docbook/smbdotconf/tuning/changenotifytimeout.xml delete mode 100644 docs/docbook/smbdotconf/tuning/deadtime.xml delete mode 100644 docs/docbook/smbdotconf/tuning/getwdcache.xml delete mode 100644 docs/docbook/smbdotconf/tuning/hostnamelookups.xml delete mode 100644 docs/docbook/smbdotconf/tuning/keepalive.xml delete mode 100644 docs/docbook/smbdotconf/tuning/maxconnections.xml delete mode 100644 docs/docbook/smbdotconf/tuning/maxdisksize.xml delete mode 100644 docs/docbook/smbdotconf/tuning/maxopenfiles.xml delete mode 100644 docs/docbook/smbdotconf/tuning/maxsmbdprocesses.xml delete mode 100644 docs/docbook/smbdotconf/tuning/minprintspace.xml delete mode 100644 docs/docbook/smbdotconf/tuning/namecachetimeout.xml delete mode 100644 docs/docbook/smbdotconf/tuning/paranoidserversecurity.xml delete mode 100644 docs/docbook/smbdotconf/tuning/readsize.xml delete mode 100644 docs/docbook/smbdotconf/tuning/socketoptions.xml delete mode 100644 docs/docbook/smbdotconf/tuning/strictallocate.xml delete mode 100644 docs/docbook/smbdotconf/tuning/strictsync.xml delete mode 100644 docs/docbook/smbdotconf/tuning/syncalways.xml delete mode 100644 docs/docbook/smbdotconf/tuning/usemmap.xml delete mode 100644 docs/docbook/smbdotconf/tuning/usesendfile.xml delete mode 100644 docs/docbook/smbdotconf/tuning/writecachesize.xml (limited to 'docs/docbook/smbdotconf/tuning') diff --git a/docs/docbook/smbdotconf/tuning/blocksize.xml b/docs/docbook/smbdotconf/tuning/blocksize.xml deleted file mode 100644 index eecf1925e8..0000000000 --- a/docs/docbook/smbdotconf/tuning/blocksize.xml +++ /dev/null @@ -1,22 +0,0 @@ - - - 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. - - - diff --git a/docs/docbook/smbdotconf/tuning/changenotifytimeout.xml b/docs/docbook/smbdotconf/tuning/changenotifytimeout.xml deleted file mode 100644 index 471798c269..0000000000 --- a/docs/docbook/smbdotconf/tuning/changenotifytimeout.xml +++ /dev/null @@ -1,20 +0,0 @@ - - - This SMB allows a client to tell a server to - "watch" a particular directory for any changes and only reply to - the SMB request when a change has occurred. Such constant scanning of - a directory is expensive under UNIX, hence an smbd - 8 daemon only performs such a scan - on each requested directory once every change notify - timeout seconds. - - Default: change notify timeout = 60 - - Example: change notify timeout = 300 - - Would change the scan time to every 5 minutes. - - diff --git a/docs/docbook/smbdotconf/tuning/deadtime.xml b/docs/docbook/smbdotconf/tuning/deadtime.xml deleted file mode 100644 index 938f354b9a..0000000000 --- a/docs/docbook/smbdotconf/tuning/deadtime.xml +++ /dev/null @@ -1,27 +0,0 @@ - - - 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. - - Default: deadtime = 0 - Example: deadtime = 15 - - diff --git a/docs/docbook/smbdotconf/tuning/getwdcache.xml b/docs/docbook/smbdotconf/tuning/getwdcache.xml deleted file mode 100644 index 8c22be9fb5..0000000000 --- a/docs/docbook/smbdotconf/tuning/getwdcache.xml +++ /dev/null @@ -1,14 +0,0 @@ - - - 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 wide links - parameter is set to no. - - Default: getwd cache = yes - - diff --git a/docs/docbook/smbdotconf/tuning/hostnamelookups.xml b/docs/docbook/smbdotconf/tuning/hostnamelookups.xml deleted file mode 100644 index 613fabe42f..0000000000 --- a/docs/docbook/smbdotconf/tuning/hostnamelookups.xml +++ /dev/null @@ -1,16 +0,0 @@ - - - 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. - - - Default: hostname lookups = yes - - Example: hostname lookups = no - - diff --git a/docs/docbook/smbdotconf/tuning/keepalive.xml b/docs/docbook/smbdotconf/tuning/keepalive.xml deleted file mode 100644 index 1320dfab61..0000000000 --- a/docs/docbook/smbdotconf/tuning/keepalive.xml +++ /dev/null @@ -1,21 +0,0 @@ - - - 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 - being used has the SO_KEEPALIVE attribute set on it (see - socket options). - Basically you should only use this option if you strike difficulties. - - Default: keepalive = 300 - - Example: keepalive = 600 - - diff --git a/docs/docbook/smbdotconf/tuning/maxconnections.xml b/docs/docbook/smbdotconf/tuning/maxconnections.xml deleted file mode 100644 index 5127df06f4..0000000000 --- a/docs/docbook/smbdotconf/tuning/maxconnections.xml +++ /dev/null @@ -1,18 +0,0 @@ - - - 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 - lock directory option. - - Default: max connections = 0 - - Example: max connections = 10 - - diff --git a/docs/docbook/smbdotconf/tuning/maxdisksize.xml b/docs/docbook/smbdotconf/tuning/maxdisksize.xml deleted file mode 100644 index 7d99b31e03..0000000000 --- a/docs/docbook/smbdotconf/tuning/maxdisksize.xml +++ /dev/null @@ -1,28 +0,0 @@ - - - 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. - - Default: max disk size = 0 - - Example: max disk size = 1000 - - diff --git a/docs/docbook/smbdotconf/tuning/maxopenfiles.xml b/docs/docbook/smbdotconf/tuning/maxopenfiles.xml deleted file mode 100644 index 9505b2aaa5..0000000000 --- a/docs/docbook/smbdotconf/tuning/maxopenfiles.xml +++ /dev/null @@ -1,19 +0,0 @@ - - - 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. - - Default: max open files = 10000 - - diff --git a/docs/docbook/smbdotconf/tuning/maxsmbdprocesses.xml b/docs/docbook/smbdotconf/tuning/maxsmbdprocesses.xml deleted file mode 100644 index 453818ab7d..0000000000 --- a/docs/docbook/smbdotconf/tuning/maxsmbdprocesses.xml +++ /dev/null @@ -1,18 +0,0 @@ - - - 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. - - Default: max smbd processes = 0 ## no limit - - Example: max smbd processes = 1000 - - diff --git a/docs/docbook/smbdotconf/tuning/minprintspace.xml b/docs/docbook/smbdotconf/tuning/minprintspace.xml deleted file mode 100644 index 0df75af0ab..0000000000 --- a/docs/docbook/smbdotconf/tuning/minprintspace.xml +++ /dev/null @@ -1,18 +0,0 @@ - - - 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. - - See also the printing - parameter. - - Default: min print space = 0 - - Example: min print space = 2000 - - diff --git a/docs/docbook/smbdotconf/tuning/namecachetimeout.xml b/docs/docbook/smbdotconf/tuning/namecachetimeout.xml deleted file mode 100644 index 6330760915..0000000000 --- a/docs/docbook/smbdotconf/tuning/namecachetimeout.xml +++ /dev/null @@ -1,15 +0,0 @@ - - - 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. - - - Default: name cache timeout = 660 - - Example: name cache timeout = 0 - - diff --git a/docs/docbook/smbdotconf/tuning/paranoidserversecurity.xml b/docs/docbook/smbdotconf/tuning/paranoidserversecurity.xml deleted file mode 100644 index 3fababf01b..0000000000 --- a/docs/docbook/smbdotconf/tuning/paranoidserversecurity.xml +++ /dev/null @@ -1,18 +0,0 @@ - - - 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. - - Default: paranoid server security = yes - - diff --git a/docs/docbook/smbdotconf/tuning/readsize.xml b/docs/docbook/smbdotconf/tuning/readsize.xml deleted file mode 100644 index c76b810225..0000000000 --- a/docs/docbook/smbdotconf/tuning/readsize.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - The option read size - affects the overlap of disk reads/writes with network reads/writes. - If the amount of data being transferred in several of the SMB - commands (currently SMBwrite, SMBwriteX and SMBreadbraw) is larger - than this value then the server begins writing the data before it - has received the whole packet from the network, or in the case of - SMBreadbraw, it begins writing to the network before all the data - has been read from disk. - - This overlapping works best when the speeds of disk and - network access are similar, having very little effect when the - speed of one is much greater than the other. - - The default value is 16384, but very little experimentation - has been done yet to determine the optimal value, and it is likely - that the best value will vary greatly between systems anyway. - A value over 65536 is pointless and will cause you to allocate - memory unnecessarily. - - Default: read size = 16384 - - Example: read size = 8192 - - diff --git a/docs/docbook/smbdotconf/tuning/socketoptions.xml b/docs/docbook/smbdotconf/tuning/socketoptions.xml deleted file mode 100644 index 5684ac5bca..0000000000 --- a/docs/docbook/smbdotconf/tuning/socketoptions.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - 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! - - Default: socket options = TCP_NODELAY - - Example: socket options = IPTOS_LOWDELAY - - diff --git a/docs/docbook/smbdotconf/tuning/strictallocate.xml b/docs/docbook/smbdotconf/tuning/strictallocate.xml deleted file mode 100644 index 0d11519b04..0000000000 --- a/docs/docbook/smbdotconf/tuning/strictallocate.xml +++ /dev/null @@ -1,23 +0,0 @@ - - - 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. - - Default: strict allocate = no - - diff --git a/docs/docbook/smbdotconf/tuning/strictsync.xml b/docs/docbook/smbdotconf/tuning/strictsync.xml deleted file mode 100644 index 18e778e093..0000000000 --- a/docs/docbook/smbdotconf/tuning/strictsync.xml +++ /dev/null @@ -1,25 +0,0 @@ - - - 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. - - See also the sync - always parameter. - - Default: strict sync = no - - diff --git a/docs/docbook/smbdotconf/tuning/syncalways.xml b/docs/docbook/smbdotconf/tuning/syncalways.xml deleted file mode 100644 index dca33eb802..0000000000 --- a/docs/docbook/smbdotconf/tuning/syncalways.xml +++ /dev/null @@ -1,21 +0,0 @@ - - - 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. - - See also the strict - sync parameter. - - Default: sync always = no - - diff --git a/docs/docbook/smbdotconf/tuning/usemmap.xml b/docs/docbook/smbdotconf/tuning/usemmap.xml deleted file mode 100644 index 1e79e07ef3..0000000000 --- a/docs/docbook/smbdotconf/tuning/usemmap.xml +++ /dev/null @@ -1,17 +0,0 @@ - - - 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. - - - Default: use mmap = yes - - diff --git a/docs/docbook/smbdotconf/tuning/usesendfile.xml b/docs/docbook/smbdotconf/tuning/usesendfile.xml deleted file mode 100644 index 6bbd651549..0000000000 --- a/docs/docbook/smbdotconf/tuning/usesendfile.xml +++ /dev/null @@ -1,15 +0,0 @@ - - - If this parameter is yes, and Samba - was built with the --with-sendfile-support option, and the underlying operating - system supports sendfile system call, 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. This is off by default as it's effects are unknown - as yet. - - Default: use sendfile = no - - diff --git a/docs/docbook/smbdotconf/tuning/writecachesize.xml b/docs/docbook/smbdotconf/tuning/writecachesize.xml deleted file mode 100644 index 8b5fbe66bd..0000000000 --- a/docs/docbook/smbdotconf/tuning/writecachesize.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - 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. - - Default: write cache size = 0 - - Example: write cache size = 262144 - - for a 256k cache size per file. - - -- cgit