You are viewing a plain text version of this content. The canonical link for it is here.
Posted to scm@geronimo.apache.org by jd...@apache.org on 2006/09/25 21:39:06 UTC
svn commit: r449785 - in /geronimo/server/trunk/maven-plugins:
car-maven-plugin/src/site/apt/usage.apt
geronimo-deployment-plugin/src/site/apt/usage.apt
geronimo-maven-plugin/src/site/apt/usage/server.apt
selenium-maven-plugin/src/site/apt/usage.apt
Author: jdillon
Date: Mon Sep 25 12:39:04 2006
New Revision: 449785
URL: http://svn.apache.org/viewvc?view=rev&rev=449785
Log:
Adding APT friendly ASL sub-header, testing props for keyword expansion
Modified:
geronimo/server/trunk/maven-plugins/car-maven-plugin/src/site/apt/usage.apt (contents, props changed)
geronimo/server/trunk/maven-plugins/geronimo-deployment-plugin/src/site/apt/usage.apt (props changed)
geronimo/server/trunk/maven-plugins/geronimo-maven-plugin/src/site/apt/usage/server.apt (contents, props changed)
geronimo/server/trunk/maven-plugins/selenium-maven-plugin/src/site/apt/usage.apt (contents, props changed)
Modified: geronimo/server/trunk/maven-plugins/car-maven-plugin/src/site/apt/usage.apt
URL: http://svn.apache.org/viewvc/geronimo/server/trunk/maven-plugins/car-maven-plugin/src/site/apt/usage.apt?view=diff&rev=449785&r1=449784&r2=449785
==============================================================================
--- geronimo/server/trunk/maven-plugins/car-maven-plugin/src/site/apt/usage.apt (original)
+++ geronimo/server/trunk/maven-plugins/car-maven-plugin/src/site/apt/usage.apt Mon Sep 25 12:39:04 2006
@@ -1,180 +1,198 @@
- ------
- Geronimo CAR Plugin for Maven 2
- ------
- ???
- ------
- ???
-
-Basic Usage
-
-* Setup Plugin Repository
-
-+----------+
-<project>
- ...
- <pluginRepositories>
- <pluginRepository>
- <id>apache-snapshots</id>
- <name>Apache Snapshots Repository</name>
- <url>http://people.apache.org/repo/m2-snapshot-repository</url>
- <layout>default</layout>
- <snapshots>
- <enabled>true</enabled>
- <updatePolicy>daily</updatePolicy>
- <checksumPolicy>ignore</checksumPolicy>
- </snapshots>
- <releases>
- <enabled>false</enabled>
- </releases>
- </pluginRepository>
- ...
- </pluginRepositories>
- ...
-</project>
-+----------+
-
-* Define Dependency as Extention
-
- Install as extention to allow 'car' packaging to be used.
-
-+----------+
-<project>
- ...
- <packaging>car</packaging>
- ...
- <build>
- ...
- <plugins>
- ...
- <plugin>
- <groupId>org.apache.geronimo.plugins</groupId>
- <artifactId>car-maven-plugin</artifactId>
- <extensions>true</extensions>
- </plugin>
- </plugins>
- ...
- </build>
- ...
-</project>
-+----------+
-
-* CAR with Class-Path and Main-Class manifest entries
-
- NOTE: The list of classpath elements is non-transitive.
-
-+----------+
-<project>
- ...
- <packaging>car</packaging>
- ...
- <build>
- ...
- <plugins>
- ...
- <plugin>
- <groupId>org.apache.geronimo.plugins</groupId>
- <artifactId>car-maven-plugin</artifactId>
- <configuration>
- <archive>
- <manifestEntries>
- <Endorsed-Dirs>lib/endorsed</Endorsed-Dirs>
- <Extension-Dirs>lib/ext</Extension-Dirs>
- </manifestEntries>
- <manifest>
- <mainClass>org.apache.geronimo.system.main.Daemon</mainClass>
- </manifest>
- </archive>
- <classpath>
- <classpathElement>
- <groupId>mx4j</groupId>
- <artifactId>mx4j</artifactId>
- </classpathElement>
- <classpathElement>
- <groupId>mx4j</groupId>
- <artifactId>mx4j-remote</artifactId>
- </classpathElement>
- <classpathElement>
- <groupId>commons-cli</groupId>
- <artifactId>commons-cli</artifactId>
- </classpathElement>
- <classpathElement>
- <groupId>commons-logging</groupId>
- <artifactId>commons-logging</artifactId>
- </classpathElement>
- <classpathElement>
- <groupId>cglib</groupId>
- <artifactId>cglib-nodep</artifactId>
- </classpathElement>
- <classpathElement>
- <groupId>log4j</groupId>
- <artifactId>log4j</artifactId>
- </classpathElement>
- <classpathElement>
- <groupId>jline</groupId>
- <artifactId>jline</artifactId>
- </classpathElement>
- <classpathElement>
- <groupId>xpp3</groupId>
- <artifactId>xpp3</artifactId>
- </classpathElement>
- <classpathElement>
- <groupId>xstream</groupId>
- <artifactId>xstream</artifactId>
- </classpathElement>
- <classpathElement>
- <groupId>backport-util-concurrent</groupId>
- <artifactId>backport-util-concurrent</artifactId>
- </classpathElement>
- <classpathElement>
- <groupId>xerces</groupId>
- <artifactId>xercesImpl</artifactId>
- <classpathPrefix>../lib/endorsed</classpathPrefix>
- </classpathElement>
- <classpathElement>
- <groupId>xerces</groupId>
- <artifactId>xmlParserAPIs</artifactId>
- <classpathPrefix>../lib/endorsed</classpathPrefix>
- </classpathElement>
- </classpath>
- <classpathPrefix>../lib</classpathPrefix>
- </configuration>
- </plugin>
- ...
- </plugins>
- ...
- </build>
- ...
-<project>
-+----------+
-
-* Install artifacts into a Geronimo repository
-
- Install arbitrary artifacts into a Geronimo repository.
-
-+----------+
-<plugin>
- <groupId>org.apache.geronimo.plugins</groupId>
- <artifactId>car-maven-plugin</artifactId>
- <executions>
- <execution>
- <id>install-repository</id>
- <phase>compile</phase>
- <goals>
- <goal>install-artifacts</goal>
- </goals>
- <configuration>
- <repositoryDirectory>${project.build.outputDirectory}/repository</repositoryDirectory>
-
- <artifacts>
- <artifactItem>
- <groupId>org.apache.geronimo.modules</groupId>
- <artifactId>ge-activemq-rar</artifactId>
- <type>rar</type>
- </artifactItem>
- </artifacts>
- </configuration>
- </execution>
- </executions>
-</plugin>
-+----------+
-
+ ------
+ Basic Usage :: Geronimo CAR Plugin for Maven 2
+ ------
+ ------
+ $Rev$ $Date$
+
+~~
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License. You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied. See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
+~~
+
+Basic Usage
+
+* Setup Plugin Repository
+
++----------+
+<project>
+ ...
+ <pluginRepositories>
+ <pluginRepository>
+ <id>apache-snapshots</id>
+ <name>Apache Snapshots Repository</name>
+ <url>http://people.apache.org/repo/m2-snapshot-repository</url>
+ <layout>default</layout>
+ <snapshots>
+ <enabled>true</enabled>
+ <updatePolicy>daily</updatePolicy>
+ <checksumPolicy>ignore</checksumPolicy>
+ </snapshots>
+ <releases>
+ <enabled>false</enabled>
+ </releases>
+ </pluginRepository>
+ ...
+ </pluginRepositories>
+ ...
+</project>
++----------+
+
+* Define Dependency as Extention
+
+ Install as extention to allow 'car' packaging to be used.
+
++----------+
+<project>
+ ...
+ <packaging>car</packaging>
+ ...
+ <build>
+ ...
+ <plugins>
+ ...
+ <plugin>
+ <groupId>org.apache.geronimo.plugins</groupId>
+ <artifactId>car-maven-plugin</artifactId>
+ <extensions>true</extensions>
+ </plugin>
+ </plugins>
+ ...
+ </build>
+ ...
+</project>
++----------+
+
+* CAR with Class-Path and Main-Class manifest entries
+
+ NOTE: The list of classpath elements is non-transitive.
+
++----------+
+<project>
+ ...
+ <packaging>car</packaging>
+ ...
+ <build>
+ ...
+ <plugins>
+ ...
+ <plugin>
+ <groupId>org.apache.geronimo.plugins</groupId>
+ <artifactId>car-maven-plugin</artifactId>
+ <configuration>
+ <archive>
+ <manifestEntries>
+ <Endorsed-Dirs>lib/endorsed</Endorsed-Dirs>
+ <Extension-Dirs>lib/ext</Extension-Dirs>
+ </manifestEntries>
+ <manifest>
+ <mainClass>org.apache.geronimo.system.main.Daemon</mainClass>
+ </manifest>
+ </archive>
+ <classpath>
+ <classpathElement>
+ <groupId>mx4j</groupId>
+ <artifactId>mx4j</artifactId>
+ </classpathElement>
+ <classpathElement>
+ <groupId>mx4j</groupId>
+ <artifactId>mx4j-remote</artifactId>
+ </classpathElement>
+ <classpathElement>
+ <groupId>commons-cli</groupId>
+ <artifactId>commons-cli</artifactId>
+ </classpathElement>
+ <classpathElement>
+ <groupId>commons-logging</groupId>
+ <artifactId>commons-logging</artifactId>
+ </classpathElement>
+ <classpathElement>
+ <groupId>cglib</groupId>
+ <artifactId>cglib-nodep</artifactId>
+ </classpathElement>
+ <classpathElement>
+ <groupId>log4j</groupId>
+ <artifactId>log4j</artifactId>
+ </classpathElement>
+ <classpathElement>
+ <groupId>jline</groupId>
+ <artifactId>jline</artifactId>
+ </classpathElement>
+ <classpathElement>
+ <groupId>xpp3</groupId>
+ <artifactId>xpp3</artifactId>
+ </classpathElement>
+ <classpathElement>
+ <groupId>xstream</groupId>
+ <artifactId>xstream</artifactId>
+ </classpathElement>
+ <classpathElement>
+ <groupId>backport-util-concurrent</groupId>
+ <artifactId>backport-util-concurrent</artifactId>
+ </classpathElement>
+ <classpathElement>
+ <groupId>xerces</groupId>
+ <artifactId>xercesImpl</artifactId>
+ <classpathPrefix>../lib/endorsed</classpathPrefix>
+ </classpathElement>
+ <classpathElement>
+ <groupId>xerces</groupId>
+ <artifactId>xmlParserAPIs</artifactId>
+ <classpathPrefix>../lib/endorsed</classpathPrefix>
+ </classpathElement>
+ </classpath>
+ <classpathPrefix>../lib</classpathPrefix>
+ </configuration>
+ </plugin>
+ ...
+ </plugins>
+ ...
+ </build>
+ ...
+<project>
++----------+
+
+* Install artifacts into a Geronimo repository
+
+ Install arbitrary artifacts into a Geronimo repository.
+
++----------+
+<plugin>
+ <groupId>org.apache.geronimo.plugins</groupId>
+ <artifactId>car-maven-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>install-repository</id>
+ <phase>compile</phase>
+ <goals>
+ <goal>install-artifacts</goal>
+ </goals>
+ <configuration>
+ <repositoryDirectory>${project.build.outputDirectory}/repository</repositoryDirectory>
+
+ <artifacts>
+ <artifactItem>
+ <groupId>org.apache.geronimo.modules</groupId>
+ <artifactId>ge-activemq-rar</artifactId>
+ <type>rar</type>
+ </artifactItem>
+ </artifacts>
+ </configuration>
+ </execution>
+ </executions>
+</plugin>
++----------+
+
Propchange: geronimo/server/trunk/maven-plugins/car-maven-plugin/src/site/apt/usage.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: geronimo/server/trunk/maven-plugins/car-maven-plugin/src/site/apt/usage.apt
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Propchange: geronimo/server/trunk/maven-plugins/car-maven-plugin/src/site/apt/usage.apt
------------------------------------------------------------------------------
svn:mime-type = text/plain
Propchange: geronimo/server/trunk/maven-plugins/geronimo-deployment-plugin/src/site/apt/usage.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: geronimo/server/trunk/maven-plugins/geronimo-deployment-plugin/src/site/apt/usage.apt
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Propchange: geronimo/server/trunk/maven-plugins/geronimo-deployment-plugin/src/site/apt/usage.apt
------------------------------------------------------------------------------
svn:mime-type = text/plain
Modified: geronimo/server/trunk/maven-plugins/geronimo-maven-plugin/src/site/apt/usage/server.apt
URL: http://svn.apache.org/viewvc/geronimo/server/trunk/maven-plugins/geronimo-maven-plugin/src/site/apt/usage/server.apt?view=diff&rev=449785&r1=449784&r2=449785
==============================================================================
--- geronimo/server/trunk/maven-plugins/geronimo-maven-plugin/src/site/apt/usage/server.apt (original)
+++ geronimo/server/trunk/maven-plugins/geronimo-maven-plugin/src/site/apt/usage/server.apt Mon Sep 25 12:39:04 2006
@@ -1,241 +1,241 @@
- ------
- Server Goals Usage :: Geronimo Plugin for Maven 2
- ------
- ------
- $Rev$ $Date$
-
-~~
-~~ Licensed to the Apache Software Foundation (ASF) under one
-~~ or more contributor license agreements. See the NOTICE file
-~~ distributed with this work for additional information
-~~ regarding copyright ownership. The ASF licenses this file
-~~ to you under the Apache License, Version 2.0 (the
-~~ "License"); you may not use this file except in compliance
-~~ with the License. You may obtain a copy of the License at
-~~
-~~ http://www.apache.org/licenses/LICENSE-2.0
-~~
-~~ Unless required by applicable law or agreed to in writing,
-~~ software distributed under the License is distributed on an
-~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-~~ KIND, either express or implied. See the License for the
-~~ specific language governing permissions and limitations
-~~ under the License.
-~~
-
-Server Goals Usage
-
-* Assembly Artifact Configuration
-
- Before the plugin can start or stop a server, it needs to know about the
- assembly (or assemblies) which it will install.
-
- This example shows one assembly, which will be used to install unless the
- <<<assemblyArchive>>> parameter has been set (see below section on <Installing an Assembly>).
-
- <<NOTE:>> Archive files <<MUST>> be a <<<ZIP>>> files (or be in the same format, like a <<<JAR>>>).
-
-+----------+
-<plugin>
- <groupId>org.apache.geronimo.plugins</groupId>
- <artifactId>geronimo-maven-plugin</artifactId>
-
- <configuration>
- <assemblies>
- <assembly>
- <groupId>org.apache.geronimo.assemblies</groupId>
- <artifactId>geronimo-jetty-j2ee</artifactId>
- <version>${pom.version}</version>
- <classifier>bin</classifier>
- <type>zip</type>
- </assembly>
- </assemblies>
- </configuration>
-</plugin>
-+----------+
-
- Multiple assemblies may be specified. Each must have a unique id, and either
- <<<defaultAssemblyId>>> or <<<assemblyId>>> must be configured to inform the
- plugin which assembly to use.
-
-+----------+
-<plugin>
- <groupId>org.apache.geronimo.plugins</groupId>
- <artifactId>geronimo-maven-plugin</artifactId>
-
- <configuration>
- <assemblies>
- <assembly>
- <id>jetty</id>
- <groupId>org.apache.geronimo.assemblies</groupId>
- <artifactId>geronimo-jetty-j2ee</artifactId>
- <version>${pom.version}</version>
- <classifier>bin</classifier>
- <type>zip</type>
- </assembly>
-
- <assembly>
- <id>jetty-minimal</id>
- <groupId>org.apache.geronimo.assemblies</groupId>
- <artifactId>geronimo-jetty-minimal</artifactId>
- <version>${pom.version}</version>
- <classifier>bin</classifier>
- <type>zip</type>
- </assembly>
-
- <assembly>
- <id>tomcat</id>
- <groupId>org.apache.geronimo.assemblies</groupId>
- <artifactId>geronimo-tomcat-j2ee</artifactId>
- <version>${pom.version}</version>
- <classifier>bin</classifier>
- <type>zip</type>
- </assembly>
-
- <assembly>
- <id>tomcat-minimal</id>
- <groupId>org.apache.geronimo.assemblies</groupId>
- <artifactId>geronimo-tomcat-minimal</artifactId>
- <version>${pom.version}</version>
- <classifier>bin</classifier>
- <type>zip</type>
- </assembly>
- </assemblies>
-
- <defaultAssemblyId>jetty</defaultAssemblyId>
- </configuration>
-</plugin>
-+----------+
-
-* Starting Geronimo Server
-
- Once you have configured an assembly (or assemblies with a default), then you can simply start the server.
-
- The assembly archive will be installed if it does not already exist, or if
- the plugin detects that the current archive is newer than the last installation.
-
-+----------+
-mvn geronimo:start
-+----------+
-
- If you have a pre-existing assembly installed and you want to use that, you can set <<<geronimoHome>>>
- this will bypass any installation logic completely.
-
-+----------+
-mvn geronimo:start -DgeronimoHome=/path/to/assembly
-+----------+
-
- Some additional flags may be passed in to alter the startup behavior. For example
- to enable verbose mode:
-
-+----------+
-mvn geronimo:start -Dverbose=true
-+----------+
-
- Optional JVM debug arguments may be configured.
-
-+----------+
-<plugin>
- <groupId>org.apache.geronimo.plugins</groupId>
- <artifactId>geronimo-maven-plugin</artifactId>
-
- <configuration>
- <debugArguments>
- <argument>-Xdebug</argument>
- <argument>-Xrunjdwp:transport=dt_socket,address=8000,server=y,suspend=n</argument>
- </debugArguments>
- </configuration>
-</plugin>
-+----------+
-
- By setting the <<<debug>>> parameter the JVM will be started in debug mode.
-
-+----------+
-mvn geronimo:start -Ddebug=true
-+----------+
-
-* Stopping Geronimo Server
-
- To stop a server using the defaults, which is probably fine in most cases, just invoke the {{stop}} goal.
-
- Stopping a server does not require an assembly to be installed.
-
-+----------+
-mvn geronimo:stop
-+----------+
-
- Additional parameters may be passed in on the command-line:
-
-+----------+
-mvn geronimo:stop -Dusername=system -Dpassword=manager -Dport=1099
-+----------+
-
-* Selecting an Assembly
-
- Once you have a set of assemblies configured with unique ids, you can specify
- the id of the assembly you wish to use on the command-line:
-
-+----------+
-mvn geronimo:start -DassemblyId=tomcat
-+----------+
-
-* Start/Stop for Integration Testing
-
- For inline integration testing, you can set the <<<background>>> parameter
- on the <<<start>>> goal to start the server, wait for it to load and then
- return control to Maven so that it can execute integration tests.
-
-+----------+
-<plugin>
- <groupId>org.apache.geronimo.plugins</groupId>
- <artifactId>geronimo-maven-plugin</artifactId>
- <executions>
- <execution>
- <id>start-server</id>
- <phase>pre-integration-test</phase>
- <goals>
- <goal>start</goal>
- </goals>
- <configuration>
- <background>true</background>
- </configuration>
- </execution>
-
- <execution>
- <id>stop-server</id>
- <phase>post-integration-test</phase>
- <goals>
- <goal>stop</goal>
- </goals>
- </execution>
- </executions>
-</plugin>
-+----------+
-
-* Installing an Assembly
-
- To just run the installation of the assembly:
-
-+----------+
-mvn geronimo:install -DassemblyId=tomcat
-+----------+
-
- To install a specific assembly archive, which need not be in the repository:
-
-+----------+
-mvn geronimo:install -DassemblyArchive=/path/to/assembly.zip
-+----------+
-
- For this to work, the file <<MUST>> be a <<<ZIP>>> (or be in the same format, like a <<<JAR>>>)
- and the archive should contain a full server assembly, specifically it needs to have a
- <<<bin/server.jar>>> entry. This entry is used to discover <<<geronimoHome>>>.
-
- You can also change the base directory where the assembly is extracted to by setting
- the <<<installDirectory>>> parameter. This is useful for a certain operating system
- that has a horribly small limit on the maximum size of a path name.
-
- <<NOTE:>> The directory structure of the archive is still preserved when it is extracted.
-
-+----------+
-mvn geronimo:install -DinstallDirectory=c:\
-+----------+
+ ------
+ Server Goals Usage :: Geronimo Plugin for Maven 2
+ ------
+ ------
+ $Rev$ $Date$
+
+~~
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License. You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied. See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
+~~
+
+Server Goals Usage
+
+* Assembly Artifact Configuration
+
+ Before the plugin can start or stop a server, it needs to know about the
+ assembly (or assemblies) which it will install.
+
+ This example shows one assembly, which will be used to install unless the
+ <<<assemblyArchive>>> parameter has been set (see below section on <Installing an Assembly>).
+
+ <<NOTE:>> Archive files <<MUST>> be a <<<ZIP>>> files (or be in the same format, like a <<<JAR>>>).
+
++----------+
+<plugin>
+ <groupId>org.apache.geronimo.plugins</groupId>
+ <artifactId>geronimo-maven-plugin</artifactId>
+
+ <configuration>
+ <assemblies>
+ <assembly>
+ <groupId>org.apache.geronimo.assemblies</groupId>
+ <artifactId>geronimo-jetty-j2ee</artifactId>
+ <version>${pom.version}</version>
+ <classifier>bin</classifier>
+ <type>zip</type>
+ </assembly>
+ </assemblies>
+ </configuration>
+</plugin>
++----------+
+
+ Multiple assemblies may be specified. Each must have a unique id, and either
+ <<<defaultAssemblyId>>> or <<<assemblyId>>> must be configured to inform the
+ plugin which assembly to use.
+
++----------+
+<plugin>
+ <groupId>org.apache.geronimo.plugins</groupId>
+ <artifactId>geronimo-maven-plugin</artifactId>
+
+ <configuration>
+ <assemblies>
+ <assembly>
+ <id>jetty</id>
+ <groupId>org.apache.geronimo.assemblies</groupId>
+ <artifactId>geronimo-jetty-j2ee</artifactId>
+ <version>${pom.version}</version>
+ <classifier>bin</classifier>
+ <type>zip</type>
+ </assembly>
+
+ <assembly>
+ <id>jetty-minimal</id>
+ <groupId>org.apache.geronimo.assemblies</groupId>
+ <artifactId>geronimo-jetty-minimal</artifactId>
+ <version>${pom.version}</version>
+ <classifier>bin</classifier>
+ <type>zip</type>
+ </assembly>
+
+ <assembly>
+ <id>tomcat</id>
+ <groupId>org.apache.geronimo.assemblies</groupId>
+ <artifactId>geronimo-tomcat-j2ee</artifactId>
+ <version>${pom.version}</version>
+ <classifier>bin</classifier>
+ <type>zip</type>
+ </assembly>
+
+ <assembly>
+ <id>tomcat-minimal</id>
+ <groupId>org.apache.geronimo.assemblies</groupId>
+ <artifactId>geronimo-tomcat-minimal</artifactId>
+ <version>${pom.version}</version>
+ <classifier>bin</classifier>
+ <type>zip</type>
+ </assembly>
+ </assemblies>
+
+ <defaultAssemblyId>jetty</defaultAssemblyId>
+ </configuration>
+</plugin>
++----------+
+
+* Starting Geronimo Server
+
+ Once you have configured an assembly (or assemblies with a default), then you can simply start the server.
+
+ The assembly archive will be installed if it does not already exist, or if
+ the plugin detects that the current archive is newer than the last installation.
+
++----------+
+mvn geronimo:start
++----------+
+
+ If you have a pre-existing assembly installed and you want to use that, you can set <<<geronimoHome>>>
+ this will bypass any installation logic completely.
+
++----------+
+mvn geronimo:start -DgeronimoHome=/path/to/assembly
++----------+
+
+ Some additional flags may be passed in to alter the startup behavior. For example
+ to enable verbose mode:
+
++----------+
+mvn geronimo:start -Dverbose=true
++----------+
+
+ Optional JVM debug arguments may be configured.
+
++----------+
+<plugin>
+ <groupId>org.apache.geronimo.plugins</groupId>
+ <artifactId>geronimo-maven-plugin</artifactId>
+
+ <configuration>
+ <debugArguments>
+ <argument>-Xdebug</argument>
+ <argument>-Xrunjdwp:transport=dt_socket,address=8000,server=y,suspend=n</argument>
+ </debugArguments>
+ </configuration>
+</plugin>
++----------+
+
+ By setting the <<<debug>>> parameter the JVM will be started in debug mode.
+
++----------+
+mvn geronimo:start -Ddebug=true
++----------+
+
+* Stopping Geronimo Server
+
+ To stop a server using the defaults, which is probably fine in most cases, just invoke the {{stop}} goal.
+
+ Stopping a server does not require an assembly to be installed.
+
++----------+
+mvn geronimo:stop
++----------+
+
+ Additional parameters may be passed in on the command-line:
+
++----------+
+mvn geronimo:stop -Dusername=system -Dpassword=manager -Dport=1099
++----------+
+
+* Selecting an Assembly
+
+ Once you have a set of assemblies configured with unique ids, you can specify
+ the id of the assembly you wish to use on the command-line:
+
++----------+
+mvn geronimo:start -DassemblyId=tomcat
++----------+
+
+* Start/Stop for Integration Testing
+
+ For inline integration testing, you can set the <<<background>>> parameter
+ on the <<<start>>> goal to start the server, wait for it to load and then
+ return control to Maven so that it can execute integration tests.
+
++----------+
+<plugin>
+ <groupId>org.apache.geronimo.plugins</groupId>
+ <artifactId>geronimo-maven-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>start-server</id>
+ <phase>pre-integration-test</phase>
+ <goals>
+ <goal>start</goal>
+ </goals>
+ <configuration>
+ <background>true</background>
+ </configuration>
+ </execution>
+
+ <execution>
+ <id>stop-server</id>
+ <phase>post-integration-test</phase>
+ <goals>
+ <goal>stop</goal>
+ </goals>
+ </execution>
+ </executions>
+</plugin>
++----------+
+
+* Installing an Assembly
+
+ To just run the installation of the assembly:
+
++----------+
+mvn geronimo:install -DassemblyId=tomcat
++----------+
+
+ To install a specific assembly archive, which need not be in the repository:
+
++----------+
+mvn geronimo:install -DassemblyArchive=/path/to/assembly.zip
++----------+
+
+ For this to work, the file <<MUST>> be a <<<ZIP>>> (or be in the same format, like a <<<JAR>>>)
+ and the archive should contain a full server assembly, specifically it needs to have a
+ <<<bin/server.jar>>> entry. This entry is used to discover <<<geronimoHome>>>.
+
+ You can also change the base directory where the assembly is extracted to by setting
+ the <<<installDirectory>>> parameter. This is useful for a certain operating system
+ that has a horribly small limit on the maximum size of a path name.
+
+ <<NOTE:>> The directory structure of the archive is still preserved when it is extracted.
+
++----------+
+mvn geronimo:install -DinstallDirectory=c:\
++----------+
Propchange: geronimo/server/trunk/maven-plugins/geronimo-maven-plugin/src/site/apt/usage/server.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: geronimo/server/trunk/maven-plugins/geronimo-maven-plugin/src/site/apt/usage/server.apt
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Propchange: geronimo/server/trunk/maven-plugins/geronimo-maven-plugin/src/site/apt/usage/server.apt
------------------------------------------------------------------------------
svn:mime-type = text/plain
Modified: geronimo/server/trunk/maven-plugins/selenium-maven-plugin/src/site/apt/usage.apt
URL: http://svn.apache.org/viewvc/geronimo/server/trunk/maven-plugins/selenium-maven-plugin/src/site/apt/usage.apt?view=diff&rev=449785&r1=449784&r2=449785
==============================================================================
--- geronimo/server/trunk/maven-plugins/selenium-maven-plugin/src/site/apt/usage.apt (original)
+++ geronimo/server/trunk/maven-plugins/selenium-maven-plugin/src/site/apt/usage.apt Mon Sep 25 12:39:04 2006
@@ -1,62 +1,80 @@
- ------
- Geronimo Selenium Plugin for Maven 2
- ------
- ???
- ------
- ???
-
-Basic Usage
-
-* Start Selenium Server (Integrated)
-
- For integration tests that need a Selenium server, use the <<<pre-integration-test>>>
- phase to start it up in the <background> to allow the <<<integration-test>>> phase to
- be executed with the server running.
-
- <<NOTE:>> Currently there is no <stop>, the forked JVM will exit when Maven does.
-
- This will by default create files under <<<$\{pom.basedir\}/target/selenium>>>, including:
-
- * <<<server.out>>>
-
- * <<<server.err>>>
-
- * <<<server.log>>>
-
- * <<<user-extensions.js>>> (if enabled)
-
-+----------+
-<plugin>
- <groupId>org.apache.geronimo.plugins</groupId>
- <artifactId>selenium-maven-plugin</artifactId>
- <executions>
- <execution>
- <id>start-selenium</id>
- <phase>pre-integration-test</phase>
- <goals>
- <goal>start</goal>
- </goals>
- <configuration>
- <background>true</background>
- </configuration>
- </execution>
- </executions>
-</plugin>
-+----------+
-
-* Start Selenium Server (Standalone)
-
- To start Selenium on the command line, which is very useful while developing tests,
- simply execute the <<<start>>> goal.
-
- This will start the server and block until the server has been stopped, either
- from the process being killed, or more normally, until CTRL-C is used to exit
- Maven.
-
- This is the preferred mechanism to start the server standalone, as it will setup
- <<<user-extensions.js>>>.
-
-+----------+
-mvn selenium:start
-+----------+
-
+ ------
+ Basic Usage :: Geronimo Selenium Plugin for Maven 2
+ ------
+ ------
+ $Rev$ $Date$
+
+~~
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License. You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied. See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
+~~
+
+Basic Usage
+
+* Start Selenium Server (Integrated)
+
+ For integration tests that need a Selenium server, use the <<<pre-integration-test>>>
+ phase to start it up in the <background> to allow the <<<integration-test>>> phase to
+ be executed with the server running.
+
+ <<NOTE:>> Currently there is no <stop>, the forked JVM will exit when Maven does.
+
+ This will by default create files under <<<$\{pom.basedir\}/target/selenium>>>, including:
+
+ * <<<server.out>>>
+
+ * <<<server.err>>>
+
+ * <<<server.log>>>
+
+ * <<<user-extensions.js>>> (if enabled)
+
++----------+
+<plugin>
+ <groupId>org.apache.geronimo.plugins</groupId>
+ <artifactId>selenium-maven-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>start-selenium</id>
+ <phase>pre-integration-test</phase>
+ <goals>
+ <goal>start</goal>
+ </goals>
+ <configuration>
+ <background>true</background>
+ </configuration>
+ </execution>
+ </executions>
+</plugin>
++----------+
+
+* Start Selenium Server (Standalone)
+
+ To start Selenium on the command line, which is very useful while developing tests,
+ simply execute the <<<start>>> goal.
+
+ This will start the server and block until the server has been stopped, either
+ from the process being killed, or more normally, until CTRL-C is used to exit
+ Maven.
+
+ This is the preferred mechanism to start the server standalone, as it will setup
+ <<<user-extensions.js>>>.
+
++----------+
+mvn selenium:start
++----------+
+
Propchange: geronimo/server/trunk/maven-plugins/selenium-maven-plugin/src/site/apt/usage.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: geronimo/server/trunk/maven-plugins/selenium-maven-plugin/src/site/apt/usage.apt
------------------------------------------------------------------------------
svn:keywords = Date Author Id Revision HeadURL
Propchange: geronimo/server/trunk/maven-plugins/selenium-maven-plugin/src/site/apt/usage.apt
------------------------------------------------------------------------------
svn:mime-type = text/plain