From 5ae68b3709f11bdf84ea61bb672cb09dd8b464ce Mon Sep 17 00:00:00 2001 From: Takahiro Nagao Date: Fri, 24 Jun 2022 13:08:48 +0900 Subject: [PATCH] Update readme and usage --- README.adoc | 32 ++++++++++++++++++-------------- docs/Usage.adoc | 32 +++++++++++++++++++++++++++----- 2 files changed, 45 insertions(+), 19 deletions(-) diff --git a/README.adoc b/README.adoc index a0267f7..ce87a3d 100644 --- a/README.adoc +++ b/README.adoc @@ -4,22 +4,26 @@ == Overview Launcher is an implementation of https://microprofile.io/[MicroProfile]. -Launcher 3.0 conforms to MicroProfile 4.1. +Launcher 4.0 supports MicroProfile 5.0 and some APIs from Jakarta EE 9.1. Currently supported APIs are as follows: -* Jakarta Contexts and Dependency Injection 2.0 -* Jakarta RESTful Web Services 2.1 -* Jakarta JSON Binding 1.0 -* Jakarta JSON Processing 1.1 -* Jakarta Annotations 1.3 -* MicroProfile Config 2.0 -* MicroProfile Fault Tolerance 3.0 -* MicroProfile Health 3.1 -* MicroProfile JWT Authentication 1.2 -* MicroProfile Metrics 3.0 -* MicroProfile OpenAPI 2.0 -* MicroProfile OpenTracing 2.0 -* MicroProfile Rest Client 2.0 +* MicroProfile Config 3.0 +* MicroProfile Fault Tolerance 4.0 +* MicroProfile Health 4.0 +* MicroProfile JWT Authentication 2.0 +* MicroProfile Metrics 4.0 +* MicroProfile OpenAPI 3.0 +* MicroProfile OpenTracing 3.0 +* MicroProfile Rest Client 3.0 +* Jakarta Annotations 2.0 +* Jakarta Contexts and Dependency Injection 3.0 +* Jakarta Expression Language 4.0 +* Jakarta JSON Binding 2.0 +* Jakarta JSON Processing 2.0 +* Jakarta RESTful Web Services 3.0 +* Jakarta Server Pages 3.0 +* Jakarta Servlet 5.0 +* Jakarta Standard Tag Library 2.0 Launcher provides features to run MicroProfile applications and create portable uber (fat) JARs. For more details, please refer to link:docs/Usage.adoc[]. diff --git a/docs/Usage.adoc b/docs/Usage.adoc index afaeb76..9e83263 100644 --- a/docs/Usage.adoc +++ b/docs/Usage.adoc @@ -4,12 +4,20 @@ ---- java -jar launcher-.jar [--config-file file-path] + [--contextroot context-root] [--http-listener port-number] [--https-listener port-number] - [--contextroot context-root] [--libraries jar-filepath[,jar-filepath]*] + [--precompilejsp[=true|=false]] --deploy war-file - [--generate uber-jar] + [--generate uber-jar-filepath] +---- + +---- +java -jar launcher-.jar + [--config-file file-path] + --execute subcommand + subcommand-args... ---- === Options @@ -17,12 +25,21 @@ java -jar launcher-.jar |=== | Name | Description | Default Value | `--config-file` | Specify the path to configuration file (domain.xml). Do not use `--http-listener` or `--https-listener` when using this option. | +| `--contextroot` | Specify the context-root. | `/` +| `--deploy` | Specify the path to WAR file to deploy. This option is mandatory. | +| `--execute` | Specify the subcommand to execute. | +| `--generate` | Specify the path to uber JAR to generate. When this option is not specified, the application will run automatically. | | `--http-listener` | Specify HTTP port number. Do not use `--config-file` when using this option. | `8080` | `--https-listener` |Specify HTTPS port number. Do not use `--config-file` when using this option. | `8181` -| `--deploy` | Specify the path to WAR file to deploy. This option is mandatory. | -| `--contextroot` | Specify the context-root. | `/` | `--libraries` | Specify the paths to JAR files referred from the application. To specify more than one files, use comma (`,`) as a separator. Files specified in this option will not be included in the generated uber JAR. | -| `--generate` | Specify the path to uber JAR to generate. When this option is not specified, the application will run automatically. | +| `--precompilejsp` | Specify `true` to enable JSP precompilation; `false` to disable. | `false` +|=== + +=== Operands +[options="autowidth, header"] +|=== +| Name | Description +| `subcommand-args` | Specify options and operands for the subcommand. |=== == Examples @@ -36,3 +53,8 @@ $ java -jar launcher-.jar --deploy my-app.war $ java -jar launcher-.jar --deploy my-app.war --generate my-uber.jar $ java -jar my-uber.jar ---- + +* Example 3: Execute the `create-file-user` subcommand. +---- +$ java -jar launcher-.jar --config-file domain.xml --execute create-file-user --passwordfile password.txt user1 +----