Author: sebb
Date: Tue Dec 12 15:51:33 2006
New Revision: 486421
URL: http://svn.apache.org/viewvc?view=rev&rev=486421
Log:
Documentation updates
Modified:
jakarta/jmeter/branches/rel-2-2/xdocs/usermanual/get-started.xml
Modified: jakarta/jmeter/branches/rel-2-2/xdocs/usermanual/get-started.xml
URL:
http://svn.apache.org/viewvc/jakarta/jmeter/branches/rel-2-2/xdocs/usermanual/get-started.xml?view=diff&rev=486421&r1=486420&r2=486421
==============================================================================
--- jakarta/jmeter/branches/rel-2-2/xdocs/usermanual/get-started.xml (original)
+++ jakarta/jmeter/branches/rel-2-2/xdocs/usermanual/get-started.xml Tue Dec 12
15:51:33 2006
@@ -19,7 +19,6 @@
<properties>
<title>User's Manual: Getting Started</title>
</properties>
-
<body>
<section name="2. Getting Started" anchor="get_started">
@@ -32,7 +31,7 @@
<p>
Other software that you may want to download:
<ul>
-<li><a href="http://www.beanshell.org/";>BeanShell</a></li>
+<li><a href="http://www.beanshell.org/";>BeanShell</a> - needed for the
BeanShell function and test elements</li>
<li><a href="http://java.sun.com/products/javabeans/glasgow/jaf.html";>Java
Activation Framework</a> - needed for JavaMail</li>
<li><a href="http://java.sun.com/products/javamail/index.jsp";>Java Mail</a> -
needed for mail visualiser and SOAP tests</li>
<li><a href="http://java.sun.com/products/jms/docs.html";>JMS</a> - for JMS
samplers</li>
@@ -58,14 +57,11 @@
<p>JMeter requires your computing environment meets some minimum
requirements.</p>
<subsection name="2.1.1 Java Version" anchor="java_versions">
-<p>JMeter requires a fully compliant JVM 1.3 or higher.
-We are making a strong effort currently to be compatible with the 1.3 JVM's,
though it is expected JMeter performs best with 1.4 or better.
+<p>JMeter requires a fully compliant JVM 1.4 or higher. Since 2.2 it no
longer supports Java 1.3.
</p>
<p>Because JMeter uses only standard Java APIs, please do not file bug reports
if your JRE fails to run
JMeter because of JRE implementation issues.</p>
<note>
-Java 1.3 does not include SSL (HTTPS) support - you'll need to download JSSE.
-Also, it does not perform as well as later Java versions.
Use the latest version of Java 1.4 or 1.5 for best results
</note>
</subsection>
@@ -88,7 +84,7 @@
<subsection name="2.2.1 Java Compiler" anchor="opt_compiler">
-<p>If you want to build the JMeter source or develop JMeter plugins, then you
will need a fully compliant JDK 1.3 or higher.</p>
+<p>If you want to build the JMeter source or develop JMeter plugins, then you
will need a fully compliant JDK 1.4 or higher.</p>
</subsection>
<subsection name="2.2.2 SAX XML Parser" anchor="opt_sax">
@@ -106,12 +102,12 @@
<subsection name="2.2.4 SSL Encryption" anchor="opt_ssl">
<p>To test a web server using SSL encryption (HTTPS), JMeter requires that an
-implementation of SSL be provided (such as Sun's <a
href="http://java.sun.com/products/jsse/index.html";>Java Secure Sockets
Extension -- JSSE</a>).
+implementation of SSL be provided, as is the case with Sun Java 1.4 and above.
+If your version of Java does not include SSL support, then it is possible to
add an external implementation.
Include the necessary encryption packages in JMeter's <a
href="#classpath">classpath</a>. Also, update <a
href="#configuring_jmeter">jmeter.properties</a>
-by registering the SSL Provider.</p>
+to register the SSL Provider.</p>
<p>There is also the <complink name="SSL Manager"/>, for greater control of
certificates.</p>
-<p>Note: if you are running JDK1.4, then you do not have to download JSSE
because Sun integrated it into JDK1.4 as a standard library.</p>
-<p>The JMeter proxy server (see below) does not support recording SSL
(https).</p>
+<note>The JMeter proxy server (see below) does not support recording SSL
(https).</note>
</subsection>
<subsection name="2.2.5 JDBC Driver" anchor="opt_jdbc">
@@ -123,44 +119,39 @@
<subsection name="2.2.6 Apache SOAP" anchor="opt_soap">
<p>Apache SOAP requires mail.jar and activation.jar. You need to download and
copy these two jar files to your jmeter/lib directory. Once the files are in
there, JMeter will automatically pick them up.</p>
</subsection>
+
+<subsection name="2.2.7 BeanShell" anchor="opt_beanshell">
+<p>To run the BeanShell function or any of the BeanSell test elements
(sampler, timer etc),
+ you need to download the beanshell jar from <a
href="http://www.beanshell.org/";>http://www.beanshell.org/</a> and copy the jar
file to the jmeter/lib directory, where JMeter will automatically pick it
up.</p>
+</subsection>
+
<note>
-See the <a href="#classpath">JMeter Classpath</a> section for details on
installing additional jars.
+See the <a href="#classpath">JMeter Classpath</a> section for more details on
installing additional jars.
</note>
</section>
<section name="2.3 Installation" anchor="install">
-<p>Installing JMeter is a snap. Specifics depend on which release file you
-downloaded.</p>
<p><b>Note: avoid installing JMeter in a path with spaces in the name.
This causes problems for remote testing.</b></p>
-<subsection name="2.3.1 Downloading the Latest Release"
anchor="download_release">
<p>We recommend that most users run the <a
href="http://jakarta.apache.org/site/downloads/index.html";>latest
release</a>.</p>
<p>To install a release build, simply unzip the zip/tar file into the directory
where you want JMeter to be installed. Provided that you have a JRE/JDK
correctly installed
and the JAVA_HOME environment variable set, there is nothing more for you to
do.</p>
-</subsection>
-<subsection name="2.3.2 Downloading Nightly Builds" anchor="download_nightly">
-<p>If you do not mind working with beta-quality software, then you can
download and run the <a
href="http://jakarta.apache.org/builds/jakarta-jmeter/nightly";>latest nightly
build</a>.</p>
-<p>To install a nightly build, unzip the _bin and _lib zip/tar files into the
same directory structure.
-Provided that you have a JRE/JDK correctly installed
-and the JAVA_HOME environment variable set, JMeter should be installed
successfully.</p>
-</subsection>
</section>
<section name="2.4 Running JMeter" anchor="running">
<br/>
<p>To run JMeter, run the jmeter.bat (for Windows) or jmeter (for Unix) file.
-JMeter must be started from the JMeter bin directory (where those files are
found).
-The jmeter.bat file attempts to change to the appropriate directory if it can.
</p>
<subsection name="2.4.1 JMeter's Classpath" anchor="classpath">
<p>JMeter automatically finds classes from jars in its /lib and /lib/ext
directories.
If you have developed new JMeter components,
then you should jar them and copy the jar into JMeter's /lib/ext directory.
JMeter will
-automatically find JMeter components in any jars found here.
+automatically find JMeter components in any jars found here.
+Support jars should be placed in the lib directory.
If you don't want to put the extension jars in the lib/ext directory,
then define the property <b>search_paths</b> in jmeter.properties.
Do not use lib/ext for utility jars; it is only intended for JMeter components.
@@ -248,16 +239,19 @@
[Which you should do anyway, to make it easier to detect
viruses and other nasties that pretend to be text files...]
</p>
<p>As well as recording errors, the jmeter.log file records
some information about the test run. For example:</p>
+<div overflow="scroll">
<pre>
10/17/2003 12:19:20 PM INFO - jmeter.JMeter: Version 1.9.20031002
10/17/2003 12:19:45 PM INFO - jmeter.gui.action.Load: Loading file:
c:\mytestfiles\BSH.jmx
10/17/2003 12:19:52 PM INFO - jmeter.engine.StandardJMeterEngine: Running the
test!
-10/17/2003 12:19:52 PM INFO - jmeter.engine.StandardJMeterEngine: Starting 1
threads for group BSH. Ramp up = 1.
+10/17/2003 12:19:52 PM INFO - jmeter.engine.StandardJMeterEngine:
+Starting 1 threads for group BSH. Ramp up = 1.
10/17/2003 12:19:52 PM INFO - jmeter.engine.StandardJMeterEngine: Continue on
error
10/17/2003 12:19:52 PM INFO - jmeter.threads.JMeterThread: Thread BSH1-1
started
10/17/2003 12:19:52 PM INFO - jmeter.threads.JMeterThread: Thread BSH1-1 is
done
10/17/2003 12:19:52 PM INFO - jmeter.engine.StandardJMeterEngine: Test has
ended
</pre>
+</div>
<p>The log file can be helpful in determining the cause of an error,
as JMeter does not interrupt a test to display an error dialogue.</p>
</subsection>
@@ -313,7 +307,7 @@
your own copy of the jmeter.properties and specify it in the command line.
</p>
<note>
- Note: since 2.1.2, you can define additional JMeter properties in the file
defined by the
+ Note: since 2.2, you can define additional JMeter properties in the file
defined by the
JMeter property <b>user.properties</b> which has the default value
<b>user.properties</b>.
The file will be automatically loaded if it is found in the current
directory.
Similarly, <b>system.properties</b> is used to update system properties.
@@ -322,7 +316,7 @@
<property name="ssl.provider">You can specify the class for your SSL
implementation. If you are using the JSSE from sun, then it is:<br/>
com.sun.net.ssl.internal.ssl.Provider. JMeter, by default, should
provide https support is you are
- using JDK1.4 or if you use JDK1.3 with the JSSE class jars in your
JMeter classpath.</property>
+ using JDK1.4.</property>
<property name="xml.parser">You can specify an implementation as your
XML
parser. The default value is:
org.apache.xerces.parsers.SAXParser</property>
<property name="remote_hosts">Comma-delimited list of remote JMeter hosts.
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
