From f16afa9def2e5ad8b9149bc32e857b2f41b0179d Mon Sep 17 00:00:00 2001
From: Jim McDonough <jmcd@samba.org>
Date: Mon, 19 Mar 2007 18:29:04 +0000
Subject: [PATCH] Add manpage for gpfs module.  Thanks to Chetan Shringarpure
 <chetan.sh@in.ibm.com> (This used to be commit
 649b6fffcb531fef3d0952a2f1a43acd8ec7f6e1)

---
 docs/manpages-3/vfs_gpfs.8.xml | 139 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 139 insertions(+)
 create mode 100644 docs/manpages-3/vfs_gpfs.8.xml

diff --git a/docs/manpages-3/vfs_gpfs.8.xml b/docs/manpages-3/vfs_gpfs.8.xml
new file mode 100644
index 00000000000..b56b4dbaf4d
--- /dev/null
+++ b/docs/manpages-3/vfs_gpfs.8.xml
@@ -0,0 +1,139 @@
+<?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_gpfs.8">
+
+<refmeta>
+	<refentrytitle>vfs_gpfs</refentrytitle>
+	<manvolnum>8</manvolnum>
+</refmeta>
+
+
+<refnamediv>
+	<refname>vfs_gpfs</refname>
+	<refpurpose>gpfs specific samba extensions like acls and prealloc</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+	<cmdsynopsis>
+		<command>vfs objects = gpfs</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>gpfs</command> VFS module is the home
+	for all gpfs extensions that Samba requires for proper integration 
+	with GPFS. For this it utilizes the gpl-ed library interfaces provided by
+	GPFS team.
+	</para>
+	
+	<para>Currently the gpfs vfs module provides extensions in following areas :
+	<itemizedlist>
+	<listitem><para>NFSv4 ACL Interfaces with configurable options for gpfs</para></listitem>
+	<listitem><para>Kernel oplock support on GPFS</para></listitem>
+	</itemizedlist>
+	</para>
+	
+	<para><command>NOTE:</command>This module follows the posix-acl behaviour
+	and hence allows permission stealing via chown. Samba might allow at a later 
+	point in time, to restrict the chown via this module as such restrictions
+	are the responsibility of the underlying filesystem than of Samba.
+	</para>
+
+	<para>This module is stackable.</para>
+
+</refsect1>
+
+
+<refsect1>
+	<title>OPTIONS</title>
+
+	<variablelist>
+
+		<varlistentry>
+		
+		<term>nfs4:mode = [ simple | special ]</term>
+		<listitem>
+		<para>
+		Enable/Disable substitution of special ids on GPFS. This parameter
+		should not affect the windows users in anyway. It only ensures that Samba
+		sets the special ids - OWNER@ and GROUP@ ( mappings to simple uids ) 
+		that are relevant to GPFS.
+		</para>
+
+		<para>The following MODE are understood by the module:</para>
+		<itemizedlist>
+		<listitem><para><command>simple(default)</command> - do not use special IDs in GPFS ACEs</para></listitem>
+		<listitem><para><command>special</command> - use special IDs in GPFS ACEs. </para> </listitem>
+		</itemizedlist>
+		</listitem>
+
+		</varlistentry>
+
+		<varlistentry>
+		<term>nfs4:acedup = [dontcare|reject|ignore|merge]</term>
+		<para>
+		This parameter configures how Samba handles duplicate ACEs encountered in GPFS ACLs.
+		GPFS allows/creates duplicate ACE for different bits for same ID.
+		</para>
+		
+		<para>Following is the behaviour of Samba for different values :</para>
+		<itemizedlist>
+		<listitem><para><command>dontcare (default)</command> - copy the ACEs as they come</para></listitem>
+		<listitem><para><command>reject</command> - stop operation and exit with error on ACL set op</para></listitem>
+		<listitem><para><command>ignore</command> - don't include the second matching ACE</para></listitem>
+		<listitem><para><command>merge</command> - OR 2 ace.flag fields and 2 ace.mask fields of the 2 duplicate ACEs into 1 ACE</para></listitem>
+		</itemizedlist>
+		</varlistentry>
+
+	</variablelist>
+</refsect1>
+
+<refsect1>
+	<title>EXAMPLES</title>
+
+	<para>A GPFS mount can be exported via Samba as follows :</para>
+
+<programlisting>
+        <smbconfsection name="[samba_gpfs_share]"/>
+	<smbconfoption name="path">/test/gpfs_mount</smbconfoption>
+	<smbconfoption name="nfs4: mode">special</smbconfoption>
+	<smbconfoption name="nfs4: acedup">merge</smbconfoption>
+</programlisting>
+</refsect1>
+
+<refsect1>
+	<title>CAVEATS</title>
+	<para>The gpfs gpl libraries are required by <command>gpfs</command> VFS 
+	module during both compilation and runtime.
+	Also this VFS module is tested to work on SLES 9/10 and RHEL 4.4
+	</para>
+</refsect1>
+
+<refsect1>
+	<title>VERSION</title>
+	<para>This man page is correct for version 3.0.25 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>
+
+	<para>The GPFS VFS module was created with contributions from
+	Volker Lendecke and the developers at IBM.
+	</para>
+
+	<para> This manpage was created by the IBM FSCC team </para>
+</refsect1>
+
+</refentry>
-- 
2.11.4.GIT