docs/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 </refmeta>
   9
  10
  11 <refnamediv>
  12         <refname>smbget</refname>
  13         <refpurpose>wget-like utility for download files over SMB</refpurpose>
  14 </refnamediv>
  15
  16 <refsynopsisdiv>
  17         <cmdsynopsis>
  18                 <command>smbget</command>
  19                 <arg choice="opt">-a, --guest</arg>
  20                 <arg choice="opt">-r, --resume</arg>
  21                 <arg choice="opt">-R, --recursive</arg>
  22                 <arg choice="opt">-u, --username=STRING</arg>
  23                 <arg choice="opt">-p, --password=STRING</arg>
  24                 <arg choice="opt">-w, --workgroup=STRING</arg>
  25                 <arg choice="opt">-n, --nonprompt</arg>
  26                 <arg choice="opt">-d, --debuglevel=INT</arg>
  27                 <arg choice="opt">-D, --dots</arg>
  28                 <arg choice="opt">-P, --keep-permissions</arg>
  29                 <arg choice="opt">-o, --outputfile</arg>
  30                 <arg choice="opt">-f, --rcfile</arg>
  31                 <arg choice="opt">-q, --quiet</arg>
  32                 <arg choice="opt">-v, --verbose</arg>
  33                 <arg choice="opt">-b, --blocksize</arg>
  34                 <arg choice="opt">-?, --help</arg>
  35                 <arg choice="opt">--usage</arg>
  36                 <arg choice="req">smb://host/share/path/to/file</arg>
  37                 <arg choice="opt">smb://url2/</arg>
  38                 <arg choice="opt">...</arg>
  39         </cmdsynopsis>
  40 </refsynopsisdiv>
  41
  42 <refsect1>
  43         <title>DESCRIPTION</title>
  44
  45         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
  46         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  47
  48         <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.
  49         </para>
  50
  51         <para>
  52                 The files should be in the smb-URL standard, e.g. use smb://host/share/file
  53                 for the UNC path <emphasis>\\\\HOST\\SHARE\\file</emphasis>.
  54         </para>
  55 </refsect1>
  56
  57 <refsect1>
  58         <title>OPTIONS</title>
  59
  60         <varlistentry>
  61                 <term>-a, --guest</term>
  62                 <listitem><para>Work as user guest</para></listitem>
  63         </varlistentry>
  64
  65         <varlistentry>
  66                 <term>-r, --resume</term>
  67                 <listitem><para>Automatically resume aborted files</para></listitem>
  68         </varlistentry>
  69
  70         <varlistentry>
  71                 <term>-R, --recursive</term>
  72                 <listitem><para>Recursively download files</para></listitem>
  73         </varlistentry>
  74
  75         <varlistentry>
  76                 <term>-u, --username=STRING</term>
  77                 <listitem><para>Username to use</para></listitem>
  78         </varlistentry>
  79
  80         <varlistentry>
  81                 <term>-p, --password=STRING</term>
  82                 <listitem><para>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>-P, --keep-permissions</term>
 107                 <listitem><para>Set same permissions on local file as are set on remote file.</para></listitem>
 108         </varlistentry>
 109
 110         <varlistentry>
 111                 <term>-o, --outputfile</term>
 112                 <listitem><para>Write the file that is being download to the specified file. Can not be used together with -R.</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 overriden 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 </refsect1>
 145
 146 <refsect1>
 147         <title>SMB URLS</title>
 148
 149         <para> SMB URL's should be specified in the following format:</para>
 150
 151         <para><programlisting>
 152 smb://[[[domain;]user[:password@]]server[/share[/path[/file]]]]
 153 </programlisting></para>
 154
 155 <para><programlisting>
 156 smb:// means all the workgroups
 157 </programlisting></para>
 158
 159 <para><programlisting>
 160 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.
 161 </programlisting></para>
 162
 163 </refsect1>
 164
 165 <refsect1>
 166         <title>EXAMPLES</title>
 167
 168 <programlisting>
 169 # Recursively download 'src' directory
 170 smbget -R smb://rhonwyn/jelmer/src
 171 # Download FreeBSD ISO and enable resuming
 172 smbget -r smb://rhonwyn/isos/FreeBSD5.1.iso
 173 # Recursively download all ISOs
 174 smbget -Rr smb://rhonwyn/isos
 175 # Backup my data on rhonwyn
 176 smbget -Rr smb://rhonwyn/
 177 </programlisting>
 178
 179 </refsect1>
 180
 181 <refsect1>
 182         <title>BUGS</title>
 183
 184         <para>Permission denied is returned in some cases where the cause of the error is unknown
 185 (such as an illegally formatted smb:// url or trying to get a directory without -R
 186 turned on).</para>
 187 </refsect1>
 188
 189 <refsect1>
 190         <title>VERSION</title>
 191
 192         <para>This man page is correct for version 3.0 of
 193         the Samba suite.</para>
 194 </refsect1>
 195
 196 <refsect1>
 197         <title>AUTHOR</title>
 198
 199         <para>The original Samba software and related utilities
 200         were created by Andrew Tridgell. Samba is now developed
 201         by the Samba Team as an Open Source project similar
 202         to the way the Linux kernel is developed.</para>
 203
 204         <para>The smbget manpage was written by Jelmer Vernooij.</para>
 205
 206 </refsect1>
 207
 208 </refentry>