s3:docs: document the smbclient "tid" command
[samba.git] / docs-xml / manpages-3 / smbclient.1.xml
index e8e1b215cdd9ff7714fae507b0d40c1880161cc4..337b0e43e5a9d38f680a95512f766970210377fc 100644 (file)
@@ -7,13 +7,13 @@
        <manvolnum>1</manvolnum>
        <refmiscinfo class="source">Samba</refmiscinfo>
        <refmiscinfo class="manual">User Commands</refmiscinfo>
-       <refmiscinfo class="version">3.2</refmiscinfo>
+       <refmiscinfo class="version">3.6</refmiscinfo>
 </refmeta>
 
 
 <refnamediv>
        <refname>smbclient</refname>
-       <refpurpose>ftp-like client to access SMB/CIFS resources 
+       <refpurpose>ftp-like client to access SMB/CIFS resources
        on servers</refpurpose>
 </refnamediv>
 
@@ -30,6 +30,8 @@
                <arg choice="opt">-m maxprotocol</arg>
                <arg choice="opt">-A authfile</arg>
                <arg choice="opt">-N</arg>
+               <arg choice="opt">-C</arg>
+               <arg choice="opt">-g</arg>
                <arg choice="opt">-i scope</arg>
                <arg choice="opt">-O &lt;socket options&gt;</arg>
                <arg choice="opt">-p port</arg>
@@ -39,7 +41,7 @@
                <arg choice="opt">-P</arg>
                <arg choice="opt">-c &lt;command&gt;</arg>
        </cmdsynopsis>
-               
+
        <cmdsynopsis>
                <command>smbclient</command>
                <arg choice="req">servicename</arg>
@@ -54,6 +56,8 @@
                <arg choice="opt">-m maxprotocol</arg>
                <arg choice="opt">-A authfile</arg>
                <arg choice="opt">-N</arg>
+               <arg choice="opt">-C</arg>
+               <arg choice="opt">-g</arg>
                <arg choice="opt">-l log-basename</arg>
                <arg choice="opt">-I destinationIP</arg>
                <arg choice="opt">-E</arg>
                </varlistentry>
                
                <varlistentry>
-               <term>-R &lt;name resolve order&gt;</term> 
+               <term>-R|--name-resolve &lt;name resolve order&gt;</term>
                <listitem><para>This option is used by the programs in the Samba 
                suite to determine what naming services and in what order to resolve 
                host names to IP addresses. The option takes a space-separated 
                
                
                <varlistentry>
-               <term>-M NetBIOS name</term>
+               <term>-M|--message NetBIOS name</term>
                <listitem><para>This options allows you to send messages, using 
                the "WinPopup" protocol, to another computer. Once a connection is 
                established you then type your message, pressing ^D (control-D) to 
                on your WfWg PCs if you want them to always be able to receive 
                messages. </para></listitem>
                </varlistentry>
-               
+
                <varlistentry>
-               <term>-p port</term>
+               <term>-p|--port port</term>
                <listitem><para>This number is the TCP port number that will be used 
                when making connections to the server. The standard (well-known)
                TCP port number for an SMB/CIFS server is 139, which is the 
                default. </para></listitem>
                </varlistentry>
-               
+
+               <varlistentry>
+               <term>-g|--grepable</term>
+               <listitem><para>This parameter provides combined with
+               <parameter>-L</parameter> easy parseable output that allows processing
+               with utilities such as grep and cut.
+               </para></listitem>
+               </varlistentry>
+
+               <varlistentry>
+               <term>-m|--max-protocol protocol</term>
+               <listitem><para>This parameter sets the maximum protocol version announced by the client.
+               </para></listitem>
+               </varlistentry>
+
                <varlistentry>
-               <term>-P</term>
+               <term>-P|--machine-pass</term>
                <listitem><para>
                Make queries to the external server using the machine account of the local server.
                </para></listitem>
                </varlistentry>
-               
+
                &stdarg.help;
-               
+
                <varlistentry>
-               <term>-I IP-address</term>
-               <listitem><para><replaceable>IP address</replaceable> is the address of the server to connect to. 
+               <term>-I|--ip-address IP-address</term>
+               <listitem><para><replaceable>IP address</replaceable> is the address of the server to connect to.
                It should be specified in standard "a.b.c.d" notation. </para>
 
                <para>Normally the client would attempt to locate a named 
                </varlistentry>
                
                <varlistentry>
-               <term>-E</term>
+               <term>-E|--stderr</term>
                <listitem><para>This parameter causes the client to write messages 
                to the standard error stream (stderr) rather than to the standard 
                output stream. </para>
                </varlistentry>
                
                <varlistentry>
-               <term>-L</term>
+               <term>-L|--list</term>
                <listitem><para>This option allows you to look at what services 
                are available on a server. You use it as <command>smbclient -L 
                host</command> and a list should appear.  The <parameter>-I
                host on another network. </para></listitem>
                </varlistentry>
                
