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
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
|
<HTML
><HEAD
><TITLE
>smbclient</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.57"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><H1
><A
NAME="SMBCLIENT"
>smbclient</A
></H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5"
></A
><H2
>Name</H2
>smbclient -- ftp-like client to access SMB/CIFS resources
on servers</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN8"
></A
><H2
>Synopsis</H2
><P
><B
CLASS="COMMAND"
>smbclient</B
> {servicename} [password] [-b <buffer size>] [-d debuglevel] [-D Directory] [-S server] [-U username] [-W workgroup] [-M <netbios name>] [-m maxprotocol] [-A authfile] [-N] [-l logfile] [-L <netbios name>] [-I destinationIP] [-E <terminal code>] [-c <command string>] [-i scope] [-O <socket options>] [-p port] [-R <name resolve order>] [-s <smb config file>] [-T<c|x>IXFqgbNan]</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN34"
></A
><H2
>DESCRIPTION</H2
><P
>This tool is part of the <A
HREF="samba.7.html"
TARGET="_top"
> Samba</A
> suite.</P
><P
><B
CLASS="COMMAND"
>smbclient</B
> is a client that can
'talk' to an SMB/CIFS server. It offers an interface
similar to that of the ftp program (see <B
CLASS="COMMAND"
>ftp(1)</B
>).
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. </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN41"
></A
><H2
>OPTIONS</H2
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>servicename</DT
><DD
><P
>servicename is the name of the service
you want to use on the server. A service name takes the form
<TT
CLASS="FILENAME"
>//server/service</TT
> where <TT
CLASS="PARAMETER"
><I
>server
</I
></TT
> is the NetBIOS name of the SMB/CIFS server
offering the desired service and <TT
CLASS="PARAMETER"
><I
>service</I
></TT
>
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 <TT
CLASS="FILENAME"
>//smbserver/printer
</TT
></P
><P
>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.
</P
><P
>The server name is looked up according to either
the <TT
CLASS="PARAMETER"
><I
>-R</I
></TT
> parameter to smbclient or
using the name resolve order parameter in the smb.conf file,
allowing an administrator to change the order and methods
by which server names are looked up. </P
></DD
><DT
>password</DT
><DD
><P
>The password required to access the specified
service on the specified server. If this parameter is
supplied, the <TT
CLASS="PARAMETER"
><I
>-N</I
></TT
> option (suppress
password prompt) is assumed. </P
><P
>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 <TT
CLASS="PARAMETER"
><I
>-U</I
></TT
> option (see
below)) and the <TT
CLASS="PARAMETER"
><I
>-N</I
></TT
> 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.)
</P
><P
>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.
</P
><P
>Be cautious about including passwords in scripts.
</P
></DD
><DT
>-s smb.conf</DT
><DD
><P
>Specifies the location of the all important
<TT
CLASS="FILENAME"
>smb.conf</TT
> file. </P
></DD
><DT
>-O socket options</DT
><DD
><P
>TCP socket options to set on the client
socket. See the socket options parameter in the <TT
CLASS="FILENAME"
> smb.conf (5)</TT
> manpage for the list of valid
options. </P
></DD
><DT
>-R <name resolve order></DT
><DD
><P
>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.</P
><P
>The options are :"lmhosts", "host", "wins" and "bcast". They
cause names to be resolved as follows :</P
><P
></P
><UL
><LI
><P
><TT
CLASS="CONSTANT"
>lmhosts</TT
> : 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 <A
HREF="lmhosts.5.html"
TARGET="_top"
>lmhosts(5)</A
> for details) then
any name type matches for lookup.</P
></LI
><LI
><P
><TT
CLASS="CONSTANT"
>host</TT
> : Do a standard host
name to IP address resolution, using the system <TT
CLASS="FILENAME"
>/etc/hosts
</TT
>, NIS, or DNS lookups. This method of name resolution
is operating system depended for instance on IRIX or Solaris this
may be controlled by the <TT
CLASS="FILENAME"
>/etc/nsswitch.conf</TT
>
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.</P
></LI
><LI
><P
><TT
CLASS="CONSTANT"
>wins</TT
> : Query a name with
the IP address listed in the <TT
CLASS="PARAMETER"
><I
>wins server</I
></TT
>
parameter. If no WINS server has
been specified this method will be ignored.</P
></LI
><LI
><P
><TT
CLASS="CONSTANT"
>bcast</TT
> : Do a broadcast on
each of the known local interfaces listed in the
<TT
CLASS="PARAMETER"
><I
>interfaces</I
></TT
>
parameter. This is the least reliable of the name resolution
methods as it depends on the target host being on a locally
connected subnet.</P
></LI
></UL
><P
>If this parameter is not set then the name resolve order
defined in the <TT
CLASS="FILENAME"
>smb.conf</TT
> file parameter
(name resolve order) will be used. </P
><P
>The default order is lmhosts, host, wins, bcast and without
this parameter or any entry in the <TT
CLASS="PARAMETER"
><I
>name resolve order
</I
></TT
> parameter of the smb.conf file the name resolution
methods will be attempted in this order. </P
></DD
><DT
>-M NetBIOS name</DT
><DD
><P
>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. </P
><P
>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. </P
><P
>The message is also automatically truncated if the message
is over 1600 bytes, as this is the limit of the protocol.
</P
><P
>One useful trick is to cat the message through
<B
CLASS="COMMAND"
>smbclient</B
>. For example: <B
CLASS="COMMAND"
> cat mymessage.txt | smbclient -M FRED </B
> will
send the message in the file <TT
CLASS="FILENAME"
>mymessage.txt</TT
>
to the machine FRED. </P
><P
>You may also find the <TT
CLASS="PARAMETER"
><I
>-U</I
></TT
> and
<TT
CLASS="PARAMETER"
><I
>-I</I
></TT
> options useful, as they allow you to
control the FROM and TO parts of the message. </P
><P
>See the message command parameter in the <TT
CLASS="FILENAME"
> smb.conf(5)</TT
> for a description of how to handle incoming
WinPopup messages in Samba. </P
><P
><EM
>Note</EM
>: Copy WinPopup into the startup group
on your WfWg PCs if you want them to always be able to receive
messages. </P
></DD
><DT
>-i scope</DT
><DD
><P
>This specifies a NetBIOS scope that smbclient 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 <EM
>very</EM
> rarely used, only set
this parameter if you are the system administrator in charge of all
the NetBIOS systems you communicate with. </P
></DD
><DT
>-N</DT
><DD
><P
>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. </P
><P
>Unless a password is specified on the command line or
this parameter is specified, the client will request a
password.</P
></DD
><DT
>-n NetBIOS name</DT
><DD
><P
>By default, the client will use the local
machine's hostname (in uppercase) as its NetBIOS name. This parameter
allows you to override the host name and use whatever NetBIOS
name you wish. </P
></DD
><DT
>-d debuglevel</DT
><DD
><P
>debuglevel is an integer from 0 to 10, or
the letter 'A'. </P
><P
>The default value if this parameter is not specified
is zero. </P
><P
>The higher this value, the more detail will be logged to
the log files about the activities of the
client. 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. </P
><P
>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. If debuglevel is set to the letter 'A', then <EM
>all
</EM
> debug messages will be printed. This setting
is for developers only (and people who <EM
>really</EM
> want
to know how the code works internally). </P
><P
>Note that specifying this parameter here will override
the log level parameter in the <B
CLASS="COMMAND"
>smb.conf (5)</B
>
file. </P
></DD
><DT
>-p port</DT
><DD
><P
>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. </P
></DD
><DT
>-l logfilename</DT
><DD
><P
>If specified, logfilename specifies a base filename
into which operational data from the running client will be
logged. </P
><P
>The default base name is specified at compile time.</P
><P
>The base name is used to generate actual log file names.
For example, if the name specified was "log", the debug file
would be <TT
CLASS="FILENAME"
>log.client</TT
>.</P
><P
>The log file generated is never removed by the client.
</P
></DD
><DT
>-h</DT
><DD
><P
>Print the usage message for the client. </P
></DD
><DT
>-I IP-address</DT
><DD
><P
>IP address is the address of the server to connect to.
It should be specified in standard "a.b.c.d" notation. </P
><P
>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 <TT
CLASS="PARAMETER"
><I
>name resolve order</I
></TT
>
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. </P
><P
>There is no default for this parameter. If not supplied,
it will be determined automatically by the client as described
above. </P
></DD
><DT
>-E</DT
><DD
><P
>This parameter causes the client to write messages
to the standard error stream (stderr) rather than to the standard
output stream. </P
><P
>By default, the client writes messages to standard output
- typically the user's tty. </P
></DD
><DT
>-U username[%pass]</DT
><DD
><P
>Sets the SMB username or username and password.
If %pass is not specified, The user will be prompted. The client
will first check the USER environment variable, then the
<TT
CLASS="PARAMETER"
><I
>$LOGNAME</I
></TT
> variable and if either exist, the
string is uppercased. Anything in these variables following a '%'
sign will be treated as the password. If these environmental
variables are not found, the username <TT
CLASS="CONSTANT"
>GUEST</TT
>
is used. </P
><P
>If the password is not included in these environment
variables (using the %pass syntax), rpcclient will look for
a <TT
CLASS="PARAMETER"
><I
>$PASSWD</I
></TT
> environment variable from which
to read the password. </P
><P
>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 doesn't
desire 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
<TT
CLASS="PARAMETER"
><I
>-A</I
></TT
> for more details. </P
><P
>Be cautious about including passwords in scripts or in
the <TT
CLASS="PARAMETER"
><I
>$PASSWD</I
></TT
> environment variable. Also, on
many systems the command line of a running process may be seen
via the <B
CLASS="COMMAND"
>ps</B
> command to be safe always allow
<B
CLASS="COMMAND"
>rpcclient</B
> to prompt for a password and type
it in directly. </P
></DD
><DT
>-A filename</DT
><DD
><P
>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
</P
><P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="90%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>username = <value>
password = <value>
</PRE
></TD
></TR
></TABLE
></P
><P
>Make certain that the permissions on the file restrict
access from unwanted users. </P
></DD
><DT
>-L</DT
><DD
><P
>This option allows you to look at what services
are available on a server. You use it as <B
CLASS="COMMAND"
>smbclient -L
host</B
> and a list should appear. The <TT
CLASS="PARAMETER"
><I
>-I
</I
></TT
> 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. </P
></DD
><DT
>-t terminal code</DT
><DD
><P
>This option tells smbclient how to interpret
filenames coming from the remote server. Usually Asian language
multibyte UNIX implementations use different character sets than
SMB/CIFS servers (<EM
>EUC</EM
> instead of <EM
> SJIS</EM
> for example). Setting this parameter will let
<B
CLASS="COMMAND"
>smbclient</B
> convert between the UNIX filenames and
the SMB filenames correctly. This option has not been seriously tested
and may have some problems. </P
><P
>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. </P
></DD
><DT
>-b buffersize</DT
><DD
><P
>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.
</P
></DD
><DT
>-W WORKGROUP</DT
><DD
><P
>Override the default workgroup specified in the
workgroup parameter of the <TT
CLASS="FILENAME"
>smb.conf</TT
> file
for this connection. This may be needed to connect to some
servers. </P
></DD
><DT
>-T tar options</DT
><DD
><P
>smbclient may be used to create <B
CLASS="COMMAND"
>tar(1)
</B
> compatible backups of all the files on an SMB/CIFS
share. The secondary tar flags that can be given to this option
are : </P
><P
></P
><UL
><LI
><P
><TT
CLASS="PARAMETER"
><I
>c</I
></TT
> - 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
<TT
CLASS="PARAMETER"
><I
>x</I
></TT
> flag. </P
></LI
><LI
><P
><TT
CLASS="PARAMETER"
><I
>x</I
></TT
> - 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 <TT
CLASS="PARAMETER"
><I
>c</I
></TT
> 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. </P
></LI
><LI
><P
><TT
CLASS="PARAMETER"
><I
>I</I
></TT
> - 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. </P
></LI
><LI
><P
><TT
CLASS="PARAMETER"
><I
>X</I
></TT
> - 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 <TT
CLASS="PARAMETER"
><I
>r</I
></TT
> below. </P
></LI
><LI
><P
><TT
CLASS="PARAMETER"
><I
>b</I
></TT
> - 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.
</P
></LI
><LI
><P
><TT
CLASS="PARAMETER"
><I
>g</I
></TT
> - Incremental. Only back up
files that have the archive bit set. Useful only with the
<TT
CLASS="PARAMETER"
><I
>c</I
></TT
> flag. </P
></LI
><LI
><P
><TT
CLASS="PARAMETER"
><I
>q</I
></TT
> - Quiet. Keeps tar from printing
diagnostics as it works. This is the same as tarmode quiet.
</P
></LI
><LI
><P
><TT
CLASS="PARAMETER"
><I
>r</I
></TT
> - Regular expression include
or exclude. Uses regular 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 '?'.
</P
></LI
><LI
><P
><TT
CLASS="PARAMETER"
><I
>N</I
></TT
> - 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
<TT
CLASS="PARAMETER"
><I
>c</I
></TT
> flag. </P
></LI
><LI
><P
><TT
CLASS="PARAMETER"
><I
>a</I
></TT
> - Set archive bit. Causes the
archive bit to be reset when a file is backed up. Useful with the
<TT
CLASS="PARAMETER"
><I
>g</I
></TT
> and <TT
CLASS="PARAMETER"
><I
>c</I
></TT
> flags.
</P
></LI
></UL
><P
><EM
>Tar Long File Names</EM
></P
><P
><B
CLASS="COMMAND"
>smbclient</B
>'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, smbclient's tar option places all
files in the archive with relative names, not absolute names.
</P
><P
><EM
>Tar Filenames</EM
></P
><P
>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). </P
><P
><EM
>Examples</EM
></P
><P
>Restore from tar file backup.tar into myshare on mypc
(no password on share). </P
><P
><B
CLASS="COMMAND"
>smbclient //mypc/myshare "" -N -Tx backup.tar
</B
></P
><P
>Restore everything except <TT
CLASS="FILENAME"
>users/docs</TT
>
</P
><P
><B
CLASS="COMMAND"
>smbclient //mypc/myshare "" -N -TXx backup.tar
users/docs</B
></P
><P
>Create a tar file of the files beneath <TT
CLASS="FILENAME"
> users/docs</TT
>. </P
><P
><B
CLASS="COMMAND"
>smbclient //mypc/myshare "" -N -Tc
backup.tar users/docs </B
></P
><P
>Create the same tar file as above, but now use
a DOS path name. </P
><P
><B
CLASS="COMMAND"
>smbclient //mypc/myshare "" -N -tc backup.tar
users\edocs </B
></P
><P
>Create a tar file of all the files and directories in
the share. </P
><P
><B
CLASS="COMMAND"
>smbclient //mypc/myshare "" -N -Tc backup.tar *
</B
></P
></DD
><DT
>-D initial directory</DT
><DD
><P
>Change to initial directory before starting. Probably
only of any use with the tar -T option. </P
></DD
><DT
>-c command string</DT
><DD
><P
>command string is a semicolon separated list of
commands to be executed instead of prompting from stdin. <TT
CLASS="PARAMETER"
><I
> -N</I
></TT
> is implied by <TT
CLASS="PARAMETER"
><I
>-c</I
></TT
>.</P
><P
>This is particularly useful in scripts and for printing stdin
to the server, e.g. <B
CLASS="COMMAND"
>-c 'print -'</B
>. </P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN297"
></A
><H2
>OPERATIONS</H2
><P
>Once the client is running, the user is presented with
a prompt : </P
><P
><TT
CLASS="PROMPT"
>smb:\> </TT
></P
><P
>The backslash ("\") indicates the current working directory
on the server, and will change if the current working directory
is changed. </P
><P
>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.
</P
><P
>You can specify file names which have spaces in them by quoting
the name with double quotes, for example "a long file name". </P
><P
>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.
</P
><P
>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.
</P
><P
>The commands available are given here in alphabetical order. </P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>? [command]</DT
><DD
><P
>If "command" 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. </P
></DD
><DT
>! [shell command]</DT
><DD
><P
>If "shell command" 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.
</P
></DD
><DT
>cd [directory name]</DT
><DD
><P
>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. </P
><P
>If no directory name is specified, the current working
directory on the server will be reported. </P
></DD
><DT
>del <mask></DT
><DD
><P
>The client will request that the server attempt
to delete all files matching "mask" from the current working
directory on the server. </P
></DD
><DT
>dir <mask></DT
><DD
><P
>A list of the files matching "mask" in the current
working directory on the server will be retrieved from the server
and displayed. </P
></DD
><DT
>exit</DT
><DD
><P
>Terminate the connection with the server and exit
from the program. </P
></DD
><DT
>get <remote file name> [local file name]</DT
><DD
><P
>Copy the file called "remote file name" from
the server to the machine running the client. If specified, name
the local copy "local file name". Note that all transfers in
<B
CLASS="COMMAND"
>smbclient</B
> are binary. See also the
lowercase command. </P
></DD
><DT
>help [command]</DT
><DD
><P
>See the ? command above. </P
></DD
><DT
>lcd [directory name]</DT
><DD
><P
>If "directory name" 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. </P
><P
>If no directory name is specified, the name of the
current working directory on the local machine will be reported.
</P
></DD
><DT
>lowercase</DT
><DD
><P
>Toggle lowercasing of filenames for the get and
mget commands. </P
><P
>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. </P
></DD
><DT
>ls <mask></DT
><DD
><P
>See the dir command above. </P
></DD
><DT
>mask <mask></DT
><DD
><P
>This command allows the user to set up a mask
which will be used during recursive operation of the mget and
mput commands. </P
><P
>The masks specified to the mget and mput commands act as
filters for directories rather than files when recursion is
toggled ON. </P
><P
>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. </P
><P
>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. </P
></DD
><DT
>md <directory name></DT
><DD
><P
>See the mkdir command. </P
></DD
><DT
>mget <mask></DT
><DD
><P
>Copy all files matching mask from the server to
the machine running the client. </P
><P
>Note that mask 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
smbclient are binary. See also the lowercase command. </P
></DD
><DT
>mkdir <directory name></DT
><DD
><P
>Create a new directory on the server (user access
privileges permitting) with the specified name. </P
></DD
><DT
>mput <mask></DT
><DD
><P
>Copy all files matching mask in the current working
directory on the local machine to the current working directory on
the server. </P
><P
>Note that mask 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 smbclient
are binary. </P
></DD
><DT
>print <file name></DT
><DD
><P
>Print the specified file from the local machine
through a printable service on the server. </P
><P
>See also the printmode command.</P
></DD
><DT
>printmode <graphics or text></DT
><DD
><P
>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. </P
></DD
><DT
>prompt</DT
><DD
><P
>Toggle prompting for filenames during operation
of the mget and mput commands. </P
><P
>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.
</P
></DD
><DT
>put <local file name> [remote file name]</DT
><DD
><P
>Copy the file called "local file name" from the
machine running the client to the server. If specified,
name the remote copy "remote file name". Note that all transfers
in smbclient are binary. See also the lowercase command.
</P
></DD
><DT
>queue</DT
><DD
><P
>Displays the print queue, showing the job id,
name, size and current status. </P
></DD
><DT
>quit</DT
><DD
><P
>See the exit command. </P
></DD
><DT
>rd <directory name></DT
><DD
><P
>See the rmdir command. </P
></DD
><DT
>recurse</DT
><DD
><P
>Toggle directory recursion for the commands mget
and mput. </P
><P
>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.
</P
><P
>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. </P
></DD
><DT
>rm <mask></DT
><DD
><P
>Remove all files matching mask from the current
working directory on the server. </P
></DD
><DT
>rmdir <directory name></DT
><DD
><P
>Remove the specified directory (user access
privileges permitting) from the server. </P
></DD
><DT
>tar <c|x>[IXbgNa]</DT
><DD
><P
>Performs a tar operation - see the <TT
CLASS="PARAMETER"
><I
>-T
</I
></TT
> 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.
</P
></DD
><DT
>blocksize <blocksize></DT
><DD
><P
>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. </P
></DD
><DT
>tarmode <full|inc|reset|noreset></DT
><DD
><P
>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). </P
></DD
><DT
>setmode <filename> <perm=[+|\-]rsha></DT
><DD
><P
>A version of the DOS attrib command to set
file permissions. For example: </P
><P
><B
CLASS="COMMAND"
>setmode myfile +r </B
></P
><P
>would make myfile read only. </P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN446"
></A
><H2
>NOTES</H2
><P
>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.
</P
><P
>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.</P
><P
>smbclient supports long file names where the server
supports the LANMAN2 protocol or above. </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN451"
></A
><H2
>ENVIRONMENT VARIABLES</H2
><P
>The variable <TT
CLASS="PARAMETER"
><I
>$USER</I
></TT
> 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.</P
><P
>The variable <TT
CLASS="PARAMETER"
><I
>$PASSWD</I
></TT
> 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. </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN457"
></A
><H2
>INSTALLATION</H2
><P
>The location of the client program is a matter for
individual system administrators. The following are thus
suggestions only. </P
><P
>It is recommended that the smbclient software be installed
in the <TT
CLASS="FILENAME"
>/usr/local/samba/bin/</TT
> or <TT
CLASS="FILENAME"
> /usr/samba/bin/</TT
> directory, this directory readable
by all, writeable only by root. The client program itself should
be executable by all. The client should <EM
>NOT</EM
> be
setuid or setgid! </P
><P
>The client log files should be put in a directory readable
and writeable only by the user. </P
><P
>To test the client, you will need to know the name of a
running SMB/CIFS server. It is possible to run <B
CLASS="COMMAND"
>smbd(8)
</B
> 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. </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN467"
></A
><H2
>DIAGNOSTICS</H2
><P
>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. </P
><P
>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. </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN471"
></A
><H2
>VERSION</H2
><P
>This man page is correct for version 2.2 of
the Samba suite.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN474"
></A
><H2
>AUTHOR</H2
><P
>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.</P
><P
>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
<A
HREF="ftp://ftp.icce.rug.nl/pub/unix/"
TARGET="_top"
> ftp://ftp.icce.rug.nl/pub/unix/</A
>) and updated for the Samba 2.0
release by Jeremy Allison. The conversion to DocBook for
Samba 2.2 was done by Gerald Carter</P
></DIV
></BODY
></HTML
>
|
