source: vendor/3.5.5/docs/manpages/smbget.1

Last change on this file was 478, checked in by Silvan Scherrer, 15 years ago

Samba 3.5: vendor update to 3.5.4

File size: 8.4 KB
Line 
1.\" Title: smbget
2.\" Author: [see the "AUTHOR" section]
3.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
4.\" Date: 06/18/2010
5.\" Manual: User Commands
6.\" Source: Samba 3.5
7.\" Language: English
8.\"
9.TH "SMBGET" "1" "06/18/2010" "Samba 3\&.5" "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"
170smbget \- 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] [\-O,\ \-\-stdout] [\-?,\ \-\-help] [\-\-usage] {smb://host/share/path/to/file} [smb://url2/] [\&.\&.\&.]
175.fam
176.SH "DESCRIPTION"
177.PP
178This tool is part of the
179\fBsamba\fR(7)
180suite\&.
181.PP
182smbget 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
184The 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
190Work as user guest
191.RE
192.PP
193\-r, \-\-resume
194.RS 4
195Automatically resume aborted files
196.RE
197.PP
198\-R, \-\-recursive
199.RS 4
200Recursively download files
201.RE
202.PP
203\-u, \-\-username=STRING
204.RS 4
205Username to use
206.RE
207.PP
208\-p, \-\-password=STRING
209.RS 4
210Password to use
211.RE
212.PP
213\-w, \-\-workgroup=STRING
214.RS 4
215Workgroup to use (optional)
216.RE
217.PP
218\-n, \-\-nonprompt
219.RS 4
220Don\'t ask anything (non\-interactive)
221.RE
222.PP
223\-d, \-\-debuglevel=INT
224.RS 4
225Debuglevel to use
226.RE
227.PP
228\-D, \-\-dots
229.RS 4
230Show dots as progress indication
231.RE
232.PP
233\-P, \-\-keep\-permissions
234.RS 4
235Set same permissions on local file as are set on remote file\&.
236.RE
237.PP
238\-o, \-\-outputfile
239.RS 4
240Write the file that is being downloaded to the specified file\&. Can not be used together with \-R\&.
241.RE
242.PP
243\-O, \-\-stdout
244.RS 4
245Write the file that is being downloaded to standard output\&.
246.RE
247.PP
248\-f, \-\-rcfile
249.RS 4
250Use 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\&.
251.RE
252.PP
253\-q, \-\-quiet
254.RS 4
255Be quiet
256.RE
257.PP
258\-v, \-\-verbose
259.RS 4
260Be verbose
261.RE
262.PP
263\-b, \-\-blocksize
264.RS 4
265Number of bytes to download in a block\&. Defaults to 64000\&.
266.RE
267.PP
268\-?, \-\-help
269.RS 4
270Show help message
271.RE
272.PP
273\-\-usage
274.RS 4
275Display brief usage message
276.RE
277.SH "SMB URLS"
278.PP
279SMB URL\'s should be specified in the following format:
280.PP
281.if n \{\
282.RS 4
283.\}
284.fam C
285.ps -1
286.nf
287.if t \{\
288.sp -1
289.\}
290.BB lightgray adjust-for-leading-newline
291.sp -1
292
293smb://[[[domain;]user[:password@]]server[/share[/path[/file]]]]
294.EB lightgray adjust-for-leading-newline
295.if t \{\
296.sp 1
297.\}
298.fi
299.fam
300.ps +1
301.if n \{\
302.RE
303.\}
304.PP
305.if n \{\
306.RS 4
307.\}
308.fam C
309.ps -1
310.nf
311.if t \{\
312.sp -1
313.\}
314.BB lightgray adjust-for-leading-newline
315.sp -1
316
317smb:// means all the workgroups
318.EB lightgray adjust-for-leading-newline
319.if t \{\
320.sp 1
321.\}
322.fi
323.fam
324.ps +1
325.if n \{\
326.RE
327.\}
328.PP
329.if n \{\
330.RS 4
331.\}
332.fam C
333.ps -1
334.nf
335.if t \{\
336.sp -1
337.\}
338.BB lightgray adjust-for-leading-newline
339.sp -1
340
341smb://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\&.
342.EB lightgray adjust-for-leading-newline
343.if t \{\
344.sp 1
345.\}
346.fi
347.fam
348.ps +1
349.if n \{\
350.RE
351.\}
352.SH "EXAMPLES"
353.sp
354.if n \{\
355.RS 4
356.\}
357.fam C
358.ps -1
359.nf
360.if t \{\
361.sp -1
362.\}
363.BB lightgray adjust-for-leading-newline
364.sp -1
365
366# Recursively download \'src\' directory
367smbget \-R smb://rhonwyn/jelmer/src
368# Download FreeBSD ISO and enable resuming
369smbget \-r smb://rhonwyn/isos/FreeBSD5\&.1\&.iso
370# Recursively download all ISOs
371smbget \-Rr smb://rhonwyn/isos
372# Backup my data on rhonwyn
373smbget \-Rr smb://rhonwyn/
374.EB lightgray adjust-for-leading-newline
375.if t \{\
376.sp 1
377.\}
378.fi
379.fam
380.ps +1
381.if n \{\
382.RE
383.\}
384.SH "BUGS"
385.PP
386Permission 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)\&.
387.SH "VERSION"
388.PP
389This man page is correct for version 3 of the Samba suite\&.
390.SH "AUTHOR"
391.PP
392The 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\&.
393.PP
394The smbget manpage was written by Jelmer Vernooij\&.
Note: See TracBrowser for help on using the repository browser.