summaryrefslogtreecommitdiff
path: root/docs/manpages/smbget.1.xml
blob: 7c4f2956a8fc5b9372d797582b7cc514ad8f1751 (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
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
<refentry id="smbget.1">

<refmeta>
	<refentrytitle>smbget</refentrytitle>
	<manvolnum>1</manvolnum>
</refmeta>


<refnamediv>
	<refname>smbget</refname>
	<refpurpose>wget-like utility for download files over SMB</refpurpose>
</refnamediv>

<refsynopsisdiv>
	<cmdsynopsis>
		<command>smbget</command>
		<arg choice="opt">-a, --guest</arg>
		<arg choice="opt">-r, --resume</arg>
		<arg choice="opt">-R, --recursive</arg>
		<arg choice="opt">-u, --username=STRING</arg>
		<arg choice="opt">-p, --password=STRING</arg>
		<arg choice="opt">-w, --workgroup=STRING</arg>
		<arg choice="opt">-n, --nonprompt</arg>
		<arg choice="opt">-d, --debuglevel=INT</arg>
		<arg choice="opt">-D, --dots</arg>
		<arg choice="opt">-P, --keep-permissions</arg>
		<arg choice="opt">-o, --outputfile</arg>
		<arg choice="opt">-f, --rcfile</arg>
		<arg choice="opt">-q, --quiet</arg>
		<arg choice="opt">-v, --verbose</arg>
		<arg choice="opt">-b, --blocksize</arg>
		<arg choice="opt">-?, --help</arg>
		<arg choice="opt">--usage</arg>
		<arg choice="req">smb://host/share/path/to/file</arg>
		<arg choice="opt">smb://url2/</arg>
		<arg choice="opt">...</arg>
	</cmdsynopsis>
</refsynopsisdiv>

<refsect1>
	<title>DESCRIPTION</title>

	<para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
	<manvolnum>7</manvolnum></citerefentry> suite.</para>

	<para>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. 
	</para>

	<para>
		The files should be in the smb-URL standard, e.g. use smb://host/share/file
		for the UNC path <emphasis>\\\\HOST\\SHARE\\file</emphasis>.
	</para>
</refsect1>

<refsect1>
	<title>OPTIONS</title>

	<varlistentry>
		<term>-a, --guest</term>
		<listitem><para>Work as user guest</para></listitem>
	</varlistentry>

	<varlistentry>
		<term>-r, --resume</term>
		<listitem><para>Automatically resume aborted files</para></listitem>
	</varlistentry>

	<varlistentry>
		<term>-R, --recursive</term>
		<listitem><para>Recursively download files</para></listitem>
	</varlistentry>

	<varlistentry>
		<term>-u, --username=STRING</term>
		<listitem><para>Username to use</para></listitem>
	</varlistentry>

	<varlistentry>
		<term>-p, --password=STRING</term>
		<listitem><para>Password to use</para></listitem>
	</varlistentry>

	<varlistentry>
		<term>-w, --workgroup=STRING</term>
		<listitem><para>Workgroup to use (optional)</para></listitem>
	</varlistentry>

	<varlistentry>
		<term>-n, --nonprompt</term>
		<listitem><para>Don't ask anything (non-interactive)</para></listitem>
	</varlistentry>

	<varlistentry>
		<term>-d, --debuglevel=INT</term>
		<listitem><para>Debuglevel to use</para></listitem>
	</varlistentry>

	<varlistentry>
		<term>-D, --dots</term>
		<listitem><para>Show dots as progress indication</para></listitem>
	</varlistentry>

	<varlistentry>
		<term>-P, --keep-permissions</term>
		<listitem><para>Set same permissions on local file as are set on remote file.</para></listitem>
	</varlistentry>

	<varlistentry>
		<term>-o, --outputfile</term>
		<listitem><para>Write the file that is being download to the specified file. Can not be used together with -R.</para></listitem>
	</varlistentry>

	<varlistentry>
		<term>-f, --rcfile</term>
		<listitem><para>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.</para></listitem>
	</varlistentry>

	<varlistentry>
		<term>-q, --quiet</term>
		<listitem><para>Be quiet</para></listitem>
	</varlistentry>

	<varlistentry>
		<term>-v, --verbose</term>
		<listitem><para>Be verbose</para></listitem>
	</varlistentry>

	<varlistentry>
		<term>-b, --blocksize</term>
		<listitem><para>Number of bytes to download in a block. Defaults to 64000.</para></listitem>
	</varlistentry>

	<varlistentry>
		<term>-?, --help</term>
		<listitem><para>Show help message</para></listitem>
	</varlistentry>

	<varlistentry>
		<term>--usage</term>
		<listitem><para>Display brief usage message</para></listitem>
	</varlistentry>
</refsect1>

<refsect1>
	<title>SMB URLS</title>

	<para> SMB URL's should be specified in the following format:</para>

	<para><programlisting>
smb://[[[domain;]user[:password@]]server[/share[/path[/file]]]]
</programlisting></para>

<para><programlisting>
smb:// means all the workgroups
</programlisting></para>

<para><programlisting>
smb://name/ means, if <replaceable>name</replaceable> is a workgroup, all the servers in this workgroup, or if <replaceable>name</replaceable> is a server, all the shares on this server.
</programlisting></para>

</refsect1>

<refsect1>
	<title>EXAMPLES</title>
	
<programlisting>
# Recursively download 'src' directory
smbget -R smb://rhonwyn/jelmer/src
# Download FreeBSD ISO and enable resuming
smbget -r smb://rhonwyn/isos/FreeBSD5.1.iso
# Recursively download all ISOs
smbget -Rr smb://rhonwyn/isos
# Backup my data on rhonwyn
smbget -Rr smb://rhonwyn/
</programlisting>

</refsect1>

<refsect1>
	<title>BUGS</title>

	<para>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).</para>
</refsect1>

<refsect1>
	<title>VERSION</title>

	<para>This man page is correct for version 3.0 of 
	the Samba suite.</para>
</refsect1>

<refsect1>
	<title>AUTHOR</title>
	
	<para>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.</para>

	<para>The smbget manpage was written by Jelmer Vernooij.</para>

</refsect1>

</refentry>