docs/docbook/smbdotconf/filename/manglednames.xml

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