summaryrefslogtreecommitdiff
path: root/docs-xml/manpages/vfs_offline.8.xml
blob: e278f208ef76e038822d6171e0ef3c4ec6365cd8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
<refentry id="vfs_offline.8">

<refmeta>
	<refentrytitle>vfs_offline</refentrytitle>
	<manvolnum>8</manvolnum>
	<refmiscinfo class="source">Samba</refmiscinfo>
	<refmiscinfo class="manual">System Administration tools</refmiscinfo>
	<refmiscinfo class="version">&doc.version;</refmiscinfo>
</refmeta>


<refnamediv>
	<refname>vfs_offline</refname>
	<refpurpose>Mark all files as offline</refpurpose>
</refnamediv>

<refsynopsisdiv>
	<cmdsynopsis>
		<command>vfs objects = offline</command>
	</cmdsynopsis>
</refsynopsisdiv>

<refsect1>
	<title>DESCRIPTION</title>

	<para>This VFS module is part of the
	<citerefentry><refentrytitle>samba</refentrytitle>
	<manvolnum>7</manvolnum></citerefentry> suite.</para>

	<para>The <command>vfs_offline</command> module marks all files
	in the share as having the offline DOS attribute.</para>

	<para>Files with the offline DOS attribute are handled differently
	by the Windows SMB client, as well as by Windows Explorer. In
	particular, Windows Explorer does not read those files for the sole
	purpose of drawing a thumbnail, as it normally does. This can
	improve user experience with some remote file systems.</para>

</refsect1>

<refsect1>
	<title>EXAMPLES</title>

	<para>Mark all files in a share as offline:</para>

<programlisting>
        <smbconfsection name="[remote]"/>
	<smbconfoption name="vfs objects">offline</smbconfoption>
</programlisting>

</refsect1>

<refsect1>
	<title>VERSION</title>

	<para>This man page is part of version &doc.version; of the Samba suite.
	</para>
</refsect1>

<refsect1>
	<title>AUTHOR</title>

	<para>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.</para>

</refsect1>

</refentry>