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