From 2b984c620814b1258c8b4e006dde370b19b4461d Mon Sep 17 00:00:00 2001 From: Alexander Bokovoy Date: Thu, 27 Mar 2003 18:28:55 +0000 Subject: 1. Fix generate-file-list.sh to produce a list sorted by parameter name, not parameter section. 2. Convert base parameters to new meta-information scheme (This used to be commit 6026e47cfe493625c6ed017ecae3cc785a6d0347) --- .../docbook/smbdotconf/base/bindinterfacesonly.xml | 123 +++++++++++---------- docs/docbook/smbdotconf/base/comment.xml | 28 +++-- docs/docbook/smbdotconf/base/directory.xml | 14 ++- docs/docbook/smbdotconf/base/displaycharset.xml | 23 ++-- docs/docbook/smbdotconf/base/doscharset.xml | 28 ++--- docs/docbook/smbdotconf/base/interfaces.xml | 76 ++++++------- docs/docbook/smbdotconf/base/netbiosaliases.xml | 33 +++--- docs/docbook/smbdotconf/base/netbiosname.xml | 32 +++--- docs/docbook/smbdotconf/base/netbiosscope.xml | 17 +-- docs/docbook/smbdotconf/base/path.xml | 50 +++++---- docs/docbook/smbdotconf/base/realm.xml | 25 +++-- docs/docbook/smbdotconf/base/serverstring.xml | 36 +++--- docs/docbook/smbdotconf/base/unixcharset.xml | 24 ++-- docs/docbook/smbdotconf/base/workgroup.xml | 25 +++-- docs/docbook/smbdotconf/generate-file-list.sh | 2 +- docs/docbook/smbdotconf/smbconf.dtd | 3 + 16 files changed, 295 insertions(+), 244 deletions(-) diff --git a/docs/docbook/smbdotconf/base/bindinterfacesonly.xml b/docs/docbook/smbdotconf/base/bindinterfacesonly.xml index 78e1b02bf5..3ad9aa4614 100644 --- a/docs/docbook/smbdotconf/base/bindinterfacesonly.xml +++ b/docs/docbook/smbdotconf/base/bindinterfacesonly.xml @@ -1,66 +1,71 @@ - - bind interfaces only (G) - This global parameter allows the Samba admin - to limit what interfaces on a machine will serve SMB requests. It - affects file service smbd - 8 and name service nmbd - 8 in a slightly different ways. + + + This global parameter allows the Samba admin + to limit what interfaces on a machine will serve SMB requests. It + affects file service smbd + 8 and name service nmbd + 8 in a slightly different ways. - For name service it causes nmbd to bind - to ports 137 and 138 on the interfaces listed in the interfaces parameter. nmbd - also binds to the "all addresses" interface (0.0.0.0) - on ports 137 and 138 for the purposes of reading broadcast messages. - If this option is not set then nmbd will service - name requests on all of these sockets. If bind interfaces - only is set then nmbd will check the - source address of any packets coming in on the broadcast sockets - and discard any that don't match the broadcast addresses of the - interfaces in the interfaces parameter list. - As unicast packets are received on the other sockets it allows - nmbd to refuse to serve names to machines that - send packets that arrive through any interfaces not listed in the - interfaces list. IP Source address spoofing - does defeat this simple check, however, so it must not be used - seriously as a security feature for nmbd. + For name service it causes nmbd to bind + to ports 137 and 138 on the interfaces listed in + the interfaces parameter. nmbd also + binds to the "all addresses" interface (0.0.0.0) + on ports 137 and 138 for the purposes of reading broadcast messages. + If this option is not set then nmbd will service + name requests on all of these sockets. If bind interfaces + only is set then nmbd will check the + source address of any packets coming in on the broadcast sockets + and discard any that don't match the broadcast addresses of the + interfaces in the interfaces parameter list. + As unicast packets are received on the other sockets it allows + nmbd to refuse to serve names to machines that + send packets that arrive through any interfaces not listed in the + interfaces list. IP Source address spoofing + does defeat this simple check, however, so it must not be used + seriously as a security feature for nmbd. - For file service it causes smbd - 8 to bind only to the interface list - given in the - interfaces parameter. This restricts the networks that - smbd will serve to packets coming in those - interfaces. Note that you should not use this parameter for machines - that are serving PPP or other intermittent or non-broadcast network - interfaces as it will not cope with non-permanent interfaces. + For file service it causes smbd + 8 to bind only to the interface list + given in the interfaces parameter. This + restricts the networks that smbd will serve + to packets coming in those interfaces. Note that you should not use this parameter + for machines that are serving PPP or other intermittent or non-broadcast network + interfaces as it will not cope with non-permanent interfaces. - If bind interfaces only is set then - unless the network address 127.0.0.1 is added - to the interfaces parameter list smbpasswd - 8 and swat - 8 may not work as expected due to the reasons covered below. + If bind interfaces only is set then + unless the network address 127.0.0.1 is added + to the interfaces parameter + list smbpasswd + 8 and swat + 8 may not work as expected due + to the reasons covered below. - To change a users SMB password, the smbpasswd - by default connects to the localhost - 127.0.0.1 - address as an SMB client to issue the password change request. If - bind interfaces only is set then unless the - network address 127.0.0.1 is added to the - interfaces parameter list then - smbpasswd will fail to connect in it's default mode. - smbpasswd can be forced to use the primary IP interface - of the local host by using its smbpasswd - 8 -r remote machine - parameter, with remote machine set - to the IP name of the primary interface of the local host. + To change a users SMB password, the smbpasswd + by default connects to the localhost - 127.0.0.1 + address as an SMB client to issue the password change request. If + bind interfaces only is set then unless the + network address 127.0.0.1 is added to the + interfaces parameter list then + smbpasswd will fail to connect in it's default mode. + smbpasswd can be forced to use the primary IP interface + of the local host by using its smbpasswd + 8 -r remote machine + parameter, with remote machine set + to the IP name of the primary interface of the local host. - The swat status page tries to connect with - smbd and nmbd at the address - 127.0.0.1 to determine if they are running. - Not adding 127.0.0.1 will cause - smbd and nmbd to always show - "not running" even if they really are. This can prevent - swat from starting/stopping/restarting smbd - and nmbd. + The swat status page tries to connect with + smbd and nmbd at the address + 127.0.0.1 to determine if they are running. + Not adding 127.0.0.1 will cause + smbd and nmbd to always show + "not running" even if they really are. This can prevent + swat from starting/stopping/restarting smbd + and nmbd. - Default: bind interfaces only = no + Default: bind interfaces only = no - - + + diff --git a/docs/docbook/smbdotconf/base/comment.xml b/docs/docbook/smbdotconf/base/comment.xml index 693268a0b0..f08d06ef25 100644 --- a/docs/docbook/smbdotconf/base/comment.xml +++ b/docs/docbook/smbdotconf/base/comment.xml @@ -1,14 +1,18 @@ - - comment (S) - This is a text field that is seen next to a share - when a client does a queries the server, either via the network - neighborhood or via net view to list what shares - are available. + + + This is a text field that is seen next to a share + when a client does a queries the server, either via the network + neighborhood or via net view to list what shares + are available. - If you want to set the string that is displayed next to the - machine name then see the - server string parameter. + If you want to set the string that is displayed next to the + machine name then see the + server string parameter. - Default: No comment string - Example: comment = Fred's Files - + Default: No comment string + Example: comment = Fred's Files + + diff --git a/docs/docbook/smbdotconf/base/directory.xml b/docs/docbook/smbdotconf/base/directory.xml index 1ec4ab7e1a..f912c39c8c 100644 --- a/docs/docbook/smbdotconf/base/directory.xml +++ b/docs/docbook/smbdotconf/base/directory.xml @@ -1,5 +1,9 @@ - - directory (S) - Synonym for path - . - + + + + Synonym for path. + + diff --git a/docs/docbook/smbdotconf/base/displaycharset.xml b/docs/docbook/smbdotconf/base/displaycharset.xml index add519e783..e02842ab48 100644 --- a/docs/docbook/smbdotconf/base/displaycharset.xml +++ b/docs/docbook/smbdotconf/base/displaycharset.xml @@ -1,13 +1,16 @@ - - display charset (G) - Specifies the charset that samba will use - to print messages to stdout and stderr and SWAT will use. - Should generally be the same as the unix charset. - + + + Specifies the charset that samba will use + to print messages to stdout and stderr and SWAT will use. + Should generally be the same as the unix charset. + - Default: display charset = ASCII + Default: display charset = ASCII - Example: display charset = UTF8 + Example: display charset = UTF8 - - + + diff --git a/docs/docbook/smbdotconf/base/doscharset.xml b/docs/docbook/smbdotconf/base/doscharset.xml index db767e720c..5fc718dcaa 100644 --- a/docs/docbook/smbdotconf/base/doscharset.xml +++ b/docs/docbook/smbdotconf/base/doscharset.xml @@ -1,14 +1,16 @@ - - dos charset (G) - DOS SMB clients assume the server has - the same charset as they do. This option specifies which - charset Samba should talk to DOS clients. - + + + DOS SMB clients assume the server has + the same charset as they do. This option specifies which + charset Samba should talk to DOS clients. + - The default depends on which charsets you have installed. - Samba tries to use charset 850 but falls back to ASCII in - case it is not available. Run testparm - 1 to check the default on your system. - - - + The default depends on which charsets you have installed. + Samba tries to use charset 850 but falls back to ASCII in + case it is not available. Run testparm + 1 to check the default on your system. + + diff --git a/docs/docbook/smbdotconf/base/interfaces.xml b/docs/docbook/smbdotconf/base/interfaces.xml index 1125ad0559..3fa346e206 100644 --- a/docs/docbook/smbdotconf/base/interfaces.xml +++ b/docs/docbook/smbdotconf/base/interfaces.xml @@ -1,49 +1,51 @@ - - interfaces (G) - This option allows you to override the default - network interfaces list that Samba will use for browsing, name - registration and other NBT traffic. By default Samba will query - the kernel for the list of all active interfaces and use any - interfaces except 127.0.0.1 that are broadcast capable. + + + This option allows you to override the default + network interfaces list that Samba will use for browsing, name + registration and other NBT traffic. By default Samba will query + the kernel for the list of all active interfaces and use any + interfaces except 127.0.0.1 that are broadcast capable. - The option takes a list of interface strings. Each string - can be in any of the following forms: + The option takes a list of interface strings. Each string + can be in any of the following forms: - - a network interface name (such as eth0). - This may include shell-like wildcards so eth* will match - any interface starting with the substring "eth" + + a network interface name (such as eth0). + This may include shell-like wildcards so eth* will match + any interface starting with the substring "eth" - an IP address. In this case the netmask is - determined from the list of interfaces obtained from the - kernel + an IP address. In this case the netmask is + determined from the list of interfaces obtained from the + kernel - an IP/mask pair. + an IP/mask pair. - a broadcast/mask pair. - + a broadcast/mask pair. + - The "mask" parameters can either be a bit length (such - as 24 for a C class network) or a full netmask in dotted - decimal form. + The "mask" parameters can either be a bit length (such + as 24 for a C class network) or a full netmask in dotted + decimal form. - The "IP" parameters above can either be a full dotted - decimal IP address or a hostname which will be looked up via - the OS's normal hostname resolution mechanisms. + The "IP" parameters above can either be a full dotted + decimal IP address or a hostname which will be looked up via + the OS's normal hostname resolution mechanisms. - For example, the following line: + For example, the following line: - interfaces = eth0 192.168.2.10/24 192.168.3.10/255.255.255.0 - + interfaces = eth0 192.168.2.10/24 192.168.3.10/255.255.255.0 - would configure three network interfaces corresponding - to the eth0 device and IP addresses 192.168.2.10 and 192.168.3.10. - The netmasks of the latter two interfaces would be set to 255.255.255.0. + would configure three network interfaces corresponding + to the eth0 device and IP addresses 192.168.2.10 and 192.168.3.10. + The netmasks of the latter two interfaces would be set to 255.255.255.0. - See also bind - interfaces only. + See also bind + interfaces only. - Default: all active interfaces except 127.0.0.1 - that are broadcast capable - - + Default: all active interfaces except 127.0.0.1 + that are broadcast capable + + diff --git a/docs/docbook/smbdotconf/base/netbiosaliases.xml b/docs/docbook/smbdotconf/base/netbiosaliases.xml index b0a7688a83..a62fb8f7d6 100644 --- a/docs/docbook/smbdotconf/base/netbiosaliases.xml +++ b/docs/docbook/smbdotconf/base/netbiosaliases.xml @@ -1,17 +1,20 @@ - - netbios aliases (G) - This is a list of NetBIOS names that nmbd(8) will advertise as additional - names by which the Samba server is known. This allows one machine - to appear in browse lists under multiple names. If a machine is - acting as a browse server or logon server none - of these names will be advertised as either browse server or logon - servers, only the primary name of the machine will be advertised - with these capabilities. + + + This is a list of NetBIOS names that nmbd(8) will + advertise as additional names by which the Samba server is known. This allows one machine + to appear in browse lists under multiple names. If a machine is acting as a browse server + or logon server none of these names will be advertised as either browse server or logon + servers, only the primary name of the machine will be advertised with these capabilities. + - See also netbios - name. + See also netbios + name. - Default: empty string (no additional names) - Example: netbios aliases = TEST TEST1 TEST2 - - + Default: empty string (no additional names) + + Example: netbios aliases = TEST TEST1 TEST2 + + diff --git a/docs/docbook/smbdotconf/base/netbiosname.xml b/docs/docbook/smbdotconf/base/netbiosname.xml index 2daf26e2b3..287a8f9f9f 100644 --- a/docs/docbook/smbdotconf/base/netbiosname.xml +++ b/docs/docbook/smbdotconf/base/netbiosname.xml @@ -1,16 +1,20 @@ - - netbios name (G) - This sets the NetBIOS name by which a Samba - server is known. By default it is the same as the first component - of the host's DNS name. If a machine is a browse server or - logon server this name (or the first component - of the hosts DNS name) will be the name that these services are - advertised under. + + + This sets the NetBIOS name by which a Samba + server is known. By default it is the same as the first component + of the host's DNS name. If a machine is a browse server or + logon server this name (or the first component + of the hosts DNS name) will be the name that these services are + advertised under. - See also netbios - aliases. + See also netbios + aliases. - Default: machine DNS name - Example: netbios name = MYNAME - - + Default: machine DNS name + + Example: netbios name = MYNAME + + diff --git a/docs/docbook/smbdotconf/base/netbiosscope.xml b/docs/docbook/smbdotconf/base/netbiosscope.xml index fd0e4ad40c..8c5866bc32 100644 --- a/docs/docbook/smbdotconf/base/netbiosscope.xml +++ b/docs/docbook/smbdotconf/base/netbiosscope.xml @@ -1,7 +1,10 @@ - - netbios scope (G) - This sets the NetBIOS scope that Samba will - operate under. This should not be set unless every machine - on your LAN also sets this value. - - + + + This sets the NetBIOS scope that Samba will + operate under. This should not be set unless every machine + on your LAN also sets this value. + + diff --git a/docs/docbook/smbdotconf/base/path.xml b/docs/docbook/smbdotconf/base/path.xml index 7d65e10b2b..9f0a7cd976 100644 --- a/docs/docbook/smbdotconf/base/path.xml +++ b/docs/docbook/smbdotconf/base/path.xml @@ -1,27 +1,31 @@ - - path (S) - This parameter specifies a directory to which - the user of the service is to be given access. In the case of - printable services, this is where print data will spool prior to - being submitted to the host for printing. + + + This parameter specifies a directory to which + the user of the service is to be given access. In the case of + printable services, this is where print data will spool prior to + being submitted to the host for printing. - For a printable service offering guest access, the service - should be readonly and the path should be world-writeable and - have the sticky bit set. This is not mandatory of course, but - you probably won't get the results you expect if you do - otherwise. + For a printable service offering guest access, the service + should be readonly and the path should be world-writeable and + have the sticky bit set. This is not mandatory of course, but + you probably won't get the results you expect if you do + otherwise. - Any occurrences of %u in the path - will be replaced with the UNIX username that the client is using - on this connection. Any occurrences of %m - will be replaced by the NetBIOS name of the machine they are - connecting from. These replacements are very useful for setting - up pseudo home directories for users. + Any occurrences of %u in the path + will be replaced with the UNIX username that the client is using + on this connection. Any occurrences of %m + will be replaced by the NetBIOS name of the machine they are + connecting from. These replacements are very useful for setting + up pseudo home directories for users. - Note that this path will be based on - root dir if one was specified. + Note that this path will be based on + root dir if one was specified. - Default: none - Example: path = /home/fred - - + Default: none + + Example: path = /home/fred + + diff --git a/docs/docbook/smbdotconf/base/realm.xml b/docs/docbook/smbdotconf/base/realm.xml index 50c7d26eea..c0b1d1aad6 100644 --- a/docs/docbook/smbdotconf/base/realm.xml +++ b/docs/docbook/smbdotconf/base/realm.xml @@ -1,12 +1,15 @@ - - realm (G) - - This option specifies the kerberos realm to use. The realm is - used as the ADS equivalent of the NT4domain. It - is usually set to the DNS name of the kerberos server. - + + + This option specifies the kerberos realm to use. The realm is + used as the ADS equivalent of the NT4 domain. It + is usually set to the DNS name of the kerberos server. + - Default: realm = - Example: realm = mysambabox.mycompany.com - - + Default: realm = + + Example: realm = mysambabox.mycompany.com + + diff --git a/docs/docbook/smbdotconf/base/serverstring.xml b/docs/docbook/smbdotconf/base/serverstring.xml index a47ac4cf42..5935dd80dd 100644 --- a/docs/docbook/smbdotconf/base/serverstring.xml +++ b/docs/docbook/smbdotconf/base/serverstring.xml @@ -1,22 +1,24 @@ - - server string (G) - This controls what string will show up in the - printer comment box in print manager and next to the IPC connection - in net view. It can be any string that you wish - to show to your users. + + + This controls what string will show up in the printer comment box in print + manager and next to the IPC connection in net view. It + can be any string that you wish to show to your users. - It also sets what will appear in browse lists next - to the machine name. + It also sets what will appear in browse lists next + to the machine name. - A %v will be replaced with the Samba - version number. + A %v will be replaced with the Samba + version number. - A %h will be replaced with the - hostname. + A %h will be replaced with the + hostname. - Default: server string = Samba %v + Default: server string = Samba %v - Example: server string = University of GNUs Samba - Server - - + Example: server string = University of GNUs Samba + Server + + diff --git a/docs/docbook/smbdotconf/base/unixcharset.xml b/docs/docbook/smbdotconf/base/unixcharset.xml index 0ea84e38c8..f003c097aa 100644 --- a/docs/docbook/smbdotconf/base/unixcharset.xml +++ b/docs/docbook/smbdotconf/base/unixcharset.xml @@ -1,11 +1,15 @@ - - unix charset (G) - Specifies the charset the unix machine - Samba runs on uses. Samba needs to know this in order to be able to - convert text to the charsets other SMB clients use. - + + + Specifies the charset the unix machine + Samba runs on uses. Samba needs to know this in order to be able to + convert text to the charsets other SMB clients use. + - Default: unix charset = UTF8 - Example: unix charset = ASCII - - + Default: unix charset = UTF8 + + Example: unix charset = ASCII + + diff --git a/docs/docbook/smbdotconf/base/workgroup.xml b/docs/docbook/smbdotconf/base/workgroup.xml index 71ea89d202..65300bca58 100644 --- a/docs/docbook/smbdotconf/base/workgroup.xml +++ b/docs/docbook/smbdotconf/base/workgroup.xml @@ -1,11 +1,16 @@ - - workgroup (G) - This controls what workgroup your server will - appear to be in when queried by clients. Note that this parameter - also controls the Domain name used with the security = domain - setting. + + + This controls what workgroup your server will + appear to be in when queried by clients. Note that this parameter + also controls the Domain name used with + the security = domain + setting. - Default: set at compile time to WORKGROUP - Example: workgroup = MYGROUP - - + Default: set at compile time to WORKGROUP + + Example: workgroup = MYGROUP + + diff --git a/docs/docbook/smbdotconf/generate-file-list.sh b/docs/docbook/smbdotconf/generate-file-list.sh index f61ac4f49c..3495f50c43 100755 --- a/docs/docbook/smbdotconf/generate-file-list.sh +++ b/docs/docbook/smbdotconf/generate-file-list.sh @@ -1,6 +1,6 @@ #!/bin/sh echo "" -find . -type f -name '*.xml' -mindepth 2 | sort | +find . -type f -name '*.xml' -mindepth 2 | sort -t/ -k3 | while read ; do echo "" done diff --git a/docs/docbook/smbdotconf/smbconf.dtd b/docs/docbook/smbdotconf/smbconf.dtd index 00340a7db9..591c9b2738 100644 --- a/docs/docbook/smbdotconf/smbconf.dtd +++ b/docs/docbook/smbdotconf/smbconf.dtd @@ -4,4 +4,7 @@ + + + -- cgit