r7117: Move more manpages to the source repository
[samba.git] / source / torture / man / smbtorture.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="smbtorture.1">
4
5 <refmeta>
6         <refentrytitle>smbtorture</refentrytitle>
7         <manvolnum>1</manvolnum>
8 </refmeta>
9
10
11 <refnamediv>
12         <refname>smbtorture</refname>
13         <refpurpose>Run a series of tests against a SMB server</refpurpose>
14 </refnamediv>
15
16 <refsynopsisdiv>
17         <cmdsynopsis>
18                 <command>smbtorture</command>
19         </cmdsynopsis>
20         
21         <cmdsynopsis>
22                 <command>smbtorture</command>
23                 <arg choice="req">//server/share</arg>
24                 <arg choice="opt">-d debuglevel</arg>
25                 <arg choice="opt">-U user%pass</arg>
26                 <arg choice="opt">-k</arg>
27                 <arg choice="opt">-N numprocs</arg>
28                 <arg choice="opt">-n netbios_name</arg>
29                 <arg choice="opt">-W workgroup</arg>
30                 <arg choice="opt">-o num_operations</arg>
31                 <arg choice="opt">-e num files(entries)</arg>
32                 <arg choice="opt">-O socket_options</arg>
33                 <arg choice="opt">-m maximum_protocol</arg>
34                 <arg choice="opt">-L</arg>
35                 <arg choice="opt">-c CLIENT.TXT</arg>
36                 <arg choice="opt">-t timelimit</arg>
37                 <arg choice="opt">-C filename</arg>
38                 <arg choice="opt">-A</arg>
39                 <arg choice="opt">-p port</arg>
40                 <arg choice="opt">-s seed</arg>
41                 <arg choice="opt">-f max_failures</arg>
42                 <arg choice="opt">-X</arg>
43                 TEST1 TEST2 ...
44         </cmdsynopsis>
45         
46 </refsynopsisdiv>
47
48 <refsect1>
49         <title>DESCRIPTION</title>
50
51         <para>smbtorture is a testsuite that runs several tests 
52                 against a SMB server. All tests are known to succeed 
53                 against a Windows 2003 server (?). Smbtorture's primary 
54                 goal is finding differences in implementations of the SMB protocol 
55                 and testing SMB servers.
56         </para>
57
58         <para>Any number of tests can be specified 
59                 on the command-line. If no tests are specified, all tests 
60                 are run. </para>
61
62         <para>If no arguments are specified at all, all available options 
63                 and tests are listed.</para>
64
65 </refsect1>
66
67
68 <refsect1>
69         <title>OPTIONS</title>
70
71         <variablelist>
72                 <varlistentry><term>-d debuglevel</term>
73                         <listitem><para>Use the specified Samba debug level. A higher debug level 
74                                 means more output.</para></listitem>
75                 </varlistentry>
76                 <varlistentry><term>-U user%pass</term>
77                         <listitem><para>Use the specified username/password combination when logging in to a remote server.</para></listitem>
78                 </varlistentry>
79                 <varlistentry><term>-k</term>
80                         <listitem><para>Use kerberos when authenticating.</para></listitem>
81                 </varlistentry>
82                 <varlistentry><term>-W workgroup</term>
83                         <listitem><para>Use specified name as our workgroup name.</para></listitem>
84                 </varlistentry>
85                 <varlistentry><term>-n netbios_name</term>
86                         <listitem><para>Use specified name as our NetBIOS name.</para></listitem>
87                 </varlistentry>
88
89                 <varlistentry><term>-O socket_options</term>
90                         <listitem><para>Use specified socket options, equivalent of the smb.conf option <quote>socket options</quote>. See the smb.conf(5) manpage for details.</para></listitem>
91                 </varlistentry>
92
93                 <varlistentry><term>-m max_protocol</term>
94                         <listitem><para>Specify the maximum SMB dialect that should be used. Possible values are: CORE, COREPLUS, LANMAN1, LANMAN2, NT1</para></listitem>
95                 </varlistentry>
96
97                 <varlistentry><term>-s seed</term>
98                         <listitem><para>Initialize the randomizer using <replaceable>seed</replaceable> as seed.</para></listitem>
99                 </varlistentry>
100
101                 <varlistentry><term>-L</term>
102                         <listitem><para>Use oplocks.</para></listitem>
103                 </varlistentry>
104
105                 <varlistentry><term>-X</term>
106                         <listitem><para>Enable dangerous tests. Use with care! This might crash your server...</para></listitem>
107                 </varlistentry>
108
109                 <varlistentry><term>-t timelimit</term>
110                         <listitem><para>Specify the NBENCH time limit in seconds. Defaults to 600.</para></listitem>
111                 </varlistentry>
112
113                 <varlistentry><term>-p ports</term>
114                         <listitem><para>Specify ports to connect to.</para></listitem>
115                 </varlistentry>
116
117                 <varlistentry><term>-c file</term>
118                         <listitem><para>Read NBENCH commands from <replaceable>file</replaceable> instead of from CLIENT.TXT.</para></listitem>
119                 </varlistentry>
120
121                 <varlistentry><term>-A</term>
122                         <listitem><para>Show not just OK or FAILED but more detailed 
123                                         output. Used only by DENY test at the moment.</para></listitem>
124                 </varlistentry>
125
126                 <varlistentry><term>-C filename</term>
127                         <listitem><para>Load a list of UNC names from the specified filename. Smbtorture instances will connect to a random host from this list.</para></listitem>
128                 </varlistentry>
129
130                 <varlistentry><term>-N numprocs</term>
131                         <listitem><para>Specify number of smbtorture processes to launch.</para></listitem>
132                 </varlistentry>
133
134                 <varlistentry><term>-o num_operations</term>
135                         <listitem><para>Number of times some operations should be tried before assuming they're output is consistent (default:100).</para></listitem>
136                 </varlistentry>
137
138                 <varlistentry><term>-e num_files</term>
139                         <listitem><para>Number of entries to use in certain tests (such as creating X files) (default: 1000).</para></listitem>
140                 </varlistentry>
141
142                 <varlistentry><term>-f max_failures</term>
143                         <listitem><para>Number of failures before aborting a test (default: 1).</para></listitem>
144                 </varlistentry>
145         </variablelist>
146 </refsect1>
147
148 <refsect1>
149         <title>VERSION</title>
150
151         <para>This man page is correct for version 4.0 of the Samba suite.</para>
152 </refsect1>
153
154 <refsect1>
155         <title>SEE ALSO</title>
156
157         <para>Samba</para>
158
159 </refsect1>
160
161 <refsect1>
162         <title>AUTHOR</title>
163
164         &man.credits.samba;
165
166         <para>smbtorture was written by Andrew Tridgell.</para>
167
168         <para>This manpage was written by Jelmer Vernooij.</para>
169         
170 </refsect1>
171
172 </refentry>