docs-xml/manpages/vfs_aio_pthread.8.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
   3 <refentry id="vfs_aio_pthread.8">
   4
   5 <refmeta>
   6         <refentrytitle>vfs_aio_pthread</refentrytitle>
   7         <manvolnum>8</manvolnum>
   8         <refmiscinfo class="source">Samba</refmiscinfo>
   9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
  10         <refmiscinfo class="version">&doc.version;</refmiscinfo>
  11 </refmeta>
  12
  13
  14 <refnamediv>
  15         <refname>vfs_aio_pthread</refname>
  16         <refpurpose>implement async open in Samba vfs using a pthread pool</refpurpose>
  17 </refnamediv>
  18
  19 <refsynopsisdiv>
  20         <cmdsynopsis>
  21                 <command>vfs objects = aio_pthread</command>
  22         </cmdsynopsis>
  23 </refsynopsisdiv>
  24
  25 <refsect1>
  26         <title>DESCRIPTION</title>
  27
  28         <para>This VFS module is part of the
  29         <citerefentry><refentrytitle>samba</refentrytitle>
  30         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  31
  32         <para>The <command>aio_pthread</command> VFS module enables asynchronous
  33         opens (for new files) with <smbconfoption name="aio_pthread:aio open">yes</smbconfoption>
  34         on platforms which have the pthreads API available,
  35         support the openat() syscall and support per thread credentials (modern Linux kernels).
  36         </para>
  37
  38         <para>The module makes use of the global thread pool which uses the
  39         <smbconfoption name="aio max threads"/> option.</para>
  40
  41         <para>This module MUST be listed last in any module stack as
  42         the Samba VFS open interface is not thread-safe. This
  43         module makes direct openat() system calls and does
  44         NOT call the Samba VFS open interfaces.</para>
  45
  46 </refsect1>
  47
  48
  49 <refsect1>
  50         <title>EXAMPLES</title>
  51
  52         <para>Straight forward use:</para>
  53
  54 <programlisting>
  55         <smbconfsection name="[cooldata]"/>
  56         <smbconfoption name="path">/data/ice</smbconfoption>
  57         <smbconfoption name="vfs objects">aio_pthread</smbconfoption>
  58         <smbconfoption name="aio_pthread:aio open">yes</smbconfoption>
  59 </programlisting>
  60
  61 </refsect1>
  62
  63 <refsect1>
  64         <title>OPTIONS</title>
  65
  66         <variablelist>
  67
  68                 <varlistentry>
  69                 <term>aio_pthread:aio open = BOOL</term>
  70                 <listitem>
  71                 <para>Try async opens for creating new files.
  72                 </para>
  73                 <para>The default is 'no'.</para>
  74                 </listitem>
  75                 </varlistentry>
  76
  77         </variablelist>
  78 </refsect1>
  79
  80 <refsect1>
  81         <title>VERSION</title>
  82
  83         <para>This man page is part of version &doc.version; of the Samba suite.
  84         </para>
  85 </refsect1>
  86
  87 <refsect1>
  88         <title>AUTHOR</title>
  89
  90         <para>The original Samba software and related utilities
  91         were created by Andrew Tridgell. Samba is now developed
  92         by the Samba Team as an Open Source project similar
  93         to the way the Linux kernel is developed.</para>
  94
  95 </refsect1>
  96
  97 </refentry>