summaryrefslogtreecommitdiff
path: root/docs-xml/manpages/vfstest.1.xml
diff options
context:
space:
mode:
Diffstat (limited to 'docs-xml/manpages/vfstest.1.xml')
-rw-r--r--docs-xml/manpages/vfstest.1.xml153
1 files changed, 153 insertions, 0 deletions
diff --git a/docs-xml/manpages/vfstest.1.xml b/docs-xml/manpages/vfstest.1.xml
new file mode 100644
index 0000000000..675d766550
--- /dev/null
+++ b/docs-xml/manpages/vfstest.1.xml
@@ -0,0 +1,153 @@
+<?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="vfstest.1">
+
+<refmeta>
+ <refentrytitle>vfstest</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="source">Samba</refmiscinfo>
+ <refmiscinfo class="manual">User Commands</refmiscinfo>
+ <refmiscinfo class="version">3.6</refmiscinfo>
+</refmeta>
+
+
+<refnamediv>
+ <refname>vfstest</refname>
+ <refpurpose>tool for testing samba VFS modules </refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+ <cmdsynopsis>
+ <command>vfstest</command>
+ <arg choice="opt">-d debuglevel</arg>
+ <arg choice="opt">-c command</arg>
+ <arg choice="opt">-l logdir</arg>
+ <arg choice="opt">-h</arg>
+ </cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1>
+ <title>DESCRIPTION</title>
+
+ <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
+ <manvolnum>7</manvolnum></citerefentry> suite.</para>
+
+ <para><command>vfstest</command> is a small command line
+ utility that has the ability to test dso samba VFS modules. It gives the
+ user the ability to call the various VFS functions manually and
+ supports cascaded VFS modules.
+ </para>
+</refsect1>
+
+
+<refsect1>
+ <title>OPTIONS</title>
+
+ <variablelist>
+
+ <varlistentry>
+ <term>-c|--command=command</term>
+ <listitem><para>Execute the specified (colon-separated) commands.
+ See below for the commands that are available.
+ </para> </listitem>
+ </varlistentry>
+
+ &stdarg.help;
+
+ <varlistentry>
+ <term>-l|--logfile=logbasename</term>
+ <listitem><para>File name for log/debug files. The extension
+ <constant>'.client'</constant> will be appended. The log file is never removed
+ by the client.
+ </para></listitem>
+ </varlistentry>
+
+ &stdarg.server.debug;
+ &popt.common.samba;
+
+ </variablelist>
+</refsect1>
+
+
+<refsect1>
+ <title>COMMANDS</title>
+
+ <para><emphasis>VFS COMMANDS</emphasis></para>
+ <itemizedlist>
+ <listitem><para><command>load &lt;module.so&gt;</command> - Load specified VFS module </para></listitem>
+
+ <listitem><para><command>populate &lt;char&gt; &lt;size&gt;</command> - Populate a data buffer with the specified data
+ </para></listitem>
+
+ <listitem><para><command>showdata [&lt;offset&gt; &lt;len&gt;]</command> - Show data currently in data buffer
+ </para></listitem>
+
+ <listitem><para><command>connect</command> - VFS connect()</para></listitem>
+ <listitem><para><command>disconnect</command> - VFS disconnect()</para></listitem>
+ <listitem><para><command>disk_free</command> - VFS disk_free()</para></listitem>
+ <listitem><para><command>opendir</command> - VFS opendir()</para></listitem>
+ <listitem><para><command>readdir</command> - VFS readdir()</para></listitem>
+ <listitem><para><command>mkdir</command> - VFS mkdir()</para></listitem>
+ <listitem><para><command>rmdir</command> - VFS rmdir()</para></listitem>
+ <listitem><para><command>closedir</command> - VFS closedir()</para></listitem>
+ <listitem><para><command>open</command> - VFS open()</para></listitem>
+ <listitem><para><command>close</command> - VFS close()</para></listitem>
+ <listitem><para><command>read</command> - VFS read()</para></listitem>
+ <listitem><para><command>write</command> - VFS write()</para></listitem>
+ <listitem><para><command>lseek</command> - VFS lseek()</para></listitem>
+ <listitem><para><command>rename</command> - VFS rename()</para></listitem>
+ <listitem><para><command>fsync</command> - VFS fsync()</para></listitem>
+ <listitem><para><command>stat</command> - VFS stat()</para></listitem>
+ <listitem><para><command>fstat</command> - VFS fstat()</para></listitem>
+ <listitem><para><command>lstat</command> - VFS lstat()</para></listitem>
+ <listitem><para><command>unlink</command> - VFS unlink()</para></listitem>
+ <listitem><para><command>chmod</command> - VFS chmod()</para></listitem>
+ <listitem><para><command>fchmod</command> - VFS fchmod()</para></listitem>
+ <listitem><para><command>chown</command> - VFS chown()</para></listitem>
+ <listitem><para><command>fchown</command> - VFS fchown()</para></listitem>
+ <listitem><para><command>chdir</command> - VFS chdir()</para></listitem>
+ <listitem><para><command>getwd</command> - VFS getwd()</para></listitem>
+ <listitem><para><command>utime</command> - VFS utime()</para></listitem>
+ <listitem><para><command>ftruncate</command> - VFS ftruncate()</para></listitem>
+ <listitem><para><command>lock</command> - VFS lock()</para></listitem>
+ <listitem><para><command>symlink</command> - VFS symlink()</para></listitem>
+ <listitem><para><command>readlink</command> - VFS readlink()</para></listitem>
+ <listitem><para><command>link</command> - VFS link()</para></listitem>
+ <listitem><para><command>mknod</command> - VFS mknod()</para></listitem>
+ <listitem><para><command>realpath</command> - VFS realpath()</para></listitem>
+ </itemizedlist>
+
+ <para><emphasis>GENERAL COMMANDS</emphasis></para>
+ <itemizedlist>
+ <listitem><para><command>conf &lt;smb.conf&gt;</command> - Load a different configuration file</para></listitem>
+
+ <listitem><para><command>help [&lt;command&gt;]</command> - Get list of commands or info about specified command</para></listitem>
+
+ <listitem><para><command>debuglevel &lt;level&gt;</command> - Set debug level</para></listitem>
+
+ <listitem><para><command>freemem</command> - Free memory currently in use</para></listitem>
+
+ <listitem><para><command>exit</command> - Exit vfstest</para></listitem>
+ </itemizedlist>
+
+</refsect1>
+
+<refsect1>
+ <title>VERSION</title>
+
+ <para>This man page is correct for version 3 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>
+
+ <para>The vfstest man page was written by Jelmer Vernooij.</para>
+</refsect1>
+
+</refentry>