docs: Update doc to use absolute path for 'dedicated keytab file'
[sfrench/samba-autobuild/.git] / docs-xml / manpages / vfs_offline.8.xml
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
3 <refentry id="vfs_offline.8">
4
5 <refmeta>
6         <refentrytitle>vfs_offline</refentrytitle>
7         <manvolnum>8</manvolnum>
8         <refmiscinfo class="source">Samba</refmiscinfo>
9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
10         <refmiscinfo class="version">4.6</refmiscinfo>
11 </refmeta>
12
13
14 <refnamediv>
15         <refname>vfs_offline</refname>
16         <refpurpose>Mark all files as offline</refpurpose>
17 </refnamediv>
18
19 <refsynopsisdiv>
20         <cmdsynopsis>
21                 <command>vfs objects = offline</command>
22         </cmdsynopsis>
23 </refsynopsisdiv>
24
25 <refsect1>
26         <title>DESCRIPTION</title>
27
28         <para>This VFS module is part of the
29         <citerefentry><refentrytitle>samba</refentrytitle>
30         <manvolnum>7</manvolnum></citerefentry> suite.</para>
31
32         <para>The <command>vfs_offline</command> module marks all files
33         in the share as having the offline DOS attribute.</para>
34
35         <para>Files with the offline DOS attribute are handled differently
36         by the Windows SMB client, as well as by Windows Explorer. In
37         particular, Windows Explorer does not read those files for the sole
38         purpose of drawing a thumbnail, as it normally does. This can
39         improve user experience with some remote file systems.</para>
40
41 </refsect1>
42
43 <refsect1>
44         <title>EXAMPLES</title>
45
46         <para>Mark all files in a share as offline:</para>
47
48 <programlisting>
49         <smbconfsection name="[remote]"/>
50         <smbconfoption name="vfs objects">offline</smbconfoption>
51 </programlisting>
52
53 </refsect1>
54
55 <refsect1>
56         <title>VERSION</title>
57
58         <para>This man page is correct for version 4.4 of the Samba suite.
59         </para>
60 </refsect1>
61
62 <refsect1>
63         <title>AUTHOR</title>
64
65         <para>The original Samba software and related utilities
66         were created by Andrew Tridgell. Samba is now developed
67         by the Samba Team as an Open Source project similar
68         to the way the Linux kernel is developed.</para>
69
70 </refsect1>
71
72 </refentry>