Changeset 231 for branches/samba-3.2.x/docs/manpages/vfs_commit.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_commit.8 (modified) (5 diffs)

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

@@ -1 +1 @@
 .\"     Title: vfs_commit
-.\"    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_COMMIT" "8" "12/19/2008" "Samba 3\.2" "System Administration tools"
+.TH "VFS_COMMIT" "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_commit - flush dirty data at specified intervals
-.SH "SYNOPSIS"
-.HP 1
-vfs objects = commit
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "Name"
+vfs_commit \- flush dirty data at specified intervals
+.SH "Synopsis"
+.fam C
+.HP \w'\ 'u
+\FCvfs objects = commit\F[]
+.fam
 .SH "DESCRIPTION"
 .PP
 This VFS module is part of the
 \fBsamba\fR(7)
-suite\.
+suite\&.
 .PP
 The
-vfs_commit
-VFS module keeps track of the amount of data written to a file and synchronizes it to disk when a specified amount accumulates\.
-.PP
-vfs_commit
-is useful in two circumstances\. First, if you have very precious data, the impact of unexpected power loss can be minimized by a small commit:dthresh value\. Secondly, write performance can be improved on some systems by flushing file data early and at regular intervals\.
-.PP
-This module is stackable\.
+\FCvfs_commit\F[]
+VFS module keeps track of the amount of data written to a file and synchronizes it to disk when a specified amount accumulates\&.
+.PP
+\FCvfs_commit\F[]
+is useful in two circumstances\&. First, if you have very precious data, the impact of unexpected power loss can be minimized by a small commit:dthresh value\&. Secondly, write performance can be improved on some systems by flushing file data early and at regular intervals\&.
+.PP
+This module is stackable\&.
 .SH "OPTIONS"
 .PP
 commit:dthresh = BYTES
 .RS 4
-Synchronize file data each time the specified number of bytes has been written\.
+Synchronize file data each time the specified number of bytes has been written\&.
 .sp
 The following suffixes may be applied to BYTES:
@@ -46 +204 @@
 .IP \(bu 2.3
 .\}
-K
+\FCK\F[]
 \- BYTES is a number of kilobytes
 .RE
@@ -58 +216 @@
 .IP \(bu 2.3
 .\}
-M
+\FCM\F[]
 \- BYTES is a number of megabytes
 .RE
@@ -70 +228 @@
 .IP \(bu 2.3
 .\}
-G
+\FCG\F[]
 \- BYTES is a number of gigabytes
 .sp
@@ -79 +237 @@
 Synchronize the file data on the [precious] share after every 512 kilobytes (524288 bytes) of data is written:
 .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[precious]\fR
-        \fIpath = /data/precious\fR
-        \fIvfs objects = commit\fR
-        \fIcommit:dthresh = 512K\fR
-.fi
-.RE
+        \m[blue]\fBpath = /data/precious\fR\m[]
+        \m[blue]\fBvfs objects = commit\fR\m[]
+        \m[blue]\fBcommit:dthresh = 512K\fR\m[]
+.EB lightgray adjust-for-leading-newline
+.if t \{\
+.sp 1
+.\}
+.fi
+.fam
+.ps +1
+.if n \{\
+.RE
+.\}
 .SH "CAVEATS"
 .PP
 On some systems, the data synchronization performed by
-commit
-may reduce performance\.
+\FCcommit\F[]
+may reduce performance\&.
 .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\.
+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\&.