source: trunk-3.0/docs/manpages/vfs_cacheprime.8@ 102

Last change on this file since 102 was 44, checked in by Paul Smedley, 18 years ago

Update source to 3.0.25b

File size: 2.2 KB
Line 
1.\"Generated by db2man.xsl. Don't modify this, modify the source.
2.de Sh \" Subsection
3.br
4.if t .Sp
5.ne 5
6.PP
7\fB\\$1\fR
8.PP
9..
10.de Sp \" Vertical space (when we can't use .PP)
11.if t .sp .5v
12.if n .sp
13..
14.de Ip \" List item
15.br
16.ie \\n(.$>=3 .ne \\$3
17.el .ne 3
18.IP "\\$1" \\$2
19..
20.TH "VFS_CACHEPRIME" 8 "" "" ""
21.SH "NAME"
22vfs_cacheprime - prime the kernel file data cache
23.SH "SYNOPSIS"
24.HP 1
25vfs objects = cacheprime
26.SH "DESCRIPTION"
27.PP
28This VFS module is part of the
29\fBsamba\fR(7)
30suite.
31.PP
32The
33vfs_cacheprime
34VFS module reads chunks of file data near the range requested by clients in order to make sure the data is present in the kernel file data cache at the time when it is actually requested by clients.
35.PP
36The size of the disk read operations performed by
37vfs_cacheprime
38is determined by the cacheprime:rsize option. All disk read operations are aligned on boundaries that are a multiple of this size. Each range of the file data is primed at most once during the time the client has the file open.
39.PP
40This module is stackable.
41.SH "OPTIONS"
42.PP
43cacheprime:rsize = BYTES
44.RS 3n
45The number of bytes with which to prime the kernel data cache.
46.sp
47The following suffixes may be applied to BYTES:
48.RS 3n
49.TP 3n
50\(bu
51K
52- BYTES is a number of kilobytes
53.TP 3n
54\(bu
55M
56- BYTES is a number of megabytes
57.TP 3n
58\(bu
59G
60- BYTES is a number of gigabytes
61.RE
62.RE
63.SH "EXAMPLES"
64.PP
65For a hypothetical disk array, it is necessary to ensure that all read operations are of size 1 megabyte (1048576 bytes), and aligned on 1 megabyte boundaries:
66
67.nf
68
69 \fI[hypothetical]\fR
70 vfs objects = cacheprime
71 cacheprime:rsize = 1M
72
73.fi
74.SH "CAVEATS"
75.PP
76cacheprime
77is not a a substitute for a general-purpose readahead mechanism. It is intended for use only in very specific environments where disk operations must be aligned and sized to known values (as much as that is possible).
78.SH "VERSION"
79.PP
80This man page is correct for version 3.0.25 of the Samba suite.
81.SH "AUTHOR"
82.PP
83The 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.
84
Note: See TracBrowser for help on using the repository browser.