mstover1 02/02/19 18:51:54
Modified: xdocs/usermanual get-started.xml index.xml intro.xml
Log:
updating documentation
Revision Changes Path
1.2 +91 -12 jakarta-jmeter/xdocs/usermanual/get-started.xml
Index: get-started.xml
===================================================================
RCS file: /home/cvs/jakarta-jmeter/xdocs/usermanual/get-started.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- get-started.xml 28 Oct 2001 13:22:50 -0000 1.1
+++ get-started.xml 20 Feb 2002 02:51:54 -0000 1.2
@@ -10,35 +10,114 @@
<section name="2. Getting Started">
</section>
+<a name="requirements"/>
<section name="2.1 Requirements"></section>
+<a name="java_versions"/>
<section name="2.1.1 Java Versions">
-<p>JMeter runs in JDK1.2 and higher. However, there is a rather <a href="">nasty
bug in JDK 1.3</a> that may affect your testing.</p>
+<p>JMeter runs in JDK1.2 and higher. </p>
</section>
-<section name="2.1.5 JDBC Driver (for testing databases)">
-<p>If you intend to perform database testing, you will need a JDBC driver.</p>
+<a name="os"/>
+<section name="2.1.2 Operating Systems">
+<p>JMeter has been tested and works under Unix (Solaris, Linux, etc) and Windows
(98,
+NT, 2000). JMeter is a 100% Java application and should run correctly on any system
+that has a compliant Java implementation.</p>
</section>
-<section name="2.1.6 SAX XML Parser">
+<a name="jdbc"/>
+<section name="2.1.3 JDBC Driver (for testing databases)">
+<p>If you intend to perform database testing, you will need a JDBC driver
+appropriate for your database. You will need to <a href="classpath">add the
classes</a> for your
+driver to JMeter's classpath.</p>
</section>
-<section name="2.2 Installation">
+<a name="xml"/>
+<section name="2.1.4 SAX XML Parser">
+<p>JMeter comes packaged with Apache's Xerces XML parser. There is no need to use
any
+other XML parser, but, it is possible to use any SAX2 compliant XML parser. To do
+so, include the classes for the third-party parser in <a href="classpath">JMeter's
classpath</a>,
+and update the <a href="configuring_jmeter.html">jmeter.properties</a> file with
the full classname of the parser
+implementation.
+</p>
</section>
-<section name="2.2.1 Downloading the Latest Release">
-<p>We recommend that most users run the latest stable release instead of a nightly
build.</p>
+<a name="ssl"/>
+<section name="2.1.5 SSL Encryption Support">
+<p>To test a web server using SSL encryption (https), JMeter requires that an
+implementation of SSL be provided (such as Sun's JSSE). JMeter will run fine
without
+these files, but cannot be used to test an HTTPS site unless such files are included
+in <a href="classpath">JMeter's classpath</a>. In addition, <a
href="configuring_jmeter.html">jmeter.properties</a>
+must be configured correctly to register the SSL Provider.</p>
</section>
-<section name="2.2.2 Downloading Nightly Builds">
-<p>If you do not mind working with beta-quality software, then you can download and
run the <a href="">latest nightly build</a>. </p>
+<a name="mail"/>
+<section name="2.1.6 Email Support">
+<p>JMeter has limited Email capabilities (it can send email based on test results).
+To enable this support, it is necessary to add Sun's JavaMail packages to <a
href="classpath">JMeter's classpath</a>.
+</p>
+</section>
+
+<a name="install"/>
+<section name="2.2 Installation">
</section>
-<section name="2.2.3 UNIX Instructions">
-<p></p>
+<a name="download_latest"/>
+<section name="2.2.1 Downloading the Latest Release">
+<p>We recommend that most users run the latest stable release instead of a nightly
build.
+To install from a release build, simply unzip the zip/tar file into the directory
+where you want JMeter to be installed. Provided you have a JDK correctly installed,
+and JAVA_HOME environment variable set, there is nothing more to do.</p>
</section>
-<section name="2.2.4 MS-Windows Instructions">
+<a name="download_nightly"/>
+<section name="2.2.2 Downloading Nightly Builds">
+<p>If you do not mind working with beta-quality software, then you can download and
run the
+latest nightly build. To install from a nightly build, it is necessary to compile
and
+build JMeter. To do so, unzip the zip/tar file into the directory where you want
JMeter
+to be installed. Open a shell or command prompt and change directory to JMeter's
top
+level directory. Type "build install" to install JMeter. Provided your system has
+a JDK correctly installed and the JAVA_HOME environment variable set, JMeter should
+install correctly.</p>
+</section>
+
+<a name="run"/>
+<section name="2.3 Running JMeter">
+<p>To run JMeter, double-click on the jmeter.bat(Windows)/jmeter(Unix) file. For
most
+systems this should be sufficient. For some systems, it necessary to invoke this
+file directly in a shell/command prompt (rather than double-clicking with the
mouse). </p>
+
+<p>If JMeter does not start correctly, it may be because your system does not
support
+the commands contained in jmeter.bat/jmeter (ie Windows 98 systems). In this case,
+ you will need to rewrite the jmeter.bat/jmeter file to explicitly include all
+ jar files found in JMeter's lib/ directory in JMeter's classpath.</p>
+</section>
+
+<a name="classpath"/>
+<section name="2.3.1 JMeter's Classpath">
+<p>The jmeter.bat/jmeter file automatically adds all jar files found in JMeter's
lib/
+directory. Because of this, if you need to add your own or third party jar files to
+JMeter's classpath, it is only required that you copy them into JMeter's lib/
+directory. </p>
+</section>
+
+<a name="proxy_server"/>
+<section name="2.3.2 Using a Proxy Server">
+<p>If you are testing a system behind a firewall, you may need to tell JMeter to
+use a proxy server. To do so, use the jmeter.bat/jmeter file from a command line
to start
+JMeter, and include two options:<br/>
+-h [proxy server hostname or ip address]<br/>
+-p [proxy server port]<br/>
+<b>eg.</b>: jmeter -h my.proxy.server -p 8000
+</p>
+</section>
+
+<a name="cl_only"/>
+<section name="2.3.4 Non-GUI Mode">
+<p>To run JMeter without the GUI, invoke the nongui.bat/nongui.sh files from the
+command line, with the -o option (-o [name of *.jmx file that describes entire test
script]).<br/>
+<b>eg:</b> nongui -o my_test.jmx -h [proxy server] -p [proxy port]
+</p>
</section>
</body>
1.4 +98 -101 jakarta-jmeter/xdocs/usermanual/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-jmeter/xdocs/usermanual/index.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- index.xml 19 Nov 2001 14:11:43 -0000 1.3
+++ index.xml 20 Feb 2002 02:51:54 -0000 1.4
@@ -10,126 +10,123 @@
<ul>
<li><a href="intro.html">1. Introduction</a></li>
<ul>
- <li><a href="intro.html#history">1.1 History</a></li>
- <li><a href="intro.html#future">1.2 The Future</a></li>
+ <li><a href="intro.html#history">1.1 History</a></li>
+ <li><a href="intro.html#future">1.2 The Future</a></li>
</ul>
<li><a href="get-started.html">2. Getting Started</a></li>
<ul>
- <li><a href="get-started.html#requirements">2.1 Requirements</a></li>
- <ul>
- <li><a href="get-started.html#java_versions">2.1.1 Java Versions<!--: JDK1.2
and higher (has not been tested w/JDK 1.4)--></a></li>
- <li><a href="get-started.html#os">2.1.2 Operating Systems<!--: any (has been
tested on Windows 98, ...)--></a></li>
- <li><a href="get-started.html#jdbc">2.1.3 JDBC Driver (for testing
databases)</a></li>
- <li><a href="get-started.html#xml">2.1.4 SAX XML Parser</a></li>
- </ul>
- <li><a href="get-started.html#install">2.2 Installation<!--(includes
configuration)--></a></li>
- <ul>
- <li><a href="get-started.html#download_latest">2.2.1 Downloading the Latest
Release</a></li>
- <li><a href="get-started.html#download_nightly">2.2.2 Downloading Nightly
Builds<!-- (include build instructions)--></a></li>
- <li><a href="get-started.html#unix">2.2.3 UNIX Instructions</a></li>
- <li><a href="get-started.html#windows">2.2.4 MS-Windows Instructions</a></li>
- </ul>
+ <li><a href="get-started.html#requirements">2.1 Requirements</a></li>
+ <ul>
+ <li><a href="get-started.html#java_versions">2.1.1 Java Versions<!--:
JDK1.2 and higher (has not been tested w/JDK 1.4)--></a></li>
+ <li><a href="get-started.html#os">2.1.2 Operating Systems<!--: any
(has been tested on Windows 98, ...)--></a></li>
+ <li><a href="get-started.html#jdbc">2.1.3 JDBC Driver (for testing
databases)</a></li>
+ <li><a href="get-started.html#xml">2.1.4 SAX XML Parser</a></li>
+ <li><a href="get-started.html#ssl">2.1.5 SSL Encryption
Support</a></li>
+ <li><a href="get-started.html#mail">2.1.6 Email Support</a></li>
+ </ul>
+ <li><a href="get-started.html#install">2.2 Installation<!--(includes
configuration)--></a></li>
+ <ul>
+ <li><a href="get-started.html#download_latest">2.2.1 Downloading the
Latest Release</a></li>
+ <li><a href="get-started.html#download_nightly">2.2.2 Downloading
Nightly Builds<!-- (include build instructions)--></a></li>
+ </ul>
+ <li><a href="get-started.html#run">2.3 Running JMeter</a></li>
+ <ul>
+ <li><a href="get-started.html#classpath">2.3.1 JMeter's
Classpath</a></li>
+ <li><a href="get-started.html#proxy_server">2.3.2 Using a Proxy
Server</a></li>
+ <li><a href="get-started.html#cl_only">2.3.4 Non-GUI Mode</a></li>
+ </ul>
</ul>
<li><a href="build-test-plan.html">3. Building a Test Plan</a></li>
<ul>
- <li><a href="build-test-plan.html#add_remove">3.1 Adding and Removing
Elements</a></li>
- <li><a href="build-test-plan.html#load_save">3.2 Loading and Saving
Elements</a></li>
- <li><a href="build-test-plan.html#run">3.3 Running a Test Plan</a></li>
+ <li><a href="build-test-plan.html#add_remove">3.1 Adding and Removing
Elements</a></li>
+ <li><a href="build-test-plan.html#load_save">3.2 Loading and Saving
Elements</a></li>
+ <li><a href="build-test-plan.html#run">3.3 Running a Test Plan</a></li>
</ul>
<li><a href="elements-test-plan.html">4. Elements of a Test Plan</a></li>
<ul>
- <li><a href="thread-group.html">4.1 Thread Group</a></li>
- <li><a href="controller.html">4.2 Controllers</a></li>
- <ul>
- <li><a href="gen-controller.html">4.2.1 Generative Controllers</a></li>
- <ul>
- <li><a href="gen-controller.html#ftp_request">4.2.1.1 FTP Request</a></li>
- <li><a href="gen-controller.html#http_request">4.2.1.2 HTTP Request</a></li>
- <li><a href="gen-controller.html#jdbc_request">4.2.1.3 JDBC Request</a></li>
- </ul>
- <li><a href="logic-controller.html">4.2.2 Logic Controllers</a></li>
- <ul>
- <li><a href="logic-controller.html#interleave">4.2.2.1 Interleave
Controller</a></li>
- <li><a href="logic-controller.html#loop">4.2.2.2 Loop Controller</a></li>
- <li><a href="logic-controller.html#mod_manager">4.2.2.3 Modification
Manager</a></li>
- <li><a href="logic-controller.html#once_only">4.2.2.4 Once Only
Controller</a></li>
- <li><a href="logic-controller.html#simple">4.2.2.5 Simple
Controller</a></li>
- </ul>
- </ul>
- <li><a href="listener.html">4.3 Listeners</a></li>
- <ul>
- <li><a href="listener.html#graph">4.3.1 Graphs</a></li>
- <ul>
- <li><a href="listener.html#view_graph_tree">4.3.1.1 View Graph Tree</a></li>
- <li><a href="listener.html#graph_full_results">4.3.1.2 Graph Full
Results</a></li>
- <li><a href="listener.html#graph_results">4.3.1.3 Graph Results</a></li>
- <li><a href="listener.html#spline">4.3.1.4 Spline Visualizer</a></li>
- </ul>
- <li><a href="listener.html#managers">4.3.2 Managers</a></li>
- <ul>
- <li><a href="listener.html#mod_manager">4.3.2.1 Modification
Manager</a></li>
- </ul>
- <li><a href="listener.html#misc">4.3.3 Miscellaneous</a></li>
- <ul>
- <li><a href="listener.html#assertion_results">4.3.3.1 Assertion
Results</a></li>
- <li><a href="listener.html#file_reporter">4.3.3.2 File Reporter</a></li>
- <li><a href="listener.html#view_results">4.3.3.3 View Results</a></li>
- <li><a href="listener.html#view_results_tree">4.3.3.4 View Result
Tree</a></li>
- </ul>
- </ul>
- <li><a href="timer.html">4.4 Timers</a></li>
- <ul>
- <li><a href="timer.html#constant">4.4.1 Constant Timer</a></li>
- <li><a href="timer.html#gaussian">4.4.2 Gaussian Random Timer</a></li>
- <li><a href="timer.html#uniform">4.4.3 Uniform Random Timer</a></li>
- </ul>
-
- <li><a href="assertion.html">4.5 Assertions</a></li>
-
- <li><a href="ftp-config.html">4.6 FTP Configuration Elements</a></li>
- <ul>
- <li><a href="ftp-config.html#request_defaults">4.6.1 FTP Request
Defaults</a></li>
- </ul>
-
- <li><a href="http-config.html">4.7 HTTP Configuration Elements</a></li>
- <ul>
- <li><a href="http-config.html#auth_manager">4.7.1 HTTP Authorization
Manager</a></li>
- <li><a href="http-config.html#cookie_manager">4.7.2 HTTP Cookie
Manager</a></li>
- <li><a href="http-config.html#header_manager">4.7.3 HTTP Header
Manager</a></li>
- <li><a href="http-config.html#proxy_server">4.7.4 HTTP Proxy Server</a></li>
- <li><a href="http-config.html#request_defaults">4.7.5 HTTP Request
Defaults</a></li>
- </ul>
-
- <li><a href="jdbc-config.html">4.8 JDBC Configuration Elements</a></li>
- <ul>
- <li><a href="jdbc-config.html#conn_pool">4.8.1 JDBC Database Connection Pool
Defaults</a></li>
- <li><a href="jdbc-config.html#login">4.8.2 JDBC Database Login
Defaults</a></li>
- <li><a href="jdbc-config.html#sql_query">4.8.3 JDBC SQL Query
Defaults</a></li>
- </ul>
+ <li><a href="thread-group.html">4.1 Thread Group</a></li>
+ <li><a href="controller.html">4.2 Controllers</a></li>
+ <ul>
+ <li><a href="gen-controller.html">4.2.1 Generative Controllers</a></li>
+ <ul>
+ <li><a href="gen-controller.html#ftp_request">4.2.1.1 FTP
Request</a></li>
+ <li><a href="gen-controller.html#http_request">4.2.1.2 HTTP
Request</a></li>
+ <li><a href="gen-controller.html#jdbc_request">4.2.1.3 JDBC
Request</a></li>
+ </ul>
+ <li><a href="logic-controller.html">4.2.2 Logic Controllers</a></li>
+ <ul>
+ <li><a href="logic-controller.html#interleave">4.2.2.1 Interleave
Controller</a></li>
+ <li><a href="logic-controller.html#loop">4.2.2.2 Loop
Controller</a></li>
+ <li><a href="logic-controller.html#mod_manager">4.2.2.3 Modification
Manager</a></li>
+ <li><a href="logic-controller.html#once_only">4.2.2.4 Once Only
Controller</a></li>
+ <li><a href="logic-controller.html#simple">4.2.2.5 Simple
Controller</a></li>
+ </ul>
+ </ul>
+ <li><a href="listener.html">4.3 Reporters</a></li>
+ <ul>
+ <li><a href="listener.html#view_graph_tree">4.3.1 View Graph
Tree</a></li>
+ <li><a href="listener.html#graph_full_results">4.3.2 Graph Full
Results</a></li>
+ <li><a href="listener.html#graph_results">4.3.3 Graph
Results</a></li>
+ <li><a href="listener.html#spline">4.3.4 Spline Visualizer</a></li>
+ <li><a href="listener.html#assertion_results">4.3.5 Assertion
Results</a></li>
+ <li><a href="listener.html#file_reporter">4.3.6 File
Reporter</a></li>
+ <li><a href="listener.html#view_results">4.3.7 View Results</a></li>
+ <li><a href="listener.html#view_results_tree">4.3.8 View Result
Tree</a></li>
+ </ul>
+ <li><a href="timer.html">4.4 Timers</a></li>
+ <ul>
+ <li><a href="timer.html#constant">4.4.1 Constant Timer</a></li>
+ <li><a href="timer.html#gaussian">4.4.2 Gaussian Random Timer</a></li>
+ <li><a href="timer.html#uniform">4.4.3 Uniform Random Timer</a></li>
+ </ul>
+
+ <li><a href="assertion.html">4.5 Assertions</a></li>
+
+ <li><a href="ftp-config.html">4.6 FTP Configuration Elements</a></li>
+ <ul>
+ <li><a href="ftp-config.html#request_defaults">4.6.1 FTP Request
Defaults</a></li>
+ </ul>
+
+ <li><a href="http-config.html">4.7 HTTP Configuration Elements</a></li>
+ <ul>
+ <li><a href="http-config.html#auth_manager">4.7.1 HTTP Authorization
Manager</a></li>
+ <li><a href="http-config.html#cookie_manager">4.7.2 HTTP Cookie
Manager</a></li>
+ <li><a href="http-config.html#header_manager">4.7.3 HTTP Header
Manager</a></li>
+ <li><a href="http-config.html#proxy_server">4.7.4 HTTP Proxy
Server</a></li>
+ <li><a href="http-config.html#request_defaults">4.7.5 HTTP Request
Defaults</a></li>
+ </ul>
+
+ <li><a href="jdbc-config.html">4.8 JDBC Configuration Elements</a></li>
+ <ul>
+ <li><a href="jdbc-config.html#conn_pool">4.8.1 JDBC Database
Connection Pool Defaults</a></li>
+ <li><a href="jdbc-config.html#login">4.8.2 JDBC Database Login
Defaults</a></li>
+ <li><a href="jdbc-config.html#sql_query">4.8.3 JDBC SQL Query
Defaults</a></li>
+ </ul>
</ul>
<li><a href="build-web-test-plan.html">5. Building a Web Test Plan</a></li>
- <ul>
- <li><a href="build-web-test-plan.htm#adding_users">5.1 Adding Users</a></li>
- <li><a href="build-web-test-plan.html#adding_defaults">5.2 Adding Default
HTTP Request Properties</a></li>
- <li><a href="build-web-test-plan.html#adding_requests">5.3 Adding HTTP
Requests</a></li>
- <li><a href="build-web-test-plan.html#adding_file_reporter">5.4 Adding a File
Reporter to Store the Test Results</a></li>
- <li><a href="build-web-test-plan.html#saving">5.5 Saving the Test
Plan</a></li>
- <li><a href="build-web-test-plan.html#running">5.6 Running the Test
Plan</a></li>
- </ul>
+ <ul>
+ <li><a href="build-web-test-plan.htm#adding_users">5.1 Adding
Users</a></li>
+ <li><a href="build-web-test-plan.html#adding_defaults">5.2 Adding
Default HTTP Request Properties</a></li>
+ <li><a href="build-web-test-plan.html#adding_requests">5.3 Adding HTTP
Requests</a></li>
+ <li><a href="build-web-test-plan.html#adding_file_reporter">5.4 Adding
a File Reporter to Store the Test Results</a></li>
+ <li><a href="build-web-test-plan.html#saving">5.5 Saving the Test
Plan</a></li>
+ <li><a href="build-web-test-plan.html#running">5.6 Running the Test
Plan</a></li>
+ </ul>
<li><a href="build-adv-web-test-plan.html">6. Building an Advanced Web Test
Plan</a></li>
<li><a href="build-db-test-plan.html">7. Building a Database Test Plan</a></li>
<li><a href="build-ftp-test-plan.html">8. Building a FTP Test Plan</a></li>
<li><a href="remote-test.html">9. Remote Testing</a></li>
- <li><a href="best-practices.html">10. Best Practices</a></li>
+ <li><a href="configuring_jmeter.html">10. Configuring JMeter</a></li>
+ <li><a href="best-practices.html">11. Best Practices</a></li>
<ul>
- <li><a href="best-practices.html#limit_threads">10.1 [ALL] Limit the Number of
Threads</a></li>
- <li><a href="best-practices.html#put_cookie_manager">10.2 [HTTP] Where to Put
the Cookie Manager</a></li>
- <li><a href="best-practices.html#put_auth_manager">10.3 [HTTP] Where to Put the
Authorization Manager</a></li>
+ <li><a href="best-practices.html#limit_threads">11.1 [ALL] Limit the Number
of Threads</a></li>
+ <li><a href="best-practices.html#put_cookie_manager">11.2 [HTTP] Where to Put
the Cookie Manager</a></li>
+ <li><a href="best-practices.html#put_auth_manager">11.3 [HTTP] Where to Put
the Authorization Manager</a></li>
</ul>
- <li><a href="boss.html">11. Help! My boss wants me to load test our web
app!</a></li>
- <li><a href="glossary.html">12. Glossary</a></li>
+ <li><a href="boss.html">12. Help! My boss wants me to load test our web
app!</a></li>
+ <li><a href="glossary.html">13. Glossary</a></li>
</ul>
</section>
1.2 +26 -0 jakarta-jmeter/xdocs/usermanual/intro.xml
Index: intro.xml
===================================================================
RCS file: /home/cvs/jakarta-jmeter/xdocs/usermanual/intro.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- intro.xml 28 Oct 2001 13:22:50 -0000 1.1
+++ intro.xml 20 Feb 2002 02:51:54 -0000 1.2
@@ -8,12 +8,38 @@
<body>
<section name="1. Introduction">
+<p>
+<b>Apache JMeter</b> is a 100% pure Java desktop application designed
+ to load test client/server software
+ (such as a web application). It may be used
+ to test performance both on static and dynamic
+ resources (files, Servlets, Perl scripts, Java Objects, Data Bases and
+ Queries, FTP Servers and more). It can be used to simulate a heavy
+load on a server, network or object to test its strength or to analyze
+overall performance under different load types.
+</p>
+<p>
+Additionally, JMeter can help you regression test your application by using
+test scripts with assertions to validate that your application is returning the
+results you expect. These assertions use regular expressions to give you maximum
+flexibility in designing these test.
+</p>
</section>
<section name="1.1 History">
+<p>JMeter was originally written by Stefano Mazzocchi of the Apache Software
+Foundation, primarily to test the performance of Apache JServ (a project that has
+since been replaced by the Apache Tomcat project). It has since been redesigned
+and re-implemented to improve the UI and JMeter's functional testing capabilities.
+</p>
</section>
<section name="1.2 The Future">
+<p>JMeter's future will hopefully see it's capabilities rapidly expand as developers
+take advantage of JMeter's pluggable architecture. The primary goal of further
+development is to make JMeter the most useful regression testing tool as possible,
+without compromising JMeter's load-testing capabilities.
+</p>
</section>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
