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.4</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>The parameter "catia:mappings" specifies the mapping on a
  41         per-character basis, see below.
  42         </para>
  43 </refsect1>
  44
  45
  46
  47 <refsect1>
  48         <title>OPTIONS</title>
  49         <variablelist>
  50                 <varlistentry>
  51                 <term>catia:mappings = SERVER_HEX_CHAR:CLIENT_HEX_CHAR
  52                 </term>
  53                 <listitem>
  54                 <para>SERVER_HEX_CHAR specifies a 0x prefixed hexedecimal
  55                 character code that, when included in a Samba server-side
  56                 filename, will be mapped to CLIENT_HEX_CHAR for the CIFS
  57                 client.</para>
  58                 <para>The same mapping occurs in the opposite direction.
  59                 Multiple character mappings are separated by a comma.</para>
  60                 </listitem>
  61                 </varlistentry>
  62         </variablelist>
  63 </refsect1>
  64
  65
  66
  67 <refsect1>
  68         <title>EXAMPLES</title>
  69
  70         <para>Map server-side quotation-marks (") to client-side diaeresis
  71         (&#x00a8;) on filenames in the [CAD] share:</para>
  72
  73 <programlisting>
  74         <smbconfsection name="[CAD]"/>
  75         <smbconfoption name="path">/data/cad</smbconfoption>
  76         <smbconfoption name="vfs objects">catia</smbconfoption>
  77         <smbconfoption name="catia:mappings">0x22:0xa8</smbconfoption>
  78 </programlisting>
  79
  80         <para>Perform comprehensive mapping of common Catia filename characters:</para>
  81 <programlisting>
  82         <smbconfsection name="[CAD]"/>
  83         <smbconfoption name="path">/data/cad</smbconfoption>
  84         <smbconfoption name="vfs objects">catia</smbconfoption>
  85         <smbconfoption name="catia:mappings">0x22:0xa8,0x2a:0xa4,0x2f:0xf8,0x3a:0xf7,0x3c:0xab,0x3e:0xbb,0x3f:0xbf,0x5c:0xff,0x7c:0xa6</smbconfoption>
  86 </programlisting>
  87
  88         <para>Server-side filename to be translated (Note that the path delimiter "/" is not used here):
  89         </para>
  90         <para>a\a:a*a?a"a&lt;a&gt;a|a</para>
  91
  92         <para>Resulting filename, as seen by the client:</para>
  93
  94         <para>a&#x00ff;a&#x00f7;a&#x00a4;a&#x00bf;a&#x00a8;a&#x00ab;a&#x00bb;a&#x00a6;a
  95         </para>
  96 </refsect1>
  97
  98 <refsect1>
  99         <title>CAVEATS</title>
 100
 101         <para>Character mapping must work in BOTH directions (server -&gt;
 102         client and client -&gt; server) to get unique and existing file names!
 103         </para>
 104
 105         <para>A NOT working example:</para>
 106
 107 <programlisting>
 108         <smbconfsection name="[CAD]"/>
 109         <smbconfoption name="path">/data/cad</smbconfoption>
 110         <smbconfoption name="vfs objects">catia</smbconfoption>
 111         <smbconfoption name="catia:mappings">0x3a:0x5f</smbconfoption>
 112 </programlisting>
 113
 114         <para>Here the colon ":" is mapped to the underscore "_".</para>
 115         <para>Assuming a server-side filename "a:should_work", which is
 116         translated to "a_should_work" for the client.</para>
 117         <para>BUT the reverse mapping from client "a_should_work" to server
 118         will result in "a:should:work" - something like "file not found"
 119         will be returned.
 120         </para>
 121
 122 </refsect1>
 123
 124 <refsect1>
 125         <title>VERSION</title>
 126
 127         <para>This man page is correct for Samba versions from 3.5.0 to 4.0.6.
 128         </para>
 129 </refsect1>
 130
 131 <refsect1>
 132         <title>AUTHOR</title>
 133
 134         <para>The original Samba software and related utilities
 135         were created by Andrew Tridgell. Samba is now developed
 136         by the Samba Team as an Open Source project similar
 137         to the way the Linux kernel is developed.</para>
 138         <para>New version written by Guenter Kukkukk kukks@samba.org</para>
 139
 140 </refsect1>
 141
 142 </refentry>