docs-xml/smbdotconf/filename/manglednames.xml

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