Skip to content

Commit

Permalink
docs/tools/ikvm.md: Grouped options in a similar way as the java.exe …
Browse files Browse the repository at this point in the history
…documentation.
  • Loading branch information
NightOwl888 committed Jul 10, 2022
1 parent 084f3bf commit bbc4a75
Showing 1 changed file with 24 additions and 6 deletions.
30 changes: 24 additions & 6 deletions docs/tools/ikvm.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,28 @@ Command-line arguments passed to the main class.

## Options

| Source | Description |
### Standard Options

| <span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span>Source<span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span> | <span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span>Description<span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span> |
|---|---|
| `-?\|-help` | Displays command syntax and options for the tool. |
| `-version` | Displays IKVM and runtime version. |
| `-showversion` | Display version and continue running. |
| `-cp\|-classpath` | &lt;directories and zip/jar files separated by ;&gt; Set search path for application classes and resources. |
| `-jar` | Run a jar file. |
| `-D<property>=<value>` | Set a Java system property. |
| `-ea\|-enableassertions[:[<packagename>\|<classname>]]` | Set Java system property to enable assertions. A class name or package name can be specified to enable assertions for a specific class or package. |
| `-da\|-disableassertions[:[<packagename>\|<classname>]]` | Set Java system property to disable assertions. A class name or package name can be specified to disable assertions for a specific class or package. |
| `-esa\|-enablesystemassertions` | Set Java system property to enable system assertions. |
| `-dsa\|-disablesystemassertions` | Set Java system property to disable system assertions. |
| `-D<name>=<value>` | Set a Java system property. |
| `-ea\|-enableassertions[:<packagename> [<packagename>...] \|:<classname>]` | Set Java system property to enable assertions. |
| `-da\|-disableassertions[:<packagename> [<packagename>...] \|:<classname>]` | Set Java system property to disable assertions. |
| `-Xsave` | Save the generated assembly (for debugging). |

### Extra Options

| <span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span>Source<span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span> | <span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span>Description<span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span> |
|---|---|
| `-X` | Displays command syntax and options for the `-X<name>` command options. |
| `-Xsave\|-XXsave` | Save the generated assembly (for debugging). |
| `-Xtime` | Time the execution. |
| `-Xtrace:<string>` | Displays all trace points with the given name. |
| `-Xmethodtrace:<string>` | Builds method trace into the specified output methods. |
Expand All @@ -47,11 +59,17 @@ Command-line arguments passed to the main class.
| `-Xnoglobbing` | Disable argument globbing. |
| `-Xverify` | Enable strict class file verification. |
| `-Xreference:<path>/<assembly>.dll` | Add a assembly (dll or exe) as reference to the classpath. This equals the C# code `Startup.addBootClassPathAssemby(Assembly.LoadFrom(name));`. |
| `-jar` | Run a jar file. |
| `-Xdebug` | Enable debugging. |
| `-Xnoagent` | For compatibility with java.exe. This option will be ignored and a warning will be print to the console. |
| `-XX:+AllowNonVirtualCalls` | Allow non-virtual calls. |

### Java Compatibility Options

The Java HotSpot Virtual Machine is not supported by the `ikvm` tool. But several of the parameters will print warning messages if they are provided and do not halt execution of `ikvm`.

| <span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span>Source<span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span> | <span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span>Description<span>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span> |
|---|---|
| `-XX:<anything>` | For compatibility with java.exe. This option will be ignored and a warning will be print to the console. |
| `-Xnoagent` | For compatibility with java.exe. This option will be ignored and a warning will be print to the console. |
| `-Xms` | For compatibility with java.exe. This option will be ignored and a warning will be print to the console. |
| `-Xmx` | For compatibility with java.exe. This option will be ignored and a warning will be print to the console. |
| `-Xss` | For compatibility with java.exe. This option will be ignored and a warning will be print to the console. |
Expand Down

0 comments on commit bbc4a75

Please sign in to comment.