diff options
| -rw-r--r-- | docs-xml/manpages/vfs_catia.8.xml | 57 |
1 files changed, 55 insertions, 2 deletions
diff --git a/docs-xml/manpages/vfs_catia.8.xml b/docs-xml/manpages/vfs_catia.8.xml index a5f62333dc..e86f73dca5 100644 --- a/docs-xml/manpages/vfs_catia.8.xml +++ b/docs-xml/manpages/vfs_catia.8.xml @@ -31,18 +31,31 @@ <para>The Catia CAD package commonly creates filenames that use characters that are illegal in CIFS filenames. The - <command>vfs_catia</command> VFS module implements a fixed character + <command>vfs_catia</command> VFS module implements a character mapping so that these files can be shared with CIFS clients. </para> <para>This module is stackable.</para> + <para>Up to samba version 3.4.x a fixed character mapping was used. + The invalid windows characters \ / : * ? " < > | and the blank + character were mapped in a hardcoded way. + </para> + + <para>Starting with samba-3.5.0 a more flexible mapping was introduced. + The new parameter "catia:mappings" now specifies the mapping on a char by char + basis using the notation: unix hex char 0x.. : windows hex char 0x.. + Multiple character mappings are separated by a comma. + </para> + + </refsect1> <refsect1> <title>EXAMPLES</title> + <para>Samba versions up to 3.4.x:</para> <para>Map Catia filenames on the [CAD] share:</para> <programlisting> @@ -51,12 +64,51 @@ <smbconfoption name="vfs objects">catia</smbconfoption> </programlisting> + <para>Samba versions 3.5.0 and later:</para> + <para>Map Catia filenames on the [CAD] share:</para> + +<programlisting> + <smbconfsection name="[CAD]"/> + <smbconfoption name="path">/data/cad</smbconfoption> + <smbconfoption name="vfs objects">catia</smbconfoption> + <smbconfoption name="catia:mappings">0x22:0xa8</smbconfoption> +</programlisting> + + <para>To get the full formerly fixed mappings:</para> +<programlisting> + <smbconfsection name="[CAD]"/> + <smbconfoption name="path">/data/cad</smbconfoption> + <smbconfoption name="vfs objects">catia</smbconfoption> + <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> +</programlisting> + + <para>Note that the character mapping must work in BOTH directions + (unix -> windows and windows -> unix) to get unique and existing file names! + </para> + + <para>A NOT working example:</para> + +<programlisting> + <smbconfsection name="[CAD]"/> + <smbconfoption name="path">/data/cad</smbconfoption> + <smbconfoption name="vfs objects">catia</smbconfoption> + <smbconfoption name="catia:mappings">0x3a:0x5f</smbconfoption> +</programlisting> + + <para>Here the colon ":" is mapped to the underscore "_".</para> + <para>Assuming a unix filename "a:should_work", which is well translated + to windows as "a_should_work".</para> + <para>BUT the reverse mapping from windows "a_should_work" to unix + will result to "a:should:work" - something like "file not found" + would be returned. + </para> + </refsect1> <refsect1> <title>VERSION</title> - <para>This man page is correct for version 3.0.25 of the Samba suite. + <para>This man page is correct for all versions up to 4.0.3 of the Samba suite. </para> </refsect1> @@ -67,6 +119,7 @@ were created by Andrew Tridgell. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed.</para> + <para>Written by Guenter Kukkukk kukks@samba.org</para> </refsect1> |