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">4.2</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, --username=STRING</arg>
  26                 <arg choice="opt">-p, --password=STRING</arg>
  27                 <arg choice="opt">-w, --workgroup=STRING</arg>
  28                 <arg choice="opt">-n, --nonprompt</arg>
  29                 <arg choice="opt">-d, --debuglevel=INT</arg>
  30                 <arg choice="opt">-D, --dots</arg>
  31                 <arg choice="opt">-P, --keep-permissions</arg>
  32                 <arg choice="opt">-o, --outputfile</arg>
  33                 <arg choice="opt">-f, --rcfile</arg>
  34                 <arg choice="opt">-q, --quiet</arg>
  35                 <arg choice="opt">-v, --verbose</arg>
  36                 <arg choice="opt">-b, --blocksize</arg>
  37                 <arg choice="opt">-O, --stdout</arg>
  38                 <arg choice="opt">-U, --update</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, --username=STRING</term>
  82                 <listitem><para>Username to use</para></listitem>
  83         </varlistentry>
  84
  85         <varlistentry>
  86                 <term>-p, --password=STRING</term>
  87                 <listitem><para>Password to use</para></listitem>
  88         </varlistentry>
  89
  90         <varlistentry>
  91                 <term>-w, --workgroup=STRING</term>
  92                 <listitem><para>Workgroup to use (optional)</para></listitem>
  93         </varlistentry>
  94
  95         <varlistentry>
  96                 <term>-n, --nonprompt</term>
  97                 <listitem><para>Don't ask anything (non-interactive)</para></listitem>
  98         </varlistentry>
  99
 100         <varlistentry>
 101                 <term>-d, --debuglevel=INT</term>
 102                 <listitem><para>Debuglevel to use</para></listitem>
 103         </varlistentry>
 104
 105         <varlistentry>
 106                 <term>-D, --dots</term>
 107                 <listitem><para>Show dots as progress indication</para></listitem>
 108         </varlistentry>
 109
 110         <varlistentry>
 111                 <term>-P, --keep-permissions</term>
 112                 <listitem><para>Set same permissions on local file as are set on remote file.</para></listitem>
 113         </varlistentry>
 114
 115         <varlistentry>
 116                 <term>-o, --outputfile</term>
 117                 <listitem><para>Write the file that is being downloaded to the specified file. Can not be used together with -R.</para></listitem>
 118         </varlistentry>
 119
 120         <varlistentry>
 121                 <term>-O, --stdout</term>
 122                 <listitem><para>Write the file that is being downloaded to standard output.</para></listitem>
 123         </varlistentry>
 124
 125         <varlistentry>
 126                 <term>-f, --rcfile</term>
 127                 <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>
 128         </varlistentry>
 129
 130         <varlistentry>
 131                 <term>-q, --quiet</term>
 132                 <listitem><para>Be quiet</para></listitem>
 133         </varlistentry>
 134
 135         <varlistentry>
 136                 <term>-v, --verbose</term>
 137                 <listitem><para>Be verbose</para></listitem>
 138         </varlistentry>
 139
 140         <varlistentry>
 141                 <term>-b, --blocksize</term>
 142                 <listitem><para>Number of bytes to download in a block. Defaults to 64000.</para></listitem>
 143         </varlistentry>
 144
 145         <varlistentry>
 146                 <term>-?, --help</term>
 147                 <listitem><para>Show help message</para></listitem>
 148         </varlistentry>
 149
 150         <varlistentry>
 151                 <term>--usage</term>
 152                 <listitem><para>Display brief usage message</para></listitem>
 153         </varlistentry>
 154
 155         <varlistentry>
 156                 <term>-U, --update</term>
 157                 <listitem><para>Download only when remote file is newer than local file or local file is missing.</para></listitem>
 158         </varlistentry>
 159
 160         &stdarg.encrypt;
 161
 162 </refsect1>
 163
 164 <refsect1>
 165         <title>SMB URLS</title>
 166
 167         <para> SMB URL's should be specified in the following format:</para>
 168
 169         <para><programlisting>
 170 smb://[[[domain;]user[:password@]]server[/share[/path[/file]]]]
 171 </programlisting></para>
 172
 173 <para><programlisting>
 174 smb:// means all the workgroups
 175 </programlisting></para>
 176
 177 <para><programlisting>
 178 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.
 179 </programlisting></para>
 180
 181 </refsect1>
 182
 183 <refsect1>
 184         <title>EXAMPLES</title>
 185
 186 <programlisting>
 187 # Recursively download 'src' directory
 188 smbget -R smb://rhonwyn/jelmer/src
 189 # Download FreeBSD ISO and enable resuming
 190 smbget -r smb://rhonwyn/isos/FreeBSD5.1.iso
 191 # Recursively download all ISOs
 192 smbget -Rr smb://rhonwyn/isos
 193 # Backup my data on rhonwyn
 194 smbget -Rr smb://rhonwyn/
 195 </programlisting>
 196
 197 </refsect1>
 198
 199 <refsect1>
 200         <title>BUGS</title>
 201
 202         <para>Permission denied is returned in some cases where the cause of the error is unknown
 203 (such as an illegally formatted smb:// url or trying to get a directory without -R
 204 turned on).</para>
 205 </refsect1>
 206
 207 <refsect1>
 208         <title>VERSION</title>
 209
 210         <para>This man page is correct for version 3 of
 211         the Samba suite.</para>
 212 </refsect1>
 213
 214 <refsect1>
 215         <title>AUTHOR</title>
 216
 217         <para>The original Samba software and related utilities
 218         were created by Andrew Tridgell. Samba is now developed
 219         by the Samba Team as an Open Source project similar
 220         to the way the Linux kernel is developed.</para>
 221
 222         <para>The smbget manpage was written by Jelmer Vernooij.</para>
 223
 224 </refsect1>
 225
 226 </refentry>