Added internal cross references for all man pages.
[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 Note that specifying this parameter here will override the url(bf(log
197 level))(smb.conf.5.html#loglevel) parameter in the url(bf(smb.conf
198 (5)))(smb.conf.5.html) file.
199
200 label(minusP)
201 dit(bf(-P)) If this option is specified, the service requested will be
202 connected to as a printer service rather than as a normal filespace
203 service. Operations such as put and get will not be applicable for
204 such a connection.
205
206 By default, services will be connected to as NON-printer services.
207
208 label(minusp)
209 dit(bf(-p port)) This number is the TCP port number that will be used
210 when making connections to the server. The standard (well-known) TCP
211 port number for an SMB/CIFS server is 139, which is the default.
212
213 label(minusl)
214 dit(bf(-l logfilename)) If specified, logfilename specifies a base
215 filename into which operational data from the running client will be
216 logged.
217
218 The default base name is specified at compile time.
219
220 The base name is used to generate actual log file names. For example,
221 if the name specified was "log", the debug file would be
222 tt(log.client).
223
224 The log file generated is never removed by the client.
225
226 label(minush)
227 dit(bf(-h)) Print the usage message for the client.
228
229 label(minusI)
230 dit(bf(-I IP address)) IP address is the address of the server to
231 connect to. It should be specified in standard "a.b.c.d" notation.
232
233 Normally the client would attempt to locate a named SMB/CIFS server by
234 looking it up via the NetBIOS name resolution mechanism described
235 above in the link(bf(name resolve order))(nameresolveorder) parameter
236 above. Using this parameter will force the client to assume that the
237 server is on the machine with the specified IP address and the NetBIOS
238 name component of the resource being connected to will be ignored.
239
240 There is no default for this parameter. If not supplied, it will be
241 determined automatically by the client as described above.
242
243 label(minusE)
244 dit(bf(-E)) This parameter causes the client to write messages to the
245 standard error stream (stderr) rather than to the standard output
246 stream.
247
248 By default, the client writes messages to standard output - typically
249 the user's tty.
250
251 label(minusU)
252 dit(bf(-U username)) This specifies the user name that will be used by
253 the client to make a connection, assuming your server is not a downlevel
254 server that is running a protocol level that uses passwords on shares,
255 not on usernames.
256
257 Some servers are fussy about the case of this name, and some insist
258 that it must be a valid NetBIOS name.
259
260 If no username is supplied, it will default to an uppercase version of
261 the environment variable tt(USER) or tt(LOGNAME) in that order.  If no
262 username is supplied and neither environment variable exists the
263 username "GUEST" will be used.
264
265 If the tt(USER) environment variable containts a '%' character,
266 everything after that will be treated as a password. This allows you
267 to set the environment variable to be tt(USER=username%password) so
268 that a password is not passed on the command line (where it may be
269 seen by the ps command).
270
271 If the service you are connecting to requires a password, it can be
272 supplied using the link(bf(-U))(minusU) option, by appending a percent symbol ("%")
273 then the password to username.  For example, to attach to a service as
274 user tt("fred") with password tt("secret"), you would specify. nl()
275
276 tt(-U fred%secret) nl()
277
278 on the command line. Note that there are no spaces around the percent
279 symbol.
280
281 If you specify the password as part of username then the link(bf(-N))(minusN) option
282 (suppress password prompt) is assumed.
283
284 If you specify the password as a parameter em(AND) as part of username
285 then the password as part of username will take precedence. Putting
286 nothing before or nothing after the percent symbol will cause an empty
287 username or an empty password to be used, respectively.
288
289 The password may also be specified by setting up an environment
290 variable called tt(PASSWORD) that contains the users password. Note
291 that this may be very insecure on some systems but on others allows
292 users to script smbclient commands without having a password appear in
293 the command line of a process listing.
294
295 Note: Some servers (including OS/2 and Windows for Workgroups) insist
296 on an uppercase password. Lowercase or mixed case passwords may be
297 rejected by these servers.
298
299 Be cautious about including passwords in scripts or in the
300 tt(PASSWORD) environment variable. Also, on many systems the command
301 line of a running process may be seen via the tt(ps) command to be
302 safe always allow smbclient to prompt for a password and type it in
303 directly.
304
305 label(minusL)
306 dit(bf(-L)) This option allows you to look at what services are
307 available on a server. You use it as tt("smbclient -L host") and a
308 list should appear.  The link(bf(-I))(minusI) option may be useful if your NetBIOS
309 names don't match your tcp/ip dns host names or if you are trying to
310 reach a host on another network.
311
312 label(minust)
313 dit(bf(-t terminal code)) This option tells smbclient how to interpret
314 filenames coming from the remote server. Usually Asian language
315 multibyte UNIX implementations use different character sets than
316 SMB/CIFS servers (em(EUC) instead of em(SJIS) for example). Setting
317 this parameter will let smbclient convert between the UNIX filenames
318 and the SMB filenames correctly. This option has not been seriously
319 tested and may have some problems.
320
321 The terminal codes include tt(sjis), tt(euc), tt(jis7), tt(jis8),
322 tt(junet), tt(hex), tt(cap). This is not a complete list, check the
323 Samba source code for the complete list.
324
325 label(minusm)
326 dit(bf(-m max protocol level)) Normally, smbclient will negotiate with
327 the server to use the most advanced version of the SMB/CIFS protocol
328 that the server supports. Occasionaly it may be desirable to tell
329 smbclient to negotiate a lower level of the protocol, hence this
330 parameter. Valid options for the em(max protocol level) are :
331
332 startit()
333
334 it() CORE
335
336 it() COREPLUS
337
338 it() LANMAN1
339
340 it() LANMAN2
341
342 it() NT1
343
344 endit()
345
346 label(minusW)
347 dit(bf(-W WORKGROUP)) Override the default workgroup specified in the
348 url(bf(workgroup))(smb.conf.5.html#workgroup) parameter of the
349 url(bf(smb.conf))(smb.conf.5.html) file for this connection. This may
350 be needed to connect to some servers.
351
352 label(minusT) dit(bf(-T tar options)) smbclient may be used to create
353 bf(tar (1)) compatible backups of all the files on an SMB/CIFS
354 share. The secondary tar flags that can be given to this option are :
355
356         startdit()
357
358         dit(bf(c)) Create a tar file on UNIX. Must be followed by the
359         name of a tar file, tape device or tt("-") for standard output. If
360         using standard output you must turn the log level to its lowest value
361     tt(-d0) to avoid corrupting your tar file. This flag is
362         mutually exclusive with the bf(x) flag.
363
364         dit(bf(x)) Extract (restore) a local tar file back to a
365         share. Unless the link(bf(-D))(minusD) option is given, the tar files will be
366         restored from the top level of the share. Must be followed by the name
367         of the tar file, device or tt("-") for standard input. Mutually exclusive
368         with the bf(c) flag. Restored files have theuir creation times (mtime)
369         set to the date saved in the tar file. Directories currently do not
370         get their creation dates restored properly.
371
372         dit(bf(I)) Include files and directories. Is the default
373         behaviour when filenames are specified above. Causes tar files to
374         be included in an extract or create (and therefore everything else to
375         be excluded). See example below.  Filename globbing does not work for
376         included files for extractions (yet).
377
378         dit(bf(X)) Exclude files and directories. Causes tar files to
379         be excluded from an extract or create. See example below.  Filename
380         globbing does not work for excluded files (yet).
381
382         dit(bf(b)) Blocksize. Must be followed by a valid (greater than
383         zero) blocksize.  Causes tar file to be written out in
384         blocksize*TBLOCK (usually 512 byte) blocks.
385
386         dit(bf(g)) Incremental. Only back up files that have the
387         archive bit set. Useful only with the bf(c) flag.
388
389         dit(bf(q)) Quiet. Keeps tar from printing diagnostics as it
390         works.  This is the same as tarmode quiet.
391
392         dit(bf(N)) Newer than. Must be followed by the name of a file
393         whose date is compared against files found on the share during a
394         create. Only files newer than the file specified are backed up to the
395         tar file. Useful only with the bf(c) flag.
396
397         dit(bf(a)) Set archive bit. Causes the archive bit to be reset
398         when a file is backed up. Useful with the bf(g) and bf(c) flags.
399
400         enddit()
401
402 em(Tar Long File Names)
403
404 smbclient's tar option now supports long file names both on backup and
405 restore. However, the full path name of the file must be less than
406 1024 bytes.  Also, when a tar archive is created, smbclient's tar
407 option places all files in the archive with relative names, not
408 absolute names.
409
410 em(Tar Filenames)
411
412 All file names can be given as DOS path names (with tt(\) as the
413 component separator) or as UNIX path names (with tt(/) as the
414 component separator).
415
416 em(Examples)
417
418 startit()
419
420 it() Restore from tar file backup.tar into myshare on mypc (no password on share).
421
422         tt(smbclient //mypc/myshare "" -N -Tx backup.tar)
423
424 it() Restore everything except users/docs
425
426         tt(smbclient //mypc/myshare "" -N -TXx backup.tar users/docs)
427
428 it() Create a tar file of the files beneath users/docs.
429
430         tt(smbclient //mypc/myshare "" -N -Tc backup.tar users/docs)
431
432 it() Create the same tar file as above, but now use a DOS path name.
433
434         tt(smbclient //mypc/myshare "" -N -tc backup.tar users\edocs)
435
436 it() Create a tar file of all the files and directories in the share.
437
438         tt(smbclient //mypc/myshare "" -N -Tc backup.tar *)
439
440 endit()
441
442 label(minusD)
443 dit(bf(-D initial directory)) Change to initial directory before
444 starting. Probably only of any use with the tar link(bf(-T))(minusT) option.
445
446 label(minusc)
447 dit(bf(-c command string)) command string is a semicolon separated
448 list of commands to be executed instead of prompting from stdin.
449 link(bf(-N))(minusN) is implied by bf(-c).
450
451 This is particularly useful in scripts and for printing stdin to the
452 server, e.g. tt(-c 'print -').
453
454 enddit()
455
456 label(OPERATIONS)
457 manpagesection(OPERATIONS)
458
459 Once the client is running, the user is presented with a prompt :
460
461 tt(smb:\>)
462
463 The backslash ("\") indicates the current working directory on the
464 server, and will change if the current working directory is changed.
465
466 The prompt indicates that the client is ready and waiting to carry out
467 a user command. Each command is a single word, optionally followed by
468 parameters specific to that command. Command and parameters are
469 space-delimited unless these notes specifically state otherwise. All
470 commands are case-insensitive.  Parameters to commands may or may not
471 be case sensitive, depending on the command.
472
473 You can specify file names which have spaces in them by quoting the
474 name with double quotes, for example "a long file name".
475
476 Parameters shown in square brackets (eg., "[parameter]") are
477 optional. If not given, the command will use suitable
478 defaults. Parameters shown in angle brackets (eg., "<parameter>") are
479 required.
480
481 Note that all commands operating on the server are actually performed
482 by issuing a request to the server. Thus the behaviour may vary from
483 server to server, depending on how the server was implemented.
484
485 The commands available are given here in alphabetical order.
486
487 startdit()
488
489 label(questionmark) dit(bf(? [command])) If "command" is specified,
490 the bf(?) command will display a brief informative message about the
491 specified command.  If no command is specified, a list of available
492 commands will be displayed.
493
494 label(exclaimationmark) dit(bf(! [shell command])) If "shell command"
495 is specified, the bf(!)  command will execute a shell locally and run
496 the specified shell command. If no command is specified, a local shell
497 will be run.
498
499 label(cd) dit(bf(cd [directory name])) If "directory name" is
500 specified, the current working directory on the server will be changed
501 to the directory specified. This operation will fail if for any reason
502 the specified directory is inaccessible.
503
504 If no directory name is specified, the current working directory on
505 the server will be reported.
506
507 label(del) dit(bf(del <mask>)) The client will request that the server
508 attempt to delete all files matching "mask" from the current working
509 directory on the server.
510
511 label(dir) dit(bf(dir <mask>)) A list of the files matching "mask" in
512 the current working directory on the server will be retrieved from the
513 server and displayed.
514
515 label(exit) dit(bf(exit)) Terminate the connection with the server and
516 exit from the program.
517
518 label(get) dit(bf(get <remote file name> [local file name])) Copy the
519 file called "remote file name" from the server to the machine running
520 the client. If specified, name the local copy "local file name".  Note
521 that all transfers in smbclient are binary. See also the
522 link(bf(lowercase))(lowercase) command.
523
524 label(help) dit(bf(help [command])) See the link(bf(?))(questionmark)
525 command above.
526
527 label(lcd) dit(bf(lcd [directory name])) If "directory name" is
528 specified, the current working directory on the local machine will
529 be changed to the directory specified. This operation will fail if for
530 any reason the specified directory is inaccessible.
531
532 If no directory name is specified, the name of the current working
533 directory on the local machine will be reported.
534
535 label(lowercase) dit(bf(lowercase)) Toggle lowercasing of filenames
536 for the link(bf(get))(get) and link(bf(mget))(mget) commands.
537
538 When lowercasing is toggled ON, local filenames are converted to
539 lowercase when using the link(bf(get))(get) and link(bf(mget))(mget)
540 commands. This is often useful when copying (say) MSDOS files from a
541 server, because lowercase filenames are the norm on UNIX systems.
542
543 label(ls) dit(bf(ls <mask>)) See the link(bf(dir))(dir) command above.
544
545 label(mask) dit(bf(mask <mask>)) This command allows the user to set
546 up a mask which will be used during recursive operation of the
547 link(bf(mget))(mget) and link(bf(mput))(mput) commands.
548
549 The masks specified to the link(bf(mget))(mget) and
550 link(bf(mput))(mput) commands act as filters for directories rather
551 than files when recursion is toggled ON.
552
553 The mask specified with the .B mask command is necessary to filter
554 files within those directories. For example, if the mask specified in
555 an link(bf(mget))(mget) command is "source*" and the mask specified
556 with the mask command is "*.c" and recursion is toggled ON, the
557 link(bf(mget))(mget) command will retrieve all files matching "*.c" in
558 all directories below and including all directories matching "source*"
559 in the current working directory.
560
561 Note that the value for mask defaults to blank (equivalent to "*") and
562 remains so until the mask command is used to change it. It retains the
563 most recently specified value indefinitely. To avoid unexpected
564 results it would be wise to change the value of .I mask back to "*"
565 after using the link(bf(mget))(mget) or link(bf(mput))(mput) commands.
566
567 label(md) dit(bf(md <directory name>)) See the link(bf(mkdir))(mkdir)
568 command.
569
570 label(mget) dit(bf(mget <mask>)) Copy all files matching mask from the
571 server to the machine running the client.
572
573 Note that mask is interpreted differently during recursive operation
574 and non-recursive operation - refer to the link(bf(recurse))(recurse)
575 and link(bf(mask))(mask) commands for more information. Note that all
576 transfers in .B smbclient are binary. See also the
577 link(bf(lowercase))(lowercase) command.
578
579 label(mkdir) dit(bf(mkdir <directory name>)) Create a new directory on
580 the server (user access privileges permitting) with the specified
581 name.
582
583 label(mput) dit(bf(mput <mask>)) Copy all files matching mask in
584 the current working directory on the local machine to the current
585 working directory on the server.
586
587 Note that mask is interpreted differently during recursive operation
588 and non-recursive operation - refer to the link(bf(recurse))(recurse)
589 and link(bf(mask))(mask) commands for more information. Note that all
590 transfers in .B smbclient are binary.
591
592 label(print) dit(bf(print <file name>)) Print the specified file
593 from the local machine through a printable service on the server.
594
595 See also the link(bf(printmode))(printmode) command.
596
597 label(printmode) dit(bf(printmode <graphics or text>)) Set the print
598 mode to suit either binary data (such as graphical information) or
599 text. Subsequent print commands will use the currently set print
600 mode.
601
602 label(prompt) dir(bf(prompt)) Toggle prompting for filenames during
603 operation of the link(bf(mget))(mget) and link(bf(mput))(mput)
604 commands.
605
606 When toggled ON, the user will be prompted to confirm the transfer of
607 each file during these commands. When toggled OFF, all specified files
608 will be transferred without prompting.
609
610 label(put) dit(bf(put <local file name> [remote file name])) Copy the
611 file called "local file name" from the machine running the client to
612 the server. If specified, name the remote copy "remote file name".
613 Note that all transfers in smbclient are binary. See also the
614 link(bf(lowercase))(lowercase) command.
615
616 label(queue) dir(bf(queue)) Displays the print queue, showing the job
617 id, name, size and current status.
618
619 label(quit) dit(bf(quit)) See the link(bf(exit))(exit) command.
620
621 label(rd) dir(bf(rd <directory name>)) See the link(bf(rmdir))(rmdir)
622 command.
623
624 label(recurse) dir(bf(recurse)) Toggle directory recursion for the
625 commands link(bf(mget))(mget) and link(bf(mput))(mput).
626
627 When toggled ON, these commands will process all directories in the
628 source directory (i.e., the directory they are copying .IR from ) and
629 will recurse into any that match the mask specified to the
630 command. Only files that match the mask specified using the
631 link(bf(mask))(mask) command will be retrieved. See also the
632 link(bf(mask))(mask) command.
633
634 When recursion is toggled OFF, only files from the current working
635 directory on the source machine that match the mask specified to the
636 link(bf(mget))(mget) or link(bf(mput))(mput) commands will be copied,
637 and any mask specified using the link(bf(mask))(mask) command will be
638 ignored.
639
640 label(rm) dir(bf(rm <mask>)) Remove all files matching mask from
641 the current working directory on the server.
642
643 label(rmdir) dit(bf(rmdir <directory name>)) Remove the specified
644 directory (user access privileges permitting) from the server.
645
646 label(tar) dit(bf(tar <c|x>[IXbgNa])) Performs a tar operation - see
647 the link(bf(-T))(minusT) command line option above. Behaviour may be
648 affected by the link(bf(tarmode))(tarmode) command (see below). Using
649 g (incremental) and N (newer) will affect tarmode settings. Note that
650 using the "-" option with tar x may not work - use the command line
651 option instead.
652
653 label(blocksize) dit(bf(blocksize <blocksize>)) Blocksize. Must be
654 followed by a valid (greater than zero) blocksize. Causes tar file to
655 be written out in blocksize*TBLOCK (usually 512 byte) blocks.
656
657 label(tarmode) dir(bf(tarmode <full|inc|reset|noreset>)) Changes tar's
658 behaviour with regard to archive bits. In full mode, tar will back up
659 everything regardless of the archive bit setting (this is the default
660 mode). In incremental mode, tar will only back up files with the
661 archive bit set. In reset mode, tar will reset the archive bit on all
662 files it backs up (implies read/write share).
663
664 label(setmode) dit(bf(setmode <filename> <perm=[+|\-]rsha>)) A version
665 of the DOS attrib command to set file permissions. For example:
666
667 tt(setmode myfile +r)
668
669 would make myfile read only.
670
671 enddit()
672
673 label(NOTES)
674 manpagesection(NOTES)
675
676 Some servers are fussy about the case of supplied usernames,
677 passwords, share names (aka service names) and machine names. If you
678 fail to connect try giving all parameters in uppercase.
679
680 It is often necessary to use the link(bf(-n))(minusn) option when connecting to some
681 types of servers. For example OS/2 LanManager insists on a valid
682 NetBIOS name being used, so you need to supply a valid name that would
683 be known to the server.
684
685 smbclient supports long file names where the server supports the
686 LANMAN2 protocol or above.
687
688 label(ENVIRONMENTVARIABLES)
689 manpagesection(ENVIRONMENT VARIABLES)
690
691 The variable bf(USER) may contain the username of the person using the
692 client.  This information is used only if the protocol level is high
693 enough to support session-level passwords.
694
695 The variable bf(PASSWORD) may contain the password of the person using
696 the client.  This information is used only if the protocol level is
697 high enough to support session-level passwords.
698
699 label(INSTALLATION)
700 manpagesection(INSTALLATION)
701
702 The location of the client program is a matter for individual system
703 administrators. The following are thus suggestions only.
704
705 It is recommended that the smbclient software be installed in the
706 /usr/local/samba/bin or /usr/samba/bin directory, this directory
707 readable by all, writeable only by root. The client program itself
708 should be executable by all. The client should em(NOT) be setuid or
709 setgid!
710
711 The client log files should be put in a directory readable and
712 writable only by the user.
713
714 To test the client, you will need to know the name of a running
715 SMB/CIFS server. It is possible to run url(bf(smbd (8)))(smbd.8.html)
716 an ordinary user - running that server as a daemon on a
717 user-accessible port (typically any port number over 1024) would
718 provide a suitable test server.
719
720 label(DIAGNOSTICS)
721 manpagesection(DIAGNOSTICS)
722
723 Most diagnostics issued by the client are logged in a specified log
724 file. The log file name is specified at compile time, but may be
725 overridden on the command line.
726
727 The number and nature of diagnostics available depends on the debug
728 level used by the client. If you have problems, set the debug level to
729 3 and peruse the log files.
730
731 label(VERSION)
732 manpagesection(VERSION)
733
734 This man page is correct for version 2.0 of the Samba suite.
735
736 label(AUTHOR)
737 manpageauthor()
738
739 The original Samba software and related utilities were created by
740 Andrew Tridgell email(samba-bugs@samba.anu.edu.au). Samba is now developed
741 by the Samba Team as an Open Source project similar to the way the
742 Linux kernel is developed.
743
744 The original Samba man pages were written by Karl Auer. The man page
745 sources were converted to YODL format (another excellent piece of Open
746 Source software) and updated for the Samba2.0 release by Jeremy
747 Allison, email(samba-bugs@samba.anu.edu.au).
748
749 See url(bf(samba (7)))(samba.7.html) to find out how to get a full
750 list of contributors and details on how to submit bug reports,
751 comments etc.