docs/manpages-3/smb-vfs-prealloc.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="smb-vfs-prealloc.8">
   4
   5 <refmeta>
   6         <refentrytitle>smb-vfs-prealloc</refentrytitle>
   7         <manvolnum>8</manvolnum>
   8 </refmeta>
   9
  10
  11 <refnamediv>
  12         <refname>prealloc</refname>
  13         <refpurpose>preallocate matching files to a predetermined size</refpurpose>
  14 </refnamediv>
  15
  16 <refsynopsisdiv>
  17         <cmdsynopsis>
  18                 <command>vfs objects = prealloc</command>
  19         </cmdsynopsis>
  20 </refsynopsisdiv>
  21
  22 <refsect1>
  23         <title>DESCRIPTION</title>
  24
  25         <para>This module is part of the <citerefentry><refentrytitle>samba</refentrytitle>
  26         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  27
  28         <para>The <command>prealloc</command> VFS module preallocates
  29         files to a specified size each time a new file is created. This
  30         is useful in environments where files are of a predetermined
  31         size will be written to a disk subsystem where extending file
  32         allocations is expensive.  </para>
  33
  34         <para>This module is stackable.</para>
  35
  36 </refsect1>
  37
  38
  39 <refsect1>
  40         <title>OPTIONS</title>
  41
  42         <variablelist>
  43
  44                 <varlistentry>
  45                 <term>prealloc:EXT = BYTES</term>
  46                 <listitem>
  47                 <para>Preallocate all files with the extension EXT to
  48                 the size specified by BYTES.
  49                 </para>
  50
  51                 <para>The following suffixes may be applied to BYTES:</para>
  52                 <itemizedlist>
  53                 <listitem><para><command>K</command> - BYTES is a number of kilobytes</para></listitem>
  54                 <listitem><para><command>M</command> - BYTES is a number of megabytes</para></listitem>
  55                 <listitem><para><command>G</command> - BYTES is a number of gigabytes</para></listitem>
  56                 </itemizedlist>
  57
  58                 </listitem>
  59                 </varlistentry>
  60
  61         </variablelist>
  62 </refsect1>
  63
  64 <refsect1>
  65         <title>EXAMPLES</title>
  66
  67         <para>A process writes TIFF files to a Samba share, and the
  68         is known these files will almost always be around 4 megabytes
  69         (4194304 bytes): </para>
  70
  71 <programlisting>
  72         <smbconfsection name="[frames]"/>
  73         <smbconfoption name="path">/data/frames</smbconfoption>
  74         <smbconfoption name="vfs objects">prealloc</smbconfoption>
  75         <smbconfoption name="prealloc:tiff">4M</smbconfoption>
  76 </programlisting>
  77 </refsect1>
  78
  79 <refsect1>
  80         <title>CAVEATS</title>
  81         <para><command>preallocate</command> is not supported on all
  82         platforms and filesystems. Currently only XFS filesystems on
  83         Linux and IRIX are supported.
  84         </para>
  85 </refsect1>
  86
  87 <refsect1>
  88         <title>VERSION</title>
  89         <para>This man page is correct for version 3.0.25 of the Samba suite.
  90         </para>
  91 </refsect1>
  92
  93 <refsect1>
  94         <title>AUTHOR</title>
  95
  96         <para>The original Samba software and related utilities
  97         were created by Andrew Tridgell. Samba is now developed
  98         by the Samba Team as an Open Source project similar
  99         to the way the Linux kernel is developed.</para>
 100
 101 </refsect1>
 102
 103 </refentry>