Changeset 134 for branches/samba-3.0/docs/manpages/smbclient.1
- Timestamp:
- May 23, 2008, 6:56:41 AM (17 years ago)
- File:
-
- 1 edited
-
branches/samba-3.0/docs/manpages/smbclient.1 (modified) (6 diffs)
Legend:
- Unmodified
- Added
- Removed
-
branches/samba-3.0/docs/manpages/smbclient.1
r44 r134 1 .\"Generated by db2man.xsl. Don't modify this, modify the source. 2 .de Sh \" Subsection 3 .br 4 .if t .Sp 5 .ne 5 6 .PP 7 \fB\\$1\fR 8 .PP 9 .. 10 .de Sp \" Vertical space (when we can't use .PP) 11 .if t .sp .5v 12 .if n .sp 13 .. 14 .de Ip \" List item 15 .br 16 .ie \\n(.$>=3 .ne \\$3 17 .el .ne 3 18 .IP "\\$1" \\$2 19 .. 20 .TH "SMBCLIENT" 1 "" "" "" 1 .\" Title: smbclient 2 .\" Author: 3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> 4 .\" Date: 05/21/2008 5 .\" Manual: User Commands 6 .\" Source: Samba 3.0 7 .\" 8 .TH "SMBCLIENT" "1" "05/21/2008" "Samba 3\.0" "User Commands" 9 .\" disable hyphenation 10 .nh 11 .\" disable justification (adjust text to left margin only) 12 .ad l 21 13 .SH "NAME" 22 14 smbclient - ftp-like client to access SMB/CIFS resources on servers 23 15 .SH "SYNOPSIS" 24 16 .HP 1 25 smbclient [ -b <buffer size>] [-d debuglevel] [-L <netbios name>] [-U username] [-I destinationIP] [-M <netbios name>] [-m maxprotocol] [-A authfile] [-N] [-i scope] [-O <socket options>] [-p port] [-R <name resolve order>] [-s <smb config file>] [-k] [-P] [-c<command>]17 smbclient [\-b\ <buffer\ size>] [\-d\ debuglevel] [\-e] [\-L\ <netbios\ name>] [\-U\ username] [\-I\ destinationIP] [\-M\ <netbios\ name>] [\-m\ maxprotocol] [\-A\ authfile] [\-N] [\-i\ scope] [\-O\ <socket\ options>] [\-p\ port] [\-R\ <name\ resolve\ order>] [\-s\ <smb\ config\ file>] [\-k] [\-P] [\-c\ <command>] 26 18 .HP 1 27 smbclient {servicename} [password] [ -b <buffer size>] [-d debuglevel] [-D Directory] [-U username] [-W workgroup] [-M <netbios name>] [-m maxprotocol] [-A authfile] [-N] [-l logdir] [-I destinationIP] [-E] [-c <command string>] [-i scope] [-O <socket options>] [-p port] [-R <name resolve order>] [-s <smb config file>] [-T<c|x>IXFqgbNan] [-k]19 smbclient {servicename} [password] [\-b\ <buffer\ size>] [\-d\ debuglevel] [\-e] [\-D\ Directory] [\-U\ username] [\-W\ workgroup] [\-M\ <netbios\ name>] [\-m\ maxprotocol] [\-A\ authfile] [\-N] [\-l\ log\-basename] [\-I\ destinationIP] [\-E] [\-c\ <command\ string>] [\-i\ scope] [\-O\ <socket\ options>] [\-p\ port] [\-R\ <name\ resolve\ order>] [\-s\ <smb\ config\ file>] [\-T<c|x>IXFqgbNan] [\-k] 28 20 .SH "DESCRIPTION" 29 21 .PP 30 22 This tool is part of the 31 23 \fBsamba\fR(7) 32 suite .24 suite\. 33 25 .PP 34 26 smbclient 35 is a client that can 'talk' to an SMB/CIFS server. It offers an interface similar to that of the ftp program (see36 \fBftp\fR(1)) . 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 and so on.27 is a client that can \'talk\' to an SMB/CIFS server\. It offers an interface similar to that of the ftp program (see 28 \fBftp\fR(1))\. 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 and so on\. 37 29 .SH "OPTIONS" 38 30 .PP 39 31 servicename 40 .RS 3n41 servicename is the name of the service you want to use on the server . A service name takes the form32 .RS 4 33 servicename is the name of the service you want to use on the server\. A service name takes the form 42 34 \fI//server/service\fR 43 35 where … … 45 37 is the NetBIOS name of the SMB/CIFS server offering the desired service and 46 38 \fIservice\fR 47 is the name of the service offered . Thus to connect to the service "printer" on the SMB/CIFS server "smbserver", you would use the servicename39 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 48 40 \fI//smbserver/printer \fR 49 41 .sp 50 Note that the server name required is NOT necessarily 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 .42 Note that the server name required is NOT necessarily 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\. 51 43 .sp 52 44 The server name is looked up according to either the 53 \fI -R\fR45 \fI\-R\fR 54 46 parameter to 55 47 smbclient 56 48 or using the name resolve order parameter in the 57 49 \fBsmb.conf\fR(5) 58 file, allowing an administrator to change the order and methods by which server names are looked up .50 file, allowing an administrator to change the order and methods by which server names are looked up\. 59 51 .RE 60 52 .PP 61 53 password 62 .RS 3n63 The password required to access the specified service on the specified server . If this parameter is supplied, the64 \fI -N\fR65 option (suppress password prompt) is assumed .66 .sp 67 There is no default password . If no password is supplied on the command line (either by using this parameter or adding a password to the68 \fI -U\fR54 .RS 4 55 The password required to access the specified service on the specified server\. If this parameter is supplied, the 56 \fI\-N\fR 57 option (suppress password prompt) is assumed\. 58 .sp 59 There is no default password\. If no password is supplied on the command line (either by using this parameter or adding a password to the 60 \fI\-U\fR 69 61 option (see below)) and the 70 \fI-N\fR 71 option is not specified, the client will prompt for a password, even if the desired service does not require one. (If no password is required, simply press ENTER to provide a null password.) 72 .sp 73 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. 74 .sp 75 Be cautious about including passwords in scripts. 76 .RE 77 .PP 78 -R <name resolve order> 79 .RS 3n 80 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 string of different name resolution options. 81 .sp 82 The options are :"lmhosts", "host", "wins" and "bcast". They cause names to be resolved as follows: 83 .RS 3n 84 .TP 3n 85 \(bu 86 \fBlmhosts\fR: 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 62 \fI\-N\fR 63 option is not specified, the client will prompt for a password, even if the desired service does not require one\. (If no password is required, simply press ENTER to provide a null password\.) 64 .sp 65 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\. 66 .sp 67 Be cautious about including passwords in scripts\. 68 .RE 69 .PP 70 \-R <name resolve order> 71 .RS 4 72 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 string of different name resolution options\. 73 .sp 74 The options are :"lmhosts", "host", "wins" and "bcast"\. They cause names to be resolved as follows: 75 .sp 76 .RS 4 77 .ie n \{\ 78 \h'-04'\(bu\h'+03'\c 79 .\} 80 .el \{\ 81 .sp -1 82 .IP \(bu 2.3 83 .\} 84 \fBlmhosts\fR: 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 87 85 \fBlmhosts\fR(5) 88 for details) then any name type matches for lookup. 89 .TP 3n 90 \(bu 86 for details) then any name type matches for lookup\. 87 .RE 88 .sp 89 .RS 4 90 .ie n \{\ 91 \h'-04'\(bu\h'+03'\c 92 .\} 93 .el \{\ 94 .sp -1 95 .IP \(bu 2.3 96 .\} 91 97 \fBhost\fR: Do a standard host name to IP address resolution, using the system 92 \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 93 \fI/etc/nsswitch.conf\fR 94 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. 95 .TP 3n 96 \(bu 98 \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 99 \fI/etc/nsswitch\.conf\fR 100 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\. 101 .RE 102 .sp 103 .RS 4 104 .ie n \{\ 105 \h'-04'\(bu\h'+03'\c 106 .\} 107 .el \{\ 108 .sp -1 109 .IP \(bu 2.3 110 .\} 97 111 \fBwins\fR: Query a name with the IP address listed in the 98 112 \fIwins server\fR 99 parameter. If no WINS server has been specified this method will be ignored. 100 .TP 3n 101 \(bu 113 parameter\. If no WINS server has been specified this method will be ignored\. 114 .RE 115 .sp 116 .RS 4 117 .ie n \{\ 118 \h'-04'\(bu\h'+03'\c 119 .\} 120 .el \{\ 121 .sp -1 122 .IP \(bu 2.3 123 .\} 102 124 \fBbcast\fR: Do a broadcast on each of the known local interfaces listed in the 103 125 \fIinterfaces\fR 104 parameter . This is the least reliable of the name resolution methods as it depends on the target host being on a locally connected subnet.105 . RE106 . IP "" 3n126 parameter\. This is the least reliable of the name resolution methods as it depends on the target host being on a locally connected subnet\. 127 .sp 128 .RE 107 129 If this parameter is not set then the name resolve order defined in the 108 130 \fBsmb.conf\fR(5) 109 file parameter (name resolve order) will be used .131 file parameter (name resolve order) will be used\. 110 132 .sp 111 133 The default order is lmhosts, host, wins, bcast and without this parameter or any entry in the … … 113 135 parameter of the 114 136 \fBsmb.conf\fR(5) 115 file the name resolution methods will be attempted in this order. 116 .RE 117 .PP 118 -M NetBIOS name 119 .RS 3n 120 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 end. 121 .sp 122 If the receiving computer is running WinPopup the user will receive the message and probably a beep. If they are not running WinPopup the message will be lost, and no error message will occur. 123 .sp 124 The message is also automatically truncated if the message is over 1600 bytes, as this is the limit of the protocol. 125 .sp 126 One useful trick is to cat the message through 127 smbclient. For example: 128 129 .sp 130 131 .nf 132 133 cat mymessage.txt | smbclient -M FRED 134 135 .fi 136 will send the message in the file 137 \fImymessage.txt\fR 138 to the machine FRED. 137 file the name resolution methods will be attempted in this order\. 138 .RE 139 .PP 140 \-M NetBIOS name 141 .RS 4 142 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 end\. 143 .sp 144 If the receiving computer is running WinPopup the user will receive the message and probably a beep\. If they are not running WinPopup the message will be lost, and no error message will occur\. 145 .sp 146 The message is also automatically truncated if the message is over 1600 bytes, as this is the limit of the protocol\. 147 .sp 148 One useful trick is to pipe the message through 149 smbclient\. For example: smbclient \-M FRED < mymessage\.txt will send the message in the file 150 \fImymessage\.txt\fR 151 to the machine FRED\. 139 152 .sp 140 153 You may also find the 141 \fI -U\fR154 \fI\-U\fR 142 155 and 143 \fI -I\fR144 options useful, as they allow you to control the FROM and TO parts of the message .156 \fI\-I\fR 157 options useful, as they allow you to control the FROM and TO parts of the message\. 145 158 .sp 146 159 See the … … 148 161 parameter in the 149 162 \fBsmb.conf\fR(5) 150 for a description of how to handle incoming WinPopup messages in Samba .151 .sp 152 \f BNote\fR: Copy WinPopup into the startup group on your WfWg PCs if you want them to always be able to receive messages.153 .RE 154 .PP 155 -p port156 .RS 3n157 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.158 .RE 159 .PP 160 -P161 .RS 3n162 Make queries to the external server using the machine account of the local server .163 .RE 164 .PP 165 -h|--help166 .RS 3n167 Print a summary of command line options .168 .RE 169 .PP 170 -I IP-address171 .RS 3n163 for a description of how to handle incoming WinPopup messages in Samba\. 164 .sp 165 \fINote\fR: Copy WinPopup into the startup group on your WfWg PCs if you want them to always be able to receive messages\. 166 .RE 167 .PP 168 \-p port 169 .RS 4 170 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\. 171 .RE 172 .PP 173 \-P 174 .RS 4 175 Make queries to the external server using the machine account of the local server\. 176 .RE 177 .PP 178 \-h|\-\-help 179 .RS 4 180 Print a summary of command line options\. 181 .RE 182 .PP 183 \-I IP\-address 184 .RS 4 172 185 \fIIP address\fR 173 is the address of the server to connect to . It should be specified in standard "a.b.c.d" notation.186 is the address of the server to connect to\. It should be specified in standard "a\.b\.c\.d" notation\. 174 187 .sp 175 188 Normally the client would attempt to locate a named SMB/CIFS server by looking it up via the NetBIOS name resolution mechanism described above in the 176 189 \fIname resolve order\fR 177 parameter above . Using this parameter will force the client to assume that the server is on the machine with the specified IP address and the NetBIOS name component of the resource being connected to will be ignored.178 .sp 179 There is no default for this parameter . If not supplied, it will be determined automatically by the client as described above.180 .RE 181 .PP 182 -E183 .RS 3n184 This parameter causes the client to write messages to the standard error stream (stderr) rather than to the standard output stream .185 .sp 186 By default, the client writes messages to standard output - typically the user's tty.187 .RE 188 .PP 189 -L190 .RS 3n191 This option allows you to look at what services are available on a server . You use it as192 smbclient -L host193 and a list should appear . The194 \fI -I \fR195 option 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.196 .RE 197 .PP 198 -t terminal code199 .RS 3n190 parameter above\. Using this parameter will force the client to assume that the server is on the machine with the specified IP address and the NetBIOS name component of the resource being connected to will be ignored\. 191 .sp 192 There is no default for this parameter\. If not supplied, it will be determined automatically by the client as described above\. 193 .RE 194 .PP 195 \-E 196 .RS 4 197 This parameter causes the client to write messages to the standard error stream (stderr) rather than to the standard output stream\. 198 .sp 199 By default, the client writes messages to standard output \- typically the user\'s tty\. 200 .RE 201 .PP 202 \-L 203 .RS 4 204 This option allows you to look at what services are available on a server\. You use it as 205 smbclient \-L host 206 and a list should appear\. The 207 \fI\-I \fR 208 option 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\. 209 .RE 210 .PP 211 \-t terminal code 212 .RS 4 200 213 This option tells 201 214 smbclient 202 how to interpret filenames coming from the remote server . Usually Asian language multibyte UNIX implementations use different character sets than SMB/CIFS servers (\fBEUC\fR215 how to interpret filenames coming from the remote server\. Usually Asian language multibyte UNIX implementations use different character sets than SMB/CIFS servers (\fIEUC\fR 203 216 instead of 204 \f BSJIS\fR205 for example) . Setting this parameter will let217 \fI SJIS\fR 218 for example)\. Setting this parameter will let 206 219 smbclient 207 convert between the UNIX filenames and the SMB filenames correctly. This option has not been seriously tested and may have some problems. 208 .sp 209 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. 210 .RE 211 .PP 212 -b buffersize 213 .RS 3n 214 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 observed to speed up file transfers to and from a Win9x server. 215 .RE 216 .PP 217 -V 218 .RS 3n 219 Prints the program version number. 220 .RE 221 .PP 222 -s <configuration file> 223 .RS 3n 224 The file specified contains the configuration details required by the server. The information in this file includes server-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide. See 225 \fIsmb.conf\fR 226 for more information. The default configuration file name is determined at compile time. 227 .RE 228 .PP 229 -d|--debuglevel=level 230 .RS 3n 220 convert between the UNIX filenames and the SMB filenames correctly\. This option has not been seriously tested and may have some problems\. 221 .sp 222 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\. 223 .RE 224 .PP 225 \-b buffersize 226 .RS 4 227 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 observed to speed up file transfers to and from a Win9x server\. 228 .RE 229 .PP 230 \-e 231 .RS 4 232 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 negotiaion (either kerberos or NTLMv1/v2 if given domain/username/password triple\. Fails the connection if encryption cannot be negotiated\. 233 .RE 234 .PP 235 \-d|\-\-debuglevel=level 236 .RS 4 231 237 \fIlevel\fR 232 is an integer from 0 to 10 . The default value if this parameter is not specified is zero.233 .sp 234 The higher this value, the more detail will be logged to the log files about the activities of the server . At level 0, only critical errors and serious warnings will be logged. Level 1 is a reasonable level for day-to-day running - it generates a small amount of information about operations carried out.235 .sp 236 Levels above 1 will generate considerable amounts of log 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.238 is an integer from 0 to 10\. The default value if this parameter is not specified is 1\. 239 .sp 240 The higher this value, the more detail will be logged to the log files about the activities of the server\. At level 0, only critical errors and serious warnings will be logged\. Level 1 is a reasonable level for day\-to\-day running \- it generates a small amount of information about operations carried out\. 241 .sp 242 Levels above 1 will generate considerable amounts of log 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\. 237 243 .sp 238 244 Note that specifying this parameter here will override the 239 245 \fIlog level\fR 240 246 parameter in the 241 \fIsmb.conf\fR 242 file. 243 .RE 244 .PP 245 -l|--logfile=logdirectory 246 .RS 3n 247 Base directory name for log/debug files. The extension 248 \fB".progname"\fR 249 will be appended (e.g. log.smbclient, log.smbd, etc...). The log file is never removed by the client. 250 .RE 251 .PP 252 -N 253 .RS 3n 254 If specified, this parameter suppresses the normal password prompt from the client to the user. This is useful when accessing a service that does not require a password. 255 .sp 256 Unless a password is specified on the command line or this parameter is specified, the client will request a password. 257 .sp 258 If a password is specified on the command line and this option is also defined the password on the command line will be silently ingnored and no password will be used. 259 .RE 260 .PP 261 -k 262 .RS 3n 263 Try to authenticate with kerberos. Only useful in an Active Directory environment. 264 .RE 265 .PP 266 -A|--authentication-file=filename 267 .RS 3n 268 This option allows you to specify a file from which to read the username and password used in the connection. The format of the file is 269 .sp 270 271 .sp 272 247 \fIsmb\.conf\fR 248 file\. 249 .RE 250 .PP 251 \-V 252 .RS 4 253 Prints the program version number\. 254 .RE 255 .PP 256 \-s <configuration file> 257 .RS 4 258 The file specified contains the configuration details required by the server\. The information in this file includes server\-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide\. See 259 \fIsmb\.conf\fR 260 for more information\. The default configuration file name is determined at compile time\. 261 .RE 262 .PP 263 \-l|\-\-log\-basename=logdirectory 264 .RS 4 265 Base directory name for log/debug files\. The extension 266 \fB"\.progname"\fR 267 will be appended (e\.g\. log\.smbclient, log\.smbd, etc\.\.\.)\. The log file is never removed by the client\. 268 .RE 269 .PP 270 \-N 271 .RS 4 272 If specified, this parameter suppresses the normal password prompt from the client to the user\. This is useful when accessing a service that does not require a password\. 273 .sp 274 Unless a password is specified on the command line or this parameter is specified, the client will request a password\. 275 .sp 276 If a password is specified on the command line and this option is also defined the password on the command line will be silently ingnored and no password will be used\. 277 .RE 278 .PP 279 \-k 280 .RS 4 281 Try to authenticate with kerberos\. Only useful in an Active Directory environment\. 282 .RE 283 .PP 284 \-A|\-\-authentication\-file=filename 285 .RS 4 286 This option allows you to specify a file from which to read the username and password used in the connection\. The format of the file is 287 .sp 288 .sp 289 .RS 4 273 290 .nf 274 275 291 username = <value> 276 292 password = <value> 277 293 domain = <value> 278 279 294 .fi 280 281 .sp 282 Make certain that the permissions on the file restrict access from unwanted users .283 .RE 284 .PP 285 -U|--user=username[%password]286 .RS 3n287 Sets the SMB username or username and password .288 .sp 289 If %password is not specified, the user will be prompted . The client will first check the295 .RE 296 .sp 297 Make certain that the permissions on the file restrict access from unwanted users\. 298 .RE 299 .PP 300 \-U|\-\-user=username[%password] 301 .RS 4 302 Sets the SMB username or username and password\. 303 .sp 304 If %password is not specified, the user will be prompted\. The client will first check the 290 305 \fBUSER\fR 291 306 environment variable, then the 292 307 \fBLOGNAME\fR 293 variable and if either exists, the string is uppercased . If these environmental variables are not found, the username308 variable and if either exists, the string is uppercased\. If these environmental variables are not found, the username 294 309 \fBGUEST\fR 295 is used .296 .sp 297 A third option is to use a credentials file which contains the plaintext of the username and password . This option is mainly provided for scripts where the admin does not 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 the298 \fI -A\fR299 for more details .300 .sp 301 Be cautious about including passwords in scripts . Also, on many systems the command line of a running process may be seen via the310 is used\. 311 .sp 312 A third option is to use a credentials file which contains the plaintext of the username and password\. This option is mainly provided for scripts where the admin does not 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 313 \fI\-A\fR 314 for more details\. 315 .sp 316 Be cautious about including passwords in scripts\. Also, on many systems the command line of a running process may be seen via the 302 317 ps 303 command . To be safe always allow318 command\. To be safe always allow 304 319 rpcclient 305 to prompt for a password and type it in directly .306 .RE 307 .PP 308 -n <primary NetBIOS name>309 .RS 3n310 This option allows you to override the NetBIOS name that Samba uses for itself . This is identical to setting the311 320 to prompt for a password and type it in directly\. 321 .RE 322 .PP 323 \-n <primary NetBIOS name> 324 .RS 4 325 This option allows you to override the NetBIOS name that Samba uses for itself\. This is identical to setting the 326 \fInetbios name\fR 312 327 parameter in the 313 \fIsmb .conf\fR314 file . However, a command line setting will take precedence over settings in315 \fIsmb .conf\fR.316 .RE 317 .PP 318 -i <scope>319 .RS 3n328 \fIsmb\.conf\fR 329 file\. However, a command line setting will take precedence over settings in 330 \fIsmb\.conf\fR\. 331 .RE 332 .PP 333 \-i <scope> 334 .RS 4 320 335 This specifies a NetBIOS scope that 321 336 nmblookup 322 will use to communicate with when generating NetBIOS names . For details on the use of NetBIOS scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are323 \f Bvery\fR324 rarely used, only set this parameter if you are the system administrator in charge of all the NetBIOS systems you communicate with .325 .RE 326 .PP 327 -W|--workgroup=domain328 .RS 3n329 Set the SMB domain of the username . This overrides the default domain which is the domain defined in smb.conf. If the domain specified is the same as the servers NetBIOS name, it causes the client to log on using the servers local SAM (as opposed to the Domain SAM).330 .RE 331 .PP 332 -O socket options333 .RS 3n334 TCP socket options to set on the client socket . See the socket options parameter in the335 \fIsmb .conf\fR336 manual page for the list of valid options .337 .RE 338 .PP 339 -T tar options340 .RS 3n337 will use to communicate with when generating NetBIOS names\. For details on the use of NetBIOS scopes, see rfc1001\.txt and rfc1002\.txt\. NetBIOS scopes are 338 \fIvery\fR 339 rarely used, only set this parameter if you are the system administrator in charge of all the NetBIOS systems you communicate with\. 340 .RE 341 .PP 342 \-W|\-\-workgroup=domain 343 .RS 4 344 Set the SMB domain of the username\. This overrides the default domain which is the domain defined in smb\.conf\. If the domain specified is the same as the servers NetBIOS name, it causes the client to log on using the servers local SAM (as opposed to the Domain SAM)\. 345 .RE 346 .PP 347 \-O socket options 348 .RS 4 349 TCP socket options to set on the client socket\. See the socket options parameter in the 350 \fIsmb\.conf\fR 351 manual page for the list of valid options\. 352 .RE 353 .PP 354 \-T tar options 355 .RS 4 341 356 smbclient may be used to create 342 357 tar(1) 343 compatible backups of all the files on an SMB/CIFS share. The secondary tar flags that can be given to this option are : 344 .RS 3n 345 .TP 3n 346 \(bu 358 compatible backups of all the files on an SMB/CIFS share\. The secondary tar flags that can be given to this option are : 359 .sp 360 .RS 4 361 .ie n \{\ 362 \h'-04'\(bu\h'+03'\c 363 .\} 364 .el \{\ 365 .sp -1 366 .IP \(bu 2.3 367 .\} 347 368 \fIc\fR 348 - Create a tar file on UNIX. Must be followed by the name of a tar file, tape device or "-" for standard output. If using standard output you must turn the log level to its lowest value -d0 to avoid corrupting your tar file. This flag is mutually exclusive with the369 \- Create a tar file on UNIX\. Must be followed by the name of a tar file, tape device or "\-" for standard output\. If using standard output you must turn the log level to its lowest value \-d0 to avoid corrupting your tar file\. This flag is mutually exclusive with the 349 370 \fIx\fR 350 flag. 351 .TP 3n 352 \(bu 371 flag\. 372 .RE 373 .sp 374 .RS 4 375 .ie n \{\ 376 \h'-04'\(bu\h'+03'\c 377 .\} 378 .el \{\ 379 .sp -1 380 .IP \(bu 2.3 381 .\} 353 382 \fIx\fR 354 - Extract (restore) a local tar file back to a share. Unless the -D option is given, the tar files will be restored from the top level of the share. Must be followed by the name of the tar file, device or "-" for standard input. Mutually exclusive with the383 \- Extract (restore) a local tar file back to a share\. Unless the \-D option is given, the tar files will be restored from the top level of the share\. Must be followed by the name of the tar file, device or "\-" for standard input\. Mutually exclusive with the 355 384 \fIc\fR 356 flag. Restored files have their creation times (mtime) set to the date saved in the tar file. Directories currently do not get their creation dates restored properly. 357 .TP 3n 358 \(bu 385 flag\. Restored files have their creation times (mtime) set to the date saved in the tar file\. Directories currently do not get their creation dates restored properly\. 386 .RE 387 .sp 388 .RS 4 389 .ie n \{\ 390 \h'-04'\(bu\h'+03'\c 391 .\} 392 .el \{\ 393 .sp -1 394 .IP \(bu 2.3 395 .\} 359 396 \fII\fR 360 - Include files and directories. Is the default behavior when filenames are specified above. Causes 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. See397 \- Include files and directories\. Is the default behavior when filenames are specified above\. Causes 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 361 398 \fIr\fR 362 below. 363 .TP 3n 364 \(bu 399 below\. 400 .RE 401 .sp 402 .RS 4 403 .ie n \{\ 404 \h'-04'\(bu\h'+03'\c 405 .\} 406 .el \{\ 407 .sp -1 408 .IP \(bu 2.3 409 .\} 365 410 \fIX\fR 366 - Exclude files and directories. Causes files to be excluded from an extract or create. See example below. Filename globbing works in one of two ways now. See411 \- Exclude files and directories\. Causes files to be excluded from an extract or create\. See example below\. Filename globbing works in one of two ways now\. See 367 412 \fIr\fR 368 below. 369 .TP 3n 370 \(bu 413 below\. 414 .RE 415 .sp 416 .RS 4 417 .ie n \{\ 418 \h'-04'\(bu\h'+03'\c 419 .\} 420 .el \{\ 421 .sp -1 422 .IP \(bu 2.3 423 .\} 371 424 \fIF\fR 372 - File containing a list of files and directories. The425 \- File containing a list of files and directories\. The 373 426 \fIF\fR 374 causes the name following the tarfile to create to be read as a filename that contains a list of files and directories 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. See427 causes the name following the tarfile to create to be read as a filename that contains a list of files and directories 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 375 428 \fIr\fR 376 below. 377 .TP 3n 378 \(bu 429 below\. 430 .RE 431 .sp 432 .RS 4 433 .ie n \{\ 434 \h'-04'\(bu\h'+03'\c 435 .\} 436 .el \{\ 437 .sp -1 438 .IP \(bu 2.3 439 .\} 379 440 \fIb\fR 380 - Blocksize. Must be followed by a valid (greater than zero) blocksize. Causes tar file to be written out in blocksize*TBLOCK (usually 512 byte) blocks. 381 .TP 3n 382 \(bu 441 \- Blocksize\. Must be followed by a valid (greater than zero) blocksize\. Causes tar file to be written out in blocksize*TBLOCK (usually 512 byte) blocks\. 442 .RE 443 .sp 444 .RS 4 445 .ie n \{\ 446 \h'-04'\(bu\h'+03'\c 447 .\} 448 .el \{\ 449 .sp -1 450 .IP \(bu 2.3 451 .\} 383 452 \fIg\fR 384 - Incremental. Only back up files that have the archive bit set. Useful only with the453 \- Incremental\. Only back up files that have the archive bit set\. Useful only with the 385 454 \fIc\fR 386 flag. 387 .TP 3n 388 \(bu 455 flag\. 456 .RE 457 .sp 458 .RS 4 459 .ie n \{\ 460 \h'-04'\(bu\h'+03'\c 461 .\} 462 .el \{\ 463 .sp -1 464 .IP \(bu 2.3 465 .\} 389 466 \fIq\fR 390 - Quiet. Keeps tar from printing diagnostics as it works. This is the same as tarmode quiet. 391 .TP 3n 392 \(bu 467 \- Quiet\. Keeps tar from printing diagnostics as it works\. This is the same as tarmode quiet\. 468 .RE 469 .sp 470 .RS 4 471 .ie n \{\ 472 \h'-04'\(bu\h'+03'\c 473 .\} 474 .el \{\ 475 .sp -1 476 .IP \(bu 2.3 477 .\} 393 478 \fIr\fR 394 - 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 '?'. 395 .TP 3n 396 \(bu 479 \- 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 \'?\'\. 480 .RE 481 .sp 482 .RS 4 483 .ie n \{\ 484 \h'-04'\(bu\h'+03'\c 485 .\} 486 .el \{\ 487 .sp -1 488 .IP \(bu 2.3 489 .\} 397 490 \fIN\fR 398 - Newer than. Must be followed by the name of a file whose date is compared against files found on the share during a create. Only files newer than the file specified are backed up to the tar file. Useful only with the491 \- Newer than\. Must be followed by the name of a file whose date is compared against files found on the share during a create\. Only files newer than the file specified are backed up to the tar file\. Useful only with the 399 492 \fIc\fR 400 flag. 401 .TP 3n 402 \(bu 493 flag\. 494 .RE 495 .sp 496 .RS 4 497 .ie n \{\ 498 \h'-04'\(bu\h'+03'\c 499 .\} 500 .el \{\ 501 .sp -1 502 .IP \(bu 2.3 503 .\} 403 504 \fIa\fR 404 - Set archive bit. Causes the archive bit to be reset when a file is backed up. Useful with the505 \- Set archive bit\. Causes the archive bit to be reset when a file is backed up\. Useful with the 405 506 \fIg\fR 406 507 and 407 508 \fIc\fR 408 flags .409 . RE410 . IP "" 3n411 \f BTar Long File Names\fR412 .sp 413 smbclient '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 a tar archive is created,414 smbclient 's tar option places all files in the archive with relative names, not absolute names.415 .sp 416 \f BTar Filenames\fR417 .sp 418 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).419 .sp 420 \f BExamples\fR509 flags\. 510 .sp 511 .RE 512 \fITar Long File Names\fR 513 .sp 514 smbclient\'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 a tar archive is created, 515 smbclient\'s tar option places all files in the archive with relative names, not absolute names\. 516 .sp 517 \fITar Filenames\fR 518 .sp 519 All file names can be given as DOS path names (with \'\e\e\' as the component separator) or as UNIX path names (with \'/\' as the component separator)\. 520 .sp 521 \fIExamples\fR 421 522 .sp 422 523 Restore from tar file 423 \fIbackup .tar\fR424 into myshare on mypc (no password on share) .425 .sp 426 smbclient //mypc/yshare "" -N -Tx backup.tar524 \fIbackup\.tar\fR 525 into myshare on mypc (no password on share)\. 526 .sp 527 smbclient //mypc/yshare "" \-N \-Tx backup\.tar 427 528 .sp 428 529 Restore everything except 429 530 \fIusers/docs\fR 430 531 .sp 431 smbclient //mypc/myshare "" -N -TXx backup.tar users/docs532 smbclient //mypc/myshare "" \-N \-TXx backup\.tar users/docs 432 533 .sp 433 534 Create a tar file of the files beneath 434 \fI users/docs\fR .435 .sp 436 smbclient //mypc/myshare "" -N -Tc backup.tar users/docs437 .sp 438 Create the same tar file as above, but now use a DOS path name .439 .sp 440 smbclient //mypc/myshare "" -N -tc backup.tar users\\edocs535 \fI users/docs\fR\. 536 .sp 537 smbclient //mypc/myshare "" \-N \-Tc backup\.tar users/docs 538 .sp 539 Create the same tar file as above, but now use a DOS path name\. 540 .sp 541 smbclient //mypc/myshare "" \-N \-tc backup\.tar users\eedocs 441 542 .sp 442 543 Create a tar file of the files listed in the file 443 \fItarlist\fR .444 .sp 445 smbclient //mypc/myshare "" -N -TcF backup.tar tarlist446 .sp 447 Create a tar file of all the files and directories in the share .448 .sp 449 smbclient //mypc/myshare "" -N -Tc backup.tar *450 .RE 451 .PP 452 -D initial directory453 .RS 3n454 Change to initial directory before starting . Probably only of any use with the tar -T option.455 .RE 456 .PP 457 -c command string458 .RS 3n459 command string is a semicolon -separated list of commands to be executed instead of prompting from stdin.460 \fI -N\fR544 \fItarlist\fR\. 545 .sp 546 smbclient //mypc/myshare "" \-N \-TcF backup\.tar tarlist 547 .sp 548 Create a tar file of all the files and directories in the share\. 549 .sp 550 smbclient //mypc/myshare "" \-N \-Tc backup\.tar * 551 .RE 552 .PP 553 \-D initial directory 554 .RS 4 555 Change to initial directory before starting\. Probably only of any use with the tar \-T option\. 556 .RE 557 .PP 558 \-c command string 559 .RS 4 560 command string is a semicolon\-separated list of commands to be executed instead of prompting from stdin\. 561 \fI \-N\fR 461 562 is implied by 462 \fI -c\fR.463 .sp 464 This is particularly useful in scripts and for printing stdin to the server, e .g.465 -c 'print -'.563 \fI\-c\fR\. 564 .sp 565 This is particularly useful in scripts and for printing stdin to the server, e\.g\. 566 \-c \'print \-\'\. 466 567 .RE 467 568 .SH "OPERATIONS" … … 469 570 Once the client is running, the user is presented with a prompt : 470 571 .PP 471 smb:\ >472 .PP 473 The backslash ("\ \") indicates the current working directory on the server, and will change if the current working directory is changed.474 .PP 475 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 commands may or may not be case sensitive, depending on the command.476 .PP 477 You can specify file names which have spaces in them by quoting the name with double quotes, for example "a long file name" .478 .PP 479 Parameters shown in square brackets (e .g., "[parameter]") are optional. If not given, the command will use suitable defaults. Parameters shown in angle brackets (e.g., "<parameter>") are required.480 .PP 481 Note that all commands operating on the server are actually performed by issuing a request to the server . Thus the behavior may vary from server to server, depending on how the server was implemented.482 .PP 483 The commands available are given here in alphabetical order .572 smb:\e> 573 .PP 574 The backslash ("\e\e") indicates the current working directory on the server, and will change if the current working directory is changed\. 575 .PP 576 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 commands may or may not be case sensitive, depending on the command\. 577 .PP 578 You can specify file names which have spaces in them by quoting the name with double quotes, for example "a long file name"\. 579 .PP 580 Parameters shown in square brackets (e\.g\., "[parameter]") are optional\. If not given, the command will use suitable defaults\. Parameters shown in angle brackets (e\.g\., "<parameter>") are required\. 581 .PP 582 Note that all commands operating on the server are actually performed by issuing a request to the server\. Thus the behavior may vary from server to server, depending on how the server was implemented\. 583 .PP 584 The commands available are given here in alphabetical order\. 484 585 .PP 485 586 ? [command] 486 .RS 3n587 .RS 4 487 588 If 488 589 \fIcommand\fR 489 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.590 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\. 490 591 .RE 491 592 .PP 492 593 ! [shell command] 493 .RS 3n594 .RS 4 494 595 If 495 596 \fIshell command\fR 496 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. 597 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\. 598 .RE 599 .PP 600 allinfo file 601 .RS 4 602 The client will request that the server return all known information about a file or directory (including streams)\. 497 603 .RE 498 604 .PP 499 605 altname file 500 .RS 3n 501 The client will request that the server return the "alternate" name (the 8.3 name) for a file or directory. 606 .RS 4 607 The client will request that the server return the "alternate" name (the 8\.3 name) for a file or directory\. 608 .RE 609 .PP 610 archive <number> 611 .RS 4 612 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\. 613 .RE 614 .PP 615 blocksize <number> 616 .RS 4 617 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\. 618 .RE 619 .PP 620 cancel jobid0 [jobid1] \.\.\. [jobidN] 621 .RS 4 622 The client will request that the server cancel the printjobs identified by the given numeric print job ids\. 502 623 .RE 503 624 .PP 504 625 case_sensitive 505 .RS 3n 506 Toggles the setting of the flag in SMB packets that tells the server to treat filenames as case sensitive. Set to OFF by default (tells file server to treat filenames as case insensitive). Only currently affects Samba 3.0.5 and above file servers with the case sensitive parameter set to auto in the smb.conf. 507 .RE 508 .PP 509 cancel jobid0 [jobid1] ... [jobidN] 510 .RS 3n 511 The client will request that the server cancel the printjobs identified by the given numeric print job ids. 626 .RS 4 627 Toggles the setting of the flag in SMB packets that tells the server to treat filenames as case sensitive\. Set to OFF by default (tells file server to treat filenames as case insensitive)\. Only currently affects Samba 3\.0\.5 and above file servers with the case sensitive parameter set to auto in the smb\.conf\. 628 .RE 629 .PP 630 cd <directory name> 631 .RS 4 632 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\. 633 .sp 634 If no directory name is specified, the current working directory on the server will be reported\. 512 635 .RE 513 636 .PP 514 637 chmod file mode in octal 515 .RS 3n516 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 change the UNIX permissions to the given octal mode, in standard UNIX format.638 .RS 4 639 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 change the UNIX permissions to the given octal mode, in standard UNIX format\. 517 640 .RE 518 641 .PP 519 642 chown file uid gid 520 .RS 3n 521 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 change the UNIX user and group ownership to the given decimal values. Note there is currently no way to remotely look up the UNIX uid and gid values for a given name. This may be addressed in future versions of the CIFS UNIX extensions. 522 .RE 523 .PP 524 cd [directory name] 525 .RS 3n 526 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. 527 .sp 528 If no directory name is specified, the current working directory on the server will be reported. 643 .RS 4 644 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 change the UNIX user and group ownership to the given decimal values\. Note there is currently no way to remotely look up the UNIX uid and gid values for a given name\. This may be addressed in future versions of the CIFS UNIX extensions\. 645 .RE 646 .PP 647 close <fileid> 648 .RS 4 649 Closes a file explicitly opened by the open command\. Used for internal Samba testing purposes\. 529 650 .RE 530 651 .PP 531 652 del <mask> 532 .RS 3n653 .RS 4 533 654 The client will request that the server attempt to delete all files matching 534 655 \fImask\fR 535 from the current working directory on the server .656 from the current working directory on the server\. 536 657 .RE 537 658 .PP 538 659 dir <mask> 539 .RS 3n660 .RS 4 540 661 A list of the files matching 541 662 \fImask\fR 542 in the current working directory on the server will be retrieved from the server and displayed. 663 in the current working directory on the server will be retrieved from the server and displayed\. 664 .RE 665 .PP 666 du <filename> 667 .RS 4 668 Does a directory listing and then prints out the current disk useage and free space on a share\. 669 .RE 670 .PP 671 echo <number> <data> 672 .RS 4 673 Does an SMBecho request to ping the server\. Used for internal Samba testing purposes\. 543 674 .RE 544 675 .PP 545 676 exit 546 .RS 3n547 Terminate the connection with the server and exit from the program .677 .RS 4 678 Terminate the connection with the server and exit from the program\. 548 679 .RE 549 680 .PP 550 681 get <remote file name> [local file name] 551 .RS 3n682 .RS 4 552 683 Copy the file called 553 684 \fIremote file name\fR 554 from the server to the machine running the client . If specified, name the local copy555 \fIlocal file name\fR . Note that all transfers in685 from the server to the machine running the client\. If specified, name the local copy 686 \fIlocal file name\fR\. Note that all transfers in 556 687 smbclient 557 are binary. See also the lowercase command. 688 are binary\. See also the lowercase command\. 689 .RE 690 .PP 691 getfacl <filename> 692 .RS 4 693 Requires the server support the UNIX extensions\. Requests and prints the POSIX ACL on a file\. 694 .RE 695 .PP 696 hardlink <src> <dest< 697 .RS 4 698 Creates a hardlink on the server using Windows CIFS semantics\. the POSIX ACL on a file\. 558 699 .RE 559 700 .PP 560 701 help [command] 561 .RS 3n 562 See the ? command above. 702 .RS 4 703 See the ? command above\. 704 .RE 705 .PP 706 history 707 .RS 4 708 Displays the command history\. 709 .RE 710 .PP 711 iosize <bytes> 712 .RS 4 713 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\. 563 714 .RE 564 715 .PP 565 716 lcd [directory name] 566 .RS 3n717 .RS 4 567 718 If 568 719 \fIdirectory name\fR 569 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.570 .sp 571 If no directory name is specified, the name of the current working directory on the local machine will be reported .720 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\. 721 .sp 722 If no directory name is specified, the name of the current working directory on the local machine will be reported\. 572 723 .RE 573 724 .PP 574 725 link target linkname 575 .RS 3n 576 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 hard link between the linkname and target files. The linkname file must not exist. 726 .RS 4 727 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 hard link between the linkname and target files\. The linkname file must not exist\. 728 .RE 729 .PP 730 listconnect 731 .RS 4 732 Show the current connections held for DFS purposes\. 733 .RE 734 .PP 735 lock <filenum> <r|w> <hex\-start> <hex\-len> 736 .RS 4 737 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\. 738 .RE 739 .PP 740 logon <username> <password> 741 .RS 4 742 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\. 577 743 .RE 578 744 .PP 579 745 lowercase 580 .RS 3n581 Toggle lowercasing of filenames for the get and mget commands .582 .sp 583 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 lowercase filenames are the norm on UNIX systems.746 .RS 4 747 Toggle lowercasing of filenames for the get and mget commands\. 748 .sp 749 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 lowercase filenames are the norm on UNIX systems\. 584 750 .RE 585 751 .PP 586 752 ls <mask> 587 .RS 3n588 See the dir command above .753 .RS 4 754 See the dir command above\. 589 755 .RE 590 756 .PP 591 757 mask <mask> 592 .RS 3n593 This command allows the user to set up a mask which will be used during recursive operation of the mget and mput commands .594 .sp 595 The masks specified to the mget and mput commands act as filters for directories rather than files when recursion is toggled ON .596 .sp 597 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 matching "source*" in the current working directory.598 .sp 599 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.758 .RS 4 759 This command allows the user to set up a mask which will be used during recursive operation of the mget and mput commands\. 760 .sp 761 The masks specified to the mget and mput commands act as filters for directories rather than files when recursion is toggled ON\. 762 .sp 763 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 matching "source*" in the current working directory\. 764 .sp 765 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\. 600 766 .RE 601 767 .PP 602 768 md <directory name> 603 .RS 3n604 See the mkdir command .769 .RS 4 770 See the mkdir command\. 605 771 .RE 606 772 .PP 607 773 mget <mask> 608 .RS 3n774 .RS 4 609 775 Copy all files matching 610 776 \fImask\fR 611 from the server to the machine running the client .777 from the server to the machine running the client\. 612 778 .sp 613 779 Note that 614 780 \fImask\fR 615 is interpreted differently during recursive operation and non -recursive operation - refer to the recurse and mask commands for more information. Note that all transfers in781 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 616 782 smbclient 617 are binary . See also the lowercase command.783 are binary\. See also the lowercase command\. 618 784 .RE 619 785 .PP 620 786 mkdir <directory name> 621 .RS 3n 622 Create a new directory on the server (user access privileges permitting) with the specified name. 787 .RS 4 788 Create a new directory on the server (user access privileges permitting) with the specified name\. 789 .RE 790 .PP 791 more <file name> 792 .RS 4 793 Fetch a remote file and view it with the contents of your PAGER environment variable\. 623 794 .RE 624 795 .PP 625 796 mput <mask> 626 .RS 3n797 .RS 4 627 798 Copy all files matching 628 799 \fImask\fR 629 in the current working directory on the local machine to the current working directory on the server .800 in the current working directory on the local machine to the current working directory on the server\. 630 801 .sp 631 802 Note that 632 803 \fImask\fR 633 is interpreted differently during recursive operation and non -recursive operation - refer to the recurse and mask commands for more information. Note that all transfers in804 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 634 805 smbclient 635 are binary. 806 are binary\. 807 .RE 808 .PP 809 posix 810 .RS 4 811 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),\. 812 .RE 813 .PP 814 posix_encrypt <domain> <username> <password> 815 .RS 4 816 This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not\. Attempt to negotiate SMB encryption on this connection\. If smbclient connected with kerberos credentials (\-k) the arguments to this command are ignored and the kerberos credentials are used to negotiate GSSAPI signing and sealing instead\. See also the \-e option to smbclient to force encryption on initial connection\. This command is new with Samba 3\.2\. 817 .RE 818 .PP 819 posix_open <filename> <octal mode> 820 .RS 4 821 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\. 822 .RE 823 .PP 824 posix_mkdir <directoryname> <octal mode> 825 .RS 4 826 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\. 827 .RE 828 .PP 829 posix_rmdir <directoryname> 830 .RS 4 831 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\. 832 .RE 833 .PP 834 posix_unlink <filename> 835 .RS 4 836 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\. 636 837 .RE 637 838 .PP 638 839 print <file name> 639 .RS 3n640 Print the specified file from the local machine through a printable service on the server .840 .RS 4 841 Print the specified file from the local machine through a printable service on the server\. 641 842 .RE 642 843 .PP 643 844 prompt 644 .RS 3n645 Toggle prompting for filenames during operation of the mget and mput commands .646 .sp 647 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.845 .RS 4 846 Toggle prompting for filenames during operation of the mget and mput commands\. 847 .sp 848 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\. 648 849 .RE 649 850 .PP 650 851 put <local file name> [remote file name] 651 .RS 3n852 .RS 4 652 853 Copy the file called 653 854 \fIlocal file name\fR 654 from the machine running the client to the server . If specified, name the remote copy655 \fIremote file name\fR . Note that all transfers in855 from the machine running the client to the server\. If specified, name the remote copy 856 \fIremote file name\fR\. Note that all transfers in 656 857 smbclient 657 are binary . See also the lowercase command.858 are binary\. See also the lowercase command\. 658 859 .RE 659 860 .PP 660 861 queue 661 .RS 3n662 Displays the print queue, showing the job id, name, size and current status .862 .RS 4 863 Displays the print queue, showing the job id, name, size and current status\. 663 864 .RE 664 865 .PP 665 866 quit 666 .RS 3n667 See the exit command .867 .RS 4 868 See the exit command\. 668 869 .RE 669 870 .PP 670 871 rd <directory name> 671 .RS 3n672 See the rmdir command .872 .RS 4 873 See the rmdir command\. 673 874 .RE 674 875 .PP 675 876 recurse 676 .RS 3n677 Toggle directory recursion for the commands mget and mput .678 .sp 679 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.680 .sp 681 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 .877 .RS 4 878 Toggle directory recursion for the commands mget and mput\. 879 .sp 880 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\. 881 .sp 882 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\. 682 883 .RE 683 884 .PP 684 885 rm <mask> 685 .RS 3n886 .RS 4 686 887 Remove all files matching 687 888 \fImask\fR 688 from the current working directory on the server .889 from the current working directory on the server\. 689 890 .RE 690 891 .PP 691 892 rmdir <directory name> 692 .RS 3n693 Remove the specified directory (user access privileges permitting) from the server .694 .RE 695 .PP 696 setmode <filename> <perm=[+|\ -]rsha>697 .RS 3n698 A version of the DOS attrib command to set file permissions . For example:893 .RS 4 894 Remove the specified directory (user access privileges permitting) from the server\. 895 .RE 896 .PP 897 setmode <filename> <perm=[+|\e\-]rsha> 898 .RS 4 899 A version of the DOS attrib command to set file permissions\. For example: 699 900 .sp 700 901 setmode myfile +r 701 902 .sp 702 would make myfile read only. 903 would make myfile read only\. 904 .RE 905 .PP 906 showconnect 907 .RS 4 908 Show the currently active connection held for DFS purposes\. 703 909 .RE 704 910 .PP 705 911 stat file 706 .RS 3n707 This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not . The client requests the UNIX basic info level and prints out the same info that the Linux stat command would about the file. This includes the size, blocks used on disk, file type, permissions, inode number, number of links and finally the three timestamps (access, modify and change). If the file is a special file (symlink, character or block device, fifo or socket) then extra information may also be printed.912 .RS 4 913 This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not\. The client requests the UNIX basic info level and prints out the same info that the Linux stat command would about the file\. This includes the size, blocks used on disk, file type, permissions, inode number, number of links and finally the three timestamps (access, modify and change)\. If the file is a special file (symlink, character or block device, fifo or socket) then extra information may also be printed\. 708 914 .RE 709 915 .PP 710 916 symlink target linkname 711 .RS 3n712 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 outside the currently connected share. This is enforced by the Samba server.917 .RS 4 918 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 outside the currently connected share\. This is enforced by the Samba server\. 713 919 .RE 714 920 .PP 715 921 tar <c|x>[IXbgNa] 716 .RS 3n717 Performs a tar operation - see the718 \fI -T \fR719 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.922 .RS 4 923 Performs a tar operation \- see the 924 \fI\-T \fR 925 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\. 720 926 .RE 721 927 .PP 722 928 blocksize <blocksize> 723 .RS 3n724 Blocksize . Must be followed by a valid (greater than zero) blocksize. Causes tar file to be written out in725 \fIblocksize\fR*TBLOCK (usually 512 byte) blocks .929 .RS 4 930 Blocksize\. Must be followed by a valid (greater than zero) blocksize\. Causes tar file to be written out in 931 \fIblocksize\fR*TBLOCK (usually 512 byte) blocks\. 726 932 .RE 727 933 .PP 728 934 tarmode <full|inc|reset|noreset> 729 .RS 3n 730 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). 935 .RS 4 936 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)\. 937 .RE 938 .PP 939 unlock <filenum> <hex\-start> <hex\-len> 940 .RS 4 941 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\. 942 .RE 943 .PP 944 volume 945 .RS 4 946 Prints the current volume name of the share\. 947 .RE 948 .PP 949 vuid <number> 950 .RS 4 951 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\. 731 952 .RE 732 953 .SH "NOTES" 733 954 .PP 734 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.735 .PP 736 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.737 .PP 738 smbclient supports long file names where the server supports the LANMAN2 protocol or above .955 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\. 956 .PP 957 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\. 958 .PP 959 smbclient supports long file names where the server supports the LANMAN2 protocol or above\. 739 960 .SH "ENVIRONMENT VARIABLES" 740 961 .PP 741 962 The variable 742 963 \fBUSER\fR 743 may contain the username of the person using the client . This information is used only if the protocol level is high enough to support session-level passwords.964 may contain the username of the person using the client\. This information is used only if the protocol level is high enough to support session\-level passwords\. 744 965 .PP 745 966 The variable 746 967 \fBPASSWD\fR 747 may contain 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.968 may contain 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\. 748 969 .PP 749 970 The variable 750 971 \fBLIBSMB_PROG\fR 751 may contain the path, executed with system(), which the client should connect to instead of connecting to a server . This functionality is primarily intended as a development aid, and works best when using a LMHOSTS file972 may contain the path, executed with system(), which the client should connect to instead of connecting to a server\. This functionality is primarily intended as a development aid, and works best when using a LMHOSTS file 752 973 .SH "INSTALLATION" 753 974 .PP 754 The location of the client program is a matter for individual system administrators . The following are thus suggestions only.975 The location of the client program is a matter for individual system administrators\. The following are thus suggestions only\. 755 976 .PP 756 977 It is recommended that the smbclient software be installed in the … … 758 979 or 759 980 \fI /usr/samba/bin/\fR 760 directory, this directory readable by all, writeable only by root . The client program itself should be executable by all. The client should761 \f BNOT\fR981 directory, this directory readable by all, writeable only by root\. The client program itself should be executable by all\. The client should 982 \fINOT\fR 762 983 be setuid or setgid! 763 984 .PP 764 The client log files should be put in a directory readable and writeable only by the user .765 .PP 766 To test the client, you will need to know the name of a running SMB/CIFS server . It is possible to run985 The client log files should be put in a directory readable and writeable only by the user\. 986 .PP 987 To test the client, you will need to know the name of a running SMB/CIFS server\. It is possible to run 767 988 \fBsmbd\fR(8) 768 as 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.989 as 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\. 769 990 .SH "DIAGNOSTICS" 770 991 .PP 771 Most diagnostics issued by the client are logged in a specified log file . The log file name is specified at compile time, but may be overridden on the command line.772 .PP 773 The number and nature of diagnostics available depends on the debug level used by the client . If you have problems, set the debug level to 3 and peruse the log files.992 Most diagnostics issued by the client are logged in a specified log file\. The log file name is specified at compile time, but may be overridden on the command line\. 993 .PP 994 The number and nature of diagnostics available depends on the debug level used by the client\. If you have problems, set the debug level to 3 and peruse the log files\. 774 995 .SH "VERSION" 775 996 .PP 776 This man page is correct for version 3 of the Samba suite.997 This man page is correct for version 3\.2 of the Samba suite\. 777 998 .SH "AUTHOR" 778 999 .PP 779 The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed. 780 .PP 781 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 782 ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done by Alexander Bokovoy. 783 1000 The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\. 1001 .PP 1002 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 1003 ftp://ftp\.icce\.rug\.nl/pub/unix/) and updated for the Samba 2\.0 release by Jeremy Allison\. The conversion to DocBook for Samba 2\.2 was done by Gerald Carter\. The conversion to DocBook XML 4\.2 for Samba 3\.0 was done by Alexander Bokovoy\.
Note:
See TracChangeset
for help on using the changeset viewer.
