From 6cb4575b12ebb495883a6bf081ed17eccf641df4 Mon Sep 17 00:00:00 2001 From: Alexander Bokovoy Date: Tue, 8 Apr 2003 05:44:49 +0000 Subject: Finish conversion of Printing parameters (This used to be commit 6515b0cff8b0fec25010e5b33b6e7009356146fa) --- .../smbdotconf/printing/addprintercommand.xml | 107 +++++++++++---------- .../docbook/smbdotconf/printing/defaultdevmode.xml | 63 ++++++------ .../smbdotconf/printing/deleteprintercommand.xml | 63 ++++++------ .../smbdotconf/printing/enumportscommand.xml | 45 +++++---- .../docbook/smbdotconf/printing/lppausecommand.xml | 82 ++++++++-------- .../smbdotconf/printing/lpresumecommand.xml | 58 +++++------ docs/docbook/smbdotconf/printing/os2drivermap.xml | 37 +++---- docs/docbook/smbdotconf/printing/printer.xml | 15 +-- docs/docbook/smbdotconf/printing/printername.xml | 27 +++--- .../smbdotconf/printing/queuepausecommand.xml | 45 +++++---- .../smbdotconf/printing/queueresumecommand.xml | 52 +++++----- .../smbdotconf/printing/showaddprinterwizard.xml | 58 +++++------ .../smbdotconf/printing/useclientdriver.xml | 66 +++++++------ 13 files changed, 377 insertions(+), 341 deletions(-) (limited to 'docs/docbook/smbdotconf') diff --git a/docs/docbook/smbdotconf/printing/addprintercommand.xml b/docs/docbook/smbdotconf/printing/addprintercommand.xml index abff09cda4..63b3f567b1 100644 --- a/docs/docbook/smbdotconf/printing/addprintercommand.xml +++ b/docs/docbook/smbdotconf/printing/addprintercommand.xml @@ -1,60 +1,63 @@ - - addprinter command (G) - With the introduction of MS-RPC based printing - support for Windows NT/2000 clients in Samba 2.2, The MS Add - Printer Wizard (APW) icon is now also available in the - "Printers..." folder displayed a share listing. The APW - allows for printers to be add remotely to a Samba or Windows - NT/2000 print server. + + + With the introduction of MS-RPC based printing + support for Windows NT/2000 clients in Samba 2.2, The MS Add + Printer Wizard (APW) icon is now also available in the + "Printers..." folder displayed a share listing. The APW + allows for printers to be add remotely to a Samba or Windows + NT/2000 print server. - For a Samba host this means that the printer must be - physically added to the underlying printing system. The add - printer command defines a script to be run which - will perform the necessary operations for adding the printer - to the print system and to add the appropriate service definition - to the smb.conf file in order that it can be - shared by smbd - 8. + For a Samba host this means that the printer must be + physically added to the underlying printing system. The add + printer command defines a script to be run which + will perform the necessary operations for adding the printer + to the print system and to add the appropriate service definition + to the smb.conf file in order that it can be + shared by smbd + 8. - The addprinter command is - automatically invoked with the following parameter (in - order): + The addprinter command is + automatically invoked with the following parameter (in + order): - - printer name - share name - port name - driver name - location - Windows 9x driver location - - + + printer name + share name + port name + driver name + location + Windows 9x driver location + - All parameters are filled in from the PRINTER_INFO_2 structure sent - by the Windows NT/2000 client with one exception. The "Windows 9x - driver location" parameter is included for backwards compatibility - only. The remaining fields in the structure are generated from answers - to the APW questions. + All parameters are filled in from the PRINTER_INFO_2 structure sent + by the Windows NT/2000 client with one exception. The "Windows 9x + driver location" parameter is included for backwards compatibility + only. The remaining fields in the structure are generated from answers + to the APW questions. - Once the addprinter command has - been executed, smbd will reparse the - smb.conf to determine if the share defined by the APW - exists. If the sharename is still invalid, then smbd - will return an ACCESS_DENIED error to the client. + Once the addprinter command has + been executed, smbd will reparse the + smb.conf to determine if the share defined by the APW + exists. If the sharename is still invalid, then smbd + will return an ACCESS_DENIED error to the client. - - The "add printer command" program can output a single line of text, - which Samba will set as the port the new printer is connected to. - If this line isn't output, Samba won't reload its printer shares. - + + The "add printer command" program can output a single line of text, + which Samba will set as the port the new printer is connected to. + If this line isn't output, Samba won't reload its printer shares. + - See also - deleteprinter command, printing, - show add - printer wizard + See also + deleteprinter command, + printing, + show add + printer wizard - Default: none - Example: addprinter command = /usr/bin/addprinter - - - + Default: none + + Example: addprinter command = /usr/bin/addprinter + + diff --git a/docs/docbook/smbdotconf/printing/defaultdevmode.xml b/docs/docbook/smbdotconf/printing/defaultdevmode.xml index 9609038dcd..1f14b21f5f 100644 --- a/docs/docbook/smbdotconf/printing/defaultdevmode.xml +++ b/docs/docbook/smbdotconf/printing/defaultdevmode.xml @@ -1,34 +1,37 @@ - - default devmode (S) - This parameter is only applicable to printable services. When smbd is serving - Printer Drivers to Windows NT/2k/XP clients, each printer on the Samba - server has a Device Mode which defines things such as paper size and - orientation and duplex settings. The device mode can only correctly be - generated by the printer driver itself (which can only be executed on a - Win32 platform). Because smbd is unable to execute the driver code - to generate the device mode, the default behavior is to set this field - to NULL. - + + + This parameter is only applicable to printable services. + When smbd is serving Printer Drivers to Windows NT/2k/XP clients, each printer on the Samba + server has a Device Mode which defines things such as paper size and + orientation and duplex settings. The device mode can only correctly be + generated by the printer driver itself (which can only be executed on a + Win32 platform). Because smbd is unable to execute the driver code + to generate the device mode, the default behavior is to set this field + to NULL. + - Most problems with serving printer drivers to Windows NT/2k/XP clients - can be traced to a problem with the generated device mode. Certain drivers - will do things such as crashing the client's Explorer.exe with a NULL devmode. - However, other printer drivers can cause the client's spooler service - (spoolsv.exe) to die if the devmode was not created by the driver itself - (i.e. smbd generates a default devmode). - + Most problems with serving printer drivers to Windows NT/2k/XP clients + can be traced to a problem with the generated device mode. Certain drivers + will do things such as crashing the client's Explorer.exe with a NULL devmode. + However, other printer drivers can cause the client's spooler service + (spoolsv.exe) to die if the devmode was not created by the driver itself + (i.e. smbd generates a default devmode). + - This parameter should be used with care and tested with the printer - driver in question. It is better to leave the device mode to NULL - and let the Windows client set the correct values. Because drivers do not - do this all the time, setting default devmode = yes - will instruct smbd to generate a default one. - + This parameter should be used with care and tested with the printer + driver in question. It is better to leave the device mode to NULL + and let the Windows client set the correct values. Because drivers do not + do this all the time, setting default devmode = yes + will instruct smbd to generate a default one. + - For more information on Windows NT/2k printing and Device Modes, - see the MSDN documentation. - + For more information on Windows NT/2k printing and Device Modes, + see the MSDN documentation. + - Default: default devmode = no - - + Default: default devmode = no + + diff --git a/docs/docbook/smbdotconf/printing/deleteprintercommand.xml b/docs/docbook/smbdotconf/printing/deleteprintercommand.xml index 23f2ff76b0..864f75168d 100644 --- a/docs/docbook/smbdotconf/printing/deleteprintercommand.xml +++ b/docs/docbook/smbdotconf/printing/deleteprintercommand.xml @@ -1,35 +1,38 @@ - - deleteprinter command (G) - With the introduction of MS-RPC based printer - support for Windows NT/2000 clients in Samba 2.2, it is now - possible to delete printer at run time by issuing the - DeletePrinter() RPC call. + + + With the introduction of MS-RPC based printer + support for Windows NT/2000 clients in Samba 2.2, it is now + possible to delete printer at run time by issuing the + DeletePrinter() RPC call. - For a Samba host this means that the printer must be - physically deleted from underlying printing system. The - deleteprinter command defines a script to be run which - will perform the necessary operations for removing the printer - from the print system and from smb.conf. - + For a Samba host this means that the printer must be + physically deleted from underlying printing system. The + deleteprinter command defines a script to be run which + will perform the necessary operations for removing the printer + from the print system and from smb.conf. + - The deleteprinter command is - automatically called with only one parameter: - "printer name". + The deleteprinter command is + automatically called with only one parameter: + "printer name". - - Once the deleteprinter command has - been executed, smbd will reparse the - smb.conf to associated printer no longer exists. - If the sharename is still valid, then smbd - will return an ACCESS_DENIED error to the client. + Once the deleteprinter command has + been executed, smbd will reparse the + smb.conf to associated printer no longer exists. + If the sharename is still valid, then smbd + will return an ACCESS_DENIED error to the client. - See also - addprinter command, printing, - show add - printer wizard + See also + addprinter command, + printing, + show add + printer wizard - Default: none - Example: deleteprinter command = /usr/bin/removeprinter - - - + Default: none + + Example: deleteprinter command = /usr/bin/removeprinter + + diff --git a/docs/docbook/smbdotconf/printing/enumportscommand.xml b/docs/docbook/smbdotconf/printing/enumportscommand.xml index b1111a5e1c..89e510483f 100644 --- a/docs/docbook/smbdotconf/printing/enumportscommand.xml +++ b/docs/docbook/smbdotconf/printing/enumportscommand.xml @@ -1,22 +1,25 @@ - - enumports command (G) - The concept of a "port" is fairly foreign - to UNIX hosts. Under Windows NT/2000 print servers, a port - is associated with a port monitor and generally takes the form of - a local port (i.e. LPT1:, COM1:, FILE:) or a remote port - (i.e. LPD Port Monitor, etc...). By default, Samba has only one - port defined--"Samba Printer Port". Under - Windows NT/2000, all printers must have a valid port name. - If you wish to have a list of ports displayed (smbd - does not use a port name for anything) other than - the default "Samba Printer Port", you - can define enumports command to point to - a program which should generate a list of ports, one per line, - to standard output. This listing will then be used in response - to the level 1 and 2 EnumPorts() RPC. + + + The concept of a "port" is fairly foreign + to UNIX hosts. Under Windows NT/2000 print servers, a port + is associated with a port monitor and generally takes the form of + a local port (i.e. LPT1:, COM1:, FILE:) or a remote port + (i.e. LPD Port Monitor, etc...). By default, Samba has only one + port defined--"Samba Printer Port". Under + Windows NT/2000, all printers must have a valid port name. + If you wish to have a list of ports displayed (smbd + does not use a port name for anything) other than + the default "Samba Printer Port", you + can define enumports command to point to + a program which should generate a list of ports, one per line, + to standard output. This listing will then be used in response + to the level 1 and 2 EnumPorts() RPC. - Default: no enumports command - Example: enumports command = /usr/bin/listports - - - + Default: no enumports command + + Example: enumports command = /usr/bin/listports + + diff --git a/docs/docbook/smbdotconf/printing/lppausecommand.xml b/docs/docbook/smbdotconf/printing/lppausecommand.xml index 34d7c7f800..15c5aca990 100644 --- a/docs/docbook/smbdotconf/printing/lppausecommand.xml +++ b/docs/docbook/smbdotconf/printing/lppausecommand.xml @@ -1,41 +1,43 @@ - - lppause command (S) - This parameter specifies the command to be - executed on the server host in order to stop printing or spooling - a specific print job. - - This command should be a program or script which takes - a printer name and job number to pause the print job. One way - of implementing this is by using job priorities, where jobs - having a too low priority won't be sent to the printer. - - If a %p is given then the printer name - is put in its place. A %j is replaced with - the job number (an integer). On HPUX (see printing=hpux - ), if the -p%p option is added - to the lpq command, the job will show up with the correct status, i.e. - if the job priority is lower than the set fence priority it will - have the PAUSED status, whereas if the priority is equal or higher it - will have the SPOOLED or PRINTING status. - - Note that it is good practice to include the absolute path - in the lppause command as the PATH may not be available to the server. - - See also the printing - parameter. - - Default: Currently no default value is given to - this string, unless the value of the printing - parameter is SYSV, in which case the default is : - - lp -i %p-%j -H hold - - or if the value of the printing parameter - is SOFTQ, then the default is: - - qstat -s -j%j -h + + + This parameter specifies the command to be + executed on the server host in order to stop printing or spooling + a specific print job. + + This command should be a program or script which takes + a printer name and job number to pause the print job. One way + of implementing this is by using job priorities, where jobs + having a too low priority won't be sent to the printer. + + If a %p is given then the printer name + is put in its place. A %j is replaced with + the job number (an integer). On HPUX (see printing=hpux + ), if the -p%p option is added + to the lpq command, the job will show up with the correct status, i.e. + if the job priority is lower than the set fence priority it will + have the PAUSED status, whereas if the priority is equal or higher it + will have the SPOOLED or PRINTING status. + + Note that it is good practice to include the absolute path + in the lppause command as the PATH may not be available to the server. + + See also the printing + parameter. + + Default: Currently no default value is given to + this string, unless the value of the printing + parameter is SYSV, in which case the default is : + + lp -i %p-%j -H hold + + or if the value of the printing parameter + is SOFTQ, then the default is: + + qstat -s -j%j -h - Example for HPUX: lppause command = /usr/bin/lpalt - %p-%j -p0 - - + Example for HPUX: lppause command = /usr/bin/lpalt %p-%j -p0 + + diff --git a/docs/docbook/smbdotconf/printing/lpresumecommand.xml b/docs/docbook/smbdotconf/printing/lpresumecommand.xml index fbb1ac71ad..ae3241bfa9 100644 --- a/docs/docbook/smbdotconf/printing/lpresumecommand.xml +++ b/docs/docbook/smbdotconf/printing/lpresumecommand.xml @@ -1,37 +1,39 @@ - - lpresume command (S) - This parameter specifies the command to be - executed on the server host in order to restart or continue - printing or spooling a specific print job. + + + This parameter specifies the command to be + executed on the server host in order to restart or continue + printing or spooling a specific print job. - This command should be a program or script which takes - a printer name and job number to resume the print job. See - also the lppause command - parameter. + This command should be a program or script which takes + a printer name and job number to resume the print job. See + also the lppause command + parameter. - 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 lpresume command as the PATH may not - be available to the server. + Note that it is good practice to include the absolute path + in the lpresume command as the PATH may not + be available to the server. - See also the printing - parameter. + See also the printing + parameter. - Default: Currently no default value is given - to this string, unless the value of the printing - parameter is SYSV, in which case the default is : + Default: Currently no default value is given + to this string, unless the value of the printing + parameter is SYSV, in which case the default is : - lp -i %p-%j -H resume + lp -i %p-%j -H resume - or if the value of the printing parameter - is SOFTQ, then the default is: + or if the value of the printing parameter + is SOFTQ, then the default is: - qstat -s -j%j -r + qstat -s -j%j -r - Example for HPUX: lpresume command = /usr/bin/lpalt - %p-%j -p2 - - + Example for HPUX: lpresume command = /usr/bin/lpalt %p-%j -p2 + + diff --git a/docs/docbook/smbdotconf/printing/os2drivermap.xml b/docs/docbook/smbdotconf/printing/os2drivermap.xml index fdfba35a49..478031c7b9 100644 --- a/docs/docbook/smbdotconf/printing/os2drivermap.xml +++ b/docs/docbook/smbdotconf/printing/os2drivermap.xml @@ -1,22 +1,23 @@ - - os2 driver map (G) - The parameter is used to define the absolute - path to a file containing a mapping of Windows NT printer driver - names to OS/2 printer driver names. The format is: + + + The parameter is used to define the absolute + path to a file containing a mapping of Windows NT printer driver + names to OS/2 printer driver names. The format is: - <nt driver name> = <os2 driver - name>.<device name> + <nt driver name> = <os2 driver name>.<device name> - For example, a valid entry using the HP LaserJet 5 - printer driver would appear as HP LaserJet 5L = LASERJET.HP - LaserJet 5L. + For example, a valid entry using the HP LaserJet 5 + printer driver would appear as HP LaserJet 5L = LASERJET.HP + LaserJet 5L. - The need for the file is due to the printer driver namespace - problem described in the Samba - Printing HOWTO. For more details on OS/2 clients, please - refer to the OS2-Client-HOWTO containing in the Samba documentation. + The need for the file is due to the printer driver namespace + problem described in the Samba + Printing HOWTO. For more details on OS/2 clients, please + refer to the OS2-Client-HOWTO containing in the Samba documentation. - Default: os2 driver map = <empty string> - - - + Default: os2 driver map = <empty string> + + diff --git a/docs/docbook/smbdotconf/printing/printer.xml b/docs/docbook/smbdotconf/printing/printer.xml index 4cf90b06fa..0a9611ee03 100644 --- a/docs/docbook/smbdotconf/printing/printer.xml +++ b/docs/docbook/smbdotconf/printing/printer.xml @@ -1,6 +1,9 @@ - - printer (S) - Synonym for - printer name. - - + + + Synonym for + printer name. + + diff --git a/docs/docbook/smbdotconf/printing/printername.xml b/docs/docbook/smbdotconf/printing/printername.xml index 25e6afa1f2..9f76a673ad 100644 --- a/docs/docbook/smbdotconf/printing/printername.xml +++ b/docs/docbook/smbdotconf/printing/printername.xml @@ -1,15 +1,18 @@ - - printer name (S) - This parameter specifies the name of the printer - to which print jobs spooled through a printable service will be sent. + + + This parameter specifies the name of the printer + to which print jobs spooled through a printable service will be sent. - If specified in the [global] section, the printer - name given will be used for any printable service that does - not have its own printer name specified. + If specified in the [global] section, the printer + name given will be used for any printable service that does + not have its own printer name specified. - Default: none (but may be lp - on many systems) + Default: none (but may be lp + on many systems) - Example: printer name = laserwriter - - + Example: printer name = laserwriter + + diff --git a/docs/docbook/smbdotconf/printing/queuepausecommand.xml b/docs/docbook/smbdotconf/printing/queuepausecommand.xml index c991994f7f..13741a0e7f 100644 --- a/docs/docbook/smbdotconf/printing/queuepausecommand.xml +++ b/docs/docbook/smbdotconf/printing/queuepausecommand.xml @@ -1,26 +1,29 @@ - - queuepause command (S) - This parameter specifies the command to be - executed on the server host in order to pause the printer queue. + + + This parameter specifies the command to be + executed on the server host in order to pause the printer queue. - This command should be a program or script which takes - a printer name as its only parameter and stops the printer queue, - such that no longer jobs are submitted to the printer. + This command should be a program or script which takes + a printer name as its only parameter and stops the printer queue, + such that no longer jobs are submitted to the printer. - This command is not supported by Windows for Workgroups, - but can be issued from the Printers window under Windows 95 - and NT. + This command is not supported by Windows for Workgroups, + but can be issued from the Printers window under Windows 95 + and NT. - If a %p is given then the printer name - is put in its place. Otherwise it is placed at the end of the command. - + 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 command as the PATH may not be available to the - server. + Note that it is good practice to include the absolute + path in the command as the PATH may not be available to the + server. - Default: depends on the setting of printing - - Example: queuepause command = disable %p - - + Default: depends on the setting of printing + + Example: queuepause command = disable %p + + diff --git a/docs/docbook/smbdotconf/printing/queueresumecommand.xml b/docs/docbook/smbdotconf/printing/queueresumecommand.xml index 7c0d60961a..23f6702192 100644 --- a/docs/docbook/smbdotconf/printing/queueresumecommand.xml +++ b/docs/docbook/smbdotconf/printing/queueresumecommand.xml @@ -1,31 +1,33 @@ - - queueresume command (S) - This parameter specifies the command to be - executed on the server host in order to resume the printer queue. It - is the command to undo the behavior that is caused by the - previous parameter ( - queuepause command). + + + This parameter specifies the command to be + executed on the server host in order to resume the printer queue. It + is the command to undo the behavior that is caused by the + previous parameter ( + queuepause command). - This command should be a program or script which takes - a printer name as its only parameter and resumes the printer queue, - such that queued jobs are resubmitted to the printer. + This command should be a program or script which takes + a printer name as its only parameter and resumes the printer queue, + such that queued jobs are resubmitted to the printer. - This command is not supported by Windows for Workgroups, - but can be issued from the Printers window under Windows 95 - and NT. + This command is not supported by Windows for Workgroups, + but can be issued from the Printers window under Windows 95 + and NT. - If a %p is given then the printer name - is put in its place. Otherwise it is placed at the end of the - command. + 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 command as the PATH may not be available to the - server. + Note that it is good practice to include the absolute + path in the command as the PATH may not be available to the + server. - Default: depends on the setting of printing - + Default: depends on the setting of + printing - Example: queuepause command = enable %p - - - + Example: queuepause command = enable %p + + diff --git a/docs/docbook/smbdotconf/printing/showaddprinterwizard.xml b/docs/docbook/smbdotconf/printing/showaddprinterwizard.xml index 9bf5160ad5..5a0d5c8877 100644 --- a/docs/docbook/smbdotconf/printing/showaddprinterwizard.xml +++ b/docs/docbook/smbdotconf/printing/showaddprinterwizard.xml @@ -1,31 +1,35 @@ - - show add printer wizard (G) - With the introduction of MS-RPC based printing support - for Windows NT/2000 client in Samba 2.2, a "Printers..." folder will - appear on Samba hosts in the share listing. Normally this folder will - contain an icon for the MS Add Printer Wizard (APW). However, it is - possible to disable this feature regardless of the level of privilege - of the connected user. + + + With the introduction of MS-RPC based printing support + for Windows NT/2000 client in Samba 2.2, a "Printers..." folder will + appear on Samba hosts in the share listing. Normally this folder will + contain an icon for the MS Add Printer Wizard (APW). However, it is + possible to disable this feature regardless of the level of privilege + of the connected user. - Under normal circumstances, the Windows NT/2000 client will - open a handle on the printer server with OpenPrinterEx() asking for - Administrator privileges. If the user does not have administrative - access on the print server (i.e is not root or a member of the - printer admin group), the OpenPrinterEx() - call fails and the client makes another open call with a request for - a lower privilege level. This should succeed, however the APW - icon will not be displayed. + Under normal circumstances, the Windows NT/2000 client will + open a handle on the printer server with OpenPrinterEx() asking for + Administrator privileges. If the user does not have administrative + access on the print server (i.e is not root or a member of the + printer admin group), the OpenPrinterEx() + call fails and the client makes another open call with a request for + a lower privilege level. This should succeed, however the APW + icon will not be displayed. - Disabling the show add printer wizard - parameter will always cause the OpenPrinterEx() on the server - to fail. Thus the APW icon will never be displayed. - Note :This does not prevent the same user from having - administrative privilege on an individual printer. + Disabling the show add printer wizard + parameter will always cause the OpenPrinterEx() on the server + to fail. Thus the APW icon will never be displayed. + Note :This does not prevent the same user from having + administrative privilege on an individual printer. - See also addprinter - command, - deleteprinter command, printer admin + See also addprinter + command, + deleteprinter command, + printer admin - Default :show add printer wizard = yes - - + Default :show add printer wizard = yes + + diff --git a/docs/docbook/smbdotconf/printing/useclientdriver.xml b/docs/docbook/smbdotconf/printing/useclientdriver.xml index 8327d0aaa4..bc4162333b 100644 --- a/docs/docbook/smbdotconf/printing/useclientdriver.xml +++ b/docs/docbook/smbdotconf/printing/useclientdriver.xml @@ -1,35 +1,39 @@ - - use client driver (S) - This parameter applies only to Windows NT/2000 - clients. It has no affect on Windows 95/98/ME clients. When - serving a printer to Windows NT/2000 clients without first installing - a valid printer driver on the Samba host, the client will be required - to install a local printer driver. From this point on, the client - will treat the print as a local printer and not a network printer - connection. This is much the same behavior that will occur - when disable spoolss = yes. + + + This parameter applies only to Windows NT/2000 + clients. It has no affect on Windows 95/98/ME clients. When + serving a printer to Windows NT/2000 clients without first installing + a valid printer driver on the Samba host, the client will be required + to install a local printer driver. From this point on, the client + will treat the print as a local printer and not a network printer + connection. This is much the same behavior that will occur + when disable spoolss = yes. + - The differentiating - factor is that under normal circumstances, the NT/2000 client will - attempt to open the network printer using MS-RPC. The problem is that - because the client considers the printer to be local, it will attempt - to issue the OpenPrinterEx() call requesting access rights associated - with the logged on user. If the user possesses local administator rights - but not root privilegde on the Samba host (often the case), the OpenPrinterEx() - call will fail. The result is that the client will now display an "Access - Denied; Unable to connect" message in the printer queue window (even though - jobs may successfully be printed). + The differentiating factor is that under normal + circumstances, the NT/2000 client will attempt to open the network + printer using MS-RPC. The problem is that because the client + considers the printer to be local, it will attempt to issue the + OpenPrinterEx() call requesting access rights associated with the + logged on user. If the user possesses local administator rights but + not root privilegde on the Samba host (often the case), the + OpenPrinterEx() call will fail. The result is that the client will + now display an "Access Denied; Unable to connect" message + in the printer queue window (even though jobs may successfully be + printed). - If this parameter is enabled for a printer, then any attempt - to open the printer with the PRINTER_ACCESS_ADMINISTER right is mapped - to PRINTER_ACCESS_USE instead. Thus allowing the OpenPrinterEx() - call to succeed. This parameter MUST not be able enabled - on a print share which has valid print driver installed on the Samba - server. + If this parameter is enabled for a printer, then any attempt + to open the printer with the PRINTER_ACCESS_ADMINISTER right is mapped + to PRINTER_ACCESS_USE instead. Thus allowing the OpenPrinterEx() + call to succeed. This parameter MUST not be able enabled + on a print share which has valid print driver installed on the Samba + server. - See also disable spoolss - + See also disable spoolss - Default: use client driver = no - - + Default: use client driver = no + + -- cgit From a384176cb93ab5b3db56675674bf7b0d4778ecec Mon Sep 17 00:00:00 2001 From: Alexander Bokovoy Date: Wed, 9 Apr 2003 14:38:24 +0000 Subject: Next batch of conversions: File names. Fixed some wrong context marks (most of "hide ..." parameters are per-share) (This used to be commit 0f8d5b210a60a40f95a43daf06d3d8686985ecd1) --- docs/docbook/smbdotconf/filename/casesensitive.xml | 14 +++--- docs/docbook/smbdotconf/filename/casesignames.xml | 13 +++-- docs/docbook/smbdotconf/filename/defaultcase.xml | 18 ++++--- .../smbdotconf/filename/deletevetofiles.xml | 45 +++++++++-------- docs/docbook/smbdotconf/filename/hidedotfiles.xml | 15 +++--- docs/docbook/smbdotconf/filename/hidefiles.xml | 58 ++++++++++++---------- .../smbdotconf/filename/hidespecialfiles.xml | 20 ++++---- .../docbook/smbdotconf/filename/hideunreadable.xml | 16 +++--- .../smbdotconf/filename/hideunwriteablefiles.xml | 20 ++++---- docs/docbook/smbdotconf/filename/manglecase.xml | 15 +++--- docs/docbook/smbdotconf/filename/mangledstack.xml | 42 +++++++++------- docs/docbook/smbdotconf/filename/mangleprefix.xml | 27 ++++++---- docs/docbook/smbdotconf/filename/manglingchar.xml | 23 +++++---- .../docbook/smbdotconf/filename/manglingmethod.xml | 33 ++++++------ docs/docbook/smbdotconf/filename/preservecase.xml | 23 +++++---- .../smbdotconf/filename/shortpreservecase.xml | 29 +++++------ docs/docbook/smbdotconf/filename/stripdot.xml | 19 ++++--- 17 files changed, 238 insertions(+), 192 deletions(-) (limited to 'docs/docbook/smbdotconf') diff --git a/docs/docbook/smbdotconf/filename/casesensitive.xml b/docs/docbook/smbdotconf/filename/casesensitive.xml index 622aea329e..94b20d6c0c 100644 --- a/docs/docbook/smbdotconf/filename/casesensitive.xml +++ b/docs/docbook/smbdotconf/filename/casesensitive.xml @@ -1,7 +1,9 @@ - - case sensitive (S) - See the discussion in the section NAME MANGLING. + + + See the discussion in the section NAME MANGLING. - Default: case sensitive = no - - + Default: case sensitive = no + + diff --git a/docs/docbook/smbdotconf/filename/casesignames.xml b/docs/docbook/smbdotconf/filename/casesignames.xml index 94bcb85984..3254b545c5 100644 --- a/docs/docbook/smbdotconf/filename/casesignames.xml +++ b/docs/docbook/smbdotconf/filename/casesignames.xml @@ -1,5 +1,8 @@ - - casesignames (S) - Synonym for case - sensitive. - + + + Synonym for case sensitive. + + diff --git a/docs/docbook/smbdotconf/filename/defaultcase.xml b/docs/docbook/smbdotconf/filename/defaultcase.xml index f2bdf5db1c..de3ad35c0c 100644 --- a/docs/docbook/smbdotconf/filename/defaultcase.xml +++ b/docs/docbook/smbdotconf/filename/defaultcase.xml @@ -1,9 +1,11 @@ - - default case (S) - See the section on - NAME MANGLING. Also note the - short preserve case parameter. + + + See the section on + NAME MANGLING. Also note the + short preserve case parameter. - Default: default case = lower - - + Default: default case = lower + + diff --git a/docs/docbook/smbdotconf/filename/deletevetofiles.xml b/docs/docbook/smbdotconf/filename/deletevetofiles.xml index 49a5e2232f..c851824b7e 100644 --- a/docs/docbook/smbdotconf/filename/deletevetofiles.xml +++ b/docs/docbook/smbdotconf/filename/deletevetofiles.xml @@ -1,25 +1,28 @@ - - delete veto files (S) - This option is used when Samba is attempting to - delete a directory that contains one or more vetoed directories - (see the veto files - option). If this option is set to no (the default) then if a vetoed - directory contains any non-vetoed files or directories then the - directory delete will fail. This is usually what you want. + + + This option is used when Samba is attempting to + delete a directory that contains one or more vetoed directories + (see the veto files + option). If this option is set to no (the default) then if a vetoed + directory contains any non-vetoed files or directories then the + directory delete will fail. This is usually what you want. - If this option is set to yes, then Samba - will attempt to recursively delete any files and directories within - the vetoed directory. This can be useful for integration with file - serving systems such as NetAtalk which create meta-files within - directories you might normally veto DOS/Windows users from seeing - (e.g. .AppleDouble) + If this option is set to yes, then Samba + will attempt to recursively delete any files and directories within + the vetoed directory. This can be useful for integration with file + serving systems such as NetAtalk which create meta-files within + directories you might normally veto DOS/Windows users from seeing + (e.g. .AppleDouble) - Setting delete veto files = yes allows these - directories to be transparently deleted when the parent directory - is deleted (so long as the user has permissions to do so). + Setting delete veto files = yes allows these + directories to be transparently deleted when the parent directory + is deleted (so long as the user has permissions to do so). - See also the veto - files parameter. + See also the veto + files parameter. - Default: delete veto files = no - + Default: delete veto files = no + + diff --git a/docs/docbook/smbdotconf/filename/hidedotfiles.xml b/docs/docbook/smbdotconf/filename/hidedotfiles.xml index 63e87d8059..1728f01f8f 100644 --- a/docs/docbook/smbdotconf/filename/hidedotfiles.xml +++ b/docs/docbook/smbdotconf/filename/hidedotfiles.xml @@ -1,7 +1,10 @@ - - hide dot files (S) - This is a boolean parameter that controls whether - files starting with a dot appear as hidden files. + + + This is a boolean parameter that controls whether + files starting with a dot appear as hidden files. - Default: hide dot files = yes - + Default: hide dot files = yes + + diff --git a/docs/docbook/smbdotconf/filename/hidefiles.xml b/docs/docbook/smbdotconf/filename/hidefiles.xml index 6f93a2a239..b687fc5a1f 100644 --- a/docs/docbook/smbdotconf/filename/hidefiles.xml +++ b/docs/docbook/smbdotconf/filename/hidefiles.xml @@ -1,35 +1,39 @@ - - hide files(S) - This is a list of files or directories that are not - visible but are accessible. The DOS 'hidden' attribute is applied - to any files or directories that match. + + + This is a list of files or directories that are not + visible but are accessible. The DOS 'hidden' attribute is applied + to any files or directories that match. - Each entry in the list must be separated by a '/', - which allows spaces to be included in the entry. '*' - and '?' can be used to specify multiple files or directories - as in DOS wildcards. + Each entry in the list must be separated by a '/', + which allows spaces to be included in the entry. '*' + and '?' can be used to specify multiple files or directories + as in DOS wildcards. - Each entry must be a Unix path, not a DOS path and must - not include the Unix directory separator '/'. + Each entry must be a Unix path, not a DOS path and must + not include the Unix directory separator '/'. - Note that the case sensitivity option is applicable - in hiding files. + Note that the case sensitivity option is applicable + in hiding files. - Setting this parameter will affect the performance of Samba, - as it will be forced to check all files and directories for a match - as they are scanned. + Setting this parameter will affect the performance of Samba, + as it will be forced to check all files and directories for a match + as they are scanned. - See also hide - dot files, - veto files and - case sensitive. + See also hide + dot files, + veto files and + case sensitive. - Default: no file are hidden - Example: hide files = + Default: no file are hidden + + Example: hide files = /.*/DesktopFolderDB/TrashFor%m/resource.frk/ - The above example is based on files that the Macintosh - SMB client (DAVE) available from - Thursby creates for internal use, and also still hides - all files beginning with a dot. - + The above example is based on files that the Macintosh + SMB client (DAVE) available from + Thursby creates for internal use, and also still hides + all files beginning with a dot. + + diff --git a/docs/docbook/smbdotconf/filename/hidespecialfiles.xml b/docs/docbook/smbdotconf/filename/hidespecialfiles.xml index 9a8c206097..815e8ea63c 100644 --- a/docs/docbook/smbdotconf/filename/hidespecialfiles.xml +++ b/docs/docbook/smbdotconf/filename/hidespecialfiles.xml @@ -1,10 +1,12 @@ - - hide special files (G) - This parameter prevents clients from seeing - special files such as sockets, devices and fifo's in directory - listings. - + + + This parameter prevents clients from seeing + special files such as sockets, devices and fifo's in directory + listings. + - Default: hide special files = no - - + Default: hide special files = no + + diff --git a/docs/docbook/smbdotconf/filename/hideunreadable.xml b/docs/docbook/smbdotconf/filename/hideunreadable.xml index d25153f103..f34a3a597d 100644 --- a/docs/docbook/smbdotconf/filename/hideunreadable.xml +++ b/docs/docbook/smbdotconf/filename/hideunreadable.xml @@ -1,8 +1,10 @@ - - hide unreadable (G) - This parameter prevents clients from seeing the - existance of files that cannot be read. Defaults to off. + + + This parameter prevents clients from seeing the + existance of files that cannot be read. Defaults to off. - Default: hide unreadable = no - - + Default: hide unreadable = no + + diff --git a/docs/docbook/smbdotconf/filename/hideunwriteablefiles.xml b/docs/docbook/smbdotconf/filename/hideunwriteablefiles.xml index 9e28e8de5c..7d20296ff2 100644 --- a/docs/docbook/smbdotconf/filename/hideunwriteablefiles.xml +++ b/docs/docbook/smbdotconf/filename/hideunwriteablefiles.xml @@ -1,10 +1,12 @@ - - hide unwriteable files (G) - This parameter prevents clients from seeing - the existance of files that cannot be written to. Defaults to off. - Note that unwriteable directories are shown as usual. - + + + This parameter prevents clients from seeing + the existance of files that cannot be written to. Defaults to off. + Note that unwriteable directories are shown as usual. + - Default: hide unwriteable = no - - + Default: hide unwriteable = no + + diff --git a/docs/docbook/smbdotconf/filename/manglecase.xml b/docs/docbook/smbdotconf/filename/manglecase.xml index 170d77d453..d514375c3b 100644 --- a/docs/docbook/smbdotconf/filename/manglecase.xml +++ b/docs/docbook/smbdotconf/filename/manglecase.xml @@ -1,8 +1,9 @@ - - mangle case (S) - See the section on - NAME MANGLING + + + See the section on NAME MANGLING - Default: mangle case = no - - + Default: mangle case = no + + diff --git a/docs/docbook/smbdotconf/filename/mangledstack.xml b/docs/docbook/smbdotconf/filename/mangledstack.xml index 3e6099ba92..42083d13a2 100644 --- a/docs/docbook/smbdotconf/filename/mangledstack.xml +++ b/docs/docbook/smbdotconf/filename/mangledstack.xml @@ -1,23 +1,27 @@ - - mangled stack (G) - This parameter controls the number of mangled names - that should be cached in the Samba server smbd - 8. + + + This parameter controls the number of mangled names + that should be cached in the Samba server smbd + 8. - This stack is a list of recently mangled base names - (extensions are only maintained if they are longer than 3 characters - or contains upper case characters). + This stack is a list of recently mangled base names + (extensions are only maintained if they are longer than 3 characters + or contains upper case characters). - The larger this value, the more likely it is that mangled - names can be successfully converted to correct long UNIX names. - However, large stack sizes will slow most directory accesses. Smaller - stacks save memory in the server (each stack element costs 256 bytes). - + The larger this value, the more likely it is that mangled + names can be successfully converted to correct long UNIX names. + However, large stack sizes will slow most directory accesses. Smaller + stacks save memory in the server (each stack element costs 256 bytes). + - It is not possible to absolutely guarantee correct long - filenames, so be prepared for some surprises! + It is not possible to absolutely guarantee correct long + filenames, so be prepared for some surprises! - Default: mangled stack = 50 - Example: mangled stack = 100 - - + Default: mangled stack = 50 + + Example: mangled stack = 100 + + diff --git a/docs/docbook/smbdotconf/filename/mangleprefix.xml b/docs/docbook/smbdotconf/filename/mangleprefix.xml index 7dfd46199c..5476ed1f08 100644 --- a/docs/docbook/smbdotconf/filename/mangleprefix.xml +++ b/docs/docbook/smbdotconf/filename/mangleprefix.xml @@ -1,11 +1,16 @@ - - mangle prefix (G) - controls the number of prefix - characters from the original name used when generating - the mangled names. A larger value will give a weaker - hash and therefore more name collisions. The minimum - value is 1 and the maximum value is 6. - Default: mangle prefix = 1 - Example: mangle prefix = 4 - - + + + controls the number of prefix + characters from the original name used when generating + the mangled names. A larger value will give a weaker + hash and therefore more name collisions. The minimum + value is 1 and the maximum value is 6. + + Default: mangle prefix = 1 + + Example: mangle prefix = 4 + + diff --git a/docs/docbook/smbdotconf/filename/manglingchar.xml b/docs/docbook/smbdotconf/filename/manglingchar.xml index e6a9050466..57c4fa2acd 100644 --- a/docs/docbook/smbdotconf/filename/manglingchar.xml +++ b/docs/docbook/smbdotconf/filename/manglingchar.xml @@ -1,11 +1,14 @@ - - mangling char (S) - This controls what character is used as - the magic character in name mangling. The default is a '~' - but this may interfere with some software. Use this option to set - it to whatever you prefer. + + + This controls what character is used as + the magic character in name mangling. The + default is a '~' but this may interfere with some software. Use this option to set + it to whatever you prefer. - Default: mangling char = ~ - Example: mangling char = ^ - - + Default: mangling char = ~ + + Example: mangling char = ^ + + diff --git a/docs/docbook/smbdotconf/filename/manglingmethod.xml b/docs/docbook/smbdotconf/filename/manglingmethod.xml index 11f9e9eb01..74366483bd 100644 --- a/docs/docbook/smbdotconf/filename/manglingmethod.xml +++ b/docs/docbook/smbdotconf/filename/manglingmethod.xml @@ -1,14 +1,19 @@ - - mangling method (G) - controls the algorithm used for the generating - the mangled names. Can take two different values, "hash" and - "hash2". "hash" is the default and is the algorithm that has been - used in Samba for many years. "hash2" is a newer and considered - a better algorithm (generates less collisions) in the names. - However, many Win32 applications store the mangled names and so - changing to the new algorithm must not be done - lightly as these applications may break unless reinstalled. - Default: mangling method = hash2 - Example: mangling method = hash - - + + + controls the algorithm used for the generating + the mangled names. Can take two different values, "hash" and + "hash2". "hash" is the default and is the algorithm that has been + used in Samba for many years. "hash2" is a newer and considered + a better algorithm (generates less collisions) in the names. + However, many Win32 applications store the mangled names and so + changing to the new algorithm must not be done + lightly as these applications may break unless reinstalled. + + Default: mangling method = hash2 + + Example: mangling method = hash + + diff --git a/docs/docbook/smbdotconf/filename/preservecase.xml b/docs/docbook/smbdotconf/filename/preservecase.xml index 3be458ce15..d8a4e2342d 100644 --- a/docs/docbook/smbdotconf/filename/preservecase.xml +++ b/docs/docbook/smbdotconf/filename/preservecase.xml @@ -1,13 +1,14 @@ - - preserve case (S) - This controls if new filenames are created - with the case that the client passes, or if they are forced to - be the default case - . + + + This controls if new filenames are created + with the case that the client passes, or if they are forced to + be the default case + . - Default: preserve case = yes + Default: preserve case = yes - See the section on NAME - MANGLING for a fuller discussion. - - + See the section on NAME MANGLING for a fuller discussion. + + diff --git a/docs/docbook/smbdotconf/filename/shortpreservecase.xml b/docs/docbook/smbdotconf/filename/shortpreservecase.xml index 1c8b36380d..52c93e1370 100644 --- a/docs/docbook/smbdotconf/filename/shortpreservecase.xml +++ b/docs/docbook/smbdotconf/filename/shortpreservecase.xml @@ -1,16 +1,17 @@ - - short preserve case (S) - This boolean parameter controls if new files - which conform to 8.3 syntax, that is all in upper case and of - suitable length, are created upper case, or if they are forced - to be the default case - . This option can be use with preserve case = yes - to permit long filenames to retain their case, while short - names are lowered. + + + This boolean parameter controls if new files + which conform to 8.3 syntax, that is all in upper case and of + suitable length, are created upper case, or if they are forced + to be the default case + . This option can be use with preserve case = yes + to permit long filenames to retain their case, while short + names are lowered. - See the section on - NAME MANGLING. + See the section on NAME MANGLING. - Default: short preserve case = yes - - + Default: short preserve case = yes + + diff --git a/docs/docbook/smbdotconf/filename/stripdot.xml b/docs/docbook/smbdotconf/filename/stripdot.xml index ff877144a6..afed63a12b 100644 --- a/docs/docbook/smbdotconf/filename/stripdot.xml +++ b/docs/docbook/smbdotconf/filename/stripdot.xml @@ -1,9 +1,12 @@ - - strip dot (G) - This is a boolean that controls whether to - strip trailing dots off UNIX filenames. This helps with some - CDROMs that have filenames ending in a single dot. + + + This is a boolean that controls whether to + strip trailing dots off UNIX filenames. This helps with some + CDROMs that have filenames ending in a single dot. - Default: strip dot = no - - + Default: strip dot = no + + -- cgit From 42233f5c5876c1fde9ada8aaac0f1f568aacc4df Mon Sep 17 00:00:00 2001 From: Alexander Bokovoy Date: Wed, 9 Apr 2003 15:53:41 +0000 Subject: Finish conversion of Filenames (This used to be commit 8e0f0dbbbcb3179f1a868c72720e4eaf530e0a79) --- docs/docbook/smbdotconf/filename/mangledmap.xml | 41 +++++++------ docs/docbook/smbdotconf/filename/manglednames.xml | 71 ++++++++++++---------- docs/docbook/smbdotconf/filename/maparchive.xml | 32 +++++----- docs/docbook/smbdotconf/filename/maphidden.xml | 24 ++++---- docs/docbook/smbdotconf/filename/mapsystem.xml | 24 ++++---- docs/docbook/smbdotconf/filename/statcache.xml | 21 ++++--- docs/docbook/smbdotconf/filename/vetofiles.xml | 60 +++++++++--------- .../smbdotconf/filename/vetooplockfiles.xml | 43 ++++++------- 8 files changed, 170 insertions(+), 146 deletions(-) (limited to 'docs/docbook/smbdotconf') diff --git a/docs/docbook/smbdotconf/filename/mangledmap.xml b/docs/docbook/smbdotconf/filename/mangledmap.xml index abe6c031e0..e790fa877d 100644 --- a/docs/docbook/smbdotconf/filename/mangledmap.xml +++ b/docs/docbook/smbdotconf/filename/mangledmap.xml @@ -1,23 +1,26 @@ - - mangled map (S) - This is for those who want to directly map UNIX - file names which cannot be represented on Windows/DOS. The mangling - of names is not always what is needed. In particular you may have - documents with file extensions that differ between DOS and UNIX. - For example, under UNIX it is common to use .html - for HTML files, whereas under Windows/DOS .htm - is more commonly used. + + + This is for those who want to directly map UNIX + file names which cannot be represented on Windows/DOS. The mangling + of names is not always what is needed. In particular you may have + documents with file extensions that differ between DOS and UNIX. + For example, under UNIX it is common to use .html + for HTML files, whereas under Windows/DOS .htm + is more commonly used. - So to map html to htm - you would use: + So to map html to htm + you would use: - mangled map = (*.html *.htm) + mangled map = (*.html *.htm) - One very useful case is to remove the annoying ;1 - off the ends of filenames on some CDROMs (only visible - under some UNIXes). To do this use a map of (*;1 *;). + One very useful case is to remove the annoying ;1 + off the ends of filenames on some CDROMs (only visible + under some UNIXes). To do this use a map of (*;1 *;). - Default: no mangled map - Example: mangled map = (*;1 *;) - - + Default: no mangled map + + Example: mangled map = (*;1 *;) + + diff --git a/docs/docbook/smbdotconf/filename/manglednames.xml b/docs/docbook/smbdotconf/filename/manglednames.xml index 41592b3159..4ec088d16f 100644 --- a/docs/docbook/smbdotconf/filename/manglednames.xml +++ b/docs/docbook/smbdotconf/filename/manglednames.xml @@ -1,21 +1,26 @@ - - mangled names (S) - This controls whether non-DOS names under UNIX - should be mapped to DOS-compatible names ("mangled") and made visible, - or whether non-DOS names should simply be ignored. + + + This controls whether non-DOS names under UNIX + should be mapped to DOS-compatible names ("mangled") and made visible, + or whether non-DOS names should simply be ignored. - See the section on - NAME MANGLING for details on how to control the mangling process. + See the section on NAME MANGLING for + details on how to control the mangling process. - If mangling is used then the mangling algorithm is as follows: + If mangling is used then the mangling algorithm is as follows: - - The first (up to) five alphanumeric characters + + + The first (up to) five alphanumeric characters before the rightmost dot of the filename are preserved, forced to upper case, and appear as the first (up to) five characters - of the mangled name. + of the mangled name. + - A tilde "~" is appended to the first part of the mangled + + A tilde "~" is appended to the first part of the mangled name, followed by a two-character unique sequence, based on the original root name (i.e., the original filename minus its final extension). The final extension is included in the hash calculation @@ -24,35 +29,39 @@ Note that the character to use may be specified using the mangling char - option, if you don't like '~'. + option, if you don't like '~'. + - The first three alphanumeric characters of the final + + The first three alphanumeric characters of the final extension are preserved, forced to upper case and appear as the extension of the mangled name. The final extension is defined as that part of the original filename after the rightmost dot. If there are no dots in the filename, the mangled name will have no extension (except - in the case of "hidden files" - see below). + in the case of "hidden files" - see below). + - Files whose UNIX name begins with a dot will be + + Files whose UNIX name begins with a dot will be presented as DOS hidden files. The mangled name will be created as for other filenames, but with the leading dot removed and "___" as its extension regardless of actual original extension (that's three - underscores). - + underscores). + + - The two-digit hash value consists of upper case - alphanumeric characters. + The two-digit hash value consists of upper case alphanumeric characters. - This algorithm can cause name collisions only if files - in a directory share the same first five alphanumeric characters. - The probability of such a clash is 1/1300. + This algorithm can cause name collisions only if files + in a directory share the same first five alphanumeric characters. + The probability of such a clash is 1/1300. - The name mangling (if enabled) allows a file to be - copied between UNIX directories from Windows/DOS while retaining - the long UNIX filename. UNIX files can be renamed to a new extension - from Windows/DOS and will retain the same basename. Mangled names - do not change between sessions. + The name mangling (if enabled) allows a file to be + copied between UNIX directories from Windows/DOS while retaining + the long UNIX filename. UNIX files can be renamed to a new extension + from Windows/DOS and will retain the same basename. Mangled names + do not change between sessions. - Default: mangled names = yes - - + Default: mangled names = yes + + diff --git a/docs/docbook/smbdotconf/filename/maparchive.xml b/docs/docbook/smbdotconf/filename/maparchive.xml index 18f39791aa..b44088efe3 100644 --- a/docs/docbook/smbdotconf/filename/maparchive.xml +++ b/docs/docbook/smbdotconf/filename/maparchive.xml @@ -1,17 +1,19 @@ - - map archive (S) - This controls whether the DOS archive attribute - should be mapped to the UNIX owner execute bit. The DOS archive bit - is set when a file has been modified since its last backup. One - motivation for this option it to keep Samba/your PC from making - any file it touches from becoming executable under UNIX. This can - be quite annoying for shared source code, documents, etc... + + + This controls whether the DOS archive attribute + should be mapped to the UNIX owner execute bit. The DOS archive bit + is set when a file has been modified since its last backup. One + motivation for this option it to keep Samba/your PC from making + any file it touches from becoming executable under UNIX. This can + be quite annoying for shared source code, documents, etc... - Note that this requires the create mask - parameter to be set such that owner execute bit is not masked out - (i.e. it must include 100). See the parameter - create mask for details. + Note that this requires the create mask + parameter to be set such that owner execute bit is not masked out + (i.e. it must include 100). See the parameter + create mask for details. - Default: map archive = yes - - + Default: map archive = yes + + diff --git a/docs/docbook/smbdotconf/filename/maphidden.xml b/docs/docbook/smbdotconf/filename/maphidden.xml index 2b0266c23e..4c1a932788 100644 --- a/docs/docbook/smbdotconf/filename/maphidden.xml +++ b/docs/docbook/smbdotconf/filename/maphidden.xml @@ -1,13 +1,15 @@ - - map hidden (S) - This controls whether DOS style hidden files - should be mapped to the UNIX world execute bit. + + + This controls whether DOS style hidden files + should be mapped to the UNIX world execute bit. - Note that this requires the create mask - to be set such that the world execute bit is not masked out (i.e. - it must include 001). See the parameter - create mask for details. + Note that this requires the create mask + to be set such that the world execute bit is not masked out (i.e. + it must include 001). See the parameter + create mask for details. - Default: map hidden = no - - + Default: map hidden = no + + diff --git a/docs/docbook/smbdotconf/filename/mapsystem.xml b/docs/docbook/smbdotconf/filename/mapsystem.xml index ead629971a..7fe50bb19f 100644 --- a/docs/docbook/smbdotconf/filename/mapsystem.xml +++ b/docs/docbook/smbdotconf/filename/mapsystem.xml @@ -1,13 +1,15 @@ - - map system (S) - This controls whether DOS style system files - should be mapped to the UNIX group execute bit. + + + This controls whether DOS style system files + should be mapped to the UNIX group execute bit. - Note that this requires the create mask - to be set such that the group execute bit is not masked out (i.e. - it must include 010). See the parameter - create mask for details. + Note that this requires the create mask + to be set such that the group execute bit is not masked out (i.e. + it must include 010). See the parameter + create mask for details. - Default: map system = no - - + Default: map system = no + + diff --git a/docs/docbook/smbdotconf/filename/statcache.xml b/docs/docbook/smbdotconf/filename/statcache.xml index ee94081483..ee2a48732e 100644 --- a/docs/docbook/smbdotconf/filename/statcache.xml +++ b/docs/docbook/smbdotconf/filename/statcache.xml @@ -1,10 +1,13 @@ - - stat cache (G) - This parameter determines if smbd - 8 will use a cache in order to - speed up case insensitive name mappings. You should never need - to change this parameter. + + + This parameter determines if smbd + 8 will use a cache in order to + speed up case insensitive name mappings. You should never need + to change this parameter. - Default: stat cache = yes - - + Default: stat cache = yes + + diff --git a/docs/docbook/smbdotconf/filename/vetofiles.xml b/docs/docbook/smbdotconf/filename/vetofiles.xml index faef2040b9..073645c611 100644 --- a/docs/docbook/smbdotconf/filename/vetofiles.xml +++ b/docs/docbook/smbdotconf/filename/vetofiles.xml @@ -1,36 +1,38 @@ - - veto files(S) - This is a list of files and directories that - are neither visible nor accessible. Each entry in the list must - be separated by a '/', which allows spaces to be included - in the entry. '*' and '?' can be used to specify multiple files - or directories as in DOS wildcards. + + + This is a list of files and directories that + are neither visible nor accessible. Each entry in the list must + be separated by a '/', which allows spaces to be included + in the entry. '*' and '?' can be used to specify multiple files + or directories as in DOS wildcards. - Each entry must be a unix path, not a DOS path and - must not include the unix directory - separator '/'. + Each entry must be a unix path, not a DOS path and + must not include the unix directory + separator '/'. - Note that the case sensitive option - is applicable in vetoing files. + Note that the case sensitive option + is applicable in vetoing files. - One feature of the veto files parameter that it - is important to be aware of is Samba's behaviour when - trying to delete a directory. If a directory that is - to be deleted contains nothing but veto files this - deletion will fail unless you also set - the delete veto files parameter to - yes. + One feature of the veto files parameter that it + is important to be aware of is Samba's behaviour when + trying to delete a directory. If a directory that is + to be deleted contains nothing but veto files this + deletion will fail unless you also set + the delete veto files parameter to + yes. - Setting this parameter will affect the performance - of Samba, as it will be forced to check all files and directories - for a match as they are scanned. + Setting this parameter will affect the performance + of Samba, as it will be forced to check all files and directories + for a match as they are scanned. - See also hide files - and - case sensitive. + See also hide files + and + case sensitive. - Default: No files or directories are vetoed. - + Default: No files or directories are vetoed. + Examples: ; Veto any files containing the word Security, @@ -42,5 +44,5 @@ veto files = /*Security*/*.tmp/*root*/ ; creates. veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/ - - + + diff --git a/docs/docbook/smbdotconf/filename/vetooplockfiles.xml b/docs/docbook/smbdotconf/filename/vetooplockfiles.xml index 0c817c97f8..e7c683a518 100644 --- a/docs/docbook/smbdotconf/filename/vetooplockfiles.xml +++ b/docs/docbook/smbdotconf/filename/vetooplockfiles.xml @@ -1,24 +1,25 @@ - - veto oplock files (S) - This parameter is only valid when the oplocks - parameter is turned on for a share. It allows the Samba administrator - to selectively turn off the granting of oplocks on selected files that - match a wildcarded list, similar to the wildcarded list used in the - veto files - parameter. + + + This parameter is only valid when the + oplocks + parameter is turned on for a share. It allows the Samba administrator + to selectively turn off the granting of oplocks on selected files that + match a wildcarded list, similar to the wildcarded list used in the + veto files + parameter. - Default: No files are vetoed for oplock - grants + Default: No files are vetoed for oplock grants - You might want to do this on files that you know will - be heavily contended for by clients. A good example of this - is in the NetBench SMB benchmark program, which causes heavy - client contention for files ending in .SEM. - To cause Samba not to grant oplocks on these files you would use - the line (either in the [global] section or in the section for - the particular NetBench share : + You might want to do this on files that you know will + be heavily contended for by clients. A good example of this + is in the NetBench SMB benchmark program, which causes heavy + client contention for files ending in .SEM. + To cause Samba not to grant oplocks on these files you would use + the line (either in the [global] section or in the section for + the particular NetBench share : - Example: veto oplock files = /*.SEM/ - - - + Example: veto oplock files = /*.SEM/ + + -- cgit From 4235c93fe8eb638510cea376e569fe6843052fef Mon Sep 17 00:00:00 2001 From: Alexander Bokovoy Date: Wed, 9 Apr 2003 17:10:44 +0000 Subject: Convert Logon parameters. (This used to be commit 7766cf5e2fff429b4769e1183bce0ce560570efe) --- .../smbdotconf/logon/abortshutdownscript.xml | 27 ++++--- docs/docbook/smbdotconf/logon/addgroupscript.xml | 31 +++---- docs/docbook/smbdotconf/logon/addmachinescript.xml | 33 ++++---- docs/docbook/smbdotconf/logon/adduserscript.xml | 85 +++++++++---------- .../smbdotconf/logon/addusertogroupscript.xml | 30 +++---- .../docbook/smbdotconf/logon/deletegroupscript.xml | 21 +++-- .../smbdotconf/logon/deleteuserfromgroupscript.xml | 30 +++---- docs/docbook/smbdotconf/logon/deleteuserscript.xml | 37 ++++----- docs/docbook/smbdotconf/logon/domainlogons.xml | 25 +++--- docs/docbook/smbdotconf/logon/logondrive.xml | 27 ++++--- docs/docbook/smbdotconf/logon/logonhome.xml | 69 ++++++++-------- docs/docbook/smbdotconf/logon/logonpath.xml | 94 +++++++++++----------- docs/docbook/smbdotconf/logon/logonscript.xml | 69 ++++++++-------- .../smbdotconf/logon/setprimarygroupscript.xml | 34 ++++---- docs/docbook/smbdotconf/logon/shutdownscript.xml | 75 ++++++++++------- 15 files changed, 375 insertions(+), 312 deletions(-) (limited to 'docs/docbook/smbdotconf') diff --git a/docs/docbook/smbdotconf/logon/abortshutdownscript.xml b/docs/docbook/smbdotconf/logon/abortshutdownscript.xml index 89fd9186bb..e9a7dba792 100644 --- a/docs/docbook/smbdotconf/logon/abortshutdownscript.xml +++ b/docs/docbook/smbdotconf/logon/abortshutdownscript.xml @@ -1,13 +1,18 @@ - - abort shutdown script (G) - This parameter only exists in the HEAD cvs branch - This a full path name to a script called by smbd - 8 that - should stop a shutdown procedure issued by the shutdown script. + + + This parameter only exists in the HEAD cvs branch + This a full path name to a script called by smbd + 8 that + should stop a shutdown procedure issued by the + shutdown script. - This command will be run as user. + This command will be run as user. - Default: None. - Example: abort shutdown script = /sbin/shutdown -c - - + Default: None. + + Example: abort shutdown script = /sbin/shutdown -c + + diff --git a/docs/docbook/smbdotconf/logon/addgroupscript.xml b/docs/docbook/smbdotconf/logon/addgroupscript.xml index 67441a1645..25906d0889 100644 --- a/docs/docbook/smbdotconf/logon/addgroupscript.xml +++ b/docs/docbook/smbdotconf/logon/addgroupscript.xml @@ -1,14 +1,17 @@ -add group script (G) - This is the full pathname to a script that will - be run AS ROOT by smbd - 8 when a new group is - requested. It will expand any - %g to the group name passed. - This script is only useful for installations using the - Windows NT domain administration tools. The script is - free to create a group with an arbitrary name to - circumvent unix group name restrictions. In that case - the script must print the numeric gid of the created - group on stdout. - - + + + This is the full pathname to a script that will be run + AS ROOT by + smbd8 + when a new group is requested. It will expand any %g to the group name passed. This + script is only useful for installations using the Windows NT + domain administration tools. The script is free to create a + group with an arbitrary name to circumvent unix group name + restrictions. In that case the script must print the numeric gid + of the created group on stdout. + + diff --git a/docs/docbook/smbdotconf/logon/addmachinescript.xml b/docs/docbook/smbdotconf/logon/addmachinescript.xml index fdc69c9490..7aef54d8b0 100644 --- a/docs/docbook/smbdotconf/logon/addmachinescript.xml +++ b/docs/docbook/smbdotconf/logon/addmachinescript.xml @@ -1,18 +1,21 @@ - - add machine script (G) - This is the full pathname to a script that will - be run by smbd - 8 when a machine is added - to it's domain using the administrator username and password method. + + + This is the full pathname to a script that will be run by + smbd + 8 when a machine is added + to it's domain using the administrator username and password + method. - This option is only required when using sam back-ends tied to the - Unix uid method of RID calculation such as smbpasswd. This option is only - available in Samba 3.0. + This option is only required when using sam back-ends tied + to the Unix uid method of RID calculation such as smbpasswd. + This option is only available in Samba 3.0. - Default: add machine script = <empty string> - + Default: add machine script = <empty string> - Example: add machine script = /usr/sbin/adduser -n -g machines -c Machine -d /dev/null -s /bin/false %u - - - + Example: add machine script = /usr/sbin/adduser -n -g + machines -c Machine -d /dev/null -s /bin/false %u + + diff --git a/docs/docbook/smbdotconf/logon/adduserscript.xml b/docs/docbook/smbdotconf/logon/adduserscript.xml index 3afea231a5..34d3e7ea58 100644 --- a/docs/docbook/smbdotconf/logon/adduserscript.xml +++ b/docs/docbook/smbdotconf/logon/adduserscript.xml @@ -1,49 +1,50 @@ - - add user script (G) - This is the full pathname to a script that will - be run AS ROOT by smbd - 8 under special circumstances described below. + + + This is the full pathname to a script that will + be run AS ROOT by smbd + 8 under special circumstances described below. - Normally, a Samba server requires that UNIX users are - created for all users accessing files on this server. For sites - that use Windows NT account databases as their primary user database - creating these users and keeping the user list in sync with the - Windows NT PDC is an onerous task. This option allows smbd to create the required UNIX users - ON DEMAND when a user accesses the Samba server. + Normally, a Samba server requires that UNIX users are + created for all users accessing files on this server. For sites + that use Windows NT account databases as their primary user database + creating these users and keeping the user list in sync with the + Windows NT PDC is an onerous task. This option allows smbd to create the required UNIX users + ON DEMAND when a user accesses the Samba server. - In order to use this option, smbd - 8 must NOT be set to security = share - and add user script - must be set to a full pathname for a script that will create a UNIX - user given one argument of %u, which expands into - the UNIX user name to create. + In order to use this option, smbd + 8 must NOT be set to security = share + and add user script + must be set to a full pathname for a script that will create a UNIX + user given one argument of %u, which expands into + the UNIX user name to create. - When the Windows user attempts to access the Samba server, - at login (session setup in the SMB protocol) time, smbd - 8 contacts the password server and - attempts to authenticate the given user with the given password. If the - authentication succeeds then smbd - attempts to find a UNIX user in the UNIX password database to map the - Windows user into. If this lookup fails, and add user script - is set then smbd will - call the specified script AS ROOT, expanding - any %u argument to be the user name to create. + When the Windows user attempts to access the Samba server, + at login (session setup in the SMB protocol) time, smbd + 8 contacts the password server and + attempts to authenticate the given user with the given password. If the + authentication succeeds then smbd + attempts to find a UNIX user in the UNIX password database to map the + Windows user into. If this lookup fails, and add user script + is set then smbd will + call the specified script AS ROOT, expanding + any %u argument to be the user name to create. - If this script successfully creates the user then smbd - will continue on as though the UNIX user - already existed. In this way, UNIX users are dynamically created to - match existing Windows NT accounts. + If this script successfully creates the user then smbd + will continue on as though the UNIX user + already existed. In this way, UNIX users are dynamically created to + match existing Windows NT accounts. - See also - security, - password server, - delete user - script. + See also + security, + password server, + delete user + script. - Default: add user script = <empty string> - + Default: add user script = <empty string> - Example: add user script = /usr/local/samba/bin/add_user - %u - - + Example: add user script = /usr/local/samba/bin/add_user %u + + diff --git a/docs/docbook/smbdotconf/logon/addusertogroupscript.xml b/docs/docbook/smbdotconf/logon/addusertogroupscript.xml index fe8be5b504..ed17b9c0d9 100644 --- a/docs/docbook/smbdotconf/logon/addusertogroupscript.xml +++ b/docs/docbook/smbdotconf/logon/addusertogroupscript.xml @@ -1,16 +1,18 @@ - - add user to group script (G) - Full path to the script that will be called when - a user is added to a group using the Windows NT domain administration - tools. It will be run by smbd - 8 AS ROOT. - Any %g will be replaced with the group name and - any %u will be replaced with the user name. - + + + Full path to the script that will be called when + a user is added to a group using the Windows NT domain administration + tools. It will be run by smbd + 8 AS ROOT. + Any %g will be replaced with the group name and + any %u will be replaced with the user name. + - Default: add user to group script = + Default: add user to group script = - Example: add user to group script = /usr/sbin/adduser %u %g - - - + Example: add user to group script = /usr/sbin/adduser %u %g + + diff --git a/docs/docbook/smbdotconf/logon/deletegroupscript.xml b/docs/docbook/smbdotconf/logon/deletegroupscript.xml index 02c413115a..2e78c6ae7d 100644 --- a/docs/docbook/smbdotconf/logon/deletegroupscript.xml +++ b/docs/docbook/smbdotconf/logon/deletegroupscript.xml @@ -1,8 +1,13 @@ -delete group script (G) - This is the full pathname to a script that will - be run AS ROOT smbd - 8 when a group is requested to be deleted. - It will expand any %g to the group name passed. - This script is only useful for installations using the Windows NT domain administration tools. - - + + + This is the full pathname to a script that will + be run AS ROOT smbd + 8 when a group is requested to be deleted. + It will expand any %g to the group name passed. + This script is only useful for installations using the Windows NT domain administration tools. + + + diff --git a/docs/docbook/smbdotconf/logon/deleteuserfromgroupscript.xml b/docs/docbook/smbdotconf/logon/deleteuserfromgroupscript.xml index bb1c5136c1..76594c75d8 100644 --- a/docs/docbook/smbdotconf/logon/deleteuserfromgroupscript.xml +++ b/docs/docbook/smbdotconf/logon/deleteuserfromgroupscript.xml @@ -1,16 +1,18 @@ - - delete user from group script (G) - Full path to the script that will be called when - a user is removed from a group using the Windows NT domain administration - tools. It will be run by smbd - 8 AS ROOT. - Any %g will be replaced with the group name and - any %u will be replaced with the user name. - + + + Full path to the script that will be called when + a user is removed from a group using the Windows NT domain administration + tools. It will be run by smbd + 8 AS ROOT. + Any %g will be replaced with the group name and + any %u will be replaced with the user name. + - Default: delete user from group script = + Default: delete user from group script = - Example: delete user from group script = /usr/sbin/deluser %u %g - - - + Example: delete user from group script = /usr/sbin/deluser %u %g + + diff --git a/docs/docbook/smbdotconf/logon/deleteuserscript.xml b/docs/docbook/smbdotconf/logon/deleteuserscript.xml index afb75dbe77..233844555b 100644 --- a/docs/docbook/smbdotconf/logon/deleteuserscript.xml +++ b/docs/docbook/smbdotconf/logon/deleteuserscript.xml @@ -1,21 +1,22 @@ - - delete user script (G) - This is the full pathname to a script that will - be run by smbd - 8 when managing users - with remote RPC (NT) tools. - + + + This is the full pathname to a script that will + be run by smbd + 8 when managing users + with remote RPC (NT) tools. + - This script is called when a remote client removes a user - from the server, normally using 'User Manager for Domains' or - rpcclient. - + This script is called when a remote client removes a user + from the server, normally using 'User Manager for Domains' or + rpcclient. - This script should delete the given UNIX username. - + This script should delete the given UNIX username. - Default: delete user script = <empty string> - - Example: delete user script = /usr/local/samba/bin/del_user - %u - + Default: delete user script = <empty string> + + Example: delete user script = /usr/local/samba/bin/del_user %u + + diff --git a/docs/docbook/smbdotconf/logon/domainlogons.xml b/docs/docbook/smbdotconf/logon/domainlogons.xml index 9a2f432f7d..e45621e553 100644 --- a/docs/docbook/smbdotconf/logon/domainlogons.xml +++ b/docs/docbook/smbdotconf/logon/domainlogons.xml @@ -1,12 +1,15 @@ - - domain logons (G) - If set to yes, the Samba server will serve - Windows 95/98 Domain logons for the - workgroup it is in. Samba 2.2 - has limited capability to act as a domain controller for Windows - NT 4 Domains. For more details on setting up this feature see - the Samba-PDC-HOWTO included in the htmldocs/ - directory shipped with the source code. + + + If set to yes, the Samba server will serve + Windows 95/98 Domain logons for the + workgroup it is in. Samba 2.2 + has limited capability to act as a domain controller for Windows + NT 4 Domains. For more details on setting up this feature see + the Samba-PDC-HOWTO included in the Samba documentation. - Default: domain logons = no - + Default: domain logons = no + + diff --git a/docs/docbook/smbdotconf/logon/logondrive.xml b/docs/docbook/smbdotconf/logon/logondrive.xml index d0aa4d7456..8c6be709bf 100644 --- a/docs/docbook/smbdotconf/logon/logondrive.xml +++ b/docs/docbook/smbdotconf/logon/logondrive.xml @@ -1,13 +1,18 @@ - - logon drive (G) - This parameter specifies the local path to - which the home directory will be connected (see logon home) - and is only used by NT Workstations. + + + This parameter specifies the local path to + which the home directory will be connected (see + logon home) + and is only used by NT Workstations. - Note that this option is only useful if Samba is set up as a - logon server. + Note that this option is only useful if Samba is set up as a + logon server. - Default: logon drive = z: - Example: logon drive = h: - - + Default: logon drive = z: + + Example: logon drive = h: + + diff --git a/docs/docbook/smbdotconf/logon/logonhome.xml b/docs/docbook/smbdotconf/logon/logonhome.xml index ec19c54043..05c69524c2 100644 --- a/docs/docbook/smbdotconf/logon/logonhome.xml +++ b/docs/docbook/smbdotconf/logon/logonhome.xml @@ -1,40 +1,45 @@ - - logon home (G) - This parameter specifies the home directory - location when a Win95/98 or NT Workstation logs into a Samba PDC. - It allows you to do + + + This parameter specifies the home directory + location when a Win95/98 or NT Workstation logs into a Samba PDC. + It allows you to do - C:\> NET USE H: /HOME - + C:\> + NET USE H: /HOME + - from a command prompt, for example. + from a command prompt, for example. - This option takes the standard substitutions, allowing - you to have separate logon scripts for each user or machine. + This option takes the standard substitutions, allowing + you to have separate logon scripts for each user or machine. - This parameter can be used with Win9X workstations to ensure - that roaming profiles are stored in a subdirectory of the user's - home directory. This is done in the following way: + This parameter can be used with Win9X workstations to ensure + that roaming profiles are stored in a subdirectory of the user's + home directory. This is done in the following way: - logon home = \\%N\%U\profile + logon home = \\%N\%U\profile - This tells Samba to return the above string, with - substitutions made when a client requests the info, generally - in a NetUserGetInfo request. Win9X clients truncate the info to - \\server\share when a user does net use /home - but use the whole string when dealing with profiles. + This tells Samba to return the above string, with + substitutions made when a client requests the info, generally + in a NetUserGetInfo request. Win9X clients truncate the info to + \\server\share when a user does net use /home + but use the whole string when dealing with profiles. - Note that in prior versions of Samba, the - logon path was returned rather than - logon home. This broke net use - /home but allowed profiles outside the home directory. - The current implementation is correct, and can be used for - profiles if you use the above trick. - - This option is only useful if Samba is set up as a logon - server. + Note that in prior versions of Samba, the + logon path was returned rather than + logon home. This broke net use /home but allowed profiles outside the home directory. + The current implementation is correct, and can be used for profiles if you use + the above trick. + + This option is only useful if Samba is set up as a logon + server. + + Default: logon home = "\\%N\%U" - Default: logon home = "\\%N\%U" - Example: logon home = "\\remote_smb_server\%U" - - + Example: logon home = "\\remote_smb_server\%U" + + diff --git a/docs/docbook/smbdotconf/logon/logonpath.xml b/docs/docbook/smbdotconf/logon/logonpath.xml index 04a2777862..9abcf0d702 100644 --- a/docs/docbook/smbdotconf/logon/logonpath.xml +++ b/docs/docbook/smbdotconf/logon/logonpath.xml @@ -1,45 +1,49 @@ - - logon path (G) - This parameter specifies the home directory - where roaming profiles (NTuser.dat etc files for Windows NT) are - stored. Contrary to previous versions of these manual pages, it has - nothing to do with Win 9X roaming profiles. To find out how to - handle roaming profiles for Win 9X system, see the - logon home parameter. - - This option takes the standard substitutions, allowing you - to have separate logon scripts for each user or machine. It also - specifies the directory from which the "Application Data", - (desktop, start menu, - network neighborhood, programs - and other folders, and their contents, are loaded and displayed on - your Windows NT client. - - The share and the path must be readable by the user for - the preferences and directories to be loaded onto the Windows NT - client. The share must be writeable when the user logs in for the first - time, in order that the Windows NT client can create the NTuser.dat - and other directories. - - Thereafter, the directories and any of the contents can, - if required, be made read-only. It is not advisable that the - NTuser.dat file be made read-only - rename it to NTuser.man to - achieve the desired effect (a MANdatory - profile). - - Windows clients can sometimes maintain a connection to - the [homes] share, even though there is no user logged in. - Therefore, it is vital that the logon path does not include a - reference to the homes share (i.e. setting this parameter to - \%N\%U\profile_path will cause problems). - - This option takes the standard substitutions, allowing - you to have separate logon scripts for each user or machine. - - Note that this option is only useful if Samba is set up - as a logon server. - - Default: logon path = \\%N\%U\profile - Example: logon path = \\PROFILESERVER\PROFILE\%U - - + + + This parameter specifies the home directory + where roaming profiles (NTuser.dat etc files for Windows NT) are + stored. Contrary to previous versions of these manual pages, it has + nothing to do with Win 9X roaming profiles. To find out how to + handle roaming profiles for Win 9X system, see the + logon home parameter. + + This option takes the standard substitutions, allowing you + to have separate logon scripts for each user or machine. It also + specifies the directory from which the "Application Data", + (desktop, start menu, + network neighborhood, programs + and other folders, and their contents, are loaded and displayed on + your Windows NT client. + + The share and the path must be readable by the user for + the preferences and directories to be loaded onto the Windows NT + client. The share must be writeable when the user logs in for the first + time, in order that the Windows NT client can create the NTuser.dat + and other directories. + + Thereafter, the directories and any of the contents can, + if required, be made read-only. It is not advisable that the + NTuser.dat file be made read-only - rename it to NTuser.man to + achieve the desired effect (a MANdatory + profile). + + Windows clients can sometimes maintain a connection to + the [homes] share, even though there is no user logged in. + Therefore, it is vital that the logon path does not include a + reference to the homes share (i.e. setting this parameter to + \%N\%U\profile_path will cause problems). + + This option takes the standard substitutions, allowing + you to have separate logon scripts for each user or machine. + + Note that this option is only useful if Samba is set up + as a logon server. + + Default: logon path = \\%N\%U\profile + + Example: logon path = \\PROFILESERVER\PROFILE\%U + + diff --git a/docs/docbook/smbdotconf/logon/logonscript.xml b/docs/docbook/smbdotconf/logon/logonscript.xml index 842cf927d2..65b6253c0c 100644 --- a/docs/docbook/smbdotconf/logon/logonscript.xml +++ b/docs/docbook/smbdotconf/logon/logonscript.xml @@ -1,39 +1,44 @@ - - logon script (G) - This parameter specifies the batch file (.bat) or - NT command file (.cmd) to be downloaded and run on a machine when - a user successfully logs in. The file must contain the DOS - style CR/LF line endings. Using a DOS-style editor to create the - file is recommended. + + + This parameter specifies the batch file (.bat) or + NT command file (.cmd) to be downloaded and run on a machine when + a user successfully logs in. The file must contain the DOS + style CR/LF line endings. Using a DOS-style editor to create the + file is recommended. - The script must be a relative path to the [netlogon] - service. If the [netlogon] service specifies a - path of /usr/local/samba/netlogon - , and logon script = STARTUP.BAT, then - the file that will be downloaded is: + The script must be a relative path to the [netlogon] + service. If the [netlogon] service specifies a + path of /usr/local/samba/netlogon, and logon script = STARTUP.BAT, then + the file that will be downloaded is: - /usr/local/samba/netlogon/STARTUP.BAT + /usr/local/samba/netlogon/STARTUP.BAT - The contents of the batch file are entirely your choice. A - suggested command would be to add NET TIME \\SERVER /SET - /YES, to force every machine to synchronize clocks with - the same time server. Another use would be to add NET USE - U: \\SERVER\UTILS for commonly used utilities, or - NET USE Q: \\SERVER\ISO9001_QA for example. + The contents of the batch file are entirely your choice. A + suggested command would be to add NET TIME \\SERVER /SET + /YES, to force every machine to synchronize clocks with + the same time server. Another use would be to add NET USE + U: \\SERVER\UTILS for commonly used utilities, or + NET USE Q: \\SERVER\ISO9001_QA for example. - Note that it is particularly important not to allow write - access to the [netlogon] share, or to grant users write permission - on the batch files in a secure environment, as this would allow - the batch files to be arbitrarily modified and security to be - breached. + Note that it is particularly important not to allow write + access to the [netlogon] share, or to grant users write permission + on the batch files in a secure environment, as this would allow + the batch files to be arbitrarily modified and security to be + breached. - This option takes the standard substitutions, allowing you - to have separate logon scripts for each user or machine. + This option takes the standard substitutions, allowing you + to have separate logon scripts for each user or machine. - This option is only useful if Samba is set up as a logon - server. + This option is only useful if Samba is set up as a logon + server. - Default: no logon script defined - Example: logon script = scripts\%U.bat - - + Default: no logon script defined + + Example: logon script = scripts\%U.bat + + diff --git a/docs/docbook/smbdotconf/logon/setprimarygroupscript.xml b/docs/docbook/smbdotconf/logon/setprimarygroupscript.xml index 45380ce4a8..c19c307417 100644 --- a/docs/docbook/smbdotconf/logon/setprimarygroupscript.xml +++ b/docs/docbook/smbdotconf/logon/setprimarygroupscript.xml @@ -1,19 +1,21 @@ - -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 - primary group from the windows user manager or when - fetching a SAM with net rpc - vampire. %u will be - replaced with the user whose primary group is to be - set. %g will be replaced with - the group to set. - Default: No default value + 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 primary group from the windows user + manager or when fetching a SAM with net rpc + vampire. %u will be replaced + with the user whose primary group is to be set. + %g will be replaced with the group to + set. - Example: set primary group script = /usr/sbin/usermod -g '%g' '%u' - - + Default: No default value + + Example: set primary group script = /usr/sbin/usermod -g '%g' '%u' + + diff --git a/docs/docbook/smbdotconf/logon/shutdownscript.xml b/docs/docbook/smbdotconf/logon/shutdownscript.xml index ac286393b5..0eaffea747 100644 --- a/docs/docbook/smbdotconf/logon/shutdownscript.xml +++ b/docs/docbook/smbdotconf/logon/shutdownscript.xml @@ -1,30 +1,46 @@ - - shutdown script (G) - This parameter only exists in the HEAD cvs branch - This a full path name to a script called by - smbd(8) that - should start a shutdown procedure. + + + This parameter only exists in the HEAD cvs branch + This a full path name to a script called by smbd + 8 that should start a shutdown procedure. - This command will be run as the user connected to the - server. + This command will be run as the user connected to the server. - %m %t %r %f parameters are expanded - %m will be substituted with the - shutdown message sent to the server. - %t will be substituted with the - number of seconds to wait before effectively starting the - shutdown procedure. - %r will be substituted with the - switch -r. It means reboot after shutdown - for NT. - - %f will be substituted with the - switch -f. It means force the shutdown - even if applications do not respond for NT. + %m %t %r %f parameters are expanded: + + + + %m will be substituted with the + shutdown message sent to the server. + + + + %t will be substituted with the + number of seconds to wait before effectively starting the + shutdown procedure. + + + + %r will be substituted with the + switch -r. It means reboot after shutdown + for NT. + + + + %f will be substituted with the + switch -f. It means force the shutdown + even if applications do not respond for NT. + + + + Default: None. - Default: None. - Example: abort shutdown script = /usr/local/samba/sbin/shutdown %m %t %r %f - Shutdown script example: + Example: abort shutdown script = /usr/local/samba/sbin/shutdown %m %t %r %f + + Shutdown script example: #!/bin/bash @@ -34,9 +50,10 @@ let "time++" /sbin/shutdown $3 $4 +$time $1 & - Shutdown does not return so we need to launch it in background. - +Shutdown does not return so we need to launch it in background. + - See also abort shutdown script. - - + See also + abort shutdown script. + + -- cgit From f810148de55705e170a0cdd72aa7e9348132c05d Mon Sep 17 00:00:00 2001 From: Jelmer Vernooij Date: Thu, 10 Apr 2003 11:15:45 +0000 Subject: ENCRYPTION.txt is gone. Pointed out by Will Kemp. (This used to be commit 85437976c852c272b9663f83a288081c63243747) --- docs/docbook/smbdotconf/security/encryptpasswords.xml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) (limited to 'docs/docbook/smbdotconf') diff --git a/docs/docbook/smbdotconf/security/encryptpasswords.xml b/docs/docbook/smbdotconf/security/encryptpasswords.xml index 4f83a776c8..20b9353648 100644 --- a/docs/docbook/smbdotconf/security/encryptpasswords.xml +++ b/docs/docbook/smbdotconf/security/encryptpasswords.xml @@ -7,9 +7,7 @@ will be negotiated with the client. Note that Windows NT 4.0 SP3 and above and also Windows 98 will by default expect encrypted passwords unless a registry entry is changed. To use encrypted passwords in - Samba see the file ENCRYPTION.txt in the Samba documentation - directory docs/ shipped - with the source code. + Samba see the chapter "User Database" in the Samba HOWTO Collection. In order for encrypted passwords to work correctly smbd -- cgit From 274b7650447f3580ba78e36a87f1cd88718c2032 Mon Sep 17 00:00:00 2001 From: Alexander Bokovoy Date: Fri, 11 Apr 2003 14:26:21 +0000 Subject: Finish conversion of Browse options (This used to be commit e59bd1d9fba71e7b8841a6d995f7bb9e156a15cc) --- docs/docbook/smbdotconf/browse/browsable.xml | 14 +++-- docs/docbook/smbdotconf/browse/browseable.xml | 17 +++--- docs/docbook/smbdotconf/browse/browselist.xml | 22 +++++--- docs/docbook/smbdotconf/browse/domainmaster.xml | 66 ++++++++++++---------- .../docbook/smbdotconf/browse/enhancedbrowsing.xml | 43 +++++++------- docs/docbook/smbdotconf/browse/lmannounce.xml | 47 +++++++-------- docs/docbook/smbdotconf/browse/lminterval.xml | 33 ++++++----- docs/docbook/smbdotconf/browse/localmaster.xml | 36 ++++++------ docs/docbook/smbdotconf/browse/oslevel.xml | 42 +++++++------- docs/docbook/smbdotconf/browse/preferedmaster.xml | 15 +++-- docs/docbook/smbdotconf/browse/preferredmaster.xml | 46 ++++++++------- 11 files changed, 210 insertions(+), 171 deletions(-) (limited to 'docs/docbook/smbdotconf') diff --git a/docs/docbook/smbdotconf/browse/browsable.xml b/docs/docbook/smbdotconf/browse/browsable.xml index 779571cff2..bd35732927 100644 --- a/docs/docbook/smbdotconf/browse/browsable.xml +++ b/docs/docbook/smbdotconf/browse/browsable.xml @@ -1,5 +1,9 @@ - - browsable (S) - See the - browseable. - + + + See the + browseable. + + diff --git a/docs/docbook/smbdotconf/browse/browseable.xml b/docs/docbook/smbdotconf/browse/browseable.xml index c223d6c7d7..5da61cccfb 100644 --- a/docs/docbook/smbdotconf/browse/browseable.xml +++ b/docs/docbook/smbdotconf/browse/browseable.xml @@ -1,8 +1,11 @@ - - browseable (S) - This controls whether this share is seen in - the list of available shares in a net view and in the browse list. + + + This controls whether this share is seen in + the list of available shares in a net view and in the browse list. - Default: browseable = yes - - + Default: browseable = yes + + diff --git a/docs/docbook/smbdotconf/browse/browselist.xml b/docs/docbook/smbdotconf/browse/browselist.xml index f15e2caf2a..17a962a3f5 100644 --- a/docs/docbook/smbdotconf/browse/browselist.xml +++ b/docs/docbook/smbdotconf/browse/browselist.xml @@ -1,10 +1,14 @@ - - browse list (G) - This controls whether smbd - 8 will serve a browse list to - a client doing a NetServerEnum call. Normally - set to yes. You should never need to change - this. + + + This controls whether smbd + 8 will serve a browse list to + a client doing a NetServerEnum call. Normally + set to yes. You should never need to change + this. - Default: browse list = yes - + Default: browse list = yes + + diff --git a/docs/docbook/smbdotconf/browse/domainmaster.xml b/docs/docbook/smbdotconf/browse/domainmaster.xml index cf2d504e4d..7bd334bbb5 100644 --- a/docs/docbook/smbdotconf/browse/domainmaster.xml +++ b/docs/docbook/smbdotconf/browse/domainmaster.xml @@ -1,34 +1,38 @@ - - domain master (G) - Tell smbd - 8 to enable WAN-wide browse list - collation. Setting this option causes nmbd to - claim a special domain specific NetBIOS name that identifies - it as a domain master browser for its given - workgroup. Local master browsers - in the same workgroup on broadcast-isolated - subnets will give this nmbd their local browse lists, - and then ask smbd - 8 for a complete copy of the browse - list for the whole wide area network. Browser clients will then contact - their local master browser, and will receive the domain-wide browse list, - instead of just the list for their broadcast-isolated subnet. + + + Tell smbd + 8 to enable WAN-wide browse list + collation. Setting this option causes nmbd to + claim a special domain specific NetBIOS name that identifies + it as a domain master browser for its given + workgroup. Local master browsers + in the same workgroup on broadcast-isolated + subnets will give this nmbd their local browse lists, + and then ask smbd + 8 for a complete copy of the browse + list for the whole wide area network. Browser clients will then contact + their local master browser, and will receive the domain-wide browse list, + instead of just the list for their broadcast-isolated subnet. - Note that Windows NT Primary Domain Controllers expect to be - able to claim this workgroup specific special - NetBIOS name that identifies them as domain master browsers for - that workgroup by default (i.e. there is no - way to prevent a Windows NT PDC from attempting to do this). This - means that if this parameter is set and nmbd claims - the special name for a workgroup before a Windows - NT PDC is able to do so then cross subnet browsing will behave - strangely and may fail. + Note that Windows NT Primary Domain Controllers expect to be + able to claim this workgroup specific special + NetBIOS name that identifies them as domain master browsers for + that workgroup by default (i.e. there is no + way to prevent a Windows NT PDC from attempting to do this). This + means that if this parameter is set and nmbd claims + the special name for a workgroup before a Windows + NT PDC is able to do so then cross subnet browsing will behave + strangely and may fail. - If domain logons = yes - , then the default behavior is to enable the domain - master parameter. If domain logons is - not enabled (the default setting), then neither will domain - master be enabled by default. + If domain logons = yes + , then the default behavior is to enable the domain + master parameter. If domain logons is + not enabled (the default setting), then neither will domain + master be enabled by default. - Default: domain master = auto - + Default: domain master = auto + + diff --git a/docs/docbook/smbdotconf/browse/enhancedbrowsing.xml b/docs/docbook/smbdotconf/browse/enhancedbrowsing.xml index cf8d3e54b9..8fb3be1603 100644 --- a/docs/docbook/smbdotconf/browse/enhancedbrowsing.xml +++ b/docs/docbook/smbdotconf/browse/enhancedbrowsing.xml @@ -1,24 +1,27 @@ - - enhanced browsing (G) - This option enables a couple of enhancements to - cross-subnet browse propagation that have been added in Samba - but which are not standard in Microsoft implementations. - + + + This option enables a couple of enhancements to + cross-subnet browse propagation that have been added in Samba + but which are not standard in Microsoft implementations. + - The first enhancement to browse propagation consists of a regular - wildcard query to a Samba WINS server for all Domain Master Browsers, - followed by a browse synchronization with each of the returned - DMBs. The second enhancement consists of a regular randomised browse - synchronization with all currently known DMBs. + The first enhancement to browse propagation consists of a regular + wildcard query to a Samba WINS server for all Domain Master Browsers, + followed by a browse synchronization with each of the returned + DMBs. The second enhancement consists of a regular randomised browse + synchronization with all currently known DMBs. - You may wish to disable this option if you have a problem with empty - workgroups not disappearing from browse lists. Due to the restrictions - of the browse protocols these enhancements can cause a empty workgroup - to stay around forever which can be annoying. + You may wish to disable this option if you have a problem with empty + workgroups not disappearing from browse lists. Due to the restrictions + of the browse protocols these enhancements can cause a empty workgroup + to stay around forever which can be annoying. - In general you should leave this option enabled as it makes - cross-subnet browse propagation much more reliable. + In general you should leave this option enabled as it makes + cross-subnet browse propagation much more reliable. - Default: enhanced browsing = yes - - + Default: enhanced browsing = yes + + diff --git a/docs/docbook/smbdotconf/browse/lmannounce.xml b/docs/docbook/smbdotconf/browse/lmannounce.xml index 1551c0991e..b18234443a 100644 --- a/docs/docbook/smbdotconf/browse/lmannounce.xml +++ b/docs/docbook/smbdotconf/browse/lmannounce.xml @@ -1,24 +1,27 @@ - - lm announce (G) - This parameter determines if nmbd - 8 will produce Lanman announce - broadcasts that are needed by OS/2 clients in order for them to see - the Samba server in their browse list. This parameter can have three - values, yes, no, or - auto. The default is auto. - If set to no Samba will never produce these - broadcasts. If set to yes Samba will produce - Lanman announce broadcasts at a frequency set by the parameter - lm interval. If set to auto - Samba will not send Lanman announce broadcasts by default but will - listen for them. If it hears such a broadcast on the wire it will - then start sending them at a frequency set by the parameter - lm interval. + + + This parameter determines if nmbd + 8 will produce Lanman announce + broadcasts that are needed by OS/2 clients in order for them to see + the Samba server in their browse list. This parameter can have three + values, yes, no, or + auto. The default is auto. + If set to no Samba will never produce these + broadcasts. If set to yes Samba will produce + Lanman announce broadcasts at a frequency set by the parameter + lm interval. If set to auto + Samba will not send Lanman announce broadcasts by default but will + listen for them. If it hears such a broadcast on the wire it will + then start sending them at a frequency set by the parameter + lm interval. - See also lm interval - . + See also lm interval. - Default: lm announce = auto - Example: lm announce = yes - - + Default: lm announce = auto + + Example: lm announce = yes + + diff --git a/docs/docbook/smbdotconf/browse/lminterval.xml b/docs/docbook/smbdotconf/browse/lminterval.xml index cc17dc15b0..58e4cc30ba 100644 --- a/docs/docbook/smbdotconf/browse/lminterval.xml +++ b/docs/docbook/smbdotconf/browse/lminterval.xml @@ -1,17 +1,20 @@ - - lm interval (G) - If Samba is set to produce Lanman announce - broadcasts needed by OS/2 clients (see the - lm announce parameter) then this - parameter defines the frequency in seconds with which they will be - made. If this is set to zero then no Lanman announcements will be - made despite the setting of the lm announce - parameter. + + + If Samba is set to produce Lanman announce + broadcasts needed by OS/2 clients (see the + lm announce parameter) then this + parameter defines the frequency in seconds with which they will be + made. If this is set to zero then no Lanman announcements will be + made despite the setting of the lm announce + parameter. - See also lm - announce. + See also lm announce. - Default: lm interval = 60 - Example: lm interval = 120 - - + Default: lm interval = 60 + + Example: lm interval = 120 + + diff --git a/docs/docbook/smbdotconf/browse/localmaster.xml b/docs/docbook/smbdotconf/browse/localmaster.xml index dffbd3cb19..ac2626c679 100644 --- a/docs/docbook/smbdotconf/browse/localmaster.xml +++ b/docs/docbook/smbdotconf/browse/localmaster.xml @@ -1,18 +1,22 @@ - - local master (G) - This option allows nmbd - 8 to try and become a local master browser - on a subnet. If set to no then - nmbd will not attempt to become a local master browser - on a subnet and will also lose in all browsing elections. By - default this value is set to yes. Setting this value to yes doesn't - mean that Samba will become the local master - browser on a subnet, just that nmbd will - participate in elections for local master browser. + + + This option allows nmbd + 8 to try and become a local master browser + on a subnet. If set to no then + nmbd will not attempt to become a local master browser + on a subnet and will also lose in all browsing elections. By + default this value is set to yes. Setting this value to + yes doesn't mean that Samba will become the + local master browser on a subnet, just that nmbd + will participate in elections for local master browser. - Setting this value to no will cause nmbd - never to become a local master browser. + Setting this value to no will cause nmbd never to become a local + master browser. - Default: local master = yes - - + Default: local master = yes + + diff --git a/docs/docbook/smbdotconf/browse/oslevel.xml b/docs/docbook/smbdotconf/browse/oslevel.xml index 927db32204..560516e3f8 100644 --- a/docs/docbook/smbdotconf/browse/oslevel.xml +++ b/docs/docbook/smbdotconf/browse/oslevel.xml @@ -1,21 +1,25 @@ - - os level (G) - This integer value controls what level Samba - advertises itself as for browse elections. The value of this - parameter determines whether nmbd - 8 - has a chance of becoming a local master browser for the - WORKGROUP in the local broadcast area. + + + This integer value controls what level Samba + advertises itself as for browse elections. The value of this + parameter determines whether nmbd + 8 + has a chance of becoming a local master browser for the + WORKGROUP in the local broadcast area. - Note :By default, Samba will win - a local master browsing election over all Microsoft operating - systems except a Windows NT 4.0/2000 Domain Controller. This - means that a misconfigured Samba host can effectively isolate - a subnet for browsing purposes. See BROWSING.txt - in the Samba docs/ directory - for details. + Note :By default, Samba will win + a local master browsing election over all Microsoft operating + systems except a Windows NT 4.0/2000 Domain Controller. This + means that a misconfigured Samba host can effectively isolate + a subnet for browsing purposes. See BROWSING.txt + in the Samba docs/ directory + for details. - Default: os level = 20 - Example: os level = 65 - - + Default: os level = 20 + + Example: os level = 65 + + diff --git a/docs/docbook/smbdotconf/browse/preferedmaster.xml b/docs/docbook/smbdotconf/browse/preferedmaster.xml index 8098626c51..2e8cd938ea 100644 --- a/docs/docbook/smbdotconf/browse/preferedmaster.xml +++ b/docs/docbook/smbdotconf/browse/preferedmaster.xml @@ -1,6 +1,9 @@ - - prefered master (G) - Synonym for - preferred master for people who cannot spell :-). - - + + + Synonym for + preferred master for people who cannot spell :-). + + diff --git a/docs/docbook/smbdotconf/browse/preferredmaster.xml b/docs/docbook/smbdotconf/browse/preferredmaster.xml index 53934fdb78..31c966b4ac 100644 --- a/docs/docbook/smbdotconf/browse/preferredmaster.xml +++ b/docs/docbook/smbdotconf/browse/preferredmaster.xml @@ -1,25 +1,29 @@ - - preferred master (G) - This boolean parameter controls if nmbd(8) is a preferred master browser - for its workgroup. + + + This boolean parameter controls if + nmbd + 8 is a preferred master + browser for its workgroup. - If this is set to yes, on startup, nmbd - will force an election, and it will have a slight advantage in - winning the election. It is recommended that this parameter is - used in conjunction with - domain master = yes, so that - nmbd can guarantee becoming a domain master. + If this is set to yes, on startup, nmbd + will force an election, and it will have a slight advantage in + winning the election. It is recommended that this parameter is + used in conjunction with + domain master = yes, so + that nmbd can guarantee becoming a domain master. - Use this option with caution, because if there are several - hosts (whether Samba servers, Windows 95 or NT) that are preferred - master browsers on the same subnet, they will each periodically - and continuously attempt to become the local master browser. - This will result in unnecessary broadcast traffic and reduced browsing - capabilities. + Use this option with caution, because if there are several + hosts (whether Samba servers, Windows 95 or NT) that are + preferred master browsers on the same subnet, they will each + periodically and continuously attempt to become the local + master browser. This will result in unnecessary broadcast + traffic and reduced browsing capabilities. - See also os level - . + See also os level. - Default: preferred master = auto - - + Default: preferred master = auto + + -- cgit From 7d19f81d96d8474c5ab7a9d950b1e32b41baf8c8 Mon Sep 17 00:00:00 2001 From: Alexander Bokovoy Date: Fri, 11 Apr 2003 14:46:50 +0000 Subject: Finish conversion of WINS options (This used to be commit eb7a35110eac38fb545c34f3b9e33cbd58d60fdc) --- docs/docbook/smbdotconf/wins/dnsproxy.xml | 38 +++++++------ docs/docbook/smbdotconf/wins/winshook.xml | 78 ++++++++++++++++----------- docs/docbook/smbdotconf/wins/winspartners.xml | 27 +++++----- docs/docbook/smbdotconf/wins/winsproxy.xml | 20 ++++--- docs/docbook/smbdotconf/wins/winsserver.xml | 57 +++++++++++--------- docs/docbook/smbdotconf/wins/winssupport.xml | 25 +++++---- 6 files changed, 139 insertions(+), 106 deletions(-) (limited to 'docs/docbook/smbdotconf') diff --git a/docs/docbook/smbdotconf/wins/dnsproxy.xml b/docs/docbook/smbdotconf/wins/dnsproxy.xml index fd53ae7ded..45ec160c5a 100644 --- a/docs/docbook/smbdotconf/wins/dnsproxy.xml +++ b/docs/docbook/smbdotconf/wins/dnsproxy.xml @@ -1,21 +1,25 @@ - - dns proxy (G) - Specifies that nmbd - 8 when acting as a WINS server and - finding that a NetBIOS name has not been registered, should treat the - NetBIOS name word-for-word as a DNS name and do a lookup with the DNS server - for that name on behalf of the name-querying client. + + + Specifies that nmbd + 8 when acting as a WINS server and + finding that a NetBIOS name has not been registered, should treat the + NetBIOS name word-for-word as a DNS name and do a lookup with the DNS server + for that name on behalf of the name-querying client. - Note that the maximum length for a NetBIOS name is 15 - characters, so the DNS name (or DNS alias) can likewise only be - 15 characters, maximum. + Note that the maximum length for a NetBIOS name is 15 + characters, so the DNS name (or DNS alias) can likewise only be + 15 characters, maximum. - nmbd spawns a second copy of itself to do the - DNS name lookup requests, as doing a name lookup is a blocking - action. + nmbd spawns a second copy of itself to do the + DNS name lookup requests, as doing a name lookup is a blocking + action. - See also the parameter - wins support. + See also the parameter + wins support. - Default: dns proxy = yes - + Default: dns proxy = yes + + diff --git a/docs/docbook/smbdotconf/wins/winshook.xml b/docs/docbook/smbdotconf/wins/winshook.xml index e0c4a87c5b..e38e93f6b5 100644 --- a/docs/docbook/smbdotconf/wins/winshook.xml +++ b/docs/docbook/smbdotconf/wins/winshook.xml @@ -1,43 +1,57 @@ - - wins hook (G) - When Samba is running as a WINS server this - allows you to call an external program for all changes to the - WINS database. The primary use for this option is to allow the - dynamic update of external name resolution databases such as - dynamic DNS. + + + When Samba is running as a WINS server this + allows you to call an external program for all changes to the + WINS database. The primary use for this option is to allow the + dynamic update of external name resolution databases such as + dynamic DNS. - The wins hook parameter specifies the name of a script - or executable that will be called as follows: + The wins hook parameter specifies the name of a script + or executable that will be called as follows: - wins_hook operation name nametype ttl IP_list - + wins_hook operation name nametype ttl IP_list - - The first argument is the operation and is one - of "add", "delete", or "refresh". In most cases the operation can - be ignored as the rest of the parameters provide sufficient - information. Note that "refresh" may sometimes be called when the - name has not previously been added, in that case it should be treated - as an add. + + + The first argument is the operation and is + one of "add", "delete", or + "refresh". In most cases the operation + can be ignored as the rest of the parameters + provide sufficient information. Note that + "refresh" may sometimes be called when + the name has not previously been added, in that + case it should be treated as an add. + - The second argument is the NetBIOS name. If the + + The second argument is the NetBIOS name. If the name is not a legal name then the wins hook is not called. Legal names contain only letters, digits, hyphens, underscores - and periods. + and periods. + - The third argument is the NetBIOS name - type as a 2 digit hexadecimal number. + + The third argument is the NetBIOS name + type as a 2 digit hexadecimal number. + - The fourth argument is the TTL (time to live) - for the name in seconds. + + The fourth argument is the TTL (time to live) + for the name in seconds. + - The fifth and subsequent arguments are the IP + + The fifth and subsequent arguments are the IP addresses currently registered for that name. If this list is - empty then the name should be deleted. - - - An example script that calls the BIND dynamic DNS update - program nsupdate is provided in the examples - directory of the Samba source code. + empty then the name should be deleted. - + + + An example script that calls the BIND dynamic DNS update + program nsupdate is provided in the examples + directory of the Samba source code. + + diff --git a/docs/docbook/smbdotconf/wins/winspartners.xml b/docs/docbook/smbdotconf/wins/winspartners.xml index 840435ae4e..9ec277ed2d 100644 --- a/docs/docbook/smbdotconf/wins/winspartners.xml +++ b/docs/docbook/smbdotconf/wins/winspartners.xml @@ -1,14 +1,17 @@ - - wins partners (G) - A space separated list of partners' IP addresses for - WINS replication. WINS partners are always defined as push/pull - partners as defining only one way WINS replication is unreliable. - WINS replication is currently experimental and unreliable between - samba servers. - + + + A space separated list of partners' IP addresses for + WINS replication. WINS partners are always defined as push/pull + partners as defining only one way WINS replication is unreliable. + WINS replication is currently experimental and unreliable between + samba servers. + - Default: wins partners = + Default: wins partners = - Example: wins partners = 192.168.0.1 172.16.1.2 - - + Example: wins partners = 192.168.0.1 172.16.1.2 + + diff --git a/docs/docbook/smbdotconf/wins/winsproxy.xml b/docs/docbook/smbdotconf/wins/winsproxy.xml index 31978d3b24..11f47e31c7 100644 --- a/docs/docbook/smbdotconf/wins/winsproxy.xml +++ b/docs/docbook/smbdotconf/wins/winsproxy.xml @@ -1,9 +1,13 @@ - - wins proxy (G) - This is a boolean that controls if nmbd(8) will respond to broadcast name - queries on behalf of other hosts. You may need to set this - to yes for some older clients. + + + This is a boolean that controls if nmbd + 8 will respond to broadcast name + queries on behalf of other hosts. You may need to set this + to yes for some older clients. - Default: wins proxy = no - - + Default: wins proxy = no + + diff --git a/docs/docbook/smbdotconf/wins/winsserver.xml b/docs/docbook/smbdotconf/wins/winsserver.xml index ebdb3016c7..12ee635acd 100644 --- a/docs/docbook/smbdotconf/wins/winsserver.xml +++ b/docs/docbook/smbdotconf/wins/winsserver.xml @@ -1,32 +1,37 @@ - - wins server (G) - This specifies the IP address (or DNS name: IP - address for preference) of the WINS server that nmbd - 8 should register with. If you have a WINS server on - your network then you should set this to the WINS server's IP. + + + This specifies the IP address (or DNS name: IP + address for preference) of the WINS server that nmbd + 8 should register with. If you have a WINS server on + your network then you should set this to the WINS server's IP. - You should point this at your WINS server if you have a - multi-subnetted network. + You should point this at your WINS server if you have a + multi-subnetted network. - If you want to work in multiple namespaces, you can - give every wins server a 'tag'. For each tag, only one - (working) server will be queried for a name. The tag should be - seperated from the ip address by a colon. - + If you want to work in multiple namespaces, you can + give every wins server a 'tag'. For each tag, only one + (working) server will be queried for a name. The tag should be + seperated from the ip address by a colon. + - You need to set up Samba to point - to a WINS server if you have multiple subnets and wish cross-subnet - browsing to work correctly. + You need to set up Samba to point + to a WINS server if you have multiple subnets and wish cross-subnet + browsing to work correctly. - See the documentation file Browsing in the samba howto collection. + See the documentation file Browsing in the samba howto collection. - Default: not enabled - Example: wins server = mary:192.9.200.1 fred:192.168.3.199 mary:192.168.2.61 - For this example when querying a certain name, 192.19.200.1 will - be asked first and if that doesn't respond 192.168.2.61. If either - of those doesn't know the name 192.168.3.199 will be queried. - + Default: not enabled - Example: wins server = 192.9.200.1 192.168.2.61 - - + Example: wins server = mary:192.9.200.1 fred:192.168.3.199 mary:192.168.2.61 + + For this example when querying a certain name, 192.19.200.1 will + be asked first and if that doesn't respond 192.168.2.61. If either + of those doesn't know the name 192.168.3.199 will be queried. + + + Example: wins server = 192.9.200.1 192.168.2.61 + + diff --git a/docs/docbook/smbdotconf/wins/winssupport.xml b/docs/docbook/smbdotconf/wins/winssupport.xml index 5ad886a9b1..eef59e708f 100644 --- a/docs/docbook/smbdotconf/wins/winssupport.xml +++ b/docs/docbook/smbdotconf/wins/winssupport.xml @@ -1,12 +1,15 @@ - - wins support (G) - This boolean controls if the nmbd - 8 process in Samba will act as a WINS server. You should - not set this to yes unless you have a multi-subnetted network and - you wish a particular nmbd to be your WINS server. - Note that you should NEVER set this to yes - on more than one machine in your network. + + + This boolean controls if the nmbd + 8 process in Samba will act as a WINS server. You should + not set this to yes unless you have a multi-subnetted network and + you wish a particular nmbd to be your WINS server. + Note that you should NEVER set this to yes + on more than one machine in your network. - Default: wins support = no - - + Default: wins support = no + + -- cgit From d90a4ea71a17f22b9d65462189d6e074b4fa9e6e Mon Sep 17 00:00:00 2001 From: Alexander Bokovoy Date: Fri, 11 Apr 2003 15:01:39 +0000 Subject: Finish conversion of Locking options (This used to be commit 9613c217786147c9deda9770887dc069659b1deb) --- docs/docbook/smbdotconf/locking/blockinglocks.xml | 39 ++++++------- docs/docbook/smbdotconf/locking/cscpolicy.xml | 32 ++++++----- docs/docbook/smbdotconf/locking/fakeoplocks.xml | 50 ++++++++-------- docs/docbook/smbdotconf/locking/kerneloplocks.xml | 43 +++++++------- docs/docbook/smbdotconf/locking/level2oplocks.xml | 66 +++++++++++----------- docs/docbook/smbdotconf/locking/locking.xml | 42 +++++++------- docs/docbook/smbdotconf/locking/lockspincount.xml | 30 +++++----- docs/docbook/smbdotconf/locking/lockspintime.xml | 21 +++---- .../smbdotconf/locking/oplockbreakwaittime.xml | 30 +++++----- .../smbdotconf/locking/oplockcontentionlimit.xml | 35 ++++++------ docs/docbook/smbdotconf/locking/oplocks.xml | 50 ++++++++-------- docs/docbook/smbdotconf/locking/posixlocking.xml | 28 ++++----- docs/docbook/smbdotconf/locking/sharemodes.xml | 44 ++++++++------- docs/docbook/smbdotconf/locking/strictlocking.xml | 30 +++++----- 14 files changed, 285 insertions(+), 255 deletions(-) (limited to 'docs/docbook/smbdotconf') diff --git a/docs/docbook/smbdotconf/locking/blockinglocks.xml b/docs/docbook/smbdotconf/locking/blockinglocks.xml index ea5e90b5cd..f11d92f4f5 100644 --- a/docs/docbook/smbdotconf/locking/blockinglocks.xml +++ b/docs/docbook/smbdotconf/locking/blockinglocks.xml @@ -1,22 +1,23 @@ - - blocking locks (S) - This parameter controls the behavior - of smbd - 8 when given a request by a client - to obtain a byte range lock on a region of an open file, and the - request has a time limit associated with it. + + + This parameter controls the behavior + of smbd + 8 when given a request by a client + to obtain a byte range lock on a region of an open file, and the + request has a time limit associated with it. - If this parameter is set and the lock range requested - cannot be immediately satisfied, samba will internally - queue the lock request, and periodically attempt to obtain - the lock until the timeout period expires. + If this parameter is set and the lock range requested + cannot be immediately satisfied, samba will internally + queue the lock request, and periodically attempt to obtain + the lock until the timeout period expires. - If this parameter is set to no, then - samba will behave as previous versions of Samba would and - will fail the lock request immediately if the lock range - cannot be obtained. + If this parameter is set to no, then + samba will behave as previous versions of Samba would and + will fail the lock request immediately if the lock range + cannot be obtained. - Default: blocking locks = yes - - - + Default: blocking locks = yes + + diff --git a/docs/docbook/smbdotconf/locking/cscpolicy.xml b/docs/docbook/smbdotconf/locking/cscpolicy.xml index e5139bc4f3..7567ed9286 100644 --- a/docs/docbook/smbdotconf/locking/cscpolicy.xml +++ b/docs/docbook/smbdotconf/locking/cscpolicy.xml @@ -1,18 +1,20 @@ - - csc policy (S) - This stands for client-side caching - policy, and specifies how clients capable of offline - caching will cache the files in the share. The valid values - are: manual, documents, programs, disable. + + + This stands for client-side caching + policy, and specifies how clients capable of offline + caching will cache the files in the share. The valid values + are: manual, documents, programs, disable. - These values correspond to those used on Windows - servers. + These values correspond to those used on Windows servers. - For example, shares containing roaming profiles can have - offline caching disabled using csc policy = disable - . + For example, shares containing roaming profiles can have + offline caching disabled using csc policy = disable. - Default: csc policy = manual - Example: csc policy = programs - - + Default: csc policy = manual + + Example: csc policy = programs + + diff --git a/docs/docbook/smbdotconf/locking/fakeoplocks.xml b/docs/docbook/smbdotconf/locking/fakeoplocks.xml index 16887726c0..b7deac68ba 100644 --- a/docs/docbook/smbdotconf/locking/fakeoplocks.xml +++ b/docs/docbook/smbdotconf/locking/fakeoplocks.xml @@ -1,27 +1,31 @@ - - fake oplocks (S) - Oplocks are the way that SMB clients get permission - from a server to locally cache file operations. If a server grants - an oplock (opportunistic lock) then the client is free to assume - that it is the only one accessing the file and it will aggressively - cache file data. With some oplock types the client may even cache - file open/close operations. This can give enormous performance benefits. - + + + Oplocks are the way that SMB clients get permission + from a server to locally cache file operations. If a server grants + an oplock (opportunistic lock) then the client is free to assume + that it is the only one accessing the file and it will aggressively + cache file data. With some oplock types the client may even cache + file open/close operations. This can give enormous performance benefits. + - When you set fake oplocks = yes, smbd(8) will - always grant oplock requests no matter how many clients are using - the file. + When you set fake oplocks = yes, + smbd8 will + always grant oplock requests no matter how many clients are using the file. - It is generally much better to use the real oplocks support rather - than this parameter. + It is generally much better to use the real + oplocks support rather + than this parameter. - If you enable this option on all read-only shares or - shares that you know will only be accessed from one client at a - time such as physically read-only media like CDROMs, you will see - a big performance improvement on many operations. If you enable - this option on shares where multiple clients may be accessing the - files read-write at the same time you can get data corruption. Use - this option carefully! + If you enable this option on all read-only shares or + shares that you know will only be accessed from one client at a + time such as physically read-only media like CDROMs, you will see + a big performance improvement on many operations. If you enable + this option on shares where multiple clients may be accessing the + files read-write at the same time you can get data corruption. Use + this option carefully! - Default: fake oplocks = no - + Default: fake oplocks = no + + diff --git a/docs/docbook/smbdotconf/locking/kerneloplocks.xml b/docs/docbook/smbdotconf/locking/kerneloplocks.xml index 98513fdd1e..f155fddc8f 100644 --- a/docs/docbook/smbdotconf/locking/kerneloplocks.xml +++ b/docs/docbook/smbdotconf/locking/kerneloplocks.xml @@ -1,24 +1,27 @@ - - kernel oplocks (G) - For UNIXes that support kernel based oplocks - (currently only IRIX and the Linux 2.4 kernel), this parameter - allows the use of them to be turned on or off. + + + For UNIXes that support kernel based + oplocks + (currently only IRIX and the Linux 2.4 kernel), this parameter + allows the use of them to be turned on or off. - Kernel oplocks support allows Samba oplocks - to be broken whenever a local UNIX process or NFS operation - accesses a file that smbd - 8 has oplocked. This allows complete - data consistency between SMB/CIFS, NFS and local file access (and is - a very cool feature :-). + Kernel oplocks support allows Samba oplocks + to be broken whenever a local UNIX process or NFS operation + accesses a file that smbd + 8 has oplocked. This allows complete + data consistency between SMB/CIFS, NFS and local file access (and is + a very cool feature :-). - This parameter defaults to on, but is translated - to a no-op on systems that no not have the necessary kernel support. - You should never need to touch this parameter. + This parameter defaults to on, but is translated + to a no-op on systems that no not have the necessary kernel support. + You should never need to touch this parameter. - See also the oplocks - and level2 oplocks - parameters. + See also the oplocks + and level2 oplocks + parameters. - Default: kernel oplocks = yes - - + Default: kernel oplocks = yes + + diff --git a/docs/docbook/smbdotconf/locking/level2oplocks.xml b/docs/docbook/smbdotconf/locking/level2oplocks.xml index adae6d268f..c2c090b1a8 100644 --- a/docs/docbook/smbdotconf/locking/level2oplocks.xml +++ b/docs/docbook/smbdotconf/locking/level2oplocks.xml @@ -1,39 +1,41 @@ - - level2 oplocks (S) - This parameter controls whether Samba supports - level2 (read-only) oplocks on a share. + + + This parameter controls whether Samba supports + level2 (read-only) oplocks on a share. - Level2, or read-only oplocks allow Windows NT clients - that have an oplock on a file to downgrade from a read-write oplock - to a read-only oplock once a second client opens the file (instead - of releasing all oplocks on a second open, as in traditional, - exclusive oplocks). This allows all openers of the file that - support level2 oplocks to cache the file for read-ahead only (ie. - they may not cache writes or lock requests) and increases performance - for many accesses of files that are not commonly written (such as - application .EXE files). + Level2, or read-only oplocks allow Windows NT clients + that have an oplock on a file to downgrade from a read-write oplock + to a read-only oplock once a second client opens the file (instead + of releasing all oplocks on a second open, as in traditional, + exclusive oplocks). This allows all openers of the file that + support level2 oplocks to cache the file for read-ahead only (ie. + they may not cache writes or lock requests) and increases performance + for many accesses of files that are not commonly written (such as + application .EXE files). - Once one of the clients which have a read-only oplock - writes to the file all clients are notified (no reply is needed - or waited for) and told to break their oplocks to "none" and - delete any read-ahead caches. + Once one of the clients which have a read-only oplock + writes to the file all clients are notified (no reply is needed + or waited for) and told to break their oplocks to "none" and + delete any read-ahead caches. - It is recommended that this parameter be turned on - to speed access to shared executables. + It is recommended that this parameter be turned on to + speed access to shared executables. - For more discussions on level2 oplocks see the CIFS spec. + For more discussions on level2 oplocks see the CIFS spec. - Currently, if kernel - oplocks are supported then level2 oplocks are - not granted (even if this parameter is set to yes). - Note also, the oplocks - parameter must be set to yes on this share in order for - this parameter to have any effect. + Currently, if kernel + oplocks are supported then level2 oplocks are + not granted (even if this parameter is set to yes). + Note also, the oplocks + parameter must be set to yes on this share in order for + this parameter to have any effect. - See also the oplocks - and kernel oplocks - parameters. + See also the oplocks + and kernel oplocks + parameters. - Default: level2 oplocks = yes - - + Default: level2 oplocks = yes + + diff --git a/docs/docbook/smbdotconf/locking/locking.xml b/docs/docbook/smbdotconf/locking/locking.xml index aa27027a11..8526224316 100644 --- a/docs/docbook/smbdotconf/locking/locking.xml +++ b/docs/docbook/smbdotconf/locking/locking.xml @@ -1,25 +1,27 @@ - - locking (S) - This controls whether or not locking will be - performed by the server in response to lock requests from the - client. + + + This controls whether or not locking will be + performed by the server in response to lock requests from the + client. - If locking = no, all lock and unlock - requests will appear to succeed and all lock queries will report - that the file in question is available for locking. + If locking = no, all lock and unlock + requests will appear to succeed and all lock queries will report + that the file in question is available for locking. - If locking = yes, real locking will be performed - by the server. + If locking = yes, real locking will be performed + by the server. - This option may be useful for read-only - filesystems which may not need locking (such as - CDROM drives), although setting this parameter of no - is not really recommended even in this case. + This option may be useful for read-only + filesystems which may not need locking (such as + CDROM drives), although setting this parameter of no + is not really recommended even in this case. - Be careful about disabling locking either globally or in a - specific service, as lack of locking may result in data corruption. - You should never need to set this parameter. + Be careful about disabling locking either globally or in a + specific service, as lack of locking may result in data corruption. + You should never need to set this parameter. - Default: locking = yes - - + Default: locking = yes + + diff --git a/docs/docbook/smbdotconf/locking/lockspincount.xml b/docs/docbook/smbdotconf/locking/lockspincount.xml index 1ee1aab4d4..d308f5d845 100644 --- a/docs/docbook/smbdotconf/locking/lockspincount.xml +++ b/docs/docbook/smbdotconf/locking/lockspincount.xml @@ -1,15 +1,17 @@ - - lock spin count (G) - This parameter controls the number of times - that smbd should attempt to gain a byte range lock on the - behalf of a client request. Experiments have shown that - Windows 2k servers do not reply with a failure if the lock - could not be immediately granted, but try a few more times - in case the lock could later be aquired. This behavior - is used to support PC database formats such as MS Access - and FoxPro. - + + + This parameter controls the number of times + that smbd should attempt to gain a byte range lock on the + behalf of a client request. Experiments have shown that + Windows 2k servers do not reply with a failure if the lock + could not be immediately granted, but try a few more times + in case the lock could later be aquired. This behavior + is used to support PC database formats such as MS Access + and FoxPro. + - Default: lock spin count = 2 - - + Default: lock spin count = 2 + + diff --git a/docs/docbook/smbdotconf/locking/lockspintime.xml b/docs/docbook/smbdotconf/locking/lockspintime.xml index 4d3ea1bdc4..460b2827b4 100644 --- a/docs/docbook/smbdotconf/locking/lockspintime.xml +++ b/docs/docbook/smbdotconf/locking/lockspintime.xml @@ -1,11 +1,12 @@ - - lock spin time (G) - The time in microseconds that smbd should - pause before attempting to gain a failed lock. See - lock spin - count for more details. - + + + The time in microseconds that smbd should + pause before attempting to gain a failed lock. See + lock spin + count for more details. - Default: lock spin time = 10 - - + Default: lock spin time = 10 + + diff --git a/docs/docbook/smbdotconf/locking/oplockbreakwaittime.xml b/docs/docbook/smbdotconf/locking/oplockbreakwaittime.xml index 5e08200a33..0dc130eab3 100644 --- a/docs/docbook/smbdotconf/locking/oplockbreakwaittime.xml +++ b/docs/docbook/smbdotconf/locking/oplockbreakwaittime.xml @@ -1,16 +1,18 @@ - - oplock break wait time (G) - This is a tuning parameter added due to bugs in - both Windows 9x and WinNT. If Samba responds to a client too - quickly when that client issues an SMB that can cause an oplock - break request, then the network client can fail and not respond - to the break request. This tuning parameter (which is set in milliseconds) - is the amount of time Samba will wait before sending an oplock break - request to such (broken) clients. + + + This is a tuning parameter added due to bugs in + both Windows 9x and WinNT. If Samba responds to a client too + quickly when that client issues an SMB that can cause an oplock + break request, then the network client can fail and not respond + to the break request. This tuning parameter (which is set in milliseconds) + is the amount of time Samba will wait before sending an oplock break + request to such (broken) clients. - DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ - AND UNDERSTOOD THE SAMBA OPLOCK CODE. + DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND + UNDERSTOOD THE SAMBA OPLOCK CODE. - Default: oplock break wait time = 0 - - + Default: oplock break wait time = 0 + + diff --git a/docs/docbook/smbdotconf/locking/oplockcontentionlimit.xml b/docs/docbook/smbdotconf/locking/oplockcontentionlimit.xml index fd3b45d0b1..1b24e5cdec 100644 --- a/docs/docbook/smbdotconf/locking/oplockcontentionlimit.xml +++ b/docs/docbook/smbdotconf/locking/oplockcontentionlimit.xml @@ -1,19 +1,22 @@ - - oplock contention limit (S) - This is a very advanced - smbd(8) tuning option to - improve the efficiency of the granting of oplocks under multiple - client contention for the same file. + + + This is a very advanced + smbd + 8 tuning option to + improve the efficiency of the granting of oplocks under multiple + client contention for the same file. - In brief it specifies a number, which causes smbd - 8not to grant an oplock even when requested - if the approximate number of clients contending for an oplock on the same file goes over this - limit. This causes smbd to behave in a similar - way to Windows NT. + In brief it specifies a number, which causes smbd + 8not to grant an oplock even when requested + if the approximate number of clients contending for an oplock on the same file goes over this + limit. This causes smbd to behave in a similar + way to Windows NT. - DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ - AND UNDERSTOOD THE SAMBA OPLOCK CODE. + DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ + AND UNDERSTOOD THE SAMBA OPLOCK CODE. - Default: oplock contention limit = 2 - - + Default: oplock contention limit = 2 + + diff --git a/docs/docbook/smbdotconf/locking/oplocks.xml b/docs/docbook/smbdotconf/locking/oplocks.xml index 071786f35c..0ba53ba765 100644 --- a/docs/docbook/smbdotconf/locking/oplocks.xml +++ b/docs/docbook/smbdotconf/locking/oplocks.xml @@ -1,27 +1,29 @@ - - oplocks (S) - This boolean option tells smbd whether to - issue oplocks (opportunistic locks) to file open requests on this - share. The oplock code can dramatically (approx. 30% or more) improve - the speed of access to files on Samba servers. It allows the clients - to aggressively cache files locally and you may want to disable this - option for unreliable network environments (it is turned on by - default in Windows NT Servers). For more information see the file - Speed.txt in the Samba docs/ - directory. + + + This boolean option tells smbd whether to + issue oplocks (opportunistic locks) to file open requests on this + share. The oplock code can dramatically (approx. 30% or more) improve + the speed of access to files on Samba servers. It allows the clients + to aggressively cache files locally and you may want to disable this + option for unreliable network environments (it is turned on by + default in Windows NT Servers). For more information see the file + Speed.txt in the Samba docs/ + directory. - Oplocks may be selectively turned off on certain files with a - share. See the - veto oplock files parameter. On some systems - oplocks are recognized by the underlying operating system. This - allows data synchronization between all access to oplocked files, - whether it be via Samba or NFS or a local UNIX process. See the - kernel oplocks parameter for details. + Oplocks may be selectively turned off on certain files with a + share. See the + veto oplock files parameter. On some systems + oplocks are recognized by the underlying operating system. This + allows data synchronization between all access to oplocked files, + whether it be via Samba or NFS or a local UNIX process. See the + kernel oplocks parameter for details. - See also the kernel - oplocks and - level2 oplocks parameters. + See also the kernel + oplocks and + level2 oplocks parameters. - Default: oplocks = yes - - + Default: oplocks = yes + + diff --git a/docs/docbook/smbdotconf/locking/posixlocking.xml b/docs/docbook/smbdotconf/locking/posixlocking.xml index 4f2e2d215b..c81bdcff38 100644 --- a/docs/docbook/smbdotconf/locking/posixlocking.xml +++ b/docs/docbook/smbdotconf/locking/posixlocking.xml @@ -1,14 +1,16 @@ - - posix locking (S) - The smbd - 8 - daemon maintains an database of file locks obtained by SMB clients. - The default behavior is to map this internal database to POSIX - locks. This means that file locks obtained by SMB clients are - consistent with those seen by POSIX compliant applications accessing - the files via a non-SMB method (e.g. NFS or local file access). - You should never need to disable this parameter. + + + The smbd + 8 + daemon maintains an database of file locks obtained by SMB clients. + The default behavior is to map this internal database to POSIX + locks. This means that file locks obtained by SMB clients are + consistent with those seen by POSIX compliant applications accessing + the files via a non-SMB method (e.g. NFS or local file access). + You should never need to disable this parameter. - Default: posix locking = yes - - + Default: posix locking = yes + + diff --git a/docs/docbook/smbdotconf/locking/sharemodes.xml b/docs/docbook/smbdotconf/locking/sharemodes.xml index c789ed0fb2..529ec44106 100644 --- a/docs/docbook/smbdotconf/locking/sharemodes.xml +++ b/docs/docbook/smbdotconf/locking/sharemodes.xml @@ -1,26 +1,28 @@ - - share modes (S) - This enables or disables the honoring of - the share modes during a file open. These - modes are used by clients to gain exclusive read or write access - to a file. + + + This enables or disables the honoring of + the share modes during a file open. These + modes are used by clients to gain exclusive read or write access + to a file. - These open modes are not directly supported by UNIX, so - they are simulated using shared memory, or lock files if your - UNIX doesn't support shared memory (almost all do). + These open modes are not directly supported by UNIX, so + they are simulated using shared memory, or lock files if your + UNIX doesn't support shared memory (almost all do). - The share modes that are enabled by this option are - DENY_DOS, DENY_ALL, - DENY_READ, DENY_WRITE, - DENY_NONE and DENY_FCB. - + The share modes that are enabled by this option are + DENY_DOS, DENY_ALL, + DENY_READ, DENY_WRITE, + DENY_NONE and DENY_FCB. + - This option gives full share compatibility and enabled - by default. + This option gives full share compatibility and enabled + by default. - You should NEVER turn this parameter - off as many Windows applications will break if you do so. + You should NEVER turn this parameter + off as many Windows applications will break if you do so. - Default: share modes = yes - - + Default: share modes = yes + + diff --git a/docs/docbook/smbdotconf/locking/strictlocking.xml b/docs/docbook/smbdotconf/locking/strictlocking.xml index b67ae47736..34c1c7fe5e 100644 --- a/docs/docbook/smbdotconf/locking/strictlocking.xml +++ b/docs/docbook/smbdotconf/locking/strictlocking.xml @@ -1,17 +1,19 @@ - - strict locking (S) - This is a boolean that controls the handling of - file locking in the server. When this is set to yes - the server will check every read and write access for file locks, and - deny access if locks exist. This can be slow on some systems. + + + This is a boolean that controls the handling of + file locking in the server. When this is set to yes + the server will check every read and write access for file locks, and + deny access if locks exist. This can be slow on some systems. - When strict locking is no the server does file - lock checks only when the client explicitly asks for them. + When strict locking is no the server does file + lock checks only when the client explicitly asks for them. - Well-behaved clients always ask for lock checks when it - is important, so in the vast majority of cases strict - locking = no is preferable. + Well-behaved clients always ask for lock checks when it + is important, so in the vast majority of cases strict + locking = no is preferable. - Default: strict locking = no - - + Default: strict locking = no + + -- cgit From 957270bcc0fec692270c4d22e974b98cb774aa4f Mon Sep 17 00:00:00 2001 From: Alexander Bokovoy Date: Fri, 11 Apr 2003 15:17:53 +0000 Subject: Finish conversion of LDAP options (This used to be commit 938e3d3f5305ed2162fa0cb0d2a6025fbadfcfec) --- docs/docbook/smbdotconf/ldap/ldapadmindn.xml | 29 +++++----- docs/docbook/smbdotconf/ldap/ldapdeletedn.xml | 21 ++++---- docs/docbook/smbdotconf/ldap/ldapfilter.xml | 24 +++++---- docs/docbook/smbdotconf/ldap/ldapmachinesuffix.xml | 19 ++++--- docs/docbook/smbdotconf/ldap/ldappasswdsync.xml | 50 +++++++++++------- docs/docbook/smbdotconf/ldap/ldapport.xml | 33 ++++++------ docs/docbook/smbdotconf/ldap/ldapserver.xml | 26 ++++----- docs/docbook/smbdotconf/ldap/ldapssl.xml | 61 +++++++++++++--------- docs/docbook/smbdotconf/ldap/ldapsuffix.xml | 20 ++++--- docs/docbook/smbdotconf/ldap/ldaptrustids.xml | 39 ++++++++------ docs/docbook/smbdotconf/ldap/ldapusersuffix.xml | 20 +++---- 11 files changed, 190 insertions(+), 152 deletions(-) (limited to 'docs/docbook/smbdotconf') diff --git a/docs/docbook/smbdotconf/ldap/ldapadmindn.xml b/docs/docbook/smbdotconf/ldap/ldapadmindn.xml index f92e8ce310..301c88df7b 100644 --- a/docs/docbook/smbdotconf/ldap/ldapadmindn.xml +++ b/docs/docbook/smbdotconf/ldap/ldapadmindn.xml @@ -1,13 +1,16 @@ - - ldap admin dn (G) - The ldap admin dn defines the Distinguished - Name (DN) name used by Samba to contact the ldap server when retreiving - user account information. The ldap - admin dn is used in conjunction with the admin dn password - stored in the private/secrets.tdb file. See the - smbpasswd - 8 man page for more information on how - to accmplish this. - - - + + + The ldap admin dn + defines the Distinguished Name (DN) name used by Samba to + contact the ldap server when retreiving user account + information. The ldap admin + dn is used in conjunction with the admin dn password + stored in the private/secrets.tdb file. + See the smbpasswd + 8 man page for more + information on how to accmplish this. + + diff --git a/docs/docbook/smbdotconf/ldap/ldapdeletedn.xml b/docs/docbook/smbdotconf/ldap/ldapdeletedn.xml index f4a820c16d..89a75e02fd 100644 --- a/docs/docbook/smbdotconf/ldap/ldapdeletedn.xml +++ b/docs/docbook/smbdotconf/ldap/ldapdeletedn.xml @@ -1,10 +1,13 @@ - - ldap delete dn (G) - This parameter specifies whether a delete - operation in the ldapsam deletes the complete entry or only the attributes - specific to Samba. - + + + This parameter specifies whether a delete + operation in the ldapsam deletes the complete entry or only the attributes + specific to Samba. + - Default : ldap delete dn = no - - + Default: ldap delete dn = no + + diff --git a/docs/docbook/smbdotconf/ldap/ldapfilter.xml b/docs/docbook/smbdotconf/ldap/ldapfilter.xml index 6ddf8db30f..1d0ab33d89 100644 --- a/docs/docbook/smbdotconf/ldap/ldapfilter.xml +++ b/docs/docbook/smbdotconf/ldap/ldapfilter.xml @@ -1,12 +1,14 @@ - - ldap filter (G) - This parameter specifies the RFC 2254 compliant LDAP search filter. - The default is to match the login name with the uid - attribute for all entries matching the sambaAccount - objectclass. Note that this filter should only return one entry. - + + + This parameter specifies the RFC 2254 compliant LDAP search filter. + The default is to match the login name with the uid + attribute for all entries matching the sambaAccount + objectclass. Note that this filter should only return one entry. + - - Default : ldap filter = (&(uid=%u)(objectclass=sambaAccount)) - - + Default: ldap filter = (&(uid=%u)(objectclass=sambaAccount)) + + diff --git a/docs/docbook/smbdotconf/ldap/ldapmachinesuffix.xml b/docs/docbook/smbdotconf/ldap/ldapmachinesuffix.xml index e02bf9acfc..0ef6a04abf 100644 --- a/docs/docbook/smbdotconf/ldap/ldapmachinesuffix.xml +++ b/docs/docbook/smbdotconf/ldap/ldapmachinesuffix.xml @@ -1,11 +1,10 @@ - - ldap machine suffix (G) - It specifies where machines should be - added to the ldap tree. - - + + + It specifies where machines should be added to the ldap tree. - - Default : none - - + Default: none + + diff --git a/docs/docbook/smbdotconf/ldap/ldappasswdsync.xml b/docs/docbook/smbdotconf/ldap/ldappasswdsync.xml index ce9449374d..8015b2fb2d 100644 --- a/docs/docbook/smbdotconf/ldap/ldappasswdsync.xml +++ b/docs/docbook/smbdotconf/ldap/ldappasswdsync.xml @@ -1,23 +1,35 @@ - - ldap passwd sync (G) - This option is used to define whether - or not Samba should sync the LDAP password with the NT - and LM hashes for normal accounts (NOT for - workstation, server or domain trusts) on a password - change via SAMBA. - + + + This option is used to define whether + or not Samba should sync the LDAP password with the NT + and LM hashes for normal accounts (NOT for + workstation, server or domain trusts) on a password + change via SAMBA. + - - The ldap passwd sync can be set to one of three values: - - - Yes = Try to update the LDAP, NT and LM passwords and update the pwdLastSet time. + The ldap passwd + sync can be set to one of three values: + + + + Yes = Try + to update the LDAP, NT and LM passwords and update the pwdLastSet time. + - No = Update NT and LM passwords and update the pwdLastSet time. + + No = Update NT and + LM passwords and update the pwdLastSet time. + - Only = Only update the LDAP password and let the LDAP server do the rest. - - - Default : ldap passwd sync = no + + Only = Only update + the LDAP password and let the LDAP server do the rest. - + + + Default: ldap passwd sync = no + + diff --git a/docs/docbook/smbdotconf/ldap/ldapport.xml b/docs/docbook/smbdotconf/ldap/ldapport.xml index 97c256d423..c00c525db0 100644 --- a/docs/docbook/smbdotconf/ldap/ldapport.xml +++ b/docs/docbook/smbdotconf/ldap/ldapport.xml @@ -1,20 +1,19 @@ - - ldap port (G) - This parameter is only available if Samba has been - configure to include the --with-ldapsam option - at compile time. - + + + This parameter is only available if Samba has been + configure to include the --with-ldapsam option + at compile time. - - This option is used to control the tcp port number used to contact - the ldap server. - The default is to use the stand LDAPS port 636. - + This option is used to control the tcp port number used to contact + the ldap server. + The default is to use the stand LDAPS port 636. - See Also: ldap ssl - + See Also: ldap ssl - Default : ldap port = 636 ; if ldap ssl = on - Default : ldap port = 389 ; if ldap ssl = off - - + Default : ldap port = 636 ; if ldap ssl = on + + Default : ldap port = 389 ; if ldap ssl = off + + diff --git a/docs/docbook/smbdotconf/ldap/ldapserver.xml b/docs/docbook/smbdotconf/ldap/ldapserver.xml index 33d5652ac9..e7a4c670ab 100644 --- a/docs/docbook/smbdotconf/ldap/ldapserver.xml +++ b/docs/docbook/smbdotconf/ldap/ldapserver.xml @@ -1,15 +1,15 @@ - - ldap server (G) - This parameter is only available if Samba has been - configure to include the --with-ldapsam option - at compile time. - + + + This parameter is only available if Samba has been + configure to include the --with-ldapsam + option at compile time. - - This parameter should contain the FQDN of the ldap directory - server which should be queried to locate user account information. - + This parameter should contain the FQDN of the ldap directory + server which should be queried to locate user account information. + - Default : ldap server = localhost - - + Default : ldap server = localhost + + diff --git a/docs/docbook/smbdotconf/ldap/ldapssl.xml b/docs/docbook/smbdotconf/ldap/ldapssl.xml index d747d8f7df..13bafdf3a7 100644 --- a/docs/docbook/smbdotconf/ldap/ldapssl.xml +++ b/docs/docbook/smbdotconf/ldap/ldapssl.xml @@ -1,30 +1,39 @@ - - ldap ssl (G) - This option is used to define whether or not Samba should - use SSL when connecting to the ldap server - This is NOT related to - Samba's previous SSL support which was enabled by specifying the - --with-ssl option to the configure - script. - + + + This option is used to define whether or not Samba should + use SSL when connecting to the ldap server + This is NOT related to + Samba's previous SSL support which was enabled by specifying the + --with-ssl option to the configure + script. - - The ldap ssl can be set to one of three values: - - - Off = Never use SSL when querying the directory. + The ldap ssl can be set to one of three values: + + + Off = Never + use SSL when querying the directory. + - Start_tls = Use the LDAPv3 StartTLS extended operation - (RFC2830) for communicating with the directory server. + + Start_tls = Use + the LDAPv3 StartTLS extended operation (RFC2830) for + communicating with the directory server. + - On = - Use SSL on the ldaps port when contacting the - ldap server. Only - available when the backwards-compatiblity - --with-ldapsam option is specified - to configure. See passdb backend - - - Default : ldap ssl = start_tls + + On = Use SSL + on the ldaps port when contacting the ldap server. Only available when the + backwards-compatiblity --with-ldapsam option is specified + to configure. See passdb backend - + + + Default : ldap ssl = start_tls + + diff --git a/docs/docbook/smbdotconf/ldap/ldapsuffix.xml b/docs/docbook/smbdotconf/ldap/ldapsuffix.xml index dae15f8104..609f171096 100644 --- a/docs/docbook/smbdotconf/ldap/ldapsuffix.xml +++ b/docs/docbook/smbdotconf/ldap/ldapsuffix.xml @@ -1,8 +1,14 @@ - - ldap suffix (G) - - Specifies where user and machine accounts are added to the tree. Can be overriden by ldap user suffix and ldap machine suffix. It also used as the base dn for all ldap searches. + + + Specifies where user and machine accounts are added to the + tree. Can be overriden by ldap user + suffix and ldap machine + suffix. It also used as the base dn for all ldap + searches. - Default : none - - + Default: none + + diff --git a/docs/docbook/smbdotconf/ldap/ldaptrustids.xml b/docs/docbook/smbdotconf/ldap/ldaptrustids.xml index 8fe4a1400b..36bbcb2fb4 100644 --- a/docs/docbook/smbdotconf/ldap/ldaptrustids.xml +++ b/docs/docbook/smbdotconf/ldap/ldaptrustids.xml @@ -1,18 +1,23 @@ - - ldap trust ids (G) - Normally, Samba validates each entry - in the LDAP server against getpwnam(). This allows - LDAP to be used for Samba with the unix system using - NIS (for example) and also ensures that Samba does not - present accounts that do not otherwise exist. - This option is used to disable this functionality, and - instead to rely on the presence of the appropriate - attributes in LDAP directly, which can result in a - significant performance boost in some situations. - Setting this option to yes effectivly assumes - that the local machine is running nss_ldap against the - same LDAP server. + + - Default: ldap trust ids = No - - + Normally, Samba validates each entry in the LDAP server + against getpwnam(). This allows LDAP to be used for Samba with + the unix system using NIS (for example) and also ensures that + Samba does not present accounts that do not otherwise exist. + + + This option is used to disable this functionality, and + instead to rely on the presence of the appropriate attributes + in LDAP directly, which can result in a significant performance + boost in some situations. Setting this option to yes effectivly + assumes that the local machine is running nss_ldap against the same LDAP + server. + + Default: ldap trust ids = No + + diff --git a/docs/docbook/smbdotconf/ldap/ldapusersuffix.xml b/docs/docbook/smbdotconf/ldap/ldapusersuffix.xml index e4fb681e23..731fba3420 100644 --- a/docs/docbook/smbdotconf/ldap/ldapusersuffix.xml +++ b/docs/docbook/smbdotconf/ldap/ldapusersuffix.xml @@ -1,10 +1,10 @@ - - ldap user suffix (G) - It specifies where users are added to the tree. - - - - - Default : none - - + + + It specifies where users are added to the tree. + + Default: none + + -- cgit From c62b42d2b2aa065eeb510b0ec98a1ea45e7b606e Mon Sep 17 00:00:00 2001 From: Alexander Bokovoy Date: Fri, 11 Apr 2003 15:25:03 +0000 Subject: Finish conversion of VFS options. This section is not complete yet -- we miss documentation for parametric options and new modules stuff (This used to be commit 769bce45e9678b67e2ef1da84d5ee95c90357b9e) --- docs/docbook/smbdotconf/vfs/hostmsdfs.xml | 33 +++++++++++++++------------- docs/docbook/smbdotconf/vfs/msdfsproxy.xml | 33 +++++++++++++++------------- docs/docbook/smbdotconf/vfs/msdfsroot.xml | 35 +++++++++++++++--------------- docs/docbook/smbdotconf/vfs/vfsobject.xml | 20 +++++++++-------- docs/docbook/smbdotconf/vfs/vfsoptions.xml | 20 +++++++++-------- docs/docbook/smbdotconf/vfs/vfspath.xml | 21 +++++++++--------- 6 files changed, 87 insertions(+), 75 deletions(-) (limited to 'docs/docbook/smbdotconf') diff --git a/docs/docbook/smbdotconf/vfs/hostmsdfs.xml b/docs/docbook/smbdotconf/vfs/hostmsdfs.xml index 0496fd7f47..c843969e50 100644 --- a/docs/docbook/smbdotconf/vfs/hostmsdfs.xml +++ b/docs/docbook/smbdotconf/vfs/hostmsdfs.xml @@ -1,17 +1,20 @@ - - host msdfs (G) - This boolean parameter is only available - if Samba has been configured and compiled with the - --with-msdfs option. If set to yes, - Samba will act as a Dfs server, and allow Dfs-aware clients - to browse Dfs trees hosted on the server. + + + This boolean parameter is only available + if Samba has been configured and compiled with the + --with-msdfs option. If set to yes, + Samba will act as a Dfs server, and allow Dfs-aware clients + to browse Dfs trees hosted on the server. - See also the - msdfs root share level parameter. For - more information on setting up a Dfs tree on Samba, - refer to msdfs_setup.html. - + See also the + msdfs root share level parameter. For + more information on setting up a Dfs tree on Samba, + refer to msdfs_setup.html. + - Default: host msdfs = no - - + Default: host msdfs = no + + diff --git a/docs/docbook/smbdotconf/vfs/msdfsproxy.xml b/docs/docbook/smbdotconf/vfs/msdfsproxy.xml index 41b36cb91b..c16968fda7 100644 --- a/docs/docbook/smbdotconf/vfs/msdfsproxy.xml +++ b/docs/docbook/smbdotconf/vfs/msdfsproxy.xml @@ -1,15 +1,18 @@ - - msdfs proxy (S) - This parameter indicates that the share is a - stand-in for another CIFS share whose location is specified by - the value of the parameter. When clients attempt to connect to - this share, they are redirected to the proxied share using - the SMB-Dfs protocol. - Only Dfs roots can act as proxy shares. Take a look at the - msdfs root - and - host msdfs - options to find out how to set up a Dfs root share. - Example: msdfs proxy = \\\\otherserver\\someshare - - + + + This parameter indicates that the share is a + stand-in for another CIFS share whose location is specified by + the value of the parameter. When clients attempt to connect to + this share, they are redirected to the proxied share using + the SMB-Dfs protocol. + + Only Dfs roots can act as proxy shares. Take a look at the + msdfs root + and host msdfs + options to find out how to set up a Dfs root share. + + Example: msdfs proxy = \\\\otherserver\\someshare + + diff --git a/docs/docbook/smbdotconf/vfs/msdfsroot.xml b/docs/docbook/smbdotconf/vfs/msdfsroot.xml index dc50ba5e57..35142ff037 100644 --- a/docs/docbook/smbdotconf/vfs/msdfsroot.xml +++ b/docs/docbook/smbdotconf/vfs/msdfsroot.xml @@ -1,19 +1,20 @@ - - msdfs root (S) - This boolean parameter is only available if - Samba is configured and compiled with the - --with-msdfs option. If set to yes, - Samba treats the share as a Dfs root and allows clients to browse - the distributed file system tree rooted at the share directory. - Dfs links are specified in the share directory by symbolic - links of the form msdfs:serverA\\shareA,serverB\\shareB - and so on. For more information on setting up a Dfs tree - on Samba, refer to "Hosting a Microsoft - Distributed File System tree on Samba" document. + + + This boolean parameter is only available if + Samba is configured and compiled with the + --with-msdfs option. If set to yes, + Samba treats the share as a Dfs root and allows clients to browse + the distributed file system tree rooted at the share directory. + Dfs links are specified in the share directory by symbolic + links of the form msdfs:serverA\\shareA,serverB\\shareB + and so on. For more information on setting up a Dfs tree + on Samba, refer to "Hosting a Microsoft + Distributed File System tree on Samba" document. - See also host msdfs - + See also host msdfs - Default: msdfs root = no - - + Default: msdfs root = no + + diff --git a/docs/docbook/smbdotconf/vfs/vfsobject.xml b/docs/docbook/smbdotconf/vfs/vfsobject.xml index d334552dae..c68e8d0135 100644 --- a/docs/docbook/smbdotconf/vfs/vfsobject.xml +++ b/docs/docbook/smbdotconf/vfs/vfsobject.xml @@ -1,10 +1,12 @@ - - vfs object (S) - This parameter specifies a shared object files that - are used for Samba VFS I/O operations. By default, normal - disk I/O operations are used but these can be overloaded - with one or more VFS objects. + + + This parameter specifies a shared object files that + are used for Samba VFS I/O operations. By default, normal + disk I/O operations are used but these can be overloaded + with one or more VFS objects. - Default : no value - - + Default: no value + + diff --git a/docs/docbook/smbdotconf/vfs/vfsoptions.xml b/docs/docbook/smbdotconf/vfs/vfsoptions.xml index 28f14a09bf..d07ec461e2 100644 --- a/docs/docbook/smbdotconf/vfs/vfsoptions.xml +++ b/docs/docbook/smbdotconf/vfs/vfsoptions.xml @@ -1,10 +1,12 @@ - - vfs options (S) - This parameter allows parameters to be passed - to the vfs layer at initialization time. - See also - vfs object. + + + This parameter allows parameters to be passed + to the vfs layer at initialization time. + See also + vfs object. - Default : no value - - + Default: no value + + diff --git a/docs/docbook/smbdotconf/vfs/vfspath.xml b/docs/docbook/smbdotconf/vfs/vfspath.xml index 78c27302a8..c6718a0076 100644 --- a/docs/docbook/smbdotconf/vfs/vfspath.xml +++ b/docs/docbook/smbdotconf/vfs/vfspath.xml @@ -1,12 +1,13 @@ - - vfs path (S) - This parameter specifies the directory - to look in for vfs modules. The name of every vfs object - will be prepended by this directory - + + + This parameter specifies the directory + to look in for vfs modules. The name of every vfs object + will be prepended by this directory. - Default: vfs path = - Example: vfs path = /usr/lib/samba/vfs + Default: vfs path = - - + Example: vfs path = /usr/lib/samba/vfs + + -- cgit From 32bd50c8284de4d9ccb9864d6ec2069403b1949d Mon Sep 17 00:00:00 2001 From: Alexander Bokovoy Date: Fri, 11 Apr 2003 15:44:52 +0000 Subject: Finish conversion of Winbind options. Only Misc section left! (This used to be commit 4861003048b409aea20362e79a99ce286bf225de) --- .../docbook/smbdotconf/winbind/templatehomedir.xml | 28 +++++++++------- docs/docbook/smbdotconf/winbind/templateshell.xml | 21 +++++++----- .../smbdotconf/winbind/winbindcachetime.xml | 23 +++++++------ .../smbdotconf/winbind/winbindenumgroups.xml | 35 ++++++++++--------- .../smbdotconf/winbind/winbindenumusers.xml | 39 ++++++++++++---------- docs/docbook/smbdotconf/winbind/winbindgid.xml | 26 ++++++++------- .../smbdotconf/winbind/winbindseparator.xml | 34 ++++++++++--------- docs/docbook/smbdotconf/winbind/winbinduid.xml | 26 ++++++++------- .../smbdotconf/winbind/winbindusedefaultdomain.xml | 31 +++++++++-------- 9 files changed, 146 insertions(+), 117 deletions(-) (limited to 'docs/docbook/smbdotconf') diff --git a/docs/docbook/smbdotconf/winbind/templatehomedir.xml b/docs/docbook/smbdotconf/winbind/templatehomedir.xml index a931e9b5a3..6c19617bab 100644 --- a/docs/docbook/smbdotconf/winbind/templatehomedir.xml +++ b/docs/docbook/smbdotconf/winbind/templatehomedir.xml @@ -1,13 +1,17 @@ - - template homedir (G) - When filling out the user information for a Windows NT - user, the winbindd(8) daemon - uses this parameter to fill in the home directory for that user. - If the string %D is present it is substituted - with the user's Windows NT domain name. If the string %U - is present it is substituted with the user's Windows - NT user name. + + + When filling out the user information for a Windows NT + user, the winbindd + 8 daemon uses this + parameter to fill in the home directory for that user. If the + string %D is present it + is substituted with the user's Windows NT domain name. If the + string %U is present it + is substituted with the user's Windows NT user name. - Default: template homedir = /home/%D/%U - - + Default: template homedir = /home/%D/%U + + diff --git a/docs/docbook/smbdotconf/winbind/templateshell.xml b/docs/docbook/smbdotconf/winbind/templateshell.xml index e0b9f1a2ca..1104387331 100644 --- a/docs/docbook/smbdotconf/winbind/templateshell.xml +++ b/docs/docbook/smbdotconf/winbind/templateshell.xml @@ -1,10 +1,13 @@ - - template shell (G) - When filling out the user information for a Windows NT - user, the winbindd - 8 daemon - uses this parameter to fill in the login shell for that user. + + + When filling out the user information for a Windows NT + user, the winbindd + 8 daemon uses this + parameter to fill in the login shell for that user. - Default: template shell = /bin/false - - + Default: template shell = /bin/false + + diff --git a/docs/docbook/smbdotconf/winbind/winbindcachetime.xml b/docs/docbook/smbdotconf/winbind/winbindcachetime.xml index adbb8b12f6..3080adc7c8 100644 --- a/docs/docbook/smbdotconf/winbind/winbindcachetime.xml +++ b/docs/docbook/smbdotconf/winbind/winbindcachetime.xml @@ -1,11 +1,14 @@ - - winbind cache time (G) - This parameter specifies the number of - seconds the winbindd - 8 daemon will cache - user and group information before querying a Windows NT server - again. + + + This parameter specifies the number of + seconds the winbindd + 8 daemon will cache + user and group information before querying a Windows NT server + again. - Default: winbind cache type = 15 - - + Default: winbind cache type = 15 + + diff --git a/docs/docbook/smbdotconf/winbind/winbindenumgroups.xml b/docs/docbook/smbdotconf/winbind/winbindenumgroups.xml index 096c280fc2..1cffca7492 100644 --- a/docs/docbook/smbdotconf/winbind/winbindenumgroups.xml +++ b/docs/docbook/smbdotconf/winbind/winbindenumgroups.xml @@ -1,18 +1,21 @@ - - winbind enum groups (G) - On large installations using winbindd - 8 it may be necessary to suppress - the enumeration of groups through the setgrent(), - getgrent() and - endgrent() group of system calls. If - the winbind enum groups parameter is - no, calls to the getgrent() system - call will not return any data. + + + On large installations using winbindd + 8 it may be necessary to suppress + the enumeration of groups through the setgrent(), + getgrent() and + endgrent() group of system calls. If + the winbind enum groups parameter is + no, calls to the getgrent() system + call will not return any data. - Warning: Turning off group - enumeration may cause some programs to behave oddly. - + Warning: Turning off group + enumeration may cause some programs to behave oddly. + - Default: winbind enum groups = yes - - + Default: winbind enum groups = yes + + diff --git a/docs/docbook/smbdotconf/winbind/winbindenumusers.xml b/docs/docbook/smbdotconf/winbind/winbindenumusers.xml index 7935755f0c..95f1e7ff4c 100644 --- a/docs/docbook/smbdotconf/winbind/winbindenumusers.xml +++ b/docs/docbook/smbdotconf/winbind/winbindenumusers.xml @@ -1,20 +1,23 @@ - - winbind enum users (G) - On large installations using winbindd - 8 it may be - necessary to suppress the enumeration of users through the setpwent(), - getpwent() and - endpwent() group of system calls. If - the winbind enum users parameter is - no, calls to the getpwent system call - will not return any data. + + + On large installations using winbindd + 8 it may be + necessary to suppress the enumeration of users through the setpwent(), + getpwent() and + endpwent() group of system calls. If + the winbind enum users parameter is + no, calls to the getpwent system call + will not return any data. - Warning: Turning off user - enumeration may cause some programs to behave oddly. For - example, the finger program relies on having access to the - full user list when searching for matching - usernames. + Warning: Turning off user + enumeration may cause some programs to behave oddly. For + example, the finger program relies on having access to the + full user list when searching for matching + usernames. - Default: winbind enum users = yes - - + Default: winbind enum users = yes + + diff --git a/docs/docbook/smbdotconf/winbind/winbindgid.xml b/docs/docbook/smbdotconf/winbind/winbindgid.xml index a8a9683b01..a8414e9e8c 100644 --- a/docs/docbook/smbdotconf/winbind/winbindgid.xml +++ b/docs/docbook/smbdotconf/winbind/winbindgid.xml @@ -1,14 +1,16 @@ - - winbind gid (G) - The winbind gid parameter specifies the range of group - ids that are allocated by the winbindd - 8 daemon. This range of group ids should have no - existing local or NIS groups within it as strange conflicts can - occur otherwise. + + + The winbind gid parameter specifies the range of group + ids that are allocated by the winbindd + 8 daemon. This range of group ids should have no + existing local or NIS groups within it as strange conflicts can + occur otherwise. - Default: winbind gid = <empty string> - + Default: winbind gid = <empty string> - Example: winbind gid = 10000-20000 - - + Example: winbind gid = 10000-20000 + + diff --git a/docs/docbook/smbdotconf/winbind/winbindseparator.xml b/docs/docbook/smbdotconf/winbind/winbindseparator.xml index 416adcb531..cefc69d5bd 100644 --- a/docs/docbook/smbdotconf/winbind/winbindseparator.xml +++ b/docs/docbook/smbdotconf/winbind/winbindseparator.xml @@ -1,17 +1,21 @@ - - winbind separator (G) - This parameter allows an admin to define the character - used when listing a username of the form of DOMAIN - \user. This parameter - is only applicable when using the pam_winbind.so - and nss_winbind.so modules for UNIX services. - + + + This parameter allows an admin to define the character + used when listing a username of the form of DOMAIN + \user. This parameter + is only applicable when using the pam_winbind.so + and nss_winbind.so modules for UNIX services. + - Please note that setting this parameter to + causes problems - with group membership at least on glibc systems, as the character + - is used as a special character for NIS in /etc/group. + Please note that setting this parameter to + causes problems + with group membership at least on glibc systems, as the character + + is used as a special character for NIS in /etc/group. - Default: winbind separator = '\' - Example: winbind separator = + - - + Default: winbind separator = '\' + + Example: winbind separator = + + + diff --git a/docs/docbook/smbdotconf/winbind/winbinduid.xml b/docs/docbook/smbdotconf/winbind/winbinduid.xml index ecd7848f61..6fee40fcb8 100644 --- a/docs/docbook/smbdotconf/winbind/winbinduid.xml +++ b/docs/docbook/smbdotconf/winbind/winbinduid.xml @@ -1,14 +1,16 @@ - - winbind uid (G) - The winbind gid parameter specifies the range of group - ids that are allocated by the winbindd - 8 daemon. This range of ids should have no - existing local or NIS users within it as strange conflicts can - occur otherwise. + + + The winbind gid parameter specifies the range of group + ids that are allocated by the winbindd + 8 daemon. This range of ids should have no + existing local or NIS users within it as strange conflicts can + occur otherwise. - Default: winbind uid = <empty string> - + Default: winbind uid = <empty string> - Example: winbind uid = 10000-20000 - - + Example: winbind uid = 10000-20000 + + diff --git a/docs/docbook/smbdotconf/winbind/winbindusedefaultdomain.xml b/docs/docbook/smbdotconf/winbind/winbindusedefaultdomain.xml index a6b7bcd7e5..5c31a7f9b0 100644 --- a/docs/docbook/smbdotconf/winbind/winbindusedefaultdomain.xml +++ b/docs/docbook/smbdotconf/winbind/winbindusedefaultdomain.xml @@ -1,14 +1,19 @@ - - winbind use default domain (G) - This parameter specifies whether the winbindd - 8 daemon should operate on users - without domain component in their username. - Users without a domain component are treated as is part of the winbindd server's - own domain. While this does not benifit Windows users, it makes SSH, FTP and e-mail - function in a way much closer to the way they would in a native unix system. + + + This parameter specifies whether the + winbindd + 8 daemon should operate on users + without domain component in their username. Users without a domain + component are treated as is part of the winbindd server's own + domain. While this does not benifit Windows users, it makes SSH, FTP and + e-mail function in a way much closer to the way they + would in a native unix system. - Default: winbind use default domain = <no> - - Example: winbind use default domain = yes - - + Default: winbind use default domain = <no> + + Example: winbind use default domain = yes + + -- cgit From 3d5bb047b18fd289459c4096cc4787b89bbffafe Mon Sep 17 00:00:00 2001 From: Alexander Bokovoy Date: Fri, 11 Apr 2003 15:55:49 +0000 Subject: Fix typos in printing (This used to be commit 63cf664adeff997e359fc56ac75feb85d64ff2d7) --- .../smbdotconf/domain/machinepasswordtimeout.xml | 35 ++++++++++++---------- .../smbdotconf/printing/enumportscommand.xml | 2 +- docs/docbook/smbdotconf/printing/printing.xml | 2 +- 3 files changed, 21 insertions(+), 18 deletions(-) (limited to 'docs/docbook/smbdotconf') diff --git a/docs/docbook/smbdotconf/domain/machinepasswordtimeout.xml b/docs/docbook/smbdotconf/domain/machinepasswordtimeout.xml index 14e6d9c5df..06017fce59 100644 --- a/docs/docbook/smbdotconf/domain/machinepasswordtimeout.xml +++ b/docs/docbook/smbdotconf/domain/machinepasswordtimeout.xml @@ -1,18 +1,21 @@ - - machine password timeout (G) - If a Samba server is a member of a Windows - NT Domain (see the security = domain) - parameter) then periodically a running - smbd(8) process will try and change the MACHINE ACCOUNT - PASSWORD stored in the TDB called private/secrets.tdb - . This parameter specifies how often this password - will be changed, in seconds. The default is one week (expressed in - seconds), the same as a Windows NT Domain member server. + + + If a Samba server is a member of a Windows + NT Domain (see the security = domain) + parameter) then periodically a running + smbd(8) process will try and change the MACHINE ACCOUNT + PASSWORD stored in the TDB called private/secrets.tdb + . This parameter specifies how often this password + will be changed, in seconds. The default is one week (expressed in + seconds), the same as a Windows NT Domain member server. - See also smbpasswd - 8, and the - security = domain) parameter. + See also smbpasswd + 8, and the + security = domain) parameter. - Default: machine password timeout = 604800 - - + Default: machine password timeout = 604800 + + diff --git a/docs/docbook/smbdotconf/printing/enumportscommand.xml b/docs/docbook/smbdotconf/printing/enumportscommand.xml index 89e510483f..7cdf0cc370 100644 --- a/docs/docbook/smbdotconf/printing/enumportscommand.xml +++ b/docs/docbook/smbdotconf/printing/enumportscommand.xml @@ -1,6 +1,6 @@ The concept of a "port" is fairly foreign diff --git a/docs/docbook/smbdotconf/printing/printing.xml b/docs/docbook/smbdotconf/printing/printing.xml index 4e9caa9b54..633666eea7 100644 --- a/docs/docbook/smbdotconf/printing/printing.xml +++ b/docs/docbook/smbdotconf/printing/printing.xml @@ -5,7 +5,7 @@ This parameters controls how printer status information is interpreted on your system. It also affects the default values for - the print command, parameter + the print command, lpq command, lppause command , lpresume command, and Date: Fri, 11 Apr 2003 15:57:51 +0000 Subject: Fix current status of conversion (This used to be commit b359a6881f88f6a3e2690bd776da6e5981b5aa23) --- docs/docbook/smbdotconf/README | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'docs/docbook/smbdotconf') diff --git a/docs/docbook/smbdotconf/README b/docs/docbook/smbdotconf/README index e69d30af5f..9a037149ad 100644 --- a/docs/docbook/smbdotconf/README +++ b/docs/docbook/smbdotconf/README @@ -149,8 +149,7 @@ process-all.sh Current state of converted parameters ------------------------------------- -Only 'base' parameters converted so far to serve as example of -formatting. +Only 'misc' parameters don't converted so far. All undocumented parameters are listed in doc-status file in of Samba's docs/ directory. -- cgit