define(MC_TITLE,webstone)
define(MC_DATE,98/05/14)
include(mc_html_head.h)
<!-- @(#) webstone.in 1.4@(#) -->
</UL><FONT SIZE=+1><STRONG>NAME</STRONG></FONT><UL>
webstone - run the WebStone benchmark from the command line
</UL><FONT SIZE=+1><STRONG>SYNOPSIS</STRONG></FONT><UL>
<STRONG>webstone</STRONG>
[ -gui | -help | -setup | -kill | -nogui | -genfiles | -silent
| -tail | -results ]
</UL><FONT SIZE=+1><STRONG>DESCRIPTION</STRONG></FONT><UL>
<P>
<STRONG>webstone</STRONG>
is a script that provides a command line interface for invoking any of
the programs that make up the WebStone benchmark.
<P>
The default action is to recursively invoke
<P>
<UL>
<TT>
webstone -nogui
</TT>
</UL>
to start a single benchmark run.
<P>
The first invocation should be
<STRONG>webstone -setup</STRONG>.
This prepares the Perl scripts so the GUI will work.  After this is done
the GUI is available to perform most other WebStone tasks.
<P>
Suggested order for command-line use:
<P>
<UL>
<LI>webstone -setup
<LI>webstone -genfiles
<LI>webstone -nogui
<LI>webstone -results
</UL>
<P>
Before doing "webstone -setup", read the man page for
<STRONG>runbench(1)</STRONG>
to learn how to configure the
<STRONG>conf/testbed</STRONG>
file.
</UL><FONT SIZE=+1><STRONG>OPTIONS</STRONG></FONT><UL>
<DL>
<DT><STRONG>-gui</STRONG><DD>
Invoke the graphical user interface.
<DT><STRONG>-help</STRONG><DD>
Display the
<STRONG>README.FIRST</STRONG>
file.
<DT><STRONG>-setup</STRONG><DD>
Prepare WebStone from source.  Call the
<STRONG>bin/gui-configure</STRONG>
shell script to modify the Perl scripts that make up the GUI so they can
find the Perl executable.  Then call
<STRONG>configure</STRONG>
and 
<STRONG>make</STRONG>
to compile and install the WebStone binaries.
<DT><STRONG>-kill</STRONG><DD>
Call
<STRONG>bin/killbench</STRONG>
to terminate WebStone processes on both the webmaster system and the
client systems.
<DT><STRONG>-nogui</STRONG><DD>
Invoke
<STRONG>bin/runbench</STRONG>
directly, without trying to start the GUI.
<DT><STRONG>-genfiles</STRONG><DD>
Create the data files to be used for the testing and copy them to
the Web server.
<DT><STRONG>-silent</STRONG><DD>
Same as
<STRONG>-nogui</STRONG>,
except that screen output is discarded.
<DT><STRONG>-tail</STRONG><DD>
Display the output currently being written to the
<STRONG>run</STRONG>
file by the active
<STRONG> webmaster</STRONG>
process.
<DT><STRONG>-results</STRONG><DD>
Display summaries of all results in
<STRONG>bin/runs</STRONG>,
using
<STRONG>bin/wscollect.wpl</STRONG>.
</DL>
</UL><FONT SIZE=+1><STRONG>FILES</STRONG></FONT><UL>
<DL>
<DT><STRONG>conf/testbed</STRONG><DD>
The configuration file used by
<STRONG>bin/runbench</STRONG>
to control how the next test run is to be invoked.
<DT><STRONG>conf/filelist</STRONG><DD>
The list of URLs and weights to be used for the benchmark run.
<DT><STRONG>conf/fileset</STRONG><DD>
The list of file names to be created on the server by "-genfiles".
<DT><STRONG>bin/*.wpl</STRONG><DD>
The Perl scripts that make up the WebStone GUI.  The special suffix
("WebStone Perl") is to make sure the script is run by the GUI's
own micro-server rather than by the browser.
<DT><STRONG>bin/runs/*</STRONG><DD>
Output directories, one per invocation of 
<STRONG>webmaster</STRONG>.
If the
<STRONG> testbed</STRONG>
is set up to do a series of runs, a directory is created for each run.
<DT><STRONG>bin/runs/*/config</STRONG><DD>
The configuration file that spells out the work to be done by each
client system.  Created by
<STRONG>runbench</STRONG>,
used by
<STRONG>webmaster</STRONG>.
</DL>
</UL><FONT SIZE=+1><STRONG>ENVIRONMENT</STRONG></FONT><UL>
The variables understood by
<STRONG>runbench</STRONG>
are usually set in the
<STRONG>conf/testbed</STRONG>
file.  Values exported from the user's execution environment override
the values in
<STRONG>conf/testbed</STRONG>.
</UL><FONT SIZE=+1><STRONG>AUTHOR</STRONG></FONT><UL>
include(copyright.h)
</UL><FONT SIZE=+1><STRONG>LIMITATIONS</STRONG></FONT><UL>
<P>
<STRONG>webstone -gui</STRONG> doesn't work on Windows NT.  The fix
depends on support for sockets from Perl, which has been problematic.
<P>
<STRONG>runbench</STRONG>
and
<STRONG>webmaster</STRONG>
should record the actual values of the parameters it uses, not
just the contents of
<STRONG>conf/testbed</STRONG>
and
<STRONG>bin/runs/*/config</STRONG>.
<P>
On NT, <STRONG>-genfiles</STRONG>
doesn't try to transfer the files to the server.
<P>
The
<STRONG>-genfiles</STRONG>
option should keep local copies of the data files if 
<STRONG>$RCP</STRONG>
is not set, and instruct the user to copy them to the server by hand.
<P>
The
<STRONG>-setup</STRONG>
option should do the right thing with a binary distribution.
<P>
There should be a mechanism for grouping sets of output directories
and for naming the groups.
</UL><FONT SIZE=+1><STRONG>SEE ALSO</STRONG></FONT><UL>
<A href=runbench.html>runbench(1)</A>,
<A href=webclient.html>webclient(1)</A>,
<A href=webmaster.html>webmaster(1)</A>,
<A href=webstonegui.html>webstonegui(1)<A>
include(mc_html_foot.h)