From 5f38125c147c329da1e4e853b99022f1a3e77ba2 Mon Sep 17 00:00:00 2001 From: Guenter Kukkukk Date: Thu, 28 Feb 2013 06:12:36 +0100 Subject: vfs_catia: fix the completely outdated manual page The complete rework around 3.5.0 was not even mentioned somewhere. (i was not able to find any info about that major change) Signed-off-by: Guenter Kukkukk Reviewed-by: Jeremy Allison --- docs-xml/manpages/vfs_catia.8.xml | 57 +++++++++++++++++++++++++++++++++++++-- 1 file changed, 55 insertions(+), 2 deletions(-) (limited to 'docs-xml') 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 @@ The Catia CAD package commonly creates filenames that use characters that are illegal in CIFS filenames. The - vfs_catia VFS module implements a fixed character + vfs_catia VFS module implements a character mapping so that these files can be shared with CIFS clients. This module is stackable. + 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. + + + 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. + + + EXAMPLES + Samba versions up to 3.4.x: Map Catia filenames on the [CAD] share: @@ -51,12 +64,51 @@ catia + Samba versions 3.5.0 and later: + Map Catia filenames on the [CAD] share: + + + + /data/cad + catia + 0x22:0xa8 + + + To get the full formerly fixed mappings: + + + /data/cad + catia + 0x22:0xa8,0x2a:0xa4,0x2f:0xf8,0x3a:0xf7,0x3c:0xab,0x3e:0xbb,0x3f:0xbf,0x5c:0xff,0x7c:0xa6,0x20:0xb1 + + + Note that the character mapping must work in BOTH directions + (unix -> windows and windows -> unix) to get unique and existing file names! + + + A NOT working example: + + + + /data/cad + catia + 0x3a:0x5f + + + Here the colon ":" is mapped to the underscore "_". + Assuming a unix filename "a:should_work", which is well translated + to windows as "a_should_work". + 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. + + VERSION - This man page is correct for version 3.0.25 of the Samba suite. + This man page is correct for all versions up to 4.0.3 of the Samba suite. @@ -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. + Written by Guenter Kukkukk kukks@samba.org -- cgit