source: trunk/samba-3.0.25pre1/docs/manpages/vfs_cacheprime.8@ 1

Last change on this file since 1 was 1, checked in by Paul Smedley, 19 years ago

Initial code import

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.ad l
25.hy 0
26.HP 25
27\fBvfs objects = cacheprime\fR
28.ad
29.hy
30
31.SH "DESCRIPTION"
32
33.PP
34This VFS module is part of the\fBsamba\fR(7) suite\&.
35
36.PP
37The \fBvfs_cacheprime\fR VFS 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\&.
38
39.PP
40The size of the disk read operations performed by \fBvfs_cacheprime\fR is 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\&.
41
42.PP
43This module is stackable\&.
44
45.SH "OPTIONS"
46
47.TP
48cacheprime:rsize = BYTES
49The number of bytes with which to prime the kernel data cache\&.
50
51The following suffixes may be applied to BYTES:
52
53.RS
54.TP 3
55\(bu
56\fBK\fR \- BYTES is a number of kilobytes
57.TP
58\(bu
59\fBM\fR \- BYTES is a number of megabytes
60.TP
61\(bu
62\fBG\fR \- BYTES is a number of gigabytes
63.LP
64.RE
65.IP
66
67.SH "EXAMPLES"
68
69.PP
70For 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:
71
72.nf
73
74 \fI[hypothetical]\fR
75 vfs objects = cacheprime
76 cacheprime:rsize = 1M
77
78.fi
79
80.SH "CAVEATS"
81
82.PP
83\fBcacheprime\fR is 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)\&.
84
85.SH "VERSION"
86
87.PP
88This man page is correct for version 3\&.0\&.25 of the Samba suite\&.
89
90.SH "AUTHOR"
91
92.PP
93The 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\&.
94
Note: See TracBrowser for help on using the repository browser.