Initial import
[samba] / docs / manpages / smbget.1
diff --git a/docs/manpages/smbget.1 b/docs/manpages/smbget.1
new file mode 100644 (file)
index 0000000..b667528
--- /dev/null
@@ -0,0 +1,171 @@
+.\"Generated by db2man.xsl. Don't modify this, modify the source.
+.de Sh \" Subsection
+.br
+.if t .Sp
+.ne 5
+.PP
+\fB\\$1\fR
+.PP
+..
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Ip \" List item
+.br
+.ie \\n(.$>=3 .ne \\$3
+.el .ne 3
+.IP "\\$1" \\$2
+..
+.TH "SMBGET" 1 "" "" ""
+.SH NAME
+smbget \- wget-like utility for download files over SMB
+.SH "SYNOPSIS"
+.ad l
+.hy 0
+.HP 7
+\fBsmbget\fR [\-a,\ \-\-guest] [\-r,\ \-\-resume] [\-R,\ \-\-recursive] [\-u,\ \-\-username=STRING] [\-p,\ \-\-password=STRING] [\-w,\ \-\-workgroup=STRING] [\-n,\ \-\-nonprompt] [\-d,\ \-\-debuglevel=INT] [\-D,\ \-\-dots] [\-P,\ \-\-keep\-permissions] [\-o,\ \-\-outputfile] [\-f,\ \-\-rcfile] [\-q,\ \-\-quiet] [\-v,\ \-\-verbose] [\-b,\ \-\-blocksize] [\-?,\ \-\-help] [\-\-usage] {smb://host/share/path/to/file} [smb://url2/] [\&.\&.\&.]
+.ad
+.hy
+
+.SH "DESCRIPTION"
+
+.PP
+This tool is part of the \fBsamba\fR(7) suite\&.
+
+.PP
+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\&.
+
+.PP
+The files should be in the smb\-URL standard, e\&.g\&. use smb://host/share/file for the UNC path \fB\\\\\\\\HOST\\\\SHARE\\\\file\fR\&.
+
+.SH "OPTIONS"
+
+.TP
+\-a, \-\-guest
+Work as user guest
+
+.TP
+\-r, \-\-resume
+Automatically resume aborted files
+
+.TP
+\-R, \-\-recursive
+Recursively download files
+
+.TP
+\-u, \-\-username=STRING
+Username to use
+
+.TP
+\-p, \-\-password=STRING
+Password to use
+
+.TP
+\-w, \-\-workgroup=STRING
+Workgroup to use (optional)
+
+.TP
+\-n, \-\-nonprompt
+Don't ask anything (non\-interactive)
+
+.TP
+\-d, \-\-debuglevel=INT
+Debuglevel to use
+
+.TP
+\-D, \-\-dots
+Show dots as progress indication
+
+.TP
+\-P, \-\-keep\-permissions
+Set same permissions on local file as are set on remote file\&.
+
+.TP
+\-o, \-\-outputfile
+Write the file that is being download to the specified file\&. Can not be used together with \-R\&.
+
+.TP
+\-f, \-\-rcfile
+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\&.
+
+.TP
+\-q, \-\-quiet
+Be quiet
+
+.TP
+\-v, \-\-verbose
+Be verbose
+
+.TP
+\-b, \-\-blocksize
+Number of bytes to download in a block\&. Defaults to 64000\&.
+
+.TP
+\-?, \-\-help
+Show help message
+
+.TP
+\-\-usage
+Display brief usage message
+
+.SH "SMB URLS"
+
+.PP
+SMB URL's should be specified in the following format:
+
+.PP
+
+.nf
+
+smb://[[[domain;]user[:password@]]server[/share[/path[/file]]]]
+.fi
+
+
+.PP
+
+.nf
+
+smb:// means all the workgroups
+.fi
+
+
+.PP
+
+.nf
+
+smb://name/ means, if \fIname\fR is a workgroup, all the servers in this workgroup, or if \fIname\fR is a server, all the shares on this server\&.
+.fi
+
+
+.SH "EXAMPLES"
+.nf
+
+# 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/
+.fi
+
+.SH "BUGS"
+
+.PP
+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)\&.
+
+.SH "VERSION"
+
+.PP
+This man page is correct for version 3\&.0 of the Samba suite\&.
+
+.SH "AUTHOR"
+
+.PP
+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\&.
+
+.PP
+The smbget manpage was written by Jelmer Vernooij\&.
+