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">--recursive</arg>
  25                 <arg choice="opt">-D, --dots</arg>
  26                 <arg choice="opt">-o, --outputfile</arg>
  27                 <arg choice="opt">-q, --quiet</arg>
  28                 <arg choice="opt">-v, --verbose</arg>
  29                 <arg choice="opt">-b, --blocksize</arg>
  30                 <arg choice="opt">-O, --stdout</arg>
  31                 <arg choice="opt">-u, --update</arg>
  32                 <arg choice="opt">-e, --encrypt</arg>
  33                 <arg choice="opt">--limit-rate=INT</arg>
  34                 <arg choice="opt">-?|--help</arg>
  35                 <arg choice="opt">--usage</arg>
  36                 <arg choice="opt">-d|--debuglevel=DEBUGLEVEL</arg>
  37                 <arg choice="opt">--debug-stdout</arg>
  38                 <arg choice="opt">-s|--configfile=CONFIGFILE</arg>
  39                 <arg choice="opt">--option=name=value</arg>
  40                 <arg choice="opt">-l|--log-basename=LOGFILEBASE</arg>
  41                 <arg choice="opt">--leak-report</arg>
  42                 <arg choice="opt">--leak-report-full</arg>
  43                 <arg choice="opt">-R|--name-resolve=NAME-RESOLVE-ORDER</arg>
  44                 <arg choice="opt">-O|--socket-options=SOCKETOPTIONS</arg>
  45                 <arg choice="opt">-m|--max-protocol=MAXPROTOCOL</arg>
  46                 <arg choice="opt">-n|--netbiosname=NETBIOSNAME</arg>
  47                 <arg choice="opt">--netbios-scope=SCOPE</arg>
  48                 <arg choice="opt">-W|--workgroup=WORKGROUP</arg>
  49                 <arg choice="opt">--realm=REALM</arg>
  50                 <arg choice="opt">-U|--user=[DOMAIN/]USERNAME%[PASSWORD]</arg>
  51                 <arg choice="opt">-N|--no-pass</arg>
  52                 <arg choice="opt">--password=STRING</arg>
  53                 <arg choice="opt">--pw-nt-hash</arg>
  54                 <arg choice="opt">-A|--authentication-file=FILE</arg>
  55                 <arg choice="opt">-P|--machine-pass</arg>
  56                 <arg choice="opt">--simple-bind-dn=DN</arg>
  57                 <arg choice="opt">--use-kerberos=desired|required|off</arg>
  58                 <arg choice="opt">--use-krb5-ccache=CCACHE</arg>
  59                 <arg choice="opt">--use-winbind-ccache</arg>
  60                 <arg choice="opt">--client-protection=sign|encrypt|off</arg>
  61                 <arg choice="opt">-V|--version</arg>
  62                 <arg choice="req">smb://host/share/path/to/file</arg>
  63                 <arg choice="opt">smb://url2/</arg>
  64                 <arg choice="opt">...</arg>
  65         </cmdsynopsis>
  66 </refsynopsisdiv>
  67
  68 <refsect1>
  69         <title>DESCRIPTION</title>
  70
  71         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
  72         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  73
  74         <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.
  75         </para>
  76
  77         <para>
  78                 The files should be in the smb-URL standard, e.g. use smb://host/share/file
  79                 for the UNC path <emphasis>\\\\HOST\\SHARE\\file</emphasis>.
  80         </para>
  81 </refsect1>
  82
  83 <refsect1>
  84         <title>OPTIONS</title>
  85
  86         <varlistentry>
  87                 <term>-a, --guest</term>
  88                 <listitem><para>Work as user guest</para></listitem>
  89         </varlistentry>
  90
  91         <varlistentry>
  92                 <term>-r, --resume</term>
  93                 <listitem><para>Automatically resume aborted files</para></listitem>
  94         </varlistentry>
  95
  96         <varlistentry>
  97                 <term>--recursive</term>
  98                 <listitem><para>Recursively download files</para></listitem>
  99         </varlistentry>
 100
 101         <varlistentry>
 102                 <term>-D, --dots</term>
 103                 <listitem><para>Show dots as progress indication</para></listitem>
 104         </varlistentry>
 105
 106         <varlistentry>
 107                 <term>-o, --outputfile</term>
 108                 <listitem><para>Write the file that is being downloaded to the specified file. Can not be used together with -R.</para></listitem>
 109         </varlistentry>
 110
 111         <varlistentry>
 112                 <term>--stdout</term>
 113                 <listitem><para>Write the file that is being downloaded to standard output.</para></listitem>
 114         </varlistentry>
 115
 116         <varlistentry>
 117                 <term>-q, --quiet</term>
 118                 <listitem><para>Be quiet</para></listitem>
 119         </varlistentry>
 120
 121         <varlistentry>
 122                 <term>-v, --verbose</term>
 123                 <listitem><para>Be verbose</para></listitem>
 124         </varlistentry>
 125
 126         <varlistentry>
 127                 <term>-b, --blocksize</term>
 128                 <listitem><para>Number of bytes to download in a block. Defaults to 64000.</para></listitem>
 129         </varlistentry>
 130
 131         <varlistentry>
 132                 <term>-u, --update</term>
 133                 <listitem><para>Download only when remote file is newer than local file or local file is missing.</para></listitem>
 134         </varlistentry>
 135
 136         <varlistentry>
 137         <term>-e, --encrypt</term>
 138                 <listitem><para>Enable SMB encryption.</para></listitem>
 139         </varlistentry>
 140
 141         <varlistentry>
 142         <term>--limit-rate=INT</term>
 143                 <listitem><para>Limit download rate by this many KB/s.</para></listitem>
 144         </varlistentry>
 145
 146                 &popt.autohelp;
 147                 &cmdline.common.samba.client;
 148                 &cmdline.common.connection;
 149                 &cmdline.common.credentials;
 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 --recursive smb://rhonwyn/jelmer/src
 177 # Download FreeBSD ISO and enable resuming
 178 smbget --resume smb://rhonwyn/isos/FreeBSD5.1.iso
 179 # Recursively download all ISOs
 180 smbget --recursive --resume smb://rhonwyn/isos
 181 # Backup my data on rhonwyn
 182 smbget --recursive -resume 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 --resursive
 192 turned on).</para>
 193 </refsect1>
 194
 195 <refsect1>
 196         <title>VERSION</title>
 197
 198         <para>This man page is part of 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>