docs/docbook/manpages/vfstest.1.sgml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
   2 <refentry id="vfstest">
   3
   4 <refmeta>
   5         <refentrytitle>vfstest</refentrytitle>
   6         <manvolnum>1</manvolnum>
   7 </refmeta>
   8
   9
  10 <refnamediv>
  11         <refname>vfstest</refname>
  12         <refpurpose>tool for testing samba VFS modules </refpurpose>
  13 </refnamediv>
  14
  15 <refsynopsisdiv>
  16         <cmdsynopsis>
  17                 <command>vfstest</command>
  18                 <arg choice="opt">-d debuglevel</arg>
  19                 <arg choice="opt">-c command</arg>
  20                 <arg choice="opt">-l logfile</arg>
  21                 <arg choice="opt">-h</arg>
  22         </cmdsynopsis>
  23 </refsynopsisdiv>
  24
  25 <refsect1>
  26         <title>DESCRIPTION</title>
  27
  28         <para>This tool is part of the <ulink url="samba.7.html">
  29         Samba</ulink> suite.</para>
  30
  31         <para><command>vfstest</command> is a small command line
  32         utility that has the ability to test dso samba VFS modules. It gives the
  33         user the ability to call the various VFS functions manually and
  34         supports cascaded VFS modules.
  35         </para>
  36 </refsect1>
  37
  38
  39 <refsect1>
  40         <title>OPTIONS</title>
  41
  42         <variablelist>
  43
  44                 <varlistentry>
  45                 <term>-c|--command=command</term>
  46                 <listitem><para>Execute the specified (colon-seperated) commands.
  47                 See below for the commands that are available.
  48                 </para> </listitem>
  49                 </varlistentry>
  50
  51                 <varlistentry>
  52                 <term>-d|--debug=debuglevel</term>
  53                 <listitem><para>set the debuglevel. Debug level 0 is the lowest
  54                 and 100 being the highest. This should be set to 100 if you are
  55                 planning on submitting a bug report to the Samba team (see
  56                 <filename>BUGS.txt</filename>).
  57                 </para></listitem>
  58                 </varlistentry>
  59
  60                 <varlistentry>
  61                 <term>-h|--help</term>
  62                 <listitem><para>Print a summary of command line options.
  63                 </para></listitem>
  64                 </varlistentry>
  65
  66                 <varlistentry>
  67                 <term>-l|--logfile=logbasename</term>
  68                 <listitem><para>File name for log/debug files. The extension
  69                 <constant>'.client'</constant> will be appended. The log file is never removed
  70                 by the client.
  71                 </para></listitem>
  72                 </varlistentry>
  73
  74         </variablelist>
  75 </refsect1>
  76
  77
  78 <refsect1>
  79         <title>COMMANDS</title>
  80
  81         <para><emphasis>VFS COMMANDS</emphasis></para>
  82         <itemizedlist>
  83                 <listitem><para><command>load &lt;module.so&gt;</command> - Load specified VFS module </para></listitem>
  84
  85                 <listitem><para><command>populate &lt;char&gt; &lt;size&gt;</command> - Populate a data buffer with the specified data
  86                 </para></listitem>
  87
  88                 <listitem><para><command>showdata [&lt;offset&gt; &lt;len&gt;]</command> - Show data currently in data buffer
  89                 </para></listitem>
  90
  91                 <listitem><para><command>connect</command> - VFS connect()</para></listitem>
  92                 <listitem><para><command>disconnect</command> - VFS disconnect()</para></listitem>
  93                 <listitem><para><command>disk_free</command> - VFS disk_free()</para></listitem>
  94                 <listitem><para><command>opendir</command> - VFS opendir()</para></listitem>
  95                 <listitem><para><command>readdir</command> - VFS readdir()</para></listitem>
  96                 <listitem><para><command>mkdir</command> - VFS mkdir()</para></listitem>
  97                 <listitem><para><command>rmdir</command> - VFS rmdir()</para></listitem>
  98                 <listitem><para><command>closedir</command> - VFS closedir()</para></listitem>
  99                 <listitem><para><command>open</command> - VFS open()</para></listitem>
 100                 <listitem><para><command>close</command> - VFS close()</para></listitem>
 101                 <listitem><para><command>read</command> - VFS read()</para></listitem>
 102                 <listitem><para><command>write</command> - VFS write()</para></listitem>
 103                 <listitem><para><command>lseek</command> - VFS lseek()</para></listitem>
 104                 <listitem><para><command>rename</command> - VFS rename()</para></listitem>
 105                 <listitem><para><command>fsync</command> - VFS fsync()</para></listitem>
 106                 <listitem><para><command>stat</command> - VFS stat()</para></listitem>
 107                 <listitem><para><command>fstat</command> - VFS fstat()</para></listitem>
 108                 <listitem><para><command>lstat</command> - VFS lstat()</para></listitem>
 109                 <listitem><para><command>unlink</command> - VFS unlink()</para></listitem>
 110                 <listitem><para><command>chmod</command> - VFS chmod()</para></listitem>
 111                 <listitem><para><command>fchmod</command> - VFS fchmod()</para></listitem>
 112                 <listitem><para><command>chown</command> - VFS chown()</para></listitem>
 113                 <listitem><para><command>fchown</command> - VFS fchown()</para></listitem>
 114                 <listitem><para><command>chdir</command> - VFS chdir()</para></listitem>
 115                 <listitem><para><command>getwd</command> - VFS getwd()</para></listitem>
 116                 <listitem><para><command>utime</command> - VFS utime()</para></listitem>
 117                 <listitem><para><command>ftruncate</command> - VFS ftruncate()</para></listitem>
 118                 <listitem><para><command>lock</command> - VFS lock()</para></listitem>
 119                 <listitem><para><command>symlink</command> - VFS symlink()</para></listitem>
 120                 <listitem><para><command>readlink</command> - VFS readlink()</para></listitem>
 121                 <listitem><para><command>link</command> - VFS link()</para></listitem>
 122                 <listitem><para><command>mknod</command> - VFS mknod()</para></listitem>
 123                 <listitem><para><command>realpath</command> - VFS realpath()</para></listitem>
 124         </itemizedlist>
 125
 126         <para><emphasis>GENERAL COMMANDS</emphasis></para>
 127         <itemizedlist>
 128                 <listitem><para><command>conf &lt;smb.conf&gt;</command> - Load a different configuration file</para></listitem>
 129
 130                 <listitem><para><command>help [&lt;command&gt;]</command> - Get list of commands or info about specified command</para></listitem>
 131
 132                 <listitem><para><command>debuglevel &lt;level&gt;</command> - Set debug level</para></listitem>
 133
 134                 <listitem><para><command>freemem</command> - Free memory currently in use</para></listitem>
 135
 136                 <listitem><para><command>exit</command> - Exit vfstest</para></listitem>
 137         </itemizedlist>
 138
 139 </refsect1>
 140
 141 <refsect1>
 142         <title>VERSION</title>
 143
 144         <para>This man page is correct for version 3.0 of the Samba
 145         suite.</para>
 146 </refsect1>
 147
 148 <refsect1>
 149         <title>AUTHOR</title>
 150
 151         <para>The original Samba software and related utilities
 152         were created by Andrew Tridgell. Samba is now developed
 153         by the Samba Team as an Open Source project similar
 154         to the way the Linux kernel is developed.</para>
 155
 156         <para>The vfstest man page was written by Jelmer Vernooij.</para>
 157 </refsect1>
 158
 159 </refentry>