docs-xml/smbdotconf/filename/manglednames.xml

   1 <samba:parameter name="mangled names"
   2                                  type="boolean"
   3                  context="S"
   4                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
   5 <description>
   6         <para>This controls whether non-DOS names under UNIX
   7         should be mapped to DOS-compatible names (&quot;mangled&quot;) and made visible,
   8         or whether non-DOS names should simply be ignored.</para>
   9
  10         <para>See the section on <smbconfoption name="name mangling"/> for
  11         details on how to control the mangling process.</para>
  12
  13         <para>If mangling is used then the mangling method is as follows:</para>
  14
  15         <itemizedlist>
  16                 <listitem>
  17                         <para>The first (up to) five alphanumeric characters
  18                         before the rightmost dot of the filename are preserved, forced
  19                         to upper case, and appear as the first (up to) five characters
  20                         of the mangled name.</para>
  21                 </listitem>
  22
  23                 <listitem>
  24                         <para>A tilde &quot;~&quot; is appended to the first part of the mangled
  25                         name, followed by a two-character unique sequence, based on the
  26                         original root name (i.e., the original filename minus its final
  27                         extension). The final extension is included in the hash calculation
  28                         only if it contains any upper case characters or is longer than three
  29                         characters.</para>
  30
  31                         <para>Note that the character to use may be specified using
  32                                 the <smbconfoption name="mangling char"/>
  33                         option, if you don't like '~'.</para>
  34                 </listitem>
  35
  36                 <listitem>
  37                         <para>Files whose UNIX name begins with a dot will be
  38                         presented as DOS hidden files. The mangled name will be created as
  39                         for other filenames, but with the leading dot removed and &quot;___&quot; as
  40                         its extension regardless of actual original extension (that's three
  41                         underscores).</para>
  42                 </listitem>
  43         </itemizedlist>
  44
  45         <para>The two-digit hash value consists of upper case alphanumeric characters.</para>
  46
  47         <para>This algorithm can cause name collisions only if files
  48         in a directory share the same first five alphanumeric characters.
  49         The probability of such a clash is 1/1300.</para>
  50
  51         <para>The name mangling (if enabled) allows a file to be
  52         copied between UNIX directories from Windows/DOS while retaining
  53         the long UNIX filename. UNIX files can be renamed to a new extension
  54         from Windows/DOS and will retain the same basename. Mangled names
  55         do not change between sessions.</para>
  56 </description>
  57 <value type="default">yes</value>
  58 </samba:parameter>