Document the two new smb options

--smb-user=[DOMAIN/]USER%PASSWORD
and
--smb-share=//SERVER/SHARE[/PATH]

diff --git a/doc/dbench.1 b/doc/dbench.1
index d851b48f5b37b1d590b97f3ce8fd46f31d8d2e14..b61a6fbb9a2415f561a02e5718f9db3a55778de6 100644 (file)
--- a/doc/dbench.1
+++ b/doc/dbench.1
@@ -1,11 +1,11 @@
 .\"     Title: dbench
 .\"    Author: 
 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
-.\"      Date: 09/26/2009
+.\"      Date: 12/08/2009
 .\"    Manual: 
 .\"    Source: 
 .\"
-.TH "DBENCH" "1" "09/26/2009" "" ""
+.TH "DBENCH" "1" "12/08/2009" "" ""
 .\" disable hyphenation
 .nh
 .\" disable justification (adjust text to left margin only)
@@ -25,7 +25,7 @@ dbench is a utility to benchmark a system based on client workload profiles\.
 .PP
 The backend type specifies which kind of commandset and what kind of tests that dbench will perform\. The backend type specifies which kind of loadfile that can be used\.
 .PP
-There are currently five types of backends : "fileio", "sockio", "nfs", "scsi"and "iscsi"\. The default is "fileio" which uses a CIFS style loadfile\.
+There are currently six types of backends : "fileio", "sockio", "nfs", "scsi", "iscsi" and "smb"\. The default is "fileio" which uses a smbtorture/BENCH\-NBENCH style loadfile\.
 .SS "\-c \-\-loadfile=<filename>"
 .PP
 This specifies the name of the loadfile to use\. The loadfile describes the sequence and timing of operations that dbench will issue\.
@@ -88,6 +88,25 @@ After each create/mkdir/rmdir/rename operation, immediately try to stat() the ob
 .SS "\-T \-\-tcp\-options=<string>"
 .PP
 This option only apply to the "sockio" backend\.
+.SH "SMB OPTIONS"
+.SS "\-\-smb\-share=//<hostname>/<share>[/<path>]"
+.PP
+This option only apply to the "smb" backend\.
+.PP
+This option is mandatory when the "smb" backend is used\.
+.PP
+This specifies the server and the share to use for the testing\. It also contains an optional path to a directory to use\.
+.PP
+Example: \-\-smb\-share=//MY\-SERVER/DATA
+.SS "\-\-smb\-user=[<domain>/]<user>%<password>"
+.PP
+This option only apply to the "smb" backend\.
+.PP
+This option is mandatory when the "smb" backend is used\.
+.PP
+This specifies the username and password to use when authenticationg to the server\.
+.PP
+Example: \-\-smb\-user=Administrator%Password
 .SH "NFS OPTIONS"
 .SS "\-\-server=<hostname>"
 .PP

diff --git a/doc/dbench.1.html b/doc/dbench.1.html
index a5ddc52ee9c03ebc95d61fc155d626843e554a14..47208f1f288b0cce4f559a6e3f044047cd488e96 100644 (file)
--- a/doc/dbench.1.html
+++ b/doc/dbench.1.html
@@ -6,16 +6,16 @@
       tests that dbench will perform. The backend type specifies which
       kind of loadfile that can be used.
       </p><p>
-      There are currently five types of backends : "fileio", "sockio", "nfs", "scsi"and "iscsi". The default is "fileio" which uses a CIFS style loadfile.
-      </p></div><div class="refsect2" lang="en"><a name="id2479709"></a><h3>-c --loadfile=&lt;filename&gt;</h3><p>
+      There are currently six types of backends : "fileio", "sockio", "nfs", "scsi", "iscsi" and "smb". The default is "fileio" which uses a smbtorture/BENCH-NBENCH style loadfile.
+      </p></div><div class="refsect2" lang="en"><a name="id2479710"></a><h3>-c --loadfile=&lt;filename&gt;</h3><p>
       This specifies the name of the loadfile to use. The loadfile describes
       the sequence and timing of operations that dbench will issue.
-      </p></div><div class="refsect2" lang="en"><a name="id2479721"></a><h3>-D --directory=&lt;string&gt;</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2479722"></a><h3>-D --directory=&lt;string&gt;</h3><p>
       This controls which directory that dbench will use as the root for when
       running the loadfile. This defaults to "." which refers to the current
       directory for the "fileio" and "sockio" backends and the root of the
       export for the "nfs" backend.
-      </p></div><div class="refsect2" lang="en"><a name="id2479735"></a><h3>-R --target-rate=&lt;double&gt;</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2479736"></a><h3>-R --target-rate=&lt;double&gt;</h3><p>
       By default dbench will try to replay the loadfile and keep the same
       rate as the original application the loadfile was captured from.
       Using this option it is possible to run the load file faster/slower
