diff options
Diffstat (limited to 'docs/manpages/smbclient.1')
| -rw-r--r-- | docs/manpages/smbclient.1 | 164 |
1 files changed, 89 insertions, 75 deletions
diff --git a/docs/manpages/smbclient.1 b/docs/manpages/smbclient.1 index 765c9e52734..8ad27aad69f 100644 --- a/docs/manpages/smbclient.1 +++ b/docs/manpages/smbclient.1 @@ -1,22 +1,21 @@ -.\" This manpage has been automatically generated by docbook2man -.\" from a DocBook document. This tool can be found at: -.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> +.\" This manpage has been automatically generated by docbook2man-spec +.\" from a DocBook document. docbook2man-spec can be found at: +.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <steve@ggi-project.org>. -.TH "SMBCLIENT" "1" "20 augustus 2002" "" "" +.TH "SMBCLIENT" "1" "28 August 2002" "" "" .SH NAME smbclient \- ftp-like client to access SMB/CIFS resources on servers .SH SYNOPSIS - -\fBsmbclient\fR \fBservicename\fR [ \fBpassword\fR ] [ \fB-b <buffer size>\fR ] [ \fB-d debuglevel\fR ] [ \fB-D Directory\fR ] [ \fB-U username\fR ] [ \fB-W workgroup\fR ] [ \fB-M <netbios name>\fR ] [ \fB-m maxprotocol\fR ] [ \fB-A authfile\fR ] [ \fB-N\fR ] [ \fB-l logfile\fR ] [ \fB-L <netbios name>\fR ] [ \fB-I destinationIP\fR ] [ \fB-E <terminal code>\fR ] [ \fB-c <command string>\fR ] [ \fB-i scope\fR ] [ \fB-O <socket options>\fR ] [ \fB-p port\fR ] [ \fB-R <name resolve order>\fR ] [ \fB-s <smb config file>\fR ] [ \fB-T<c|x>IXFqgbNan\fR ] - +.sp +\fBsmbclient\fR \fBservicename\fR [ \fBpassword\fR ] [ \fB-b <buffer size>\fR ] [ \fB-d debuglevel\fR ] [ \fB-D Directory\fR ] [ \fB-U username\fR ] [ \fB-W workgroup\fR ] [ \fB-M <netbios name>\fR ] [ \fB-m maxprotocol\fR ] [ \fB-A authfile\fR ] [ \fB-N\fR ] [ \fB-l logfile\fR ] [ \fB-L <netbios name>\fR ] [ \fB-I destinationIP\fR ] [ \fB-E <terminal code>\fR ] [ \fB-c <command string>\fR ] [ \fB-i scope\fR ] [ \fB-O <socket options>\fR ] [ \fB-p port\fR ] [ \fB-R <name resolve order>\fR ] [ \fB-s <smb config file>\fR ] [ \fB-T<c|x>IXFqgbNan\fR ] .SH "DESCRIPTION" .PP -This tool is part of the Samba <URL:samba.7.html> suite. +This tool is part of the Samba suite. .PP \fBsmbclient\fR is a client that can \&'talk' to an SMB/CIFS server. It offers an interface -similar to that of the ftp program (see \fBftp(1)\fR). +similar to that of the ftp program (see \fBftp(1)\fR). Operations include things like getting files from the server to the local machine, putting files from the local machine to the server, retrieving directory information from the server @@ -27,15 +26,14 @@ and so on. servicename is the name of the service you want to use on the server. A service name takes the form \fI//server/service\fR where \fIserver -\fR is the NetBIOS name of the SMB/CIFS server +\fRis the NetBIOS name of the SMB/CIFS server offering the desired service and \fIservice\fR -is the name of the service offered. Thus to connect to +is the name of the service offered. Thus to connect to the service "printer" on the SMB/CIFS server "smbserver", you would use the servicename \fI//smbserver/printer \fR - Note that the server name required is NOT necessarily -the IP (DNS) host name of the server ! The name required is +the IP (DNS) host name of the server ! The name required is a NetBIOS server name, which may or may not be the same as the IP hostname of the machine running the server. @@ -61,7 +59,7 @@ required, simply press ENTER to provide a null password.) Note: Some servers (including OS/2 and Windows for Workgroups) insist on an uppercase password. Lowercase -or mixed case passwords may be rejected by these servers. +or mixed case passwords may be rejected by these servers. Be cautious about including passwords in scripts. .TP @@ -71,7 +69,7 @@ Specifies the location of the all important .TP \fB-O socket options\fR TCP socket options to set on the client -socket. See the socket options parameter in the \fI smb.conf (5)\fR manpage for the list of valid +socket. See the socket options parameter in the \fI smb.conf (5)\fR manpage for the list of valid options. .TP \fB-R <name resolve order>\fR @@ -87,7 +85,7 @@ cause names to be resolved as follows : \(bu lmhosts : Lookup an IP address in the Samba lmhosts file. If the line in lmhosts has -no name type attached to the NetBIOS name (see the lmhosts(5) <URL:lmhosts.5.html> for details) then +no name type attached to the NetBIOS name (see the lmhosts(5) for details) then any name type matches for lookup. .TP 0.2i \(bu @@ -96,14 +94,14 @@ name to IP address resolution, using the system \fI/etc/hosts \fR, NIS, or DNS lookups. This method of name resolution is operating system dependent, for instance on IRIX or Solaris this may be controlled by the \fI/etc/nsswitch.conf\fR -file). Note that this method is only used if the NetBIOS name +file). Note that this method is only used if the NetBIOS name type being queried is the 0x20 (server) name type, otherwise it is ignored. .TP 0.2i \(bu wins : Query a name with the IP address listed in the \fIwins server\fR -parameter. If no WINS server has +parameter. If no WINS server has been specified this method will be ignored. .TP 0.2i \(bu @@ -114,15 +112,17 @@ parameter. This is the least reliable of the name resolution methods as it depends on the target host being on a locally connected subnet. .RE - +.PP If this parameter is not set then the name resolve order -defined in the \fIsmb.conf\fR file parameter +defined in the \fIsmb.conf\fR file parameter (name resolve order) will be used. - +.PP +.PP The default order is lmhosts, host, wins, bcast and without this parameter or any entry in the \fIname resolve order -\fR parameter of the \fIsmb.conf\fR file the name resolution +\fRparameter of the \fIsmb.conf\fR file the name resolution methods will be attempted in this order. +.PP .TP \fB-M NetBIOS name\fR This options allows you to send messages, using @@ -139,7 +139,7 @@ The message is also automatically truncated if the message is over 1600 bytes, as this is the limit of the protocol. One useful trick is to cat the message through -\fBsmbclient\fR. For example: \fB cat mymessage.txt | smbclient -M FRED \fR will +\fBsmbclient\fR. For example: \fB cat mymessage.txt | smbclient -M FRED \fR will send the message in the file \fImymessage.txt\fR to the machine FRED. @@ -147,7 +147,7 @@ You may also find the \fI-U\fR and \fI-I\fR options useful, as they allow you to control the FROM and TO parts of the message. -See the message command parameter in the \fI smb.conf(5)\fR for a description of how to handle incoming +See the message command parameter in the \fI smb.conf(5)\fR for a description of how to handle incoming WinPopup messages in Samba. \fBNote\fR: Copy WinPopup into the startup group @@ -197,7 +197,7 @@ data, and should only be used when investigating a problem. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic. If \fIdebuglevel\fR is set to the letter 'A', then \fBall -\fR debug messages will be printed. This setting +\fRdebug messages will be printed. This setting is for developers only (and people who \fBreally\fR want to know how the code works internally). @@ -222,7 +222,7 @@ The base name is used to generate actual log file names. For example, if the name specified was "log", the debug file would be \fIlog.client\fR. -The log file generated is never removed by the client. +The log file generated is never removed by the client. .TP \fB-h\fR Print the usage message for the client. @@ -267,11 +267,11 @@ a \fBPASSWD\fR environment variable from which to read the password. A third option is to use a credentials file which -contains the plaintext of the domain name, username and password. This +contains the plaintext of the domain name, username and password. This option is mainly provided for scripts where the admin doesn't wish to pass the credentials on the command line or via environment variables. If this method is used, make certain that the permissions -on the file restrict access from unwanted users. See the +on the file restrict access from unwanted users. See the \fI-A\fR for more details. Be cautious about including passwords in scripts or in @@ -284,14 +284,15 @@ it in directly. \fB-A filename\fR This option allows you to specify a file from which to read the username, domain name, and -password used in the connection. The format of the file is - +password used in the connection. The format of the file is +.sp .nf username = <value> password = <value> domain = <value> +.sp .fi If the domain parameter is missing the current workgroup name @@ -301,8 +302,8 @@ access from unwanted users. \fB-L\fR This option allows you to look at what services are available on a server. You use it as \fBsmbclient -L -host\fR and a list should appear. The \fI-I -\fR option may be useful if your NetBIOS names don't +host\fR and a list should appear. The \fI-I +\fRoption may be useful if your NetBIOS names don't match your TCP/IP DNS host names or if you are trying to reach a host on another network. .TP @@ -310,7 +311,7 @@ host on another network. This option tells \fBsmbclient\fR how to interpret filenames coming from the remote server. Usually Asian language multibyte UNIX implementations use different character sets than -SMB/CIFS servers (\fBEUC\fR instead of \fB SJIS\fR for example). Setting this parameter will let +SMB/CIFS servers (\fBEUC\fR instead of \fB SJIS\fR for example). Setting this parameter will let \fBsmbclient\fR convert between the UNIX filenames and the SMB filenames correctly. This option has not been seriously tested and may have some problems. @@ -333,7 +334,7 @@ servers. .TP \fB-T tar options\fR smbclient may be used to create \fBtar(1) -\fR compatible backups of all the files on an SMB/CIFS +\fRcompatible backups of all the files on an SMB/CIFS share. The secondary tar flags that can be given to this option are : .RS @@ -360,18 +361,18 @@ their creation dates restored properly. \fII\fR - Include files and directories. Is the default behavior when filenames are specified above. Causes tar files to be included in an extract or create (and therefore -everything else to be excluded). See example below. Filename globbing -works in one of two ways. See r below. +everything else to be excluded). See example below. Filename globbing +works in one of two ways. See r below. .TP 0.2i \(bu \fIX\fR - Exclude files and directories. Causes tar files to be excluded from an extract or create. See -example below. Filename globbing works in one of two ways now. +example below. Filename globbing works in one of two ways now. See \fIr\fR below. .TP 0.2i \(bu \fIb\fR - Blocksize. Must be followed -by a valid (greater than zero) blocksize. Causes tar file to be +by a valid (greater than zero) blocksize. Causes tar file to be written out in blocksize*TBLOCK (usually 512 byte) blocks. .TP 0.2i \(bu @@ -381,14 +382,14 @@ files that have the archive bit set. Useful only with the .TP 0.2i \(bu \fIq\fR - Quiet. Keeps tar from printing -diagnostics as it works. This is the same as tarmode quiet. +diagnostics as it works. This is the same as tarmode quiet. .TP 0.2i \(bu \fIr\fR - Regular expression include -or exclude. Uses regular expression matching for -excluding or excluding files if compiled with HAVE_REGEX_H. -However this mode can be very slow. If not compiled with -HAVE_REGEX_H, does a limited wildcard match on '*' and '?'. +or exclude. Uses regular expression matching for +excluding or excluding files if compiled with HAVE_REGEX_H. +However this mode can be very slow. If not compiled with +HAVE_REGEX_H, does a limited wildcard match on '*' and '?'. .TP 0.2i \(bu \fIN\fR - Newer than. Must be followed @@ -402,50 +403,63 @@ specified are backed up to the tar file. Useful only with the archive bit to be reset when a file is backed up. Useful with the \fIg\fR and \fIc\fR flags. .RE - +.PP \fBTar Long File Names\fR - +.PP +.PP \fBsmbclient\fR's tar option now supports long file names both on backup and restore. However, the full path -name of the file must be less than 1024 bytes. Also, when +name of the file must be less than 1024 bytes. Also, when a tar archive is created, \fBsmbclient\fR's tar option places all files in the archive with relative names, not absolute names. - +.PP +.PP \fBTar Filenames\fR - +.PP +.PP All file names can be given as DOS path names (with '\\' as the component separator) or as UNIX path names (with '/' as the component separator). - +.PP +.PP \fBExamples\fR - +.PP +.PP Restore from tar file \fIbackup.tar\fR into myshare on mypc (no password on share). - +.PP +.PP \fBsmbclient //mypc/yshare "" -N -Tx backup.tar -\fR - +\fR.PP +.PP Restore everything except \fIusers/docs\fR - +.PP +.PP \fBsmbclient //mypc/myshare "" -N -TXx backup.tar users/docs\fR - -Create a tar file of the files beneath \fI users/docs\fR. - +.PP +.PP +Create a tar file of the files beneath \fI users/docs\fR. +.PP +.PP \fBsmbclient //mypc/myshare "" -N -Tc backup.tar users/docs \fR - +.PP +.PP Create the same tar file as above, but now use a DOS path name. - +.PP +.PP \fBsmbclient //mypc/myshare "" -N -tc backup.tar users\\edocs \fR - +.PP +.PP Create a tar file of all the files and directories in the share. - +.PP +.PP \fBsmbclient //mypc/myshare "" -N -Tc backup.tar * -\fR +\fR.PP .TP \fB-D initial directory\fR Change to initial directory before starting. Probably @@ -453,7 +467,7 @@ only of any use with the tar -T option. .TP \fB-c command string\fR command string is a semicolon-separated list of -commands to be executed instead of prompting from stdin. \fI -N\fR is implied by \fI-c\fR. +commands to be executed instead of prompting from stdin. \fI -N\fR is implied by \fI-c\fR. This is particularly useful in scripts and for printing stdin to the server, e.g. \fB-c 'print -'\fR. @@ -472,14 +486,14 @@ The prompt indicates that the client is ready and waiting to carry out a user command. Each command is a single word, optionally followed by parameters specific to that command. Command and parameters are space-delimited unless these notes specifically -state otherwise. All commands are case-insensitive. Parameters to +state otherwise. All commands are case-insensitive. Parameters to commands may or may not be case sensitive, depending on the command. .PP You can specify file names which have spaces in them by quoting the name with double quotes, for example "a long file name". .PP Parameters shown in square brackets (e.g., "[parameter]") are -optional. If not given, the command will use suitable defaults. Parameters +optional. If not given, the command will use suitable defaults. Parameters shown in angle brackets (e.g., "<parameter>") are required. .PP Note that all commands operating on the server are actually @@ -490,12 +504,12 @@ The commands available are given here in alphabetical order. .TP \fB? [command]\fR If \fIcommand\fR is specified, the ? command will display -a brief informative message about the specified command. If no +a brief informative message about the specified command. If no command is specified, a list of available commands will be displayed. .TP \fB! [shell command]\fR -If \fIshell command\fR is specified, the ! +If \fIshell command\fR 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. .TP @@ -545,7 +559,7 @@ from the program. \fBget <remote file name> [local file name]\fR Copy the file called \fIremote file name\fR from the server to the machine running the client. If specified, name -the local copy \fIlocal file name\fR. Note that all transfers in +the local copy \fIlocal file name\fR. Note that all transfers in \fBsmbclient\fR are binary. See also the lowercase command. .TP @@ -703,7 +717,7 @@ outside the currently connected share. This is enforced by the Samba server. .TP \fBtar <c|x>[IXbgNa]\fR Performs a tar operation - see the \fI-T -\fR command line option above. Behavior may be affected +\fRcommand 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. @@ -736,18 +750,18 @@ supports the LANMAN2 protocol or above. .SH "ENVIRONMENT VARIABLES" .PP The variable \fBUSER\fR may contain the -username of the person using the client. This information is -used only if the protocol level is high enough to support +username of the person using the client. This information is +used only if the protocol level is high enough to support session-level passwords. .PP The variable \fBPASSWD\fR may contain -the password of the person using the client. This information is +the password of the person using the client. This information is used only if the protocol level is high enough to support session-level passwords. .PP The variable \fBLIBSMB_PROG\fR may contain the path, executed with system(), which the client should connect -to instead of connecting to a server. This functionality is primarily +to instead of connecting to a server. This functionality is primarily intended as a development aid, and works best when using a LMHOSTS file .SH "INSTALLATION" @@ -767,7 +781,7 @@ and writeable only by the user. .PP To test the client, you will need to know the name of a running SMB/CIFS server. It is possible to run \fBsmbd(8) -\fR as an ordinary user - running that server as a daemon +\fRas an ordinary user - running that server as a daemon on a user-accessible port (typically any port number over 1024) would provide a suitable test server. .SH "DIAGNOSTICS" @@ -794,5 +808,5 @@ The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0 -release by Jeremy Allison. The conversion to DocBook for +release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter |