1d2b2ed38be788fd4dfd30b3baa3645d4f076d78
[samba.git] / docs / yodldocs / smbclient.1.yo
1 mailto(samba-bugs@samba.anu.edu.au) 
2
3 manpage(smbclient)(1)(23 Oct 1998)(Samba)(SAMBA)
4
5 label(NAME)
6 manpagename(smbclient)(ftp-like client to access SMB/CIFS resources on servers)
7
8 label(SYNOPSIS)
9 manpagesynopsis()
10
11 bf(smbclient) link(servicename)(servicename) [link(password)(password)] [link(-s smb.conf)(minuss)] [link(-B IP addr)(minusB)] [link(-O socket options)(minusO)][link(-R name resolve order)(nameresolveorder)] [link(-M NetBIOS name)(minusM)] [link(-i scope)(minusi)] [link(-N)(minusN)] [link(-n NetBIOS name)(minusn)] [link(-d debuglevel)(minusd)] [link(-P)(minusP)] [link(-p port)(minusp)] [link(-l log basename)(minusl)] [link(-h)(minush)] [link(-I dest IP)(minusI)] [link(-E)(minusE)] [link(-U username)(minusU)] [link(-L NetBIOS name)(minusL)] [link(-t terminal code)(minust)] [link(-m max protocol)(minusm)] [link(-W workgroup)(minusW)] [link(-T<c|x>IXFqgbNan)(minusT)] [link(-D directory)(minusD)] [link(-c command string)(minusc)]
12
13 label(DESCRIPTION)
14 manpagedescription()
15
16 This program is part of the bf(Samba) suite.
17
18 bf(smbclient) is a client that can 'talk' to an SMB/CIFS server. It
19 offers an interface similar to that of the ftp program (see bf(ftp
20 (1))).  Operations include things like getting files from the server
21 to the local machine, putting files from the local machine to the
22 server, retrieving directory information from the server and so on.
23
24 label(OPTIONS)
25 manpageoptions()
26
27 startdit()
28
29 label(servicename)
30 dit(bf(servicename)) servicename is the name of the service you want
31 to use on the server. A service name takes the form
32 tt(//server/service) where em(server) is the NetBIOS name of the SMB/CIFS
33 server offering the desired service and em(service) is the name
34 of the service offered. Thus to connect to the service em(printer) on
35 the SMB/CIFS server em(smbserver), you would use the servicename
36
37 tt(//smbserver/printer)
38
39 Note that the server name required is NOT necessarily the IP (DNS)
40 host name of the server ! The name required is a NetBIOS server name,
41 which may or may not be the same as the IP hostname of the machine
42 running the server.
43
44 The server name is looked up according to either the
45 link(bf(-R))(nameresolveorder) parameter to bf(smbclient) or using the
46 url(bf(name resolve order))(smb.conf.5.html#nameresolveorder)
47 parameter in the smb.conf file, allowing an administrator to change
48 the order and methods by which server names are looked up.
49
50 label(password)
51 dit(bf(password)) password is the password required to access the
52 specified service on the specified server. If this parameter is
53 supplied, the link(bf(-N))(minusN) option (suppress password prompt) is assumed.
54
55 There is no default password. If no password is supplied on the
56 command line (either by using this parameter or adding a password to
57 the link(bf(-U))(minusU) option (see below)) and the link(bf(-N))(minusN) option is not specified,
58 the client will prompt for a password, even if the desired service
59 does not require one. (If no password is required, simply press ENTER
60 to provide a null password.)
61
62 Note: Some servers (including OS/2 and Windows for Workgroups) insist
63 on an uppercase password. Lowercase or mixed case passwords may be
64 rejected by these servers.
65
66 Be cautious about including passwords in scripts.
67
68 label(minuss)
69 dit(bf(-s smb.conf)) This parameter specifies the pathname to the
70 Samba configuration file, smb.conf. This file controls all aspects of
71 the Samba setup on the machine and smbclient also needs to read this
72 file.
73
74 label(minusB)
75 dit(bf(-B IP addr)) The IP address to use when sending a broadcast packet.
76
77 label(minusO)
78 dit(bf(-O socket options)) TCP socket options to set on the client
79 socket. See the url(socket options)(smb.conf.5.html#socketoptions)
80 parameter in the url(bf(smb.conf (5)))(smb.conf.5.html) manpage for
81 the list of valid options.
82
83 label(nameresolveorder)
84 dit(bf(-R name resolve order)) This option allows the user of
85 smbclient to determine what name resolution services to use when
86 looking up the NetBIOS name of the host being connected to.
87
88 The options are :"lmhosts", "host", "wins" and "bcast". They cause
89 names to be resolved as follows :
90
91 startit()
92
93 it() bf(lmhosts) : Lookup an IP address in the Samba lmhosts file.
94
95 it() bf(host) : Do a standard host name to IP address resolution,
96 using the system /etc/hosts, NIS, or DNS lookups. This method of name
97 resolution is operating system depended for instance on IRIX or
98 Solaris this may be controlled by the em(/etc/nsswitch.conf) file).  
99
100 it() bf(wins) : Query a name with the IP address listed in the url(bf(wins
101 server))(smb.conf.5.html#winsserver) parameter in the smb.conf file. If 
102 no WINS server has been specified this method will be ignored.
103
104 it() bf(bcast) : Do a broadcast on each of the known local interfaces
105 listed in the url(bf(interfaces))(smb.conf.5.html#interfaces) parameter
106 in the smb.conf file. This is the least reliable of the name resolution
107 methods as it depends on the target host being on a locally connected
108 subnet. To specify a particular broadcast address the link(bf(-B))(minusB) option 
109 may be used.
110
111 endit()
112
113 If this parameter is not set then the name resolver order defined
114 in the url(bf(smb.conf))(smb.conf.5.html) file parameter 
115 url((bf(name resolve order)))(smb.conf.5.html#nameresolveorder)
116 will be used.
117
118 The default order is lmhosts, host, wins, bcast and without this
119 parameter or any entry in the url(bf("name resolve
120 order"))(smb.conf.5.html#nameresolveorder) parameter of the
121 url(bf(smb.conf))(smb.conf.5.html) file the name resolution methods
122 will be attempted in this order.
123
124 label(minusM)
125 dit(bf(-M NetBIOS name)) This options allows you to send messages,
126 using the "WinPopup" protocol, to another computer. Once a connection
127 is established you then type your message, pressing ^D (control-D) to
128 end.
129
130 If the receiving computer is running WinPopup the user will receive
131 the message and probably a beep. If they are not running WinPopup the
132 message will be lost, and no error message will occur.
133
134 The message is also automatically truncated if the message is over
135 1600 bytes, as this is the limit of the protocol.
136
137 One useful trick is to cat the message through bf(smbclient).
138 For example:
139
140 tt(cat mymessage.txt | smbclient -M FRED)
141
142 will send the message in the file em(mymessage.txt) to the machine FRED.
143
144 You may also find the link(bf(-U))(minusU) and link(bf(-I))(minusI) options useful, as they allow
145 you to control the FROM and TO parts of the message.
146
147 See the url(bf(message command))(smb.conf.5.html#messagecommand)
148 parameter in the bf(smb.conf (5)) for a description of how to handle
149 incoming WinPopup messages in Samba.
150
151 Note: Copy WinPopup into the startup group on your WfWg PCs if you
152 want them to always be able to receive messages.
153
154 label(minusi)
155 dit(bf(-i scope)) This specifies a NetBIOS scope that smbclient will use
156 to communicate with when generating NetBIOS names. For details on the
157 use of NetBIOS scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes
158 are em(very) rarely used, only set this parameter if you are the
159 system administrator in charge of all the NetBIOS systems you
160 communicate with.
161
162 label(minusN)
163 dit(bf(-N)) If specified, this parameter suppresses the normal
164 password prompt from the client to the user. This is useful when
165 accessing a service that does not require a password.
166
167 Unless a password is specified on the command line or this parameter
168 is specified, the client will request a password.
169
170 label(minusn)
171 dit(bf(-n NetBIOS name)) By default, the client will use the local
172 machine's hostname (in uppercase) as its NetBIOS name. This parameter
173 allows you to override the host name and use whatever NetBIOS name you
174 wish.
175
176 label(minusd)
177 dit(bf(-d debuglevel)) debuglevel is an integer from 0 to 10, or the
178 letter 'A'.
179
180 The default value if this parameter is not specified is zero.
181
182 The higher this value, the more detail will be logged to the log files
183 about the activities of the client. At level 0, only critical errors
184 and serious warnings will be logged. Level 1 is a reasonable level for
185 day to day running - it generates a small amount of information about
186 operations carried out.
187
188 Levels above 1 will generate considerable amounts of log data, and
189 should only be used when investigating a problem. Levels above 3 are
190 designed for use only by developers and generate HUGE amounts of log
191 data, most of which is extremely cryptic. If debuglevel is set to the
192 letter 'A', then em(all) debug messages will be printed. This setting
193 is for developers only (and people who em(really) want to know how the
194 code works internally).
195
196 label(minusP)
197 dit(bf(-P)) If this option is specified, the service requested will be
198 connected to as a printer service rather than as a normal filespace
199 service. Operations such as put and get will not be applicable for
200 such a connection.
201
202 By default, services will be connected to as NON-printer services.
203
204 label(minusp)
205 dit(bf(-p port)) This number is the TCP port number that will be used
206 when making connections to the server. The standard (well-known) TCP
207 port number for an SMB/CIFS server is 139, which is the default.
208
209 label(minusl)
210 dit(bf(-l logfilename)) If specified, logfilename specifies a base
211 filename into which operational data from the running client will be
212 logged.
213
214 The default base name is specified at compile time.
215
216 The base name is used to generate actual log file names. For example,
217 if the name specified was "log", the debug file would be
218 tt(log.client).
219
220 The log file generated is never removed by the client.
221
222 label(minush)
223 dit(bf(-h)) Print the usage message for the client.
224
225 label(minusI)
226 dit(bf(-I IP address)) IP address is the address of the server to
227 connect to. It should be specified in standard "a.b.c.d" notation.
228
229 Normally the client would attempt to locate a named SMB/CIFS server by
230 looking it up via the NetBIOS name resolution mechanism described
231 above in the link(bf(name resolve order))(nameresolveorder) parameter
232 above. Using this parameter will force the client to assume that the
233 server is on the machine with the specified IP address and the NetBIOS
234 name component of the resource being connected to will be ignored.
235
236 There is no default for this parameter. If not supplied, it will be
237 determined automatically by the client as described above.
238
239 label(minusE)
240 dit(bf(-E)) This parameter causes the client to write messages to the
241 standard error stream (stderr) rather than to the standard output
242 stream.
243
244 By default, the client writes messages to standard output - typically
245 the user's tty.
246
247 label(minusU)
248 dit(bf(-U username)) This specifies the user name that will be used by
249 the client to make a connection, assuming your server is not a downlevel
250 server that is running a protocol level that uses passwords on shares,
251 not on usernames.
252
253 Some servers are fussy about the case of this name, and some insist
254 that it must be a valid NetBIOS name.
255
256 If no username is supplied, it will default to an uppercase version of
257 the environment variable tt(USER) or tt(LOGNAME) in that order.  If no
258 username is supplied and neither environment variable exists the
259 username "GUEST" will be used.
260
261 If the tt(USER) environment variable containts a '%' character,
262 everything after that will be treated as a password. This allows you
263 to set the environment variable to be tt(USER=username%password) so
264 that a password is not passed on the command line (where it may be
265 seen by the ps command).
266
267 If the service you are connecting to requires a password, it can be
268 supplied using the link(bf(-U))(minusU) option, by appending a percent symbol ("%")
269 then the password to username.  For example, to attach to a service as
270 user tt("fred") with password tt("secret"), you would specify. nl()
271
272 tt(-U fred%secret) nl()
273
274 on the command line. Note that there are no spaces around the percent
275 symbol.
276
277 If you specify the password as part of username then the link(bf(-N))(minusN) option
278 (suppress password prompt) is assumed.
279
280 If you specify the password as a parameter em(AND) as part of username
281 then the password as part of username will take precedence. Putting
282 nothing before or nothing after the percent symbol will cause an empty
283 username or an empty password to be used, respectively.
284
285 The password may also be specified by setting up an environment
286 variable called tt(PASSWORD) that contains the users password. Note
287 that this may be very insecure on some systems but on others allows
288 users to script smbclient commands without having a password appear in
289 the command line of a process listing.
290
291 Note: Some servers (including OS/2 and Windows for Workgroups) insist
292 on an uppercase password. Lowercase or mixed case passwords may be
293 rejected by these servers.
294
295 Be cautious about including passwords in scripts or in the
296 tt(PASSWORD) environment variable. Also, on many systems the command
297 line of a running process may be seen via the tt(ps) command to be
298 safe always allow smbclient to prompt for a password and type it in
299 directly.
300
301 label(minusL)
302 dit(bf(-L)) This option allows you to look at what services are
303 available on a server. You use it as tt("smbclient -L host") and a
304 list should appear.  The link(bf(-I))(minusI) option may be useful if your NetBIOS
305 names don't match your tcp/ip dns host names or if you are trying to
306 reach a host on another network.
307
308 label(minust)
309 dit(bf(-t terminal code)) This option tells smbclient how to interpret
310 filenames coming from the remote server. Usually Asian language
311 multibyte UNIX implementations use different character sets than
312 SMB/CIFS servers (em(EUC) instead of em(SJIS) for example). Setting
313 this parameter will let smbclient convert between the UNIX filenames
314 and the SMB filenames correctly. This option has not been seriously
315 tested and may have some problems.
316
317 The terminal codes include tt(sjis), tt(euc), tt(jis7), tt(jis8),
318 tt(junet), tt(hex), tt(cap). This is not a complete list, check the
319 Samba source code for the complete list.
320
321 label(minusm)
322 dit(bf(-m max protocol level)) Normally, smbclient will negotiate with
323 the server to use the most advanced version of the SMB/CIFS protocol
324 that the server supports. Occasionaly it may be desirable to tell
325 smbclient to negotiate a lower level of the protocol, hence this
326 parameter. Valid options for the em(max protocol level) are :
327
328 startit()
329
330 it() CORE
331
332 it() COREPLUS
333
334 it() LANMAN1
335
336 it() LANMAN2
337
338 it() NT1
339
340 endit()
341
342 label(minusW)
343 dit(bf(-W WORKGROUP)) Override the default workgroup specified in the
344 url(bf(workgroup))(smb.conf.5.html#workgroup) parameter of the
345 url(bf(smb.conf))(smb.conf.5.html) file for this connection. This may
346 be needed to connect to some servers.
347
348 label(minusT) dit(bf(-T tar options)) smbclient may be used to create
349 bf(tar (1)) compatible backups of all the files on an SMB/CIFS
350 share. The secondary tar flags that can be given to this option are :
351
352         startdit()
353
354         dit(bf(c)) Create a tar file on UNIX. Must be followed by the
355         name of a tar file, tape device or tt("-") for standard output. If
356         using standard output you must turn the log level to its lowest value
357     tt(-d0) to avoid corrupting your tar file. This flag is
358         mutually exclusive with the bf(x) flag.
359
360         dit(bf(x)) Extract (restore) a local tar file back to a
361         share. Unless the link(bf(-D))(minusD) option is given, the tar files will be
362         restored from the top level of the share. Must be followed by the name
363         of the tar file, device or tt("-") for standard input. Mutually exclusive
364         with the bf(c) flag. Restored files have theuir creation times (mtime)
365         set to the date saved in the tar file. Directories currently do not
366         get their creation dates restored properly.
367
368         dit(bf(I)) Include files and directories. Is the default
369         behaviour when filenames are specified above. Causes tar files to
370         be included in an extract or create (and therefore everything else to
371         be excluded). See example below.  Filename globbing does not work for
372         included files for extractions (yet).
373
374         dit(bf(X)) Exclude files and directories. Causes tar files to
375         be excluded from an extract or create. See example below.  Filename
376         globbing does not work for excluded files (yet).
377
378         dit(bf(b)) Blocksize. Must be followed by a valid (greater than
379         zero) blocksize.  Causes tar file to be written out in
380         blocksize*TBLOCK (usually 512 byte) blocks.
381
382         dit(bf(g)) Incremental. Only back up files that have the
383         archive bit set. Useful only with the bf(c) flag.
384
385         dit(bf(q)) Quiet. Keeps tar from printing diagnostics as it
386         works.  This is the same as tarmode quiet.
387
388         dit(bf(N)) Newer than. Must be followed by the name of a file
389         whose date is compared against files found on the share during a
390         create. Only files newer than the file specified are backed up to the
391         tar file. Useful only with the bf(c) flag.
392
393         dit(bf(a)) Set archive bit. Causes the archive bit to be reset
394         when a file is backed up. Useful with the bf(g) and bf(c) flags.
395
396         enddit()
397
398 em(Tar Long File Names)
399
400 smbclient's tar option now supports long file names both on backup and
401 restore. However, the full path name of the file must be less than
402 1024 bytes.  Also, when a tar archive is created, smbclient's tar
403 option places all files in the archive with relative names, not
404 absolute names.
405
406 em(Tar Filenames)
407
408 All file names can be given as DOS path names (with tt(\) as the
409 component separator) or as UNIX path names (with tt(/) as the
410 component separator).
411
412 em(Examples)
413
414 startit()
415
416 it() Restore from tar file backup.tar into myshare on mypc (no password on share).
417
418         tt(smbclient //mypc/myshare "" -N -Tx backup.tar)
419
420 it() Restore everything except users/docs
421
422         tt(smbclient //mypc/myshare "" -N -TXx backup.tar users/docs)
423
424 it() Create a tar file of the files beneath users/docs.
425
426         tt(smbclient //mypc/myshare "" -N -Tc backup.tar users/docs)
427
428 it() Create the same tar file as above, but now use a DOS path name.
429
430         tt(smbclient //mypc/myshare "" -N -tc backup.tar users\edocs)
431
432 it() Create a tar file of all the files and directories in the share.
433
434         tt(smbclient //mypc/myshare "" -N -Tc backup.tar *)
435
436 endit()
437
438 label(minusD)
439 dit(bf(-D initial directory)) Change to initial directory before
440 starting. Probably only of any use with the tar link(bf(-T))(minusT) option.
441
442 label(minusc)
443 dit(bf(-c command string)) command string is a semicolon separated
444 list of commands to be executed instead of prompting from stdin.
445 link(bf(-N))(minusN) is implied by bf(-c).
446
447 This is particularly useful in scripts and for printing stdin to the
448 server, e.g. tt(-c 'print -').
449
450 enddit()
451
452 label(OPERATIONS)
453 manpagesection(OPERATIONS)
454
455 Once the client is running, the user is presented with a prompt :
456
457 tt(smb:\>)
458
459 The backslash ("\") indicates the current working directory on the
460 server, and will change if the current working directory is changed.
461
462 The prompt indicates that the client is ready and waiting to carry out
463 a user command. Each command is a single word, optionally followed by
464 parameters specific to that command. Command and parameters are
465 space-delimited unless these notes specifically state otherwise. All
466 commands are case-insensitive.  Parameters to commands may or may not
467 be case sensitive, depending on the command.
468
469 You can specify file names which have spaces in them by quoting the
470 name with double quotes, for example "a long file name".
471
472 Parameters shown in square brackets (eg., "[parameter]") are
473 optional. If not given, the command will use suitable
474 defaults. Parameters shown in angle brackets (eg., "<parameter>") are
475 required.
476
477 Note that all commands operating on the server are actually performed
478 by issuing a request to the server. Thus the behaviour may vary from
479 server to server, depending on how the server was implemented.
480
481 The commands available are given here in alphabetical order.
482
483 startdit()
484
485 label(questionmark) dit(bf(? [command])) If "command" is specified,
486 the bf(?) command will display a brief informative message about the
487 specified command.  If no command is specified, a list of available
488 commands will be displayed.
489
490 label(exclaimationmark) dit(bf(! [shell command])) If "shell command"
491 is specified, the bf(!)  command will execute a shell locally and run
492 the specified shell command. If no command is specified, a local shell
493 will be run.
494
495 label(cd) dit(bf(cd [directory name])) If "directory name" is
496 specified, the current working directory on the server will be changed
497 to the directory specified. This operation will fail if for any reason
498 the specified directory is inaccessible.
499
500 If no directory name is specified, the current working directory on
501 the server will be reported.
502
503 label(del) dit(bf(del <mask>)) The client will request that the server
504 attempt to delete all files matching "mask" from the current working
505 directory on the server.
506
507 label(dir) dit(bf(dir <mask>)) A list of the files matching "mask" in
508 the current working directory on the server will be retrieved from the
509 server and displayed.
510
511 label(exit) dit(bf(exit)) Terminate the connection with the server and
512 exit from the program.
513
514 label(get) dit(bf(get <remote file name> [local file name])) Copy the
515 file called "remote file name" from the server to the machine running
516 the client. If specified, name the local copy "local file name".  Note
517 that all transfers in smbclient are binary. See also the
518 link(bf(lowercase))(lowercase) command.
519
520 label(help) dit(bf(help [command])) See the link(bf(?))(questionmark)
521 command above.
522
523 label(lcd) dit(bf(lcd [directory name])) If "directory name" is
524 specified, the current working directory on the local machine will
525 be changed to the directory specified. This operation will fail if for
526 any reason the specified directory is inaccessible.
527
528 If no directory name is specified, the name of the current working
529 directory on the local machine will be reported.
530
531 label(lowercase) dit(bf(lowercase)) Toggle lowercasing of filenames
532 for the link(bf(get))(get) and link(bf(mget))(mget) commands.
533
534 When lowercasing is toggled ON, local filenames are converted to
535 lowercase when using the link(bf(get))(get) and link(bf(mget))(mget)
536 commands. This is often useful when copying (say) MSDOS files from a
537 server, because lowercase filenames are the norm on UNIX systems.
538
539 label(ls) dit(bf(ls <mask>)) See the link(bf(dir))(dir) command above.
540
541 label(mask) dit(bf(mask <mask>)) This command allows the user to set
542 up a mask which will be used during recursive operation of the
543 link(bf(mget))(mget) and link(bf(mput))(mput) commands.
544
545 The masks specified to the link(bf(mget))(mget) and
546 link(bf(mput))(mput) commands act as filters for directories rather
547 than files when recursion is toggled ON.
548
549 The mask specified with the .B mask command is necessary to filter
550 files within those directories. For example, if the mask specified in
551 an link(bf(mget))(mget) command is "source*" and the mask specified
552 with the mask command is "*.c" and recursion is toggled ON, the
553 link(bf(mget))(mget) command will retrieve all files matching "*.c" in
554 all directories below and including all directories matching "source*"
555 in the current working directory.
556
557 Note that the value for mask defaults to blank (equivalent to "*") and
558 remains so until the mask command is used to change it. It retains the
559 most recently specified value indefinitely. To avoid unexpected
560 results it would be wise to change the value of .I mask back to "*"
561 after using the link(bf(mget))(mget) or link(bf(mput))(mput) commands.
562
563 label(md) dit(bf(md <directory name>)) See the link(bf(mkdir))(mkdir)
564 command.
565
566 label(mget) dit(bf(mget <mask>)) Copy all files matching mask from the
567 server to the machine running the client.
568
569 Note that mask is interpreted differently during recursive operation
570 and non-recursive operation - refer to the link(bf(recurse))(recurse)
571 and link(bf(mask))(mask) commands for more information. Note that all
572 transfers in .B smbclient are binary. See also the
573 link(bf(lowercase))(lowercase) command.
574
575 label(mkdir) dit(bf(mkdir <directory name>)) Create a new directory on
576 the server (user access privileges permitting) with the specified
577 name.
578
579 label(mput) dit(bf(mput <mask>)) Copy all files matching mask in
580 the current working directory on the local machine to the current
581 working directory on the server.
582
583 Note that mask is interpreted differently during recursive operation
584 and non-recursive operation - refer to the link(bf(recurse))(recurse)
585 and link(bf(mask))(mask) commands for more information. Note that all
586 transfers in .B smbclient are binary.
587
588 label(print) dit(bf(print <file name>)) Print the specified file
589 from the local machine through a printable service on the server.
590
591 See also the link(bf(printmode))(printmode) command.
592
593 label(printmode) dit(bf(printmode <graphics or text>)) Set the print
594 mode to suit either binary data (such as graphical information) or
595 text. Subsequent print commands will use the currently set print
596 mode.
597
598 label(prompt) dir(bf(prompt)) Toggle prompting for filenames during
599 operation of the link(bf(mget))(mget) and link(bf(mput))(mput)
600 commands.
601
602 When toggled ON, the user will be prompted to confirm the transfer of
603 each file during these commands. When toggled OFF, all specified files
604 will be transferred without prompting.
605
606 label(put) dit(bf(put <local file name> [remote file name])) Copy the
607 file called "local file name" from the machine running the client to
608 the server. If specified, name the remote copy "remote file name".
609 Note that all transfers in smbclient are binary. See also the
610 link(bf(lowercase))(lowercase) command.
611
612 label(queue) dir(bf(queue)) Displays the print queue, showing the job
613 id, name, size and current status.
614
615 label(quit) dit(bf(quit)) See the link(bf(exit))(exit) command.
616
617 label(rd) dir(bf(rd <directory name>)) See the link(bf(rmdir))(rmdir)
618 command.
619
620 label(recurse) dir(bf(recurse)) Toggle directory recursion for the
621 commands link(bf(mget))(mget) and link(bf(mput))(mput).
622
623 When toggled ON, these commands will process all directories in the
624 source directory (i.e., the directory they are copying .IR from ) and
625 will recurse into any that match the mask specified to the
626 command. Only files that match the mask specified using the
627 link(bf(mask))(mask) command will be retrieved. See also the
628 link(bf(mask))(mask) command.
629
630 When recursion is toggled OFF, only files from the current working
631 directory on the source machine that match the mask specified to the
632 link(bf(mget))(mget) or link(bf(mput))(mput) commands will be copied,
633 and any mask specified using the link(bf(mask))(mask) command will be
634 ignored.
635
636 label(rm) dir(bf(rm <mask>)) Remove all files matching mask from
637 the current working directory on the server.
638
639 label(rmdir) dit(bf(rmdir <directory name>)) Remove the specified
640 directory (user access privileges permitting) from the server.
641
642 label(tar) dit(bf(tar <c|x>[IXbgNa])) Performs a tar operation - see
643 the link(bf(-T))(minusT) command line option above. Behaviour may be
644 affected by the link(bf(tarmode))(tarmode) command (see below). Using
645 g (incremental) and N (newer) will affect tarmode settings. Note that
646 using the "-" option with tar x may not work - use the command line
647 option instead.
648
649 label(blocksize) dit(bf(blocksize <blocksize>)) Blocksize. Must be
650 followed by a valid (greater than zero) blocksize. Causes tar file to
651 be written out in blocksize*TBLOCK (usually 512 byte) blocks.
652
653 label(tarmode) dir(bf(tarmode <full|inc|reset|noreset>)) Changes tar's
654 behaviour with regard to archive bits. In full mode, tar will back up
655 everything regardless of the archive bit setting (this is the default
656 mode). In incremental mode, tar will only back up files with the
657 archive bit set. In reset mode, tar will reset the archive bit on all
658 files it backs up (implies read/write share).
659
660 label(setmode) dit(bf(setmode <filename> <perm=[+|\-]rsha>)) A version
661 of the DOS attrib command to set file permissions. For example:
662
663 tt(setmode myfile +r)
664
665 would make myfile read only.
666
667 enddit()
668
669 label(NOTES)
670 manpagesection(NOTES)
671
672 Some servers are fussy about the case of supplied usernames,
673 passwords, share names (aka service names) and machine names. If you
674 fail to connect try giving all parameters in uppercase.
675
676 It is often necessary to use the link(bf(-n))(minusn) option when connecting to some
677 types of servers. For example OS/2 LanManager insists on a valid
678 NetBIOS name being used, so you need to supply a valid name that would
679 be known to the server.
680
681 smbclient supports long file names where the server supports the
682 LANMAN2 protocol or above.
683
684 label(ENVIRONMENTVARIABLES)
685 manpagesection(ENVIRONMENT VARIABLES)
686
687 The variable bf(USER) may contain the username of the person using the
688 client.  This information is used only if the protocol level is high
689 enough to support session-level passwords.
690
691 The variable bf(PASSWORD) may contain the password of the person using
692 the client.  This information is used only if the protocol level is
693 high enough to support session-level passwords.
694
695 label(INSTALLATION)
696 manpagesection(INSTALLATION)
697
698 The location of the client program is a matter for individual system
699 administrators. The following are thus suggestions only.
700
701 It is recommended that the smbclient software be installed in the
702 /usr/local/samba/bin or /usr/samba/bin directory, this directory
703 readable by all, writeable only by root. The client program itself
704 should be executable by all. The client should em(NOT) be setuid or
705 setgid!
706
707 The client log files should be put in a directory readable and
708 writable only by the user.
709
710 To test the client, you will need to know the name of a running
711 SMB/CIFS server. It is possible to run url(bf(smbd (8)))(smbd.8.html)
712 an ordinary user - running that server as a daemon on a
713 user-accessible port (typically any port number over 1024) would
714 provide a suitable test server.
715
716 label(DIAGNOSTICS)
717 manpagesection(DIAGNOSTICS)
718
719 Most diagnostics issued by the client are logged in a specified log
720 file. The log file name is specified at compile time, but may be
721 overridden on the command line.
722
723 The number and nature of diagnostics available depends on the debug
724 level used by the client. If you have problems, set the debug level to
725 3 and peruse the log files.
726
727 label(VERSION)
728 manpagesection(VERSION)
729
730 This man page is correct for version 2.0 of the Samba suite.
731
732 label(AUTHOR)
733 manpageauthor()
734
735 The original Samba software and related utilities were created by
736 Andrew Tridgell email(samba-bugs@samba.anu.edu.au). Samba is now developed
737 by the Samba Team as an Open Source project similar to the way the
738 Linux kernel is developed.
739
740 The original Samba man pages were written by Karl Auer. The man page
741 sources were converted to YODL format (another excellent piece of Open
742 Source software) and updated for the Samba2.0 release by Jeremy
743 Allison, email(samba-bugs@samba.anu.edu.au).
744
745 See url(bf(samba (7)))(samba.7.html) to find out how to get a full
746 list of contributors and details on how to submit bug reports,
747 comments etc.