diff options
| author | Jelmer Vernooij <jelmer@samba.org> | 2005-07-04 21:36:46 +0000 |
|---|---|---|
| committer | Gerald W. Carter <jerry@samba.org> | 2008-04-23 08:47:00 -0500 |
| commit | 55d8ee039a920508fb51bcc85397e26acc365f60 (patch) | |
| tree | 77c323ae9e51c71202c8c4af948fc5e2082c778f /docs | |
| parent | b5f9c625fe26329edf19537939609c3e039e98e6 (diff) | |
| download | samba-55d8ee039a920508fb51bcc85397e26acc365f60.tar.gz samba-55d8ee039a920508fb51bcc85397e26acc365f60.tar.bz2 samba-55d8ee039a920508fb51bcc85397e26acc365f60.zip | |
Some random updates.
(This used to be commit 57d0cc9fcdc1c790a601f6dcf7071188448a5f58)
Diffstat (limited to 'docs')
40 files changed, 103 insertions, 111 deletions
diff --git a/docs/Makefile b/docs/Makefile index 8704ead718..2d3b3e8cc6 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -151,16 +151,16 @@ $(PDFDIR)/%.pdf: %.pdf @echo >> $@ @echo "\$$(HTMLDIR)/%: $*/%" >> $@ - @echo " mkdir -p \$$(@D)" >> $@ - @echo " cp \$$< \$$@" >> $@ + @echo " @mkdir -p \$$(@D)" >> $@ + @echo " @cp \$$< \$$@" >> $@ @echo >> $@ @echo "\$$(HTMLDIR)/$*/%: $*/%" >> $@ - @echo " mkdir -p \$$(@D)" >> $@ - @echo " cp \$$< \$$@" >> $@ + @echo " @mkdir -p \$$(@D)" >> $@ + @echo " @cp \$$< \$$@" >> $@ @echo >> $@ @echo "\$$(HTMLHELPDIR)/$*/%: $*/%" >> $@ - @echo " mkdir -p \$$(@D)" >> $@ - @echo " cp \$$< \$$@" >> $@ + @echo " @mkdir -p \$$(@D)" >> $@ + @echo " @cp \$$< \$$@" >> $@ @echo >> $@ @echo "$*-images-html-single: \$$(addprefix \$$(HTMLDIR)/, \$$($*-images-html))" >> $@ @echo "$*-images-html-chunks: \$$(addprefix \$$(HTMLDIR)/$*/, \$$($*-images-html))" >> $@ @@ -187,10 +187,10 @@ $(DVIDIR)/%.dvi: %.dvi -$(LATEX) $< %.eps: %.dia - $(DIA) -t eps-builtin -e $@ $< + @$(DIA) -t eps-builtin -e $@ $< %.png: %.dia - $(DIA) -e $@ $< + @$(DIA) -e $@ $< %.pdf: %.eps $(EPSTOPDF) $< diff --git a/docs/Samba3-HOWTO/index.xml b/docs/Samba3-HOWTO/index.xml index 609f7b174e..2a477be3ec 100644 --- a/docs/Samba3-HOWTO/index.xml +++ b/docs/Samba3-HOWTO/index.xml @@ -160,18 +160,18 @@ The chapters in this part each cover specific Samba features. <xi:include href="TOSHARG-SecureLDAP.xml"/> <xi:include href="TOSHARG-Support.xml"/> <xi:include href="TOSHARG-DNS-DHCP-Configuration.xml"/> +</part> <!-- Comment out the following line to include the manpages. *Please* do not commit with the line below enabled! --> <!-- <xi:include href="manpages.xml"/> --> - <xi:include href="manpages.xml"/> - <xi:include href="http://www.gnu.org/licenses/gpl.xml"/> +<xi:include href="manpages.xml"/> +<xi:include href="http://www.gnu.org/licenses/gpl.xml"/> - <xi:include href="TOSHARG-glossary.xml"/> +<xi:include href="TOSHARG-glossary.xml"/> - <?latex \chaptermark{Subject index} ?> +<?latex \chaptermark{Subject index} ?> - <index/> -</part> +<index/> </book> diff --git a/docs/Samba3-HOWTO/manpages.xml b/docs/Samba3-HOWTO/manpages.xml index 12e9827c89..ec2eea5e59 100644 --- a/docs/Samba3-HOWTO/manpages.xml +++ b/docs/Samba3-HOWTO/manpages.xml @@ -1,6 +1,7 @@ <?xml version="1.0" encoding="iso-8859-1"?> <!DOCTYPE reference PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc"> -<reference id="manuals" xmlns:xi="http://www.w3.org/2003/XInclude"> <title>Manual pages</title> +<appendix id="manuals" xmlns:xi="http://www.w3.org/2003/XInclude"> + <title>Manual pages</title> <para>This appendix contains most of the manual pages from the official Samba distribution. All manual pages have been written by members of <ulink url="http://samba.org/samba/team.html">the Samba Team</ulink>.</para> @@ -26,4 +27,4 @@ <xi:include href="../manpages-3/wbinfo.1.xml"/> <xi:include href="../manpages-3/winbindd.8.xml"/> -</reference> +</appendix> diff --git a/docs/configure.in b/docs/configure.in index c8fbb7bc22..9d336e2320 100644 --- a/docs/configure.in +++ b/docs/configure.in @@ -7,7 +7,7 @@ AC_ARG_WITH(samba-sources, LATEX_DOCUMENTCLASS_OPTIONS="letterpaper,11pt,openright,twoside" AC_ARG_ENABLE(prentice-hall, [ --enable-prentice-hall Produce Prentice-Hall compatible output], -[ test "$enableval" && LATEX_DOCUMENTCLASS_OPTIONS="letterpaper,10pt,openright,twoside,ph" ]) +[ test "$enableval" && LATEX_DOCUMENTCLASS_OPTIONS="letterpaper,10pt,openleft,twoside,ph" ]) AC_SUBST(LATEX_DOCUMENTCLASS_OPTIONS) DOC_BUILD_DATE=`date '+%d-%m-%Y'` diff --git a/docs/smbdotconf/base/bindinterfacesonly.xml b/docs/smbdotconf/base/bindinterfacesonly.xml index 67bb2302e7..0fd302ceaa 100644 --- a/docs/smbdotconf/base/bindinterfacesonly.xml +++ b/docs/smbdotconf/base/bindinterfacesonly.xml @@ -16,15 +16,14 @@ 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 + name requests on all of these sockets. If <smbconfoption name="bind interfaces only"/> 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. + interfaces in the <smbconfoption name="interfaces"/> 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 + <smbconfoption name="interfaces"/> 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> @@ -36,9 +35,9 @@ 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 +<para>If <smbconfoption name="bind interfaces only"/> is set then unless the network address <emphasis>127.0.0.1</emphasis> is added - to the <parameter moreinfo="none">interfaces</parameter> parameter + to the <smbconfoption name="interfaces"/> 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 @@ -47,9 +46,9 @@ <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 + <smbconfoption name="bind interfaces only"/> 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"> + <smbconfoption name="interfaces"/> 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> diff --git a/docs/smbdotconf/base/comment.xml b/docs/smbdotconf/base/comment.xml index 46d3d0a6a7..ce3b574ddf 100644 --- a/docs/smbdotconf/base/comment.xml +++ b/docs/smbdotconf/base/comment.xml @@ -10,8 +10,7 @@ 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> + machine name then see the <smbconfoption name="server string"/> parameter.</para> </description> <value type="default"><comment>No comment</comment></value> diff --git a/docs/smbdotconf/base/displaycharset.xml b/docs/smbdotconf/base/displaycharset.xml index 8439f9d130..ca25efee36 100644 --- a/docs/smbdotconf/base/displaycharset.xml +++ b/docs/smbdotconf/base/displaycharset.xml @@ -6,7 +6,7 @@ <description> <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>. + Should generally be the same as the <smbconfoption name="unix charset"/>. </para> </description> diff --git a/docs/smbdotconf/base/path.xml b/docs/smbdotconf/base/path.xml index 099a72d451..7828e62441 100644 --- a/docs/smbdotconf/base/path.xml +++ b/docs/smbdotconf/base/path.xml @@ -22,8 +22,8 @@ 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 <smbconfoption name="root dir"/> + if one was specified.</para> </description> <value type="default"></value> diff --git a/docs/smbdotconf/base/workgroup.xml b/docs/smbdotconf/base/workgroup.xml index c698394240..d62c3d5e12 100644 --- a/docs/smbdotconf/base/workgroup.xml +++ b/docs/smbdotconf/base/workgroup.xml @@ -7,7 +7,7 @@ <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> + the <smbconfoption name="security">domain</smbconfoption> setting.</para> </description> <value type="default">WORKGROUP</value> diff --git a/docs/smbdotconf/browse/domainmaster.xml b/docs/smbdotconf/browse/domainmaster.xml index 54f97caf37..d946ced7e6 100644 --- a/docs/smbdotconf/browse/domainmaster.xml +++ b/docs/smbdotconf/browse/domainmaster.xml @@ -8,9 +8,9 @@ <manvolnum>8</manvolnum></citerefentry> to enable WAN-wide browse list collation. Setting this option causes <command moreinfo="none">nmbd</command> to claim a special domain specific NetBIOS name that identifies - it as a domain master browser for its given <link linkend="WORKGROUP"> - <parameter moreinfo="none">workgroup</parameter></link>. Local master browsers - in the same <parameter moreinfo="none">workgroup</parameter> on broadcast-isolated + it as a domain master browser for its given + <smbconfoption name="workgroup"/>. Local master browsers + in the same <smbconfoption name="workgroup"/> on broadcast-isolated subnets will give this <command moreinfo="none">nmbd</command> their local browse lists, and then ask <citerefentry><refentrytitle>smbd</refentrytitle> <manvolnum>8</manvolnum></citerefentry> for a complete copy of the browse @@ -19,20 +19,19 @@ instead of just the list for their broadcast-isolated subnet.</para> <para>Note that Windows NT Primary Domain Controllers expect to be - able to claim this <parameter moreinfo="none">workgroup</parameter> specific special + able to claim this <smbconfoption name="workgroup"/> specific special NetBIOS name that identifies them as domain master browsers for - that <parameter moreinfo="none">workgroup</parameter> by default (i.e. there is no + that <smbconfoption name="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 <command moreinfo="none">nmbd</command> claims - the special name for a <parameter moreinfo="none">workgroup</parameter> before a Windows + the special name for a <smbconfoption name="workgroup"/> before a Windows NT PDC is able to do so then cross subnet browsing will behave strangely and may fail.</para> - <para>If <link linkend="DOMAINLOGONS"><command moreinfo="none">domain logons = yes</command> - </link>, then the default behavior is to enable the <parameter moreinfo="none">domain - master</parameter> parameter. If <parameter moreinfo="none">domain logons</parameter> is - not enabled (the default setting), then neither will <parameter moreinfo="none">domain - master</parameter> be enabled by default.</para> +<para>If <smbconfoption name="domain logons">yes</smbconfoption> + , then the default behavior is to enable the <smbconfoption name="domain + master"/> parameter. If <smbconfoption name="domain logons"/> is + not enabled (the default setting), then neither will <smbconfoption name="domain master"/> be enabled by default.</para> </description> <value type="default">auto</value> diff --git a/docs/smbdotconf/browse/lmannounce.xml b/docs/smbdotconf/browse/lmannounce.xml index d29f0e623d..92365d8e50 100644 --- a/docs/smbdotconf/browse/lmannounce.xml +++ b/docs/smbdotconf/browse/lmannounce.xml @@ -13,11 +13,11 @@ If set to <constant>no</constant> Samba will never produce these broadcasts. If set to <constant>yes</constant> Samba will produce Lanman announce broadcasts at a frequency set by the parameter - <parameter moreinfo="none">lm interval</parameter>. If set to <constant>auto</constant> + <smbconfoption name="lm interval"/>. If set to <constant>auto</constant> 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 - <parameter moreinfo="none">lm interval</parameter>.</para> + <smbconfoption name="lm interval"/>.</para> </description> <related>lm interval</related> diff --git a/docs/smbdotconf/browse/lminterval.xml b/docs/smbdotconf/browse/lminterval.xml index abe80bc8fb..4f38165147 100644 --- a/docs/smbdotconf/browse/lminterval.xml +++ b/docs/smbdotconf/browse/lminterval.xml @@ -5,11 +5,11 @@ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> <description> <para>If Samba is set to produce Lanman announce - broadcasts needed by OS/2 clients (see the <link linkend="LMANNOUNCE"> - <parameter moreinfo="none">lm announce</parameter></link> parameter) then this + broadcasts needed by OS/2 clients (see the + <smbconfoption name="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 <parameter moreinfo="none">lm announce</parameter> + made despite the setting of the <smbconfoption name="lm announce"/> parameter.</para> </description> <related>lm announce</related> diff --git a/docs/smbdotconf/browse/oslevel.xml b/docs/smbdotconf/browse/oslevel.xml index e379d5053b..487b165604 100644 --- a/docs/smbdotconf/browse/oslevel.xml +++ b/docs/smbdotconf/browse/oslevel.xml @@ -8,8 +8,7 @@ advertises itself as for browse elections. The value of this parameter determines whether <citerefentry><refentrytitle>nmbd</refentrytitle> <manvolnum>8</manvolnum></citerefentry> - has a chance of becoming a local master browser for the <parameter moreinfo="none"> - WORKGROUP</parameter> in the local broadcast area.</para> +has a chance of becoming a local master browser for the <smbconfoption name="workgroup"/> in the local broadcast area.</para> <para><emphasis>Note :</emphasis>By default, Samba will win a local master browsing election over all Microsoft operating diff --git a/docs/smbdotconf/browse/preferredmaster.xml b/docs/smbdotconf/browse/preferredmaster.xml index 8a6d8706c3..009aac3d3d 100644 --- a/docs/smbdotconf/browse/preferredmaster.xml +++ b/docs/smbdotconf/browse/preferredmaster.xml @@ -13,8 +13,8 @@ <para>If this is set to <constant>yes</constant>, on startup, <command moreinfo="none">nmbd</command> 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 <command moreinfo="none"><link linkend="DOMAINMASTER"> - <parameter moreinfo="none">domain master</parameter></link> = yes</command>, so + used in conjunction with + <smbconfoption name="domain master">yes</smbconfoption>, so that <command moreinfo="none">nmbd</command> can guarantee becoming a domain master.</para> <para>Use this option with caution, because if there are several diff --git a/docs/smbdotconf/domain/machinepasswordtimeout.xml b/docs/smbdotconf/domain/machinepasswordtimeout.xml index 3a2b23d2d3..790eaf97b9 100644 --- a/docs/smbdotconf/domain/machinepasswordtimeout.xml +++ b/docs/smbdotconf/domain/machinepasswordtimeout.xml @@ -5,7 +5,7 @@ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> <description> <para>If a Samba server is a member of a Windows - NT Domain (see the <link linkend="SECURITYEQUALSDOMAIN">security = domain</link> + NT Domain (see the <smbconfoption name="security">domain</smbconfoption> parameter) then periodically a running smbd process will try and change the MACHINE ACCOUNT PASSWORD stored in the TDB called <filename moreinfo="none">private/secrets.tdb @@ -14,8 +14,7 @@ seconds), the same as a Windows NT Domain member server.</para> <para>See also <citerefentry><refentrytitle>smbpasswd</refentrytitle> - <manvolnum>8</manvolnum></citerefentry>, and the <link linkend="SECURITYEQUALSDOMAIN"> - security = domain</link> parameter.</para> + <manvolnum>8</manvolnum></citerefentry>, and the <smbconfoption name="security">domain</smbconfoption> parameter.</para> </description> <value type="default">604800</value> diff --git a/docs/smbdotconf/filename/casesensitive.xml b/docs/smbdotconf/filename/casesensitive.xml index bace4b360f..7765adced2 100644 --- a/docs/smbdotconf/filename/casesensitive.xml +++ b/docs/smbdotconf/filename/casesensitive.xml @@ -4,7 +4,7 @@ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> <synonym>casesignames</synonym> <description> - <para>See the discussion in the section <link linkend="NAMEMANGLINGSECT">NAME MANGLING</link>.</para> + <para>See the discussion in the section <smbconfoption name="name mangling"/>.</para> </description> <value type="default">no</value> </samba:parameter> diff --git a/docs/smbdotconf/filename/defaultcase.xml b/docs/smbdotconf/filename/defaultcase.xml index 082a26cff9..ac5f589d3a 100644 --- a/docs/smbdotconf/filename/defaultcase.xml +++ b/docs/smbdotconf/filename/defaultcase.xml @@ -2,9 +2,8 @@ context="S" type="string" xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> <description> - <para>See the section on <link linkend="NAMEMANGLINGSECT"> - NAME MANGLING</link>. Also note the <link linkend="SHORTPRESERVECASE"> - <parameter moreinfo="none">short preserve case</parameter></link> parameter.</para> + <para>See the section on <smbconfoption name="name mangling"/> + . Also note the <smbconfoption name="short preserve case"/> parameter.</para> </description> <value type="default">lower</value> </samba:parameter> diff --git a/docs/smbdotconf/filename/deletevetofiles.xml b/docs/smbdotconf/filename/deletevetofiles.xml index a8ccced47d..b8809bacd7 100644 --- a/docs/smbdotconf/filename/deletevetofiles.xml +++ b/docs/smbdotconf/filename/deletevetofiles.xml @@ -5,7 +5,7 @@ <description> <para>This option is used when Samba is attempting to delete a directory that contains one or more vetoed directories - (see the <link linkend="VETOFILES"><parameter moreinfo="none">veto files</parameter></link> + (see the <smbconfoption name="veto files"/> option). If this option is set to <constant>no</constant> (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.</para> @@ -17,7 +17,7 @@ directories you might normally veto DOS/Windows users from seeing (e.g. <filename moreinfo="none">.AppleDouble</filename>)</para> - <para>Setting <command moreinfo="none">delete veto files = yes</command> allows these +<para>Setting <smbconfoption name="delete veto files">yes</smbconfoption> allows these directories to be transparently deleted when the parent directory is deleted (so long as the user has permissions to do so).</para> </description> diff --git a/docs/smbdotconf/filename/mangledmap.xml b/docs/smbdotconf/filename/mangledmap.xml index b199a299de..cbcec9b1df 100644 --- a/docs/smbdotconf/filename/mangledmap.xml +++ b/docs/smbdotconf/filename/mangledmap.xml @@ -14,7 +14,7 @@ <para>So to map <filename moreinfo="none">html</filename> to <filename moreinfo="none">htm</filename> you would use:</para> - <para><command moreinfo="none">mangled map = (*.html *.htm)</command></para> +<para><smbconfoption name="mangled map">(*.html *.htm)</smbconfoption>.</para> <para>One very useful case is to remove the annoying <filename moreinfo="none">;1 </filename> off the ends of filenames on some CDROMs (only visible diff --git a/docs/smbdotconf/filename/manglednames.xml b/docs/smbdotconf/filename/manglednames.xml index 9906c595bc..64bc4a9412 100644 --- a/docs/smbdotconf/filename/manglednames.xml +++ b/docs/smbdotconf/filename/manglednames.xml @@ -7,7 +7,7 @@ should be mapped to DOS-compatible names ("mangled") and made visible, or whether non-DOS names should simply be ignored.</para> - <para>See the section on <link linkend="NAMEMANGLINGSECT">NAME MANGLING</link> for +<para>See the section on <smbconfoption name="name mangling"/> for details on how to control the mangling process.</para> <para>If mangling is used then the mangling algorithm is as follows:</para> @@ -29,8 +29,8 @@ characters.</para> <para>Note that the character to use may be specified using - the <link linkend="MANGLINGCHAR"><parameter moreinfo="none">mangling char</parameter> - </link> option, if you don't like '~'.</para> + the <smbconfoption name="mangling char"/> + option, if you don't like '~'.</para> </listitem> <listitem> diff --git a/docs/smbdotconf/filename/maparchive.xml b/docs/smbdotconf/filename/maparchive.xml index 0a6504a3c9..1110ec943b 100644 --- a/docs/smbdotconf/filename/maparchive.xml +++ b/docs/smbdotconf/filename/maparchive.xml @@ -10,10 +10,9 @@ any file it touches from becoming executable under UNIX. This can be quite annoying for shared source code, documents, etc...</para> - <para>Note that this requires the <parameter moreinfo="none">create mask</parameter> +<para>Note that this requires the <smbconfoption name="create mask"/> parameter to be set such that owner execute bit is not masked out - (i.e. it must include 100). See the parameter <link linkend="CREATEMASK"> - <parameter moreinfo="none">create mask</parameter></link> for details.</para> + (i.e. it must include 100). See the parameter <smbconfoption name="create mask"/> for details.</para> </description> <value type="default">yes</value> diff --git a/docs/smbdotconf/filename/maphidden.xml b/docs/smbdotconf/filename/maphidden.xml index f3a6abd57f..da40f7ff3e 100644 --- a/docs/smbdotconf/filename/maphidden.xml +++ b/docs/smbdotconf/filename/maphidden.xml @@ -6,10 +6,9 @@ <para>This controls whether DOS style hidden files should be mapped to the UNIX world execute bit.</para> - <para>Note that this requires the <parameter moreinfo="none">create mask</parameter> +<para>Note that this requires the <smbconfoption name="create mask"/> to be set such that the world execute bit is not masked out (i.e. - it must include 001). See the parameter <link linkend="CREATEMASK"> - <parameter moreinfo="none">create mask</parameter></link> for details.</para> + it must include 001). See the parameter <smbconfoption name="create mask"/> for details.</para> </description> <value type="boolean">no</value> diff --git a/docs/smbdotconf/filename/mapsystem.xml b/docs/smbdotconf/filename/mapsystem.xml index cf8226dd09..35b7dc7cfe 100644 --- a/docs/smbdotconf/filename/mapsystem.xml +++ b/docs/smbdotconf/filename/mapsystem.xml @@ -6,10 +6,10 @@ <para>This controls whether DOS style system files should be mapped to the UNIX group execute bit.</para> - <para>Note that this requires the <parameter moreinfo="none">create mask</parameter> +<para>Note that this requires the <smbconfoption name="create mask"/> to be set such that the group execute bit is not masked out (i.e. - it must include 010). See the parameter <link linkend="CREATEMASK"> - <parameter moreinfo="none">create mask</parameter></link> for details.</para> + it must include 010). See the parameter <smbconfoption name="create mask"/> + for details.</para> </description> <value type="default">no</value> </samba:parameter> diff --git a/docs/smbdotconf/filename/preservecase.xml b/docs/smbdotconf/filename/preservecase.xml index 6346c31463..e84cb56461 100644 --- a/docs/smbdotconf/filename/preservecase.xml +++ b/docs/smbdotconf/filename/preservecase.xml @@ -5,8 +5,7 @@ <description> <para> This controls if new filenames are created with the case that the client passes, or if they are forced to - be the <link linkend="DEFAULTCASE"><parameter moreinfo="none">default case - </parameter></link>.</para> + be the <smbconfoption name="default case"/>.</para> <para>See the section on <link linkend="NAMEMANGLINGSECT">NAME MANGLING</link> for a fuller discussion.</para> </description> diff --git a/docs/smbdotconf/filename/shortpreservecase.xml b/docs/smbdotconf/filename/shortpreservecase.xml index 8742b60830..5a164c3d48 100644 --- a/docs/smbdotconf/filename/shortpreservecase.xml +++ b/docs/smbdotconf/filename/shortpreservecase.xml @@ -6,9 +6,9 @@ <para>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 <link linkend="DEFAULTCASE"><parameter moreinfo="none">default case - </parameter></link>. This option can be use with <link linkend="PRESERVECASE"><command moreinfo="none">preserve case = yes</command> - </link> to permit long filenames to retain their case, while short + to be the <smbconfoption name="default case"/> + . This option can be use with <smbconfoption name="preserve case">yes</smbconfoption> + to permit long filenames to retain their case, while short names are lowered. </para> <para>See the section on <link linkend="NAMEMANGLINGSECT">NAME MANGLING</link>.</para> diff --git a/docs/smbdotconf/filename/storedosattributes.xml b/docs/smbdotconf/filename/storedosattributes.xml index 56e5a0c175..bedf185c2f 100644 --- a/docs/smbdotconf/filename/storedosattributes.xml +++ b/docs/smbdotconf/filename/storedosattributes.xml @@ -5,9 +5,9 @@ <description> <para>If this parameter is set Samba no longer attempts to map DOS attributes like SYSTEM, HIDDEN, ARCHIVE or READ-ONLY - to UNIX permission bits (such as the <link linkend="MAPHIDDEN"><parameter moreinfo="none">map hidden</parameter></link>. Instead, DOS attributes will be stored onto an extended + to UNIX permission bits (such as the <smbconfoption name="map hidden"/>. Instead, DOS attributes will be stored onto an extended attribute in the UNIX filesystem, associated with the file or directory. - For this to operate correctly, the parameters <link linkend="MAPHIDDEN"><parameter moreinfo="none">map hidden</parameter></link>, <link linkend="MAPSYSTEM"><parameter moreinfo="none">map system</parameter></link>, <link linkend="MAPARCHIVE"><parameter moreinfo="none">map archive</parameter></link> must be set to off. + For this to operate correctly, the parameters <smbconfoption name="map hidden"/>, <smbconfoption name="map system"/>, <smbconfoption name="map archive"/> must be set to off. This parameter writes the DOS attributes as a string into the extended attribute named "user.DOSATTRIB". This extended attribute is explicitly hidden from smbd clients requesting an EA list. diff --git a/docs/smbdotconf/filename/vetofiles.xml b/docs/smbdotconf/filename/vetofiles.xml index b5a60053f4..9115da6f7c 100644 --- a/docs/smbdotconf/filename/vetofiles.xml +++ b/docs/smbdotconf/filename/vetofiles.xml @@ -13,7 +13,7 @@ must <emphasis>not</emphasis> include the unix directory separator '/'.</para> - <para>Note that the <parameter moreinfo="none">case sensitive</parameter> option +<para>Note that the <smbconfoption name="case sensitive"/> option is applicable in vetoing files.</para> <para>One feature of the veto files parameter that it @@ -21,7 +21,7 @@ trying to delete a directory. If a directory that is to be deleted contains nothing but veto files this deletion will <emphasis>fail</emphasis> unless you also set - the <parameter moreinfo="none">delete veto files</parameter> parameter to + the <smbconfoption name="delete veto files"/> parameter to <parameter moreinfo="none">yes</parameter>.</para> <para>Setting this parameter will affect the performance diff --git a/docs/smbdotconf/filename/vetooplockfiles.xml b/docs/smbdotconf/filename/vetooplockfiles.xml index 6deb2d20b0..a8b2797796 100644 --- a/docs/smbdotconf/filename/vetooplockfiles.xml +++ b/docs/smbdotconf/filename/vetooplockfiles.xml @@ -3,12 +3,12 @@ type="string" xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> <description> - <para>This parameter is only valid when the <link linkend="OPLOCKS"> - <parameter moreinfo="none">oplocks</parameter></link> + <para>This parameter is only valid when the + <smbconfoption name="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 - <link linkend="VETOFILES"><parameter moreinfo="none">veto files</parameter></link> + <smbconfoption name="veto files"/> parameter.</para> diff --git a/docs/smbdotconf/ldap/ldapadmindn.xml b/docs/smbdotconf/ldap/ldapadmindn.xml index 4e6c30c141..5f8805ad14 100644 --- a/docs/smbdotconf/ldap/ldapadmindn.xml +++ b/docs/smbdotconf/ldap/ldapadmindn.xml @@ -4,11 +4,10 @@ type="string" xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> <description> - <para> The <parameter moreinfo="none">ldap admin dn</parameter> + <para> The <smbconfoption name="ldap admin dn"/> defines the Distinguished Name (DN) name used by Samba to contact the ldap server when retreiving user account - information. The <parameter moreinfo="none">ldap admin - dn</parameter> is used in conjunction with the admin dn password + information. The <smbconfoption name="ldap admin dn"/> is used in conjunction with the admin dn password stored in the <filename moreinfo="none">private/secrets.tdb</filename> file. See the <citerefentry><refentrytitle>smbpasswd</refentrytitle> <manvolnum>8</manvolnum></citerefentry> man page for more diff --git a/docs/smbdotconf/ldap/ldapgroupsuffix.xml b/docs/smbdotconf/ldap/ldapgroupsuffix.xml index 00d6fba7a0..ffbebe2f5c 100644 --- a/docs/smbdotconf/ldap/ldapgroupsuffix.xml +++ b/docs/smbdotconf/ldap/ldapgroupsuffix.xml @@ -6,7 +6,7 @@ <description> <para>This parameters specifies the suffix that is used for groups when these are added to the LDAP directory. - If this parameter is unset, the value of <parameter>ldap suffix</parameter> will be used instead.</para> + If this parameter is unset, the value of <smbconfoption name="ldap suffix"/> will be used instead.</para> </description> <value type="default"></value> diff --git a/docs/smbdotconf/ldap/ldapidmapsuffix.xml b/docs/smbdotconf/ldap/ldapidmapsuffix.xml index 1557175dd6..81fc98d8b9 100644 --- a/docs/smbdotconf/ldap/ldapidmapsuffix.xml +++ b/docs/smbdotconf/ldap/ldapidmapsuffix.xml @@ -6,7 +6,7 @@ <description> <para>This parameters specifies the suffix that is used when storing idmap mappings. If this parameter - is unset, the value of <parameter>ldap suffix</parameter> + is unset, the value of <smbconfoption name="ldap suffix"/> will be used instead.</para> </description> <value type="default"></value> diff --git a/docs/smbdotconf/ldap/ldappasswdsync.xml b/docs/smbdotconf/ldap/ldappasswdsync.xml index f215da5bff..3a6b45654f 100644 --- a/docs/smbdotconf/ldap/ldappasswdsync.xml +++ b/docs/smbdotconf/ldap/ldappasswdsync.xml @@ -11,8 +11,7 @@ change via SAMBA. </para> - <para>The <parameter moreinfo="none">ldap passwd - sync</parameter> can be set to one of three values: </para> + <para>The <smbconfoption name="ldap passwd sync"/> can be set to one of three values: </para> <itemizedlist> <listitem> diff --git a/docs/smbdotconf/ldap/ldapport.xml b/docs/smbdotconf/ldap/ldapport.xml index 141382a640..8895c15c7f 100644 --- a/docs/smbdotconf/ldap/ldapport.xml +++ b/docs/smbdotconf/ldap/ldapport.xml @@ -8,7 +8,7 @@ at compile time.</para> <para>This option is used to control the tcp port number used to contact - the <link linkend="LDAPSERVER"><parameter moreinfo="none">ldap server</parameter></link>. + the <smbconfoption name="ldap server"/>. The default is to use the stand LDAPS port 636.</para> </description> <related>ldap ssl</related> diff --git a/docs/smbdotconf/ldap/ldapssl.xml b/docs/smbdotconf/ldap/ldapssl.xml index bd2f45fe3f..3c276b87e3 100644 --- a/docs/smbdotconf/ldap/ldapssl.xml +++ b/docs/smbdotconf/ldap/ldapssl.xml @@ -11,7 +11,7 @@ <command moreinfo="none">--with-ssl</command> option to the <filename moreinfo="none">configure</filename> script.</para> - <para>The <parameter moreinfo="none">ldap ssl</parameter> can be set to one of three values:</para> +<para>The <smbconfoption name="ldap ssl"/> can be set to one of three values:</para> <itemizedlist> <listitem> <para><parameter moreinfo="none">Off</parameter> = Never @@ -30,8 +30,7 @@ moreinfo="none">ldap server</parameter>. Only available when the backwards-compatiblity <command moreinfo="none">--with-ldapsam</command> option is specified - to configure. See <link linkend="PASSDBBACKEND"><parameter - moreinfo="none">passdb backend</parameter></link></para> + to configure. See <smbconfoption name="passdb backend"/></para> </listitem> </itemizedlist> </description> diff --git a/docs/smbdotconf/ldap/ldapsuffix.xml b/docs/smbdotconf/ldap/ldapsuffix.xml index 0bbb1c23e9..233c61040c 100644 --- a/docs/smbdotconf/ldap/ldapsuffix.xml +++ b/docs/smbdotconf/ldap/ldapsuffix.xml @@ -5,9 +5,8 @@ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> <description> <para>Specifies where user and machine accounts are added to the - tree. Can be overriden by <command moreinfo="none">ldap user - suffix</command> and <command moreinfo="none">ldap machine - suffix</command>. It also used as the base dn for all ldap + tree. Can be overriden by <smbconfoption name="ldap user suffix"/> and + <smbconfoption name="ldap machine suffix"/>. It also used as the base dn for all ldap searches. </para> </description> <value type="default"></value> diff --git a/docs/smbdotconf/ldap/ldapusersuffix.xml b/docs/smbdotconf/ldap/ldapusersuffix.xml index 133b6db707..d860fba0da 100644 --- a/docs/smbdotconf/ldap/ldapusersuffix.xml +++ b/docs/smbdotconf/ldap/ldapusersuffix.xml @@ -5,7 +5,7 @@ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"> <description> <para>This parameter specifies where users are added to the tree. - If this parameter is not specified, the value from <command>ldap suffix</command>.</para> + If this parameter is not specified, the value from <smbconfoption name="ldap suffix"/>.</para> </description> <value type="default"/> diff --git a/docs/smbdotconf/locking/cscpolicy.xml b/docs/smbdotconf/locking/cscpolicy.xml index 9886a1e8c0..5dd76569fa 100644 --- a/docs/smbdotconf/locking/cscpolicy.xml +++ b/docs/smbdotconf/locking/cscpolicy.xml @@ -11,8 +11,7 @@ <para>These values correspond to those used on Windows servers.</para> <para>For example, shares containing roaming profiles can have - offline caching disabled using <command - moreinfo="none">csc policy = disable</command>.</para> + offline caching disabled using <smbconfoption name="csc policy">disable</smbconfoption>.</para> </description> <value type="default">manual</value> <value type="example">programs</value> diff --git a/docs/smbdotconf/security/writelist.xml b/docs/smbdotconf/security/writelist.xml index 5951e7408f..3476b311bf 100644 --- a/docs/smbdotconf/security/writelist.xml +++ b/docs/smbdotconf/security/writelist.xml @@ -5,16 +5,14 @@ <description> <para>This is a list of users that are given read-write access to a service. If the connecting user is in this list then - they will be given write access, no matter what the <link linkend="READONLY"> - <parameter moreinfo="none">read only</parameter></link> + they will be given write access, no matter what the <smbconfoption name="read only"/> option is set to. The list can include group names using the @group syntax.</para> <para>Note that if a user is in both the read list and the write list then they will be given write access.</para> - <para>This parameter will not work with the <link linkend="SECURITY"> - <parameter moreinfo="none">security = share</parameter></link> in +<para>This parameter will not work with the <smbconfoption name="security">share</smbconfoption> in Samba 3.0. This is by design.</para> </description> diff --git a/docs/xslt/latex.xsl b/docs/xslt/latex.xsl index b3434d876a..f8045db74c 100644 --- a/docs/xslt/latex.xsl +++ b/docs/xslt/latex.xsl @@ -154,9 +154,11 @@ <xsl:template match="related"><xsl:apply-templates/></xsl:template> <xsl:template match="//samba:parameterlist"> + <xsl:text>\begin{description} </xsl:text> <xsl:apply-templates> - <xsl:sort select="varlistentry/term/anchor"/> + <xsl:sort select="samba:parameter/@name"/> </xsl:apply-templates> + <xsl:text>\end{description} </xsl:text> </xsl:template> <xsl:template match="value/comment"> @@ -164,12 +166,16 @@ <xsl:apply-templates/> </xsl:template> +<xsl:template match="/"> + <xsl:apply-templates/> +</xsl:template> + <xsl:template match="//samba:parameter"> - <xsl:text>\subsubsection{</xsl:text><xsl:value-of select="@name"/><xsl:text>} </xsl:text> + <xsl:text>\item[{</xsl:text><xsl:value-of select="@name"/><xsl:text>}] </xsl:text> <xsl:text>\index{</xsl:text><xsl:value-of select="@name"/><xsl:text>|it} </xsl:text> <xsl:for-each select="synonym"> - <xsl:text>\subsubsection{</xsl:text><xsl:value-of select="."/><xsl:text>} </xsl:text> + <xsl:text>\item[{</xsl:text><xsl:value-of select="."/><xsl:text>}] </xsl:text> <xsl:text>\index{</xsl:text><xsl:value-of select="."/><xsl:text>|it} </xsl:text> <xsl:text>This parameter is a synonym for \smbconfoption{</xsl:text><xsl:value-of select="../@name"/><xsl:text>}.</xsl:text> </xsl:for-each> diff --git a/docs/xslt/latex/sambadoc.cls b/docs/xslt/latex/sambadoc.cls index 5828ccce40..34b2d286e1 100644 --- a/docs/xslt/latex/sambadoc.cls +++ b/docs/xslt/latex/sambadoc.cls @@ -38,7 +38,7 @@ \RequirePackage{geometry} \geometry{ twoside, - openright, + openleft, papersize={7in,9.25in}, lmargin=.75in, rmargin=.75in, @@ -321,7 +321,8 @@ page \thepage \space undefined}}% backgroundcolor=\color[gray]{0.93}, frame=single, frameround=tttt, - prebreak={\space\linebreaksign} + prebreak={\space\linebreaksign}, + basicstyle=\small } \newcommand{\smbconfsection}[1]{\emph{#1}} |