Changeset 231 for branches/samba-3.2.x/docs/manpages/vfs_gpfs.8

Timestamp:

May 27, 2009, 9:08:03 AM (16 years ago)

Author:

Herwig Bauernfeind

Message:

Update 3.2 branch to 3.2.8 docs

File:

• branches/samba-3.2.x/docs/manpages/vfs_gpfs.8 (modified) (13 diffs)

branches/samba-3.2.x/docs/manpages/vfs_gpfs.8

@@ -1 +1 @@
 .\"     Title: vfs_gpfs
-.\"    Author: 
-.\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/>
-.\"      Date: 12/19/2008
+.\"    Author: [see the "AUTHOR" section]
+.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
+.\"      Date: 02/03/2009
 .\"    Manual: System Administration tools
 .\"    Source: Samba 3.2
+.\"  Language: English
 .\"
-.TH "VFS_GPFS" "8" "12/19/2008" "Samba 3\.2" "System Administration tools"
+.TH "VFS_GPFS" "8" "02/03/2009" "Samba 3\&.2" "System Administration tools"
+.\" -----------------------------------------------------------------
+.\" * (re)Define some macros
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" toupper - uppercase a string (locale-aware)
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de toupper
+.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
+\\$*
+.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" SH-xref - format a cross-reference to an SH section
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de SH-xref
+.ie n \{\
+.\}
+.toupper \\$*
+.el \{\
+\\$*
+.\}
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" SH - level-one heading that works better for non-TTY output
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de1 SH
+.\" put an extra blank line of space above the head in non-TTY output
+.if t \{\
+.sp 1
+.\}
+.sp \\n[PD]u
+.nr an-level 1
+.set-an-margin
+.nr an-prevailing-indent \\n[IN]
+.fi
+.in \\n[an-margin]u
+.ti 0
+.HTML-TAG ".NH \\n[an-level]"
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+\." make the size of the head bigger
+.ps +3
+.ft B
+.ne (2v + 1u)
+.ie n \{\
+.\" if n (TTY output), use uppercase
+.toupper \\$*
+.\}
+.el \{\
+.nr an-break-flag 0
+.\" if not n (not TTY), use normal case (not uppercase)
+\\$1
+.in \\n[an-margin]u
+.ti 0
+.\" if not n (not TTY), put a border/line under subheading
+.sp -.6
+\l'\n(.lu'
+.\}
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" SS - level-two heading that works better for non-TTY output
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de1 SS
+.sp \\n[PD]u
+.nr an-level 1
+.set-an-margin
+.nr an-prevailing-indent \\n[IN]
+.fi
+.in \\n[IN]u
+.ti \\n[SN]u
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.ps \\n[PS-SS]u
+\." make the size of the head bigger
+.ps +2
+.ft B
+.ne (2v + 1u)
+.if \\n[.$] \&\\$*
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" BB/BE - put background/screen (filled box) around block of text
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de BB
+.if t \{\
+.sp -.5
+.br
+.in +2n
+.ll -2n
+.gcolor red
+.di BX
+.\}
+..
+.de EB
+.if t \{\
+.if "\\$2"adjust-for-leading-newline" \{\
+.sp -1
+.\}
+.br
+.di
+.in
+.ll
+.gcolor
+.nr BW \\n(.lu-\\n(.i
+.nr BH \\n(dn+.5v
+.ne \\n(BHu+.5v
+.ie "\\$2"adjust-for-leading-newline" \{\
+\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
+.\}
+.el \{\
+\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
+.\}
+.in 0
+.sp -.5v
+.nf
+.BX
+.in
+.sp .5v
+.fi
+.\}
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" BM/EM - put colored marker in margin next to block of text
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de BM
+.if t \{\
+.br
+.ll -2n
+.gcolor red
+.di BX
+.\}
+..
+.de EM
+.if t \{\
+.br
+.di
+.ll
+.gcolor
+.nr BH \\n(dn
+.ne \\n(BHu
+\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
+.in 0
+.nf
+.BX
+.in
+.fi
+.\}
+..
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
 .\" disable hyphenation
 .nh
 .\" disable justification (adjust text to left margin only)
 .ad l
-.SH "NAME"
-vfs_gpfs - gpfs specific samba extensions like acls and prealloc
-.SH "SYNOPSIS"
-.HP 1
-vfs objects = gpfs
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "Name"
+vfs_gpfs \- gpfs specific samba extensions like acls and prealloc
+.SH "Synopsis"
+.fam C
+.HP \w'\ 'u
+\FCvfs objects = gpfs\F[]
+.fam
 .SH "DESCRIPTION"
 .PP
 This VFS module is part of the
 \fBsamba\fR(7)
-suite\.
+suite\&.
 .PP
 The
-gpfs
-VFS module is the home for all gpfs extensions that Samba requires for proper integration with GPFS\. It uses the GPL library interfaces provided by GPFS\.
+\FCgpfs\F[]
+VFS module is the home for all gpfs extensions that Samba requires for proper integration with GPFS\&. It uses the GPL library interfaces provided by GPFS\&.
 .PP
 Currently the gpfs vfs module provides extensions in following areas :
@@ -62 +220 @@
 .RE
 .PP
-NOTE: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\.
-.PP
-This module is stackable\.
+\FCNOTE:\F[]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\&.
+.PP
+This module is stackable\&.
 .SH "OPTIONS"
 .PP
 nfs4:mode = [ simple | special ]
 .RS 4
-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\.
+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\&.
 .sp
 The following MODEs are understood by the module:
@@ -81 +239 @@
 .IP \(bu 2.3
 .\}
-simple(default)
+\FCsimple(default)\F[]
 \- do not use special IDs in GPFS ACEs
 .RE
@@ -93 +251 @@
 .IP \(bu 2.3
 .\}
-special
-\- use special IDs in GPFS ACEs\.
+\FCspecial\F[]
+\- use special IDs in GPFS ACEs\&.
 .sp
 .RE
@@ -101 +259 @@
 nfs4:acedup = [dontcare|reject|ignore|merge]
 .RS 4
-This parameter configures how Samba handles duplicate ACEs encountered in GPFS ACLs\. GPFS allows/creates duplicate ACE for different bits for same ID\.
+This parameter configures how Samba handles duplicate ACEs encountered in GPFS ACLs\&. GPFS allows/creates duplicate ACE for different bits for same ID\&.
 .sp
 Following is the behaviour of Samba for different values :
@@ -113 +271 @@
 .IP \(bu 2.3
 .\}
-dontcare (default)
+\FCdontcare (default)\F[]
 \- copy the ACEs as they come
 .RE
@@ -125 +283 @@
 .IP \(bu 2.3
 .\}
-reject
+\FCreject\F[]
 \- stop operation and exit with error on ACL set op
 .RE
@@ -137 +295 @@
 .IP \(bu 2.3
 .\}
-ignore
+\FCignore\F[]
 \- don\'t include the second matching ACE
 .RE
@@ -149 +307 @@
 .IP \(bu 2.3
 .\}
-merge
-\- bitwise OR the 2 ace\.flag fields and 2 ace\.mask fields of the 2 duplicate ACEs into 1 ACE
+\FCmerge\F[]
+\- bitwise OR the 2 ace\&.flag fields and 2 ace\&.mask fields of the 2 duplicate ACEs into 1 ACE
 .sp
 .RE
@@ -157 +315 @@
 nfs4:chown = [yes|no]
 .RS 4
-This parameter allows enabling or disabling the chown supported by the underlying filesystem\. This parameter should be enabled with care as it might leave your system insecure\.
-.sp
-Some filesystems allow chown as a) giving b) stealing\. It is the latter that is considered a risk\.
+This parameter allows enabling or disabling the chown supported by the underlying filesystem\&. This parameter should be enabled with care as it might leave your system insecure\&.
+.sp
+Some filesystems allow chown as a) giving b) stealing\&. It is the latter that is considered a risk\&.
 .sp
 Following is the behaviour of Samba for different values :
