summaryrefslogtreecommitdiff
path: root/docs-xml/manpages-3/smbget.1.xml
diff options
context:
space:
mode:
Diffstat (limited to 'docs-xml/manpages-3/smbget.1.xml')
-rw-r--r--docs-xml/manpages-3/smbget.1.xml211
1 files changed, 211 insertions, 0 deletions
diff --git a/docs-xml/manpages-3/smbget.1.xml b/docs-xml/manpages-3/smbget.1.xml
new file mode 100644
index 0000000000..756ccb94b8
--- /dev/null
+++ b/docs-xml/manpages-3/smbget.1.xml
@@ -0,0 +1,211 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
+<refentry id="smbget.1">
+
+<refmeta>
+ <refentrytitle>smbget</refentrytitle>
+ <manvolnum>1</manvolnum>
+ <refmiscinfo class="source">Samba</refmiscinfo>
+ <refmiscinfo class="manual">User Commands</refmiscinfo>
+ <refmiscinfo class="version">3.2</refmiscinfo>
+</refmeta>
+
+
+<refnamediv>
+ <refname>smbget</refname>
+ <refpurpose>wget-like utility for download files over SMB</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+ <cmdsynopsis>
+ <command>smbget</command>
+ <arg choice="opt">-a, --guest</arg>
+ <arg choice="opt">-r, --resume</arg>
+ <arg choice="opt">-R, --recursive</arg>
+ <arg choice="opt">-u, --username=STRING</arg>
+ <arg choice="opt">-p, --password=STRING</arg>
+ <arg choice="opt">-w, --workgroup=STRING</arg>
+ <arg choice="opt">-n, --nonprompt</arg>
+ <arg choice="opt">-d, --debuglevel=INT</arg>
+ <arg choice="opt">-D, --dots</arg>
+ <arg choice="opt">-P, --keep-permissions</arg>
+ <arg choice="opt">-o, --outputfile</arg>
+ <arg choice="opt">-f, --rcfile</arg>
+ <arg choice="opt">-q, --quiet</arg>
+ <arg choice="opt">-v, --verbose</arg>
+ <arg choice="opt">-b, --blocksize</arg>
+ <arg choice="opt">-?, --help</arg>
+ <arg choice="opt">--usage</arg>
+ <arg choice="req">smb://host/share/path/to/file</arg>
+ <arg choice="opt">smb://url2/</arg>
+ <arg choice="opt">...</arg>
+ </cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1>
+ <title>DESCRIPTION</title>
+
+ <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
+ <manvolnum>7</manvolnum></citerefentry> suite.</para>
+
+ <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.
+ </para>
+
+ <para>
+ The files should be in the smb-URL standard, e.g. use smb://host/share/file
+ for the UNC path <emphasis>\\\\HOST\\SHARE\\file</emphasis>.
+ </para>
+</refsect1>
+
+<refsect1>
+ <title>OPTIONS</title>
+
+ <varlistentry>
+ <term>-a, --guest</term>
+ <listitem><para>Work as user guest</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>-r, --resume</term>
+ <listitem><para>Automatically resume aborted files</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>-R, --recursive</term>
+ <listitem><para>Recursively download files</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>-u, --username=STRING</term>
+ <listitem><para>Username to use</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>-p, --password=STRING</term>
+ <listitem><para>Password to use</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>-w, --workgroup=STRING</term>
+ <listitem><para>Workgroup to use (optional)</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>-n, --nonprompt</term>
+ <listitem><para>Don't ask anything (non-interactive)</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>-d, --debuglevel=INT</term>
+ <listitem><para>Debuglevel to use</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>-D, --dots</term>
+ <listitem><para>Show dots as progress indication</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>-P, --keep-permissions</term>
+ <listitem><para>Set same permissions on local file as are set on remote file.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>-o, --outputfile</term>
+ <listitem><para>Write the file that is being download to the specified file. Can not be used together with -R.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>-f, --rcfile</term>
+ <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>
+ </varlistentry>
+
+ <varlistentry>
+ <term>-q, --quiet</term>
+ <listitem><para>Be quiet</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>-v, --verbose</term>
+ <listitem><para>Be verbose</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>-b, --blocksize</term>
+ <listitem><para>Number of bytes to download in a block. Defaults to 64000.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>-?, --help</term>
+ <listitem><para>Show help message</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>--usage</term>
+ <listitem><para>Display brief usage message</para></listitem>
+ </varlistentry>
+</refsect1>
+
+<refsect1>
+ <title>SMB URLS</title>
+
+ <para> SMB URL's should be specified in the following format:</para>
+
+ <para><programlisting>
+smb://[[[domain;]user[:password@]]server[/share[/path[/file]]]]
+</programlisting></para>
+
+<para><programlisting>
+smb:// means all the workgroups
+</programlisting></para>
+
+<para><programlisting>
+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.
+</programlisting></para>
+
+</refsect1>
+
+<refsect1>
+ <title>EXAMPLES</title>
+
+<programlisting>
+# Recursively download 'src' directory
+smbget -R smb://rhonwyn/jelmer/src
+# Download FreeBSD ISO and enable resuming
+smbget -r smb://rhonwyn/isos/FreeBSD5.1.iso
+# Recursively download all ISOs
+smbget -Rr smb://rhonwyn/isos
+# Backup my data on rhonwyn
+smbget -Rr smb://rhonwyn/
+</programlisting>
+
+</refsect1>
+
+<refsect1>
+ <title>BUGS</title>
+
+ <para>Permission denied is returned in some cases where the cause of the error is unknown
+(such as an illegally formatted smb:// url or trying to get a directory without -R
+turned on).</para>
+</refsect1>
+
+<refsect1>
+ <title>VERSION</title>
+
+ <para>This man page is correct for version 3.0 of
+ the Samba suite.</para>
+</refsect1>
+
+<refsect1>
+ <title>AUTHOR</title>
+
+ <para>The original Samba software and related utilities
+ were created by Andrew Tridgell. Samba is now developed
+ by the Samba Team as an Open Source project similar
+ to the way the Linux kernel is developed.</para>
+
+ <para>The smbget manpage was written by Jelmer Vernooij.</para>
+
+</refsect1>
+
+</refentry>