trying to get HEAD building again. If you want the code
[gd/samba-autobuild/.git] / docs / htmldocs / vfstest.1.html
index 229f132ca855ab62c9b0b4e0b12b48c594b27545..7b124c070f3be3701f24639482435c402490f50d 100644 (file)
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<HTML
-><HEAD
-><TITLE
->vfstest</TITLE
-><META
-NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.7"></HEAD
-><BODY
-CLASS="REFENTRY"
-BGCOLOR="#FFFFFF"
-TEXT="#000000"
-LINK="#0000FF"
-VLINK="#840084"
-ALINK="#0000FF"
-><H1
-><A
-NAME="VFSTEST.1"
-></A
->vfstest</H1
-><DIV
-CLASS="REFNAMEDIV"
-><A
-NAME="AEN5"
-></A
-><H2
->Name</H2
->vfstest&nbsp;--&nbsp;tool for testing samba VFS modules </DIV
-><DIV
-CLASS="REFSYNOPSISDIV"
-><A
-NAME="AEN8"
-></A
-><H2
->Synopsis</H2
-><P
-><B
-CLASS="COMMAND"
->vfstest</B
->  [-d debuglevel] [-c command] [-l logfile] [-h]</P
-></DIV
-><DIV
-CLASS="REFSECT1"
-><A
-NAME="AEN15"
-></A
-><H2
->DESCRIPTION</H2
-><P
->This tool is part of the <SPAN
-CLASS="CITEREFENTRY"
-><SPAN
-CLASS="REFENTRYTITLE"
->Samba</SPAN
->(7)</SPAN
-> suite.</P
-><P
-><B
-CLASS="COMMAND"
->vfstest</B
-> is a small command line
+<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.60.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><div></div></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><tt class="command">vfstest</tt>  [-d debuglevel] [-c command] [-l logfile] [-h]</p></div></div><div class="refsect1" lang="en"><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><b class="command">vfstest</b> 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"
-><A
-NAME="AEN23"
-></A
-><H2
->OPTIONS</H2
-><P
-></P
-><DIV
-CLASS="VARIABLELIST"
-><DL
-><DT
->-c|--command=command</DT
-><DD
-><P
->Execute the specified (colon-separated) commands.
+       </p></div><div class="refsect1" lang="en"><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
->-h|--help</DT
-><DD
-><P
->Print a summary of command line options.</P
-></DD
-><DT
->-l|--logfile=logbasename</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
+               </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
+               <tt class="constant">'.client'</tt> will be appended. The log file is never removed
                by the client.
-               </P
-></DD
-><DT
->-V</DT
-><DD
-><P
->Prints the version number for 
-<B
-CLASS="COMMAND"
->smbd</B
->.</P
-></DD
-><DT
->-s &#60;configuration file&#62;</DT
-><DD
-><P
->The file specified contains the 
+               </p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the version number for 
+<b class="command">smbd</b>.</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 <A
-HREF="smb.conf.5.html"
-TARGET="_top"
-><TT
-CLASS="FILENAME"
->smb.conf(5)</TT
-></A
-> for more information.
+to provide. See <a href="smb.conf.5.html" target="_top"><tt class="filename">
+smb.conf(5)</tt></a> for more information.
 The default configuration file name is determined at 
