.\" auto-generated by docbook2man-spec from docbook-utils package
.TH "TSUNG" "1" "January 2004" "" ""
.SH NAME
tsung \- A distributed multi-protocol load testing tool.
.SH SYNOPSIS
.sp
\fBtsung\fR [ \fB-f configuration file\fR ]  [ \fB-l log dir\fR ]  [ \fB-m filename\fR ]  [ \fB-r command\fR ]  [ \fB-X directory\fR ]  [ \fB-w delay\fR ]  [ \fB-L lifetime\fR ]  [ \fB-s\fR ]  [ \fB-n\fR ]  [ \fB-k\fR ]  [ \fB-v\fR ]  [ \fB-6\fR ]  [ \fB-h\fR ]  [ \fBstart|stop|debug|status\fR ] 
.SH "DESCRIPTION"
.PP
\fBtsung\fR is a distributed load testing
tool. It is protocol-independent and can currently be used to
stress and benchmark HTTP, WebDAV, LDAP, PostgreSQL, MySQL and Jabber/XMPP servers.
.PP
It simulates user behaviour using an XML description file,
reports many measurements in real time (statistics can be
customized with transactions, and graphics generated using
gnuplot). 
.PP
For HTTP, it supports 1.0 and 1.1, has a proxy mode to
record sessions, supports GET and POST methods, Cookies, and Basic
WWW-authentication. It also has support for SSL. 
.PP
Several config examples can be found in
\fI/usr/share/doc/tsung/examples/\fR\&.
.TP
\fBstart\fR
start tsung load testing
.TP
\fBdebug\fR
start tsung with an interactive erlang shell
.TP
\fBstop\fR
stop tsung
.TP
\fBstatus\fR
print current status of a running instance of tsung (must be run on the controller host)
.SH "MANUAL"
.PP
A manual should be available at
\fI/usr/share/doc/tsung/user_manual.html\fR\&. It
is also available online at
.sp
.RS
.sp
.nf
http://tsung.erlang-projects.org/user_manual.html
.sp
.fi
.RE
.sp
.SH "OPTIONS"
.TP
\fB-f filename\fR
specifies the configuration file to use. The default
file name is \fI~/.tsung/tsung.xml\fR\&. Use - for standard input
.TP
\fB-l logdir\fR
Specifies the log directory to use. The default log dir name is \fI~/.tsung/log/YYYYMMDD-HHMM/\fR
.TP
\fB-m monitoring_file\fR
Specifies the monitoring log file name to use. The
default log file name
is \fItsung.log\fR\&. Use - for standard output
.TP
\fB-r command\fR
Specifies an alternative to ssh (rsh for ex.) for starting a slave node on a remote host
.TP
\fB-i id\fR
set controller id (default is empty). Needed to start
several controllers on the same host.
.TP
\fB-F\fR
Use long names for erlang nodes (FQDN)
.TP
\fB-s\fR
Enable erlang smp on client nodes
.TP
\fB-p\fR
set maximum erlang processes per vm (default is 250000)
.TP
\fB-X directory\fR
add additional erlang load paths (multiple -X arguments allowed)
.TP
\fB-L lifetime\fR
SSL session lifetime in seconds (600 sec by default)
.TP
\fB-w delay\fR
warmup delay in seconds (1 sec by default)
.TP
\fB-v\fR
Show version
.TP
\fB-n\fR
disable web GUI 
.TP
\fB-k\fR
keep web GUI (and controller) alive after the test has finished
.TP
\fB-6\fR
Use IPv6 for tsung internal communications
.TP
\fB-h\fR
Show usage
.SH "BUGS"
.PP
Please reports bugs to the mailing list
<tsung-users@process-one.net>, see
.sp
.RS
.sp
.nf
https://lists.process-one.net/mailman/listinfo/tsung-users
.sp
.fi
.RE
.sp
for
archives. You can also use the issue tracker 
.sp
.RS
.sp
.nf
https://github.com/processone/tsung/issues
.sp
.fi
.RE
.sp
.SH "SEE ALSO"
.PP
\fBerlang\fR(3)
.SH "AUTHORS"
.PP
\fBTsung\fR is written by Nicolas Niclausse 
<nicolas@niclux.org>\&. Contributors list
is available in
\fI/usr/share/doc/tsung/CONTRIBUTORS\fR