mailto(samba-bugs@samba.org) 

manpage(xfertest htmlcommand((1)))(1)(15 Jul 1998)(Samba)(SAMBA)

label(NAME)
manpagename(xfertest)(shell script to test samba transfer speed)

label(SYNOPSIS)
manpagesynopsis()
bf(xfertest) link(-s)(minuss) |  link(-f)(minusf) | link(-r)(munusr) | link(-n)(minusn) [link(-v)(minusv) link(-d)(minusd)] host file

label(DESCRIPTION)
manpagedescription()

This program is a contributed part of the bf(Samba) suite.

bf(xfertest) is a shell script used to test file-transfer speed of Samba's 
smbclient(1) against ftp, rcp and, indirectly, nfs.

The program copies a file to and from a host using one of the
four protocols, and reports the protocol, whether it was get or put,
the file size, time required and speed in KB/Sec, for the last five 
out of six transfers.

It makes the transfers to and from the local /tmp filesystem in
each case, to reduce local bias.

label(OPTIONS)
manpageoptions()

startdit()

label(minuss)
dit(bf(-s host file)) means to use smbclient.

The host in this case is a Samba or Microsoft server and 
share, specified as //<hostname>/<sharename>.  The file
will be obtained from the topmost directory of that service.
The user's password will be requested, kept in memory
breifly and then discarded.

label(minusd)
dit(bf(-d host file)) means to use ftp.

The host will be a machine-name, and the file will be
obtained from the top directory of the user's account
on that machine.  The user's password will be requested,
stored briefly in the user's .netrc, and then deleted.
The .netrc will be restored after the run.

label(minusr)
dit(bf(-r host file)) means to use rcp.

The host will be a machine-name that the user can copy
files to and from using rcp, and the file will be
obtained from the top directory of the user's account
on that machine.  

label(minusn)
dit(bf(-n host file)) means to use nfs.

As nfs is only used indirectly, the test is done using cp.
The file must be a file visible on the local machine, but
actually residing on a remote nfs server.  The host arguement
is required, but only for reporting purposes: it's ignored.

label(minusv)
dit(bf(-v)) Verbose mode.

This option produces extra information on stderr,
so the user can see what's
happening. The report is still produced on stdout, and can be
redirected to a file whcih will not contain any of the other
information.


label(minusd)
dit(bf(-d)) turns on debugging.

This produces much more information, including all lines sent by the
copy/timing program. These all begin with a "#" character, and may
appear on either stderr, stdout or both, depending on the underlying
transfer program.

enddit()

label(CAVEATS)
manpagesection(CAVEATS)

The temporary storage of passwords in the .netrc file for ftp is a
security risk.

label(VERSION)
manpagesection(VERSION)

This man page is correct for version 2.0 of the Samba suite.

label(SEEALSO)
manpageseealso()

bf(nfs(1)), bf(rcp(1)),
url(smbclient(1)))(smclient.1.html)

label(AUTHOR)
manpageauthor()

The original Samba software and related utilities were created by
Andrew Tridgell email(samba-bugs@samba.org). Samba is now developed
by the Samba Team as an Open Source project similar to the way the
Linux kernel is developed.

Ricky Poulten email(poultenr@logica.co.uk) wrote the tar extension and
this man page. The bf(smbtar) script was heavily rewritten and
improved by Martin Kraemer email(Martin.Kraemer@mch.sni.de). Many
thanks to everyone who suggested extensions, improvements, bug fixes,
etc. The man page sources were converted to YODL format (another
excellent piece of Open Source software available at
url(bf(ftp://ftp.icce.rug.nl/pub/unix/))(ftp://ftp.icce.rug.nl/pub/unix/))
and updated for the Samba2.0 release by Jeremy Allison,
email(samba-bugs@samba.org).
 
See url(bf(samba (7)))(samba.7.html) to find out how to get a full
list of contributors and details on how to submit bug reports,
comments etc.