source: branches/samba-3.3.x/docs/manpages/vfs_prealloc.8

Last change on this file was 411, checked in by Herwig Bauernfeind, 15 years ago

Update Samba 3.3.x to 3.3.11

File size: 6.1 KB
Line 
1.\" Title: vfs_prealloc
2.\" Author: [see the "AUTHOR" section]
3.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
4.\" Date: 02/22/2010
5.\" Manual: System Administration tools
6.\" Source: Samba 3.3
7.\" Language: English
8.\"
9.TH "VFS_PREALLOC" "8" "02/22/2010" "Samba 3\&.3" "System Administration tools"
10.\" -----------------------------------------------------------------
11.\" * (re)Define some macros
12.\" -----------------------------------------------------------------
13.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14.\" toupper - uppercase a string (locale-aware)
15.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16.de toupper
17.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
18\\$*
19.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
20..
21.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22.\" SH-xref - format a cross-reference to an SH section
23.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24.de SH-xref
25.ie n \{\
26.\}
27.toupper \\$*
28.el \{\
29\\$*
30.\}
31..
32.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33.\" SH - level-one heading that works better for non-TTY output
34.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
35.de1 SH
36.\" put an extra blank line of space above the head in non-TTY output
37.if t \{\
38.sp 1
39.\}
40.sp \\n[PD]u
41.nr an-level 1
42.set-an-margin
43.nr an-prevailing-indent \\n[IN]
44.fi
45.in \\n[an-margin]u
46.ti 0
47.HTML-TAG ".NH \\n[an-level]"
48.it 1 an-trap
49.nr an-no-space-flag 1
50.nr an-break-flag 1
51\." make the size of the head bigger
52.ps +3
53.ft B
54.ne (2v + 1u)
55.ie n \{\
56.\" if n (TTY output), use uppercase
57.toupper \\$*
58.\}
59.el \{\
60.nr an-break-flag 0
61.\" if not n (not TTY), use normal case (not uppercase)
62\\$1
63.in \\n[an-margin]u
64.ti 0
65.\" if not n (not TTY), put a border/line under subheading
66.sp -.6
67\l'\n(.lu'
68.\}
69..
70.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
71.\" SS - level-two heading that works better for non-TTY output
72.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
73.de1 SS
74.sp \\n[PD]u
75.nr an-level 1
76.set-an-margin
77.nr an-prevailing-indent \\n[IN]
78.fi
79.in \\n[IN]u
80.ti \\n[SN]u
81.it 1 an-trap
82.nr an-no-space-flag 1
83.nr an-break-flag 1
84.ps \\n[PS-SS]u
85\." make the size of the head bigger
86.ps +2
87.ft B
88.ne (2v + 1u)
89.if \\n[.$] \&\\$*
90..
91.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
92.\" BB/BE - put background/screen (filled box) around block of text
93.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
94.de BB
95.if t \{\
96.sp -.5
97.br
98.in +2n
99.ll -2n
100.gcolor red
101.di BX
102.\}
103..
104.de EB
105.if t \{\
106.if "\\$2"adjust-for-leading-newline" \{\
107.sp -1
108.\}
109.br
110.di
111.in
112.ll
113.gcolor
114.nr BW \\n(.lu-\\n(.i
115.nr BH \\n(dn+.5v
116.ne \\n(BHu+.5v
117.ie "\\$2"adjust-for-leading-newline" \{\
118\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
119.\}
120.el \{\
121\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
122.\}
123.in 0
124.sp -.5v
125.nf
126.BX
127.in
128.sp .5v
129.fi
130.\}
131..
132.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
133.\" BM/EM - put colored marker in margin next to block of text
134.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
135.de BM
136.if t \{\
137.br
138.ll -2n
139.gcolor red
140.di BX
141.\}
142..
143.de EM
144.if t \{\
145.br
146.di
147.ll
148.gcolor
149.nr BH \\n(dn
150.ne \\n(BHu
151\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
152.in 0
153.nf
154.BX
155.in
156.fi
157.\}
158..
159.\" -----------------------------------------------------------------
160.\" * set default formatting
161.\" -----------------------------------------------------------------
162.\" disable hyphenation
163.nh
164.\" disable justification (adjust text to left margin only)
165.ad l
166.\" -----------------------------------------------------------------
167.\" * MAIN CONTENT STARTS HERE *
168.\" -----------------------------------------------------------------
169.SH "Name"
170vfs_prealloc \- preallocate matching files to a predetermined size
171.SH "Synopsis"
172.fam C
173.HP \w'\ 'u
174\FCvfs objects = prealloc\F[]
175.fam
176.SH "DESCRIPTION"
177.PP
178This VFS module is part of the
179\fBsamba\fR(7)
180suite\&.
181.PP
182The
183\FCvfs_prealloc\F[]
184VFS module preallocates files to a specified size each time a new file is created\&. This is useful in environments where files are of a predetermined size will be written to a disk subsystem where extending file allocations is expensive\&.
185.PP
186This module is stackable\&.
187.SH "OPTIONS"
188.PP
189prealloc:EXT = BYTES
190.RS 4
191Preallocate all files with the extension EXT to the size specified by BYTES\&.
192.sp
193The following suffixes may be applied to BYTES:
194.sp
195.RS 4
196.ie n \{\
197\h'-04'\(bu\h'+03'\c
198.\}
199.el \{\
200.sp -1
201.IP \(bu 2.3
202.\}
203\FCK\F[]
204\- BYTES is a number of kilobytes
205.RE
206.sp
207.RS 4
208.ie n \{\
209\h'-04'\(bu\h'+03'\c
210.\}
211.el \{\
212.sp -1
213.IP \(bu 2.3
214.\}
215\FCM\F[]
216\- BYTES is a number of megabytes
217.RE
218.sp
219.RS 4
220.ie n \{\
221\h'-04'\(bu\h'+03'\c
222.\}
223.el \{\
224.sp -1
225.IP \(bu 2.3
226.\}
227\FCG\F[]
228\- BYTES is a number of gigabytes
229.sp
230.RE
231.RE
232.SH "EXAMPLES"
233.PP
234A process writes TIFF files to a Samba share, and the is known these files will almost always be around 4 megabytes (4194304 bytes):
235.sp
236.if n \{\
237.RS 4
238.\}
239.fam C
240.ps -1
241.nf
242.if t \{\
243.sp -1
244.\}
245.BB lightgray adjust-for-leading-newline
246.sp -1
247
248 \fI[frames]\fR
249 \m[blue]\fBpath = /data/frames\fR\m[]
250 \m[blue]\fBvfs objects = prealloc\fR\m[]
251 \m[blue]\fBprealloc:tiff = 4M\fR\m[]
252.EB lightgray adjust-for-leading-newline
253.if t \{\
254.sp 1
255.\}
256.fi
257.fam
258.ps +1
259.if n \{\
260.RE
261.\}
262.SH "CAVEATS"
263.PP
264\FCvfs_prealloc\F[]
265is not supported on all platforms and filesystems\&. Currently only XFS filesystems on Linux and IRIX are supported\&.
266.SH "VERSION"
267.PP
268This man page is correct for version 3\&.0\&.25 of the Samba suite\&.
269.SH "AUTHOR"
270.PP
271The 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\&.
Note: See TracBrowser for help on using the repository browser.