diff options
| -rw-r--r-- | docs/docbook/smbdotconf/base/bindinterfacesonly.xml | 123 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/base/comment.xml | 28 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/base/directory.xml | 14 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/base/displaycharset.xml | 23 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/base/doscharset.xml | 28 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/base/interfaces.xml | 76 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/base/netbiosaliases.xml | 33 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/base/netbiosname.xml | 32 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/base/netbiosscope.xml | 17 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/base/path.xml | 50 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/base/realm.xml | 25 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/base/serverstring.xml | 36 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/base/unixcharset.xml | 24 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/base/workgroup.xml | 25 | ||||
| -rwxr-xr-x | docs/docbook/smbdotconf/generate-file-list.sh | 2 | ||||
| -rw-r--r-- | 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 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="BINDINTERFACESONLY"/>bind interfaces only (G)</term> - <listitem><para>This global parameter allows the Samba admin - to limit what interfaces on a machine will serve SMB requests. It - affects file service <citerefentry><refentrytitle>smbd</refentrytitle> - <manvolnum>8</manvolnum></citerefentry> and name service <citerefentry><refentrytitle>nmbd</refentrytitle> - <manvolnum>8</manvolnum></citerefentry> in a slightly different ways.</para> +<samba:parameter name="bind interfaces only" + context="G" + advanced="1" wizard="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This global parameter allows the Samba admin + to limit what interfaces on a machine will serve SMB requests. It + affects file service <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> and name service <citerefentry><refentrytitle>nmbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> in a slightly different ways.</para> - <para>For name service it causes <command moreinfo="none">nmbd</command> to bind - to ports 137 and 138 on the interfaces listed in the <link linkend="INTERFACES">interfaces</link> parameter. <command moreinfo="none">nmbd - </command> 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 <command moreinfo="none">nmbd</command> will service - name requests on all of these sockets. If <parameter moreinfo="none">bind interfaces - only</parameter> is set then <command moreinfo="none">nmbd</command> 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 <parameter moreinfo="none">interfaces</parameter> parameter list. - As unicast packets are received on the other sockets it allows - <command moreinfo="none">nmbd</command> to refuse to serve names to machines that - send packets that arrive through any interfaces not listed in the - <parameter moreinfo="none">interfaces</parameter> list. IP Source address spoofing - does defeat this simple check, however, so it must not be used - seriously as a security feature for <command moreinfo="none">nmbd</command>.</para> + <para>For name service it causes <command moreinfo="none">nmbd</command> to bind + to ports 137 and 138 on the interfaces listed in + the <link linkend="INTERFACES">interfaces</link> parameter. <command moreinfo="none">nmbd</command> 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 <command moreinfo="none">nmbd</command> will service + name requests on all of these sockets. If <parameter moreinfo="none">bind interfaces + only</parameter> is set then <command moreinfo="none">nmbd</command> 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 <parameter moreinfo="none">interfaces</parameter> parameter list. + As unicast packets are received on the other sockets it allows + <command moreinfo="none">nmbd</command> to refuse to serve names to machines that + send packets that arrive through any interfaces not listed in the + <parameter moreinfo="none">interfaces</parameter> list. IP Source address spoofing + does defeat this simple check, however, so it must not be used + seriously as a security feature for <command moreinfo="none">nmbd</command>.</para> - <para>For file service it causes <citerefentry><refentrytitle>smbd</refentrytitle> - <manvolnum>8</manvolnum></citerefentry> to bind only to the interface list - given in the <link linkend="INTERFACES"> - interfaces</link> parameter. This restricts the networks that - <command moreinfo="none">smbd</command> 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.</para> + <para>For file service it causes <citerefentry><refentrytitle>smbd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> to bind only to the interface list + given in the <link linkend="INTERFACES">interfaces</link> parameter. This + restricts the networks that <command moreinfo="none">smbd</command> 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.</para> - <para>If <parameter moreinfo="none">bind interfaces only</parameter> is set then - unless the network address <emphasis>127.0.0.1</emphasis> is added - to the <parameter moreinfo="none">interfaces</parameter> parameter list <citerefentry><refentrytitle>smbpasswd</refentrytitle> - <manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>swat</refentrytitle> - <manvolnum>8</manvolnum></citerefentry> may not work as expected due to the reasons covered below.</para> + <para>If <parameter moreinfo="none">bind interfaces only</parameter> is set then + unless the network address <emphasis>127.0.0.1</emphasis> is added + to the <parameter moreinfo="none">interfaces</parameter> parameter + list <citerefentry><refentrytitle>smbpasswd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>swat</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> may not work as expected due + to the reasons covered below.</para> - <para>To change a users SMB password, the <command moreinfo="none">smbpasswd</command> - by default connects to the <emphasis>localhost - 127.0.0.1</emphasis> - address as an SMB client to issue the password change request. If - <parameter moreinfo="none">bind interfaces only</parameter> is set then unless the - network address <emphasis>127.0.0.1</emphasis> is added to the - <parameter moreinfo="none">interfaces</parameter> parameter list then <command moreinfo="none"> - smbpasswd</command> will fail to connect in it's default mode. - <command moreinfo="none">smbpasswd</command> can be forced to use the primary IP interface - of the local host by using its <citerefentry><refentrytitle>smbpasswd</refentrytitle> - <manvolnum>8</manvolnum></citerefentry> <parameter moreinfo="none">-r <replaceable>remote machine</replaceable></parameter> - parameter, with <replaceable>remote machine</replaceable> set - to the IP name of the primary interface of the local host.</para> + <para>To change a users SMB password, the <command moreinfo="none">smbpasswd</command> + by default connects to the <emphasis>localhost - 127.0.0.1</emphasis> + address as an SMB client to issue the password change request. If + <parameter moreinfo="none">bind interfaces only</parameter> is set then unless the + network address <emphasis>127.0.0.1</emphasis> is added to the + <parameter moreinfo="none">interfaces</parameter> parameter list then <command moreinfo="none"> + smbpasswd</command> will fail to connect in it's default mode. + <command moreinfo="none">smbpasswd</command> can be forced to use the primary IP interface + of the local host by using its <citerefentry><refentrytitle>smbpasswd</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> <parameter moreinfo="none">-r <replaceable>remote machine</replaceable></parameter> + parameter, with <replaceable>remote machine</replaceable> set + to the IP name of the primary interface of the local host.</para> - <para>The <command moreinfo="none">swat</command> status page tries to connect with - <command moreinfo="none">smbd</command> and <command moreinfo="none">nmbd</command> at the address - <emphasis>127.0.0.1</emphasis> to determine if they are running. - Not adding <emphasis>127.0.0.1</emphasis> will cause <command moreinfo="none"> - smbd</command> and <command moreinfo="none">nmbd</command> to always show - "not running" even if they really are. This can prevent <command moreinfo="none"> - swat</command> from starting/stopping/restarting <command moreinfo="none">smbd</command> - and <command moreinfo="none">nmbd</command>.</para> + <para>The <command moreinfo="none">swat</command> status page tries to connect with + <command moreinfo="none">smbd</command> and <command moreinfo="none">nmbd</command> at the address + <emphasis>127.0.0.1</emphasis> to determine if they are running. + Not adding <emphasis>127.0.0.1</emphasis> will cause <command moreinfo="none"> + smbd</command> and <command moreinfo="none">nmbd</command> to always show + "not running" even if they really are. This can prevent <command moreinfo="none"> + swat</command> from starting/stopping/restarting <command moreinfo="none">smbd</command> + and <command moreinfo="none">nmbd</command>.</para> - <para>Default: <command moreinfo="none">bind interfaces only = no</command></para> + <para>Default: <command moreinfo="none">bind interfaces only = no</command></para> - </listitem> - </samba:parameter> +</listitem> +</samba:parameter> 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 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="COMMENT"/>comment (S)</term> - <listitem><para>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 <command moreinfo="none">net view</command> to list what shares - are available.</para> +<samba:parameter name="comment" + context="S" + basic="1" advanced="1" share="1" print="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>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 <command moreinfo="none">net view</command> to list what shares + are available.</para> - <para>If you want to set the string that is displayed next to the - machine name then see the <link linkend="SERVERSTRING"><parameter moreinfo="none"> - server string</parameter></link> parameter.</para> + <para>If you want to set the string that is displayed next to the + machine name then see the <link linkend="SERVERSTRING"><parameter moreinfo="none"> + server string</parameter></link> parameter.</para> - <para>Default: <emphasis>No comment string</emphasis></para> - <para>Example: <command moreinfo="none">comment = Fred's Files</command></para></listitem> - </samba:parameter> + <para>Default: <emphasis>No comment string</emphasis></para> + <para>Example: <command moreinfo="none">comment = Fred's Files</command></para> +</listitem> +</samba:parameter> 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 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="DIRECTORY"/>directory (S)</term> - <listitem><para>Synonym for <link linkend="PATH"><parameter moreinfo="none">path - </parameter></link>.</para></listitem> - </samba:parameter> +<samba:parameter name="directory" + context="S" + hide="1" + xmlns:samba="http://samba.org/common"> + +<listitem> + <para>Synonym for <link linkend="PATH"><parameter moreinfo="none">path</parameter></link>.</para> +</listitem> +</samba:parameter> 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 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="DISPLAYCHARSET"/>display charset (G)</term> - <listitem><para>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 <command moreinfo="none">unix charset</command>. - </para> +<samba:parameter name="display charset" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>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 <command moreinfo="none">unix charset</command>. + </para> - <para>Default: <command moreinfo="none">display charset = ASCII</command></para> + <para>Default: <command moreinfo="none">display charset = ASCII</command></para> - <para>Example: <command moreinfo="none">display charset = UTF8</command></para> + <para>Example: <command moreinfo="none">display charset = UTF8</command></para> - </listitem> - </samba:parameter> +</listitem> +</samba:parameter> 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 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="DOSCHARSET"/>dos charset (G)</term> - <listitem><para>DOS SMB clients assume the server has - the same charset as they do. This option specifies which - charset Samba should talk to DOS clients. - </para> +<samba:parameter name="dos charset" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>DOS SMB clients assume the server has + the same charset as they do. This option specifies which + charset Samba should talk to DOS clients. + </para> - <para>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 <citerefentry><refentrytitle>testparm</refentrytitle> - <manvolnum>1</manvolnum></citerefentry> to check the default on your system. - </para> - </listitem> - </samba:parameter> + <para>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 <citerefentry><refentrytitle>testparm</refentrytitle> + <manvolnum>1</manvolnum></citerefentry> to check the default on your system.</para> +</listitem> +</samba:parameter> 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 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="INTERFACES"/>interfaces (G)</term> - <listitem><para>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.</para> +<samba:parameter name="interfaces" + context="G" + basic="1" advanced="1" wizard="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>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.</para> - <para>The option takes a list of interface strings. Each string - can be in any of the following forms:</para> + <para>The option takes a list of interface strings. Each string + can be in any of the following forms:</para> - <itemizedlist> - <listitem><para>a network interface name (such as eth0). - This may include shell-like wildcards so eth* will match - any interface starting with the substring "eth"</para></listitem> + <itemizedlist> + <listitem><para>a network interface name (such as eth0). + This may include shell-like wildcards so eth* will match + any interface starting with the substring "eth"</para></listitem> - <listitem><para>an IP address. In this case the netmask is - determined from the list of interfaces obtained from the - kernel</para></listitem> + <listitem><para>an IP address. In this case the netmask is + determined from the list of interfaces obtained from the + kernel</para></listitem> - <listitem><para>an IP/mask pair. </para></listitem> + <listitem><para>an IP/mask pair. </para></listitem> - <listitem><para>a broadcast/mask pair.</para></listitem> - </itemizedlist> + <listitem><para>a broadcast/mask pair.</para></listitem> + </itemizedlist> - <para>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.</para> + <para>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.</para> - <para>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.</para> + <para>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.</para> - <para>For example, the following line:</para> + <para>For example, the following line:</para> - <para><command moreinfo="none">interfaces = eth0 192.168.2.10/24 192.168.3.10/255.255.255.0 - </command></para> + <para><command moreinfo="none">interfaces = eth0 192.168.2.10/24 192.168.3.10/255.255.255.0</command></para> - <para>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.</para> + <para>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.</para> - <para>See also <link linkend="BINDINTERFACESONLY"><parameter moreinfo="none">bind - interfaces only</parameter></link>.</para> + <para>See also <link linkend="BINDINTERFACESONLY"><parameter moreinfo="none">bind + interfaces only</parameter></link>.</para> - <para>Default: <emphasis>all active interfaces except 127.0.0.1 - that are broadcast capable</emphasis></para> - </listitem> - </samba:parameter> + <para>Default: <emphasis>all active interfaces except 127.0.0.1 + that are broadcast capable</emphasis></para> +</listitem> +</samba:parameter> 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 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="NETBIOSALIASES"/>netbios aliases (G)</term> - <listitem><para>This is a list of NetBIOS names that <ulink url="nmbd.8.html">nmbd(8)</ulink> 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.</para> +<samba:parameter name="netbios aliases" + context="G" + advanced="1" wizard="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This is a list of NetBIOS names that <ulink url="nmbd.8.html">nmbd(8)</ulink> 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. + </para> - <para>See also <link linkend="NETBIOSNAME"><parameter moreinfo="none">netbios - name</parameter></link>.</para> + <para>See also <link linkend="NETBIOSNAME"><parameter moreinfo="none">netbios + name</parameter></link>.</para> - <para>Default: <emphasis>empty string (no additional names)</emphasis></para> - <para>Example: <command moreinfo="none">netbios aliases = TEST TEST1 TEST2</command></para> - </listitem> - </samba:parameter> + <para>Default: <emphasis>empty string (no additional names)</emphasis></para> + + <para>Example: <command moreinfo="none">netbios aliases = TEST TEST1 TEST2</command></para> +</listitem> +</samba:parameter> 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 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="NETBIOSNAME"/>netbios name (G)</term> - <listitem><para>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.</para> +<samba:parameter name="netbios name" + context="G" + basic="1" advanced="1" wizard="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>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.</para> - <para>See also <link linkend="NETBIOSALIASES"><parameter moreinfo="none">netbios - aliases</parameter></link>.</para> + <para>See also <link linkend="NETBIOSALIASES"><parameter moreinfo="none">netbios + aliases</parameter></link>.</para> - <para>Default: <emphasis>machine DNS name</emphasis></para> - <para>Example: <command moreinfo="none">netbios name = MYNAME</command></para> - </listitem> - </samba:parameter> + <para>Default: <emphasis>machine DNS name</emphasis></para> + + <para>Example: <command moreinfo="none">netbios name = MYNAME</command></para> +</listitem> +</samba:parameter> 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 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="NETBIOSSCOPE"/>netbios scope (G)</term> - <listitem><para>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.</para> - </listitem> - </samba:parameter> +<samba:parameter name="netbios scope" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>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.</para> +</listitem> +</samba:parameter> 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 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="PATH"/>path (S)</term> - <listitem><para>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.</para> +<samba:parameter name="path" + context="S" + basic="1" advanced="1" share="1" print="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>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.</para> - <para>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.</para> + <para>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.</para> - <para>Any occurrences of <parameter moreinfo="none">%u</parameter> in the path - will be replaced with the UNIX username that the client is using - on this connection. Any occurrences of <parameter moreinfo="none">%m</parameter> - 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.</para> + <para>Any occurrences of <parameter moreinfo="none">%u</parameter> in the path + will be replaced with the UNIX username that the client is using + on this connection. Any occurrences of <parameter moreinfo="none">%m</parameter> + 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.</para> - <para>Note that this path will be based on <link linkend="ROOTDIR"> - <parameter moreinfo="none">root dir</parameter></link> if one was specified.</para> + <para>Note that this path will be based on <link linkend="ROOTDIR"> + <parameter moreinfo="none">root dir</parameter></link> if one was specified.</para> - <para>Default: <emphasis>none</emphasis></para> - <para>Example: <command moreinfo="none">path = /home/fred</command></para> - </listitem> - </samba:parameter> + <para>Default: <emphasis>none</emphasis></para> + + <para>Example: <command moreinfo="none">path = /home/fred</command></para> +</listitem> +</samba:parameter> 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 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="REALM"/>realm (G)</term> - <listitem><para> - This option specifies the kerberos realm to use. The realm is - used as the ADS equivalent of the NT4<command moreinfo="none">domain</command>. It - is usually set to the DNS name of the kerberos server. - </para> +<samba:parameter name="realm" + context="G" + basic="1" advanced="1" wizard="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This option specifies the kerberos realm to use. The realm is + used as the ADS equivalent of the NT4 <command moreinfo="none">domain</command>. It + is usually set to the DNS name of the kerberos server. + </para> - <para>Default: <command moreinfo="none">realm = </command></para> - <para>Example: <command moreinfo="none">realm = mysambabox.mycompany.com</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">realm = </command></para> + + <para>Example: <command moreinfo="none">realm = mysambabox.mycompany.com</command></para> +</listitem> +</samba:parameter> 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 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="SERVERSTRING"/>server string (G)</term> - <listitem><para>This controls what string will show up in the - printer comment box in print manager and next to the IPC connection - in <command moreinfo="none">net view</command>. It can be any string that you wish - to show to your users.</para> +<samba:parameter name="server string" + context="G" + basic="1" advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>This controls what string will show up in the printer comment box in print + manager and next to the IPC connection in <command moreinfo="none">net view</command>. It + can be any string that you wish to show to your users.</para> - <para>It also sets what will appear in browse lists next - to the machine name.</para> + <para>It also sets what will appear in browse lists next + to the machine name.</para> - <para>A <parameter moreinfo="none">%v</parameter> will be replaced with the Samba - version number.</para> + <para>A <parameter moreinfo="none">%v</parameter> will be replaced with the Samba + version number.</para> - <para>A <parameter moreinfo="none">%h</parameter> will be replaced with the - hostname.</para> + <para>A <parameter moreinfo="none">%h</parameter> will be replaced with the + hostname.</para> - <para>Default: <command moreinfo="none">server string = Samba %v</command></para> + <para>Default: <command moreinfo="none">server string = Samba %v</command></para> - <para>Example: <command moreinfo="none">server string = University of GNUs Samba - Server</command></para> - </listitem> - </samba:parameter> + <para>Example: <command moreinfo="none">server string = University of GNUs Samba + Server</command></para> +</listitem> +</samba:parameter> 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 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="UNIXCHARSET"/>unix charset (G)</term> - <listitem><para>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. - </para> +<samba:parameter name="unix charset" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>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. + </para> - <para>Default: <command moreinfo="none">unix charset = UTF8</command></para> - <para>Example: <command moreinfo="none">unix charset = ASCII</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">unix charset = UTF8</command></para> + + <para>Example: <command moreinfo="none">unix charset = ASCII</command></para> +</listitem> +</samba:parameter> 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 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="WORKGROUP"/>workgroup (G)</term> - <listitem><para>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 <link linkend="SECURITYEQUALSDOMAIN"><command moreinfo="none">security = domain</command></link> - setting.</para> +<samba:parameter name="workgroup" + context="G" + basic="1" advanced="1" wizard="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>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 <link linkend="SECURITYEQUALSDOMAIN"><command moreinfo="none">security = domain</command></link> + setting.</para> - <para>Default: <emphasis>set at compile time to WORKGROUP</emphasis></para> - <para>Example: <command moreinfo="none">workgroup = MYGROUP</command></para> - </listitem> - </samba:parameter> + <para>Default: <emphasis>set at compile time to WORKGROUP</emphasis></para> + + <para>Example: <command moreinfo="none">workgroup = MYGROUP</command></para> +</listitem> +</samba:parameter> 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 "<variablelist>" -find . -type f -name '*.xml' -mindepth 2 | sort | +find . -type f -name '*.xml' -mindepth 2 | sort -t/ -k3 | while read ; do echo "<xi:include href='$REPLY' parse='xml' xmlns:xi='http://www.w3.org/2001/XInclude'/>" 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 @@ <!ATTLIST parameter basic CDATA #REQUIRED > <!ATTLIST parameter wizard CDATA #REQUIRED > <!ATTLIST parameter advanced CDATA #REQUIRED > +<!ATTLIST parameter share CDATA #REQUIRED > +<!ATTLIST parameter print CDATA #REQUIRED > <!ATTLIST parameter developer CDATA #REQUIRED > +<!ATTLIST parameter hide CDATA #REQUIRED > |