summaryrefslogtreecommitdiff
path: root/docs/manpages/smbclient.1
blob: 8a70aed551a138a392ffdde8d5af9dda55b86e3f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
.\" This manpage has been automatically generated by docbook2man 
.\" from a DocBook document.  This tool can be found at:
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
.\" Please send any bug reports, improvements, comments, patches, 
.\" etc. to Steve Cheng <steve@ggi-project.org>.
.TH "SMBCLIENT" "1" "19 april 2003" "" ""

.SH NAME
smbclient \- ftp-like client to access SMB/CIFS resources  on servers
.SH SYNOPSIS

\fBsmbclient\fR \fBservicename\fR [ \fBpassword\fR ] [ \fB-b <buffer size>\fR ] [ \fB-d debuglevel\fR ] [ \fB-D Directory\fR ] [ \fB-U username\fR ] [ \fB-W workgroup\fR ] [ \fB-M <netbios name>\fR ] [ \fB-m maxprotocol\fR ] [ \fB-A authfile\fR ] [ \fB-N\fR ] [ \fB-l logfile\fR ] [ \fB-L <netbios name>\fR ] [ \fB-I destinationIP\fR ] [ \fB-E\fR ] [ \fB-c <command string>\fR ] [ \fB-i scope\fR ] [ \fB-O <socket options>\fR ] [ \fB-p port\fR ] [ \fB-R <name resolve order>\fR ] [ \fB-s <smb config file>\fR ] [ \fB-T<c|x>IXFqgbNan\fR ] [ \fB-k\fR ]

.SH "DESCRIPTION"
.PP
This tool is part of the \fBSamba\fR(7) suite.
.PP
\fBsmbclient\fR is a client that can 
\&'talk' to an SMB/CIFS server. It offers an interface
similar to that of the ftp program (see \fBftp\fR(1)).  
Operations include things like getting files from the server 
to the local machine, putting files from the local machine to 
the server, retrieving directory information from the server 
and so on. 
.SH "OPTIONS"
.TP
\fBservicename\fR
servicename is the name of the service 
you want to use on the server. A service name takes the form
\fI//server/service\fR where \fIserver
\fR is the NetBIOS name of the SMB/CIFS server 
offering the desired service and \fIservice\fR 
is the name of the service offered.  Thus to connect to 
the service "printer" on the SMB/CIFS server "smbserver",
you would use the servicename \fI//smbserver/printer
\fR

Note that the server name required is NOT necessarily 
the IP (DNS) host name of the server !  The name required is 
a NetBIOS server name, which may or may not be the
same as the IP hostname of the machine running the server.

The server name is looked up according to either 
the \fI-R\fR parameter to \fBsmbclient\fR or 
using the name resolve order parameter in 
the \fBsmb.conf\fR(5) file, 
allowing an administrator to change the order and methods 
by which server names are looked up. 
.TP
\fBpassword\fR
The password required to access the specified 
service on the specified server. If this parameter is 
supplied, the \fI-N\fR option (suppress 
password prompt) is assumed. 

There is no default password. If no password is supplied 
on the command line (either by using this parameter or adding 
a password to the \fI-U\fR option (see 
below)) and the \fI-N\fR option is not 
specified, the client will prompt for a password, even if 
the desired service does not require one. (If no password is 
required, simply press ENTER to provide a null password.)

Note: Some servers (including OS/2 and Windows for 
Workgroups) insist on an uppercase password. Lowercase 
or mixed case passwords may be rejected by these servers.   

Be cautious about including passwords in scripts.
.TP
\fB-R <name resolve order>\fR
This option is used by the programs in the Samba 
suite to determine what naming services and in what order to resolve 
host names to IP addresses. The option takes a space-separated 
string of different name resolution options.

