From 6fb300f7b44cc6eb83e10b7272c2e08c150e05ba Mon Sep 17 00:00:00 2001
From: Karolin Seeger <kseeger@samba.org>
Date: Fri, 9 Aug 2013 10:57:51 +0200
Subject: docs: Add basic man page for vfs_syncops.

Fix bug #7364 - man vfs_syncops missing.

Signed-off-by: Karolin Seeger <kseeger@samba.org>
Reviewed-by: David Disseldorp <ddiss@samba.org>

Autobuild-User(master): David Disseldorp <ddiss@samba.org>
Autobuild-Date(master): Fri Aug  9 13:19:12 CEST 2013 on sn-devel-104
---
 docs-xml/manpages/vfs_syncops.8.xml | 99 +++++++++++++++++++++++++++++++++++++
 1 file changed, 99 insertions(+)
 create mode 100644 docs-xml/manpages/vfs_syncops.8.xml

(limited to 'docs-xml')

diff --git a/docs-xml/manpages/vfs_syncops.8.xml b/docs-xml/manpages/vfs_syncops.8.xml
new file mode 100644
index 0000000000..ccb0b678c3
--- /dev/null
+++ b/docs-xml/manpages/vfs_syncops.8.xml
@@ -0,0 +1,99 @@
+<?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_syncops.8">
+
+<refmeta>
+	<refentrytitle>vfs_syncops</refentrytitle>
+	<manvolnum>8</manvolnum>
+	<refmiscinfo class="source">Samba</refmiscinfo>
+	<refmiscinfo class="manual">System Administration tools</refmiscinfo>
+	<refmiscinfo class="version">4.1</refmiscinfo>
+</refmeta>
+
+
+<refnamediv>
+	<refname>vfs_syncops</refname>
+	<refpurpose>Ensure meta data operations are performed synchronously.</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+	<cmdsynopsis>
+		<command>vfs objects = syncops</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>
+	Some filesystems (even some journaled filesystems) require that a
+	fsync() be performed on many meta data operations to ensure that the
+	operation is guaranteed to remain in the filesystem after a power
+	failure. This is particularly important for some cluster filesystems
+	which are participating in a node failover system with clustered
+	Samba. On those filesystems the <command>vfs_syncops</command> VFS module
+	provides a way to perform those	operations safely.
+	</para>
+
+	<para>This module is stackable.</para>
+
+</refsect1>
+
+<refsect1>
+	<title>CONFIGURATION</title>
+
+	<para>
+	Most of the performance loss with the <command>vfs_syncops</command>
+	VFS module is in fsync on close(). You can disable that with
+	<command>syncops:onclose = no</command> that can be set either globally
+	or per share.
+	</para>
+
+	<para>
+	On certain filesystems that only require the last data written to be
+	fsync()'ed, you can disable the metadata synchronization of this module with
+	<command>syncops:onmeta = no</command>. This option can be set either
+	globally or per share.
+	</para>
+
+	<para>
+	The <command>vfs_syncops</command> VFS module can also be disabled
+	completely for a share with <command>syncops:disable = true</command>.
+	</para>
+</refsect1>
+
+<refsect1>
+	<title>EXAMPLES</title>
+
+	<para>Add syncops functionality for [share]:</para>
+<programlisting>
+        <smbconfsection name="[share]"/>
+	<smbconfoption name="path">/data/share</smbconfoption>
+	<smbconfoption name="vfs objects">syncops</smbconfoption>
+	<smbconfoption name="syncops:onclose">no</smbconfoption>
+</programlisting>
+
+</refsect1>
+
+<refsect1>
+	<title>VERSION</title>
+
+	<para>This man page is correct for version 4.1.0 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>
-- 
cgit