Add documentation for the new -t <timeout> parameter in smbclient.
authorJeremy Allison <jra@samba.org>
Fri, 16 Aug 2013 23:56:22 +0000 (16:56 -0700)
committerMichael Adam <obnox@samba.org>
Wed, 21 Aug 2013 15:28:57 +0000 (17:28 +0200)
Signed-off-by: Jeremy Allison <jra@samba.org>
Reviewed-by: Michael Adam <obnox@samba.org>
docs-xml/manpages/smbclient.1.xml

index c3fe1d7e65e62c25fd1a4374fa8c978475f66eb5..06ca817c9422dcb38adb1fad297ab2c51f91862b 100644 (file)
@@ -37,6 +37,7 @@
                <arg choice="opt">-p port</arg>
                <arg choice="opt">-R &lt;name resolve order&gt;</arg>
                <arg choice="opt">-s &lt;smb config file&gt;</arg>
+               <arg choice="opt">-t &lt;per-operation timeout in seconds&gt;</arg>
                <arg choice="opt">-k</arg>
                <arg choice="opt">-P</arg>
                <arg choice="opt">-c &lt;command&gt;</arg>
@@ -67,6 +68,7 @@
                <arg choice="opt">-p port</arg>
                <arg choice="opt">-R &lt;name resolve order&gt;</arg>
                <arg choice="opt">-s &lt;smb config file&gt;</arg>
+               <arg choice="opt">-t &lt;per-operation timeout in seconds&gt;</arg>
                <arg choice="opt">-T&lt;c|x&gt;IXFqgbNan</arg>
                <arg choice="opt">-k</arg>
        </cmdsynopsis>
                &popt.common.credentials;
                &popt.common.connection;
                
+               <varlistentry>
+               <term>-t|--timeout &lt;timeout-seconds&gt;</term>
+               <listitem><para>This allows the user to tune the default
+               timeout used for each SMB request. The default setting is
+               20 seconds. Increase it if requests to the server sometimes
+               time out. This can happen when SMB3 encryption is selected
+               and smbclient is overwhelming the server with requests.
+               This can also be set using the <command>timeout</command>
+               command inside smbclient.
+               </para></listitem>
+               </varlistentry>
+
                <varlistentry>
                <term>-T|--tar tar options</term>
                <listitem><para>smbclient may be used to create <command>tar(1)