Skip to content

Commit e3ffecd

Browse files
authored
Merge pull request #54 from tnagao7/update-docs
Update readme and usage
2 parents 8e6d270 + 5ae68b3 commit e3ffecd

File tree

2 files changed

+45
-19
lines changed

2 files changed

+45
-19
lines changed

README.adoc

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,26 @@
44
== Overview
55
Launcher is an implementation of https://microprofile.io/[MicroProfile].
66

7-
Launcher 3.0 conforms to MicroProfile 4.1.
7+
Launcher 4.0 supports MicroProfile 5.0 and some APIs from Jakarta EE 9.1.
88
Currently supported APIs are as follows:
99

10-
* Jakarta Contexts and Dependency Injection 2.0
11-
* Jakarta RESTful Web Services 2.1
12-
* Jakarta JSON Binding 1.0
13-
* Jakarta JSON Processing 1.1
14-
* Jakarta Annotations 1.3
15-
* MicroProfile Config 2.0
16-
* MicroProfile Fault Tolerance 3.0
17-
* MicroProfile Health 3.1
18-
* MicroProfile JWT Authentication 1.2
19-
* MicroProfile Metrics 3.0
20-
* MicroProfile OpenAPI 2.0
21-
* MicroProfile OpenTracing 2.0
22-
* MicroProfile Rest Client 2.0
10+
* MicroProfile Config 3.0
11+
* MicroProfile Fault Tolerance 4.0
12+
* MicroProfile Health 4.0
13+
* MicroProfile JWT Authentication 2.0
14+
* MicroProfile Metrics 4.0
15+
* MicroProfile OpenAPI 3.0
16+
* MicroProfile OpenTracing 3.0
17+
* MicroProfile Rest Client 3.0
18+
* Jakarta Annotations 2.0
19+
* Jakarta Contexts and Dependency Injection 3.0
20+
* Jakarta Expression Language 4.0
21+
* Jakarta JSON Binding 2.0
22+
* Jakarta JSON Processing 2.0
23+
* Jakarta RESTful Web Services 3.0
24+
* Jakarta Server Pages 3.0
25+
* Jakarta Servlet 5.0
26+
* Jakarta Standard Tag Library 2.0
2327

2428
Launcher provides features to run MicroProfile applications and create portable uber (fat) JARs.
2529
For more details, please refer to link:docs/Usage.adoc[].

docs/Usage.adoc

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,42 @@
44
----
55
java -jar launcher-<version>.jar
66
[--config-file file-path]
7+
[--contextroot context-root]
78
[--http-listener port-number]
89
[--https-listener port-number]
9-
[--contextroot context-root]
1010
[--libraries jar-filepath[,jar-filepath]*]
11+
[--precompilejsp[=true|=false]]
1112
--deploy war-file
12-
[--generate uber-jar]
13+
[--generate uber-jar-filepath]
14+
----
15+
16+
----
17+
java -jar launcher-<version>.jar
18+
[--config-file file-path]
19+
--execute subcommand
20+
subcommand-args...
1321
----
1422

1523
=== Options
1624
[options="autowidth, header"]
1725
|===
1826
| Name | Description | Default Value
1927
| `--config-file` | Specify the path to configuration file (domain.xml). Do not use `--http-listener` or `--https-listener` when using this option. |
28+
| `--contextroot` | Specify the context-root. | `/`
29+
| `--deploy` | Specify the path to WAR file to deploy. This option is mandatory. |
30+
| `--execute` | Specify the subcommand to execute. |
31+
| `--generate` | Specify the path to uber JAR to generate. When this option is not specified, the application will run automatically. |
2032
| `--http-listener` | Specify HTTP port number. Do not use `--config-file` when using this option. | `8080`
2133
| `--https-listener` |Specify HTTPS port number. Do not use `--config-file` when using this option. | `8181`
22-
| `--deploy` | Specify the path to WAR file to deploy. This option is mandatory. |
23-
| `--contextroot` | Specify the context-root. | `/`
2434
| `--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. |
25-
| `--generate` | Specify the path to uber JAR to generate. When this option is not specified, the application will run automatically. |
35+
| `--precompilejsp` | Specify `true` to enable JSP precompilation; `false` to disable. | `false`
36+
|===
37+
38+
=== Operands
39+
[options="autowidth, header"]
40+
|===
41+
| Name | Description
42+
| `subcommand-args` | Specify options and operands for the subcommand.
2643
|===
2744

2845
== Examples
@@ -36,3 +53,8 @@ $ java -jar launcher-<version>.jar --deploy my-app.war
3653
$ java -jar launcher-<version>.jar --deploy my-app.war --generate my-uber.jar
3754
$ java -jar my-uber.jar
3855
----
56+
57+
* Example 3: Execute the `create-file-user` subcommand.
58+
----
59+
$ java -jar launcher-<version>.jar --config-file domain.xml --execute create-file-user --passwordfile password.txt user1
60+
----

0 commit comments

Comments
 (0)