From d924da9bc82bbb9f088eb15ac58377e2a1ae3a58 Mon Sep 17 00:00:00 2001 From: David Disseldorp Date: Mon, 17 Jun 2013 19:43:34 +0200 Subject: docs/vfs_catia: rework man page The vfs_catia man page refers to two configuration variants, one applying to Samba <= 3.4.x and one referring to Samba >= 3.5.x. This change removes all information specific to Samba <= 3.4.x, as such versions have been discontinued. This change also improves formatting and nomenclature: configuration parameters, examples and caveats are split into separate sections, and server-side/client-side terms replace the ambiguous use of Unix and Windows. Signed-off-by: David Disseldorp Reviewed-by: Jeremy Allison Autobuild-User(master): Jeremy Allison Autobuild-Date(master): Mon Jun 17 23:23:57 CEST 2013 on sn-devel-104 --- docs-xml/manpages/vfs_catia.8.xml | 71 +++++++++++++++++++++------------------ 1 file changed, 39 insertions(+), 32 deletions(-) diff --git a/docs-xml/manpages/vfs_catia.8.xml b/docs-xml/manpages/vfs_catia.8.xml index 42920d2922..02a9473632 100644 --- a/docs-xml/manpages/vfs_catia.8.xml +++ b/docs-xml/manpages/vfs_catia.8.xml @@ -37,35 +37,38 @@ 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. + The parameter "catia:mappings" specifies the mapping on a + per-character basis, see below. + - 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. - + + OPTIONS + + + catia:mappings = SERVER_HEX_CHAR:CLIENT_HEX_CHAR + + + SERVER_HEX_CHAR specifies a 0x prefixed hexedecimal + character code that, when included in a Samba server-side + filename, will be mapped to CLIENT_HEX_CHAR for the CIFS + client. + The same mapping occurs in the opposite direction. + Multiple character mappings are separated by a comma. + + + + EXAMPLES - Samba versions up to 3.4.x: - Map Catia filenames on the [CAD] share: - - - - /data/cad - catia - - - Samba versions 3.5.0 and later: - Map Catia filenames on the [CAD] share: + Map server-side quotation-marks (") to client-side diaeresis + (¨) on filenames in the [CAD] share: @@ -74,7 +77,7 @@ 0x22:0xa8 - To get the full formerly fixed mappings: + Perform comprehensive mapping of common Catia filename characters: /data/cad @@ -82,17 +85,21 @@ 0x22:0xa8,0x2a:0xa4,0x2f:0xf8,0x3a:0xf7,0x3c:0xab,0x3e:0xbb,0x3f:0xbf,0x5c:0xff,0x7c:0xa6 - Unix filename to be translated (Note that the path delimiter "/" is not used here): + Server-side filename to be translated (Note that the path delimiter "/" is not used here): a\a:a*a?a"a<a>a|a - Resulting windows filename: + Resulting filename, as seen by the client: aÿa÷a¤a¿a¨a«a»a¦a + - Note that the character mapping must work in BOTH directions - (unix -> windows and windows -> unix) to get unique and existing file names! + + CAVEATS + + Character mapping must work in BOTH directions (server -> + client and client -> server) to get unique and existing file names! A NOT working example: @@ -104,20 +111,20 @@ 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 in "a:should:work" - something like "file not found" - will be returned. - + Here the colon ":" is mapped to the underscore "_". + Assuming a server-side filename "a:should_work", which is + translated to "a_should_work" for the client. + BUT the reverse mapping from client "a_should_work" to server + will result in "a:should:work" - something like "file not found" + will be returned. + VERSION - This man page is correct for all versions up to 4.0.3 of the Samba suite. + This man page is correct for Samba versions from 3.5.0 to 4.0.6. -- cgit