source: vendor/current/docs/manpages/vfs_catia.8

Last change on this file was 989, checked in by Silvan Scherrer, 9 years ago

Samba Server: update vendor to version 4.4.7

File size: 4.0 KB
Line 
1'\" t
2.\" Title: vfs_catia
3.\" Author: [see the "AUTHOR" section]
4.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
5.\" Date: 10/25/2016
6.\" Manual: System Administration tools
7.\" Source: Samba 4.4
8.\" Language: English
9.\"
10.TH "VFS_CATIA" "8" "10/25/2016" "Samba 4\&.4" "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"
31vfs_catia \- translate illegal characters in Catia filenames
32.SH "SYNOPSIS"
33.HP \w'\ 'u
34vfs objects = catia
35.SH "DESCRIPTION"
36.PP
37This VFS module is part of the
38\fBsamba\fR(7)
39suite\&.
40.PP
41The Catia CAD package commonly creates filenames that use characters that are illegal in CIFS filenames\&. The
42vfs_catia
43VFS module implements a character mapping so that these files can be shared with CIFS clients\&.
44.PP
45This module is stackable\&.
46.PP
47The parameter "catia:mappings" specifies the mapping on a per\-character basis, see below\&.
48.SH "OPTIONS"
49.PP
50catia:mappings = SERVER_HEX_CHAR:CLIENT_HEX_CHAR
51.RS 4
52SERVER_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
54The same mapping occurs in the opposite direction\&. Multiple character mappings are separated by a comma\&.
55.RE
56.SH "EXAMPLES"
57.PP
58Map 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
73Perform 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
88Server\-side filename to be translated (Note that the path delimiter "/" is not used here):
89.PP
90a\ea:a*a?a"a<a>a|a
91.PP
92Resulting filename, as seen by the client:
93.PP
94aÿa\(dia\(Csa\(r?a\(ada\(Foa\(Fca\(bba
95.SH "CAVEATS"
96.PP
97Character mapping must work in BOTH directions (server \-> client and client \-> server) to get unique and existing file names!
98.PP
99A 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
114Here the colon ":" is mapped to the underscore "_"\&.
115.PP
116Assuming a server\-side filename "a:should_work", which is translated to "a_should_work" for the client\&.
117.PP
118BUT 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
121This man page is correct for Samba versions from 3\&.5\&.0 to 4\&.0\&.6\&.
122.SH "AUTHOR"
123.PP
124The 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
126New version written by Guenter Kukkukk kukks@samba\&.org
Note: See TracBrowser for help on using the repository browser.