3dad70bb043a9b8f4148ceec9ebe90242bbc50fa
[samba.git] / source / torture / man / masktest.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="masktest.1">
4
5 <refmeta>
6         <refentrytitle>masktest</refentrytitle>
7         <manvolnum>1</manvolnum>
8 </refmeta>
9
10
11 <refnamediv>
12         <refname>masktest</refname>
13         <refpurpose>Find differences in wildcard matching between 
14         Samba's implementation and that of a remote server.</refpurpose>
15 </refnamediv>
16
17 <refsynopsisdiv>
18         <cmdsynopsis>
19                 <command>masktest</command>
20                 <arg choice="req">//server/share</arg>
21                 <arg choice="opt">-U user%pass</arg>
22                 <arg choice="opt">-d debuglevel</arg>
23                 <arg choice="opt">-W workgroup</arg>
24                 <arg choice="opt">-n numloops</arg>
25                 <arg choice="opt">-s seed</arg>
26                 <arg choice="opt">-a</arg>
27                 <arg choice="opt">-E</arg>
28                 <arg choice="opt">-M max protocol</arg>
29                 <arg choice="opt">-f filechars</arg>
30                 <arg choice="opt">-m maskchars</arg>
31                 <arg choice="opt">-v</arg>
32         </cmdsynopsis>
33         
34 </refsynopsisdiv>
35
36 <refsect1>
37         <title>DESCRIPTION</title>
38
39         <para><application>masktest</application> is a utility for 
40                 detecting differences in behaviour between Samba's 
41                 own implementation and that of a remote server.
42                 It will run generate random filenames/masks and 
43                 check if these match the same files they do on the remote file as 
44                 they do on the local server. It will display any differences it finds.
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>-n 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>-M max_protocol</term>
86                         <listitem><para>
87                                         Maximum protocol to use.
88                         </para></listitem>
89                 </varlistentry>
90
91                 <varlistentry>
92                         <term>-f</term>
93                         <listitem><para>Specify characters that can be used 
94                                         when generating file names. Default: abcdefghijklm.</para></listitem>
95                 </varlistentry>
96
97                 <varlistentry>
98                         <term>-E</term>
99                         <listitem><para>Abort when difference in behaviour is found.</para></listitem>
100                 </varlistentry>
101
102                 <varlistentry>
103                         <term>-m maskchars</term>
104                         <listitem><para>Specify characters used for wildcards.</para></listitem>
105                 </varlistentry>
106
107                 <varlistentry>
108                         <term>-v</term>
109                         <listitem><para>Be verbose</para></listitem>
110                 </varlistentry>
111
112         </variablelist>
113 </refsect1>
114
115 <refsect1>
116         <title>VERSION</title>
117
118         <para>This man page is correct for version 4.0 of the Samba suite.</para>
119 </refsect1>
120
121 <refsect1>
122         <title>SEE ALSO</title>
123
124         <para>Samba</para>
125
126 </refsect1>
127
128 <refsect1>
129         <title>AUTHOR</title>
130
131         &man.credits.samba;
132
133         <para>masktest was written by Andrew Tridgell.</para>
134
135         <para>This manpage was written by Jelmer Vernooij.</para>
136         
137 </refsect1>
138
139 </refentry>