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