samba-mirror/source4/torture/man/gentest.1.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<refentry id="gentest.1">

<refmeta>
	<refentrytitle>gentest</refentrytitle>
	<manvolnum>1</manvolnum>
	<refmiscinfo class="source">Samba</refmiscinfo>
	<refmiscinfo class="manual">Test Suite</refmiscinfo>
	<refmiscinfo class="version">4.0</refmiscinfo>
</refmeta>


<refnamediv>
	<refname>gentest</refname>
	<refpurpose>Run random generic SMB operations against two SMB servers 
	and show the differences in behavior</refpurpose>
</refnamediv>

<refsynopsisdiv>
	<cmdsynopsis>
		<command>gentest</command>
		<arg choice="req">//server1/share1</arg>
		<arg choice="req">//server2/share2</arg>
		<arg choice="req">-U user%pass</arg>
		<arg choice="req">-U user%pass</arg>
		<arg choice="opt">-s seed</arg>
		<arg choice="opt">-o numops</arg>
		<arg choice="opt">-a</arg>
		<arg choice="opt">-A</arg>
		<arg choice="opt">-i FILE</arg>
		<arg choice="opt">-O</arg>
		<arg choice="opt">-S FILE</arg>
		<arg choice="opt">-L</arg>
		<arg choice="opt">-F</arg>
		<arg choice="opt">-C</arg>
		<arg choice="opt">-X</arg>
	</cmdsynopsis>
	
</refsynopsisdiv>

<refsect1>
	<title>DESCRIPTION</title>

	<para><application>gentest</application> is a utility for 
		detecting differences in behaviour between SMB servers. 
		It will run a random set of generic operations against 
		<parameter>//server1/share1</parameter> and then the same 
		random set against <parameter>//server2/share2</parameter>
		and display the differences in the responses it gets.
	</para>

	<para>
		This utility is used by the Samba team to find differences in 
		behaviour between Samba and Windows servers. 
	</para>
</refsect1>


<refsect1>
	<title>OPTIONS</title>

	<variablelist>
		<varlistentry>
			<term>-U user%pass</term>
			<listitem><para>
					Specify the user and password to use when logging on 
					on the shares. This parameter is mandatory and has to 
					be specified twice.
			</para></listitem>
		</varlistentry>

		<varlistentry>
			<term>-s seed</term>
			<listitem><para>
					Seed the random number generator with the specified value.
			</para></listitem>
		</varlistentry>

		<varlistentry>
			<term>-o numops</term>
			<listitem><para>Set the number of operations to perform.</para></listitem>
		</varlistentry>

		<varlistentry>
			<term>-a</term>
			<listitem><para>Print the operations that are performed. </para></listitem>
		</varlistentry>
		
		<varlistentry>
			<term>-A</term>
			<listitem><para>Backtrack to find minimal number of operations 
					required to make the response to a certain call differ.
			</para></listitem>
		</varlistentry>

		<varlistentry>
			<term>-i FILE</term>
			<listitem><para>
					Specify a file containing the names of fields that 
					have to be ignored (such as time fields). See 
					below for a description of the file format.
			</para></listitem>
		</varlistentry>

		<varlistentry>
			<term>-O</term>
			<listitem><para>Enable oplocks.</para></listitem>
		</varlistentry>

		<varlistentry>
			<term>-S FILE</term>
			<listitem><para>Set preset seeds file. The default is <filename>gentest_seeds.dat</filename>.</para></listitem>
		</varlistentry>

		<varlistentry>
			<term>-L</term>
			<listitem><para>Use preset seeds</para></listitem>
		</varlistentry>

		<varlistentry>
			<term>-F</term>
			<listitem><para>Fast reconnect (just close files)</para></listitem>
		</varlistentry>

		<varlistentry>
			<term>-C</term>
			<listitem><para>Continuous analysis mode</para></listitem>
		</varlistentry>

		<varlistentry>
			<term>-X</term>
			<listitem><para>Analyse even when the test succeeded.</para></listitem>
		</varlistentry>
	</variablelist>
</refsect1>

<refsect1>
	<title>VERSION</title>

	<para>This man page is correct for version 4.0 of the Samba suite.</para>
</refsect1>

<refsect1>
	<title>SEE ALSO</title>

	<para>Samba</para>

</refsect1>

<refsect1>
	<title>AUTHOR</title>

	<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>

	<para>gentest was written by Andrew Tridgell.</para>

	<para>This manpage was written by Jelmer Vernooij.</para>
	
</refsect1>

</refentry>