Debian Codegraph @

upstream/opensuse-tumbleweed/man8/vfs_worm.8

raw
1 '\" t
2 .\" Title: vfs_worm
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_WORM" "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_worm \- disallows writes for older file
32 .SH "SYNOPSIS"
33 .HP \w'\ 'u
34 vfs objects = worm
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_worm
43 module controls the writability of files and folders depending on their change time and a adjustable grace period\&.
44 .PP
45 If the change time of a file or directory is older than the specified grace period, the write access will be denied, independent of further access controls (e\&.g\&. by the filesystem)\&.
46 .PP
47 In the case that the grace period is not exceed, the worm module will not impact any access controls\&.
48 .SH "OPTIONS"
49 .PP
50 worm:grace_period = SECONDS
51 .RS 4
52 Period in seconds which defines the time how long the write access should be handled by the normal access controls\&. After this grace period the file or directory becomes read only\&.
53 .RE
54 .SH "EXAMPLES"
55 .PP
56 Deny the write access to files and folders, which are older than five minutes (300 seconds):
57 .sp
58 .if n \{\
59 .RS 4
60 .\}
61 .nf
62 \fI[wormshare]\fR
63 \m[blue]\fBvfs objects = worm\fR\m[]
64 \m[blue]\fBworm:grace_period = 300\fR\m[]
65 .fi
66 .if n \{\
67 .RE
68 .\}
69 .SH "VERSION"
70 .PP
71 This man page is part of version 4\&.23\&.8\-git\&.477\&.f78166bceedSUSE\-oS16\&.9\-x86_64 of the Samba suite\&.
72 .SH "AUTHOR"
73 .PP
74 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\&.