@@ -50,7 +50,7 @@
       </p></div><div class="refsect2" lang="en"><a name="id2479810"></a><h3>--skip-cleanup</h3><p>
       Do not cleanup and delete all temporary files in the clients work
       directory when the test ends.
-      </p></div><div class="refsect2" lang="en"><a name="id2479820"></a><h3>--per-client-results</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2479821"></a><h3>--per-client-results</h3><p>
       When the test is finished print a latency report for each inidvidual
       client in addition to the aggregated report over all clients.
       </p></div></div><div class="refsect1" lang="en"><a name="id2479833"></a><h2>FILEIO OPTIONS</h2><div class="refsect2" lang="en"><a name="id2528486"></a><h3>-F --fsync</h3><p>
@@ -83,64 +83,80 @@
       deleted an object that stat() will fail.
       </p></div></div><div class="refsect1" lang="en"><a name="id2528568"></a><h2>SOCKIO OPTIONS</h2><div class="refsect2" lang="en"><a name="id2528573"></a><h3>-T --tcp-options=&lt;string&gt;</h3><p>
       This option only apply to the "sockio" backend.
-      </p></div></div><div class="refsect1" lang="en"><a name="id2528585"></a><h2>NFS OPTIONS</h2><div class="refsect2" lang="en"><a name="id2528591"></a><h3>--server=&lt;hostname&gt;</h3><p>
+      </p></div></div><div class="refsect1" lang="en"><a name="id2528585"></a><h2>SMB OPTIONS</h2><div class="refsect2" lang="en"><a name="id2528591"></a><h3>--smb-share=//&lt;hostname&gt;/&lt;share&gt;[/&lt;path&gt;]</h3><p>
+      This option only apply to the "smb" backend.
+      </p><p>
+      This option is mandatory when the "smb" backend is used.
+      </p><p>
+      This specifies the server and the share to use for the testing. It also contains an optional path to a directory to use.
+      </p><p>
+       Example: --smb-share=//MY-SERVER/DATA
+      </p></div><div class="refsect2" lang="en"><a name="id2528616"></a><h3>--smb-user=[&lt;domain&gt;/]&lt;user&gt;%&lt;password&gt;</h3><p>
+      This option only apply to the "smb" backend.
+      </p><p>
+      This option is mandatory when the "smb" backend is used.
+      </p><p>
+      This specifies the username and password to use when authenticationg to the server.
+      </p><p>
+       Example: --smb-user=Administrator%Password
+      </p></div></div><div class="refsect1" lang="en"><a name="id2528641"></a><h2>NFS OPTIONS</h2><div class="refsect2" lang="en"><a name="id2528647"></a><h3>--server=&lt;hostname&gt;</h3><p>
       This option only apply to the "nfs" backend.
       </p><p>
       This option is mandatory when the "nfs" backend is used.
       </p><p>
       This specifies the host-name or ip-address of the server to test.
-      </p></div><div class="refsect2" lang="en"><a name="id2528610"></a><h3>--export=&lt;string&gt;</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2528666"></a><h3>--export=&lt;string&gt;</h3><p>
       This option only apply to the "nfs" backend.
       </p><p>
       This option is mandatory when the "nfs" backend is used.
       </p><p>
       This specifies the nfs-export on the server to do i/o to.
-      </p></div><div class="refsect2" lang="en"><a name="id2528629"></a><h3>--protocol=&lt;string&gt;</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2528685"></a><h3>--protocol=&lt;string&gt;</h3><p>
       This option only apply to the "nfs" backend.
       </p><p>
       This specifies whether "tcp" or "udp" is to be used. Default is "tcp".
-      </p></div><div class="refsect2" lang="en"><a name="id2528644"></a><h3>--trunc-io=&lt;integer&gt;</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2528700"></a><h3>--trunc-io=&lt;integer&gt;</h3><p>
       This option only apply to the "nfs" backend.
       </p><p>
       Some NFS server may have limitations on how large READ/WRITE I/Os they
       accept preventing some loadfiles from running. Using this option will
       override the length specified in the loadfile and make dbench never
       issuing any READ/WRITE operations larger than this.
-      </p></div></div><div class="refsect1" lang="en"><a name="id2528664"></a><h2>SCSI OPTIONS</h2><div class="refsect2" lang="en"><a name="id2528669"></a><h3>--scsi=&lt;scsi-device&gt;</h3><p>
+      </p></div></div><div class="refsect1" lang="en"><a name="id2528720"></a><h2>SCSI OPTIONS</h2><div class="refsect2" lang="en"><a name="id2528725"></a><h3>--scsi=&lt;scsi-device&gt;</h3><p>
       This option only apply to the "scsi" backend.
       </p><p>
       This option is mandatory when the "scsi" backend is used.
       </p><p>
       This specifies the device node of the scsi-device we want to run the loadfile on. Example: --scsi=/dev/sda
