diff options
| author | Jeremy Allison <jra@samba.org> | 2007-11-02 22:45:37 +0000 |
|---|---|---|
| committer | Gerald W. Carter <jerry@samba.org> | 2008-04-23 08:47:39 -0500 |
| commit | 0a19ab148a5efefaf38f9bb2b0b70bac28869afa (patch) | |
| tree | c1ba2e5af70e817807d26e038b02641b5509f2b0 /docs/manpages-3/smbclient.1.xml | |
| parent | 201b67c0db1930e61d4eda4897e0bc2053d875a7 (diff) | |
| download | samba-0a19ab148a5efefaf38f9bb2b0b70bac28869afa.tar.gz samba-0a19ab148a5efefaf38f9bb2b0b70bac28869afa.tar.bz2 samba-0a19ab148a5efefaf38f9bb2b0b70bac28869afa.zip | |
Make the smbclient man page match the internal command list.
Jeremy.
(This used to be commit 1a24fb1d25f6bb6483202489e63098fbf25b4059)
Diffstat (limited to 'docs/manpages-3/smbclient.1.xml')
| -rw-r--r-- | docs/manpages-3/smbclient.1.xml | 442 |
1 files changed, 297 insertions, 145 deletions
diff --git a/docs/manpages-3/smbclient.1.xml b/docs/manpages-3/smbclient.1.xml index b16c00771d..d98bfe7196 100644 --- a/docs/manpages-3/smbclient.1.xml +++ b/docs/manpages-3/smbclient.1.xml @@ -502,27 +502,50 @@ <variablelist> <varlistentry> <term>? [command]</term> - <listitem><para>If <replaceable>command</replaceable> is specified, the ? command will display - a brief informative message about the specified command. If no + <listitem><para>If <replaceable>command</replaceable> is specified, the ? command will display + a brief informative message about the specified command. If no command is specified, a list of available commands will be displayed. </para></listitem> </varlistentry> - + <varlistentry> <term>! [shell command]</term> - <listitem><para>If <replaceable>shell command</replaceable> is specified, the ! - command will execute a shell locally and run the specified shell - command. If no command is specified, a local shell will be run. + <listitem><para>If <replaceable>shell command</replaceable> is specified, the ! + command will execute a shell locally and run the specified shell + command. If no command is specified, a local shell will be run. </para></listitem> </varlistentry> - + <varlistentry> <term>altname file</term> <listitem><para>The client will request that the server return the "alternate" name (the 8.3 name) for a file or directory. </para></listitem> </varlistentry> - + + <varlistentry> + <term>archive <number></term> + <listitem><para>Sets the archive level when operating on files. + 0 means ignore the archive bit, 1 means only operate on files with this bit set, + 2 means only operate on files with this bit set and reset it after operation, + 3 means operate on all files and reset it after operation. The default is 0. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>blocksize <number></term> + <listitem><para>Sets the blocksize parameter for a tar operation. The default is 20. + Causes tar file to be written out in blocksize*TBLOCK (normally 512 byte) units. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>cancel jobid0 [jobid1] ... [jobidN]</term> + <listitem><para>The client will request that the server cancel + the printjobs identified by the given numeric print job ids. + </para></listitem> + </varlistentry> + <varlistentry> <term>case_sensitive</term> <listitem><para>Toggles the setting of the flag in SMB packets that @@ -532,14 +555,18 @@ parameter set to auto in the smb.conf. </para></listitem> </varlistentry> - + <varlistentry> - <term>cancel jobid0 [jobid1] ... [jobidN]</term> - <listitem><para>The client will request that the server cancel - the printjobs identified by the given numeric print job ids. - </para></listitem> + <term>cd <directory name></term> + <listitem><para>If "directory name" is specified, the current + working directory on the server will be changed to the directory + specified. This operation will fail if for any reason the specified + directory is inaccessible. </para> + + <para>If no directory name is specified, the current working + directory on the server will be reported. </para></listitem> </varlistentry> - + <varlistentry> <term>chmod file mode in octal</term> <listitem><para>This command depends on the server supporting the CIFS @@ -547,7 +574,7 @@ change the UNIX permissions to the given octal mode, in standard UNIX format. </para></listitem> </varlistentry> - + <varlistentry> <term>chown file uid gid</term> <listitem><para>This command depends on the server supporting the CIFS @@ -557,64 +584,101 @@ This may be addressed in future versions of the CIFS UNIX extensions. </para></listitem> </varlistentry> - - <varlistentry> - <term>cd [directory name]</term> - <listitem><para>If "directory name" is specified, the current - working directory on the server will be changed to the directory - specified. This operation will fail if for any reason the specified - directory is inaccessible. </para> - <para>If no directory name is specified, the current working - directory on the server will be reported. </para></listitem> + <varlistentry> + <term>close <fileid></term> + <listitem><para>Closes a file explicitly opened by the open command. Used for + internal Samba testing purposes. + </para></listitem> </varlistentry> - + <varlistentry> <term>del <mask></term> - <listitem><para>The client will request that the server attempt - to delete all files matching <replaceable>mask</replaceable> from the current working + <listitem><para>The client will request that the server attempt + to delete all files matching <replaceable>mask</replaceable> from the current working directory on the server. </para></listitem> </varlistentry> - + <varlistentry> <term>dir <mask></term> - <listitem><para>A list of the files matching <replaceable>mask</replaceable> in the current - working directory on the server will be retrieved from the server + <listitem><para>A list of the files matching <replaceable>mask</replaceable> in the current + working directory on the server will be retrieved from the server and displayed. </para></listitem> </varlistentry> - + + <varlistentry> + <term>du <filename></term> + <listitem><para>Does a directory listing and then prints out the current disk useage and free space on a share. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>echo <number> <data></term> + <listitem><para>Does an SMBecho request to ping the server. Used for internal Samba testing purposes. + </para></listitem> + </varlistentry> + <varlistentry> <term>exit</term> - <listitem><para>Terminate the connection with the server and exit - from the program. </para></listitem> + <listitem><para>Terminate the connection with the server and exit + from the program. </para></listitem> </varlistentry> - + <varlistentry> <term>get <remote file name> [local file name]</term> - <listitem><para>Copy the file called <filename>remote file name</filename> from - the server to the machine running the client. If specified, name - the local copy <filename>local file name</filename>. Note that all transfers in - <command>smbclient</command> are binary. See also the + <listitem><para>Copy the file called <filename>remote file name</filename> from + the server to the machine running the client. If specified, name + the local copy <filename>local file name</filename>. Note that all transfers in + <command>smbclient</command> are binary. See also the lowercase command. </para></listitem> </varlistentry> - + + <varlistentry> + <term>getfacl <filename></term> + <listitem><para>Requires the server support the UNIX extensions. Requests and prints + the POSIX ACL on a file. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>hardlink <src> <dest<</term> + <listitem><para>Creates a hardlink on the server using Windows CIFS semantics. + the POSIX ACL on a file. + </para></listitem> + </varlistentry> + <varlistentry> <term>help [command]</term> <listitem><para>See the ? command above. </para></listitem> </varlistentry> - + + <varlistentry> + <term>history</term> <listitem><para>Displays the command history.</para></listitem> + </varlistentry> + + <varlistentry> + <term>iosize <bytes></term> + <listitem><para>When sending or receiving files, smbclient uses an + internal memory buffer by default of size 64512 bytes. This command + allows this size to be set to any range between 16384 (0x4000) bytes + and 16776960 (0xFFFF00) bytes. Larger sizes may mean more efficient + data transfer as smbclient will try and use the most efficient + read and write calls for the connected server. + </para></listitem> + </varlistentry> + <varlistentry> <term>lcd [directory name]</term> - <listitem><para>If <replaceable>directory name</replaceable> is specified, the current - working directory on the local machine will be changed to - the directory specified. This operation will fail if for any + <listitem><para>If <replaceable>directory name</replaceable> is specified, the current + working directory on the local machine will be changed to + the directory specified. This operation will fail if for any reason the specified directory is inaccessible. </para> - - <para>If no directory name is specified, the name of the - current working directory on the local machine will be reported. + + <para>If no directory name is specified, the name of the + current working directory on the local machine will be reported. </para></listitem> </varlistentry> - + <varlistentry> <term>link target linkname</term> <listitem><para>This command depends on the server supporting the CIFS @@ -625,163 +689,236 @@ </varlistentry> <varlistentry> + <term>listconnect</term> + <listitem><para>Show the current connections held for DFS purposes. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>lock <filenum> <r|w> <hex-start> <hex-len></term> + <listitem><para>This command depends on the server supporting the CIFS + UNIX extensions and will fail if the server does not. Tries to set a POSIX + fcntl lock of the given type on the given range. Used for internal Samba testing purposes. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>logon <username> <password></term> + <listitem><para>Establishes a new vuid for this session by logging on again. + Replaces the current vuid. Prints out the new vuid. Used for internal Samba testing purposes. + </para></listitem> + </varlistentry> + + <varlistentry> <term>lowercase</term> - <listitem><para>Toggle lowercasing of filenames for the get and - mget commands. </para> - - <para>When lowercasing is toggled ON, local filenames are converted + <listitem><para>Toggle lowercasing of filenames for the get and + <term>link target linkname</term> + + <para>When lowercasing is toggled ON, local filenames are converted to lowercase when using the get and mget commands. This is - often useful when copying (say) MSDOS files from a server, because + often useful when copying (say) MSDOS files from a server, because lowercase filenames are the norm on UNIX systems. </para></listitem> </varlistentry> - + <varlistentry> <term>ls <mask></term> <listitem><para>See the dir command above. </para></listitem> </varlistentry> - + <varlistentry> <term>mask <mask></term> - <listitem><para>This command allows the user to set up a mask - which will be used during recursive operation of the mget and + <listitem><para>This command allows the user to set up a mask + which will be used during recursive operation of the mget and mput commands. </para> - <para>The masks specified to the mget and mput commands act as - filters for directories rather than files when recursion is + <para>The masks specified to the mget and mput commands act as + filters for directories rather than files when recursion is toggled ON. </para> - - <para>The mask specified with the mask command is necessary + + <para>The mask specified with the mask command is necessary to filter files within those directories. For example, if the - mask specified in an mget command is "source*" and the mask - specified with the mask command is "*.c" and recursion is - toggled ON, the mget command will retrieve all files matching - "*.c" in all directories below and including all directories + mask specified in an mget command is "source*" and the mask + specified with the mask command is "*.c" and recursion is + toggled ON, the mget command will retrieve all files matching + "*.c" in all directories below and including all directories matching "source*" in the current working directory. </para> - <para>Note that the value for mask defaults to blank (equivalent - to "*") and remains so until the mask command is used to change it. - It retains the most recently specified value indefinitely. To - avoid unexpected results it would be wise to change the value of + <para>Note that the value for mask defaults to blank (equivalent + to "*") and remains so until the mask command is used to change it. + It retains the most recently specified value indefinitely. To + avoid unexpected results it would be wise to change the value of mask back to "*" after using the mget or mput commands. </para></listitem> </varlistentry> - + <varlistentry> <term>md <directory name></term> <listitem><para>See the mkdir command. </para></listitem> </varlistentry> - + <varlistentry> <term>mget <mask></term> - <listitem><para>Copy all files matching <replaceable>mask</replaceable> from the server to + <listitem><para>Copy all files matching <replaceable>mask</replaceable> from the server to the machine running the client. </para> - <para>Note that <replaceable>mask</replaceable> is interpreted differently during recursive - operation and non-recursive operation - refer to the recurse and - mask commands for more information. Note that all transfers in + <para>Note that <replaceable>mask</replaceable> is interpreted differently during recursive + operation and non-recursive operation - refer to the recurse and + mask commands for more information. Note that all transfers in <command>smbclient</command> are binary. See also the lowercase command. </para></listitem> </varlistentry> - + <varlistentry> <term>mkdir <directory name></term> - <listitem><para>Create a new directory on the server (user access + <listitem><para>Create a new directory on the server (user access privileges permitting) with the specified name. </para></listitem> </varlistentry> - + + <varlistentry> + <term>more <file name></term> + <listitem><para>Fetch a remote file and view it with the contents + of your PAGER environment variable. + </para></listitem> + </varlistentry> + <varlistentry> <term>mput <mask></term> - <listitem><para>Copy all files matching <replaceable>mask</replaceable> in the current working - directory on the local machine to the current working directory on + <listitem><para>Copy all files matching <replaceable>mask</replaceable> in the current working + directory on the local machine to the current working directory on the server. </para> - - <para>Note that <replaceable>mask</replaceable> is interpreted differently during recursive - operation and non-recursive operation - refer to the recurse and mask - commands for more information. Note that all transfers in <command>smbclient</command> + + <para>Note that <replaceable>mask</replaceable> is interpreted differently during recursive + operation and non-recursive operation - refer to the recurse and mask + commands for more information. Note that all transfers in <command>smbclient</command> are binary. </para></listitem> </varlistentry> - + + <varlistentry> + <term>posix</term> + <listitem><para>Query the remote server to see if it supports the CIFS UNIX + extensions and prints out the list of capabilities supported. If so, turn + on POSIX pathname processing and large file read/writes (if available),. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>posix_open <filename> <octal mode></term> + <listitem><para>This command depends on the server supporting the CIFS + UNIX extensions and will fail if the server does not. Opens a remote file + using the CIFS UNIX extensions and prints a fileid. Used for internal Samba + testing purposes. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>posix_mkdir <directoryname> <octal mode></term> + <listitem><para>This command depends on the server supporting the CIFS + UNIX extensions and will fail if the server does not. Creates a remote directory + using the CIFS UNIX extensions with the given mode. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>posix_rmdir <directoryname></term> + <listitem><para>This command depends on the server supporting the CIFS + UNIX extensions and will fail if the server does not. Deletes a remote directory + using the CIFS UNIX extensions. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>posix_unlink <filename></term> + <listitem><para>This command depends on the server supporting the CIFS + UNIX extensions and will fail if the server does not. Deletes a remote file + using the CIFS UNIX extensions. + </para></listitem> + </varlistentry> + <varlistentry> <term>print <file name></term> - <listitem><para>Print the specified file from the local machine + <listitem><para>Print the specified file from the local machine through a printable service on the server. </para></listitem> </varlistentry> - + <varlistentry> <term>prompt</term> - <listitem><para>Toggle prompting for filenames during operation + <listitem><para>Toggle prompting for filenames during operation of the mget and mput commands. </para> - <para>When toggled ON, the user will be prompted to confirm - the transfer of each file during these commands. When toggled - OFF, all specified files will be transferred without prompting. + <para>When toggled ON, the user will be prompted to confirm + the transfer of each file during these commands. When toggled + OFF, all specified files will be transferred without prompting. </para></listitem> </varlistentry> - + <varlistentry> <term>put <local file name> [remote file name]</term> - <listitem><para>Copy the file called <filename>local file name</filename> from the + <listitem><para>Copy the file called <filename>local file name</filename> from the machine running the client to the server. If specified, - name the remote copy <filename>remote file name</filename>. Note that all transfers - in <command>smbclient</command> are binary. See also the lowercase command. + name the remote copy <filename>remote file name</filename>. Note that all transfers + in <command>smbclient</command> are binary. See also the lowercase command. </para></listitem> </varlistentry> - + <varlistentry> <term>queue</term> - <listitem><para>Displays the print queue, showing the job id, + <listitem><para>Displays the print queue, showing the job id, name, size and current status. </para></listitem> </varlistentry> - + <varlistentry> <term>quit</term> <listitem><para>See the exit command. </para></listitem> </varlistentry> - + <varlistentry> <term>rd <directory name></term> <listitem><para>See the rmdir command. </para></listitem> </varlistentry> - + <varlistentry> <term>recurse</term> - <listitem><para>Toggle directory recursion for the commands mget + <listitem><para>Toggle directory recursion for the commands mget and mput. </para> - - <para>When toggled ON, these commands will process all directories + + <para>When toggled ON, these commands will process all directories in the source directory (i.e., the directory they are copying - from ) and will recurse into any that match the mask specified - to the command. Only files that match the mask specified using - the mask command will be retrieved. See also the mask command. + from ) and will recurse into any that match the mask specified + to the command. Only files that match the mask specified using + the mask command will be retrieved. See also the mask command. </para> - <para>When recursion is toggled OFF, only files from the current - working directory on the source machine that match the mask specified - to the mget or mput commands will be copied, and any mask specified + <para>When recursion is toggled OFF, only files from the current + working directory on the source machine that match the mask specified + to the mget or mput commands will be copied, and any mask specified using the mask command will be ignored. </para></listitem> </varlistentry> - + <varlistentry> <term>rm <mask></term> - <listitem><para>Remove all files matching <replaceable>mask</replaceable> from the current + <listitem><para>Remove all files matching <replaceable>mask</replaceable> from the current working directory on the server. </para></listitem> </varlistentry> - + <varlistentry> <term>rmdir <directory name></term> - <listitem><para>Remove the specified directory (user access + <listitem><para>Remove the specified directory (user access privileges permitting) from the server. </para></listitem> </varlistentry> - + <varlistentry> <term>setmode <filename> <perm=[+|\-]rsha></term> - <listitem><para>A version of the DOS attrib command to set + <listitem><para>A version of the DOS attrib command to set file permissions. For example: </para> <para><command>setmode myfile +r </command></para> - + <para>would make myfile read only. </para></listitem> </varlistentry> - + <varlistentry> + <term>showconnect</term> + <listitem><para>Show the currently active connection held for DFS purposes. + </para></listitem> + </varlistentry> <varlistentry> <term>stat file</term> @@ -795,64 +932,79 @@ </para></listitem> </varlistentry> - - <varlistentry> <term>symlink target linkname</term> <listitem><para>This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not. The client requests that the server create a symbolic hard link between the target and linkname files. The linkname file - must not exist. Note that the server will not create a link to any path that lies + must not exist. Note that the server will not create a link to any path that lies outside the currently connected share. This is enforced by the Samba server. </para></listitem> </varlistentry> - - <varlistentry> <term>tar <c|x>[IXbgNa]</term> <listitem><para>Performs a tar operation - see the <parameter>-T - </parameter> command line option above. Behavior may be affected - by the tarmode command (see below). Using g (incremental) and N - (newer) will affect tarmode settings. Note that using the "-" option - with tar x may not work - use the command line option instead. + </parameter> command line option above. Behavior may be affected + by the tarmode command (see below). Using g (incremental) and N + (newer) will affect tarmode settings. Note that using the "-" option + with tar x may not work - use the command line option instead. </para></listitem> </varlistentry> - - + <varlistentry> <term>blocksize <blocksize></term> - <listitem><para>Blocksize. Must be followed by a valid (greater - than zero) blocksize. Causes tar file to be written out in + <listitem><para>Blocksize. Must be followed by a valid (greater + than zero) blocksize. Causes tar file to be written out in <replaceable>blocksize</replaceable>*TBLOCK (usually 512 byte) blocks. </para></listitem> </varlistentry> - - + <varlistentry> <term>tarmode <full|inc|reset|noreset></term> - <listitem><para>Changes tar's behavior with regard to archive - bits. In full mode, tar will back up everything regardless of the - archive bit setting (this is the default mode). In incremental mode, - tar will only back up files with the archive bit set. In reset mode, - tar will reset the archive bit on all files it backs up (implies + <listitem><para>Changes tar's behavior with regard to archive + bits. In full mode, tar will back up everything regardless of the + archive bit setting (this is the default mode). In incremental mode, + tar will only back up files with the archive bit set. In reset mode, + tar will reset the archive bit on all files it backs up (implies read/write share). </para></listitem> </varlistentry> - - + + <varlistentry> + <term>unlock <filenum> <hex-start> <hex-len></term> + <listitem><para>This command depends on the server supporting the CIFS + UNIX extensions and will fail if the server does not. Tries to unlock a POSIX + fcntl lock on the given range. Used for internal Samba testing purposes. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>volume</term> + <listitem><para>Prints the current volume name of the share. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>vuid <number></term> + <listitem><para>Changes the currently used vuid in the protocol to + the given arbitrary number. Without an argument prints out the current + vuid being used. Used for internal Samba testing purposes. + </para></listitem> + </varlistentry> + </variablelist> </refsect1> <refsect1> <title>NOTES</title> - <para>Some servers are fussy about the case of supplied usernames, - passwords, share names (AKA service names) and machine names. - If you fail to connect try giving all parameters in uppercase. + <para>Some servers are fussy about the case of supplied usernames, + passwords, share names (AKA service names) and machine names. + If you fail to connect try giving all parameters in uppercase. </para> - - <para>It is often necessary to use the -n option when connecting - to some types of servers. For example OS/2 LanManager insists - on a valid NetBIOS name being used, so you need to supply a valid + + <para>It is often necessary to use the -n option when connecting + to some types of servers. For example OS/2 LanManager insists + on a valid NetBIOS name being used, so you need to supply a valid name that would be known to the server.</para> <para>smbclient supports long file names where the server |