docs: Update help and README

This commit is contained in:
Serge Guzik 2019-02-18 16:37:27 +02:00
parent e8de4b7e8e
commit a118ec64db
2 changed files with 9 additions and 7 deletions

View File

@ -43,11 +43,11 @@ my-app.jar
warped warped
$ ls warped $ ls warped
my-app-linux my-app-linux-x64
my-app-linux-x64.tar.gz my-app-linux-x64.tar.gz
my-app-macos my-app-macos-x64
my-app-macos-x64.tar.gz my-app-macos-x64.tar.gz
my-app-windows.exe my-app-windows-x64.exe
my-app-windows-x64.zip my-app-windows-x64.zip
``` ```
@ -76,7 +76,7 @@ Options:
"--java-version" "--java-version"
--no-optimize use JRE instead of optimized JDK; --no-optimize use JRE instead of optimized JDK;
by default jdeps and jlink are used to create by default jdeps and jlink are used to create
optimized JDK for the partiular jar, optimized JDK for the particular jar;
JRE is always used for java 8 JRE is always used for java 8
--pull check if more recent JDK/JRE distro is available; --pull check if more recent JDK/JRE distro is available;
by default latest cached version that matches by default latest cached version that matches
@ -90,7 +90,7 @@ Options:
(default: hotspot) (default: hotspot)
--jvm-options <options> --jvm-options <options>
passed to java like this: passed to java like this:
"java <options> -jar <jar file>" "java <options> -jar <jar file>";
use quotes when passing multiple options use quotes when passing multiple options
example: '-Xms512m -Xmx1024m' example: '-Xms512m -Xmx1024m'
-h, --help show this message -h, --help show this message
@ -110,3 +110,5 @@ Downloaded runtimes and prepared bundles are here:
- Linux: `$HOME/.local/share/warp4j` - Linux: `$HOME/.local/share/warp4j`
- macOS: `$HOME/Library/Application Support/warp4j` - macOS: `$HOME/Library/Application Support/warp4j`
To override cache path, set `WARP4J_CACHE` environment variable.

4
warp4j
View File

@ -22,7 +22,7 @@ function print_help {
echo ' "--java-version"' echo ' "--java-version"'
echo ' --no-optimize use JRE instead of optimized JDK;' echo ' --no-optimize use JRE instead of optimized JDK;'
echo ' by default jdeps and jlink are used to create' echo ' by default jdeps and jlink are used to create'
echo ' optimized JDK for the partiular jar,' echo ' optimized JDK for the particular jar;'
echo ' JRE is always used for java 8' echo ' JRE is always used for java 8'
echo ' --pull check if more recent JDK/JRE distro is available;' echo ' --pull check if more recent JDK/JRE distro is available;'
echo ' by default latest cached version that matches' echo ' by default latest cached version that matches'
@ -36,7 +36,7 @@ function print_help {
echo ' (default: hotspot)' echo ' (default: hotspot)'
echo ' --jvm-options <options>' echo ' --jvm-options <options>'
echo ' passed to java like this:' echo ' passed to java like this:'
echo ' "java <options> -jar <jar file>"' echo ' "java <options> -jar <jar file>";'
echo ' use quotes when passing multiple options' echo ' use quotes when passing multiple options'
echo " example: '-Xms512m -Xmx1024m'" echo " example: '-Xms512m -Xmx1024m'"
echo ' -h, --help show this message' echo ' -h, --help show this message'