sin/samba-mirror
1
0
Fork 0
mirror of https://github.com/samba-team/samba.git synced 2025-08-04 08:22:08 +03:00
Code Activity

vfs_offline: add documentation

Browse Source 
Signed-off-by: Uri Simchoni <uri@samba.org>
Reviewed-by: Jeremy Allison <jra@samba.org>

Autobuild-User(master): Jeremy Allison <jra@samba.org>
Autobuild-Date(master): Thu Nov  5 01:22:48 CET 2015 on sn-devel-104
This commit is contained in:
Uri Simchoni
2015-11-04 21:18:20 +02:00
committed by Jeremy Allison
parent b3f3ffe35d
commit 77eb8e0a4b
2 changed files with 73 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

72
docs-xml/manpages/vfs_offline.8.xml Normal file
View File

@ -0,0 +1,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">4.4</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 correct for version 4.4 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>

1
docs-xml/wscript_build
View File

@ -68,6 +68,7 @@ manpages='''
manpages/vfs_linux_xfs_sgid.8
manpages/vfs_media_harmony.8
manpages/vfs_netatalk.8
manpages/vfs_offline.8
manpages/vfs_prealloc.8
manpages/vfs_preopen.8
manpages/vfs_readahead.8