summaryrefslogtreecommitdiff
path: root/docs/manpages-3/vfs_prealloc.8.xml
diff options
context:
space:
mode:
authorJames Peach <jpeach@samba.org>2007-02-28 22:51:22 +0000
committerGerald W. Carter <jerry@samba.org>2008-04-23 08:47:27 -0500
commitea8725b305f796b4343d5a3e3c2b77d73c9333c9 (patch)
tree545eaba108bf2fbb06784c55d9d19087466b4a22 /docs/manpages-3/vfs_prealloc.8.xml
parent9222e2a16f8dde1121cab19f7215f5e5a707e4c9 (diff)
downloadsamba-ea8725b305f796b4343d5a3e3c2b77d73c9333c9.tar.gz
samba-ea8725b305f796b4343d5a3e3c2b77d73c9333c9.tar.bz2
samba-ea8725b305f796b4343d5a3e3c2b77d73c9333c9.zip
Rename module manpages for consistency.
(This used to be commit e2e8104462cf32a1ef29778f7d10bee8aa6dcb3e)
Diffstat (limited to 'docs/manpages-3/vfs_prealloc.8.xml')
-rw-r--r--docs/manpages-3/vfs_prealloc.8.xml103
1 files changed, 103 insertions, 0 deletions
diff --git a/docs/manpages-3/vfs_prealloc.8.xml b/docs/manpages-3/vfs_prealloc.8.xml
new file mode 100644
index 0000000000..1d8f6db75c
--- /dev/null
+++ b/docs/manpages-3/vfs_prealloc.8.xml
@@ -0,0 +1,103 @@
+<?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="smb-vfs-prealloc.8">
+
+<refmeta>
+ <refentrytitle>smb-vfs-prealloc</refentrytitle>
+ <manvolnum>8</manvolnum>
+</refmeta>
+
+
+<refnamediv>
+ <refname>prealloc</refname>
+ <refpurpose>preallocate matching files to a predetermined size</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+ <cmdsynopsis>
+ <command>vfs objects = prealloc</command>
+ </cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1>
+ <title>DESCRIPTION</title>
+
+ <para>This module is part of the <citerefentry><refentrytitle>samba</refentrytitle>
+ <manvolnum>7</manvolnum></citerefentry> suite.</para>
+
+ <para>The <command>prealloc</command> VFS module preallocates
+ files to a specified size each time a new file is created. This
+ is useful in environments where files are of a predetermined
+ size will be written to a disk subsystem where extending file
+ allocations is expensive. </para>
+
+ <para>This module is stackable.</para>
+
+</refsect1>
+
+
+<refsect1>
+ <title>OPTIONS</title>
+
+ <variablelist>
+
+ <varlistentry>
+ <term>prealloc:EXT = BYTES</term>
+ <listitem>
+ <para>Preallocate all files with the extension EXT to
+ the size specified by BYTES.
+ </para>
+
+ <para>The following suffixes may be applied to BYTES:</para>
+ <itemizedlist>
+ <listitem><para><command>K</command> - BYTES is a number of kilobytes</para></listitem>
+ <listitem><para><command>M</command> - BYTES is a number of megabytes</para></listitem>
+ <listitem><para><command>G</command> - BYTES is a number of gigabytes</para></listitem>
+ </itemizedlist>
+
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+</refsect1>
+
+<refsect1>
+ <title>EXAMPLES</title>
+
+ <para>A process writes TIFF files to a Samba share, and the
+ is known these files will almost always be around 4 megabytes
+ (4194304 bytes): </para>
+
+<programlisting>
+ <smbconfsection name="[frames]"/>
+ <smbconfoption name="path">/data/frames</smbconfoption>
+ <smbconfoption name="vfs objects">prealloc</smbconfoption>
+ <smbconfoption name="prealloc:tiff">4M</smbconfoption>
+</programlisting>
+</refsect1>
+
+<refsect1>
+ <title>CAVEATS</title>
+ <para><command>preallocate</command> is not supported on all
+ platforms and filesystems. Currently only XFS filesystems on
+ Linux and IRIX are supported.
+ </para>
+</refsect1>
+
+<refsect1>
+ <title>VERSION</title>
+ <para>This man page is correct for version 3.0.25 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>