Ignore:
Timestamp:
May 27, 2009, 9:08:03 AM (16 years ago)
Author:
Herwig Bauernfeind
Message:

Update 3.2 branch to 3.2.8 docs

File:
1 edited

Legend:

Unmodified
Added
Removed

  • branches/samba-3.2.x/docs/manpages/vfs_readahead.8

    r229 r231  
    11.\"     Title: vfs_readahead
    2 .\"    Author:
    3 .\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/>
    4 .\"      Date: 12/19/2008
     2.\"    Author: [see the "AUTHOR" section]
     3.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
     4.\"      Date: 02/03/2009
    55.\"    Manual: System Administration tools
    66.\"    Source: Samba 3.2
     7.\"  Language: English
    78.\"
    8 .TH "VFS_READAHEAD" "8" "12/19/2008" "Samba 3\.2" "System Administration tools"
     9.TH "VFS_READAHEAD" "8" "02/03/2009" "Samba 3\&.2" "System Administration tools"
     10.\" -----------------------------------------------------------------
     11.\" * (re)Define some macros
     12.\" -----------------------------------------------------------------
     13.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     14.\" toupper - uppercase a string (locale-aware)
     15.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     16.de toupper
     17.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
     18\\$*
     19.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
     20..
     21.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     22.\" SH-xref - format a cross-reference to an SH section
     23.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     24.de SH-xref
     25.ie n \{\
     26.\}
     27.toupper \\$*
     28.el \{\
     29\\$*
     30.\}
     31..
     32.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     33.\" SH - level-one heading that works better for non-TTY output
     34.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     35.de1 SH
     36.\" put an extra blank line of space above the head in non-TTY output
     37.if t \{\
     38.sp 1
     39.\}
     40.sp \\n[PD]u
     41.nr an-level 1
     42.set-an-margin
     43.nr an-prevailing-indent \\n[IN]
     44.fi
     45.in \\n[an-margin]u
     46.ti 0
     47.HTML-TAG ".NH \\n[an-level]"
     48.it 1 an-trap
     49.nr an-no-space-flag 1
     50.nr an-break-flag 1
     51\." make the size of the head bigger
     52.ps +3
     53.ft B
     54.ne (2v + 1u)
     55.ie n \{\
     56.\" if n (TTY output), use uppercase
     57.toupper \\$*
     58.\}
     59.el \{\
     60.nr an-break-flag 0
     61.\" if not n (not TTY), use normal case (not uppercase)
     62\\$1
     63.in \\n[an-margin]u
     64.ti 0
     65.\" if not n (not TTY), put a border/line under subheading
     66.sp -.6
     67\l'\n(.lu'
     68.\}
     69..
     70.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     71.\" SS - level-two heading that works better for non-TTY output
     72.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     73.de1 SS
     74.sp \\n[PD]u
     75.nr an-level 1
     76.set-an-margin
     77.nr an-prevailing-indent \\n[IN]
     78.fi
     79.in \\n[IN]u
     80.ti \\n[SN]u
     81.it 1 an-trap
     82.nr an-no-space-flag 1
     83.nr an-break-flag 1
     84.ps \\n[PS-SS]u
     85\." make the size of the head bigger
     86.ps +2
     87.ft B
     88.ne (2v + 1u)
     89.if \\n[.$] \&\\$*
     90..
     91.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     92.\" BB/BE - put background/screen (filled box) around block of text
     93.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     94.de BB
     95.if t \{\
     96.sp -.5
     97.br
     98.in +2n
     99.ll -2n
     100.gcolor red
     101.di BX
     102.\}
     103..
     104.de EB
     105.if t \{\
     106.if "\\$2"adjust-for-leading-newline" \{\
     107.sp -1
     108.\}
     109.br
     110.di
     111.in
     112.ll
     113.gcolor
     114.nr BW \\n(.lu-\\n(.i
     115.nr BH \\n(dn+.5v
     116.ne \\n(BHu+.5v
     117.ie "\\$2"adjust-for-leading-newline" \{\
     118\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
     119.\}
     120.el \{\
     121\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
     122.\}
     123.in 0
     124.sp -.5v
     125.nf
     126.BX
     127.in
     128.sp .5v
     129.fi
     130.\}
     131..
     132.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     133.\" BM/EM - put colored marker in margin next to block of text
     134.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     135.de BM
     136.if t \{\
     137.br
     138.ll -2n
     139.gcolor red
     140.di BX
     141.\}
     142..
     143.de EM
     144.if t \{\
     145.br
     146.di
     147.ll
     148.gcolor
     149.nr BH \\n(dn
     150.ne \\n(BHu
     151\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
     152.in 0
     153.nf
     154.BX
     155.in
     156.fi
     157.\}
     158..
     159.\" -----------------------------------------------------------------
     160.\" * set default formatting
     161.\" -----------------------------------------------------------------
    9162.\" disable hyphenation
    10163.nh
    11164.\" disable justification (adjust text to left margin only)
    12165.ad l
    13 .SH "NAME"
    14 vfs_readahead - pre-load the kernel buffer cache
    15 .SH "SYNOPSIS"
    16 .HP 1
    17 vfs objects = readahead
     166.\" -----------------------------------------------------------------
     167.\" * MAIN CONTENT STARTS HERE *
     168.\" -----------------------------------------------------------------
     169.SH "Name"
     170vfs_readahead \- pre\-load the kernel buffer cache
     171.SH "Synopsis"
     172.fam C
     173.HP \w'\ 'u
     174\FCvfs objects = readahead\F[]
     175.fam
    18176.SH "DESCRIPTION"
    19177.PP
    20178This VFS module is part of the
    21179\fBsamba\fR(7)
    22 suite\.
     180suite\&.
    23181.PP
    24182This
    25 vfs_readahead
    26 VFS 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
    28 This 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
    30 The offset multiple used is given by the readahead:offset option, which defaults to 0x80000\.
     183\FCvfs_readahead\F[]
     184VFS 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\&.
     185.PP
     186This 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\&.
     187.PP
     188The offset multiple used is given by the readahead:offset option, which defaults to 0x80000\&.
    31189.PP
    32190The size of the disk read operations performed by
    33 vfs_readahead
    34 is 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
    36 This module is stackable\.
     191\FCvfs_readahead\F[]
     192is 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\&.
     193.PP
     194This module is stackable\&.
    37195.SH "OPTIONS"
    38196.PP
    39197readahead:offset = BYTES
    40198.RS 4
    41 The offset multiple that causes readahead to be requested of the kernel buffer cache\.
     199The offset multiple that causes readahead to be requested of the kernel buffer cache\&.
    42200.RE
    43201.PP
    44202readahead:length = BYTES
    45203.RS 4
    46 The number of bytes requested to be read into the kernel buffer cache on each readahead call\.
     204The number of bytes requested to be read into the kernel buffer cache on each readahead call\&.
    47205.RE
    48206.PP
    … …  
    57215.IP \(bu 2.3
    58216.\}
    59 K
     217\FCK\F[]
    60218\- BYTES is a number of kilobytes
    61219.RE
    … …  
    69227.IP \(bu 2.3
    70228.\}
    71 M
     229\FCM\F[]
    72230\- BYTES is a number of megabytes
    73231.RE
    … …  
    81239.IP \(bu 2.3
    82240.\}
    83 G
     241\FCG\F[]
    84242\- BYTES is a number of gigabytes
    85243.SH "EXAMPLES"
    86244.sp
    87 .RS 4
     245.if n \{\
     246.RS 4
     247.\}
     248.fam C
     249.ps -1
    88250.nf
     251.if t \{\
     252.sp -1
     253.\}
     254.BB lightgray adjust-for-leading-newline
     255.sp -1
     256
    89257        \fI[hypothetical]\fR
    90         \fIvfs objects = readahead\fR
    91 .fi
    92 .RE
     258        \m[blue]\fBvfs objects = readahead\fR\m[]
     259.EB lightgray adjust-for-leading-newline
     260.if t \{\
     261.sp 1
     262.\}
     263.fi
     264.fam
     265.ps +1
     266.if n \{\
     267.RE
     268.\}
    93269.SH "VERSION"
    94270.PP
    95 This man page is correct for version 3\.0\.25 of the Samba suite\.
     271This man page is correct for version 3\&.0\&.25 of the Samba suite\&.
    96272.SH "AUTHOR"
    97273.PP
    98 The 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\.
     274The 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 TracChangeset for help on using the changeset viewer.