Debian Codegraph @

upstream/opensuse-tumbleweed/man8/vfs_crossrename.8

raw
1 '\" t
2 .\" Title: vfs_crossrename
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_CROSSRENAME" "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_crossrename \- server side rename files across filesystem boundaries
32 .SH "SYNOPSIS"
33 .HP \w'\ 'u
34 vfs objects = crossrename
35 .SH "DESCRIPTION"
36 .PP
37 This VFS module is part of the
38 \fBsamba\fR(7)
39 suite\&.
40 .PP
41 The
42 vfs_crossrename
43 VFS module allows server side rename operations even if source and target are on different physical devices\&. A "move" in Explorer is usually a rename operation if it is inside of a single share or device\&. Usually such a rename operation returns NT_STATUS_NOT_SAME_DEVICE and the client has to move the file by manual copy and delete operations\&. If the rename by copy is done by the server this can be much more efficient\&. vfs_crossrename tries to do this server\-side cross\-device rename operation\&.
44 .PP
45 There are however limitations that this module currently does not solve:
46 .PP
47 .RS 4
48 .PP
49 The ACLs of files are not preserved,
50 .RE
51 .PP
52 .RS 4
53 .PP
54 meta data in EAs are not preserved,
55 .RE
56 .PP
57 .RS 4
58 .PP
59 renames of whole subdirectories cannot be done recursively, in that case we still return STATUS_NOT_SAME_DEVICE and let the client decide what to do,
60 .RE
61 .PP
62 .RS 4
63 .PP
64 rename operations of huge files can cause hangs on the client because clients expect a rename operation to return fast\&.
65 .RE
66 .PP
67 This module is not fully stackable\&. It can be combined with other modules, but should be the last module in the
68 vfs objects
69 list\&. It directly access the files in the OS filesystem\&.
70 .SH "OPTIONS"
71 .PP
72 crossrename:sizelimit = BYTES
73 .RS 4
74 server\-side cross\-device\-renames are only done for files if the filesize is not larger than the defined size in MiB to prevent timeouts\&. The default sizelimit is 20 (MiB)
75 .RE
76 .SH "EXAMPLES"
77 .PP
78 To add server\-side cross\-device renames inside of a share for all files sized up to 50MB:
79 .sp
80 .if n \{\
81 .RS 4
82 .\}
83 .nf
84 \fI[testshare]\fR
85 \m[blue]\fBpath = /data/mounts\fR\m[]
86 \m[blue]\fBvfs objects = crossrename\fR\m[]
87 \m[blue]\fBcrossrename:sizelimit = 50\fR\m[]
88 .fi
89 .if n \{\
90 .RE
91 .\}
92 .SH "VERSION"
93 .PP
94 This man page is part of version 4\&.23\&.8\-git\&.477\&.f78166bceedSUSE\-oS16\&.9\-x86_64 of the Samba suite\&.
95 .SH "AUTHOR"
96 .PP
97 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\&.