docs-xml/manpages/vfs_catia.8.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
   3 <refentry id="vfs_catia.8">
   4
   5 <refmeta>
   6         <refentrytitle>vfs_catia</refentrytitle>
   7         <manvolnum>8</manvolnum>
   8         <refmiscinfo class="source">Samba</refmiscinfo>
   9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
  10         <refmiscinfo class="version">4.0</refmiscinfo>
  11 </refmeta>
  12
  13
  14 <refnamediv>
  15         <refname>vfs_catia</refname>
  16         <refpurpose>translate illegal characters in Catia filenames</refpurpose>
  17 </refnamediv>
  18
  19 <refsynopsisdiv>
  20         <cmdsynopsis>
  21                 <command>vfs objects = catia</command>
  22         </cmdsynopsis>
  23 </refsynopsisdiv>
  24
  25 <refsect1>
  26         <title>DESCRIPTION</title>
  27
  28         <para>This VFS module is part of the
  29         <citerefentry><refentrytitle>samba</refentrytitle>
  30         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  31
  32         <para>The Catia CAD package commonly creates filenames that
  33         use characters that are illegal in CIFS filenames. The
  34         <command>vfs_catia</command> VFS module implements a character
  35         mapping so that these files can be shared with CIFS clients.
  36         </para>
  37
  38         <para>This module is stackable.</para>
  39
  40         <para>Up to samba version 3.4.x a fixed character mapping was used.
  41         The invalid windows characters  \ / : * ? " &lt; &gt; | and the blank
  42         character were mapped in a hardcoded way.
  43         </para>
  44
  45         <para>Starting with samba-3.5.0 a more flexible mapping was introduced.
  46         The new parameter "catia:mappings" now specifies the mapping on a char by char
  47         basis using the notation: unix hex char 0x.. : windows hex char 0x..
  48         Multiple character mappings are separated by a comma.
  49         </para>
  50
  51
  52 </refsect1>
  53
  54
  55 <refsect1>
  56         <title>EXAMPLES</title>
  57
  58         <para>Samba versions up to 3.4.x:</para>
  59         <para>Map Catia filenames on the [CAD] share:</para>
  60
  61 <programlisting>
  62         <smbconfsection name="[CAD]"/>
  63         <smbconfoption name="path">/data/cad</smbconfoption>
  64         <smbconfoption name="vfs objects">catia</smbconfoption>
  65 </programlisting>
  66
  67         <para>Samba versions 3.5.0 and later:</para>
  68         <para>Map Catia filenames on the [CAD] share:</para>
  69
  70 <programlisting>
  71         <smbconfsection name="[CAD]"/>
  72         <smbconfoption name="path">/data/cad</smbconfoption>
  73         <smbconfoption name="vfs objects">catia</smbconfoption>
  74         <smbconfoption name="catia:mappings">0x22:0xa8</smbconfoption>
  75 </programlisting>
  76
  77         <para>To get the full formerly fixed mappings:</para>
  78 <programlisting>
  79         <smbconfsection name="[CAD]"/>
  80         <smbconfoption name="path">/data/cad</smbconfoption>
  81         <smbconfoption name="vfs objects">catia</smbconfoption>
  82         <smbconfoption name="catia:mappings">0x22:0xa8,0x2a:0xa4,0x2f:0xf8,0x3a:0xf7,0x3c:0xab,0x3e:0xbb,0x3f:0xbf,0x5c:0xff,0x7c:0xa6,0x20:0xb1</smbconfoption>
  83 </programlisting>
  84
  85         <para>Unix filename to be translated (Note that the path delimiter "/" is not used here):
  86         </para>
  87         <para>a\a:a*a?a"a&lt;a&gt;a|a a</para>
  88
  89         <para>Resulting windows filename:</para>
  90
  91         <para>a&#x00ff;a&#x00f7;a&#x00a4;a&#x00bf;a&#x00a8;a&#x00ab;a&#x00bb;a&#x00a6;a&#x00b1;a
  92         </para>
  93
  94         <para>Note that the character mapping must work in BOTH directions
  95         (unix -&gt; windows and windows -&gt; unix) to get unique and existing file names!
  96         </para>
  97
  98         <para>A NOT working example:</para>
  99
 100 <programlisting>
 101         <smbconfsection name="[CAD]"/>
 102         <smbconfoption name="path">/data/cad</smbconfoption>
 103         <smbconfoption name="vfs objects">catia</smbconfoption>
 104         <smbconfoption name="catia:mappings">0x3a:0x5f</smbconfoption>
 105 </programlisting>
 106
 107          <para>Here the colon ":" is mapped to the underscore "_".</para>
 108          <para>Assuming a unix filename "a:should_work", which is well translated
 109          to windows as "a_should_work".</para>
 110          <para>BUT the reverse mapping from windows "a_should_work" to unix
 111          will result in "a:should:work" - something like "file not found"
 112          will be returned.
 113          </para>
 114
 115 </refsect1>
 116
 117 <refsect1>
 118         <title>VERSION</title>
 119
 120         <para>This man page is correct for all versions up to 4.0.3 of the Samba suite.
 121         </para>
 122 </refsect1>
 123
 124 <refsect1>
 125         <title>AUTHOR</title>
 126
 127         <para>The original Samba software and related utilities
 128         were created by Andrew Tridgell. Samba is now developed
 129         by the Samba Team as an Open Source project similar
 130         to the way the Linux kernel is developed.</para>
 131         <para>New version written by Guenter Kukkukk kukks@samba.org</para>
 132
 133 </refsect1>
 134
 135 </refentry>