Add new framework for smb.conf(5). Please read README before trying to compile.

I will commit more meta-information updates during week-end.
(This used to be commit 8d684dffab6a90b3d612a1aa2b2c457a2bc2e6ac)

1 files changed, 58 insertions, 0 deletions

diff --git a/docs/docbook/smbdotconf/filename/manglednames.xml b/docs/docbook/smbdotconf/filename/manglednames.xml
new file mode 100644
index 0000000000..41592b3159
--- /dev/null
+++ b/docs/docbook/smbdotconf/filename/manglednames.xml
@@ -0,0 +1,58 @@
+<samba:parameter xmlns:samba="http://samba.org/common">
+		<term><anchor id="MANGLEDNAMES"/>mangled names (S)</term>
+		<listitem><para>This controls whether non-DOS names under UNIX 
+		should be mapped to DOS-compatible names (&quot;mangled&quot;) 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 details on how to control the mangling process.</para>
+
+		<para>If mangling is used then the mangling algorithm is as follows:</para>
+
+		<itemizedlist>
+			<listitem><para>The first (up to) five alphanumeric characters 
+			before the rightmost dot of the filename are preserved, forced 
+			to upper case, and appear as the first (up to) five characters 
+			of the mangled name.</para></listitem>
+		
+			<listitem><para>A tilde &quot;~&quot; is appended to the first part of the mangled
+			name, followed by a two-character unique sequence, based on the
+			original root name (i.e., the original filename minus its final
+			extension). The final extension is included in the hash calculation
+			only if it contains any upper case characters or is longer than three
+			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></listitem>
+
+			<listitem><para>The first three alphanumeric characters of the final 
+			extension are preserved, forced to upper case and appear as the 
+			extension of the mangled name. The final extension is defined as that 
+			part of the original filename after the rightmost dot. If there are no 
+			dots in the filename, the mangled name will have no extension (except 
+			in the case of &quot;hidden files&quot; - see below).</para></listitem>
+
+			<listitem><para>Files whose UNIX name begins with a dot will be 
+			presented as DOS hidden files. The mangled name will be created as 
+			for other filenames, but with the leading dot removed and &quot;___&quot; as 
+			its extension regardless of actual original extension (that's three 
+			underscores).</para></listitem>
+		</itemizedlist>
+
+		<para>The two-digit hash value consists of upper case 
+		alphanumeric characters.</para>
+
+		<para>This algorithm can cause name collisions only if files 
+		in a directory share the same first five alphanumeric characters. 
+		The probability of such a clash is 1/1300.</para>
+
+		<para>The name mangling (if enabled) allows a file to be 
+		copied between UNIX directories from Windows/DOS while retaining 
+		the long UNIX filename. UNIX files can be renamed to a new extension 
+		from Windows/DOS and will retain the same basename. Mangled names 
+		do not change between sessions.</para>
+
+		<para>Default: <command moreinfo="none">mangled names = yes</command></para>
+		</listitem>
+		</samba:parameter>