r12209: Fix some issues with XML entities.
[samba.git] / source / torture / man / locktest.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="locktest.1">
4
5 <refmeta>
6         <refentrytitle>locktest</refentrytitle>
7         <manvolnum>1</manvolnum>
8 </refmeta>
9
10
11 <refnamediv>
12         <refname>locktest</refname>
13         <refpurpose>Find differences in locking between two SMB servers</refpurpose>
14 </refnamediv>
15
16 <refsynopsisdiv>
17         <cmdsynopsis>
18                 <command>locktest</command>
19                 <arg choice="req">//server1/share1</arg>
20                 <arg choice="req">//server2/share2</arg>
21                 <arg choice="opt">-U user%pass</arg>
22                 <arg choice="opt">-U user%pass</arg>
23                 <arg choice="opt">-s seed</arg>
24                 <arg choice="opt">-o numops</arg>
25                 <arg choice="opt">-a</arg>
26                 <arg choice="opt">-O</arg>
27                 <arg choice="opt">-E</arg>
28                 <arg choice="opt">-Z</arg>
29                 <arg choice="opt">-R range</arg>
30                 <arg choice="opt">-B base</arg>
31                 <arg choice="opt">-M min</arg>
32         </cmdsynopsis>
33         
34 </refsynopsisdiv>
35
36 <refsect1>
37         <title>DESCRIPTION</title>
38
39         <para><application>locktest</application> is a utility for 
40                 detecting differences in behaviour in locking between SMB servers. 
41                 It will run a random set of locking operations against 
42                 <parameter>//server1/share1</parameter> and then the same 
43                 random set against <parameter>//server2/share2</parameter>
44                 and display the differences in the responses it gets.
45         </para>
46
47         <para>
48                 This utility is used by the Samba team to find differences in 
49                 behaviour between Samba and Windows servers. 
50         </para>
51 </refsect1>
52
53
54 <refsect1>
55         <title>OPTIONS</title>
56
57         <variablelist>
58                 <varlistentry>
59                         <term>-U user%pass</term>
60                         <listitem><para>
61                                         Specify the user and password to use when logging on 
62                                         on the shares. This parameter can be specified twice 
63                                         (once for the first server, once for the second).
64                         </para></listitem>
65                 </varlistentry>
66
67                 <varlistentry>
68                         <term>-s seed</term>
69                         <listitem><para>
70                                         Seed the random number generator with the specified value.
71                         </para></listitem>
72                 </varlistentry>
73
74                 <varlistentry>
75                         <term>-o numops</term>
76                         <listitem><para>Set the number of operations to perform.</para></listitem>
77                 </varlistentry>
78
79                 <varlistentry>
80                         <term>-a</term>
81                         <listitem><para>Print the operations that are performed. </para></listitem>
82                 </varlistentry>
83                 
84                 <varlistentry>
85                         <term>-A</term>
86                         <listitem><para>Backtrack to find minimal number of operations 
87                                         required to make the response to a certain call differ.
88                         </para></listitem>
89                 </varlistentry>
90
91                 <varlistentry>
92                         <term>-O</term>
93                         <listitem><para>Enable oplocks.</para></listitem>
94                 </varlistentry>
95
96                 <varlistentry>
97                         <term>-u</term>
98                         <listitem><para>Hide unlock fails.</para></listitem>
99                 </varlistentry>
100
101                 <varlistentry>
102                         <term>-E</term>
103                         <listitem><para>enable exact error code checking</para></listitem>
104                 </varlistentry>
105
106                 <varlistentry>
107                         <term>-Z</term>
108                         <listitem><para>enable the zero/zero lock</para></listitem>
109                 </varlistentry>
110
111                 <varlistentry>
112                         <term>-R range</term>
113                         <listitem><para>set lock range</para></listitem>
114                 </varlistentry>
115
116                 <varlistentry>
117                         <term>-B base</term>
118                         <listitem><para>set lock base</para></listitem>
119                 </varlistentry>
120
121                 <varlistentry>
122                         <term>-M min</term>
123                         <listitem><para>set min lock length</para></listitem>
124                 </varlistentry>
125
126                 <varlistentry>
127                         <term>-k</term>
128                         <listitem><para>Use kerberos</para></listitem>
129                 </varlistentry>
130         </variablelist>
131 </refsect1>
132
133 <refsect1>
134         <title>VERSION</title>
135
136         <para>This man page is correct for version 4.0 of the Samba suite.</para>
137 </refsect1>
138
139 <refsect1>
140         <title>SEE ALSO</title>
141
142         <para>Samba</para>
143
144 </refsect1>
145
146 <refsect1>
147         <title>AUTHOR</title>
148
149         <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>
150
151         <para>locktest was written by Andrew Tridgell.</para>
152
153         <para>This manpage was written by Jelmer Vernooij.</para>
154         
155 </refsect1>
156
157 </refentry>