41dbfc01fa0ad38316c8b7aac21fa202c1609f5e
[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 manpagename(smbclient)(ftp-like client to access SMB/CIFS resources on servers)
6
7 manpagesynopsis()
8
9 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]
10
11 manpagedescription()
12
13 This program is part of the bf(Samba) suite.
14
15 bf(smbclient) is a client that can 'talk' to an SMB/CIFS server. It
16 offers an interface similar to that of the ftp program (see bf(ftp
17 (1))).  Operations include things like getting files from the server
18 to the local machine, putting files from the local machine to the
19 server, retrieving directory information from the server and so on.
20
21 manpageoptions()
22
23 startdit()
24
25 dit(bf(servicename)) servicename is the name of the service you want
26 to use on the server. A service name takes the form
27 tt(//server/service) where em(server) is the NetBIOS name of the SMB/CIFS
28 server offering the desired service and em(service) is the name
29 of the service offered. Thus to connect to the service em(printer) on
30 the SMB/CIFS server em(lanman), you would use the servicename
31
32 tt(//lanman/printer)
33
34 Note that the server name required is NOT necessarily the host name of
35 the server! The name required is a NetBIOS server name, which may or
36 may not be the same as the IP (DNS) hostname of the machine running
37 the server.
38
39 The server name is looked up according to the bf(name resolve order)
40 parameter in the smb.conf file, allowing an administrator to change
41 the order and methods by which server names are looked up.
42
43 dit(bf(password)) password is the password required to access the
44 specified service on the specified server. If this parameter is
45 supplied, the bf(-N) option (suppress password prompt) is assumed.
46
47 There is no default password. If no password is supplied on the
48 command line (either by using this parameter or adding a password to
49 the bf(-U) option (see below)) and the bf(-N) option is not specified,
50 the client will prompt for a password, even if the desired service
51 does not require one. (If no password is required, simply press ENTER
52 to provide a null password.)
53
54 Note: Some servers (including OS/2 and Windows for Workgroups) insist
55 on an uppercase password. Lowercase or mixed case passwords may be
56 rejected by these servers.
57
58 Be cautious about including passwords in scripts.
59
60 dit(bf(-s smb.conf)) This parameter specifies the pathname to the
61 Samba configuration file, smb.conf. This file controls all aspects of
62 the Samba setup on the machine and smbclient also needs to read this
63 file.
64
65 dit(bf(-B IP addr)) The IP address to use when sending a broadcast packet.
66
67 dit(bf(-O socket_options)) TCP socket options to set on the client socket.
68
69   DEBUG(0,("\t-R name resolve order use these name resolution services only\n"));
70   DEBUG(0,("\t-M host               send a winpopup message to the host\n"));
71   DEBUG(0,("\t-i scope              use this NetBIOS scope\n"));
72   DEBUG(0,("\t-N                    don't ask for a password\n"));
73   DEBUG(0,("\t-n netbios name.      Use this name as my netbios name\n"));
74   DEBUG(0,("\t-d debuglevel         set the debuglevel\n"));
75   DEBUG(0,("\t-P                    connect to service as a printer\n"));
76   DEBUG(0,("\t-p port               connect to the specified port\n"));
77   DEBUG(0,("\t-l log basename.      Basename for log/debug files\n"));
78   DEBUG(0,("\t-h                    Print this help message.\n"));
79   DEBUG(0,("\t-I dest IP            use this IP to connect to\n"));
80   DEBUG(0,("\t-E                    write messages to stderr instead of stdout\n"));
81   DEBUG(0,("\t-U username           set the network username\n"));
82   DEBUG(0,("\t-L host               get a list of shares available on a host\n"));
83   DEBUG(0,("\t-t terminal code      terminal i/o code {sjis|euc|jis7|jis8|junet|hex}\n"));
84   DEBUG(0,("\t-m max protocol       set the max protocol level\n"));
85   DEBUG(0,("\t-W workgroup          set the workgroup name\n"));
86   DEBUG(0,("\t-T<c|x>IXFqgbNan      command line tar\n"));
87   DEBUG(0,("\t-D directory          start from directory\n"));
88   DEBUG(0,("\t-c command string     execute semicolon separated commands\n"));
89
90 .B \-R name resolve order
91
92 .RS 3
93 This parameter will override the default name resolution order of the
94 server listed in the "name resolve order" parameter in smb.conf. This
95 is useful to force name resolution to take place by a particular method.
96 This command line parameter only exists in Samba 1.9.18p4 and above.
97 .RE
98
99 .B \-A
100
101 .RS 3
102 This parameter, if specified, causes the maximum debug level to be selected.
103 Be warned that this generates prodigious amounts of debug data. There is also
104 a security issue involved, as at the maximum debug level cleartext passwords
105 may be written to some log files.
106 .RE
107
108 .B \-L
109
110 .RS 3
111 This option allows you to look at what services are available on a
112 server. You use it as "smbclient -L host" and a list should appear.
113 The
114 .B \-I
115 option may be useful if your NetBIOS names don't match your 
116 tcp/ip host names or if you are trying to reach a host on another
117 network. For example:
118
119 smbclient -L ftp -I ftp.microsoft.com
120
121 will list the shares available on Microsoft's public server.
122 .RE
123
124 .B \-M
125
126 .RS 3
127 This options allows you to send messages, using the "WinPopup"
128 protocol, to another computer. Once a connection is established you
129 then type your message, pressing ^D (control-D) to end.
130
131 If the receiving computer is running WinPopup the user will receive
132 the message and probably a beep. If they are not running WinPopup the
133 message will be lost, and no error message will occur.
134
135 The message is also automatically truncated if the message is over
136 1600 bytes, as this is the limit of the protocol.
137
138 One useful trick is to cat the message through
139 .BR smbclient .
140 For example:
141
142 cat mymessage.txt | smbclient -M FRED
143
144 will send the message in the file "mymessage.txt" to the machine FRED.
145
146 You may also find the
147 .B \-U
148 and
149 .B \-I
150 options useful, as they allow you to
151 control the FROM and TO parts of the message. 
152
153 See the message command section of
154 .BR smb.conf (5)
155 for a description of how to handle incoming WinPopup messages in Samba.
156
157 Note: Copy WinPopup into the startup group on your WfWg PCs if you
158 want them to always be able to receive messages.
159 .RE
160
161 .B \-E
162
163 .RS 3
164 This parameter, if specified, causes the client to write messages to the
165 standard error stream (stderr) rather than to the standard output stream.
166
167 By default, the client writes messages to standard output - typically the
168 user's tty.
169 .RE
170
171 .B \-I
172 .I IP number
173
174 .RS 3
175 .I IP number
176 represents the IP number of the server to connect to. It should
177 be specified in standard "a.b.c.d" notation.
178
179 Normally the client will attempt to locate the specified Lan Manager server
180 by looking it up - that is, broadcasting a request for the given server to
181 identify itself. Using this parameter will force the client to assume that
182 the server is on the machine with the specified IP number.
183
184 There is no default for this parameter. If not supplied, it will be determined
185 automatically by the client as described above.
186 .RE
187
188 .B \-N
189
190 .RS 3
191 If specified, this parameter suppresses the normal password prompt from the
192 client to the user. This is useful when accessing a service that does not
193 require a password.
194
195 Unless a password is specified on the command line or this parameter is
196 specified, the client will request a password.
197 .RE
198
199 .B \-O
200 .I socket options
201
202 .RS 3
203 See the socket options section of
204 .BR smb.conf (5)
205 for details.
206 .RE
207
208 .B \-P
209
210 .RS 3
211 If specified, the service requested will be connected to as a printer service
212 rather than as a normal filespace service. Operations such as put and get
213 will not be applicable for such a connection.
214
215 By default, services will be connected to as NON-printer services.
216 .RE
217
218 .B \-U
219 .I username
220
221 .RS 3
222 .I username
223 is the user name that will be used by the client to make a connection,
224 assuming your server is running a protocol that allows for usernames.
225
226 Some servers are fussy about the case of this name, and some insist
227 that it must be a valid NetBIOS name.
228
229 If no 
230 .I username
231 is supplied, it will default to an uppercase version of the 
232 environment variable 
233 .B USER
234 or
235 .B LOGNAME
236 in that order.
237 If no 
238 .I username
239 is supplied and neither environment variable exists the user name will
240 be empty.
241
242 If the USER environment variable containts a '%' character, everything
243 after that will be treated as a password. This allows you to set the
244 environment variable to be
245 .B USER=username%password
246 so that a password is not passed on the command line (where it may
247 be seen by the ps command).
248
249 If the service you are connecting to requires a password, it can be supplied
250 using the
251 .B \-U
252 option, by appending a percent symbol ("%") then the password to 
253 .I username.
254 For example, to attach to a service as user "fred" with password "secret", you
255 would specify
256 .B \-U
257 .I fred%secret
258 on the command line. Note that there are no spaces around the percent symbol.
259
260 If you specify the password as part of
261 .I username
262 then the 
263 .B \-N
264 option (suppress password prompt) is assumed.
265
266 If you specify the password as a parameter AND as part of
267 .I username
268 then the password as part of
269 .I username
270 will take precedence. Putting nothing before or nothing after the percent 
271 symbol will cause an empty username or an empty password to be used,
272 respectively.
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.
279 .RE
280
281 .B \-d
282 .I debuglevel
283
284 .RS 3
285 debuglevel is an integer from 0 to 5.
286
287 The default value if this parameter is not specified is zero.
288
289 The higher this value, the more detail will be logged to the log files about
290 the activities of the client. At level 0, only critical errors and serious 
291 warnings will be logged. Level 1 is a reasonable level for day to day running
292 - it generates a small amount of information about operations carried out.
293
294 Levels above 1 will generate considerable amounts of log data, and should 
295 only be used when investigating a problem. Levels above 3 are designed for 
296 use only by developers and generate HUGE amounts of log data, most of which 
297 is extremely cryptic.
298 .RE
299
300 .B \-l
301 .I log basename
302
303 .RS 3
304 If specified,
305 .I log basename
306 specifies a base filename into which operational data from the running client
307 will be logged.
308
309 The default base name is specified at compile time.
310
311 The base name is used to generate actual log file names. For example, if the
312 name specified was "log", the following files would be used for log data:
313
314 .RS 3
315 log.client.debug (containing debugging information)
316
317 log.client.in (containing inbound transaction data)
318
319 log.client.out (containing outbound transaction data)
320 .RE
321
322 The log files generated are never removed by the client.
323 .RE
324
325 .B \-n
326 .I NetBIOS name
327
328 .RS 3
329 By default, the client will use the local machine's hostname (in
330 uppercase) as its NetBIOS name. This parameter allows you to override
331 the host name and use whatever NetBIOS name you wish.
332 .RE
333
334 .B \-W
335 .I workgroup
336
337 .RS 3
338 Override what workgroup is used for the connection. This may be needed
339 to connect to some servers.
340 .RE
341
342 .B \-p
343 .I port number
344
345 .RS 3
346 port number is a positive integer value.
347
348 The default value if this parameter is not specified is 139.
349
350 This number is the port number that will be used when making connections to
351 the server. The standard (well-known) port number for the server is 139, 
352 hence the default.
353
354 This parameter is not normally specified.
355 .RE
356
357 .B \-T
358 .I tar options
359
360 .RS 3 
361 where
362 .I tar options
363 consists of one or more of
364 .BR c ,
365 .BR x ,
366 .BR I ,
367 .BR X ,
368 .BR b ,
369 .BR g ,
370 .BR q ,
371 .BR N
372 or
373 .BR a ;
374 used as:
375 .LP
376 smbclient 
377 .B "\e\eserver\eshare"
378 \-TcxIXbgNa
379 [
380 .IR blocksize
381 ]
382 [
383 .IR newer-file
384 ]
385 .IR tarfile
386 [
387 .IR filenames ...
388 ]
389
390 .RS 3
391 .B c
392 Create a tar file on UNIX. Must be followed by the name of a tar file,
393 tape device or "\-" for standard output. (May be useful to set debugging
394 low
395 .RB ( -d0 ))
396 to avoid corrupting your tar file if using "\-"). Mutually
397 exclusive with the
398 .B x
399 flag.
400
401 .B x
402 Extract (restore) a local tar file back to a share. Unless the
403 .B \-D
404 option is given, the tar files will be restored from the top level of
405 the share. Must be followed by the name of the tar file, device or "\-"
406 for standard input. Mutually exclusive with the
407 .B c
408 flag. Restored files have theuir creation times (mtime) set to the date saved in
409 the tar file. Directories currently do not get their creation dates restored 
410 properly.
411
412 .B I
413 Include files and directories. Is the default behaviour when
414 .IR filenames
415 are specified above. Causes tar files to be included in an extract or create
416 (and therefore everything else to be excluded). See example below.
417 Filename globbing does not work for included files for extractions (yet).
418
419 .B X
420 Exclude files and directories. Causes tar files to be excluded from
421 an extract or create. See example below.
422 Filename globbing does not work for excluded files (yet).
423
424 .B b
425 Blocksize. Must be followed by a valid (greater than zero) blocksize.
426 Causes tar file to be written out in blocksize*TBLOCK (usually 512 byte)
427 blocks.
428
429 .B g
430 Incremental. Only back up files that have the archive bit set. Useful
431 only with the
432 .B c
433 flag.
434
435 .B q
436 Quiet. Keeps tar from printing diagnostics as it works.  This is the
437 same as tarmode quiet.
438
439 .B N
440 Newer than. Must be followed by the name of a file whose date is
441 compared against files found on the share during a create. Only files
442 newer than the file specified are backed up to the tar file. Useful
443 only with the
444 .B c
445 flag.
446
447 .B a
448 Set archive bit. Causes the archive bit to be reset when a file is backed
449 up. Useful with the
450 .B g
451 (and
452 .BR c )
453 flags.
454 .LP
455
456 .B Long File Names
457
458 smbclient's tar option now supports long file names both on backup and 
459 restore. However, the full path name of the file must be less than 1024 bytes.
460 Also, when a tar archive is created, smbclient's tar option places all files 
461 in the archive with relative names, not absolute names.
462
463 .B Filenames ...
464
465 All file names can be given as DOS path names (with \e as the component 
466 separator) or as UNIX path names (with / as the component separator).
467
468 .B Examples
469
470 smbclient \e\emypc\emyshare "" -N -Tx backup.tar
471
472 Restore from tar file backup.tar into myshare on mypc (no password on share).
473
474 smbclient \e\emypc\emyshare "" -N -TXx backup.tar users/docs
475
476 Restore everything except users/docs
477
478 smbclient \e\emypc\emyshare "" -N -Tc backup.tar users/docs
479
480 Create a tar file of the files beneath users/docs.
481
482 smbclient \e\emypc\emyshare "" -N -tc backup.tar users\edocs
483
484 Create the same tar file as above, but now use a DOS path name.
485
486 smbclient \e\emypc\emyshare "" -N -Tc backup.tar \e*
487
488 Create a tar file of all the files and directories in the share.
489 .RE
490 .RE
491
492 .B \-D
493 .I initial directory
494
495 .RS 3 
496 Change to initial directory before starting. Probably only of any use
497 with the tar
498 .RB ( \-T )
499 option.
500 .RE
501
502 .B \-c
503 .I command string
504
505 .RS 3
506 command string is a semicolon separated list of commands to be
507 executed instead of prompting from stdin.
508 .B \-N
509 is implied by
510 .BR \-c .
511
512 This is particularly useful in scripts and for printing stdin to
513 the server, e.g. \-c 'print \-'.
514 .RE
515 .SH OPERATIONS
516 Once the client is running, the user is presented with a prompt, "smb: \e>".
517 The backslash ("\e") indicates the current working directory on the server,
518 and will change if the current working directory is changed.
519
520 The prompt indicates that the client is ready and waiting to carry out a user
521 command. Each command is a single word, optionally followed by parameters
522 specific to that command. Command and parameters are space-delimited unless
523 these notes specifically state otherwise. All commands are case-insensitive.
524 Parameters to commands may or may not be case sensitive, depending on the
525 command.
526
527 You can specify file names which have spaces in them by quoting the
528 name with double quotes, for example "a long file name".
529
530 Parameters shown in square brackets (eg., "[parameter]") are optional. If not
531 given, the command will use suitable defaults. Parameters shown in angle
532 brackets (eg., "<parameter>") are required.
533
534 Note that all commands operating on the server are actually performed by
535 issuing a request to the server. Thus the behaviour may vary from server to
536 server, depending on how the server was implemented.
537
538 The commands available are given here in alphabetical order.
539
540 .B ?
541 .RS 3
542 .B Parameters:
543 .RS 3
544 .I [command]
545
546 .RE
547 .B Description:
548 .RS 3
549 If
550 .I command
551 is specified, the
552 .B ?
553 command will display a brief informative message about the specified command.
554
555 If no command is specified, a list of available commands will be displayed.
556 .RE
557 .RE
558
559 .B !
560 .RS 3
561 .B Parameters:
562 .RS 3
563 .I [shell command]
564
565 .RE
566 .B Description:
567 .RS 3
568 If
569 .I shell command
570 is specified, the
571 .B !
572 command will execute a shell locally and run the specified shell command. If
573 no command is specified, a shell will be run.
574 .RE
575 .RE
576
577 .B cd
578 .RS 3
579 .B Parameters:
580 .RS 3
581 .I [directory name]
582
583 .RE
584 .B Description:
585 .RS 3
586 If
587 .I directory name
588 is specified, the current working directory
589 .B on the server
590 will be changed to the directory specified. This operation will fail if for
591 any reason the specified directory is inaccessible.
592
593 If no directory name is specified, the current working directory
594 .B on the server
595 will be reported.
596 .RE
597 .RE
598
599 .B del
600 .RS 3
601 .B Parameters:
602 .RS 3
603 .I <mask>
604
605 .RE
606 .B Description:
607 .RS 3
608 The client will request that the server attempt to delete all files matching
609 .I mask
610 from the current working directory
611 .B on the server.
612 .RE
613 .RE
614
615 .B dir
616 .RS 3
617 .B Parameters:
618 .RS 3
619 .I <mask>
620
621 .RE
622 .B Description:
623 .RS 3
624 A list of the files matching
625 .I mask
626 in the current working directory
627 .B on the server
628 will be retrieved from the server and displayed.
629 .RE
630 .RE
631
632 .B exit
633 .RS 3
634 .B Parameters:
635 .RS 3
636 None.
637
638 .RE
639 .B Description:
640 .RS 3
641 Terminate the connection with the server and exit from the program.
642 .RE
643 .RE
644
645 .B get
646 .RS 3
647 .B Parameters:
648 .RS 3
649 .I <remote file name> [local file name]
650
651 .RE
652 .B Description:
653 .RS 3
654 Copy the file called
655 .I remote file name
656 from the server to the machine running the client. If specified, name the
657 local copy
658 .I local file name.
659 Note that all transfers in
660 .B smbclient
661 are binary. See also the
662 .B lowercase
663 command.
664 .RE
665 .RE
666
667 .B help
668 .RS 3
669 .B Parameters:
670 .RS 3
671 .I [command]
672
673 .RE
674 .B Description:
675 .RS 3
676 See the
677 .B ?
678 command above.
679 .RE
680 .RE
681
682 .B lcd
683 .RS 3
684 .B Parameters:
685 .RS 3
686 .I [directory name]
687
688 .RE
689 .B Description:
690 .RS 3
691 If
692 .I directory name
693 is specified, the current working directory
694 .B on the local machine
695 will be changed to the directory specified. This operation will fail if for
696 any reason the specified directory is inaccessible.
697
698 If no directory name is specified, the name of the current working directory
699 .B on the local machine
700 will be reported.
701 .RE
702 .RE
703
704 .B lowercase
705 .RS 3
706 .B Parameters:
707 .RS 3
708 None.
709
710 .RE
711 .B Description:
712 .RS 3
713 Toggle lowercasing of filenames for the
714 .B get
715 and
716 .B mget
717 commands.
718
719 When lowercasing is toggled ON, local filenames are converted to lowercase
720 when using the
721 .B get
722 and
723 .B mget
724 commands. This is often useful when copying (say) MSDOS files from a server,
725 because lowercase filenames are the norm on UNIX systems.
726 .RE
727 .RE
728
729 .B ls
730 .RS 3
731 .B Parameters:
732 .RS 3
733 .I <mask>
734
735 .RE
736 .B Description:
737 .RS 3
738 See the
739 .B dir
740 command above.
741 .RE
742 .RE
743
744 .B mask
745 .RS 3
746 .B Parameters:
747 .RS 3
748 .I <mask>
749
750 .RE
751 .B Description:
752 .RS 3
753 This command allows the user to set up a mask which will be used during
754 recursive operation of the
755 .B mget
756 and
757 .B mput
758 commands.
759
760 The masks specified to the
761 .B mget
762 and
763 .B mput
764 commands act as filters for directories
765 rather than files when recursion is toggled ON.
766
767 The mask specified with the
768 .B mask
769 command is necessary to filter files within those directories. For example,
770 if the mask specified in an
771 .B mget
772 command is "source*"
773 .I and
774 the mask specified with the
775 .B mask
776 command is "*.c"
777 .I and
778 recursion is toggled ON, the
779 .B mget
780 command will retrieve all files matching "*.c" in all directories below
781 and including all directories matching "source*" in the current working 
782 directory.
783
784 Note that the value for
785 .I mask
786 defaults to blank (equivalent to "*") and remains so until the
787 .B mask
788 command is used to change it. It retains the most recently specified value
789 indefinitely. To avoid unexpected results it would be wise to change the
790 value of
791 .I mask
792 back to "*" after using the
793 .B mget
794 or
795 .B mput
796 commands.
797 .RE
798 .RE
799
800 .B md
801 .RS 3
802 .B Parameters:
803 .RS 3
804 .I <directory name>
805
806 .RE
807 .B Description:
808 .RS 3
809 See the
810 .B mkdir
811 command.
812 .RE
813 .RE
814
815 .B mget
816 .RS 3
817 .B Parameters:
818 .RS 3
819 .I <mask>
820
821 .RE
822 .B Description:
823 .RS 3
824 Copy all files matching
825 .I mask
826 from the server to the machine running the client.
827
828 Note that
829 .I mask
830 is interpreted differently during recursive operation and non-recursive
831 operation - refer to the
832 .B recurse
833 and
834 .B mask
835 commands for more information. Note that all transfers in
836 .B smbclient
837 are binary. See also the
838 .B lowercase
839 command.
840 .RE
841 .RE
842
843 .B mkdir
844 .RS 3
845 .B Parameters:
846 .RS 3
847 .I <directory name>
848
849 .RE
850 .B Description:
851 .RS 3
852 Create a new directory 
853 .B on the server
854 (user access privileges permitting) with the specified name.
855 .RE
856 .RE
857
858 .B mput
859 .RS 3
860 .B Parameters:
861 .RS 3
862 .I <mask>
863
864 .RE
865 .B Description:
866 .RS 3
867 Copy all files matching
868 .I mask
869 in the current working directory
870 .B on the local machine
871 to the current working directory on the server.
872
873 Note that
874 .I mask
875 is interpreted differently during recursive operation and non-recursive
876 operation - refer to the
877 .B recurse
878 and
879 .B mask
880 commands for more information. Note that all transfers in
881 .B smbclient
882 are binary.
883 .RE
884 .RE
885
886 .B print
887 .RS 3
888 .B Parameters:
889 .RS 3
890 .I <file name>
891
892 .RE
893 .B Description:
894 .RS 3
895 Print the specified file
896 .B from the local machine
897 through a printable service on the server.
898
899 See also the
900 .B printmode
901 command.
902 .RE
903 .RE
904
905 .B printmode
906 .RS 3
907 .B Parameters:
908 .RS 3
909 .I <graphics or text>
910
911 .RE
912 .B Description:
913 .RS 3
914 Set the print mode to suit either binary data (such as graphical information)
915 or text. Subsequent
916 .B print
917 commands will use the currently set print mode.
918 .RE
919 .RE
920
921 .B prompt
922 .RS 3
923 .B Parameters:
924 .RS 3
925 None.
926
927 .RE
928 .B Description:
929 .RS 3
930 Toggle prompting for filenames during operation of the
931 .B mget
932 and
933 .B mput
934 commands.
935
936 When toggled ON, the user will be prompted to confirm the transfer of each
937 file during these commands. When toggled OFF, all specified files will be
938 transferred without prompting.
939 .RE
940 .RE
941
942 .B put
943 .RS 3
944 .B Parameters:
945 .RS 3
946 .I <local file name> [remote file name]
947
948 .RE
949 .B Description:
950 .RS 3
951 Copy the file called
952 .I local file name
953 from the machine running the client to the server. If specified, name the
954 remote copy
955 .I remote file name.
956 Note that all transfers in
957 .B smbclient
958 are binary. See also the
959 .B lowercase
960 command.
961 .RE
962 .RE
963
964 .B queue
965 .RS 3
966 .B Parameters:
967 .RS 3
968 None.
969
970 .RE
971 .B Description:
972 .RS 3
973 Displays the print queue, showing the job id, name, size and current status.
974 .RE
975 .RE
976
977 .B quit
978 .RS 3
979 .B Parameters:
980 .RS 3
981 None.
982
983 .RE
984 .B Description:
985 .RS 3
986 See the
987 .B exit
988 command.
989 .RE
990 .RE
991
992 .B rd
993 .RS 3
994 .B Parameters:
995 .RS 3
996 .I <directory name>
997
998 .RE
999 .B Description:
1000 .RS 3
1001 See the
1002 .B rmdir
1003 command.
1004 .RE
1005 .RE
1006
1007 .B recurse
1008 .RS 3
1009 .B Parameters:
1010 .RS 3
1011 None.
1012
1013 .RE
1014 .B Description:
1015 .RS 3
1016 Toggle directory recursion for the commands
1017 .B mget
1018 and
1019 .BR mput .
1020
1021 When toggled ON, these commands will process all directories in the source
1022 directory (i.e., the directory they are copying
1023 .IR from )
1024 and will recurse into any that match the mask specified to the command. Only
1025 files that match the mask specified using the
1026 .B mask
1027 command will be retrieved. See also the
1028 .B mask
1029 command.
1030
1031 When recursion is toggled OFF, only files from the current working
1032 directory on the source machine that match the mask specified to the
1033 .B mget
1034 or
1035 .B mput
1036 commands will be copied, and any mask specified using the
1037 .B mask
1038 command will be ignored.
1039 .RE
1040 .RE
1041
1042 .B rm
1043 .RS 3
1044 .B Parameters:
1045 .RS 3
1046 .I <mask>
1047
1048 .RE
1049 .B Description:
1050 .RS 3
1051 Remove all files matching
1052 .I mask
1053 from the current working directory
1054 .B on the server.
1055 .RE
1056 .RE
1057
1058 .B rmdir
1059 .RS 3
1060 .B Parameters:
1061 .RS 3
1062 .I <directory name>
1063
1064 .RE
1065 .B Description:
1066 .RS 3
1067 Remove the specified directory (user access privileges permitting)
1068 .B from the server.
1069 .RE
1070 .RE
1071
1072 .B tar
1073 .RS 3
1074 .B Parameters:
1075 .RS 3
1076 .I <c|x>[IXbgNa]
1077
1078 .RE
1079 .B Description:
1080 .RS 3
1081 Performs a tar operation - see the
1082 .B \-T
1083 command line option above. Behaviour
1084 may be affected by the
1085 .B tarmode
1086 command (see below). Using g (incremental) and N (newer) will affect
1087 tarmode settings. Note that using the "\-" option with tar x may not
1088 work - use the command line option instead.
1089 .RE
1090 .RE
1091
1092 .B blocksize
1093 .RS 3
1094 .B Parameters
1095 .RS 3
1096 .I <blocksize>
1097
1098 .RE
1099 .B Description
1100 .RS 3
1101 Blocksize. Must be followed by a valid (greater than zero) blocksize.
1102 Causes tar file to be written out in blocksize*TBLOCK (usually 512 byte)
1103 blocks.
1104 .RE
1105 .RE
1106
1107 .B tarmode
1108 .RS 3
1109 .B Parameters
1110 .RS 3
1111 .I <full|inc|reset|noreset>
1112
1113 .RE
1114 .B Description
1115 .RS 3
1116 Changes tar's behaviour with regard to archive bits. In full mode,
1117 tar will back up everything regardless of the archive bit setting (this
1118 is the default mode). In incremental mode, tar will only back up files
1119 with the archive bit set. In reset mode, tar will reset the archive bit
1120 on all files it backs up (implies read/write share).
1121 .RE
1122 .RE
1123
1124 .B setmode
1125 .RS 3
1126 .B Parameters
1127 .RS 3
1128 .I <filename> <perm=[+|\-]rsha>
1129
1130 .RE
1131 .B Description
1132 .RS 3
1133 A version of the DOS attrib command to set file permissions. For example,
1134
1135 setmode myfile +r
1136
1137 would make myfile read only.
1138 .RE
1139 .RE
1140 .SH NOTES
1141 Some servers are fussy about the case of supplied usernames, passwords, share
1142 names (aka service names) and machine names. If you fail to connect try
1143 giving all parameters in uppercase.
1144
1145 It is often necessary to use the
1146 .B \-n
1147 option when connecting to some types
1148 of servers. For example OS/2 LanManager insists on a valid NetBIOS name
1149 being used, so you need to supply a valid name that would be known to
1150 the server.
1151
1152 .B smbclient
1153 supports long file names where the server supports the LANMAN2
1154 protocol.
1155 .SH FILES
1156 Not applicable.
1157 .SH ENVIRONMENT VARIABLES
1158 .B USER
1159 .RS 3
1160 The variable USER may contain the username of the person using the client.
1161 This information is used only if the protocol level is high enough to support
1162 session-level passwords.
1163 .RE
1164 .SH INSTALLATION
1165 The location of the client program is a matter for individual system 
1166 administrators. The following are thus suggestions only.
1167
1168 It is recommended that the client software be installed under the
1169 /usr/local/samba
1170 hierarchy, in a directory readable by all, writeable only by root. The client
1171 program itself should be executable by all. The client should NOT be setuid 
1172 or setgid!
1173
1174 The client log files should be put in a directory readable and writable only
1175 by the user.
1176
1177 To test the client, you will need to know the name of a running Lan manager
1178 server. It is possible to run
1179 .B smbd
1180 (see
1181 .BR smbd (8))
1182 as an ordinary user - running that server as a daemon on a
1183 user-accessible port (typically any port number over 1024) would
1184 provide a suitable test server.
1185 .SH VERSION
1186 This man page is (mostly) correct for version 1.9.00 of the Samba suite, plus some
1187 of the recent patches to it. These notes will necessarily lag behind 
1188 development of the client software, so it is possible that your version of 
1189 the client has extensions or parameter semantics that differ from or are not 
1190 covered by this man page. Please notify these to the address below for 
1191 rectification.
1192 .SH SEE ALSO
1193 .BR smbd (8)
1194 .SH DIAGNOSTICS
1195 [This section under construction]
1196
1197 Most diagnostics issued by the client are logged in a specified log file. The
1198 log file name is specified at compile time, but may be overridden on the
1199 command line.
1200
1201 The number and nature of diagnostics available depends on the debug level used
1202 by the client. If you have problems, set the debug level to 3 and peruse the
1203 log files.
1204
1205 Most messages are reasonably self-explanatory. Unfortunately, at time of
1206 creation of this man page the source code is still too fluid to warrant
1207 describing each and every diagnostic. At this stage your best bet is still
1208 to grep the source code and inspect the conditions that gave rise to the 
1209 diagnostics you are seeing.
1210 .SH BUGS
1211 None known.
1212 .SH CREDITS
1213 The original Samba software and related utilities were created by 
1214 Andrew Tridgell (samba-bugs@samba.anu.edu.au). Andrew is also the Keeper
1215 of the Source for this project.
1216
1217 See
1218 .BR smb.conf (5)
1219 for a full list of contributors and details on how to 
1220 submit bug reports, comments etc.