377d2f2e967d2dafee6795c656c70e34f9a55620
[samba.git] / source / torture / man / gentest.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                                   
4 <refentry id="gentest.1">
5
6 <refmeta>
7         <refentrytitle>gentest</refentrytitle>
8         <manvolnum>1</manvolnum>
9 </refmeta>
10
11
12 <refnamediv>
13         <refname>gentest</refname>
14         <refpurpose>Run random generic SMB operations against two SMB servers 
15         and show the differences in behavior</refpurpose>
16 </refnamediv>
17
18 <refsynopsisdiv>
19         <cmdsynopsis>
20                 <command>gentest</command>
21                 <arg choice="req">//server1/share1</arg>
22                 <arg choice="req">//server2/share2</arg>
23                 <arg choice="req">-U user%pass</arg>
24                 <arg choice="req">-U user%pass</arg>
25                 <arg choice="opt">-s seed</arg>
26                 <arg choice="opt">-o numops</arg>
27                 <arg choice="opt">-a</arg>
28                 <arg choice="opt">-A</arg>
29                 <arg choice="opt">-i FILE</arg>
30                 <arg choice="opt">-O</arg>
31                 <arg choice="opt">-S FILE</arg>
32                 <arg choice="opt">-L</arg>
33                 <arg choice="opt">-F</arg>
34                 <arg choice="opt">-C</arg>
35                 <arg choice="opt">-X</arg>
36         </cmdsynopsis>
37         
38 </refsynopsisdiv>
39
40 <refsect1>
41         <title>DESCRIPTION</title>
42
43         <para><application>gentest</application> is a utility for 
44                 detecting differences in behaviour between SMB servers. 
45                 It will run a random set of generic operations against 
46                 <parameter>//server1/share1</parameter> and then the same 
47                 random set against <parameter>//server2/share2</parameter>
48                 and display the differences in the responses it gets.
49         </para>
50
51         <para>
52                 This utility is used by the Samba team to find differences in 
53                 behaviour between Samba and Windows servers. 
54         </para>
55 </refsect1>
56
57
58 <refsect1>
59         <title>OPTIONS</title>
60
61         <variablelist>
62                 <varlistentry>
63                         <term>-U user%pass</term>
64                         <listitem><para>
65                                         Specify the user and password to use when logging on 
66                                         on the shares. This parameter is mandatory and has to 
67                                         be specified twice.
68                         </para></listitem>
69                 </varlistentry>
70
71                 <varlistentry>
72                         <term>-s seed</term>
73                         <listitem><para>
74                                         Seed the random number generator with the specified value.
75                         </para></listitem>
76                 </varlistentry>
77
78                 <varlistentry>
79                         <term>-o numops</term>
80                         <listitem><para>Set the number of operations to perform.</para></listitem>
81                 </varlistentry>
82
83                 <varlistentry>
84                         <term>-a</term>
85                         <listitem><para>Print the operations that are performed. </para></listitem>
86                 </varlistentry>
87                 
88                 <varlistentry>
89                         <term>-A</term>
90                         <listitem><para>Backtrack to find minimal number of operations 
91                                         required to make the response to a certain call differ.
92                         </para></listitem>
93                 </varlistentry>
94
95                 <varlistentry>
96                         <term>-i FILE</term>
97                         <listitem><para>
98                                         Specify a file containing the names of fields that 
99                                         have to be ignored (such as time fields). See 
100                                         below for a description of the file format.
101                         </para></listitem>
102                 </varlistentry>
103
104                 <varlistentry>
105                         <term>-O</term>
106                         <listitem><para>Enable oplocks.</para></listitem>
107                 </varlistentry>
108
109                 <varlistentry>
110                         <term>-S FILE</term>
111                         <listitem><para>Set preset seeds file. The default is <filename>gentest_seeds.dat</filename>.</para></listitem>
112                 </varlistentry>
113
114                 <varlistentry>
115                         <term>-L</term>
116                         <listitem><para>Use preset seeds</para></listitem>
117                 </varlistentry>
118
119                 <varlistentry>
120                         <term>-F</term>
121                         <listitem><para>Fast reconnect (just close files)</para></listitem>
122                 </varlistentry>
123
124                 <varlistentry>
125                         <term>-C</term>
126                         <listitem><para>Continuous analysis mode</para></listitem>
127                 </varlistentry>
128
129                 <varlistentry>
130                         <term>-X</term>
131                         <listitem><para>Analyse even when the test succeeded.</para></listitem>
132                 </varlistentry>
133         </variablelist>
134 </refsect1>
135
136 <refsect1>
137         <title>VERSION</title>
138
139         <para>This man page is correct for version 4.0 of the Samba suite.</para>
140 </refsect1>
141
142 <refsect1>
143         <title>SEE ALSO</title>
144
145         <para>Samba</para>
146
147 </refsect1>
148
149 <refsect1>
150         <title>AUTHOR</title>
151
152         <para>gentest was written by Andrew Tridgell.</para>
153
154         <para>This manpage was written by Jelmer Vernooij.</para>
155         
156 </refsect1>
157
158 </refentry>