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