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