Debian Codegraph @

upstream/opensuse-tumbleweed/man8/vfs_readonly.8

raw
1 '\" t
2 .\" Title: vfs_readonly
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_READONLY" "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_readonly \- make a Samba share read only for a specified time period
32 .SH "SYNOPSIS"
33 .HP \w'\ 'u
34 vfs objects = readonly
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_readonly
43 VFS module marks a share as read only for all clients connecting within the configured time period\&. Clients connecting during this time will be denied write access to all files in the share, irrespective of their actual access privileges\&.
44 .PP
45 This module is stackable\&.
46 .SH "OPTIONS"
47 .PP
48 readonly:period = BEGIN, END
49 .RS 4
50 Only mark the share as read only if the client connection was made between the times marked by the BEGIN and END date specifiers\&. The syntax of these date specifiers is the same as that accepted by the \-d option of GNU
51 \fBdate\fR(1)\&.
52 .RE
53 .SH "EXAMPLES"
54 .PP
55 Mark all shares read only:
56 .sp
57 .if n \{\
58 .RS 4
59 .\}
60 .nf
61 \fI[global]\fR
62 \m[blue]\fBvfs objects = readonly\fR\m[]
63 .fi
64 .if n \{\
65 .RE
66 .\}
67 .PP
68 Mark the [backup] share as read only during business hours:
69 .sp
70 .if n \{\
71 .RS 4
72 .\}
73 .nf
74 \fI[backup]\fR
75 \m[blue]\fBpath = /readonly\fR\m[]
76 \m[blue]\fBvfs objects = readonly\fR\m[]
77 \m[blue]\fBreadonly:period = readonly:period = "today 9:00","today 17:00"\fR\m[]
78 .fi
79 .if n \{\
80 .RE
81 .\}
82 .SH "VERSION"
83 .PP
84 This man page is part of version 4\&.23\&.8\-git\&.477\&.f78166bceedSUSE\-oS16\&.9\-x86_64 of the Samba suite\&.
85 .SH "AUTHOR"
86 .PP
87 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\&.