@@ -171 +329 @@
 .IP \(bu 2.3
 .\}
-yes
+\FCyes\F[]
 \- Enable chown if as supported by the under filesystem
 .RE
@@ -183 +341 @@
 .IP \(bu 2.3
 .\}
-no (default)
+\FCno (default)\F[]
 \- Disable chown
 .sp
@@ -192 +350 @@
 A GPFS mount can be exported via Samba as follows :
 .sp
-.RS 4
+.if n \{\
+.RS 4
+.\}
+.fam C
+.ps -1
 .nf
+.if t \{\
+.sp -1
+.\}
+.BB lightgray adjust-for-leading-newline
+.sp -1
+
         \fI[samba_gpfs_share]\fR
-        \fIvfs objects = gpfs\fR
-        \fIpath = /test/gpfs_mount\fR
-        \fInfs4: mode = special\fR
-        \fInfs4: acedup = merge\fR
-.fi
-.RE
+        \m[blue]\fBvfs objects = gpfs\fR\m[]
+        \m[blue]\fBpath = /test/gpfs_mount\fR\m[]
+        \m[blue]\fBnfs4: mode = special\fR\m[]
+        \m[blue]\fBnfs4: acedup = merge\fR\m[]
+.EB lightgray adjust-for-leading-newline
+.if t \{\
+.sp 1
+.\}
+.fi
+.fam
+.ps +1
+.if n \{\
+.RE
+.\}
 .SH "CAVEATS"
 .PP
 The gpfs gpl libraries are required by
-gpfs
-VFS module during both compilation and runtime\. Also this VFS module is tested to work on SLES 9/10 and RHEL 4\.4
+\FCgpfs\F[]
+VFS module during both compilation and runtime\&. Also this VFS module is tested to work on SLES 9/10 and RHEL 4\&.4
 .SH "VERSION"
 .PP
-This man page is correct for version 3\.0\.25 of the Samba suite\.
+This man page is correct for version 3\&.0\&.25 of the Samba suite\&.
 .SH "AUTHOR"
 .PP
-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\.
-.PP
-The GPFS VFS module was created with contributions from Volker Lendecke and the developers at IBM\.
+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\&.
+.PP
+The GPFS VFS module was created with contributions from Volker Lendecke and the developers at IBM\&.
 .PP
 This manpage was created by the IBM FSCC team