Skip to content

Commit 7ca0aa1

Browse files
committed
Update windows-specific-properties.md
1 parent 54240af commit 7ca0aa1

File tree

1 file changed

+1
-54
lines changed

1 file changed

+1
-54
lines changed

docs/windows-specific-properties.md

Lines changed: 1 addition & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -27,57 +27,4 @@
2727
| `internalName` | :x: | `${name}` | |
2828
| `originalFilename` | :x: | `${name}.exe` | |
2929
| `trademark` | :x: | `null` | |
30-
| `language` | :x: | `null` | |
31-
32-
33-
#### Mac OS X config property
34-
35-
```xml
36-
<macConfig>
37-
<!-- properties used in DMG disk image generation -->
38-
<backgroundImage>path/to/png</backgroundImage>
39-
<windowX>x</windowX>
40-
<windowY>y</windowY>
41-
<windowWidth>width</windowWidth>
42-
<windowHeight>height</windowHeight>
43-
<iconSize>size</iconSize>
44-
<textSize>size</textSize>
45-
<iconX>x</iconX>
46-
<iconY>y</iconY>
47-
<appsLinkIconX>x</appsLinkIconX>
48-
<appsLinkIconY>y</appsLinkIconY>
49-
<volumeIcon>path/to/icns</volumeIcon>
50-
<volumeName>${name}</volumeName>
51-
</macConfig>
52-
```
53-
54-
| Property | Mandatory | Default value | Description |
55-
| ----------------------- | ------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
56-
| `additionalModules` | :x: | `[]` | Additional modules to the ones identified by `jdeps` or the specified with `modules` property. |
57-
| `additionalResources` | :x: | `[]` | Additional files and folders to include in the bundled app. |
58-
| `administratorRequired` | :x: | `false` | App will run as administrator (with elevated privileges). |
59-
| `bundleJre` | :x: | `false` | Embeds a customized JRE with the app. |
60-
| `copyDependencies` | :x: | `true` | Bundles all dependencies (JAR files) with the app. |
61-
| `createTarball` | :x: | `false` | Bundles app folder in tarball. |
62-
| `createZipball` | :x: | `false` | Bundles app folder in zipball. |
63-
| `customizedJre` | :x: | `true` | Generates a customized JRE, including only identified or specified modules. Otherwise, all modules will be included. |
64-
| `description` | :x: | `${project.description}` or `${displayName}` | Project description. |
65-
| `displayName` | :x: | `${project.name}` or `${name}` | App name to show. |
66-
| `envPath` | :x: | `null` | Defines PATH environment variable in GNU/Linux and Mac OS X startup scripts. |
67-
| `generateInstaller` | :x: | `true` | Generates an installer for the app. |
68-
| `iconFile` | :x: | `null` | Path to the app icon file (PNG, XPM, ICO or ICNS). |
69-
| `jreDirectoryName` | :x: | `"jre"` | Bundled JRE directory name. |
70-
| `jrePath` | :x: | `""` | Path to JRE folder. If specified, it will bundle this JRE with the app, and won't generate a customized JRE. For Java 8 version or least. |
71-
| `licenseFile` | :x: | `${project.licenses[0].url}` or `${project.basedir}/LICENSE` | Path to project license file. |
72-
| `mainClass` | :heavy_check_mark: | `${exec.mainClass}` | Full path to your app main class. |
73-
| `modules` | :x: | `[]` | Defines modules to customize the bundled JRE. Don't use `jdeps` to get module dependencies. |
74-
| `name` | :x: | `${project.name}` or `${project.artifactId}` | App name. |
75-
| `organizationName` | :x: | `${project.organization.name}` or `"ACME"` | Organization name. |
76-
| `organizationUrl` | :x: | `${project.organization.url}` | Organization website URL. |
77-
| `organizationEmail` | :x: | `null` | Organization email. |
78-
| `platform` | :x: | `auto` | Defines the target platform, which could be different to the execution platform. Possible values: `auto`, `mac`, `linux`, `windows`. Use `auto` for using execution platform as target. |
79-
| `runnableJar` | :x: | `null` | Defines your own JAR file to be bundled. If it's ommited, the plugin packages your code in a runnable JAR and bundle it with the app. |
80-
| `url` | :x: | `null` | App website URL. |
81-
| ` version` | :x: | `${project.version}` | Project version. |
82-
| `versionInfo` | :x: | `null` | Version information for native Windows `.exe` file. :warning: **Deprecated. Use `winConfig` instead**. |
83-
| `vmArgs` | :x: | `[]` | Adds VM arguments. |
30+
| `language` | :x: | `null` | |

0 commit comments

Comments
 (0)