source: branches/samba-3.5.x/docs/manpages/vfs_readahead.8

Last change on this file was 773, checked in by Herwig Bauernfeind, 12 years ago

Samba Server 3.5: Update branch to 3.5.20

File size: 3.0 KB
Line 
1'\" t
2.\" Title: vfs_readahead
3.\" Author: [see the "AUTHOR" section]
4.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
5.\" Date: 12/14/2012
6.\" Manual: System Administration tools
7.\" Source: Samba 3.5
8.\" Language: English
9.\"
10.TH "VFS_READAHEAD" "8" "12/14/2012" "Samba 3\&.5" "System Administration tools"
11.\" -----------------------------------------------------------------
12.\" * set default formatting
13.\" -----------------------------------------------------------------
14.\" disable hyphenation
15.nh
16.\" disable justification (adjust text to left margin only)
17.ad l
18.\" -----------------------------------------------------------------
19.\" * MAIN CONTENT STARTS HERE *
20.\" -----------------------------------------------------------------
21.SH "NAME"
22vfs_readahead \- pre\-load the kernel buffer cache
23.SH "SYNOPSIS"
24.HP \w'\ 'u
25vfs objects = readahead
26.SH "DESCRIPTION"
27.PP
28This VFS module is part of the
29\fBsamba\fR(7)
30suite\&.
31.PP
32This
33vfs_readahead
34VFS 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\&.
35.PP
36This 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\&.
37.PP
38The offset multiple used is given by the readahead:offset option, which defaults to 0x80000\&.
39.PP
40The size of the disk read operations performed by
41vfs_readahead
42is 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\&.
43.PP
44This module is stackable\&.
45.SH "OPTIONS"
46.PP
47readahead:offset = BYTES
48.RS 4
49The offset multiple that causes readahead to be requested of the kernel buffer cache\&.
50.RE
51.PP
52readahead:length = BYTES
53.RS 4
54The number of bytes requested to be read into the kernel buffer cache on each readahead call\&.
55.RE
56.PP
57The following suffixes may be applied to BYTES:
58.sp
59.RS 4
60.ie n \{\
61\h'-04'\(bu\h'+03'\c
62.\}
63.el \{\
64.sp -1
65.IP \(bu 2.3
66.\}
67K
68\- BYTES is a number of kilobytes
69.RE
70.sp
71.RS 4
72.ie n \{\
73\h'-04'\(bu\h'+03'\c
74.\}
75.el \{\
76.sp -1
77.IP \(bu 2.3
78.\}
79M
80\- BYTES is a number of megabytes
81.RE
82.sp
83.RS 4
84.ie n \{\
85\h'-04'\(bu\h'+03'\c
86.\}
87.el \{\
88.sp -1
89.IP \(bu 2.3
90.\}
91G
92\- BYTES is a number of gigabytes
93.SH "EXAMPLES"
94.sp
95.if n \{\
96.RS 4
97.\}
98.nf
99 \fI[hypothetical]\fR
100 \m[blue]\fBvfs objects = readahead\fR\m[]
101.fi
102.if n \{\
103.RE
104.\}
105.SH "VERSION"
106.PP
107This man page is correct for version 3\&.0\&.25 of the Samba suite\&.
108.SH "AUTHOR"
109.PP
110The 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.