source: branches/samba-3.2.x/docs/manpages/vfs_cacheprime.8@ 200

Last change on this file since 200 was 149, checked in by Paul Smedley, 17 years ago

Update trunk to v3.2.2

File size: 2.4 KB
Line 
1.\" Title: vfs_cacheprime
2.\" Author:
3.\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/>
4.\" Date: 08/18/2008
5.\" Manual: System Administration tools
6.\" Source: Samba 3.2
7.\"
8.TH "VFS_CACHEPRIME" "8" "08/18/2008" "Samba 3\.2" "System Administration tools"
9.\" disable hyphenation
10.nh
11.\" disable justification (adjust text to left margin only)
12.ad l
13.SH "NAME"
14vfs_cacheprime - prime the kernel file data cache
15.SH "SYNOPSIS"
16.HP 1
17vfs objects = cacheprime
18.SH "DESCRIPTION"
19.PP
20This VFS module is part of the
21\fBsamba\fR(7)
22suite\.
23.PP
24The
25vfs_cacheprime
26VFS 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\.
27.PP
28The size of the disk read operations performed by
29vfs_cacheprime
30is 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\.
31.PP
32This module is stackable\.
33.SH "OPTIONS"
34.PP
35cacheprime:rsize = BYTES
36.RS 4
37The number of bytes with which to prime the kernel data cache\.
38.sp
39The following suffixes may be applied to BYTES:
40.sp
41.RS 4
42.ie n \{\
43\h'-04'\(bu\h'+03'\c
44.\}
45.el \{\
46.sp -1
47.IP \(bu 2.3
48.\}
49K
50\- BYTES is a number of kilobytes
51.RE
52.sp
53.RS 4
54.ie n \{\
55\h'-04'\(bu\h'+03'\c
56.\}
57.el \{\
58.sp -1
59.IP \(bu 2.3
60.\}
61M
62\- BYTES is a number of megabytes
63.RE
64.sp
65.RS 4
66.ie n \{\
67\h'-04'\(bu\h'+03'\c
68.\}
69.el \{\
70.sp -1
71.IP \(bu 2.3
72.\}
73G
74\- BYTES is a number of gigabytes
75.sp
76.RE
77.RE
78.SH "EXAMPLES"
79.PP
80For 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:
81.sp
82.RS 4
83.nf
84 \fI[hypothetical]\fR
85 \fIvfs objects = cacheprime\fR
86 \fIcacheprime:rsize = 1M\fR
87.fi
88.RE
89.SH "CAVEATS"
90.PP
91cacheprime
92is 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)\.
93.SH "VERSION"
94.PP
95This man page is correct for version 3\.0\.25 of the Samba suite\.
96.SH "AUTHOR"
97.PP
98The 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.