From c29eb90444170953721b087f8d26b4a3b98b3fe8 Mon Sep 17 00:00:00 2001 From: Alexander Bokovoy Date: Sun, 6 Apr 2003 22:14:01 +0000 Subject: Convert more parameters to new smb.conf(5) style. Document found occurences of non-documented parameters in doc-status (This used to be commit 3a9784d8b2318af4d9b349edd1aba4065d25da23) --- docs/docbook/global.ent | 1 - .../smbdotconf/logging/debughirestimestamp.xml | 27 ++-- docs/docbook/smbdotconf/logging/debuglevel.xml | 15 ++- docs/docbook/smbdotconf/logging/debugpid.xml | 28 ++-- docs/docbook/smbdotconf/logging/debugtimestamp.xml | 22 ++-- docs/docbook/smbdotconf/logging/debuguid.xml | 26 ++-- docs/docbook/smbdotconf/logging/logfile.xml | 21 +-- docs/docbook/smbdotconf/logging/loglevel.xml | 29 +++-- docs/docbook/smbdotconf/logging/maxlogsize.xml | 26 ++-- docs/docbook/smbdotconf/logging/syslog.xml | 33 ++--- docs/docbook/smbdotconf/logging/syslogonly.xml | 19 +-- docs/docbook/smbdotconf/logging/timestamplogs.xml | 15 ++- .../smbdotconf/logon/setprimarygroupscript.xml | 8 +- .../docbook/smbdotconf/printing/disablespoolss.xml | 39 +++--- docs/docbook/smbdotconf/printing/loadprinters.xml | 20 +-- docs/docbook/smbdotconf/printing/lpqcommand.xml | 85 ++++++------ docs/docbook/smbdotconf/printing/lprmcommand.xml | 45 ++++--- docs/docbook/smbdotconf/printing/maxprintjobs.xml | 30 +++-- docs/docbook/smbdotconf/printing/printable.xml | 29 +++-- docs/docbook/smbdotconf/printing/printcap.xml | 15 ++- docs/docbook/smbdotconf/printing/printcapname.xml | 71 +++++----- docs/docbook/smbdotconf/printing/printcommand.xml | 137 ++++++++++---------- docs/docbook/smbdotconf/printing/printing.xml | 49 +++---- docs/docbook/smbdotconf/printing/printok.xml | 15 ++- .../docbook/smbdotconf/printing/totalprintjobs.xml | 38 +++--- docs/docbook/smbdotconf/protocol/announceas.xml | 37 +++--- .../smbdotconf/protocol/announceversion.xml | 23 ++-- .../docbook/smbdotconf/protocol/disablenetbios.xml | 28 ++-- .../docbook/smbdotconf/protocol/largereadwrite.xml | 31 +++-- docs/docbook/smbdotconf/protocol/maxmux.xml | 19 +-- docs/docbook/smbdotconf/protocol/maxprotocol.xml | 67 ++++++---- docs/docbook/smbdotconf/protocol/maxttl.xml | 24 ++-- docs/docbook/smbdotconf/protocol/maxwinsttl.xml | 29 +++-- docs/docbook/smbdotconf/protocol/maxxmit.xml | 26 ++-- docs/docbook/smbdotconf/protocol/minprotocol.xml | 39 +++--- docs/docbook/smbdotconf/protocol/minwinsttl.xml | 27 ++-- .../smbdotconf/protocol/nameresolveorder.xml | 105 ++++++++------- docs/docbook/smbdotconf/protocol/ntaclsupport.xml | 23 ++-- docs/docbook/smbdotconf/protocol/ntpipesupport.xml | 25 ++-- .../smbdotconf/protocol/ntstatussupport.xml | 27 ++-- docs/docbook/smbdotconf/protocol/protocol.xml | 14 +- docs/docbook/smbdotconf/protocol/readbmpx.xml | 23 ++-- docs/docbook/smbdotconf/protocol/readraw.xml | 37 +++--- docs/docbook/smbdotconf/protocol/smbports.xml | 18 +-- docs/docbook/smbdotconf/protocol/timeserver.xml | 19 +-- docs/docbook/smbdotconf/protocol/unicode.xml | 22 ++-- .../docbook/smbdotconf/protocol/unixextensions.xml | 25 ++-- docs/docbook/smbdotconf/protocol/usespnego.xml | 26 ++-- docs/docbook/smbdotconf/protocol/writeraw.xml | 19 +-- .../docbook/smbdotconf/security/serverschannel.xml | 2 +- docs/docbook/smbdotconf/tuning/blocksize.xml | 37 +++--- .../smbdotconf/tuning/changenotifytimeout.xml | 31 +++-- docs/docbook/smbdotconf/tuning/deadtime.xml | 40 +++--- docs/docbook/smbdotconf/tuning/getwdcache.xml | 23 ++-- docs/docbook/smbdotconf/tuning/hostnamelookups.xml | 26 ++-- docs/docbook/smbdotconf/tuning/keepalive.xml | 33 +++-- docs/docbook/smbdotconf/tuning/maxconnections.xml | 30 +++-- docs/docbook/smbdotconf/tuning/maxdisksize.xml | 44 ++++--- docs/docbook/smbdotconf/tuning/maxopenfiles.xml | 31 +++-- .../docbook/smbdotconf/tuning/maxsmbdprocesses.xml | 33 ++--- docs/docbook/smbdotconf/tuning/minprintspace.xml | 28 ++-- .../docbook/smbdotconf/tuning/namecachetimeout.xml | 23 ++-- .../smbdotconf/tuning/paranoidserversecurity.xml | 30 +++-- docs/docbook/smbdotconf/tuning/readsize.xml | 48 +++---- docs/docbook/smbdotconf/tuning/socketoptions.xml | 144 +++++++++++---------- docs/docbook/smbdotconf/tuning/statcachesize.xml | 19 +-- docs/docbook/smbdotconf/tuning/strictallocate.xml | 38 +++--- docs/docbook/smbdotconf/tuning/strictsync.xml | 44 ++++--- docs/docbook/smbdotconf/tuning/syncalways.xml | 36 +++--- docs/docbook/smbdotconf/tuning/usemmap.xml | 29 +++-- docs/docbook/smbdotconf/tuning/usesendfile.xml | 27 ++-- docs/docbook/smbdotconf/tuning/writecachesize.xml | 49 +++---- docs/docs-status | 1 + 73 files changed, 1332 insertions(+), 1090 deletions(-) (limited to 'docs') diff --git a/docs/docbook/global.ent b/docs/docbook/global.ent index c71166b4d7..26c774820f 100644 --- a/docs/docbook/global.ent +++ b/docs/docbook/global.ent @@ -98,7 +98,6 @@ - diff --git a/docs/docbook/smbdotconf/logging/debughirestimestamp.xml b/docs/docbook/smbdotconf/logging/debughirestimestamp.xml index a5f40b73ca..4e49b89ddb 100644 --- a/docs/docbook/smbdotconf/logging/debughirestimestamp.xml +++ b/docs/docbook/smbdotconf/logging/debughirestimestamp.xml @@ -1,14 +1,17 @@ - - debug hires timestamp (G) - Sometimes the timestamps in the log messages - are needed with a resolution of higher that seconds, this - boolean parameter adds microsecond resolution to the timestamp - message header when turned on. + + + Sometimes the timestamps in the log messages + are needed with a resolution of higher that seconds, this + boolean parameter adds microsecond resolution to the timestamp + message header when turned on. - Note that the parameter - debug timestamp must be on for this to have an - effect. + Note that the parameter + debug timestamp must be on for this to have an + effect. - Default: debug hires timestamp = no - - + Default: debug hires timestamp = no + + diff --git a/docs/docbook/smbdotconf/logging/debuglevel.xml b/docs/docbook/smbdotconf/logging/debuglevel.xml index 99153fa853..8bd4b4e0b5 100644 --- a/docs/docbook/smbdotconf/logging/debuglevel.xml +++ b/docs/docbook/smbdotconf/logging/debuglevel.xml @@ -1,6 +1,9 @@ - - debuglevel (G) - Synonym for - log level. - - + + + Synonym for + log level. + + diff --git a/docs/docbook/smbdotconf/logging/debugpid.xml b/docs/docbook/smbdotconf/logging/debugpid.xml index 829e168412..ff393f5159 100644 --- a/docs/docbook/smbdotconf/logging/debugpid.xml +++ b/docs/docbook/smbdotconf/logging/debugpid.xml @@ -1,13 +1,19 @@ - - debug pid (G) - When using only one log file for more then one - forked smbd-process there may be hard to follow which process - outputs which message. This boolean parameter is adds the process-id - to the timestamp message headers in the logfile when turned on. + + + When using only one log file for more then one forked + smbd + 8-process there may be hard to + follow which process outputs which message. This boolean parameter + is adds the process-id to the timestamp message headers in the + logfile when turned on. - Note that the parameter - debug timestamp must be on for this to have an - effect. + Note that the parameter + debug timestamp must be on for this to have an + effect. - Default: debug pid = no - + Default: debug pid = no + + diff --git a/docs/docbook/smbdotconf/logging/debugtimestamp.xml b/docs/docbook/smbdotconf/logging/debugtimestamp.xml index 1265c1d21b..e337b5b8f2 100644 --- a/docs/docbook/smbdotconf/logging/debugtimestamp.xml +++ b/docs/docbook/smbdotconf/logging/debugtimestamp.xml @@ -1,10 +1,14 @@ - - debug timestamp (G) - Samba debug log messages are timestamped - by default. If you are running at a high - debug level these timestamps - can be distracting. This boolean parameter allows timestamping - to be turned off. + + + Samba debug log messages are timestamped + by default. If you are running at a high + debug level these timestamps + can be distracting. This boolean parameter allows timestamping + to be turned off. - Default: debug timestamp = yes - + Default: debug timestamp = yes + + diff --git a/docs/docbook/smbdotconf/logging/debuguid.xml b/docs/docbook/smbdotconf/logging/debuguid.xml index 9b0786d6b3..bcacdf32c0 100644 --- a/docs/docbook/smbdotconf/logging/debuguid.xml +++ b/docs/docbook/smbdotconf/logging/debuguid.xml @@ -1,13 +1,17 @@ - - debug uid (G) - Samba is sometimes run as root and sometime - run as the connected user, this boolean parameter inserts the - current euid, egid, uid and gid to the timestamp message headers - in the log file if turned on. + + + Samba is sometimes run as root and sometime + run as the connected user, this boolean parameter inserts the + current euid, egid, uid and gid to the timestamp message headers + in the log file if turned on. - Note that the parameter - debug timestamp must be on for this to have an - effect. + Note that the parameter + debug timestamp must be on for this to have an + effect. - Default: debug uid = no - + Default: debug uid = no + + diff --git a/docs/docbook/smbdotconf/logging/logfile.xml b/docs/docbook/smbdotconf/logging/logfile.xml index 6f176ef02b..8d3761a841 100644 --- a/docs/docbook/smbdotconf/logging/logfile.xml +++ b/docs/docbook/smbdotconf/logging/logfile.xml @@ -1,11 +1,14 @@ - - log file (G) - This option allows you to override the name - of the Samba log file (also known as the debug file). + + + This option allows you to override the name + of the Samba log file (also known as the debug file). - This option takes the standard substitutions, allowing - you to have separate log files for each user or machine. + This option takes the standard substitutions, allowing + you to have separate log files for each user or machine. - Example: log file = /usr/local/samba/var/log.%m - - + Example: log file = /usr/local/samba/var/log.%m + + diff --git a/docs/docbook/smbdotconf/logging/loglevel.xml b/docs/docbook/smbdotconf/logging/loglevel.xml index 610dc96812..6f03fe80e9 100644 --- a/docs/docbook/smbdotconf/logging/loglevel.xml +++ b/docs/docbook/smbdotconf/logging/loglevel.xml @@ -1,15 +1,18 @@ - - log level (G) - The value of the parameter (a astring) allows - the debug level (logging level) to be specified in the - smb.conf file. This parameter has been - extended since the 2.2.x series, now it allow to specify the debug - level for multiple debug classes. This is to give greater - flexibility in the configuration of the system. + + + The value of the parameter (a astring) allows + the debug level (logging level) to be specified in the + smb.conf file. This parameter has been + extended since the 2.2.x series, now it allow to specify the debug + level for multiple debug classes. This is to give greater + flexibility in the configuration of the system. - The default will be the log level specified on - the command line or level zero if none was specified. + The default will be the log level specified on + the command line or level zero if none was specified. - Example: log level = 3 passdb:5 auth:10 winbind:2 - - + Example: log level = 3 passdb:5 auth:10 winbind:2 + + diff --git a/docs/docbook/smbdotconf/logging/maxlogsize.xml b/docs/docbook/smbdotconf/logging/maxlogsize.xml index 117410b18c..6e0ec6735a 100644 --- a/docs/docbook/smbdotconf/logging/maxlogsize.xml +++ b/docs/docbook/smbdotconf/logging/maxlogsize.xml @@ -1,13 +1,17 @@ - - max log size (G) - This option (an integer in kilobytes) specifies - the max size the log file should grow to. Samba periodically checks - the size and if it is exceeded it will rename the file, adding - a .old extension. + + + This option (an integer in kilobytes) specifies + the max size the log file should grow to. Samba periodically checks + the size and if it is exceeded it will rename the file, adding + a .old extension. - A size of 0 means no limit. + A size of 0 means no limit. - Default: max log size = 5000 - Example: max log size = 1000 - - + Default: max log size = 5000 + + Example: max log size = 1000 + + diff --git a/docs/docbook/smbdotconf/logging/syslog.xml b/docs/docbook/smbdotconf/logging/syslog.xml index ac098e690a..0fdf070045 100644 --- a/docs/docbook/smbdotconf/logging/syslog.xml +++ b/docs/docbook/smbdotconf/logging/syslog.xml @@ -1,17 +1,20 @@ - - syslog (G) - This parameter maps how Samba debug messages - are logged onto the system syslog logging levels. Samba debug - level zero maps onto syslog LOG_ERR, debug - level one maps onto LOG_WARNING, debug level - two maps onto LOG_NOTICE, debug level three - maps onto LOG_INFO. All higher levels are mapped to - LOG_DEBUG. + + + This parameter maps how Samba debug messages + are logged onto the system syslog logging levels. Samba debug + level zero maps onto syslog LOG_ERR, debug + level one maps onto LOG_WARNING, debug level + two maps onto LOG_NOTICE, debug level three + maps onto LOG_INFO. All higher levels are mapped to + LOG_DEBUG. - This parameter sets the threshold for sending messages - to syslog. Only messages with debug level less than this value - will be sent to syslog. + This parameter sets the threshold for sending messages + to syslog. Only messages with debug level less than this value + will be sent to syslog. - Default: syslog = 1 - - + Default: syslog = 1 + + diff --git a/docs/docbook/smbdotconf/logging/syslogonly.xml b/docs/docbook/smbdotconf/logging/syslogonly.xml index a955306fe0..2b584d8d6d 100644 --- a/docs/docbook/smbdotconf/logging/syslogonly.xml +++ b/docs/docbook/smbdotconf/logging/syslogonly.xml @@ -1,9 +1,12 @@ - - syslog only (G) - If this parameter is set then Samba debug - messages are logged into the system syslog only, and not to - the debug log files. + + + If this parameter is set then Samba debug + messages are logged into the system syslog only, and not to + the debug log files. - Default: syslog only = no - - + Default: syslog only = no + + diff --git a/docs/docbook/smbdotconf/logging/timestamplogs.xml b/docs/docbook/smbdotconf/logging/timestamplogs.xml index 5f5f42d738..e744ce54c6 100644 --- a/docs/docbook/smbdotconf/logging/timestamplogs.xml +++ b/docs/docbook/smbdotconf/logging/timestamplogs.xml @@ -1,6 +1,9 @@ - - timestamp logs (G) - Synonym for - debug timestamp. - - + + + Synonym for + debug timestamp. + + diff --git a/docs/docbook/smbdotconf/logon/setprimarygroupscript.xml b/docs/docbook/smbdotconf/logon/setprimarygroupscript.xml index c4b2aa1d92..45380ce4a8 100644 --- a/docs/docbook/smbdotconf/logon/setprimarygroupscript.xml +++ b/docs/docbook/smbdotconf/logon/setprimarygroupscript.xml @@ -1,5 +1,7 @@ -set primary group script (G) - Thanks to the Posix subsystem in NT a + +set primary group script (G) + + Thanks to the Posix subsystem in NT a Windows User has a primary group in addition to the auxiliary groups. This script sets the primary group in the unix userdatase when an administrator sets the @@ -8,7 +10,7 @@ vampire. %u will be replaced with the user whose primary group is to be set. %g will be replaced with - the group to set. + the group to set. Default: No default value diff --git a/docs/docbook/smbdotconf/printing/disablespoolss.xml b/docs/docbook/smbdotconf/printing/disablespoolss.xml index dff1e63fab..366092fce1 100644 --- a/docs/docbook/smbdotconf/printing/disablespoolss.xml +++ b/docs/docbook/smbdotconf/printing/disablespoolss.xml @@ -1,20 +1,23 @@ - - disable spoolss (G) - Enabling this parameter will disable Samba's support - for the SPOOLSS set of MS-RPC's and will yield identical behavior - as Samba 2.0.x. Windows NT/2000 clients will downgrade to using - Lanman style printing commands. Windows 9x/ME will be uneffected by - the parameter. However, this will also disable the ability to upload - printer drivers to a Samba server via the Windows NT Add Printer - Wizard or by using the NT printer properties dialog window. It will - also disable the capability of Windows NT/2000 clients to download - print drivers from the Samba host upon demand. - Be very careful about enabling this parameter. - + + + Enabling this parameter will disable Samba's support + for the SPOOLSS set of MS-RPC's and will yield identical behavior + as Samba 2.0.x. Windows NT/2000 clients will downgrade to using + Lanman style printing commands. Windows 9x/ME will be uneffected by + the parameter. However, this will also disable the ability to upload + printer drivers to a Samba server via the Windows NT Add Printer + Wizard or by using the NT printer properties dialog window. It will + also disable the capability of Windows NT/2000 clients to download + print drivers from the Samba host upon demand. + Be very careful about enabling this parameter. + - See also use client driver - + See also use client driver + - Default : disable spoolss = no - - + Default : disable spoolss = no + + diff --git a/docs/docbook/smbdotconf/printing/loadprinters.xml b/docs/docbook/smbdotconf/printing/loadprinters.xml index adaa8afca9..efc2658ba8 100644 --- a/docs/docbook/smbdotconf/printing/loadprinters.xml +++ b/docs/docbook/smbdotconf/printing/loadprinters.xml @@ -1,9 +1,13 @@ - - load printers (G) - A boolean variable that controls whether all - printers in the printcap will be loaded for browsing by default. - See the printers section for - more details. + + + A boolean variable that controls whether all + printers in the printcap will be loaded for browsing by default. + See the printers section for + more details. - Default: load printers = yes - + Default: load printers = yes + + diff --git a/docs/docbook/smbdotconf/printing/lpqcommand.xml b/docs/docbook/smbdotconf/printing/lpqcommand.xml index ddcdf1ef49..f1b62af627 100644 --- a/docs/docbook/smbdotconf/printing/lpqcommand.xml +++ b/docs/docbook/smbdotconf/printing/lpqcommand.xml @@ -1,41 +1,44 @@ - - lpq command (S) - This parameter specifies the command to be - executed on the server host in order to obtain lpq - -style printer status information. - - This command should be a program or script which - takes a printer name as its only parameter and outputs printer - status information. - - Currently nine styles of printer status information - are supported; BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX, CUPS, and SOFTQ. - This covers most UNIX systems. You control which type is expected - using the printing = option. - - Some clients (notably Windows for Workgroups) may not - correctly send the connection number for the printer they are - requesting status information about. To get around this, the - server reports on the first printer service connected to by the - client. This only happens if the connection number sent is invalid. - - If a %p is given then the printer name - is put in its place. Otherwise it is placed at the end of the - command. - - Note that it is good practice to include the absolute path - in the lpq command as the $PATH - may not be available to the server. When compiled with - the CUPS libraries, no lpq command is - needed because smbd will make a library call to obtain the - print queue listing. - - See also the printing - parameter. - - Default: depends on the setting of - printing - - Example: lpq command = /usr/bin/lpq -P%p - - + + + This parameter specifies the command to be + executed on the server host in order to obtain lpq + -style printer status information. + + This command should be a program or script which + takes a printer name as its only parameter and outputs printer + status information. + + Currently nine styles of printer status information + are supported; BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX, CUPS, and SOFTQ. + This covers most UNIX systems. You control which type is expected + using the printing = option. + + Some clients (notably Windows for Workgroups) may not + correctly send the connection number for the printer they are + requesting status information about. To get around this, the + server reports on the first printer service connected to by the + client. This only happens if the connection number sent is invalid. + + If a %p is given then the printer name + is put in its place. Otherwise it is placed at the end of the + command. + + Note that it is good practice to include the absolute path + in the lpq command as the $PATH + may not be available to the server. When compiled with + the CUPS libraries, no lpq command is + needed because smbd will make a library call to obtain the + print queue listing. + + See also the printing + parameter. + + Default: depends on the setting of + printing + + Example: lpq command = /usr/bin/lpq -P%p + + diff --git a/docs/docbook/smbdotconf/printing/lprmcommand.xml b/docs/docbook/smbdotconf/printing/lprmcommand.xml index 7f59d6c5a0..567602c4f9 100644 --- a/docs/docbook/smbdotconf/printing/lprmcommand.xml +++ b/docs/docbook/smbdotconf/printing/lprmcommand.xml @@ -1,27 +1,30 @@ - - lprm command (S) - This parameter specifies the command to be - executed on the server host in order to delete a print job. + + + This parameter specifies the command to be + executed on the server host in order to delete a print job. - This command should be a program or script which takes - a printer name and job number, and deletes the print job. + This command should be a program or script which takes + a printer name and job number, and deletes the print job. - If a %p is given then the printer name - is put in its place. A %j is replaced with - the job number (an integer). + If a %p is given then the printer name + is put in its place. A %j is replaced with + the job number (an integer). - Note that it is good practice to include the absolute - path in the lprm command as the PATH may not be - available to the server. + Note that it is good practice to include the absolute + path in the lprm command as the PATH may not be + available to the server. - See also the printing - parameter. + See also the printing + parameter. - Default: depends on the setting of printing - + Default: depends on the setting of printing + - Example 1: lprm command = /usr/bin/lprm -P%p %j - - Example 2: lprm command = /usr/bin/cancel %p-%j - - + Example 1: lprm command = /usr/bin/lprm -P%p %j + + Example 2: lprm command = /usr/bin/cancel %p-%j + + diff --git a/docs/docbook/smbdotconf/printing/maxprintjobs.xml b/docs/docbook/smbdotconf/printing/maxprintjobs.xml index f0c7d83d3f..a631b6b8c4 100644 --- a/docs/docbook/smbdotconf/printing/maxprintjobs.xml +++ b/docs/docbook/smbdotconf/printing/maxprintjobs.xml @@ -1,14 +1,18 @@ - - max print jobs (S) - This parameter limits the maximum number of - jobs allowable in a Samba printer queue at any given moment. - If this number is exceeded, smbd - 8 will remote "Out of Space" to the client. - See all total - print jobs. - + + + This parameter limits the maximum number of + jobs allowable in a Samba printer queue at any given moment. + If this number is exceeded, smbd + 8 will remote "Out of Space" to the client. + See all total + print jobs. + - Default: max print jobs = 1000 - Example: max print jobs = 5000 - - + Default: max print jobs = 1000 + + Example: max print jobs = 5000 + + diff --git a/docs/docbook/smbdotconf/printing/printable.xml b/docs/docbook/smbdotconf/printing/printable.xml index 22d4d73b01..946e8b4b96 100644 --- a/docs/docbook/smbdotconf/printing/printable.xml +++ b/docs/docbook/smbdotconf/printing/printable.xml @@ -1,15 +1,18 @@ - - printable (S) - If this parameter is yes, then - clients may open, write to and submit spool files on the directory - specified for the service. + + + If this parameter is yes, then + clients may open, write to and submit spool files on the directory + specified for the service. - Note that a printable service will ALWAYS allow writing - to the service path (user privileges permitting) via the spooling - of print data. The read only - parameter controls only non-printing access to - the resource. + Note that a printable service will ALWAYS allow writing + to the service path (user privileges permitting) via the spooling + of print data. The read only + parameter controls only non-printing access to + the resource. - Default: printable = no - - + Default: printable = no + + diff --git a/docs/docbook/smbdotconf/printing/printcap.xml b/docs/docbook/smbdotconf/printing/printcap.xml index 2f5e4af580..0ee08a263f 100644 --- a/docs/docbook/smbdotconf/printing/printcap.xml +++ b/docs/docbook/smbdotconf/printing/printcap.xml @@ -1,6 +1,9 @@ - - printcap (G) - Synonym for - printcap name. - - + + + Synonym for + printcap name. + + diff --git a/docs/docbook/smbdotconf/printing/printcapname.xml b/docs/docbook/smbdotconf/printing/printcapname.xml index 0025624d25..5f5b5c86a9 100644 --- a/docs/docbook/smbdotconf/printing/printcapname.xml +++ b/docs/docbook/smbdotconf/printing/printcapname.xml @@ -1,28 +1,32 @@ - - printcap name (G) - This parameter may be used to override the - compiled-in default printcap name used by the server (usually - /etc/printcap). See the discussion of the [printers] section above for reasons - why you might want to do this. + + + This parameter may be used to override the + compiled-in default printcap name used by the server (usually + /etc/printcap). See the discussion of the [printers] section above for reasons + why you might want to do this. - To use the CUPS printing interface set printcap name = cups - . This should be supplemented by an addtional setting - printing = cups in the [global] - section. printcap name = cups will use the - "dummy" printcap created by CUPS, as specified in your CUPS - configuration file. - + To use the CUPS printing interface set printcap name = cups + . This should be supplemented by an addtional setting + printing = cups in the [global] + section. printcap name = cups will use the + "dummy" printcap created by CUPS, as specified in your CUPS + configuration file. + - On System V systems that use lpstat to - list available printers you can use printcap name = lpstat - to automatically obtain lists of available printers. This - is the default for systems that define SYSV at configure time in - Samba (this includes most System V based systems). If - printcap name is set to lpstat on - these systems then Samba will launch lpstat -v and - attempt to parse the output to obtain a printer list. + On System V systems that use lpstat to + list available printers you can use printcap name = lpstat + to automatically obtain lists of available printers. This + is the default for systems that define SYSV at configure time in + Samba (this includes most System V based systems). If + printcap name is set to lpstat on + these systems then Samba will launch lpstat -v and + attempt to parse the output to obtain a printer list. - A minimal printcap file would look something like this: + A minimal printcap file would look something like this: print1|My Printer 1 @@ -32,16 +36,17 @@ print4|My Printer 4 print5|My Printer 5 - where the '|' separates aliases of a printer. The fact - that the second alias has a space in it gives a hint to Samba - that it's a comment. + where the '|' separates aliases of a printer. The fact + that the second alias has a space in it gives a hint to Samba + that it's a comment. - Under AIX the default printcap - name is /etc/qconfig. Samba will assume the - file is in AIX qconfig format if the string - qconfig appears in the printcap filename. + Under AIX the default printcap + name is /etc/qconfig. Samba will assume the + file is in AIX qconfig format if the string + qconfig appears in the printcap filename. - Default: printcap name = /etc/printcap - Example: printcap name = /etc/myprintcap - - + Default: printcap name = /etc/printcap + + Example: printcap name = /etc/myprintcap + + diff --git a/docs/docbook/smbdotconf/printing/printcommand.xml b/docs/docbook/smbdotconf/printing/printcommand.xml index c996ed6c2e..5444309053 100644 --- a/docs/docbook/smbdotconf/printing/printcommand.xml +++ b/docs/docbook/smbdotconf/printing/printcommand.xml @@ -1,86 +1,89 @@ - - print command (S) - After a print job has finished spooling to - a service, this command will be used via a system() - call to process the spool file. Typically the command specified will - submit the spool file to the host's printing subsystem, but there - is no requirement that this be the case. The server will not remove - the spool file, so whatever command you specify should remove the - spool file when it has been processed, otherwise you will need to - manually remove old spool files. + + + After a print job has finished spooling to + a service, this command will be used via a system() + call to process the spool file. Typically the command specified will + submit the spool file to the host's printing subsystem, but there + is no requirement that this be the case. The server will not remove + the spool file, so whatever command you specify should remove the + spool file when it has been processed, otherwise you will need to + manually remove old spool files. - The print command is simply a text string. It will be used - verbatim after macro substitutions have been made: + The print command is simply a text string. It will be used + verbatim after macro substitutions have been made: - s, %p - the path to the spool - file name + %s, %p - the path to the spool + file name - %p - the appropriate printer - name + %p - the appropriate printer + name - %J - the job - name as transmitted by the client. + %J - the job + name as transmitted by the client. - %c - The number of printed pages - of the spooled job (if known). + %c - The number of printed pages + of the spooled job (if known). - %z - the size of the spooled - print job (in bytes) + %z - the size of the spooled + print job (in bytes) - The print command MUST contain at least - one occurrence of %s or %f - - the %p is optional. At the time - a job is submitted, if no printer name is supplied the %p - will be silently removed from the printer command. + The print command MUST contain at least + one occurrence of %s or %f + - the %p is optional. At the time + a job is submitted, if no printer name is supplied the %p + will be silently removed from the printer command. - If specified in the [global] section, the print command given - will be used for any printable service that does not have its own - print command specified. + If specified in the [global] section, the print command given + will be used for any printable service that does not have its own + print command specified. - If there is neither a specified print command for a - printable service nor a global print command, spool files will - be created but not processed and (most importantly) not removed. + If there is neither a specified print command for a + printable service nor a global print command, spool files will + be created but not processed and (most importantly) not removed. - Note that printing may fail on some UNIXes from the - nobody account. If this happens then create - an alternative guest account that can print and set the guest account - in the [global] section. + Note that printing may fail on some UNIXes from the + nobody account. If this happens then create + an alternative guest account that can print and set the + guest account + in the [global] section. - You can form quite complex print commands by realizing - that they are just passed to a shell. For example the following - will log a print job, print the file, then remove it. Note that - ';' is the usual separator for command in shell scripts. + You can form quite complex print commands by realizing + that they are just passed to a shell. For example the following + will log a print job, print the file, then remove it. Note that + ';' is the usual separator for command in shell scripts. - print command = echo Printing %s >> - /tmp/print.log; lpr -P %p %s; rm %s + print command = echo Printing %s >> + /tmp/print.log; lpr -P %p %s; rm %s - You may have to vary this command considerably depending - on how you normally print files on your system. The default for - the parameter varies depending on the setting of the - printing parameter. + You may have to vary this command considerably depending + on how you normally print files on your system. The default for + the parameter varies depending on the setting of the + printing parameter. - Default: For printing = BSD, AIX, QNX, LPRNG - or PLP : - print command = lpr -r -P%p %s + Default: For printing = BSD, AIX, QNX, LPRNG + or PLP : + print command = lpr -r -P%p %s - For printing = SYSV or HPUX : - print command = lp -c -d%p %s; rm %s + For printing = SYSV or HPUX : + print command = lp -c -d%p %s; rm %s - For printing = SOFTQ : - print command = lp -d%p -s %s; rm %s + For printing = SOFTQ : + print command = lp -d%p -s %s; rm %s - For printing = CUPS : If SAMBA is compiled against - libcups, then printcap = cups - uses the CUPS API to - submit jobs, etc. Otherwise it maps to the System V - commands with the -oraw option for printing, i.e. it - uses lp -c -d%p -oraw; rm %s. - With printing = cups, - and if SAMBA is compiled against libcups, any manually - set print command will be ignored. + For printing = CUPS : If SAMBA is compiled against + libcups, then printcap = cups + uses the CUPS API to + submit jobs, etc. Otherwise it maps to the System V + commands with the -oraw option for printing, i.e. it + uses lp -c -d%p -oraw; rm %s. + With printing = cups, + and if SAMBA is compiled against libcups, any manually + set print command will be ignored. - Example: print command = /usr/local/samba/bin/myprintscript - %p %s - - + Example: print command = /usr/local/samba/bin/myprintscript %p %s + + diff --git a/docs/docbook/smbdotconf/printing/printing.xml b/docs/docbook/smbdotconf/printing/printing.xml index d49c0e2471..4e9caa9b54 100644 --- a/docs/docbook/smbdotconf/printing/printing.xml +++ b/docs/docbook/smbdotconf/printing/printing.xml @@ -1,26 +1,31 @@ - - printing (S) - This parameters controls how printer status - information is interpreted on your system. It also affects the - default values for the print command, - lpq command, lppause command - , lpresume command, and - lprm command if specified in the - [global] section. + + + This parameters controls how printer status information is + interpreted on your system. It also affects the default values for + the print command, parameter + moreinfo="none">lpq command, lppause command , lpresume command, and lprm command if specified in the + [global] section. - Currently nine printing styles are supported. They are - BSD, AIX, - LPRNG, PLP, - SYSV, HPUX, - QNX, SOFTQ, - and CUPS. + Currently nine printing styles are supported. They are + BSD, AIX, + LPRNG, PLP, + SYSV, HPUX, + QNX, SOFTQ, + and CUPS. - To see what the defaults are for the other print - commands when using the various options use the testparm(1) program. + To see what the defaults are for the other print + commands when using the various options use the testparm + 1 program. - This option can be set on a per printer basis + This option can be set on a per printer basis - See also the discussion in the - [printers] section. - - + See also the discussion in the + [printers] section. + + diff --git a/docs/docbook/smbdotconf/printing/printok.xml b/docs/docbook/smbdotconf/printing/printok.xml index 7900e91bbb..0a0e6605f1 100644 --- a/docs/docbook/smbdotconf/printing/printok.xml +++ b/docs/docbook/smbdotconf/printing/printok.xml @@ -1,6 +1,9 @@ - - print ok (S) - Synonym for - printable. - - + + + Synonym for + printable. + + diff --git a/docs/docbook/smbdotconf/printing/totalprintjobs.xml b/docs/docbook/smbdotconf/printing/totalprintjobs.xml index 25784a3c29..ccdb137a69 100644 --- a/docs/docbook/smbdotconf/printing/totalprintjobs.xml +++ b/docs/docbook/smbdotconf/printing/totalprintjobs.xml @@ -1,18 +1,22 @@ - - total print jobs (G) - This parameter accepts an integer value which defines - a limit on the maximum number of print jobs that will be accepted - system wide at any given time. If a print job is submitted - by a client which will exceed this number, then smbd - 8 will return an - error indicating that no space is available on the server. The - default value of 0 means that no such limit exists. This parameter - can be used to prevent a server from exceeding its capacity and is - designed as a printing throttle. See also - max print jobs. - + + + This parameter accepts an integer value which defines + a limit on the maximum number of print jobs that will be accepted + system wide at any given time. If a print job is submitted + by a client which will exceed this number, then smbd + 8 will return an + error indicating that no space is available on the server. The + default value of 0 means that no such limit exists. This parameter + can be used to prevent a server from exceeding its capacity and is + designed as a printing throttle. See also + max print jobs. + - Default: total print jobs = 0 - Example: total print jobs = 5000 - - + Default: total print jobs = 0 + + Example: total print jobs = 5000 + + diff --git a/docs/docbook/smbdotconf/protocol/announceas.xml b/docs/docbook/smbdotconf/protocol/announceas.xml index 1f3169609c..b063fcc1b7 100644 --- a/docs/docbook/smbdotconf/protocol/announceas.xml +++ b/docs/docbook/smbdotconf/protocol/announceas.xml @@ -1,18 +1,21 @@ - - announce as (G) - This specifies what type of server nmbd - 8 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. + + + This specifies what type of server nmbd + 8 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. - Default: announce as = NT Server - - Example: announce as = Win95 - - + Default: announce as = NT Server + + Example: announce as = Win95 + + diff --git a/docs/docbook/smbdotconf/protocol/announceversion.xml b/docs/docbook/smbdotconf/protocol/announceversion.xml index 03ad429dbd..217004b5fc 100644 --- a/docs/docbook/smbdotconf/protocol/announceversion.xml +++ b/docs/docbook/smbdotconf/protocol/announceversion.xml @@ -1,12 +1,15 @@ - - announce version (G) - 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. + + + 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. - Default: announce version = 4.9 + Default: announce version = 4.9 - Example: announce version = 2.0 - - + Example: announce version = 2.0 + + diff --git a/docs/docbook/smbdotconf/protocol/disablenetbios.xml b/docs/docbook/smbdotconf/protocol/disablenetbios.xml index ac97cdf7c3..2fe92d00b7 100644 --- a/docs/docbook/smbdotconf/protocol/disablenetbios.xml +++ b/docs/docbook/smbdotconf/protocol/disablenetbios.xml @@ -1,14 +1,18 @@ - - disable netbios (G) - 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. + + + 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. - Note that clients that only support netbios won't be able to - see your samba server when netbios support is disabled. - + Note that clients that only support netbios won't be able to + see your samba server when netbios support is disabled. + - Default: disable netbios = no - Example: disable netbios = yes - - + Default: disable netbios = no + + Example: disable netbios = yes + + diff --git a/docs/docbook/smbdotconf/protocol/largereadwrite.xml b/docs/docbook/smbdotconf/protocol/largereadwrite.xml index 9aa28593e6..25c58899c4 100644 --- a/docs/docbook/smbdotconf/protocol/largereadwrite.xml +++ b/docs/docbook/smbdotconf/protocol/largereadwrite.xml @@ -1,15 +1,18 @@ - - large readwrite (G) - This parameter determines whether or not smbd - 8 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. - + + + This parameter determines whether or not + smbd + 8 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. - Default : large readwrite = yes - - + Default: large readwrite = yes + + diff --git a/docs/docbook/smbdotconf/protocol/maxmux.xml b/docs/docbook/smbdotconf/protocol/maxmux.xml index 51296e0747..c05487fdca 100644 --- a/docs/docbook/smbdotconf/protocol/maxmux.xml +++ b/docs/docbook/smbdotconf/protocol/maxmux.xml @@ -1,9 +1,12 @@ - - max mux (G) - 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. + + + 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. - Default: max mux = 50 - - + Default: max mux = 50 + + diff --git a/docs/docbook/smbdotconf/protocol/maxprotocol.xml b/docs/docbook/smbdotconf/protocol/maxprotocol.xml index be859f8ee3..3f4e917828 100644 --- a/docs/docbook/smbdotconf/protocol/maxprotocol.xml +++ b/docs/docbook/smbdotconf/protocol/maxprotocol.xml @@ -1,35 +1,48 @@ - - max protocol (G) - The value of the parameter (a string) is the highest - protocol level that will be supported by the server. + + + The value of the parameter (a string) is the highest + protocol level that will be supported by the server. - Possible values are : - - CORE: Earliest version. No - concept of user names. + Possible values are : + + + CORE: Earliest version. No + concept of user names. + - COREPLUS: Slight improvements on - CORE for efficiency. + + COREPLUS: Slight improvements on + CORE for efficiency. + - LANMAN1: First - modern version of the protocol. Long filename - support. + + LANMAN1: First + modern version of the protocol. Long filename + support. + - LANMAN2: Updates to Lanman1 protocol. - + + LANMAN2: Updates to Lanman1 protocol. + - NT1: Current up to date version of - the protocol. Used by Windows NT. Known as CIFS. - + + NT1: Current up to date version of the protocol. + Used by Windows NT. Known as CIFS. + + - Normally this option should not be set as the automatic - negotiation phase in the SMB protocol takes care of choosing - the appropriate protocol. + Normally this option should not be set as the automatic + negotiation phase in the SMB protocol takes care of choosing + the appropriate protocol. - See also min - protocol + See also min + protocol - Default: max protocol = NT1 - Example: max protocol = LANMAN1 - - + Default: max protocol = NT1 + + Example: max protocol = LANMAN1 + + diff --git a/docs/docbook/smbdotconf/protocol/maxttl.xml b/docs/docbook/smbdotconf/protocol/maxttl.xml index 04c6771308..63c2b57ad7 100644 --- a/docs/docbook/smbdotconf/protocol/maxttl.xml +++ b/docs/docbook/smbdotconf/protocol/maxttl.xml @@ -1,12 +1,14 @@ - - max ttl (G) - This option tells nmbd - 8 - what the default 'time to live' of NetBIOS names should be (in seconds) - when nmbd 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. + + + This option tells nmbd + 8 what the default 'time to live' + of NetBIOS names should be (in seconds) when nmbd 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. - Default: max ttl = 259200 - - + Default: max ttl = 259200 + + diff --git a/docs/docbook/smbdotconf/protocol/maxwinsttl.xml b/docs/docbook/smbdotconf/protocol/maxwinsttl.xml index c8e2d9df8d..eafacc28fa 100644 --- a/docs/docbook/smbdotconf/protocol/maxwinsttl.xml +++ b/docs/docbook/smbdotconf/protocol/maxwinsttl.xml @@ -1,15 +1,18 @@ - - max wins ttl (G) - This option tells smbd - 8 when acting as a WINS server ( - wins support = yes) what the maximum - 'time to live' of NetBIOS names that nmbd - will grant will be (in seconds). You should never need to change this - parameter. The default is 6 days (518400 seconds). + + + This option tells smbd + 8 when acting as a WINS server ( + wins support = yes) what the maximum + 'time to live' of NetBIOS names that nmbd + will grant will be (in seconds). You should never need to change this + parameter. The default is 6 days (518400 seconds). - See also the min - wins ttl parameter. + See also the min + wins ttl parameter. - Default: max wins ttl = 518400 - - + Default: max wins ttl = 518400 + + diff --git a/docs/docbook/smbdotconf/protocol/maxxmit.xml b/docs/docbook/smbdotconf/protocol/maxxmit.xml index c16cf47655..3125b8d3b9 100644 --- a/docs/docbook/smbdotconf/protocol/maxxmit.xml +++ b/docs/docbook/smbdotconf/protocol/maxxmit.xml @@ -1,12 +1,16 @@ - - max xmit (G) - 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. - + + + 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. + - Default: max xmit = 65535 - Example: max xmit = 8192 - - + Default: max xmit = 65535 + + Example: max xmit = 8192 + + diff --git a/docs/docbook/smbdotconf/protocol/minprotocol.xml b/docs/docbook/smbdotconf/protocol/minprotocol.xml index 6b1d420a4b..f382701948 100644 --- a/docs/docbook/smbdotconf/protocol/minprotocol.xml +++ b/docs/docbook/smbdotconf/protocol/minprotocol.xml @@ -1,20 +1,23 @@ - - min protocol (G) - The value of the parameter (a string) is the - lowest SMB protocol dialect than Samba will support. Please refer - to the max protocol - 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 - source/smbd/negprot.c for a listing of known protocol - dialects supported by clients. + + + The value of the parameter (a string) is the + lowest SMB protocol dialect than Samba will support. Please refer + to the max protocol + 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 + source/smbd/negprot.c for a listing of known protocol + dialects supported by clients. - If you are viewing this parameter as a security measure, you should - also refer to the lanman - auth parameter. Otherwise, you should never need - to change this parameter. + If you are viewing this parameter as a security measure, you should + also refer to the lanman + auth parameter. Otherwise, you should never need + to change this parameter. - Default : min protocol = CORE - Example : min protocol = NT1 # disable DOS - clients - - + Default : min protocol = CORE + + Example : min protocol = NT1 # disable DOS clients + + diff --git a/docs/docbook/smbdotconf/protocol/minwinsttl.xml b/docs/docbook/smbdotconf/protocol/minwinsttl.xml index e67c253f2e..8ad1a5600f 100644 --- a/docs/docbook/smbdotconf/protocol/minwinsttl.xml +++ b/docs/docbook/smbdotconf/protocol/minwinsttl.xml @@ -1,13 +1,16 @@ - - min wins ttl (G) - This option tells nmbd - 8 - when acting as a WINS server ( - wins support = yes) what the minimum 'time to live' - of NetBIOS names that nmbd will grant will be (in - seconds). You should never need to change this parameter. The default - is 6 hours (21600 seconds). + + + This option tells nmbd + 8 + when acting as a WINS server ( + wins support = yes) what the minimum 'time to live' + of NetBIOS names that nmbd will grant will be (in + seconds). You should never need to change this parameter. The default + is 6 hours (21600 seconds). - Default: min wins ttl = 21600 - - + Default: min wins ttl = 21600 + + diff --git a/docs/docbook/smbdotconf/protocol/nameresolveorder.xml b/docs/docbook/smbdotconf/protocol/nameresolveorder.xml index a5dd893902..897d04ad1c 100644 --- a/docs/docbook/smbdotconf/protocol/nameresolveorder.xml +++ b/docs/docbook/smbdotconf/protocol/nameresolveorder.xml @@ -1,47 +1,58 @@ - - name resolve order (G) - 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. - - The options are :"lmhosts", "host", "wins" and "bcast". They - cause names to be resolved as follows : - - - lmhosts : 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 lmhosts(5) for details) then - any name type matches for lookup. - - host : Do a standard host - name to IP address resolution, using the system /etc/hosts - , 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 /etc/nsswitch.conf - 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. - - wins : Query a name with - the IP address listed in the - wins server parameter. If no WINS server has - been specified this method will be ignored. - - bcast : Do a broadcast on - each of the known local interfaces listed in the interfaces - parameter. This is the least reliable of the name resolution - methods as it depends on the target host being on a locally - connected subnet. - - - Default: name resolve order = lmhosts host wins bcast - - Example: name resolve order = lmhosts bcast host - - - This will cause the local lmhosts file to be examined - first, followed by a broadcast attempt, followed by a normal - system hostname lookup. - - + + + 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. + + The options are: "lmhosts", "host", + "wins" and "bcast". They cause names to be + resolved as follows: + + + + lmhosts : 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 lmhosts(5) for details) then + any name type matches for lookup. + + + + host : Do a standard host + name to IP address resolution, using the system /etc/hosts + , 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 /etc/nsswitch.conf + 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. + + + + wins : Query a name with + the IP address listed in the + wins server parameter. If no WINS server has + been specified this method will be ignored. + + + + bcast : Do a broadcast on + each of the known local interfaces listed in the interfaces + parameter. This is the least reliable of the name resolution + methods as it depends on the target host being on a locally + connected subnet. + + + + Default: name resolve order = lmhosts host wins bcast + + Example: name resolve order = lmhosts bcast host + + This will cause the local lmhosts file to be examined + first, followed by a broadcast attempt, followed by a normal + system hostname lookup. + + diff --git a/docs/docbook/smbdotconf/protocol/ntaclsupport.xml b/docs/docbook/smbdotconf/protocol/ntaclsupport.xml index df0d8dc068..64276d51c3 100644 --- a/docs/docbook/smbdotconf/protocol/ntaclsupport.xml +++ b/docs/docbook/smbdotconf/protocol/ntaclsupport.xml @@ -1,11 +1,14 @@ - - nt acl support (S) - This boolean parameter controls whether - smbd(8) 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. + + + This boolean parameter controls whether smbd + 8 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. - Default: nt acl support = yes - - + Default: nt acl support = yes + + diff --git a/docs/docbook/smbdotconf/protocol/ntpipesupport.xml b/docs/docbook/smbdotconf/protocol/ntpipesupport.xml index cab2032847..e5c42a7696 100644 --- a/docs/docbook/smbdotconf/protocol/ntpipesupport.xml +++ b/docs/docbook/smbdotconf/protocol/ntpipesupport.xml @@ -1,12 +1,15 @@ - - nt pipe support (G) - This boolean parameter controls whether - smbd - 8 will allow Windows NT - clients to connect to the NT SMB specific IPC$ - pipes. This is a developer debugging option and can be left - alone. + + + This boolean parameter controls whether + smbd + 8 will allow Windows NT + clients to connect to the NT SMB specific IPC$ + pipes. This is a developer debugging option and can be left + alone. - Default: nt pipe support = yes - - + Default: nt pipe support = yes + + diff --git a/docs/docbook/smbdotconf/protocol/ntstatussupport.xml b/docs/docbook/smbdotconf/protocol/ntstatussupport.xml index 17dafa47c5..ecb19128ee 100644 --- a/docs/docbook/smbdotconf/protocol/ntstatussupport.xml +++ b/docs/docbook/smbdotconf/protocol/ntstatussupport.xml @@ -1,14 +1,17 @@ - - nt status support (G) - This boolean parameter controls whether smbd(8) 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 no then Samba offers - exactly the same DOS error codes that versions prior to Samba 2.2.3 - reported. + + + This boolean parameter controls whether smbd + 8 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 no then Samba offers + exactly the same DOS error codes that versions prior to Samba 2.2.3 + reported. - You should not need to ever disable this parameter. + You should not need to ever disable this parameter. - Default: nt status support = yes - - + Default: nt status support = yes + + diff --git a/docs/docbook/smbdotconf/protocol/protocol.xml b/docs/docbook/smbdotconf/protocol/protocol.xml index 5161806cfc..19926649c0 100644 --- a/docs/docbook/smbdotconf/protocol/protocol.xml +++ b/docs/docbook/smbdotconf/protocol/protocol.xml @@ -1,5 +1,9 @@ - - protocol (G) - Synonym for - max protocol. - + + + Synonym for + max protocol. + + diff --git a/docs/docbook/smbdotconf/protocol/readbmpx.xml b/docs/docbook/smbdotconf/protocol/readbmpx.xml index 0bc8f1d10b..0298407cef 100644 --- a/docs/docbook/smbdotconf/protocol/readbmpx.xml +++ b/docs/docbook/smbdotconf/protocol/readbmpx.xml @@ -1,10 +1,15 @@ - - read bmpx (G) - This boolean parameter controls whether smbd(8) will support the "Read - Block Multiplex" SMB. This is now rarely used and defaults to - no. You should never need to set this - parameter. + + + This boolean parameter controls whether + smbd + 8 will support the "Read + Block Multiplex" SMB. This is now rarely used and defaults to + no. You should never need to set this + parameter. - Default: read bmpx = no - - + Default: read bmpx = no + + diff --git a/docs/docbook/smbdotconf/protocol/readraw.xml b/docs/docbook/smbdotconf/protocol/readraw.xml index b867816e84..6b24f39d68 100644 --- a/docs/docbook/smbdotconf/protocol/readraw.xml +++ b/docs/docbook/smbdotconf/protocol/readraw.xml @@ -1,21 +1,24 @@ - - read raw (G) - This parameter controls whether or not the server - will support the raw read SMB requests when transferring data - to clients. + + + This parameter controls whether or not the server + will support the raw read SMB requests when transferring data + to clients. - If enabled, raw reads allow reads of 65535 bytes in - one packet. This typically provides a major performance benefit. - + If enabled, raw reads allow reads of 65535 bytes in + one packet. This typically provides a major performance benefit. + - 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. + 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. - In general this parameter should be viewed as a system tuning - tool and left severely alone. See also - write raw. + In general this parameter should be viewed as a system tuning + tool and left severely alone. See also + write raw. - Default: read raw = yes - - + Default: read raw = yes + + diff --git a/docs/docbook/smbdotconf/protocol/smbports.xml b/docs/docbook/smbdotconf/protocol/smbports.xml index ed088ab9d2..9d06c37964 100644 --- a/docs/docbook/smbdotconf/protocol/smbports.xml +++ b/docs/docbook/smbdotconf/protocol/smbports.xml @@ -1,10 +1,10 @@ - - smb ports (G) - Specifies which ports the server should listen on - for SMB traffic. - + + + Specifies which ports the server should listen on for SMB traffic. - Default: smb ports = 445 139 - - - + Default: smb ports = 445 139 + + diff --git a/docs/docbook/smbdotconf/protocol/timeserver.xml b/docs/docbook/smbdotconf/protocol/timeserver.xml index eb1a720a8d..d78f9a456d 100644 --- a/docs/docbook/smbdotconf/protocol/timeserver.xml +++ b/docs/docbook/smbdotconf/protocol/timeserver.xml @@ -1,9 +1,12 @@ - - time server (G) - This parameter determines if nmbd - 8 advertises itself as a time server to Windows - clients. + + + This parameter determines if nmbd + 8 advertises itself as a time server to Windows + clients. - Default: time server = no - - + Default: time server = no + + diff --git a/docs/docbook/smbdotconf/protocol/unicode.xml b/docs/docbook/smbdotconf/protocol/unicode.xml index 866dad28a0..be93cb61e2 100644 --- a/docs/docbook/smbdotconf/protocol/unicode.xml +++ b/docs/docbook/smbdotconf/protocol/unicode.xml @@ -1,11 +1,13 @@ - - unicode (G) - 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! - + + + 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! + - Default: unicode = yes - - - + Default: unicode = yes + + diff --git a/docs/docbook/smbdotconf/protocol/unixextensions.xml b/docs/docbook/smbdotconf/protocol/unixextensions.xml index d0adde9d27..2f68b9605e 100644 --- a/docs/docbook/smbdotconf/protocol/unixextensions.xml +++ b/docs/docbook/smbdotconf/protocol/unixextensions.xml @@ -1,12 +1,15 @@ - - unix extensions(G) - 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. + + + 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. - Default: unix extensions = no - - + Default: unix extensions = no + + diff --git a/docs/docbook/smbdotconf/protocol/usespnego.xml b/docs/docbook/smbdotconf/protocol/usespnego.xml index 9e3c873a4b..88c9f1df7a 100644 --- a/docs/docbook/smbdotconf/protocol/usespnego.xml +++ b/docs/docbook/smbdotconf/protocol/usespnego.xml @@ -1,11 +1,15 @@ - - use spnego (G) - 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. - Default: use spnego = yes - - + + + 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. + + Default: use spnego = yes + + diff --git a/docs/docbook/smbdotconf/protocol/writeraw.xml b/docs/docbook/smbdotconf/protocol/writeraw.xml index dbaad0130e..e71c54cabd 100644 --- a/docs/docbook/smbdotconf/protocol/writeraw.xml +++ b/docs/docbook/smbdotconf/protocol/writeraw.xml @@ -1,9 +1,12 @@ - - write raw (G) - 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. + + + 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. - Default: write raw = yes - - + Default: write raw = yes + + diff --git a/docs/docbook/smbdotconf/security/serverschannel.xml b/docs/docbook/smbdotconf/security/serverschannel.xml index afbc458068..1747fbea66 100644 --- a/docs/docbook/smbdotconf/security/serverschannel.xml +++ b/docs/docbook/smbdotconf/security/serverschannel.xml @@ -17,7 +17,7 @@ Please note that with this set to no you will have to apply the WindowsXP requireSignOrSeal-Registry patch found in - the docs/Registry subdirectory. Default: server schannel = auto Example: server schannel = yes diff --git a/docs/docbook/smbdotconf/tuning/blocksize.xml b/docs/docbook/smbdotconf/tuning/blocksize.xml index da42ca9ece..eecf1925e8 100644 --- a/docs/docbook/smbdotconf/tuning/blocksize.xml +++ b/docs/docbook/smbdotconf/tuning/blocksize.xml @@ -1,19 +1,22 @@ - - block size (S) - This parameter controls the behavior of smbd - 8 when reporting disk free - sizes. By default, this reports a disk block size of 1024 bytes. - + + + 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 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. - - + 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 index 18c8b9a176..471798c269 100644 --- a/docs/docbook/smbdotconf/tuning/changenotifytimeout.xml +++ b/docs/docbook/smbdotconf/tuning/changenotifytimeout.xml @@ -1,15 +1,20 @@ - - change notify timeout (G) - 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. + + + 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 + Default: change notify timeout = 60 - Would change the scan time to every 5 minutes. - + 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 index dbad06f25b..cbbf751862 100644 --- a/docs/docbook/smbdotconf/tuning/deadtime.xml +++ b/docs/docbook/smbdotconf/tuning/deadtime.xml @@ -1,23 +1,27 @@ - - deadtime (G) - 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. + + + 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. + 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. + 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. + 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. + A deadtime of zero indicates that no auto-disconnection + should be performed. - Default: deadtime = 0 - Example: deadtime = 15 - + Default: deadtime = 0 + Example: deadtime = 15 + + diff --git a/docs/docbook/smbdotconf/tuning/getwdcache.xml b/docs/docbook/smbdotconf/tuning/getwdcache.xml index c797bad414..8c22be9fb5 100644 --- a/docs/docbook/smbdotconf/tuning/getwdcache.xml +++ b/docs/docbook/smbdotconf/tuning/getwdcache.xml @@ -1,11 +1,14 @@ - - getwd cache (G) - 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. + + + 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 - - + Default: getwd cache = yes + + diff --git a/docs/docbook/smbdotconf/tuning/hostnamelookups.xml b/docs/docbook/smbdotconf/tuning/hostnamelookups.xml index daad09da8b..613fabe42f 100644 --- a/docs/docbook/smbdotconf/tuning/hostnamelookups.xml +++ b/docs/docbook/smbdotconf/tuning/hostnamelookups.xml @@ -1,14 +1,16 @@ - - hostname lookups (G) - 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. - + + + 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 + Default: hostname lookups = yes - Example: hostname lookups = no - - - + Example: hostname lookups = no + + diff --git a/docs/docbook/smbdotconf/tuning/keepalive.xml b/docs/docbook/smbdotconf/tuning/keepalive.xml index 746cda929e..1320dfab61 100644 --- a/docs/docbook/smbdotconf/tuning/keepalive.xml +++ b/docs/docbook/smbdotconf/tuning/keepalive.xml @@ -1,16 +1,21 @@ - - keepalive (G) - 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. + + + 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. + 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 - - + Default: keepalive = 300 + + Example: keepalive = 600 + + diff --git a/docs/docbook/smbdotconf/tuning/maxconnections.xml b/docs/docbook/smbdotconf/tuning/maxconnections.xml index 24af886b60..5127df06f4 100644 --- a/docs/docbook/smbdotconf/tuning/maxconnections.xml +++ b/docs/docbook/smbdotconf/tuning/maxconnections.xml @@ -1,16 +1,18 @@ - - max connections (S) - 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. + + + 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. + 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 - - + Default: max connections = 0 + + Example: max connections = 10 + + diff --git a/docs/docbook/smbdotconf/tuning/maxdisksize.xml b/docs/docbook/smbdotconf/tuning/maxdisksize.xml index 8aebe91902..7d99b31e03 100644 --- a/docs/docbook/smbdotconf/tuning/maxdisksize.xml +++ b/docs/docbook/smbdotconf/tuning/maxdisksize.xml @@ -1,24 +1,28 @@ - - max disk size (G) - 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. + + + 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. + 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. + 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. + A max disk size of 0 means no limit. - Default: max disk size = 0 - Example: max disk size = 1000 - - + 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 index 85b76a3378..9505b2aaa5 100644 --- a/docs/docbook/smbdotconf/tuning/maxopenfiles.xml +++ b/docs/docbook/smbdotconf/tuning/maxopenfiles.xml @@ -1,16 +1,19 @@ - - max open files (G) - 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. + + + 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. + 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 - - + Default: max open files = 10000 + + diff --git a/docs/docbook/smbdotconf/tuning/maxsmbdprocesses.xml b/docs/docbook/smbdotconf/tuning/maxsmbdprocesses.xml index e46f0185ce..453818ab7d 100644 --- a/docs/docbook/smbdotconf/tuning/maxsmbdprocesses.xml +++ b/docs/docbook/smbdotconf/tuning/maxsmbdprocesses.xml @@ -1,17 +1,18 @@ - - max smbd processes (G) - 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. - + + + 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 - - + 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 index acbb65fa41..0df75af0ab 100644 --- a/docs/docbook/smbdotconf/tuning/minprintspace.xml +++ b/docs/docbook/smbdotconf/tuning/minprintspace.xml @@ -1,14 +1,18 @@ - - min print space (S) - 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. + + + 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. + See also the printing + parameter. - Default: min print space = 0 - Example: min print space = 2000 - - + 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 index 0500a75c8d..6330760915 100644 --- a/docs/docbook/smbdotconf/tuning/namecachetimeout.xml +++ b/docs/docbook/smbdotconf/tuning/namecachetimeout.xml @@ -1,12 +1,15 @@ - - name cache timeout (G) - 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. - + + + 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 - Default: name cache timeout = 660 - Example: name cache timeout = 0 - - + Example: name cache timeout = 0 + + diff --git a/docs/docbook/smbdotconf/tuning/paranoidserversecurity.xml b/docs/docbook/smbdotconf/tuning/paranoidserversecurity.xml index d60f179176..3fababf01b 100644 --- a/docs/docbook/smbdotconf/tuning/paranoidserversecurity.xml +++ b/docs/docbook/smbdotconf/tuning/paranoidserversecurity.xml @@ -1,16 +1,18 @@ - - paranoid server security (G) - 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. - + + + 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. + 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 - - - + Default: paranoid server security = yes + + diff --git a/docs/docbook/smbdotconf/tuning/readsize.xml b/docs/docbook/smbdotconf/tuning/readsize.xml index 59c6848c76..c76b810225 100644 --- a/docs/docbook/smbdotconf/tuning/readsize.xml +++ b/docs/docbook/smbdotconf/tuning/readsize.xml @@ -1,25 +1,29 @@ - - read size (G) - 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. + + + 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. + 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. + 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 - - + Default: read size = 16384 + + Example: read size = 8192 + + diff --git a/docs/docbook/smbdotconf/tuning/socketoptions.xml b/docs/docbook/smbdotconf/tuning/socketoptions.xml index 3acc259083..5684ac5bca 100644 --- a/docs/docbook/smbdotconf/tuning/socketoptions.xml +++ b/docs/docbook/smbdotconf/tuning/socketoptions.xml @@ -1,69 +1,75 @@ - - socket options (G) - 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@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 - - + + + 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/statcachesize.xml b/docs/docbook/smbdotconf/tuning/statcachesize.xml index fe7d3a7be2..0c8d4e0c72 100644 --- a/docs/docbook/smbdotconf/tuning/statcachesize.xml +++ b/docs/docbook/smbdotconf/tuning/statcachesize.xml @@ -1,9 +1,12 @@ - - stat cache size (G) - This parameter determines the number of - entries in the stat cache. You should - never need to change this parameter. + + + This parameter determines the number of + entries in the stat cache. You should + never need to change this parameter. - Default: stat cache size = 50 - - + Default: stat cache size = 50 + + diff --git a/docs/docbook/smbdotconf/tuning/strictallocate.xml b/docs/docbook/smbdotconf/tuning/strictallocate.xml index 7b33ef3fc3..0d11519b04 100644 --- a/docs/docbook/smbdotconf/tuning/strictallocate.xml +++ b/docs/docbook/smbdotconf/tuning/strictallocate.xml @@ -1,21 +1,23 @@ - - strict allocate (S) - 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. + + + 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. + 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. + 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 - - + Default: strict allocate = no + + diff --git a/docs/docbook/smbdotconf/tuning/strictsync.xml b/docs/docbook/smbdotconf/tuning/strictsync.xml index b228f7cfcb..693806a503 100644 --- a/docs/docbook/smbdotconf/tuning/strictsync.xml +++ b/docs/docbook/smbdotconf/tuning/strictsync.xml @@ -1,23 +1,25 @@ - - strict sync (S) - 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. + + + 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. + See also the sync + always> parameter. - Default: strict sync = no - - + Default: strict sync = no + + diff --git a/docs/docbook/smbdotconf/tuning/syncalways.xml b/docs/docbook/smbdotconf/tuning/syncalways.xml index c5c32343a7..dca33eb802 100644 --- a/docs/docbook/smbdotconf/tuning/syncalways.xml +++ b/docs/docbook/smbdotconf/tuning/syncalways.xml @@ -1,19 +1,21 @@ - - sync always (S) - 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. + + + 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. + See also the strict + sync parameter. - Default: sync always = no - - + Default: sync always = no + + diff --git a/docs/docbook/smbdotconf/tuning/usemmap.xml b/docs/docbook/smbdotconf/tuning/usemmap.xml index 46fa4600de..1e79e07ef3 100644 --- a/docs/docbook/smbdotconf/tuning/usemmap.xml +++ b/docs/docbook/smbdotconf/tuning/usemmap.xml @@ -1,14 +1,17 @@ - - use mmap (G) - 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. - + + + 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 - - + Default: use mmap = yes + + diff --git a/docs/docbook/smbdotconf/tuning/usesendfile.xml b/docs/docbook/smbdotconf/tuning/usesendfile.xml index 5f2dcb72a9..6bbd651549 100644 --- a/docs/docbook/smbdotconf/tuning/usesendfile.xml +++ b/docs/docbook/smbdotconf/tuning/usesendfile.xml @@ -1,14 +1,15 @@ - - use sendfile (S) - 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. - + + + 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 - - + Default: use sendfile = no + + diff --git a/docs/docbook/smbdotconf/tuning/writecachesize.xml b/docs/docbook/smbdotconf/tuning/writecachesize.xml index b54a0e4fd6..8b5fbe66bd 100644 --- a/docs/docbook/smbdotconf/tuning/writecachesize.xml +++ b/docs/docbook/smbdotconf/tuning/writecachesize.xml @@ -1,27 +1,30 @@ - - write cache size (S) - 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. + + + 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. + 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. + The integer parameter specifies the size of this cache + (per oplocked file) in bytes. - Default: write cache size = 0 - Example: write cache size = 262144 + Default: write cache size = 0 - for a 256k cache size per file. - - + Example: write cache size = 262144 + + for a 256k cache size per file. + + diff --git a/docs/docs-status b/docs/docs-status index 6fdde80a69..60f18b17e5 100644 --- a/docs/docs-status +++ b/docs/docs-status @@ -59,6 +59,7 @@ docs/docbook/manpages/rpcclient.1.sgml - Some commands could be documented more docs/history - needs updating (is current up to 1998 - merge with 10year.html ?) Documentation for following smb.conf.5 parameters does not exist: +max reported print jobs // printing acl compatibility // protocol client signing // protocol client use spnego // protocol -- cgit