docs: man masktest: Add missing meta data.
[Samba.git] / source4 / torture / man / masktest.1.xml
blob9cd46e34647c6fbfaf69f84da2574edd1004c363
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="masktest.1">
5 <refmeta>
6         <refentrytitle>masktest</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>masktest</refname>
16         <refpurpose>Find differences in wildcard matching between 
17         Samba's implementation and that of a remote server.</refpurpose>
18 </refnamediv>
20 <refsynopsisdiv>
21         <cmdsynopsis>
22                 <command>masktest</command>
23                 <arg choice="req">//server/share</arg>
24                 <arg choice="opt">-U user%pass</arg>
25                 <arg choice="opt">-d debuglevel</arg>
26                 <arg choice="opt">-W workgroup</arg>
27                 <arg choice="opt">-n numloops</arg>
28                 <arg choice="opt">-s seed</arg>
29                 <arg choice="opt">-a</arg>
30                 <arg choice="opt">-E</arg>
31                 <arg choice="opt">-M max protocol</arg>
32                 <arg choice="opt">-f filechars</arg>
33                 <arg choice="opt">-m maskchars</arg>
34                 <arg choice="opt">-v</arg>
35         </cmdsynopsis>
36         
37 </refsynopsisdiv>
39 <refsect1>
40         <title>DESCRIPTION</title>
42         <para><application>masktest</application> is a utility for 
43                 detecting differences in behaviour between Samba's 
44                 own implementation and that of a remote server.
45                 It will run generate random filenames/masks and 
46                 check if these match the same files they do on the remote file as 
47                 they do on the local server. It will display any differences it finds.
48         </para>
50         <para>
51                 This utility is used by the Samba team to find differences in 
52                 behaviour between Samba and Windows servers. 
53         </para>
54 </refsect1>
57 <refsect1>
58         <title>OPTIONS</title>
60         <variablelist>
61                 <varlistentry>
62                         <term>-U user%pass</term>
63                         <listitem><para>
64                                         Specify the user and password to use when logging on 
65                                         on the shares. This parameter can be specified twice 
66                                         (once for the first server, once for the second).
67                         </para></listitem>
68                 </varlistentry>
70                 <varlistentry>
71                         <term>-s seed</term>
72                         <listitem><para>
73                                         Seed the random number generator with the specified value.
74                         </para></listitem>
75                 </varlistentry>
77                 <varlistentry>
78                         <term>-n numops</term>
79                         <listitem><para>Set the number of operations to perform.</para></listitem>
80                 </varlistentry>
82                 <varlistentry>
83                         <term>-a</term>
84                         <listitem><para>Print the operations that are performed. </para></listitem>
85                 </varlistentry>
86                 
87                 <varlistentry>
88                         <term>-M max_protocol</term>
89                         <listitem><para>
90                                         Maximum protocol to use.
91                         </para></listitem>
92                 </varlistentry>
94                 <varlistentry>
95                         <term>-f</term>
96                         <listitem><para>Specify characters that can be used 
97                                         when generating file names. Default: abcdefghijklm.</para></listitem>
98                 </varlistentry>
100                 <varlistentry>
101                         <term>-E</term>
102                         <listitem><para>Abort when difference in behaviour is found.</para></listitem>
103                 </varlistentry>
105                 <varlistentry>
106                         <term>-m maskchars</term>
107                         <listitem><para>Specify characters used for wildcards.</para></listitem>
108                 </varlistentry>
110                 <varlistentry>
111                         <term>-v</term>
112                         <listitem><para>Be verbose</para></listitem>
113                 </varlistentry>
115         </variablelist>
116 </refsect1>
118 <refsect1>
119         <title>VERSION</title>
121         <para>This man page is correct for version 4.0 of the Samba suite.</para>
122 </refsect1>
124 <refsect1>
125         <title>SEE ALSO</title>
127         <para>Samba</para>
129 </refsect1>
131 <refsect1>
132         <title>AUTHOR</title>
134         <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>
136         <para>masktest was written by Andrew Tridgell.</para>
138         <para>This manpage was written by Jelmer Vernooij.</para>
139         
140 </refsect1>
142 </refentry>