Skip to content

docs: cross-platform compatibility updates #2331

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
maxandersen merged 2 commits into from
Nov 22, 2025
Merged

docs: cross-platform compatibility updates #2331

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8204b5c
docs: cross-platform compatibility updates
wfouche Nov 22, 2025
88d4a72
fix: make it clear that the JVM fails and not JBang
wfouche Nov 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/modules/ROOT/pages/execution-options.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,16 @@ Or from command line:
jbang --runtime-option="-Xmx2g" --runtime-option="--enable-preview" myapp.java
----

=== Runtime Options (Cross-Platform Compatibility)

Most standard Java VM (JVM) options are generic and can be used on all Java versions and on all OS platforms, but some JVM options are platform-specific. If a OS specific option is used on a OS platform that do not support the specific option, the JVM will display an error message and terminate. To prevent this from happening, also add JVM option

* `-XX:+IgnoreUnrecognizedVMOptions`

On macOS, some Java application require option `-XstartOnFirstThread` to be set. You can add this option using `//RUNTIME_OPTIONS` or `--runtime-option`. To ensure that the Java application continue work on other platforms use JBang runtime options:

* `//RUNTIME_OPTIONS -XX:+IgnoreUnrecognizedVMOptions -XstartOnFirstThread`

=== Compile Options

Control the Java compiler with `//COMPILE_OPTIONS` or `--compile-option`:
Expand Down