docs/manpages/vfstest.1.xml

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