From 084684468dd99d0879843dd0c38db25e28c73937 Mon Sep 17 00:00:00 2001 From: Alexander Bokovoy Date: Tue, 15 Apr 2003 07:47:02 +0000 Subject: Convert another group of options in Misc section (This used to be commit a690ff1f8a068e66ffcbfdaf0be215f887a02b9c) --- docs/docbook/smbdotconf/misc/copy.xml | 31 +++--- docs/docbook/smbdotconf/misc/default.xml | 14 ++- docs/docbook/smbdotconf/misc/dfreecommand.xml | 66 ++++++------ docs/docbook/smbdotconf/misc/exec.xml | 14 ++- docs/docbook/smbdotconf/misc/homedirmap.xml | 50 ++++----- docs/docbook/smbdotconf/misc/include.xml | 28 ++--- docs/docbook/smbdotconf/misc/messagecommand.xml | 118 ++++++++++++---------- docs/docbook/smbdotconf/misc/nishomedir.xml | 55 +++++----- docs/docbook/smbdotconf/misc/preexec.xml | 38 +++---- docs/docbook/smbdotconf/misc/remoteannounce.xml | 53 +++++----- docs/docbook/smbdotconf/misc/remotebrowsesync.xml | 56 +++++----- docs/docbook/smbdotconf/misc/socketaddress.xml | 26 ++--- docs/docbook/smbdotconf/misc/timeoffset.xml | 24 +++-- 13 files changed, 310 insertions(+), 263 deletions(-) (limited to 'docs/docbook/smbdotconf/misc') diff --git a/docs/docbook/smbdotconf/misc/copy.xml b/docs/docbook/smbdotconf/misc/copy.xml index a7945af8ae..c3152956b0 100644 --- a/docs/docbook/smbdotconf/misc/copy.xml +++ b/docs/docbook/smbdotconf/misc/copy.xml @@ -1,15 +1,20 @@ - - copy (S) - This parameter allows you to "clone" service - entries. The specified service is simply duplicated under the - current service's name. Any parameters specified in the current - section will override those in the section being copied. + + + This parameter allows you to "clone" service + entries. The specified service is simply duplicated under the + current service's name. Any parameters specified in the current + section will override those in the section being copied. - This feature lets you set up a 'template' service and - create similar services easily. Note that the service being - copied must occur earlier in the configuration file than the - service doing the copying. + This feature lets you set up a 'template' service and + create similar services easily. Note that the service being + copied must occur earlier in the configuration file than the + service doing the copying. - Default: no value - Example: copy = otherservice - + Default: no value + + Example: copy = otherservice + + diff --git a/docs/docbook/smbdotconf/misc/default.xml b/docs/docbook/smbdotconf/misc/default.xml index c396d1947b..7afaba640b 100644 --- a/docs/docbook/smbdotconf/misc/default.xml +++ b/docs/docbook/smbdotconf/misc/default.xml @@ -1,5 +1,9 @@ - - default (G) - A synonym for - default service. - + + + A synonym for + default service. + + diff --git a/docs/docbook/smbdotconf/misc/dfreecommand.xml b/docs/docbook/smbdotconf/misc/dfreecommand.xml index c71ec8e00b..1e839a5242 100644 --- a/docs/docbook/smbdotconf/misc/dfreecommand.xml +++ b/docs/docbook/smbdotconf/misc/dfreecommand.xml @@ -1,50 +1,52 @@ - - dfree command (G) - The dfree command setting should - only be used on systems where a problem occurs with the internal - disk space calculations. This has been known to happen with Ultrix, - but may occur with other operating systems. The symptom that was - seen was an error of "Abort Retry Ignore" at the end of each - directory listing. + + + + The dfree command setting + should only be used on systems where a problem occurs with the + internal disk space calculations. This has been known to happen + with Ultrix, but may occur with other operating systems. The + symptom that was seen was an error of "Abort Retry + Ignore" at the end of each directory listing. - This setting allows the replacement of the internal routines to - calculate the total disk space and amount available with an external - routine. The example below gives a possible script that might fulfill - this function. + This setting allows the replacement of the internal routines to + calculate the total disk space and amount available with an external + routine. The example below gives a possible script that might fulfill + this function. - The external program will be passed a single parameter indicating - a directory in the filesystem being queried. This will typically consist - of the string ./. The script should return two - integers in ASCII. The first should be the total disk space in blocks, - and the second should be the number of available blocks. An optional - third return value can give the block size in bytes. The default - blocksize is 1024 bytes. + The external program will be passed a single parameter indicating + a directory in the filesystem being queried. This will typically consist + of the string ./. The script should return two + integers in ASCII. The first should be the total disk space in blocks, + and the second should be the number of available blocks. An optional + third return value can give the block size in bytes. The default + blocksize is 1024 bytes. - Note: Your script should NOT be setuid or - setgid and should be owned by (and writeable only by) root! + Note: Your script should NOT be setuid or + setgid and should be owned by (and writeable only by) root! - Default: By default internal routines for - determining the disk capacity and remaining space will be used. - + Default: By default internal routines for + determining the disk capacity and remaining space will be used. + - Example: dfree command = /usr/local/samba/bin/dfree - + Example: dfree command = /usr/local/samba/bin/dfree - Where the script dfree (which must be made executable) could be: + Where the script dfree (which must be made executable) could be: #!/bin/sh df $1 | tail -1 | awk '{print $2" "$4}' - or perhaps (on Sys V based systems): + or perhaps (on Sys V based systems): #!/bin/sh /usr/bin/df -k $1 | tail -1 | awk '{print $3" "$5}' - Note that you may have to replace the command names - with full path names on some systems. - - + Note that you may have to replace the command names with full path names on some systems. + + diff --git a/docs/docbook/smbdotconf/misc/exec.xml b/docs/docbook/smbdotconf/misc/exec.xml index 34963c90b2..0d44d81bff 100644 --- a/docs/docbook/smbdotconf/misc/exec.xml +++ b/docs/docbook/smbdotconf/misc/exec.xml @@ -1,5 +1,9 @@ - - exec (S) - This is a synonym for - preexec. - + + + This is a synonym for + preexec. + + diff --git a/docs/docbook/smbdotconf/misc/homedirmap.xml b/docs/docbook/smbdotconf/misc/homedirmap.xml index 41e6ca5ea1..d4f09c7f50 100644 --- a/docs/docbook/smbdotconf/misc/homedirmap.xml +++ b/docs/docbook/smbdotconf/misc/homedirmap.xml @@ -1,28 +1,32 @@ - - homedir map (G) - Ifnis homedir - is yes, and smbd - 8 is also acting - as a Win95/98 logon server then this parameter - specifies the NIS (or YP) map from which the server for the user's - home directory should be extracted. At present, only the Sun - auto.home map format is understood. The form of the map is: + + + Ifnis homedir + is yes, and smbd + 8 is also acting + as a Win95/98 logon server then this parameter + specifies the NIS (or YP) map from which the server for the user's + home directory should be extracted. At present, only the Sun + auto.home map format is understood. The form of the map is: - username server:/some/file/system + username server:/some/file/system - and the program will extract the servername from before - the first ':'. There should probably be a better parsing system - that copes with different map formats and also Amd (another - automounter) maps. + and the program will extract the servername from before + the first ':'. There should probably be a better parsing system + that copes with different map formats and also Amd (another + automounter) maps. - A working NIS client is required on - the system for this option to work. + A working NIS client is required on + the system for this option to work. - See also nis homedir - , domain logons - . + See also nis homedir + , domain logons + . - Default: homedir map = <empty string> - Example: homedir map = amd.homedir - - + Default: homedir map = <empty string> + + Example: homedir map = amd.homedir + + diff --git a/docs/docbook/smbdotconf/misc/include.xml b/docs/docbook/smbdotconf/misc/include.xml index 81230d4357..dcc32968e7 100644 --- a/docs/docbook/smbdotconf/misc/include.xml +++ b/docs/docbook/smbdotconf/misc/include.xml @@ -1,14 +1,18 @@ - - include (G) - This allows you to include one config file - inside another. The file is included literally, as though typed - in place. + + + This allows you to include one config file + inside another. The file is included literally, as though typed + in place. - It takes the standard substitutions, except %u - , %P and %S. - + It takes the standard substitutions, except %u + , %P and %S. + - Default: no file included - Example: include = /usr/local/samba/lib/admin_smb.conf - - + Default: no file included + + Example: include = /usr/local/samba/lib/admin_smb.conf + + diff --git a/docs/docbook/smbdotconf/misc/messagecommand.xml b/docs/docbook/smbdotconf/misc/messagecommand.xml index 199fab5610..6df2a02bb7 100644 --- a/docs/docbook/smbdotconf/misc/messagecommand.xml +++ b/docs/docbook/smbdotconf/misc/messagecommand.xml @@ -1,65 +1,73 @@ - - message command (G) - This specifies what command to run when the - server receives a WinPopup style message. - - This would normally be a command that would - deliver the message somehow. How this is to be done is - up to your imagination. - - An example is: - - message command = csh -c 'xedit %s;rm %s' & - - - This delivers the message using xedit, then - removes it afterwards. NOTE THAT IT IS VERY IMPORTANT - THAT THIS COMMAND RETURN IMMEDIATELY. That's why I - have the '&' on the end. If it doesn't return immediately then - your PCs may freeze when sending messages (they should recover - after 30 seconds, hopefully). - - All messages are delivered as the global guest user. - The command takes the standard substitutions, although - %u won't work (%U may be better - in this case). - - Apart from the standard substitutions, some additional - ones apply. In particular: - - - %s = the filename containing - the message. + + + This specifies what command to run when the + server receives a WinPopup style message. + + This would normally be a command that would + deliver the message somehow. How this is to be done is + up to your imagination. + + An example is: + + message command = csh -c 'xedit %s;rm %s' & + + + This delivers the message using xedit, then + removes it afterwards. NOTE THAT IT IS VERY IMPORTANT + THAT THIS COMMAND RETURN IMMEDIATELY. That's why I + have the '&' on the end. If it doesn't return immediately then + your PCs may freeze when sending messages (they should recover + after 30 seconds, hopefully). + + All messages are delivered as the global guest user. + The command takes the standard substitutions, although + %u won't work (%U may be better + in this case). + + Apart from the standard substitutions, some additional + ones apply. In particular: + + + + %s = the filename containing + the message. + - %t = the destination that - the message was sent to (probably the server name). + + %t = the destination that + the message was sent to (probably the server name). + - %f = who the message - is from. - + + %f = who the message + is from. + + - You could make this command send mail, or whatever else - takes your fancy. Please let us know of any really interesting - ideas you have. + You could make this command send mail, or whatever else + takes your fancy. Please let us know of any really interesting + ideas you have. + Here's a way of sending the messages as mail to root: - Here's a way of sending the messages as mail to root: + message command = /bin/mail -s 'message from %f on + %m' root < %s; rm %s - message command = /bin/mail -s 'message from %f on - %m' root < %s; rm %s + If you don't have a message command then the message + won't be delivered and Samba will tell the sender there was + an error. Unfortunately WfWg totally ignores the error code + and carries on regardless, saying that the message was delivered. + - If you don't have a message command then the message - won't be delivered and Samba will tell the sender there was - an error. Unfortunately WfWg totally ignores the error code - and carries on regardless, saying that the message was delivered. - + If you want to silently delete it then try: - If you want to silently delete it then try: + message command = rm %s - message command = rm %s + Default: no message command - Default: no message command - Example: message command = csh -c 'xedit %s; - rm %s' & - - + Example: message command = csh -c 'xedit %s; rm %s' & + + diff --git a/docs/docbook/smbdotconf/misc/nishomedir.xml b/docs/docbook/smbdotconf/misc/nishomedir.xml index 5a2980d4fd..734dcf8de5 100644 --- a/docs/docbook/smbdotconf/misc/nishomedir.xml +++ b/docs/docbook/smbdotconf/misc/nishomedir.xml @@ -1,30 +1,33 @@ - - nis homedir (G) - Get the home share server from a NIS map. For - UNIX systems that use an automounter, the user's home directory - will often be mounted on a workstation on demand from a remote - server. + + + Get the home share server from a NIS map. For + UNIX systems that use an automounter, the user's home directory + will often be mounted on a workstation on demand from a remote + server. - When the Samba logon server is not the actual home directory - server, but is mounting the home directories via NFS then two - network hops would be required to access the users home directory - if the logon server told the client to use itself as the SMB server - for home directories (one over SMB and one over NFS). This can - be very slow. + When the Samba logon server is not the actual home directory + server, but is mounting the home directories via NFS then two + network hops would be required to access the users home directory + if the logon server told the client to use itself as the SMB server + for home directories (one over SMB and one over NFS). This can + be very slow. - This option allows Samba to return the home share as - being on a different server to the logon server and as - long as a Samba daemon is running on the home directory server, - it will be mounted on the Samba client directly from the directory - server. When Samba is returning the home share to the client, it - will consult the NIS map specified in - homedir map and return the server - listed there. + This option allows Samba to return the home share as + being on a different server to the logon server and as + long as a Samba daemon is running on the home directory server, + it will be mounted on the Samba client directly from the directory + server. When Samba is returning the home share to the client, it + will consult the NIS map specified in + homedir map and return the server + listed there. - Note that for this option to work there must be a working - NIS system and the Samba server with this option must also - be a logon server. + Note that for this option to work there must be a working + NIS system and the Samba server with this option must also + be a logon server. - Default: nis homedir = no - - + Default: nis homedir = no + + diff --git a/docs/docbook/smbdotconf/misc/preexec.xml b/docs/docbook/smbdotconf/misc/preexec.xml index fc047e008d..18c3345c6c 100644 --- a/docs/docbook/smbdotconf/misc/preexec.xml +++ b/docs/docbook/smbdotconf/misc/preexec.xml @@ -1,23 +1,25 @@ - - preexec (S) - This option specifies a command to be run whenever - the service is connected to. It takes the usual substitutions. + + + This option specifies a command to be run whenever + the service is connected to. It takes the usual substitutions. - An interesting example is to send the users a welcome - message every time they log in. Maybe a message of the day? Here - is an example: + An interesting example is to send the users a welcome + message every time they log in. Maybe a message of the day? Here + is an example: - preexec = csh -c 'echo \"Welcome to %S!\" | - /usr/local/samba/bin/smbclient -M %m -I %I' & + preexec = csh -c 'echo \"Welcome to %S!\" | /usr/local/samba/bin/smbclient -M %m -I %I' & - Of course, this could get annoying after a while :-) + Of course, this could get annoying after a while :-) - See also preexec close - and postexec - . + See also preexec close and postexec + . - Default: none (no command executed) - Example: preexec = echo \"%u connected to %S from %m - (%I)\" >> /tmp/log - - + Default: none (no command executed) + + Example: preexec = echo \"%u connected to %S from %m (%I)\" >> /tmp/log + + diff --git a/docs/docbook/smbdotconf/misc/remoteannounce.xml b/docs/docbook/smbdotconf/misc/remoteannounce.xml index e6de4bdcaf..019cc306a7 100644 --- a/docs/docbook/smbdotconf/misc/remoteannounce.xml +++ b/docs/docbook/smbdotconf/misc/remoteannounce.xml @@ -1,32 +1,35 @@ - - remote announce (G) - This option allows you to setup nmbd(8) to periodically announce itself - to arbitrary IP addresses with an arbitrary workgroup name. + + + This option allows you to setup nmbd + 8to periodically announce itself + to arbitrary IP addresses with an arbitrary workgroup name. - This is useful if you want your Samba server to appear - in a remote workgroup for which the normal browse propagation - rules don't work. The remote workgroup can be anywhere that you - can send IP packets to. + This is useful if you want your Samba server to appear + in a remote workgroup for which the normal browse propagation + rules don't work. The remote workgroup can be anywhere that you + can send IP packets to. - For example: + For example: - remote announce = 192.168.2.255/SERVERS - 192.168.4.255/STAFF + remote announce = 192.168.2.255/SERVERS + 192.168.4.255/STAFF - the above line would cause nmbd to announce itself - to the two given IP addresses using the given workgroup names. - If you leave out the workgroup name then the one given in - the workgroup - parameter is used instead. + the above line would cause nmbd to announce itself + to the two given IP addresses using the given workgroup names. + If you leave out the workgroup name then the one given in + the workgroup + parameter is used instead. - The IP addresses you choose would normally be the broadcast - addresses of the remote networks, but can also be the IP addresses - of known browse masters if your network config is that stable. + The IP addresses you choose would normally be the broadcast + addresses of the remote networks, but can also be the IP addresses + of known browse masters if your network config is that stable. - See the documentation file BROWSING - in the docs/ directory. + See the documentation file BROWSING + in the docs/ directory. - Default: remote announce = <empty string> - - - + Default: remote announce = <empty string> + + diff --git a/docs/docbook/smbdotconf/misc/remotebrowsesync.xml b/docs/docbook/smbdotconf/misc/remotebrowsesync.xml index 8b0d863ed7..06069581e6 100644 --- a/docs/docbook/smbdotconf/misc/remotebrowsesync.xml +++ b/docs/docbook/smbdotconf/misc/remotebrowsesync.xml @@ -1,33 +1,35 @@ - - remote browse sync (G) - This option allows you to setup nmbd(8) to periodically request - synchronization of browse lists with the master browser of a Samba - server that is on a remote segment. This option will allow you to - gain browse lists for multiple workgroups across routed networks. This - is done in a manner that does not work with any non-Samba servers. + + + This option allows you to setup nmbd + 8 to periodically request + synchronization of browse lists with the master browser of a Samba + server that is on a remote segment. This option will allow you to + gain browse lists for multiple workgroups across routed networks. This + is done in a manner that does not work with any non-Samba servers. - This is useful if you want your Samba server and all local - clients to appear in a remote workgroup for which the normal browse - propagation rules don't work. The remote workgroup can be anywhere - that you can send IP packets to. + This is useful if you want your Samba server and all local + clients to appear in a remote workgroup for which the normal browse + propagation rules don't work. The remote workgroup can be anywhere + that you can send IP packets to. - For example: + For example: - remote browse sync = 192.168.2.255 192.168.4.255 - + remote browse sync = 192.168.2.255 192.168.4.255 - the above line would cause nmbd to request - the master browser on the specified subnets or addresses to - synchronize their browse lists with the local server. + the above line would cause nmbd to request + the master browser on the specified subnets or addresses to + synchronize their browse lists with the local server. - The IP addresses you choose would normally be the broadcast - addresses of the remote networks, but can also be the IP addresses - of known browse masters if your network config is that stable. If - a machine IP address is given Samba makes NO attempt to validate - that the remote machine is available, is listening, nor that it - is in fact the browse master on its segment. + The IP addresses you choose would normally be the broadcast + addresses of the remote networks, but can also be the IP addresses + of known browse masters if your network config is that stable. If + a machine IP address is given Samba makes NO attempt to validate + that the remote machine is available, is listening, nor that it + is in fact the browse master on its segment. - Default: remote browse sync = <empty string> - - - + Default: remote browse sync = <empty string> + + diff --git a/docs/docbook/smbdotconf/misc/socketaddress.xml b/docs/docbook/smbdotconf/misc/socketaddress.xml index e77737f18b..4d2299acda 100644 --- a/docs/docbook/smbdotconf/misc/socketaddress.xml +++ b/docs/docbook/smbdotconf/misc/socketaddress.xml @@ -1,14 +1,16 @@ - - socket address (G) - This option allows you to control what - address Samba will listen for connections on. This is used to - support multiple virtual interfaces on the one server, each - with a different configuration. + + + This option allows you to control what + address Samba will listen for connections on. This is used to + support multiple virtual interfaces on the one server, each + with a different configuration. - By default Samba will accept connections on any - address. + By default Samba will accept connections on any + address. - Example: socket address = 192.168.2.20 - - - + Example: socket address = 192.168.2.20 + + diff --git a/docs/docbook/smbdotconf/misc/timeoffset.xml b/docs/docbook/smbdotconf/misc/timeoffset.xml index 0c973234c3..4cd12b6d36 100644 --- a/docs/docbook/smbdotconf/misc/timeoffset.xml +++ b/docs/docbook/smbdotconf/misc/timeoffset.xml @@ -1,11 +1,15 @@ - - time offset (G) - This parameter is a setting in minutes to add - to the normal GMT to local time conversion. This is useful if - you are serving a lot of PCs that have incorrect daylight - saving time handling. + + + This parameter is a setting in minutes to add + to the normal GMT to local time conversion. This is useful if + you are serving a lot of PCs that have incorrect daylight + saving time handling. - Default: time offset = 0 - Example: time offset = 60 - - + Default: time offset = 0 + + Example: time offset = 60 + + -- cgit