A few updates to the gpfs manpage. Clarify some language, list setlease
[metze/samba/wip.git] / docs / manpages-3 / vfs_gpfs.8.xml
index b56b4dbaf4deedb8b93d5cb2d41064281b4af95f..6f012a8bc9fbd70571d93de7dccf42d766c8dccb 100644 (file)
 
        <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.
+       with GPFS. It uses the GPL library interfaces provided by GPFS.
        </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>NFSv4 ACL Interfaces with configurable options for GPFS</para></listitem>
        <listitem><para>Kernel oplock support on GPFS</para></listitem>
+       <listitem><para>Lease support on GPFS</para></listitem>
        </itemizedlist>
        </para>
        
                <term>nfs4:mode = [ simple | special ]</term>
                <listitem>
                <para>
-               Enable/Disable substitution of special ids on GPFS. This parameter
+               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 ) 
+               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>
+               <para>The following MODEs 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>
@@ -87,7 +87,7 @@
                <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>
+               <listitem><para><command>merge</command> - bitwise OR the 2 ace.flag fields and 2 ace.mask fields of the 2 duplicate ACEs into 1 ACE</para></listitem>
                </itemizedlist>
                </varlistentry>
 
 
 <programlisting>
         <smbconfsection name="[samba_gpfs_share]"/>
+       <smbconfoption name="vfs objects">gpfs</smbconfoption>
        <smbconfoption name="path">/test/gpfs_mount</smbconfoption>
        <smbconfoption name="nfs4: mode">special</smbconfoption>
        <smbconfoption name="nfs4: acedup">merge</smbconfoption>