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