docs-xml/manpages/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         <refmiscinfo class="source">Samba</refmiscinfo>
   9         <refmiscinfo class="manual">User Commands</refmiscinfo>
  10         <refmiscinfo class="version">&doc.version;</refmiscinfo>
  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">-?|--help</arg>
  23                 <arg choice="opt">--usage</arg>
  24                 <arg choice="opt">-f|--file=STRING</arg>
  25                 <arg choice="opt">-c|--command=STRING</arg>
  26                 <arg choice="opt">-m|--memreport=INT</arg>
  27                 <arg choice="opt">-d|--debuglevel=DEBUGLEVEL</arg>
  28                 <arg choice="opt">--debug-stdout</arg>
  29                 <arg choice="opt">--configfile=CONFIGFILE</arg>
  30                 <arg choice="opt">--option=name=value</arg>
  31                 <arg choice="opt">-l|--log-basename=LOGFILEBASE</arg>
  32                 <arg choice="opt">--leak-report</arg>
  33                 <arg choice="opt">--leak-report-full</arg>
  34                 <arg choice="opt">-V|--version</arg>
  35         </cmdsynopsis>
  36 </refsynopsisdiv>
  37
  38 <refsect1>
  39         <title>DESCRIPTION</title>
  40
  41         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
  42         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  43
  44         <para><command>vfstest</command> is a small command line
  45         utility that has the ability to test dso samba VFS modules. It gives the
  46         user the ability to call the various VFS functions manually and
  47         supports cascaded VFS modules.
  48         </para>
  49 </refsect1>
  50
  51
  52 <refsect1>
  53         <title>OPTIONS</title>
  54
  55         <variablelist>
  56
  57                 <varlistentry>
  58                 <term>-c|--command=command</term>
  59                 <listitem><para>Execute the specified (<constant>semicolon</constant>-separated) commands.
  60                 See below for the commands that are available.
  61                 </para> </listitem>
  62                 </varlistentry>
  63
  64                 &popt.autohelp;
  65                 &cmdline.common.samba.client;
  66         </variablelist>
  67 </refsect1>
  68
  69
  70 <refsect1>
  71         <title>COMMANDS</title>
  72
  73         <para><emphasis>VFS COMMANDS</emphasis></para>
  74         <itemizedlist>
  75                 <listitem><para><command>load &lt;module.so&gt;</command> - Load specified VFS module </para></listitem>
  76
  77                 <listitem><para><command>populate &lt;char&gt; &lt;size&gt;</command> - Populate a data buffer with the specified data
  78                 </para></listitem>
  79
  80                 <listitem><para><command>showdata [&lt;offset&gt; &lt;len&gt;]</command> - Show data currently in data buffer
  81                 </para></listitem>
  82
  83                 <listitem><para><command>connect</command> - VFS connect()</para></listitem>
  84                 <listitem><para><command>disconnect</command> - VFS disconnect()</para></listitem>
  85                 <listitem><para><command>disk_free</command> - VFS disk_free()</para></listitem>
  86                 <listitem><para><command>opendir</command> - VFS opendir()</para></listitem>
  87                 <listitem><para><command>readdir</command> - VFS readdir()</para></listitem>
  88                 <listitem><para><command>mkdir</command> - VFS mkdir()</para></listitem>
  89                 <listitem><para><command>rmdir</command> - VFS rmdir()</para></listitem>
  90                 <listitem><para><command>closedir</command> - VFS closedir()</para></listitem>
  91                 <listitem><para><command>open</command> - VFS open()</para></listitem>
  92                 <listitem><para><command>close</command> - VFS close()</para></listitem>
  93                 <listitem><para><command>read</command> - VFS read()</para></listitem>
  94                 <listitem><para><command>write</command> - VFS write()</para></listitem>
  95                 <listitem><para><command>lseek</command> - VFS lseek()</para></listitem>
  96                 <listitem><para><command>rename</command> - VFS rename()</para></listitem>
  97                 <listitem><para><command>fsync</command> - VFS fsync()</para></listitem>
  98                 <listitem><para><command>stat</command> - VFS stat()</para></listitem>
  99                 <listitem><para><command>fstat</command> - VFS fstat()</para></listitem>
 100                 <listitem><para><command>lstat</command> - VFS lstat()</para></listitem>
 101                 <listitem><para><command>unlink</command> - VFS unlink()</para></listitem>
 102                 <listitem><para><command>chmod</command> - VFS chmod()</para></listitem>
 103                 <listitem><para><command>fchmod</command> - VFS fchmod()</para></listitem>
 104                 <listitem><para><command>chown</command> - VFS chown()</para></listitem>
 105                 <listitem><para><command>fchown</command> - VFS fchown()</para></listitem>
 106                 <listitem><para><command>chdir</command> - VFS chdir()</para></listitem>
 107                 <listitem><para><command>getwd</command> - VFS getwd()</para></listitem>
 108                 <listitem><para><command>utime</command> - VFS utime()</para></listitem>
 109                 <listitem><para><command>ftruncate</command> - VFS ftruncate()</para></listitem>
 110                 <listitem><para><command>lock</command> - VFS lock()</para></listitem>
 111                 <listitem><para><command>symlink</command> - VFS symlink()</para></listitem>
 112                 <listitem><para><command>readlink</command> - VFS readlink()</para></listitem>
 113                 <listitem><para><command>link</command> - VFS link()</para></listitem>
 114                 <listitem><para><command>mknod</command> - VFS mknod()</para></listitem>
 115                 <listitem><para><command>realpath</command> - VFS realpath()</para></listitem>
 116
 117                 <listitem><para><command>getxattr</command> - VFS getxattr()</para></listitem>
 118                 <listitem><para><command>listxattr</command> - VFS listxattr()</para></listitem>
 119                 <listitem><para><command>setxattr</command> - VFS setxattr()</para></listitem>
 120                 <listitem><para><command>removexattr</command> - VFS removexattr()</para></listitem>
 121                 <listitem><para><command>fget_nt_acl</command> - VFS fget_nt_acl()</para></listitem>
 122                 <listitem><para><command>get_nt_acl</command> - VFS get_nt_acl()</para></listitem>
 123                 <listitem><para><command>fset_nt_acl</command> - VFS fset_nt_acl()</para></listitem>
 124                 <listitem><para><command>set_nt_acl</command> - VFS open() and fset_nt_acl()</para></listitem>
 125                 <listitem><para><command>sys_acl_get_file</command> - VFS sys_acl_get_file()</para></listitem>
 126                 <listitem><para><command>sys_acl_get_fd</command> - VFS sys_acl_get_fd()</para></listitem>
 127                 <listitem><para><command>sys_acl_blob_get_file</command> - VFS sys_acl_blob_get_file()</para></listitem>
 128                 <listitem><para><command>sys_acl_blob_get_fd</command> - VFS sys_acl_blob_get_fd()</para></listitem>
 129                 <listitem><para><command>sys_acl_delete_def_file</command> - VFS sys_acl_delete_def_file()</para></listitem>
 130                 <listitem><para><command>test_chain</command> - test chain code</para></listitem>
 131                 <listitem><para><command>translate_name</command> - VFS translate_name()</para></listitem>
 132
 133         </itemizedlist>
 134
 135         <para><emphasis>GENERAL COMMANDS</emphasis></para>
 136         <itemizedlist>
 137                 <listitem><para><command>conf &lt;smb.conf&gt;</command> - Load a different configuration file</para></listitem>
 138
 139                 <listitem><para><command>help [&lt;command&gt;]</command> - Get list of commands or info about specified command</para></listitem>
 140
 141                 <listitem><para><command>debuglevel &lt;level&gt;</command> - Set debug level</para></listitem>
 142
 143                 <listitem><para><command>freemem</command> - Free memory currently in use</para></listitem>
 144
 145                 <listitem><para><command>exit</command> - Exit vfstest</para></listitem>
 146         </itemizedlist>
 147
 148 </refsect1>
 149
 150 <refsect1>
 151         <title>VERSION</title>
 152
 153         <para>This man page is part of version &doc.version; of the Samba
 154         suite.</para>
 155 </refsect1>
 156
 157 <refsect1>
 158         <title>AUTHOR</title>
 159
 160         <para>The original Samba software and related utilities
 161         were created by Andrew Tridgell. Samba is now developed
 162         by the Samba Team as an Open Source project similar
 163         to the way the Linux kernel is developed.</para>
 164
 165         <para>The vfstest man page was written by Jelmer Vernooij. Updated version by Guenter Kukkukk.</para>
 166 </refsect1>
 167
 168 </refentry>