-compile time.</P
-></DD
-><DT
->-d|--debug=debuglevel</DT
-><DD
-><P
-><VAR
-CLASS="REPLACEABLE"
->debuglevel</VAR
-> is an integer 
+compile time.</p></dd><dt><span class="term">-d|--debug=debuglevel</span></dt><dd><p><i class="replaceable"><tt>debuglevel</tt></i> 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 
+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 
+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
-HREF="smb.conf.5.html#loglevel"
-TARGET="_top"
->log
-level</A
-> parameter in the <A
-HREF="smb.conf.5.html"
-TARGET="_top"
-><TT
-CLASS="FILENAME"
->smb.conf(5)</TT
-></A
-> file.</P
-></DD
-><DT
->-l|--logfile=logbasename</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
-></DL
-></DIV
-></DIV
-><DIV
-CLASS="REFSECT1"
-><A
-NAME="AEN66"
-></A
-><H2
->COMMANDS</H2
-><P
-><SPAN
-CLASS="emphasis"
-><I
-CLASS="EMPHASIS"
->VFS COMMANDS</I
-></SPAN
-></P
-><P
-></P
-><UL
-><LI
-><P
-><B
-CLASS="COMMAND"
->load &#60;module.so&#62;</B
-> - Load specified VFS module </P
-></LI
-><LI
-><P
-><B
-CLASS="COMMAND"
->populate &#60;char&#62; &#60;size&#62;</B
-> - Populate a data buffer with the specified data
-               </P
-></LI
-><LI
-><P
-><B
-CLASS="COMMAND"
->showdata [&#60;offset&#62; &#60;len&#62;]</B
-> - Show data currently in data buffer
-               </P
-></LI
-><LI
-><P
-><B
-CLASS="COMMAND"
->connect</B
-> - VFS connect()</P
-></LI
-><LI
-><P
-><B
-CLASS="COMMAND"
->disconnect</B
-> - VFS disconnect()</P
-></LI
-><LI
-><P
-><B
-CLASS="COMMAND"
->disk_free</B
-> - VFS disk_free()</P
-></LI
-><LI
-><P
-><B
-CLASS="COMMAND"
->opendir</B
-> - VFS opendir()</P
-></LI
-><LI
-><P
-><B
-CLASS="COMMAND"
->readdir</B
-> - VFS readdir()</P
-></LI
-><LI
-><P
-><B
-CLASS="COMMAND"
->mkdir</B
-> - VFS mkdir()</P
-></LI
-><LI
-><P
-><B
-CLASS="COMMAND"
->rmdir</B
-> - VFS rmdir()</P
-></LI
-><LI
-><P
-><B
-CLASS="COMMAND"
->closedir</B
-> - VFS closedir()</P
-></LI
-><LI
-><P
-><B
-CLASS="COMMAND"
->open</B
-> - VFS open()</P
-></LI
-><LI
-><P
-><B
-CLASS="COMMAND"
->close</B
-> - VFS close()</P
-></LI
-><LI
-><P
-><B
-CLASS="COMMAND"
->read</B
-> - VFS read()</P
-></LI
-><LI
-><P
-><B
-CLASS="COMMAND"
->write</B
-> - VFS write()</P
-></LI
-><LI
-><P
-><B
-CLASS="COMMAND"
->lseek</B
-> - VFS lseek()</P
-></LI
-><LI
-><P
-><B
-CLASS="COMMAND"
->rename</B
-> - VFS rename()</P
-></LI
-><LI
-><P
-><B
-CLASS="COMMAND"
->fsync</B
-> - VFS fsync()</P
-></LI
-><LI
-><P
-><B
-CLASS="COMMAND"
->stat</B
-> - VFS stat()</P
-></LI
-><LI
-><P
-><B
-CLASS="COMMAND"
->fstat</B
-> - VFS fstat()</P
-></LI
-><LI
-><P
-><B
-CLASS="COMMAND"
->lstat</B
-> - VFS lstat()</P
-></LI
-><LI
-><P
-><B
-CLASS="COMMAND"
->unlink</B
-> - VFS unlink()</P
-></LI
-><LI
-><P
-><B
-CLASS="COMMAND"
->chmod</B
-> - VFS chmod()</P
-></LI
-><LI
-><P
-><B
-CLASS="COMMAND"
->fchmod</B
-> - VFS fchmod()</P
-></LI
-><LI
-><P
-><B
-CLASS="COMMAND"
->chown</B
-> - VFS chown()</P
-></LI
-><LI
-><P
-><B
-CLASS="COMMAND"
->fchown</B
-> - VFS fchown()</P
-></LI
-><LI
-><P
-><B
-CLASS="COMMAND"
->chdir</B
-> - VFS chdir()</P
-></LI
-><LI
-><P
-><B
-CLASS="COMMAND"
->getwd</B
-> - VFS getwd()</P
-></LI
-><LI
-><P
-><B
-CLASS="COMMAND"
->utime</B
-> - VFS utime()</P
-></LI
-><LI
-><P
-><B
-CLASS="COMMAND"
->ftruncate</B
-> - VFS ftruncate()</P
-></LI
-><LI
-><P
-><B
-CLASS="COMMAND"
->lock</B
-> - VFS lock()</P
-></LI
-><LI
-><P
-><B
-CLASS="COMMAND"
->symlink</B
-> - VFS symlink()</P
-></LI
-><LI
-><P
-><B
-CLASS="COMMAND"
->readlink</B
-> - VFS readlink()</P
-></LI
-><LI
-><P
-><B
-CLASS="COMMAND"
->link</B
-> - VFS link()</P
-></LI
-><LI
-><P
-><B
-CLASS="COMMAND"
->mknod</B
-> - VFS mknod()</P
-></LI
-><LI
-><P
-><B
-CLASS="COMMAND"
->realpath</B
-> - VFS realpath()</P
-></LI
-></UL
-><P
-><SPAN
-CLASS="emphasis"
-><I
-CLASS="EMPHASIS"
->GENERAL COMMANDS</I
-></SPAN
-></P
-><P
-></P
-><UL
-><LI
-><P
-><B
-CLASS="COMMAND"
->conf &#60;smb.conf&#62;</B
-> - Load a different configuration file</P
-></LI
-><LI
-><P
-><B
-CLASS="COMMAND"
->help [&#60;command&#62;]</B
-> - Get list of commands or info about specified command</P
-></LI
-><LI
-><P
-><B
-CLASS="COMMAND"
->debuglevel &#60;level&#62;</B
-> - Set debug level</P
-></LI
-><LI
-><P
-><B
-CLASS="COMMAND"
->freemem</B
-> - Free memory currently in use</P
-></LI
-><LI
-><P
-><B
-CLASS="COMMAND"
->exit</B
-> - Exit vfstest</P
-></LI
-></UL
-></DIV
-><DIV
-CLASS="REFSECT1"
-><A
-NAME="AEN197"
-></A
-><H2
->VERSION</H2
-><P
->This man page is correct for version 3.0 of the Samba
-       suite.</P
-></DIV
-><DIV
-CLASS="REFSECT1"
-><A
-NAME="AEN200"
-></A
-><H2
->AUTHOR</H2
-><P
->The original Samba software and related utilities
+data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will 
+override the <a href="smb.conf.5.html#loglevel" target="_top">log
+level</a> parameter in the <a href="smb.conf.5.html" target="_top">
+<tt class="filename">smb.conf(5)</tt></a> file.</p></dd><dt><span class="term">-l|--logfile=logbasename</span></dt><dd><p>File name for log/debug files. The extension
+<tt class="constant">&quot;.client&quot;</tt> will be appended. The log file is
+never removed by the client.
+</p></dd></dl></div></div><div class="refsect1" lang="en"><h2>COMMANDS</h2><p><span class="emphasis"><em>VFS COMMANDS</em></span></p><div class="itemizedlist"><ul type="disc"><li><p><b class="command">load &lt;module.so&gt;</b> - Load specified VFS module </p></li><li><p><b class="command">populate &lt;char&gt; &lt;size&gt;</b> - Populate a data buffer with the specified data
+               </p></li><li><p><b class="command">showdata [&lt;offset&gt; &lt;len&gt;]</b> - Show data currently in data buffer
+               </p></li><li><p><b class="command">connect</b> - VFS connect()</p></li><li><p><b class="command">disconnect</b> - VFS disconnect()</p></li><li><p><b class="command">disk_free</b> - VFS disk_free()</p></li><li><p><b class="command">opendir</b> - VFS opendir()</p></li><li><p><b class="command">readdir</b> - VFS readdir()</p></li><li><p><b class="command">mkdir</b> - VFS mkdir()</p></li><li><p><b class="command">rmdir</b> - VFS rmdir()</p></li><li><p><b class="command">closedir</b> - VFS closedir()</p></li><li><p><b class="command">open</b> - VFS open()</p></li><li><p><b class="command">close</b> - VFS close()</p></li><li><p><b class="command">read</b> - VFS read()</p></li><li><p><b class="command">write</b> - VFS write()</p></li><li><p><b class="command">lseek</b> - VFS lseek()</p></li><li><p><b class="command">rename</b> - VFS rename()</p></li><li><p><b class="command">fsync</b> - VFS fsync()</p></li><li><p><b class="command">stat</b> - VFS stat()</p></li><li><p><b class="command">fstat</b> - VFS fstat()</p></li><li><p><b class="command">lstat</b> - VFS lstat()</p></li><li><p><b class="command">unlink</b> - VFS unlink()</p></li><li><p><b class="command">chmod</b> - VFS chmod()</p></li><li><p><b class="command">fchmod</b> - VFS fchmod()</p></li><li><p><b class="command">chown</b> - VFS chown()</p></li><li><p><b class="command">fchown</b> - VFS fchown()</p></li><li><p><b class="command">chdir</b> - VFS chdir()</p></li><li><p><b class="command">getwd</b> - VFS getwd()</p></li><li><p><b class="command">utime</b> - VFS utime()</p></li><li><p><b class="command">ftruncate</b> - VFS ftruncate()</p></li><li><p><b class="command">lock</b> - VFS lock()</p></li><li><p><b class="command">symlink</b> - VFS symlink()</p></li><li><p><b class="command">readlink</b> - VFS readlink()</p></li><li><p><b class="command">link</b> - VFS link()</p></li><li><p><b class="command">mknod</b> - VFS mknod()</p></li><li><p><b class="command">realpath</b> - VFS realpath()</p></li></ul></div><p><span class="emphasis"><em>GENERAL COMMANDS</em></span></p><div class="itemizedlist"><ul type="disc"><li><p><b class="command">conf &lt;smb.conf&gt;</b> - Load a different configuration file</p></li><li><p><b class="command">help [&lt;command&gt;]</b> - Get list of commands or info about specified command</p></li><li><p><b class="command">debuglevel &lt;level&gt;</b> - Set debug level</p></li><li><p><b class="command">freemem</b> - Free memory currently in use</p></li><li><p><b class="command">exit</b> - Exit vfstest</p></li></ul></div></div><div class="refsect1" lang="en"><h2>VERSION</h2><p>This man page is correct for version 3.0 of the Samba
+       suite.</p></div><div class="refsect1" lang="en"><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
-></BODY
-></HTML
->
\ No newline at end of file
+       to the way the Linux kernel is developed.</p><p>The vfstest man page was written by Jelmer Vernooij.</p></div></div></body></html>