Debian Codegraph @

upstream/opensuse-tumbleweed/man8/vfs_catia.8

raw
1 '\" t
2 .\" Title: vfs_catia
3 .\" Author: [see the "AUTHOR" section]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\" Date: 05/26/2026
6 .\" Manual: System Administration tools
7 .\" Source: Samba 4.23.8-git.477.f78166bceedSUSE-oS16.9-x86_64
8 .\" Language: English
9 .\"
10 .TH "VFS_CATIA" "8" "05/26/2026" "Samba 4\&.23\&.8\-git\&.477\&.f78166bcee" "System Administration tools"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 vfs_catia \- translate illegal characters in Catia filenames
32 .SH "SYNOPSIS"
33 .HP \w'\ 'u
34 vfs objects = catia
35 .SH "DESCRIPTION"
36 .PP
37 This VFS module is part of the
38 \fBsamba\fR(7)
39 suite\&.
40 .PP
41 The Catia CAD package commonly creates filenames that use characters that are illegal in CIFS filenames\&. The
42 vfs_catia
43 VFS module implements a character mapping so that these files can be shared with CIFS clients\&.
44 .PP
45 This module is stackable\&.
46 .PP
47 The parameter "catia:mappings" specifies the mapping on a per\-character basis, see below\&.
48 .SH "OPTIONS"
49 .PP
50 catia:mappings = SERVER_HEX_CHAR:CLIENT_HEX_CHAR
51 .RS 4
52 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\&.
53 .sp
54 The same mapping occurs in the opposite direction\&. Multiple character mappings are separated by a comma\&.
55 .RE
56 .SH "EXAMPLES"
57 .PP
58 Map server\-side quotation\-marks (") to client\-side diaeresis (\(ad) on filenames in the [CAD] share:
59 .sp
60 .if n \{\
61 .RS 4
62 .\}
63 .nf
64 \fI[CAD]\fR
65 \m[blue]\fBpath = /data/cad\fR\m[]
66 \m[blue]\fBvfs objects = catia\fR\m[]
67 \m[blue]\fBcatia:mappings = 0x22:0xa8\fR\m[]
68 .fi
69 .if n \{\
70 .RE
71 .\}
72 .PP
73 Perform comprehensive mapping of common Catia filename characters:
74 .sp
75 .if n \{\
76 .RS 4
77 .\}
78 .nf
79 \fI[CAD]\fR
80 \m[blue]\fBpath = /data/cad\fR\m[]
81 \m[blue]\fBvfs objects = catia\fR\m[]
82 \m[blue]\fBcatia:mappings = 0x22:0xa8,0x2a:0xa4,0x2f:0xf8,0x3a:0xf7,0x3c:0xab,0x3e:0xbb,0x3f:0xbf,0x5c:0xff,0x7c:0xa6\fR\m[]
83 .fi
84 .if n \{\
85 .RE
86 .\}
87 .PP
88 Server\-side filename to be translated (Note that the path delimiter "/" is not used here):
89 .PP
90 a\ea:a*a?a"a<a>a|a
91 .PP
92 Resulting filename, as seen by the client:
93 .PP
94 aÿa\(dia\(Csa\(r?a\(ada\(Foa\(Fca\(bba
95 .SH "CAVEATS"
96 .PP
97 Character mapping must work in BOTH directions (server \-> client and client \-> server) to get unique and existing file names!
98 .PP
99 A NOT working example:
100 .sp
101 .if n \{\
102 .RS 4
103 .\}
104 .nf
105 \fI[CAD]\fR
106 \m[blue]\fBpath = /data/cad\fR\m[]
107 \m[blue]\fBvfs objects = catia\fR\m[]
108 \m[blue]\fBcatia:mappings = 0x3a:0x5f\fR\m[]
109 .fi
110 .if n \{\
111 .RE
112 .\}
113 .PP
114 Here the colon ":" is mapped to the underscore "_"\&.
115 .PP
116 Assuming a server\-side filename "a:should_work", which is translated to "a_should_work" for the client\&.
117 .PP
118 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\&.
119 .SH "VERSION"
120 .PP
121 This man page is part of Samba versions from 3\&.5\&.0 to 4\&.0\&.6\&.
122 .SH "AUTHOR"
123 .PP
124 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\&.
125 .PP
126 New version written by Guenter Kukkukk kukks@samba\&.org