summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBjörn Jacke <bj@sernet.de>2011-10-18 10:54:56 +0200
committerBjoern Jacke <bj@sernet.de>2011-10-18 12:24:35 +0200
commit56328a4d61c8d0a52f6841097bf8fc4ffd46bfb6 (patch)
tree7d7ed9f306988cd434c27b825f8a05be1bba6495
parent9b407ee6d54601aca8ee157c9afc2a1d3e9b07ed (diff)
downloadsamba-56328a4d61c8d0a52f6841097bf8fc4ffd46bfb6.tar.gz
samba-56328a4d61c8d0a52f6841097bf8fc4ffd46bfb6.tar.bz2
samba-56328a4d61c8d0a52f6841097bf8fc4ffd46bfb6.zip
s3/doc: add man page for aio_fork vfs module
thanks to Volker for the content Autobuild-User: Björn Jacke <bj@sernet.de> Autobuild-Date: Tue Oct 18 12:24:35 CEST 2011 on sn-devel-104
-rw-r--r--docs-xml/manpages-3/vfs_aio_fork.8.xml86
1 files changed, 86 insertions, 0 deletions
diff --git a/docs-xml/manpages-3/vfs_aio_fork.8.xml b/docs-xml/manpages-3/vfs_aio_fork.8.xml
new file mode 100644
index 0000000000..af69d9ab0d
--- /dev/null
+++ b/docs-xml/manpages-3/vfs_aio_fork.8.xml
@@ -0,0 +1,86 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
+<refentry id="vfs_aio_fork.8">
+
+<refmeta>
+ <refentrytitle>vfs_aio_fork</refentrytitle>
+ <manvolnum>8</manvolnum>
+ <refmiscinfo class="source">Samba</refmiscinfo>
+ <refmiscinfo class="manual">System Administration tools</refmiscinfo>
+ <refmiscinfo class="version">3.6</refmiscinfo>
+</refmeta>
+
+
+<refnamediv>
+ <refname>vfs_aio_fork</refname>
+ <refpurpose>implement async I/O in Samba vfs</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+ <cmdsynopsis>
+ <command>vfs objects = aio_fork</command>
+ </cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1>
+ <title>DESCRIPTION</title>
+
+ <para>This VFS module is part of the
+ <citerefentry><refentrytitle>samba</refentrytitle>
+ <manvolnum>7</manvolnum></citerefentry> suite.</para>
+
+ <para>The <command>aio_fork</command> VFS module enables async
+ I/O for Samba on platforms where the system level Posix AIO
+ interface is insufficient. Posix AIO can suffer from severe
+ limitations. For example, on some Linux versions the
+ real-time signals that it uses are broken under heavy load.
+ Other systems only allow AIO when special kernel modules are
+ loaded or only allow a certain system-wide amount of async
+ requests being scheduled. Systems based on glibc (most Linux
+ systems) only allow a single outstanding request per file
+ descriptor. </para>
+
+ <para>To work around all these limitations, the aio_fork module
+ was written. It uses forked helper processes instead of the
+ internal Posix AIO interface to create asynchronousity for
+ read and write calls. It has no parameters, it will create
+ helper processes when async requests come in as needed. Idle
+ helper processes will be removed every 30 seconds.
+ </para>
+
+ <para>This module is stackable.</para>
+
+</refsect1>
+
+
+<refsect1>
+ <title>EXAMPLES</title>
+
+ <para>Straight forward use:</para>
+
+<programlisting>
+ <smbconfsection name="[cooldata]"/>
+ <smbconfoption name="path">/data/ice</smbconfoption>
+ <smbconfoption name="vfs objects">aio_fork</smbconfoption>
+</programlisting>
+
+</refsect1>
+
+<refsect1>
+ <title>VERSION</title>
+
+ <para>This man page is correct for version 3.6.0 of the Samba suite.
+ </para>
+</refsect1>
+
+<refsect1>
+ <title>AUTHOR</title>
+
+ <para>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.</para>
+
+</refsect1>
+
+</refentry>