docs/manpages-3/vfstest.1.xml

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