~zulcss/samba/server-dailies-3.4

« back to all changes in this revision

Viewing changes to docs/manpages/smbget.1

  • Committer: Chuck Short
  • Date: 2010-09-28 20:38:39 UTC
  • Revision ID: zulcss@ubuntu.com-20100928203839-pgjulytsi9ue63x1
Initial version

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\"     Title: smbget
 
2
.\"    Author: [see the "AUTHOR" section]
 
3
.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
 
4
.\"      Date: 05/10/2010
 
5
.\"    Manual: User Commands
 
6
.\"    Source: Samba 3.4
 
7
.\"  Language: English
 
8
.\"
 
9
.TH "SMBGET" "1" "05/10/2010" "Samba 3\&.4" "User Commands"
 
10
.\" -----------------------------------------------------------------
 
11
.\" * (re)Define some macros
 
12
.\" -----------------------------------------------------------------
 
13
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
14
.\" toupper - uppercase a string (locale-aware)
 
15
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
16
.de toupper
 
17
.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
 
18
\\$*
 
19
.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
 
20
..
 
21
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
22
.\" SH-xref - format a cross-reference to an SH section
 
23
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
24
.de SH-xref
 
25
.ie n \{\
 
26
.\}
 
27
.toupper \\$*
 
28
.el \{\
 
29
\\$*
 
30
.\}
 
31
..
 
32
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
33
.\" SH - level-one heading that works better for non-TTY output
 
34
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
35
.de1 SH
 
36
.\" put an extra blank line of space above the head in non-TTY output
 
37
.if t \{\
 
38
.sp 1
 
39
.\}
 
40
.sp \\n[PD]u
 
41
.nr an-level 1
 
42
.set-an-margin
 
43
.nr an-prevailing-indent \\n[IN]
 
44
.fi
 
45
.in \\n[an-margin]u
 
46
.ti 0
 
47
.HTML-TAG ".NH \\n[an-level]"
 
48
.it 1 an-trap
 
49
.nr an-no-space-flag 1
 
50
.nr an-break-flag 1
 
51
\." make the size of the head bigger
 
52
.ps +3
 
53
.ft B
 
54
.ne (2v + 1u)
 
55
.ie n \{\
 
56
.\" if n (TTY output), use uppercase
 
57
.toupper \\$*
 
58
.\}
 
59
.el \{\
 
60
.nr an-break-flag 0
 
61
.\" if not n (not TTY), use normal case (not uppercase)
 
62
\\$1
 
63
.in \\n[an-margin]u
 
64
.ti 0
 
65
.\" if not n (not TTY), put a border/line under subheading
 
66
.sp -.6
 
67
\l'\n(.lu'
 
68
.\}
 
69
..
 
70
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
71
.\" SS - level-two heading that works better for non-TTY output
 
72
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
73
.de1 SS
 
74
.sp \\n[PD]u
 
75
.nr an-level 1
 
76
.set-an-margin
 
77
.nr an-prevailing-indent \\n[IN]
 
78
.fi
 
79
.in \\n[IN]u
 
80
.ti \\n[SN]u
 
81
.it 1 an-trap
 
82
.nr an-no-space-flag 1
 
83
.nr an-break-flag 1
 
84
.ps \\n[PS-SS]u
 
85
\." make the size of the head bigger
 
86
.ps +2
 
87
.ft B
 
88
.ne (2v + 1u)
 
89
.if \\n[.$] \&\\$*
 
90
..
 
91
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
92
.\" BB/BE - put background/screen (filled box) around block of text
 
93
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
94
.de BB
 
95
.if t \{\
 
96
.sp -.5
 
97
.br
 
98
.in +2n
 
99
.ll -2n
 
100
.gcolor red
 
101
.di BX
 
102
.\}
 
103
..
 
104
.de EB
 
105
.if t \{\
 
106
.if "\\$2"adjust-for-leading-newline" \{\
 
107
.sp -1
 
108
.\}
 
109
.br
 
110
.di
 
111
.in
 
112
.ll
 
113
.gcolor
 
