source: branches/samba-3.2.x/docs/manpages/vfs_readahead.8@ 229

Last change on this file since 229 was 229, checked in by Herwig Bauernfeind, 17 years ago

Update 3.2 branch to 3.2.7 docs

File size: 2.5 KB
Line 
1.\" Title: vfs_readahead
2.\" Author:
3.\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/>
4.\" Date: 12/19/2008
5.\" Manual: System Administration tools
6.\" Source: Samba 3.2
7.\"
8.TH "VFS_READAHEAD" "8" "12/19/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_readahead - pre-load the kernel buffer cache
15.SH "SYNOPSIS"
16.HP 1
17vfs objects = readahead
18.SH "DESCRIPTION"
19.PP
20This VFS module is part of the
21\fBsamba\fR(7)
22suite\.
23.PP
24This
25vfs_readahead
26VFS module detects read requests at multiples of a given offset (hex 0x80000 by default) and then tells the kernel via either the readahead system call (on Linux) or the posix_fadvise system call to pre\-fetch this data into the buffer cache\.
27.PP
28This module is useful for Windows Vista clients reading data using the Windows Explorer program, which asynchronously does multiple file read requests at offset boundaries of 0x80000 bytes\.
29.PP
30The offset multiple used is given by the readahead:offset option, which defaults to 0x80000\.
31.PP
32The size of the disk read operations performed by
33vfs_readahead
34is determined by the readahead:length option\. By default this is set to the same value as the readahead:offset option and if not set explicitly will use the current value of readahead:offset\.
35.PP
36This module is stackable\.
37.SH "OPTIONS"
38.PP
39readahead:offset = BYTES
40.RS 4
41The offset multiple that causes readahead to be requested of the kernel buffer cache\.
42.RE
43.PP
44readahead:length = BYTES
45.RS 4
46The number of bytes requested to be read into the kernel buffer cache on each readahead call\.
47.RE
48.PP
49The following suffixes may be applied to BYTES:
50.sp
51.RS 4
52.ie n \{\
53\h'-04'\(bu\h'+03'\c
54.\}
55.el \{\
56.sp -1
57.IP \(bu 2.3
58.\}
59K
60\- BYTES is a number of kilobytes
61.RE
62.sp
63.RS 4
64.ie n \{\
65\h'-04'\(bu\h'+03'\c
66.\}
67.el \{\
68.sp -1
69.IP \(bu 2.3
70.\}
71M
72\- BYTES is a number of megabytes
73.RE
74.sp
75.RS 4
76.ie n \{\
77\h'-04'\(bu\h'+03'\c
78.\}
79.el \{\
80.sp -1
81.IP \(bu 2.3
82.\}
83G
84\- BYTES is a number of gigabytes
85.SH "EXAMPLES"
86.sp
87.RS 4
88.nf
89 \fI[hypothetical]\fR
90 \fIvfs objects = readahead\fR
91.fi
92.RE
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.