Initial import
[samba] / docs / htmldocs / manpages / vfstest.1.html
diff --git a/docs/htmldocs/manpages/vfstest.1.html b/docs/htmldocs/manpages/vfstest.1.html
new file mode 100644 (file)
index 0000000..75a5357
--- /dev/null
@@ -0,0 +1,41 @@
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>vfstest</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.68.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="vfstest.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>vfstest &#8212; tool for testing samba VFS modules </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">vfstest</code>  [-d debuglevel] [-c command] [-l logdir] [-h]</p></div></div><div class="refsect1" lang="en"><a name="id2489057"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p><span><strong class="command">vfstest</strong></span> 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.
+       </p></div><div class="refsect1" lang="en"><a name="id2450601"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-c|--command=command</span></dt><dd><p>Execute the specified (colon-separated) commands.
+               See below for the commands that are available.
+               </p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options.
+</p></dd><dt><span class="term">-l|--logfile=logbasename</span></dt><dd><p>File name for log/debug files. The extension
+               <code class="constant">'.client'</code> will be appended. The log file is never removed
+               by the client.
+               </p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the program version number.
+</p></dd><dt><span class="term">-s &lt;configuration file&gt;</span></dt><dd><p>The file specified contains the 
+configuration details required by the server.  The 
+information in this file includes server-specific
+information such as what printcap file to use, as well 
+as descriptions of all the services that the server is 
+to provide. See <code class="filename">smb.conf</code> for more information.
+The default configuration file name is determined at 
+compile time.</p></dd><dt><span class="term">-d|--debuglevel=level</span></dt><dd><p><em class="replaceable"><code>level</code></em> is an integer 
+from 0 to 10.  The default value if this parameter is 
+not specified is zero.</p><p>The higher this value, the more detail will be 
+logged to the log files about the activities of the 
+server. At level 0, only critical errors and serious 
+warnings will be logged. Level 1 is a reasonable level for
+day-to-day running - it generates a small amount of 
+information about operations carried out.</p><p>Levels above 1 will generate considerable 
+amounts of log data, and should only be used when 
+investigating a problem. Levels above 3 are designed for 
+use only by developers and generate HUGE amounts of log
+data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will 
+override the <a class="indexterm" name="id2450719"></a> parameter
+in the <code class="filename">smb.conf</code> file.</p></dd><dt><span class="term">-l|--logfile=logdirectory</span></dt><dd><p>Base directory name for log/debug files. The extension
+<code class="constant">".progname"</code> will be appended (e.g. log.smbclient, 
+log.smbd, etc...). The log file is never removed by the client.
+</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2450753"></a><h2>COMMANDS</h2><p><span class="emphasis"><em>VFS COMMANDS</em></span></p><div class="itemizedlist"><ul type="disc"><li><p><span><strong class="command">load &lt;module.so&gt;</strong></span> - Load specified VFS module </p></li><li><p><span><strong class="command">populate &lt;char&gt; &lt;size&gt;</strong></span> - Populate a data buffer with the specified data
+               </p></li><li><p><span><strong class="command">showdata [&lt;offset&gt; &lt;len&gt;]</strong></span> - Show data currently in data buffer
+               </p></li><li><p><span><strong class="command">connect</strong></span> - VFS connect()</p></li><li><p><span><strong class="command">disconnect</strong></span> - VFS disconnect()</p></li><li><p><span><strong class="command">disk_free</strong></span> - VFS disk_free()</p></li><li><p><span><strong class="command">opendir</strong></span> - VFS opendir()</p></li><li><p><span><strong class="command">readdir</strong></span> - VFS readdir()</p></li><li><p><span><strong class="command">mkdir</strong></span> - VFS mkdir()</p></li><li><p><span><strong class="command">rmdir</strong></span> - VFS rmdir()</p></li><li><p><span><strong class="command">closedir</strong></span> - VFS closedir()</p></li><li><p><span><strong class="command">open</strong></span> - VFS open()</p></li><li><p><span><strong class="command">close</strong></span> - VFS close()</p></li><li><p><span><strong class="command">read</strong></span> - VFS read()</p></li><li><p><span><strong class="command">write</strong></span> - VFS write()</p></li><li><p><span><strong class="command">lseek</strong></span> - VFS lseek()</p></li><li><p><span><strong class="command">rename</strong></span> - VFS rename()</p></li><li><p><span><strong class="command">fsync</strong></span> - VFS fsync()</p></li><li><p><span><strong class="command">stat</strong></span> - VFS stat()</p></li><li><p><span><strong class="command">fstat</strong></span> - VFS fstat()</p></li><li><p><span><strong class="command">lstat</strong></span> - VFS lstat()</p></li><li><p><span><strong class="command">unlink</strong></span> - VFS unlink()</p></li><li><p><span><strong class="command">chmod</strong></span> - VFS chmod()</p></li><li><p><span><strong class="command">fchmod</strong></span> - VFS fchmod()</p></li><li><p><span><strong class="command">chown</strong></span> - VFS chown()</p></li><li><p><span><strong class="command">fchown</strong></span> - VFS fchown()</p></li><li><p><span><strong class="command">chdir</strong></span> - VFS chdir()</p></li><li><p><span><strong class="command">getwd</strong></span> - VFS getwd()</p></li><li><p><span><strong class="command">utime</strong></span> - VFS utime()</p></li><li><p><span><strong class="command">ftruncate</strong></span> - VFS ftruncate()</p></li><li><p><span><strong class="command">lock</strong></span> - VFS lock()</p></li><li><p><span><strong class="command">symlink</strong></span> - VFS symlink()</p></li><li><p><span><strong class="command">readlink</strong></span> - VFS readlink()</p></li><li><p><span><strong class="command">link</strong></span> - VFS link()</p></li><li><p><span><strong class="command">mknod</strong></span> - VFS mknod()</p></li><li><p><span><strong class="command">realpath</strong></span> - VFS realpath()</p></li></ul></div><p><span class="emphasis"><em>GENERAL COMMANDS</em></span></p><div class="itemizedlist"><ul type="disc"><li><p><span><strong class="command">conf &lt;smb.conf&gt;</strong></span> - Load a different configuration file</p></li><li><p><span><strong class="command">help [&lt;command&gt;]</strong></span> - Get list of commands or info about specified command</p></li><li><p><span><strong class="command">debuglevel &lt;level&gt;</strong></span> - Set debug level</p></li><li><p><span><strong class="command">freemem</strong></span> - Free memory currently in use</p></li><li><p><span><strong class="command">exit</strong></span> - Exit vfstest</p></li></ul></div></div><div class="refsect1" lang="en"><a name="id2451445"></a><h2>VERSION</h2><p>This man page is correct for version 3.0 of the Samba
+       suite.</p></div><div class="refsect1" lang="en"><a name="id2451456"></a><h2>AUTHOR</h2><p>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.</p><p>The vfstest man page was written by Jelmer Vernooij.</p></div></div></body></html>