khammond 02/02/20 05:38:37 Modified: xdocs/usermanual get-started.xml Log: Added text. Revision Changes Path 1.3 +44 -88 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.2 retrieving revision 1.3 diff -u -r1.2 -r1.3 --- get-started.xml 20 Feb 2002 02:51:54 -0000 1.2 +++ get-started.xml 20 Feb 2002 13:38:37 -0000 1.3 @@ -8,116 +8,72 @@ <body> <section name="2. Getting Started"> +<p>The easiest way to begin using JMeter is to first +<a href="http://jakarta.apache.org/builds/jakarta-jmeter/release/";>download the latest production release</a> and install it. +The release contains all of the files you need to build and run Web, FTP, JDBC, and JNDI tests. If you want to perform JDBC testing, +then you will, of course, need the appropriate JDBC driver from your vendor. JMeter does not come with +any JDBC drivers.</p> +<p>Next, start JMeter and go through the <a href="build-test-plan.html">Building a Test Plan</a> section +of the User Guide to familiarize yourself with JMeter basics (for example, adding and removing elements).</p> +<p>Finally, go through the appropriate section on how to build a specific type of Test Plan. +For example, if you are interested in testing a Web application, then see the section +<a href="build-web-test-plan.html">Building a Web Test Plan</a>. +The other specific Test Plan sections are for <a href="build-db-test-plan.html">JDBC</a>, +<a href="build-ftp-test-plan.html">FTP</a>, and <a href="build-jndi-test-plan.html">JNDI</a>.</p> +<p>Once you are comfortable with building and running JMeter Test Plans, you can look into the +various configuration elements (timers, listeners, assertions, and others) which give you more control +over your Test Plans.</p> </section> -<a name="requirements"/> -<section name="2.1 Requirements"></section> +<section name="2.1 Requirements"> +<p>As you can see from the list below, JMeter has only one requirement.</p> +</section> -<a name="java_versions"/> -<section name="2.1.1 Java Versions"> -<p>JMeter runs in JDK1.2 and higher. </p> +<section name="2.1.1 Java Version"> +<p>JMeter requires a fully compliant JDK1.2 (or higher) environment. Because JMeter uses only +standard Java APIs (java.*), please do not file bug reports if your JRE fails to run +JMeter because of JRE implementation issues.</p> </section> -<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 name="2.2 Optional"> +<p>If you plan on doing JMeter development or want to use Sun's Java Standard Extension packages, then you will need one or more optional packages listed below.</p> </section> -<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 name="2.2.1 Java Compiler"> +<p>If you want to build the JMeter source or develop JMeter plugins, then you will need a fully compliant JDK1.2 or higher compiler.</p> </section> -<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 name="2.2.2 SAX 1.0 XML Parser"> +<p>JMeter comes with Apache's <a href="http://xml.apache.org/";>Xerces XML parser</a>. You have the option of telling JMeter +to use a different XML parser.</p> </section> -<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 name="2.2.3 javax.mail and javax.activation"> +<p>You will need these packages if you want JMeter to send email notifications.</p> </section> -<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 name="2.2.4 Java Secure Socket Extension (JSSE)"> +<p>You will need <a href="http://java.sun.com/products/jsse/index.html";>JSSE</a> if you want JMeter to send HTTPS requests for Web application testing. 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> </section> -<a name="install"/> <section name="2.2 Installation"> +<p>Blah, blah, blah.</p> </section> -<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> +<p>We recommend that most users run the <a href="http://jakarta.apache.org/builds/jakarta-jmeter/release/";>latest release</a>.</p> </section> -<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> +<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> +</section> + +<section name="2.2.3 UNIX Instructions"> +<p>Blah, blah, blah.</p> +</section> + +<section name="2.2.4 MS-Windows Instructions"> +<p>Blah, blah, blah.</p> </section> </body>
-- To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]> For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
