This commit was manufactured by cvs2svn to create branch 'SAMBA_3_0'.(This used to...
[ira/wip.git] / docs / manpages / smbclient.1
1 .\" This manpage has been automatically generated by docbook2man 
2 .\" from a DocBook document.  This tool can be found at:
3 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
4 .\" Please send any bug reports, improvements, comments, patches, 
5 .\" etc. to Steve Cheng <steve@ggi-project.org>.
6 .TH "SMBCLIENT" "1" "04 March 2003" "" ""
7 .SH NAME
8 smbclient \- ftp-like client to access SMB/CIFS resources  on servers
9 .SH SYNOPSIS
10
11 \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\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 ]
12
13 .SH "DESCRIPTION"
14 .PP
15 This tool is part of the  Samba suite.
16 .PP
17 \fBsmbclient\fR is a client that can 
18 \&'talk' to an SMB/CIFS server. It offers an interface
19 similar to that of the ftp program (see \fBftp(1)\fR).  
20 Operations include things like getting files from the server 
21 to the local machine, putting files from the local machine to 
22 the server, retrieving directory information from the server 
23 and so on. 
24 .SH "OPTIONS"
25 .TP
26 \fBservicename\fR
27 servicename is the name of the service 
28 you want to use on the server. A service name takes the form
29 \fI//server/service\fR where \fIserver
30 \fR is the NetBIOS name of the SMB/CIFS server 
31 offering the desired service and \fIservice\fR 
32 is the name of the service offered.  Thus to connect to 
33 the service "printer" on the SMB/CIFS server "smbserver",
34 you would use the servicename \fI//smbserver/printer
35 \fR
36
37 Note that the server name required is NOT necessarily 
38 the IP (DNS) host name of the server !  The name required is 
39 a NetBIOS server name, which may or may not be the
40 same as the IP hostname of the machine running the server.
41
42 The server name is looked up according to either 
43 the \fI-R\fR parameter to \fBsmbclient\fR or 
44 using the name resolve order parameter in the \fIsmb.conf\fR file, 
45 allowing an administrator to change the order and methods 
46 by which server names are looked up. 
47 .TP
48 \fBpassword\fR
49 The password required to access the specified 
50 service on the specified server. If this parameter is 
51 supplied, the \fI-N\fR option (suppress 
52 password prompt) is assumed. 
53
54 There is no default password. If no password is supplied 
55 on the command line (either by using this parameter or adding 
56 a password to the \fI-U\fR option (see 
57 below)) and the \fI-N\fR option is not 
58 specified, the client will prompt for a password, even if 
59 the desired service does not require one. (If no password is 
60 required, simply press ENTER to provide a null password.)
61
62 Note: Some servers (including OS/2 and Windows for 
63 Workgroups) insist on an uppercase password. Lowercase 
64 or mixed case passwords may be rejected by these servers.   
65
66 Be cautious about including passwords in scripts.
67 .TP
68 \fB-s smb.conf\fR
69 Specifies the location of the all important 
70 \fIsmb.conf\fR file. 
71 .TP
72 \fB-O socket options\fR
73 TCP socket options to set on the client 
74 socket. See the socket options parameter in the \fI  smb.conf (5)\fR manpage for the list of valid 
75 options. 
76 .TP
77 \fB-R <name resolve order>\fR
78 This option is used by the programs in the Samba 
79 suite to determine what naming services and in what order to resolve 
80 host names to IP addresses. The option takes a space-separated 
81 string of different name resolution options.
82
83 The options are :"lmhosts", "host", "wins" and "bcast". They 
84 cause names to be resolved as follows :
85 .RS
86 .TP 0.2i
87 \(bu
88 lmhosts : Lookup an IP 
89 address in the Samba lmhosts file. If the line in lmhosts has 
90 no name type attached to the NetBIOS name (see the lmhosts(5) for details) then
91 any name type matches for lookup.
92 .TP 0.2i
93 \(bu
94 host : Do a standard host 
95 name to IP address resolution, using the system \fI/etc/hosts
96 \fR, NIS, or DNS lookups. This method of name resolution 
97 is operating system dependent, for instance on IRIX or Solaris this 
98 may be controlled by the \fI/etc/nsswitch.conf\fR 
99 file).  Note that this method is only used if the NetBIOS name 
100 type being queried is the 0x20 (server) name type, otherwise 
101 it is ignored.
102 .TP 0.2i
103 \(bu
104 wins : Query a name with 
105 the IP address listed in the \fIwins server\fR
106 parameter.  If no WINS server has
107 been specified this method will be ignored.
108 .TP 0.2i
109 \(bu
110 bcast : Do a broadcast on 
111 each of the known local interfaces listed in the 
112 \fIinterfaces\fR
113 parameter. This is the least reliable of the name resolution 
114 methods as it depends on the target host being on a locally 
115 connected subnet.
116 .RE
117
118 If this parameter is not set then the name resolve order 
119 defined in the \fIsmb.conf\fR file parameter  
120 (name resolve order) will be used. 
121
122 The default order is lmhosts, host, wins, bcast and without 
123 this parameter or any entry in the \fIname resolve order
124 \fR parameter of the \fIsmb.conf\fR file the name resolution
125 methods will be attempted in this order. 
126 .TP
127 \fB-M NetBIOS name\fR
128 This options allows you to send messages, using 
129 the "WinPopup" protocol, to another computer. Once a connection is 
130 established you then type your message, pressing ^D (control-D) to 
131 end. 
132
133 If the receiving computer is running WinPopup the user will 
134 receive the message and probably a beep. If they are not running 
135 WinPopup the message will be lost, and no error message will 
136 occur. 
137
138 The message is also automatically truncated if the message 
139 is over 1600 bytes, as this is the limit of the protocol. 
140
141 One useful trick is to cat the message through
142 \fBsmbclient\fR. For example: \fB  cat mymessage.txt | smbclient -M FRED \fR will 
143 send the message in the file \fImymessage.txt\fR 
144 to the machine FRED. 
145
146 You may also find the \fI-U\fR and 
147 \fI-I\fR options useful, as they allow you to 
148 control the FROM and TO parts of the message. 
149
150 See the message command parameter in the \fI  smb.conf(5)\fR for a description of how to handle incoming 
151 WinPopup messages in Samba. 
152
153 \fBNote\fR: Copy WinPopup into the startup group 
154 on your WfWg PCs if you want them to always be able to receive 
155 messages. 
156 .TP
157 \fB-i scope\fR
158 This specifies a NetBIOS scope that smbclient will 
159 use to communicate with when generating NetBIOS names. For details 
160 on the use of NetBIOS scopes, see \fIrfc1001.txt\fR 
161 and \fIrfc1002.txt\fR.
162 NetBIOS scopes are \fBvery\fR rarely used, only set 
163 this parameter if you are the system administrator in charge of all 
164 the NetBIOS systems you communicate with. 
165 .TP
166 \fB-N\fR
167 If specified, this parameter suppresses the normal 
168 password prompt from the client to the user. This is useful when 
169 accessing a service that does not require a password. 
170
171 Unless a password is specified on the command line or 
172 this parameter is specified, the client will request a 
173 password.
174 .TP
175 \fB-n NetBIOS name\fR
176 By default, the client will use the local 
177 machine's hostname (in uppercase) as its NetBIOS name. This parameter 
178 allows you to override the host name and use whatever NetBIOS 
179 name you wish. 
180 .TP
181 \fB-d debuglevel\fR
182 \fIdebuglevel\fR is an integer from 0 to 10, or 
183 the letter 'A'. 
184
185 The default value if this parameter is not specified 
186 is zero. 
187
188 The higher this value, the more detail will be logged to 
189 the log files about the activities of the 
190 client. At level 0, only critical errors and serious warnings will 
191 be logged. Level 1 is a reasonable level for day to day running - 
192 it generates a small amount of information about operations 
193 carried out. 
194
195 Levels above 1 will generate considerable amounts of log 
196 data, and should only be used when investigating a problem.
197 Levels above 3 are designed for use only by developers and 
198 generate HUGE amounts of log data, most of which is extremely 
199 cryptic. If \fIdebuglevel\fR is set to the letter 'A', then \fBall
200 \fR  debug messages will be printed. This setting
201 is for developers only (and people who \fBreally\fR want 
202 to know how the code works internally). 
203
204 Note that specifying this parameter here will override
205 the log level parameter in the \fIsmb.conf (5)\fR 
206 file. 
207 .TP
208 \fB-p port\fR
209 This number is the TCP port number that will be used 
210 when making connections to the server. The standard (well-known)
211 TCP port number for an SMB/CIFS server is 139, which is the 
212 default. 
213 .TP
214 \fB-l logfilename\fR
215 If specified, \fIlogfilename\fR specifies a base filename 
216 into which operational data from the running client will be 
217 logged. 
218
219 The default base name is specified at compile time.
220
221 The base name is used to generate actual log file names.
222 For example, if the name specified was "log", the debug file 
223 would be \fIlog.client\fR.
224
225 The log file generated is never removed by the client.   
226 .TP
227 \fB-h\fR
228 Print the usage message for the client. 
229 .TP
230 \fB-I IP-address\fR
231 \fIIP address\fR is the address of the server to connect to. 
232 It should be specified in standard "a.b.c.d" notation. 
233
234 Normally the client would attempt to locate a named 
235 SMB/CIFS server by looking it up via the NetBIOS name resolution 
236 mechanism described above in the \fIname resolve order\fR 
237 parameter above. Using this parameter will force the client
238 to assume that the server is on the machine with the specified IP 
239 address and the NetBIOS name component of the resource being 
240 connected to will be ignored. 
241
242 There is no default for this parameter. If not supplied, 
243 it will be determined automatically by the client as described 
244 above. 
245 .TP
246 \fB-E\fR
247 This parameter causes the client to write messages 
248 to the standard error stream (stderr) rather than to the standard 
249 output stream. 
250
251 By default, the client writes messages to standard output 
252 - typically the user's tty. 
253 .TP
254 \fB-U username[%pass]\fR
255 Sets the SMB username or username and password. 
256 If %pass is not specified, The user will be prompted. The client 
257 will first check the \fBUSER\fR environment variable, then the 
258 \fBLOGNAME\fR variable and if either exists, the 
259 string is uppercased. Anything in these variables following a '%' 
260 sign will be treated as the password. If these environment 
261 variables are not found, the username GUEST 
262 is used. 
263
264 If the password is not included in these environment
265 variables (using the %pass syntax), \fBsmbclient\fR will look for 
266 a \fBPASSWD\fR environment variable from which 
267 to read the password. 
268
269 A third option is to use a credentials file which 
270 contains the plaintext of the domain name, username and password.  This 
271 option is mainly provided for scripts where the admin doesn't 
272 wish to pass the credentials on the command line or via environment 
273 variables. If this method is used, make certain that the permissions 
274 on the file restrict access from unwanted users.  See the 
275 \fI-A\fR for more details. 
276
277 Be cautious about including passwords in scripts or in 
278 the \fBPASSWD\fR environment variable. Also, on 
279 many systems the command line of a running process may be seen 
280 via the \fBps\fR command to be safe always allow 
281 \fBsmbclient\fR to prompt for a password and type 
282 it in directly. 
283 .TP
284 \fB-A filename\fR
285 This option allows 
286 you to specify a file from which to read the username, domain name, and 
287 password used in the connection.  The format of the file is 
288
289
290 .nf
291 username = <value> 
292 password = <value>
293 domain = <value>
294                 
295 .fi
296
297 If the domain parameter is missing the current workgroup name
298 is used instead. Make certain that the permissions on the file restrict 
299 access from unwanted users. 
300 .TP
301 \fB-L\fR
302 This option allows you to look at what services 
303 are available on a server. You use it as \fBsmbclient -L 
304 host\fR and a list should appear.  The \fI-I
305 \fR option may be useful if your NetBIOS names don't 
306 match your TCP/IP DNS host names or if you are trying to reach a 
307 host on another network. 
308 .TP
309 \fB-t terminal code\fR
310 This option tells \fBsmbclient\fR how to interpret 
311 filenames coming from the remote server. Usually Asian language 
312 multibyte UNIX implementations use different character sets than 
313 SMB/CIFS servers (\fBEUC\fR instead of \fB  SJIS\fR for example). Setting this parameter will let 
314 \fBsmbclient\fR convert between the UNIX filenames and 
315 the SMB filenames correctly. This option has not been seriously tested 
316 and may have some problems. 
317
318 The terminal codes include CWsjis, CWeuc, CWjis7, CWjis8,
319 CWjunet, CWhex, CWcap. This is not a complete list, check the Samba 
320 source code for the complete list. 
321 .TP
322 \fB-b buffersize\fR
323 This option changes the transmit/send buffer 
324 size when getting or putting a file from/to the server. The default 
325 is 65520 bytes. Setting this value smaller (to 1200 bytes) has been 
326 observed to speed up file transfers to and from a Win9x server. 
327 .TP
328 \fB-W WORKGROUP\fR
329 Override the default workgroup (domain) specified
330 in the workgroup parameter of the \fIsmb.conf\fR
331 file for this connection. This may be needed to connect to some
332 servers. 
333 .TP
334 \fB-T tar options\fR
335 smbclient may be used to create \fBtar(1)
336 \fR compatible backups of all the files on an SMB/CIFS
337 share. The secondary tar flags that can be given to this option 
338 are : 
339 .RS
340 .TP 0.2i
341 \(bu
342 \fIc\fR - Create a tar file on UNIX. 
343 Must be followed by the name of a tar file, tape device
344 or "-" for standard output. If using standard output you must 
345 turn the log level to its lowest value -d0 to avoid corrupting 
346 your tar file. This flag is mutually exclusive with the 
347 \fIx\fR flag. 
348 .TP 0.2i
349 \(bu
350 \fIx\fR - Extract (restore) a local 
351 tar file back to a share. Unless the -D option is given, the tar 
352 files will be restored from the top level of the share. Must be 
353 followed by the name of the tar file, device or "-" for standard 
354 input. Mutually exclusive with the \fIc\fR flag. 
355 Restored files have their creation times (mtime) set to the
356 date saved in the tar file. Directories currently do not get 
357 their creation dates restored properly. 
358 .TP 0.2i
359 \(bu
360 \fII\fR - Include files and directories. 
361 Is the default behavior when filenames are specified above. Causes 
362 tar files to be included in an extract or create (and therefore 
363 everything else to be excluded). See example below.  Filename globbing 
364 works  in one of two ways.  See r below. 
365 .TP 0.2i
366 \(bu
367 \fIX\fR - Exclude files and directories. 
368 Causes tar files to be excluded from an extract or create. See 
369 example below.  Filename globbing works in one of two ways now. 
370 See \fIr\fR below. 
371 .TP 0.2i
372 \(bu
373 \fIb\fR - Blocksize. Must be followed 
374 by a valid (greater than zero) blocksize.  Causes tar file to be 
375 written out in blocksize*TBLOCK (usually 512 byte) blocks. 
376 .TP 0.2i
377 \(bu
378 \fIg\fR - Incremental. Only back up 
379 files that have the archive bit set. Useful only with the 
380 \fIc\fR flag. 
381 .TP 0.2i
382 \(bu
383 \fIq\fR - Quiet. Keeps tar from printing 
384 diagnostics as it works.  This is the same as tarmode quiet. 
385 .TP 0.2i
386 \(bu
387 \fIr\fR - Regular expression include
388 or exclude.  Uses regular  expression matching for 
389 excluding or excluding files if  compiled with HAVE_REGEX_H. 
390 However this mode can be very slow. If  not compiled with 
391 HAVE_REGEX_H, does a limited wildcard match on '*' and  '?'. 
392 .TP 0.2i
393 \(bu
394 \fIN\fR - Newer than. Must be followed 
395 by the name of a file whose date is compared against files found 
396 on the share during a create. Only files newer than the file 
397 specified are backed up to the tar file. Useful only with the 
398 \fIc\fR flag. 
399 .TP 0.2i
400 \(bu
401 \fIa\fR - Set archive bit. Causes the 
402 archive bit to be reset when a file is backed up. Useful with the 
403 \fIg\fR and \fIc\fR flags. 
404 .RE
405
406 \fBTar Long File Names\fR
407
408 \fBsmbclient\fR's tar option now supports long 
409 file names both on backup and restore. However, the full path 
410 name of the file must be less than 1024 bytes.  Also, when
411 a tar archive is created, \fBsmbclient\fR's tar option places all 
412 files in the archive with relative names, not absolute names. 
413
414 \fBTar Filenames\fR
415
416 All file names can be given as DOS path names (with '\\' 
417 as the component separator) or as UNIX path names (with '/' as 
418 the component separator). 
419
420 \fBExamples\fR
421
422 Restore from tar file \fIbackup.tar\fR into myshare on mypc 
423 (no password on share). 
424
425 \fBsmbclient //mypc/yshare "" -N -Tx backup.tar
426 \fR
427
428 Restore everything except \fIusers/docs\fR
429
430 \fBsmbclient //mypc/myshare "" -N -TXx backup.tar 
431 users/docs\fR
432
433 Create a tar file of the files beneath \fI  users/docs\fR. 
434
435 \fBsmbclient //mypc/myshare "" -N -Tc
436 backup.tar users/docs \fR
437
438 Create the same tar file as above, but now use 
439 a DOS path name. 
440
441 \fBsmbclient //mypc/myshare "" -N -tc backup.tar 
442 users\\edocs \fR
443
444 Create a tar file of all the files and directories in 
445 the share. 
446
447 \fBsmbclient //mypc/myshare "" -N -Tc backup.tar *
448 \fR
449 .TP
450 \fB-D initial directory\fR
451 Change to initial directory before starting. Probably 
452 only of any use with the tar -T option. 
453 .TP
454 \fB-c command string\fR
455 command string is a semicolon-separated list of 
456 commands to be executed instead of prompting from stdin. \fI  -N\fR is implied by \fI-c\fR.
457
458 This is particularly useful in scripts and for printing stdin 
459 to the server, e.g. \fB-c 'print -'\fR. 
460 .SH "OPERATIONS"
461 .PP
462 Once the client is running, the user is presented with 
463 a prompt : 
464 .PP
465 smb:\\> 
466 .PP
467 The backslash ("\\") indicates the current working directory 
468 on the server, and will change if the current working directory 
469 is changed. 
470 .PP
471 The prompt indicates that the client is ready and waiting to 
472 carry out a user command. Each command is a single word, optionally 
473 followed by parameters specific to that command. Command and parameters 
474 are space-delimited unless these notes specifically
475 state otherwise. All commands are case-insensitive.  Parameters to 
476 commands may or may not be case sensitive, depending on the command. 
477 .PP
478 You can specify file names which have spaces in them by quoting 
479 the name with double quotes, for example "a long file name". 
480 .PP
481 Parameters shown in square brackets (e.g., "[parameter]") are 
482 optional.  If not given, the command will use suitable defaults. Parameters 
483 shown in angle brackets (e.g., "<parameter>") are required.
484 .PP
485 Note that all commands operating on the server are actually 
486 performed by issuing a request to the server. Thus the behavior may 
487 vary from server to server, depending on how the server was implemented. 
488 .PP
489 The commands available are given here in alphabetical order. 
490 .TP
491 \fB? [command]\fR
492 If \fIcommand\fR is specified, the ? command will display 
493 a brief informative message about the specified command.  If no 
494 command is specified, a list of available commands will
495 be displayed. 
496 .TP
497 \fB! [shell command]\fR
498 If \fIshell command\fR is specified, the !  
499 command will execute a shell locally and run the specified shell 
500 command. If no command is specified, a local shell will be run. 
501 .TP
502 \fBaltname file\fR
503 The client will request that the server return
504 the "alternate" name (the 8.3 name) for a file or directory.
505 .TP
506 \fBcancel jobid0 [jobid1] ... [jobidN]\fR
507 The client will request that the server cancel
508 the printjobs identified by the given numeric print job ids.
509 .TP
510 \fBchmod file mode in octal\fR
511 This command depends on the server supporting the CIFS
512 UNIX extensions and will fail if the server does not. The client requests that the server
513 change the UNIX permissions to the given octal mode, in standard UNIX format.
514 .TP
515 \fBchown file uid gid\fR
516 This command depends on the server supporting the CIFS
517 UNIX extensions and will fail if the server does not. The client requests that the server
518 change the UNIX user and group ownership to the given decimal values. Note there is
519 currently no way to remotely look up the UNIX uid and gid values for a given name.
520 This may be addressed in future versions of the CIFS UNIX extensions.
521 .TP
522 \fBcd [directory name]\fR
523 If "directory name" is specified, the current 
524 working directory on the server will be changed to the directory 
525 specified. This operation will fail if for any reason the specified 
526 directory is inaccessible. 
527
528 If no directory name is specified, the current working 
529 directory on the server will be reported. 
530 .TP
531 \fBdel <mask>\fR
532 The client will request that the server attempt 
533 to delete all files matching \fImask\fR from the current working 
534 directory on the server. 
535 .TP
536 \fBdir <mask>\fR
537 A list of the files matching \fImask\fR in the current 
538 working directory on the server will be retrieved from the server 
539 and displayed. 
540 .TP
541 \fBexit\fR
542 Terminate the connection with the server and exit 
543 from the program. 
544 .TP
545 \fBget <remote file name> [local file name]\fR
546 Copy the file called \fIremote file name\fR from 
547 the server to the machine running the client. If specified, name 
548 the local copy \fIlocal file name\fR.  Note that all transfers in 
549 \fBsmbclient\fR are binary. See also the 
550 lowercase command. 
551 .TP
552 \fBhelp [command]\fR
553 See the ? command above. 
554 .TP
555 \fBlcd [directory name]\fR
556 If \fIdirectory name\fR is specified, the current 
557 working directory on the local machine will be changed to 
558 the directory specified. This operation will fail if for any 
559 reason the specified directory is inaccessible. 
560
561 If no directory name is specified, the name of the 
562 current working directory on the local machine will be reported. 
563 .TP
564 \fBlink source destination\fR
565 This command depends on the server supporting the CIFS
566 UNIX extensions and will fail if the server does not. The client requests that the server
567 create a hard link between the source and destination files. The source file
568 must not exist.
569 .TP
570 \fBlowercase\fR
571 Toggle lowercasing of filenames for the get and 
572 mget commands. 
573
574 When lowercasing is toggled ON, local filenames are converted 
575 to lowercase when using the get and mget commands. This is
576 often useful when copying (say) MSDOS files from a server, because 
577 lowercase filenames are the norm on UNIX systems. 
578 .TP
579 \fBls <mask>\fR
580 See the dir command above. 
581 .TP
582 \fBmask <mask>\fR
583 This command allows the user to set up a mask 
584 which will be used during recursive operation of the mget and 
585 mput commands. 
586
587 The masks specified to the mget and mput commands act as 
588 filters for directories rather than files when recursion is 
589 toggled ON. 
590
591 The mask specified with the mask command is necessary 
592 to filter files within those directories. For example, if the
593 mask specified in an mget command is "source*" and the mask 
594 specified with the mask command is "*.c" and recursion is 
595 toggled ON, the mget command will retrieve all files matching 
596 "*.c" in all directories below and including all directories 
597 matching "source*" in the current working directory. 
598
599 Note that the value for mask defaults to blank (equivalent 
600 to "*") and remains so until the mask command is used to change it. 
601 It retains the most recently specified value indefinitely. To 
602 avoid unexpected results it would be wise to change the value of 
603 mask back to "*" after using the mget or mput commands. 
604 .TP
605 \fBmd <directory name>\fR
606 See the mkdir command. 
607 .TP
608 \fBmget <mask>\fR
609 Copy all files matching \fImask\fR from the server to 
610 the machine running the client. 
611
612 Note that \fImask\fR is interpreted differently during recursive 
613 operation and non-recursive operation - refer to the recurse and 
614 mask commands for more information. Note that all transfers in 
615 \fBsmbclient\fR are binary. See also the lowercase command. 
616 .TP
617 \fBmkdir <directory name>\fR
618 Create a new directory on the server (user access 
619 privileges permitting) with the specified name. 
620 .TP
621 \fBmput <mask>\fR
622 Copy all files matching \fImask\fR in the current working 
623 directory on the local machine to the current working directory on 
624 the server. 
625
626 Note that \fImask\fR is interpreted differently during recursive 
627 operation and non-recursive operation - refer to the recurse and mask 
628 commands for more information. Note that all transfers in \fBsmbclient\fR 
629 are binary. 
630 .TP
631 \fBprint <file name>\fR
632 Print the specified file from the local machine 
633 through a printable service on the server. 
634
635 See also the printmode command.
636 .TP
637 \fBprintmode <graphics or text>\fR
638 Set the print mode to suit either binary data 
639 (such as graphical information) or text. Subsequent print
640 commands will use the currently set print mode. 
641 .TP
642 \fBprompt\fR
643 Toggle prompting for filenames during operation 
644 of the mget and mput commands. 
645
646 When toggled ON, the user will be prompted to confirm 
647 the transfer of each file during these commands. When toggled 
648 OFF, all specified files will be transferred without prompting. 
649 .TP
650 \fBput <local file name> [remote file name]\fR
651 Copy the file called \fIlocal file name\fR from the 
652 machine running the client to the server. If specified,
653 name the remote copy \fIremote file name\fR. Note that all transfers 
654 in \fBsmbclient\fR are binary. See also the lowercase command. 
655 .TP
656 \fBqueue\fR
657 Displays the print queue, showing the job id, 
658 name, size and current status. 
659 .TP
660 \fBquit\fR
661 See the exit command. 
662 .TP
663 \fBrd <directory name>\fR
664 See the rmdir command. 
665 .TP
666 \fBrecurse\fR
667 Toggle directory recursion for the commands mget 
668 and mput. 
669
670 When toggled ON, these commands will process all directories 
671 in the source directory (i.e., the directory they are copying
672 from ) and will recurse into any that match the mask specified 
673 to the command. Only files that match the mask specified using 
674 the mask command will be retrieved. See also the mask command. 
675
676 When recursion is toggled OFF, only files from the current 
677 working directory on the source machine that match the mask specified 
678 to the mget or mput commands will be copied, and any mask specified 
679 using the mask command will be ignored. 
680 .TP
681 \fBrm <mask>\fR
682 Remove all files matching \fImask\fR from the current 
683 working directory on the server. 
684 .TP
685 \fBrmdir <directory name>\fR
686 Remove the specified directory (user access 
687 privileges permitting) from the server. 
688 .TP
689 \fBsetmode <filename> <perm=[+|\\-]rsha>\fR
690 A version of the DOS attrib command to set 
691 file permissions. For example: 
692
693 \fBsetmode myfile +r \fR
694
695 would make myfile read only. 
696 .TP
697 \fBsymlink source destination\fR
698 This command depends on the server supporting the CIFS
699 UNIX extensions and will fail if the server does not. The client requests that the server
700 create a symbolic hard link between the source and destination files. The source file
701 must not exist. Note that the server will not create a link to any path that lies 
702 outside the currently connected share. This is enforced by the Samba server.
703 .TP
704 \fBtar <c|x>[IXbgNa]\fR
705 Performs a tar operation - see the \fI-T
706 \fR command line option above. Behavior may be affected 
707 by the tarmode command (see below). Using g (incremental) and N 
708 (newer) will affect tarmode settings. Note that using the "-" option 
709 with tar x may not work - use the command line option instead. 
710 .TP
711 \fBblocksize <blocksize>\fR
712 Blocksize. Must be followed by a valid (greater 
713 than zero) blocksize. Causes tar file to be written out in 
714 \fIblocksize\fR*TBLOCK (usually 512 byte) blocks. 
715 .TP
716 \fBtarmode <full|inc|reset|noreset>\fR
717 Changes tar's behavior with regard to archive 
718 bits. In full mode, tar will back up everything regardless of the 
719 archive bit setting (this is the default mode). In incremental mode, 
720 tar will only back up files with the archive bit set. In reset mode, 
721 tar will reset the archive bit on all files it backs up (implies 
722 read/write share). 
723 .SH "NOTES"
724 .PP
725 Some servers are fussy about the case of supplied usernames, 
726 passwords, share names (AKA service names) and machine names. 
727 If you fail to connect try giving all parameters in uppercase. 
728 .PP
729 It is often necessary to use the -n option when connecting 
730 to some types of servers. For example OS/2 LanManager insists 
731 on a valid NetBIOS name being used, so you need to supply a valid 
732 name that would be known to the server.
733 .PP
734 smbclient supports long file names where the server 
735 supports the LANMAN2 protocol or above. 
736 .SH "ENVIRONMENT VARIABLES"
737 .PP
738 The variable \fBUSER\fR may contain the 
739 username of the person  using the client. This information is 
740 used only if the protocol  level is high enough to support 
741 session-level passwords.
742 .PP
743 The variable \fBPASSWD\fR may contain 
744 the password of the person using the client.  This information is 
745 used only if the protocol level is high enough to support 
746 session-level passwords. 
747 .PP
748 The variable \fBLIBSMB_PROG\fR may contain 
749 the path, executed with system(), which the client should connect 
750 to instead of connecting to a server.  This functionality is primarily
751 intended as a development aid, and works best when using a LMHOSTS 
752 file
753 .SH "INSTALLATION"
754 .PP
755 The location of the client program is a matter for 
756 individual system administrators. The following are thus
757 suggestions only. 
758 .PP
759 It is recommended that the smbclient software be installed
760 in the \fI/usr/local/samba/bin/\fR or \fI /usr/samba/bin/\fR directory, this directory readable 
761 by all, writeable only by root. The client program itself should 
762 be executable by all. The client should \fBNOT\fR be 
763 setuid or setgid! 
764 .PP
765 The client log files should be put in a directory readable 
766 and writeable only by the user. 
767 .PP
768 To test the client, you will need to know the name of a 
769 running SMB/CIFS server. It is possible to run \fBsmbd(8)
770 \fR as an ordinary user - running that server as a daemon 
771 on a user-accessible port (typically any port number over 1024)
772 would provide a suitable test server. 
773 .SH "DIAGNOSTICS"
774 .PP
775 Most diagnostics issued by the client are logged in a 
776 specified log file. The log file name is specified at compile time, 
777 but may be overridden on the command line. 
778 .PP
779 The number and nature of diagnostics available depends 
780 on the debug level used by the client. If you have problems, 
781 set the debug level to 3 and peruse the log files. 
782 .SH "VERSION"
783 .PP
784 This man page is correct for version 2.2 of 
785 the Samba suite.
786 .SH "AUTHOR"
787 .PP
788 The original Samba software and related utilities 
789 were created by Andrew Tridgell. Samba is now developed
790 by the Samba Team as an Open Source project similar 
791 to the way the Linux kernel is developed.
792 .PP
793 The original Samba man pages were written by Karl Auer. 
794 The man page sources were converted to YODL format (another 
795 excellent piece of Open Source software, available at
796 ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0 
797 release by Jeremy Allison.  The conversion to DocBook for 
798 Samba 2.2 was done by Gerald Carter