source: branches/samba-3.5.x/docs-xml/manpages-3/vfstest.1.xml@ 824

Last change on this file since 824 was 414, checked in by Herwig Bauernfeind, 15 years ago

Samba 3.5.0: Initial import
File size: 5.8 KB
Line 
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">3.5</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">-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 &stdarg.server.debug;
66 &popt.common.samba;
67
68 </variablelist>
69</refsect1>
70
71
72<refsect1>
73 <title>COMMANDS</title>
74
75 <para><emphasis>VFS COMMANDS</emphasis></para>
76 <itemizedlist>
77 <listitem><para><command>load &lt;module.so&gt;</command> - Load specified VFS module </para></listitem>
78
79 <listitem><para><command>populate &lt;char&gt; &lt;size&gt;</command> - Populate a data buffer with the specified data
80 </para></listitem>
81
82 <listitem><para><command>showdata [&lt;offset&gt; &lt;len&gt;]</command> - Show data currently in data buffer
83 </para></listitem>
84
85 <listitem><para><command>connect</command> - VFS connect()</para></listitem>
86 <listitem><para><command>disconnect</command> - VFS disconnect()</para></listitem>
87 <listitem><para><command>disk_free</command> - VFS disk_free()</para></listitem>
88 <listitem><para><command>opendir</command> - VFS opendir()</para></listitem>
89 <listitem><para><command>readdir</command> - VFS readdir()</para></listitem>
90 <listitem><para><command>mkdir</command> - VFS mkdir()</para></listitem>
91 <listitem><para><command>rmdir</command> - VFS rmdir()</para></listitem>
92 <listitem><para><command>closedir</command> - VFS closedir()</para></listitem>
93 <listitem><para><command>open</command> - VFS open()</para></listitem>
94 <listitem><para><command>close</command> - VFS close()</para></listitem>
95 <listitem><para><command>read</command> - VFS read()</para></listitem>
96 <listitem><para><command>write</command> - VFS write()</para></listitem>
97 <listitem><para><command>lseek</command> - VFS lseek()</para></listitem>
98 <listitem><para><command>rename</command> - VFS rename()</para></listitem>
99 <listitem><para><command>fsync</command> - VFS fsync()</para></listitem>
100 <listitem><para><command>stat</command> - VFS stat()</para></listitem>
101 <listitem><para><command>fstat</command> - VFS fstat()</para></listitem>
102 <listitem><para><command>lstat</command> - VFS lstat()</para></listitem>
103 <listitem><para><command>unlink</command> - VFS unlink()</para></listitem>
104 <listitem><para><command>chmod</command> - VFS chmod()</para></listitem>
105 <listitem><para><command>fchmod</command> - VFS fchmod()</para></listitem>
106 <listitem><para><command>chown</command> - VFS chown()</para></listitem>
107 <listitem><para><command>fchown</command> - VFS fchown()</para></listitem>
108 <listitem><para><command>chdir</command> - VFS chdir()</para></listitem>
109 <listitem><para><command>getwd</command> - VFS getwd()</para></listitem>
110 <listitem><para><command>utime</command> - VFS utime()</para></listitem>
111 <listitem><para><command>ftruncate</command> - VFS ftruncate()</para></listitem>
112 <listitem><para><command>lock</command> - VFS lock()</para></listitem>
113 <listitem><para><command>symlink</command> - VFS symlink()</para></listitem>
114 <listitem><para><command>readlink</command> - VFS readlink()</para></listitem>
115 <listitem><para><command>link</command> - VFS link()</para></listitem>
116 <listitem><para><command>mknod</command> - VFS mknod()</para></listitem>
117 <listitem><para><command>realpath</command> - VFS realpath()</para></listitem>
118 </itemizedlist>
119
120 <para><emphasis>GENERAL COMMANDS</emphasis></para>
121 <itemizedlist>
122 <listitem><para><command>conf &lt;smb.conf&gt;</command> - Load a different configuration file</para></listitem>
123
124 <listitem><para><command>help [&lt;command&gt;]</command> - Get list of commands or info about specified command</para></listitem>
125
126 <listitem><para><command>debuglevel &lt;level&gt;</command> - Set debug level</para></listitem>
127
128 <listitem><para><command>freemem</command> - Free memory currently in use</para></listitem>
129
130 <listitem><para><command>exit</command> - Exit vfstest</para></listitem>
131 </itemizedlist>
132
133</refsect1>
134
135<refsect1>
136 <title>VERSION</title>
137
138 <para>This man page is correct for version 3 of the Samba
139 suite.</para>
140</refsect1>
141
142<refsect1>
143 <title>AUTHOR</title>
144
145 <para>The original Samba software and related utilities
146 were created by Andrew Tridgell. Samba is now developed
147 by the Samba Team as an Open Source project similar
148 to the way the Linux kernel is developed.</para>
149
150 <para>The vfstest man page was written by Jelmer Vernooij.</para>
151</refsect1>
152
153</refentry>
Note: See TracBrowser for help on using the repository browser.