better readme

git-svn-id: svn+ssh://dev.eclipse.org/svnroot/rt/org.eclipse.jetty/jetty/trunk@1387 7e9141cc-0065-0410-87d8-b60c137991c4
This commit is contained in:
Greg Wilkins 2010-03-17 10:51:39 +00:00
parent c23e75bc3e
commit 32a02d38c2
1 changed files with 36 additions and 27 deletions

View File

@ -1,38 +1,47 @@
Jetty start
-----------
Jetty start provides a cross platform replacement for startup scripts.
It makes use of executable JAR mechanism, which lets application packaged as JAR
to be started with simple command line:
The run directory is either the top-level of a distribution
or jetty-distribution/target/distribution directory when built from
source.
java -jar start.jar [jetty.xml ... ]
Jetty start.jar provides a cross platform replacement for startup scripts.
It makes use of executable JAR that builds the classpath and then executes
jetty.
or to see debug output
To run with all the demo options:
java -Dorg.eclipse.jetty.launcher.debug=true -jar start.jar [jetty.xml ... ]
java -jar start.jar OPTIONS=All
What launcher does is:
To run with the default options:
- Figures out correct location of Jetty home directory.
java -jar start.jar
- Configures classpath based on which JDK version it has been run with
and what classes are available (for example, someone might have servlet classes
in ext directory of JDK, or JSSE needs to be inlcuded on JDK 1.3 but is
built-in in JDK 1.4 etc.)
- Looks for Sun's JAVAC (required for Jasper JSP engine)
and puts it in classpath. For this to work, launcher has to be started
with JDK, not JRE!
- After classpath has been configured, it invokes org.eclipse.jetty.Server
with any command line arguments it received.
- When there are no commandline args, launcher starts Jetty Demo
(using configuration files etc/demo.xml and etc/admin.xml) and on Windows
platform it also attemts to invoke Internet Explorer with jetty demo URL
(http://localhost:8080/).
The default options may be specified in the start.ini file, or if
that is not present, they are defined in the start.config file that
is within the start.jar.
This means Windows users who have file type association for JAR files
setup to launch jar using JDK can now lauch jetty with simple
doubleclick on start.jar, or typing "start.jar" in shell window when in Jetty
home directory.
To run with specific configuration file(s)
java -jar start.jar etc/jetty.xml
To see the available options
java -jar start.jar --help
To run with JSP support (if available)
java -jar start.jar OPTIONS=Server,jsp
To run with JMX support
java -jar start.jar OPTIONS=Server,jmx etc/jetty-jmx.xml etc/jetty.xml
To run with JSP & JMX support
java -jar start.jar OPTIONS=Server,jsp,jmx etc/jetty-jmx.xml etc/jetty.xml
Note that JSP requires the jasper jars to be within $JETTY/lib/jsp These
are currently not distributed with the eclipse release and must be
obtained from a jetty-hightide release from codehaus.
Any unknown JARs found in ext subdirectory of Jetty home will be
added to classpath. Users can place libraries common to multiple contexts there.