-               <varlistentry>
-               <term>-t terminal code</term>
-               <listitem><para>This option tells <command>smbclient</command> how to interpret 
-               filenames coming from the remote server. Usually Asian language 
-               multibyte UNIX implementations use different character sets than 
-               SMB/CIFS servers (<emphasis>EUC</emphasis> instead of <emphasis>
-               SJIS</emphasis> for example). Setting this parameter will let 
-               <command>smbclient</command> convert between the UNIX filenames and 
-               the SMB filenames correctly. This option has not been seriously tested 
-               and may have some problems. </para>
-
-               <para>The terminal codes include CWsjis, CWeuc, CWjis7, CWjis8,
-               CWjunet, CWhex, CWcap. This is not a complete list, check the Samba 
-               source code for the complete list. </para></listitem>
-               </varlistentry>
-                       
                <varlistentry>  
-               <term>-b buffersize</term>
+               <term>-b|--send-buffer buffersize</term>
                <listitem><para>This option changes the transmit/send buffer 
                size when getting or putting a file from/to the server. The default 
                is 65520 bytes. Setting this value smaller (to 1200 bytes) has been 
                </varlistentry>
                
                <varlistentry>
-               <term>-e</term>
+               <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
                &popt.common.connection;
                
                <varlistentry>
-               <term>-T tar options</term>
+               <term>-T|--tar tar options</term>
                <listitem><para>smbclient may be used to create <command>tar(1)
                </command> compatible backups of all the files on an SMB/CIFS
                share. The secondary tar flags that can be given to this option 
                </varlistentry>
                
                <varlistentry>
-               <term>-D initial directory</term>
+               <term>-D|--directory initial directory</term>
                <listitem><para>Change to initial directory before starting. Probably 
                only of any use with the tar -T option. </para></listitem>
                </varlistentry>
                
                <varlistentry>
-               <term>-c command string</term>
+               <term>-c|--command command string</term>
                <listitem><para>command string is a semicolon-separated list of 
                commands to be executed instead of prompting from stdin. <parameter>
                -N</parameter> is implied by <parameter>-c</parameter>.</para>
                </varlistentry>
 
                <varlistentry>
-               <term>hardlink &lt;src&gt; &lt;dest&lt;</term>
+               <term>hardlink &lt;src&gt; &lt;dest&gt;</term>
                <listitem><para>Creates a hardlink on the server using Windows CIFS semantics.
-               the POSIX ACL on a file.
                </para></listitem>
                </varlistentry>
 
                </para></listitem>
                </varlistentry>
 
+               <varlistentry>
+               <term>logoff</term>
+               <listitem><para>Loggs the user off the server, closing the session.
+               Used for internal Samba testing purposes.
+               </para></listitem>
+               </varlistentry>
+
                <varlistentry>
                <term>lowercase</term>
                <listitem><para>Toggle lowercasing of filenames for the get and
                <listitem><para>See the exit command. </para></listitem>
                </varlistentry>
 
+               <varlistentry>
+               <term>readlink symlinkname</term>
+               <listitem><para>This command depends on the server supporting the CIFS
+               UNIX extensions and will fail if the server does not. Print
+               the value of the symlink "symlinkname".
+               </para></listitem>
+               </varlistentry>
+
                <varlistentry>
                <term>rd &lt;directory name&gt;</term>
                <listitem><para>See the rmdir command. </para></listitem>
                using the mask command will be ignored. </para></listitem>
                </varlistentry>
 
+               <varlistentry>
+               <term>rename &lt;old filename&gt; &lt;new filename&gt;</term>
+               <listitem><para>Rename files in the current working directory on the
+               server from <replaceable>old filename</replaceable> to
+               <replaceable>new filename</replaceable>. </para></listitem>
+               </varlistentry>
+
                <varlistentry>
                <term>rm &lt;mask&gt;</term>
                <listitem><para>Remove all files matching <replaceable>mask</replaceable> from the current
                </para></listitem>
                </varlistentry>
 
+               <varlistentry>
+               <term>tcon &lt;sharename&gt;</term>
+               <listitem><para>Establishes a new tree connect (connection to a share).
+               Replaces the current tree connect. Prints the new tid (tree id).
+               Used for internal Samba testing purposes.
+               </para></listitem>
+               </varlistentry>
+
+               <varlistentry>
+               <term>tdis</term>
+               <listitem><para>Close the current share connection (tree disconnect).
+               Used for internal Samba testing purposes.
+               </para></listitem>
+               </varlistentry>
+
+               <varlistentry>
+               <term>tid &lt;number&gt;</term>
+               <listitem><para>Changes the current tree id (tid) in the
+               protocol to a new arbitrary number. Without an argument, it
+               prints out the tid currently used.
+               Used for internal Samba testing purposes.
+               </para></listitem>
+               </varlistentry>
+
        </variablelist>
 </refsect1>