f5c2ebd5c84dfd85ba8b0ab87ee359667b6337de
[sfrench/samba-autobuild/.git] / docs-xml / manpages / smbget.1.xml
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
3 <refentry id="smbget.1">
4
5 <refmeta>
6         <refentrytitle>smbget</refentrytitle>
7         <manvolnum>1</manvolnum>
8         <refmiscinfo class="source">Samba</refmiscinfo>
9         <refmiscinfo class="manual">User Commands</refmiscinfo>
10         <refmiscinfo class="version">&doc.version;</refmiscinfo>
11 </refmeta>
12
13
14 <refnamediv>
15         <refname>smbget</refname>
16         <refpurpose>wget-like utility for download files over SMB</refpurpose>
17 </refnamediv>
18
19 <refsynopsisdiv>
20         <cmdsynopsis>
21                 <command>smbget</command>
22                 <arg choice="opt">-a, --guest</arg>
23                 <arg choice="opt">-r, --resume</arg>
24                 <arg choice="opt">-R, --recursive</arg>
25                 <arg choice="opt">-U, --user=STRING</arg>
26                 <arg choice="opt">-w, --workgroup=STRING</arg>
27                 <arg choice="opt">-n, --nonprompt</arg>
28                 <arg choice="opt">-d, --debuglevel=INT</arg>
29                 <arg choice="opt">-D, --dots</arg>
30                 <arg choice="opt">-o, --outputfile</arg>
31                 <arg choice="opt">-f, --rcfile</arg>
32                 <arg choice="opt">-q, --quiet</arg>
33                 <arg choice="opt">-v, --verbose</arg>
34                 <arg choice="opt">-b, --blocksize</arg>
35                 <arg choice="opt">-O, --stdout</arg>
36                 <arg choice="opt">-u, --update</arg>
37                 <arg choice="opt">-?, --help</arg>
38                 <arg choice="opt">--usage</arg>
39                 <arg choice="req">smb://host/share/path/to/file</arg>
40                 <arg choice="opt">smb://url2/</arg>
41                 <arg choice="opt">...</arg>
42         </cmdsynopsis>
43 </refsynopsisdiv>
44
45 <refsect1>
46         <title>DESCRIPTION</title>
47
48         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
49         <manvolnum>7</manvolnum></citerefentry> suite.</para>
50
51         <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. 
52         </para>
53
54         <para>
55                 The files should be in the smb-URL standard, e.g. use smb://host/share/file
56                 for the UNC path <emphasis>\\\\HOST\\SHARE\\file</emphasis>.
57         </para>
58 </refsect1>
59
60 <refsect1>
61         <title>OPTIONS</title>
62
63         <varlistentry>
64                 <term>-a, --guest</term>
65                 <listitem><para>Work as user guest</para></listitem>
66         </varlistentry>
67
68         <varlistentry>
69                 <term>-r, --resume</term>
70                 <listitem><para>Automatically resume aborted files</para></listitem>
71         </varlistentry>
72
73         <varlistentry>
74                 <term>-R, --recursive</term>
75                 <listitem><para>Recursively download files</para></listitem>
76         </varlistentry>
77
78         <varlistentry>
79                 <term> -U, --user=<replaceable>username[%password]</replaceable></term>
80                 <listitem><para>Username (and password) to use</para></listitem>
81         </varlistentry>
82
83         <varlistentry>
84                 <term>-w, --workgroup=STRING</term>
85                 <listitem><para>Workgroup to use (optional)</para></listitem>
86         </varlistentry>
87
88         <varlistentry>
89                 <term>-n, --nonprompt</term>
90                 <listitem><para>Don't ask anything (non-interactive)</para></listitem>
91         </varlistentry>
92
93         <varlistentry>
94                 <term>-d, --debuglevel=INT</term>
95                 <listitem><para>Debuglevel to use</para></listitem>
96         </varlistentry>
97
98         <varlistentry>
99                 <term>-D, --dots</term>
100                 <listitem><para>Show dots as progress indication</para></listitem>
101         </varlistentry>
102
103         <varlistentry>
104                 <term>-o, --outputfile</term>
105                 <listitem><para>Write the file that is being downloaded to the specified file. Can not be used together with -R.</para></listitem>
106         </varlistentry>
107
108         <varlistentry>
109                 <term>-O, --stdout</term>
110                 <listitem><para>Write the file that is being downloaded to standard output.</para></listitem>
111         </varlistentry>
112
113         <varlistentry>
114                 <term>-f, --rcfile</term>
115                 <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 overridden by the contents of the rcfile.</para></listitem>
116         </varlistentry>
117
118         <varlistentry>
119                 <term>-q, --quiet</term>
120                 <listitem><para>Be quiet</para></listitem>
121         </varlistentry>
122
123         <varlistentry>
124                 <term>-v, --verbose</term>
125                 <listitem><para>Be verbose</para></listitem>
126         </varlistentry>
127
128         <varlistentry>
129                 <term>-b, --blocksize</term>
130                 <listitem><para>Number of bytes to download in a block. Defaults to 64000.</para></listitem>
131         </varlistentry>
132
133         <varlistentry>
134                 <term>-?, --help</term>
135                 <listitem><para>Show help message</para></listitem>
136         </varlistentry>
137
138         <varlistentry>
139                 <term>--usage</term>
140                 <listitem><para>Display brief usage message</para></listitem>
141         </varlistentry>
142
143         <varlistentry>
144                 <term>-u, --update</term>
145                 <listitem><para>Download only when remote file is newer than local file or local file is missing.</para></listitem>
146         </varlistentry>
147
148         &stdarg.encrypt;
149
150 </refsect1>
151
152 <refsect1>
153         <title>SMB URLS</title>
154
155         <para> SMB URL's should be specified in the following format:</para>
156
157         <para><programlisting>
158 smb://[[[domain;]user[:password@]]server[/share[/path[/file]]]]
159 </programlisting></para>
160
161 <para><programlisting>
162 smb:// means all the workgroups
163 </programlisting></para>
164
165 <para><programlisting>
166 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.
167 </programlisting></para>
168
169 </refsect1>
170
171 <refsect1>
172         <title>EXAMPLES</title>
173         
174 <programlisting>
175 # Recursively download 'src' directory
176 smbget -R smb://rhonwyn/jelmer/src
177 # Download FreeBSD ISO and enable resuming
178 smbget -r smb://rhonwyn/isos/FreeBSD5.1.iso
179 # Recursively download all ISOs
180 smbget -Rr smb://rhonwyn/isos
181 # Backup my data on rhonwyn
182 smbget -Rr smb://rhonwyn/
183 </programlisting>
184
185 </refsect1>
186
187 <refsect1>
188         <title>BUGS</title>
189
190         <para>Permission denied is returned in some cases where the cause of the error is unknown 
191 (such as an illegally formatted smb:// url or trying to get a directory without -R 
192 turned on).</para>
193 </refsect1>
194
195 <refsect1>
196         <title>VERSION</title>
197
198         <para>This man page is correct for version &doc.version; of
199         the Samba suite.</para>
200 </refsect1>
201
202 <refsect1>
203         <title>AUTHOR</title>
204         
205         <para>The original Samba software and related utilities 
206         were created by Andrew Tridgell. Samba is now developed
207         by the Samba Team as an Open Source project similar 
208         to the way the Linux kernel is developed.</para>
209
210         <para>The smbget manpage was written by Jelmer Vernooij.</para>
211
212 </refsect1>
213
214 </refentry>