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