Add documentation for the new internal command timeout to smbclient.

[amitay/samba.git] / docs-xml / manpages / smbclient.1.xml

diff --git a/docs-xml/manpages/smbclient.1.xml b/docs-xml/manpages/smbclient.1.xml
index 3a3c4dfb4d88f9eb79b9ad9cdd7acceab1e802c2..b9e55e9ea8e04abaf4e6f83afc3b51e5cc5af67b 100644 (file)
--- a/docs-xml/manpages/smbclient.1.xml
+++ b/docs-xml/manpages/smbclient.1.xml
@@ -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>
@@ -331,13 +333,14 @@
                
                <varlistentry>
                <term>-e|--encrypt</term>
-               <listitem><para>This command line parameter requires the remote
-               server support the UNIX extensions. Request that the connection be
-               encrypted. This is new for Samba 3.2 and will only work with Samba
-               3.2 or above servers. Negotiates SMB encryption using GSSAPI. Uses
-               the given credentials for the encryption negotiation (either kerberos
-               or NTLMv1/v2 if given domain/username/password triple. Fails the
-               connection if encryption cannot be negotiated.
+               <listitem><para>
+               This command line parameter requires the remote
+               server support the UNIX extensions or that the SMB3 protocol has been selected.
+               Requests that the connection be encrypted. Negotiates SMB encryption using either
+               SMB3 or POSIX extensions via GSSAPI. Uses the given credentials for
+               the encryption negotiation (either kerberos or NTLMv1/v2 if given
+               domain/username/password triple. Fails the connection if encryption
+               cannot be negotiated.
                </para></listitem>
                </varlistentry>
                
@@ -346,6 +349,18 @@
                &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)
@@ -1056,6 +1071,16 @@
                read/write share). </para></listitem>
                </varlistentry>
 
+               <varlistentry>
+               <term>timeout &lt;per-operation timeout in 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.
+               </para></listitem>
+               </varlistentry>
+
                <varlistentry>
                <term>unlock &lt;filenum&gt; &lt;hex-start&gt; &lt;hex-len&gt;</term>
                <listitem><para>This command depends on the server supporting the CIFS