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