Go to main content

man pages section 8: System Administration Commands

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

vfs_catia (8)

Name

vfs_catia - translate illegal characters in Catia filenames

Synopsis

vfs objects = catia

Description

System Administration tools                                       VFS_CATIA(8)



NAME
       vfs_catia - translate illegal characters in Catia filenames

SYNOPSIS
       vfs objects = catia

DESCRIPTION
       This VFS module is part of the samba(7) suite.

       The Catia CAD package commonly creates filenames that use characters
       that are illegal in CIFS filenames. The vfs_catia VFS module implements
       a character mapping so that these files can be shared with CIFS
       clients.

       This module is stackable.

       The parameter "catia:mappings" specifies the mapping on a per-character
       basis, see below.

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
       Map server-side quotation-marks (") to client-side diaeresis () on
       filenames in the [CAD] share:

                   [CAD]
                path = /data/cad
                vfs objects = catia
                catia:mappings = 0x22:0xa8

       Perform comprehensive mapping of common Catia filename characters:

                   [CAD]
                path = /data/cad
                vfs objects = catia
                catia:mappings = 0x22:0xa8,0x2a:0xa4,0x2f:0xf8,0x3a:0xf7,0x3c:0xab,0x3e:0xbb,0x3f:0xbf,0x5c:0xff,0x7c:0xa6

       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 filename, as seen by the client:

       aaaaaaaaa

CAVEATS
       Character mapping must work in BOTH directions (server -> client and
       client -> server) to get unique and existing file names!

       A NOT working example:

                   [CAD]
                path = /data/cad
                vfs objects = catia
                catia:mappings = 0x3a:0x5f

       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 part of Samba versions from 3.5.0 to 4.0.6.

AUTHOR
       The original Samba software and related utilities 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.

       New version written by Guenter Kukkukk kukks@samba.org



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+-----------------------+
       |ATTRIBUTE TYPE |   ATTRIBUTE VALUE     |
       +---------------+-----------------------+
       |Availability   | service/network/samba |
       +---------------+-----------------------+
       |Stability      | Volatile              |
       +---------------+-----------------------+

NOTES
       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       https://download.samba.org/pub/samba/stable/samba-4.13.17.tar.gz.

       Further information about this software can be found on the open source
       community website at http://www.samba.org/.



Samba 4.13.17                     06/28/2022                      VFS_CATIA(8)