114
.nr BW \\n(.lu-\\n(.i
 
115
.nr BH \\n(dn+.5v
 
116
.ne \\n(BHu+.5v
 
117
.ie "\\$2"adjust-for-leading-newline" \{\
 
118
\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 
119
.\}
 
120
.el \{\
 
121
\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 
122
.\}
 
123
.in 0
 
124
.sp -.5v
 
125
.nf
 
126
.BX
 
127
.in
 
128
.sp .5v
 
129
.fi
 
130
.\}
 
131
..
 
132
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
133
.\" BM/EM - put colored marker in margin next to block of text
 
134
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
135
.de BM
 
136
.if t \{\
 
137
.br
 
138
.ll -2n
 
139
.gcolor red
 
140
.di BX
 
141
.\}
 
142
..
 
143
.de EM
 
144
.if t \{\
 
145
.br
 
146
.di
 
147
.ll
 
148
.gcolor
 
149
.nr BH \\n(dn
 
150
.ne \\n(BHu
 
151
\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
 
152
.in 0
 
153
.nf
 
154
.BX
 
155
.in
 
156
.fi
 
157
.\}
 
158
..
 
159
.\" -----------------------------------------------------------------
 
160
.\" * set default formatting
 
161
.\" -----------------------------------------------------------------
 
162
.\" disable hyphenation
 
163
.nh
 
164
.\" disable justification (adjust text to left margin only)
 
165
.ad l
 
166
.\" -----------------------------------------------------------------
 
167
.\" * MAIN CONTENT STARTS HERE *
 
168
.\" -----------------------------------------------------------------
 
169
.SH "Name"
 
170
smbget \- wget\-like utility for download files over SMB
 
171
.SH "Synopsis"
 
172
.fam C
 
173
.HP \w'\ 'u
 
174
\FCsmbget\F[] [\-a,\ \-\-guest] [\-r,\ \-\-resume] [\-R,\ \-\-recursive] [\-u,\ \-\-username=STRING] [\-p,\ \-\-password=STRING] [\-w,\ \-\-workgroup=STRING] [\-n,\ \-\-nonprompt] [\-d,\ \-\-debuglevel=INT] [\-D,\ \-\-dots] [\-P,\ \-\-keep\-permissions] [\-o,\ \-\-outputfile] [\-f,\ \-\-rcfile] [\-q,\ \-\-quiet] [\-v,\ \-\-verbose] [\-b,\ \-\-blocksize] [\-?,\ \-\-help] [\-\-usage] {smb://host/share/path/to/file} [smb://url2/] [\&.\&.\&.]
 
175
.fam
 
176
.SH "DESCRIPTION"
 
177
.PP
 
178
This tool is part of the
 
179
\fBsamba\fR(7)
 
180
suite\&.
 
181
.PP
 
182
smbget is a simple utility with wget\-like semantics, that can download files from SMB servers\&. You can specify the files you would like to download on the command\-line\&.
 
183
.PP
 
184
The files should be in the smb\-URL standard, e\&.g\&. use smb://host/share/file for the UNC path
 
185
\fI\e\e\e\eHOST\e\eSHARE\e\efile\fR\&.
 
186
.SH "OPTIONS"
 
187
.PP
 
188
\-a, \-\-guest
 
189
.RS 4
 
190
Work as user guest
 
191
.RE
 
192
.PP
 
193
\-r, \-\-resume
 
194
.RS 4
 
195
Automatically resume aborted files
 
196
.RE
 
197
.PP
 
198
\-R, \-\-recursive
 
199
.RS 4
 
200
Recursively download files
 
201
.RE
 
202
.PP
 
203
\-u, \-\-username=STRING
 
204
.RS 4
 
205
Username to use
 
206
.RE
 
207
.PP
 
208
\-p, \-\-password=STRING
 
209
.RS 4
 
210
Password to use
 
211
.RE
 
212
.PP
 
213
\-w, \-\-workgroup=STRING
 
214
.RS 4
 
215
Workgroup to use (optional)
 
216
.RE
 
217
.PP
 
218
\-n, \-\-nonprompt
 
219
.RS 4
 
220
Don\'t ask anything (non\-interactive)
 
221
.RE
 
222
.PP
 
223
\-d, \-\-debuglevel=INT
 
224
.RS 4
 
225
Debuglevel to use
 
226
.RE
 
227
.PP
 
228
\-D, \-\-dots
 
229
.RS 4
 
230
Show dots as progress indication
 
231
.RE
 
232
.PP
 
233
\-P, \-\-keep\-permissions
 
234
.RS 4
 
235
Set same permissions on local file as are set on remote file\&.
 
236
.RE
 
237
.PP
 
238
\-o, \-\-outputfile
 
239
.RS 4
 
240
Write the file that is being download to the specified file\&. Can not be used together with \-R\&.
 
241
.RE
 
242
.PP
 
243
\-f, \-\-rcfile
 
244
.RS 4
 
245
Use specified rcfile\&. This will be loaded in the order it was specified \- e\&.g\&. if you specify any options before this one, they might get overriden by the contents of the rcfile\&.
 
246
.RE
 
247
.PP
 
248
\-q, \-\-quiet
 
249
.RS 4
 
250
Be quiet
 
251
.RE
 
252
.PP
 
253
\-v, \-\-verbose
 
254
.RS 4
 
255
Be verbose
 
256
.RE
 
257
.PP
 
258
\-b, \-\-blocksize
 
259
.RS 4
 
260
Number of bytes to download in a block\&. Defaults to 64000\&.
 
261
.RE
 
262
.PP
 
263
\-?, \-\-help
 
264
.RS 4
 
265
Show help message
 
266
.RE
 
267
.PP
 
268
\-\-usage
 
269
.RS 4
 
270
Display brief usage message
 
271
.RE
 
272
.SH "SMB URLS"
 
273
.PP
 
274
SMB URL\'s should be specified in the following format:
 
275
.PP
 
276
.if n \{\
 
277
.RS 4
 
278
.\}
 
279
.fam C
 
280
.ps -1
 
281
.nf
 
282
.if t \{\
 
283
.sp -1
 
284
.\}
 
285
.BB lightgray adjust-for-leading-newline
 
286
.sp -1
 
287
 
 
288
smb://[[[domain;]user[:password@]]server[/share[/path[/file]]]]
 
289
.EB lightgray adjust-for-leading-newline
 
290
.if t \{\
 
291
.sp 1
 
292
.\}
 
293
.fi
 
294
.fam
 
295
.ps +1
 
296
.if n \{\
 
297
.RE
 
298
.\}
 
299
.PP
 
300
.if n \{\
 
301
.RS 4
 
302
.\}
 
303
.fam C
 
304
.ps -1
 
305
.nf
 
306
.if t \{\
 
307
.sp -1
 
308
.\}
 
309
.BB lightgray adjust-for-leading-newline
 
310
.sp -1
 
311
 
 
312
smb:// means all the workgroups
 
313
.EB lightgray adjust-for-leading-newline
 
314
.if t \{\
 
315
.sp 1
 
316
.\}
 
317
.fi
 
318
.fam
 
319
.ps +1
 
320
.if n \{\
 
321
.RE
 
322
.\}
 
323
.PP
 
324
.if n \{\
 
325
.RS 4
 
326
.\}
 
327
.fam C
 
328
.ps -1
 
329
.nf
 
330
.if t \{\
 
331
.sp -1
 
332
.\}
 
333
.BB lightgray adjust-for-leading-newline
 
334
.sp -1
 
335
 
 
336
smb://name/ means, if \fIname\fR is a workgroup, all the servers in this workgroup, or if \fIname\fR is a server, all the shares on this server\&.
 
337
.EB lightgray adjust-for-leading-newline
 
338
.if t \{\
 
339
.sp 1
 
340
.\}
 
341
.fi
 
342
.fam
 
343
.ps +1
 
344
.if n \{\
 
345
.RE
 
346
.\}
 
347
.SH "EXAMPLES"
 
348
.sp
 
349
.if n \{\
 
350
.RS 4
 
351
.\}
 
352
.fam C
 
353
.ps -1
 
354
.nf
 
355
.if t \{\
 
356
.sp -1
 
357
.\}
 
358
.BB lightgray adjust-for-leading-newline
 
359
.sp -1
 
360
 
 
361
# Recursively download \'src\' directory
 
362
smbget \-R smb://rhonwyn/jelmer/src
 
363
# Download FreeBSD ISO and enable resuming
 
364
smbget \-r smb://rhonwyn/isos/FreeBSD5\&.1\&.iso
 
365
# Recursively download all ISOs
 
366
smbget \-Rr smb://rhonwyn/isos
 
367
# Backup my data on rhonwyn
 
368
smbget \-Rr smb://rhonwyn/
 
369
.EB lightgray adjust-for-leading-newline
 
370
.if t \{\
 
371
.sp 1
 
372
.\}
 
373
.fi
 
374
.fam
 
375
.ps +1
 
376
.if n \{\
 
377
.RE
 
378
.\}
 
379
.SH "BUGS"
 
380
.PP
 
381
Permission denied is returned in some cases where the cause of the error is unknown (such as an illegally formatted smb:// url or trying to get a directory without \-R turned on)\&.
 
382
.SH "VERSION"
 
383
.PP
 
384
This man page is correct for version 3 of the Samba suite\&.
 
385
.SH "AUTHOR"
 
386
.PP
 
387
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\&.
 
388
.PP
 
389
The smbget manpage was written by Jelmer Vernooij\&.