The options are :"lmhosts", "host", "wins" and "bcast". They 
cause names to be resolved as follows:
.RS
.TP 0.2i
\(bu
lmhosts: Lookup an IP 
address in the Samba lmhosts file. If the line in lmhosts has 
no name type attached to the NetBIOS name (see 
the \fBlmhosts\fR(5) for details) then
any name type matches for lookup.
.TP 0.2i
\(bu
host: Do a standard host 
name to IP address resolution, using the system \fI/etc/hosts
\fR, NIS, or DNS lookups. This method of name resolution 
is operating system dependent, for instance on IRIX or Solaris this 
may be controlled by the \fI/etc/nsswitch.conf\fR 
file).  Note that this method is only used if the NetBIOS name 
type being queried is the 0x20 (server) name type, otherwise 
it is ignored.
.TP 0.2i
\(bu
wins: Query a name with 
the IP address listed in the \fIwins server\fR
parameter.  If no WINS server has
been specified this method will be ignored.
.TP 0.2i
\(bu
bcast: Do a broadcast on 
each of the known local interfaces listed in the 
\fIinterfaces\fR
parameter. This is the least reliable of the name resolution 
methods as it depends on the target host being on a locally 
connected subnet.
.RE

If this parameter is not set then the name resolve order 
defined in the \fBsmb.conf\fR(5) file parameter  
(name resolve order) will be used. 

The default order is lmhosts, host, wins, bcast and without 
this parameter or any entry in the \fIname resolve order
\fR parameter of the \fBsmb.conf\fR(5) file the name resolution
methods will be attempted in this order. 
.TP
\fB-M NetBIOS name\fR
This options allows you to send messages, using 
the "WinPopup" protocol, to another computer. Once a connection is 
established you then type your message, pressing ^D (control-D) to 
end. 

If the receiving computer is running WinPopup the user will 
receive the message and probably a beep. If they are not running 
WinPopup the message will be lost, and no error message will 
occur. 

The message is also automatically truncated if the message 
is over 1600 bytes, as this is the limit of the protocol. 

One useful trick is to cat the message through
\fBsmbclient\fR. For example: \fB  cat mymessage.txt | smbclient -M FRED \fR will 
send the message in the file \fImymessage.txt\fR 
to the machine FRED. 

You may also find the \fI-U\fR and 
\fI-I\fR options useful, as they allow you to 
control the FROM and TO parts of the message. 

See the \fImessage command\fR parameter in the \fBsmb.conf\fR(5) for a description of how to handle incoming 
WinPopup messages in Samba. 

\fBNote\fR: Copy WinPopup into the startup group 
on your WfWg PCs if you want them to always be able to receive 
messages. 
.TP
\fB-p port\fR
This number is the TCP port number that will be used 
when making connections to the server. The standard (well-known)
TCP port number for an SMB/CIFS server is 139, which is the 
default. 
.TP
\fB-l logfilename\fR
If specified, \fIlogfilename\fR specifies a base filename 
into which operational data from the running client will be 
logged. 

The default base name is specified at compile time.

The base name is used to generate actual log file names.
For example, if the name specified was "log", the debug file 
would be \fIlog.client\fR.

The log file generated is never removed by the client.   
.TP
\fB-h|--help\fR
Print a summary of command line options.
.TP
\fB-I IP-address\fR
\fIIP address\fR is the address of the server to connect to. 
It should be specified in standard "a.b.c.d" notation. 

Normally the client would attempt to locate a named 
SMB/CIFS server by looking it up via the NetBIOS name resolution 
mechanism described above in the \fIname resolve order\fR 
parameter above. Using this parameter will force the client
to assume that the server is on the machine with the specified IP 
address and the NetBIOS name component of the resource being 
connected to will be ignored. 

There is no default for this parameter. If not supplied, 
it will be determined automatically by the client as described 
above. 
.TP
\fB-E\fR
This parameter causes the client to write messages 
to the standard error stream (stderr) rather than to the standard 
output stream. 

By default, the client writes messages to standard output 
- typically the user's tty. 
.TP
\fB-L\fR
This option allows you to look at what services 
are available on a server. You use it as \fBsmbclient -L 
host\fR and a list should appear.  The \fI-I
\fR option may be useful if your NetBIOS names don't 
match your TCP/IP DNS host names or if you are trying to reach a 
host on another network. 
.TP
\fB-t terminal code\fR
This option tells \fBsmbclient\fR how to interpret 
filenames coming from the remote server. Usually Asian language 
multibyte UNIX implementations use different character sets than 
SMB/CIFS servers (\fBEUC\fR instead of \fB  SJIS\fR for example). Setting this parameter will let 
\fBsmbclient\fR convert between the UNIX filenames and 
the SMB filenames correctly. This option has not been seriously tested 
and may have some problems. 

The terminal codes include CWsjis, CWeuc, CWjis7, CWjis8,
CWjunet, CWhex, CWcap. This is not a complete list, check the Samba 
source code for the complete list. 
.TP
\fB-b buffersize\fR
This option changes the transmit/send buffer 
size when getting or putting a file from/to the server. The default 
is 65520 bytes. Setting this value smaller (to 1200 bytes) has been 
observed to speed up file transfers to and from a Win9x server. 
.TP
\fB-V\fR
Prints the version number for 
\fBsmbd\fR.
.TP
\fB-s <configuration file>\fR
The file specified contains the 
configuration details required by the server.  The 
information in this file includes server-specific
information such as what printcap file to use, as well 
as descriptions of all the services that the server is 
to provide. See \fIsmb.conf(5)\fR for more information.
The default configuration file name is determined at 
compile time.
.TP
\fB-d|--debug=debuglevel\fR
\fIdebuglevel\fR is an integer 
from 0 to 10.  The default value if this parameter is 
not specified is zero.

The higher this value, the more detail will be 
logged to the log files about the activities of the 
server. At level 0, only critical errors and serious 
warnings will be logged. Level 1 is a reasonable level for
day to day running - it generates a small amount of 
information about operations carried out.

Levels above 1 will generate considerable 
amounts of log data, and should only be used when 
investigating a problem. Levels above 3 are designed for 
use only by developers and generate HUGE amounts of log
data, most of which is extremely cryptic.

Note that specifying this parameter here will 
override the log
level file.
.TP
\fB-l|--logfile=logbasename\fR
File name for log/debug files. The extension
".client" will be appended. The log file is
never removed by the client.
.TP
\fB-N\fR
If specified, this parameter suppresses the normal
password prompt from the client to the user. This is useful when
accessing a service that does not require a password. 

Unless a password is specified on the command line or
this parameter is specified, the client will request a
password.
.TP
\fB-k\fR
Try to authenticate with kerberos. Only useful in
an Active Directory environment.
.TP
\fB-A|--authfile=filename\fR
This option allows
you to specify a file from which to read the username and
password used in the connection.  The format of the file is


.nf
username = <value>
password = <value>
domain   = <value>
.fi

Make certain that the permissions on the file restrict 
access from unwanted users. 
.TP
\fB-U|--user=username[%password]\fR
Sets the SMB username or username and password. 

If %password is not specified, the user will be prompted. The
client will first check the \fBUSER\fR environment variable, then the
\fBLOGNAME\fR variable and if either exists, the
string is uppercased. If these environmental variables are not
found, the username GUEST is used. 

A third option is to use a credentials file which
contains the plaintext of the username and password.  This
option is mainly provided for scripts where the admin does not
wish to pass the credentials on the command line or via environment
variables. If this method is used, make certain that the permissions
on the file restrict access from unwanted users.  See the
\fI-A\fR for more details. 

Be cautious about including passwords in scripts. Also, on
many systems the command line of a running process may be seen
via the \fBps\fR command.  To be safe always allow
\fBrpcclient\fR to prompt for a password and type
it in directly. 
.TP
\fB-n <primary NetBIOS name>\fR
This option allows you to override
the NetBIOS name that Samba uses for itself. This is identical
to setting the \fINetBIOS
name\fR parameter in the \fBsmb.conf\fR(5) file.  However, a command
line setting will take precedence over settings in
\fBsmb.conf\fR(5).
.TP
\fB-i <scope>\fR
This specifies a NetBIOS scope that
\fBnmblookup\fR will use to communicate with when
generating NetBIOS names. For details on the use of NetBIOS
scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are
\fBvery\fR rarely used, only set this parameter
if you are the system administrator in charge of all the
NetBIOS systems you communicate with.
.TP
\fB-W|--workgroup=domain\fR
Set the SMB domain of the username.   This
overrides the default domain which is the domain defined in
smb.conf.  If the domain specified is the same as the servers 
NetBIOS name, it causes the client to log on using the servers local 
SAM (as opposed to the Domain SAM). 
.TP
\fB-O socket options\fR
TCP socket options to set on the client
socket. See the socket options parameter in
the \fBsmb.conf\fR(5) manual page for the list of valid
options. 
.TP
\fB-T tar options\fR
smbclient may be used to create \fBtar(1)
\fR compatible backups of all the files on an SMB/CIFS
share. The secondary tar flags that can be given to this option 
are : 
.RS
.TP 0.2i
\(bu
\fIc\fR - Create a tar file on UNIX. 
Must be followed by the name of a tar file, tape device
or "-" for standard output. If using standard output you must 
turn the log level to its lowest value -d0 to avoid corrupting 
your tar file. This flag is mutually exclusive with the 
\fIx\fR flag. 
.TP 0.2i
\(bu
\fIx\fR - Extract (restore) a local 
tar file back to a share. Unless the -D option is given, the tar 
files will be restored from the top level of the share. Must be 
followed by the name of the tar file, device or "-" for standard 
input. Mutually exclusive with the \fIc\fR flag. 
Restored files have their creation times (mtime) set to the
date saved in the tar file. Directories currently do not get 
their creation dates restored properly. 
.TP 0.2i
\(bu
\fII\fR - Include files and directories. 
Is the default behavior when filenames are specified above. Causes 
tar files to be included in an extract or create (and therefore 
everything else to be excluded). See example below.  Filename globbing 
works  in one of two ways.  See r below. 
.TP 0.2i
\(bu
\fIX\fR - Exclude files and directories. 
Causes tar files to be excluded from an extract or create. See 
example below.  Filename globbing works in one of two ways now. 
See \fIr\fR below. 
.TP 0.2i
\(bu
\fIb\fR - Blocksize. Must be followed 
by a valid (greater than zero) blocksize.  Causes tar file to be 
written out in blocksize*TBLOCK (usually 512 byte) blocks. 
.TP 0.2i
\(bu
\fIg\fR - Incremental. Only back up 
files that have the archive bit set. Useful only with the 
\fIc\fR flag. 
.TP 0.2i
\(bu
\fIq\fR - Quiet. Keeps tar from printing 
diagnostics as it works.  This is the same as tarmode quiet. 
.TP 0.2i
\(bu
\fIr\fR - Regular expression include
or exclude.  Uses regular  expression matching for 
excluding or excluding files if  compiled with HAVE_REGEX_H. 
However this mode can be very slow. If  not compiled with 
HAVE_REGEX_H, does a limited wildcard match on '*' and  '?'. 
.TP 0.2i
\(bu
\fIN\fR - Newer than. Must be followed 
by the name of a file whose date is compared against files found 
on the share during a create. Only files newer than the file 
specified are backed up to the tar file. Useful only with the 
\fIc\fR flag. 
.TP 0.2i
\(bu
\fIa\fR - Set archive bit. Causes the 
archive bit to be reset when a file is backed up. Useful with the 
\fIg\fR and \fIc\fR flags. 
.RE

\fBTar Long File Names\fR

\fBsmbclient\fR's tar option now supports long 
file names both on backup and restore. However, the full path 
name of the file must be less than 1024 bytes.  Also, when
a tar archive is created, \fBsmbclient\fR's tar option places all 
files in the archive with relative names, not absolute names. 

\fBTar Filenames\fR

All file names can be given as DOS path names (with '\\\\' 
as the component separator) or as UNIX path names (with '/' as 
the component separator). 

\fBExamples\fR

Restore from tar file \fIbackup.tar\fR into myshare on mypc 
(no password on share). 

\fBsmbclient //mypc/yshare "" -N -Tx backup.tar
\fR

Restore everything except \fIusers/docs\fR

\fBsmbclient //mypc/myshare "" -N -TXx backup.tar 
users/docs\fR

Create a tar file of the files beneath \fI  users/docs\fR. 

\fBsmbclient //mypc/myshare "" -N -Tc
backup.tar users/docs \fR

Create the same tar file as above, but now use 
a DOS path name. 

\fBsmbclient //mypc/myshare "" -N -tc backup.tar 
users\\edocs \fR

Create a tar file of all the files and directories in 
the share. 

\fBsmbclient //mypc/myshare "" -N -Tc backup.tar *
\fR
.TP
\fB-D initial directory\fR
Change to initial directory before starting. Probably 
only of any use with the tar -T option. 
.TP
\fB-c command string\fR
command string is a semicolon-separated list of 
commands to be executed instead of prompting from stdin. \fI  -N\fR is implied by \fI-c\fR.

This is particularly useful in scripts and for printing stdin 
to the server, e.g. \fB-c 'print -'\fR. 
.SH "OPERATIONS"
.PP
Once the client is running, the user is presented with 
a prompt : 
.PP
smb:\\> 
.PP
The backslash ("\\\\") indicates the current working directory 
on the server, and will change if the current working directory 
is changed. 
.PP
The prompt indicates that the client is ready and waiting to 
carry out a user command. Each command is a single word, optionally 
followed by parameters specific to that command. Command and parameters 
are space-delimited unless these notes specifically
state otherwise. All commands are case-insensitive.  Parameters to 
commands may or may not be case sensitive, depending on the command. 
.PP
You can specify file names which have spaces in them by quoting 
the name with double quotes, for example "a long file name". 
.PP
Parameters shown in square brackets (e.g., "[parameter]") are 
optional.  If not given, the command will use suitable defaults. Parameters 
shown in angle brackets (e.g., "<parameter>") are required.
.PP
Note that all commands operating on the server are actually 
performed by issuing a request to the server. Thus the behavior may 
vary from server to server, depending on how the server was implemented. 
.PP
The commands available are given here in alphabetical order. 
.TP
\fB? [command]\fR
If \fIcommand\fR is specified, the ? command will display 
a brief informative message about the specified command.  If no 
command is specified, a list of available commands will
be displayed. 
.TP
\fB! [shell command]\fR
If \fIshell command\fR is specified, the !  
command will execute a shell locally and run the specified shell 
command. If no command is specified, a local shell will be run. 
.TP
\fBaltname file\fR
The client will request that the server return
the "alternate" name (the 8.3 name) for a file or directory.
.TP
\fBcancel jobid0 [jobid1] ... [jobidN]\fR
The client will request that the server cancel
the printjobs identified by the given numeric print job ids.
.TP
\fBchmod file mode in octal\fR
This command depends on the server supporting the CIFS
UNIX extensions and will fail if the server does not. The client requests that the server
change the UNIX permissions to the given octal mode, in standard UNIX format.
.TP
\fBchown file uid gid\fR
This command depends on the server supporting the CIFS
UNIX extensions and will fail if the server does not. The client requests that the server
change the UNIX user and group ownership to the given decimal values. Note there is
currently no way to remotely look up the UNIX uid and gid values for a given name.
This may be addressed in future versions of the CIFS UNIX extensions.
.TP
\fBcd [directory name]\fR
If "directory name" is specified, the current 
working directory on the server will be changed to the directory 
specified. This operation will fail if for any reason the specified 
directory is inaccessible. 

If no directory name is specified, the current working 
directory on the server will be reported. 
.TP
\fBdel <mask>\fR
The client will request that the server attempt 
to delete all files matching \fImask\fR from the current working 
directory on the server. 
.TP
\fBdir <mask>\fR
A list of the files matching \fImask\fR in the current 
working directory on the server will be retrieved from the server 
and displayed. 
.TP
\fBexit\fR
Terminate the connection with the server and exit 
from the program. 
.TP
\fBget <remote file name> [local file name]\fR
Copy the file called \fIremote file name\fR from 
the server to the machine running the client. If specified, name 
the local copy \fIlocal file name\fR.  Note that all transfers in 
\fBsmbclient\fR are binary. See also the 
lowercase command. 
.TP
\fBhelp [command]\fR
See the ? command above. 
.TP
\fBlcd [directory name]\fR
If \fIdirectory name\fR is specified, the current 
working directory on the local machine will be changed to 
the directory specified. This operation will fail if for any 
reason the specified directory is inaccessible. 

If no directory name is specified, the name of the 
current working directory on the local machine will be reported. 
.TP
\fBlink source destination\fR
This command depends on the server supporting the CIFS
UNIX extensions and will fail if the server does not. The client requests that the server
create a hard link between the source and destination files. The source file
must not exist.
.TP
\fBlowercase\fR
Toggle lowercasing of filenames for the get and 
mget commands. 

When lowercasing is toggled ON, local filenames are converted 
to lowercase when using the get and mget commands. This is
often useful when copying (say) MSDOS files from a server, because 
lowercase filenames are the norm on UNIX systems. 
.TP
\fBls <mask>\fR
See the dir command above. 
.TP
\fBmask <mask>\fR
This command allows the user to set up a mask 
which will be used during recursive operation of the mget and 
mput commands. 

The masks specified to the mget and mput commands act as 
filters for directories rather than files when recursion is 
toggled ON. 

The mask specified with the mask command is necessary 
to filter files within those directories. For example, if the
mask specified in an mget command is "source*" and the mask 
specified with the mask command is "*.c" and recursion is 
toggled ON, the mget command will retrieve all files matching 
"*.c" in all directories below and including all directories 
matching "source*" in the current working directory. 

Note that the value for mask defaults to blank (equivalent 
to "*") and remains so until the mask command is used to change it. 
It retains the most recently specified value indefinitely. To 
avoid unexpected results it would be wise to change the value of 
mask back to "*" after using the mget or mput commands. 
.TP
\fBmd <directory name>\fR
See the mkdir command. 
.TP
\fBmget <mask>\fR
Copy all files matching \fImask\fR from the server to 
the machine running the client. 

Note that \fImask\fR is interpreted differently during recursive 
operation and non-recursive operation - refer to the recurse and 
mask commands for more information. Note that all transfers in 
\fBsmbclient\fR are binary. See also the lowercase command. 
.TP
\fBmkdir <directory name>\fR
Create a new directory on the server (user access 
privileges permitting) with the specified name. 
.TP
\fBmput <mask>\fR
Copy all files matching \fImask\fR in the current working 
directory on the local machine to the current working directory on 
the server. 

Note that \fImask\fR is interpreted differently during recursive 
operation and non-recursive operation - refer to the recurse and mask 
commands for more information. Note that all transfers in \fBsmbclient\fR 
are binary. 
.TP
\fBprint <file name>\fR
Print the specified file from the local machine 
through a printable service on the server. 

See also the printmode command.
.TP
\fBprintmode <graphics or text>\fR
Set the print mode to suit either binary data 
(such as graphical information) or text. Subsequent print
commands will use the currently set print mode. 
.TP
\fBprompt\fR
Toggle prompting for filenames during operation 
of the mget and mput commands. 

When toggled ON, the user will be prompted to confirm 
the transfer of each file during these commands. When toggled 
OFF, all specified files will be transferred without prompting. 
.TP
\fBput <local file name> [remote file name]\fR
Copy the file called \fIlocal file name\fR from the 
machine running the client to the server. If specified,
name the remote copy \fIremote file name\fR. Note that all transfers 
in \fBsmbclient\fR are binary. See also the lowercase command. 
.TP
\fBqueue\fR
Displays the print queue, showing the job id, 
name, size and current status. 
.TP
\fBquit\fR
See the exit command. 
.TP
\fBrd <directory name>\fR
See the rmdir command. 
.TP
\fBrecurse\fR
Toggle directory recursion for the commands mget 
and mput. 

When toggled ON, these commands will process all directories 
in the source directory (i.e., the directory they are copying
from ) and will recurse into any that match the mask specified 
to the command. Only files that match the mask specified using 
the mask command will be retrieved. See also the mask command. 

When recursion is toggled OFF, only files from the current 
working directory on the source machine that match the mask specified 
to the mget or mput commands will be copied, and any mask specified 
using the mask command will be ignored. 
.TP
\fBrm <mask>\fR
Remove all files matching \fImask\fR from the current 
working directory on the server. 
.TP
\fBrmdir <directory name>\fR
Remove the specified directory (user access 
privileges permitting) from the server. 
.TP
\fBsetmode <filename> <perm=[+|\\-]rsha>\fR
A version of the DOS attrib command to set 
file permissions. For example: 

\fBsetmode myfile +r \fR

would make myfile read only. 
.TP
\fBsymlink source destination\fR
This command depends on the server supporting the CIFS
UNIX extensions and will fail if the server does not. The client requests that the server
create a symbolic hard link between the source and destination files. The source file
must not exist. Note that the server will not create a link to any path that lies 
outside the currently connected share. This is enforced by the Samba server.
.TP
\fBtar <c|x>[IXbgNa]\fR
Performs a tar operation - see the \fI-T
\fR command line option above. Behavior may be affected 
by the tarmode command (see below). Using g (incremental) and N 
(newer) will affect tarmode settings. Note that using the "-" option 
with tar x may not work - use the command line option instead. 
.TP
\fBblocksize <blocksize>\fR
Blocksize. Must be followed by a valid (greater 
than zero) blocksize. Causes tar file to be written out in 
\fIblocksize\fR*TBLOCK (usually 512 byte) blocks. 
.TP
\fBtarmode <full|inc|reset|noreset>\fR
Changes tar's behavior with regard to archive 
bits. In full mode, tar will back up everything regardless of the 
archive bit setting (this is the default mode). In incremental mode, 
tar will only back up files with the archive bit set. In reset mode, 
tar will reset the archive bit on all files it backs up (implies 
read/write share). 
.SH "NOTES"
.PP
Some servers are fussy about the case of supplied usernames, 
passwords, share names (AKA service names) and machine names. 
If you fail to connect try giving all parameters in uppercase. 
.PP
It is often necessary to use the -n option when connecting 
to some types of servers. For example OS/2 LanManager insists 
on a valid NetBIOS name being used, so you need to supply a valid 
name that would be known to the server.
.PP
smbclient supports long file names where the server 
supports the LANMAN2 protocol or above. 
.SH "ENVIRONMENT VARIABLES"
.PP
The variable \fBUSER\fR may contain the 
username of the person  using the client. This information is 
used only if the protocol  level is high enough to support 
session-level passwords.
.PP
The variable \fBPASSWD\fR may contain 
the password of the person using the client.  This information is 
used only if the protocol level is high enough to support 
session-level passwords. 
.PP
The variable \fBLIBSMB_PROG\fR may contain 
the path, executed with system(), which the client should connect 
to instead of connecting to a server.  This functionality is primarily
intended as a development aid, and works best when using a LMHOSTS 
file
.SH "INSTALLATION"
.PP
The location of the client program is a matter for 
individual system administrators. The following are thus
suggestions only. 
.PP
It is recommended that the smbclient software be installed
in the \fI/usr/local/samba/bin/\fR or \fI /usr/samba/bin/\fR directory, this directory readable 
by all, writeable only by root. The client program itself should 
be executable by all. The client should \fBNOT\fR be 
setuid or setgid! 
.PP
The client log files should be put in a directory readable 
and writeable only by the user. 
.PP
To test the client, you will need to know the name of a 
running SMB/CIFS server. It is possible to run \fBsmbd\fR(8) as an ordinary user - running that server as a daemon 
on a user-accessible port (typically any port number over 1024)
would provide a suitable test server. 
.SH "DIAGNOSTICS"
.PP
Most diagnostics issued by the client are logged in a 
specified log file. The log file name is specified at compile time, 
but may be overridden on the command line. 
.PP
The number and nature of diagnostics available depends 
on the debug level used by the client. If you have problems, 
set the debug level to 3 and peruse the log files. 
.SH "VERSION"
.PP
This man page is correct for version 2.2 of the Samba suite.
.SH "AUTHOR"
.PP
The original Samba software and related utilities 
were created by Andrew Tridgell. Samba is now developed
by the Samba Team as an Open Source project similar 
to the way the Linux kernel is developed.
.PP
The original Samba man pages were written by Karl Auer. 
The man page sources were converted to YODL format (another 
excellent piece of Open Source software, available at  ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0 
release by Jeremy Allison.  The conversion to DocBook for 
Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0
was done by Alexander Bokovoy.