-      </p></div></div><div class="refsect1" lang="en"><a name="id2528691"></a><h2>iSCSI OPTIONS</h2><p>
+      </p></div></div><div class="refsect1" lang="en"><a name="id2528747"></a><h2>iSCSI OPTIONS</h2><p>
     Dbench contains a primitive iSCSI initiator, allowing it to perform I/O
     to some iSCSI targets.
-    </p><div class="refsect2" lang="en"><a name="id2528702"></a><h3>--iscsi-portal=&lt;ip-address&gt;</h3><p>
+    </p><div class="refsect2" lang="en"><a name="id2528758"></a><h3>--iscsi-portal=&lt;ip-address&gt;</h3><p>
       This option only apply to the "iscsi" backend.
       </p><p>
       This option is mandatory when the "iscsi" backend is used.
       </p><p>
       This specifies the host-name or ip-address of the target to test.
-      </p></div><div class="refsect2" lang="en"><a name="id2528721"></a><h3>--iscsi-port=&lt;tcp port&gt;</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2528777"></a><h3>--iscsi-port=&lt;tcp port&gt;</h3><p>
       This option only apply to the "iscsi" backend.
       </p><p>
       This option is optional when the "iscsi" backend is used.
       If not used the tcp port defaults to 3260.
       </p><p>
       This specifies the tcp port to connect to on the target.
-      </p></div><div class="refsect2" lang="en"><a name="id2528742"></a><h3>--iscsi-target=&lt;iqn name&gt;</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2528798"></a><h3>--iscsi-target=&lt;iqn name&gt;</h3><p>
       This option only apply to the "iscsi" backend.
       </p><p>
       This option is mandatory when the "iscsi" backend is used.
       </p><p>
       This specifies the iscsi iqn name of the target to test.
-      </p></div><div class="refsect2" lang="en"><a name="id2528761"></a><h3>--iscsi-lun=&lt;LUN&gt;</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2528817"></a><h3>--iscsi-lun=&lt;LUN&gt;</h3><p>
       This option only apply to the "iscsi" backend.
       </p><p>
       This option is mandatory when the "iscsi" backend is used.
       </p><p>
       This specifies the LUN of the target to test.
-      </p></div></div><div class="refsect1" lang="en"><a name="id2528781"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br>
+      </p></div></div><div class="refsect1" lang="en"><a name="id2528837"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br>
 Copyright (C) Andrew Tridgell 2008<br>
 Copyright (C) Ronnie Sahlberg 2008<br>
 <br>

diff --git a/doc/dbench.1.xml b/doc/dbench.1.xml
index ea01df04a52cf9918e02185a7c5065a7c9e0865e..5d39053084d04d864de3ba7d82618d06459ab557 100644 (file)
--- a/doc/dbench.1.xml
+++ b/doc/dbench.1.xml
@@ -71,7 +71,7 @@
       </para>
 
       <para>
-      There are currently five types of backends : "fileio", "sockio", "nfs", "scsi"and "iscsi". The default is "fileio" which uses a CIFS style loadfile.
+      There are currently six types of backends : "fileio", "sockio", "nfs", "scsi", "iscsi" and "smb". The default is "fileio" which uses a smbtorture/BENCH-NBENCH style loadfile.
       </para>
     </refsect2>
 
@@ -234,6 +234,42 @@
 
   </refsect1>
 
+  <refsect1> <title>SMB OPTIONS</title>
+    <refsect2><title>--smb-share=//&lt;hostname&gt;/&lt;share&gt;[/&lt;path&gt;]</title>
+      <para>
+      This option only apply to the "smb" backend.
+      </para>
+
+      <para>
+      This option is mandatory when the "smb" backend is used.
+      </para>
+
+      <para>
+      This specifies the server and the share to use for the testing. It also contains an optional path to a directory to use.
+      </para>
+      <para>
+       Example: --smb-share=//MY-SERVER/DATA
+      </para>
+    </refsect2>
+
+    <refsect2><title>--smb-user=[&lt;domain&gt;/]&lt;user&gt;%&lt;password&gt;</title>
+      <para>
+      This option only apply to the "smb" backend.
+      </para>
+
+      <para>
+      This option is mandatory when the "smb" backend is used.
+      </para>
+
+      <para>
+      This specifies the username and password to use when authenticationg to the server.
+      </para>
+      <para>
+       Example: --smb-user=Administrator%Password
+      </para>
+    </refsect2>
+  </refsect1>
+
   <refsect1> <title>NFS OPTIONS</title>
     <refsect2><title>--server=&lt;hostname&gt;</title>
       <para>