javapackager.1 26.9 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107
'\" t
.\" Copyright (c) 2011, 2015, Oracle and/or its affiliates. All rights reserved.
.\"
.\" Title: javapackager
.\" Language: English
.\" Date: 03 March 2015
.\" SectDesc: Java Deployment Tools
.\" Software: JDK 8
.\" Arch: Generic
.\" Part Number: E38209-04
.\" Doc ID: JSSOR
.\"
.if n .pl 99999
.TH "javapackager" "1" "03 March 2015" "JDK 8" "Java Deployment Tools"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
javapackager \- Performs tasks related to packaging and signing Java and JavaFX applications\&.
.SH "SYNOPSIS"
.sp
.if n \{\
.RS 4
.\}
.nf
\fBjavapackager\fR \fIcommand\fR [\fIoptions\fR]
.fi
.if n \{\
.RE
.\}
.PP
\fIcommand\fR
.RS 4
The task that should be performed\&.
.RE
.PP
options
.RS 4
One or more options for the command separated by spaces\&.
.RE
.SH "COMMANDS"
.PP
You can specify one of the following commands\&. After the command, specify the options for it\&.
.PP
\-createbss
.RS 4
Converts CSS files into binary form\&.
.RE
.PP
\-createjar
.RS 4
Produces a JAR archive according to other parameters\&.
.RE
.PP
\-deploy
.RS 4
Assembles the application package for redistribution\&. By default, the deploy task generates the base application package, but it can also generate a self\-contained application package if requested\&.
.RE
.PP
\-makeall
.RS 4
Performs compilation,
\fBcreatejar\fR, and
\fBdeploy\fR
steps as one call, with most arguments predefined, and attempts to generate all applicable self\-contained application packages\&. The source files must be located in a folder called
\fBsrc\fR, and the resulting files (JAR, JNLP, HTML, and self\-contained application packages) are put in a folder called
\fBdist\fR\&. This command can only be configured in a minimal way and is as automated as possible\&.
.RE
.PP
\-signjar
.RS 4
Signs JAR file(s) with a provided certificate\&.
.RE
.SH "OPTIONS FOR THE CREATEBSS COMMAND"
.PP
\-outdir \fIdir\fR
.RS 4
Name of the directory that will receive generated output files\&.
.RE
.PP
\-srcdir \fIdir\fR
.RS 4
Base directory of the files to package\&.
.RE
.PP
\-srcfiles \fIfiles\fR
.RS 4
List of files in the directory specified by the
\fB\-srcdir\fR
option\&. If omitted, all files in the directory (which is a mandatory argument in this case) will be used\&. Files in the list must be separated by spaces\&.
.RE
.SH "OPTIONS FOR THE CREATEJAR COMMAND"
.PP
\-appclass \fIapp\-class\fR
.RS 4
Qualified name of the application class to be executed\&.
.RE
.PP
\-argument \fIarg\fR
.RS 4
An unnamed argument to be inserted into the JNLP file as an
\fB<fx:argument>\fR
element\&.
.RE
.PP
\-classpath \fIfiles\fR
.RS 4
List of dependent JAR file names\&.
.RE
.PP
\-manifestAttrs \fImanifest\-attributes\fR
.RS 4
List of names and values for additional manifest attributes\&. Syntax:
.sp
.if n \{\
.RS 4
.\}
.nf
\fB"name1=value1,name2=value2,name3=value3"\fR
 
.fi
.if n \{\
.RE
.\}
.RE
.PP
\-nocss2bin
.RS 4
The packager will not convert CSS files to binary form before copying to JAR\&.
.RE
.PP
\-outdir \fIdir\fR
.RS 4
Name of the directory that will receive generated output files\&.
.RE
.PP
\-outfile \fIfilename\fR
.RS 4
Name (without the extension) of the file that will be generated\&.
.RE
.PP
\-paramfile \fIfile\fR
.RS 4
A properties file with default named application parameters\&.
.RE
.PP
\-preloader \fIpreloader\-class\fR
.RS 4
Qualified name of the JavaFX preloader class to be executed\&. Use this option only for JavaFX applications\&. Do not use for Java applications, including headless applications\&.
.RE
.PP
\-srcdir \fIdir\fR
.RS 4
Base directory of the files to package\&.
.RE
.PP
\-srcfiles \fIfiles\fR
.RS 4
List of files in the directory specified by the
\fB\-srcdir\fR
option\&. If omitted, all files in the directory (which is a mandatory argument in this case) will be used\&. Files in the list must be separated by spaces\&.
.RE
.SH "OPTIONS FOR THE DEPLOY COMMAND"
.PP
\-allpermissions
.RS 4
If present, the application will require all security permissions in the JNLP file\&.
.RE
.PP
\-appclass \fIapp\-class\fR
.RS 4
Qualified name of the application class to be executed\&.
.RE
.PP
\-argument \fIarg\fR
.RS 4
An unnamed argument to be inserted into an
\fB<fx:argument>\fR
element in the JNLP file\&.
.RE
.PP
\-B\fIbundler\-argument=value\fR
.RS 4
Provides information to the bundler that is used to package a self\-contained application\&. See Arguments for Self\-Contained Application Bundlers for information on the arguments for each bundler\&.
.RE
.PP
\-callbacks
.RS 4
Specifies user callback methods in generated HTML\&. The format is the following:
.sp
.if n \{\
.RS 4
.\}
.nf
\fB"name1:value1,name2:value2,\&.\&.\&."\fR
 
.fi
.if n \{\
.RE
.\}
.RE
.PP
\-description \fIdescription\fR
.RS 4
Description of the application\&.
.RE
.PP
\-embedCertificates
.RS 4
If present, the certificates will be embedded in the JNLP file\&.
.RE
.PP
\-embedjnlp
.RS 4
If present, the JNLP file will be embedded in the HTML document\&.
.RE
.PP
\-height \fIheight\fR
.RS 4
Height of the application\&.
.RE
.PP
\-htmlparamfile \fIfile\fR
.RS 4
Properties file with parameters for the resulting application when it is run in the browser\&.
.RE
.PP
\-isExtension
.RS 4
If present, the
\fBsrcfiles\fR
are treated as extensions\&.
.RE
.PP
\-name \fIname\fR
.RS 4
Name of the application\&.
.RE
.PP
\-native \fItype\fR
.RS 4
Generate self\-contained application bundles (if possible)\&. Use the
\fB\-B\fR
option to provide arguments to the bundlers being used\&. If
\fItype\fR
is specified, then only a bundle of this type is created\&. If no type is specified,
\fBall\fR
is used\&.
.sp
The following values are valid for
\fItype\fR:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBall\fR: Runs all of the installers for the platform on which it is running, and creates a disk image for the application\&. This value is used if
\fItype\fR
is not specified\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBinstaller\fR: Runs all of the installers for the platform on which it is running\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBimage\fR: Creates a disk image for the application\&. On OS X, the image is the
\fB\&.app\fR
file\&. On Linux, the image is the directory that gets installed\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBdmg\fR: Generates a DMG file for OS X\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBpkg\fR: Generates a
\fB\&.pkg\fR
package for OS X\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBmac\&.appStore\fR: Generates a package for the Mac App Store\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBrpm\fR: Generates an RPM package for Linux\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBdeb\fR: Generates a Debian package for Linux\&.
.RE
.RE
.PP
\-nosign
.RS 4
If present, the bundle generated for self\-contained applications is not signed by the bundler\&. The default for bundlers that support signing is to sign the bundle if signing keys are properly configured\&. This attribute is ignored by bundlers that do not support signing\&. At the time of the 8u40 release of the JDK, only OS X bundlers support signing\&.
.RE
.PP
\-outdir \fIdir\fR
.RS 4
Name of the directory that will receive generated output files\&.
.RE
.PP
\-outfile \fIfilename\fR
.RS 4
Name (without the extension) of the file that will be generated\&.
.RE
.PP
\-paramfile \fIfile\fR
.RS 4
Properties file with default named application parameters\&.
.RE
.PP
\-preloader \fIpreloader\-class\fR
.RS 4
Qualified name of the JavaFX preloader class to be executed\&. Use this option only for JavaFX applications\&. Do not use for Java applications, including headless applications\&.
.RE
.PP
\-srcdir \fIdir\fR
.RS 4
Base directory of the files to package\&.
.RE
.PP
\-srcfiles \fIfiles\fR
.RS 4
List of files in the directory specified by the
\fB\-srcdir\fR
option\&. If omitted, all files in the directory (which is a mandatory argument in this case) will be used\&. Files in the list must be separated by spaces\&.
.RE
.PP
\-templateId
.RS 4
Application ID of the application for template processing\&.
.RE
.PP
\-templateInFilename
.RS 4
Name of the HTML template file\&. Placeholders are in the following form:
.sp
.if n \{\
.RS 4
.\}
.nf
\fB#XXXX\&.YYYY(APPID)#\fR
 
.fi
.if n \{\
.RE
.\}
Where APPID is the identifier of an application and XXX is one of following:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBDT\&.SCRIPT\&.URL\fR
.sp
Location of dtjava\&.js in the Deployment Toolkit\&. By default, the location is
.sp
http://java\&.com/js/dtjava\&.js
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBDT\&.SCRIPT\&.CODE\fR
.sp
Script element to include dtjava\&.js of the Deployment Toolkit\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBDT\&.EMBED\&.CODE\&.DYNAMIC\fR
.sp
Code to embed the application into a given placeholder\&. It is expected that the code will be wrapped in the
\fBfunction()\fR
method\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBDT\&.EMBED\&.CODE\&.ONLOAD\fR
.sp
All the code needed to embed the application into a web page using the
\fBonload\fR
hook (except inclusion of dtjava\&.js)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBDT\&.LAUNCH\&.CODE\fR
.sp
Code needed to launch the application\&. It is expected that the code will be wrapped in the
\fBfunction()\fR
method\&.
.RE
.RE
.PP
\-templateOutFilename
.RS 4
Name of the HTML file that will be generated from the template\&.
.RE
.PP
\-title \fItitle\fR
.RS 4
Title of the application\&.
.RE
.PP
\-vendor \fIvendor\fR
.RS 4
Vendor of the application\&.
.RE
.PP
\-width \fIwidth\fR
.RS 4
Width of the application\&.
.RE
.PP
\-updatemode \fIupdate\-mode\fR
.RS 4
Sets the update mode for the JNLP file\&.
.RE
.SH "OPTIONS FOR THE MAKEALL COMMAND"
.PP
\-appclass \fIapp\-class\fR
.RS 4
Qualified name of the application class to be executed\&.
.RE
.PP
\-classpath \fIfiles\fR
.RS 4
List of dependent JAR file names\&.
.RE
.PP
\-height \fIheight\fR
.RS 4
Height of the application\&.
.RE
.PP
\-name \fIname\fR
.RS 4
Name of the application\&.
.RE
.PP
\-preloader \fIpreloader\-class\fR
.RS 4
Qualified name of the JavaFX preloader class to be executed\&. Use this option only for JavaFX applications\&. Do not use for Java applications, including headless applications\&.
.RE
.PP
\-width \fIwidth\fR
.RS 4
Width of the application\&.
.RE
.SH "OPTIONS FOR THE SIGNJAR COMMAND"
.PP
\-alias
.RS 4
Alias for the key\&.
.RE
.PP
\-keyPass
.RS 4
Password for recovering the key\&.
.RE
.PP
\-keyStore \fIfile\fR
.RS 4
Keystore file name\&.
.RE
.PP
\-outdir \fIdir\fR
.RS 4
Name of the directory that will receive generated output files\&.
.RE
.PP
\-srcdir \fIdir\fR
.RS 4
Base directory of the files to be signed\&.
.RE
.PP
\-srcfiles \fIfiles\fR
.RS 4
List of files in the directory specified by the
\fB\-srcdir\fR
option\&. If omitted, all files in the directory (which is a mandatory argument in this case) will be used\&. Files in the list must be separated by spaces\&.
.RE
.PP
\-storePass
.RS 4
Password to check integrity of the keystore or unlock the keystore
.RE
.PP
\-storeType
.RS 4
Keystore type\&. The default value is "jks"\&.
.RE
.SH "ARGUMENTS FOR SELF-CONTAINED APPLICATION BUNDLERS"
.PP
The
\fB\-B\fR
option for the
\fB\-deploy\fR
command is used to specify arguments for the bundler that is used to create self\-contained applications\&. Each type of bundler has its own set of arguments\&.
.SS "General Bundler Arguments"
.PP
appVersion=\fIversion\fR
.RS 4
Version of the application package\&. Some bundlers restrict the format of the version string\&.
.RE
.PP
classPath=\fIpath\fR
.RS 4
Class path relative to the assembled application directory\&. The path is typically extracted from the JAR file manifest, and does not need to be set if you are using the other
\fBjavapackager\fR
commands\&.
.RE
.PP
icon=\fIpath\fR
.RS 4
Location of the default icon to be used for launchers and other assists\&. For OS X, the format must be
\fB\&.icns\fR\&. For Linux, the format must be
\fB\&.png\fR\&.
.RE
.PP
identifier=\fIvalue\fR
.RS 4
Default value that is used for other platform\-specific values such as
\fBmac\&.CFBundleIdentifier\fR\&. Reverse DNS order is recommended, for example,
\fBcom\&.example\&.application\&.my\-application\fR\&.
.RE
.PP
jvmOptions=\fIoption\fR
.RS 4
Option to be passed to the JVM when the application is run\&. Any option that is valid for the
\fBjava\fR
command can be used\&. To pass more than one option, use multiple instances of the
\fB\-B\fR
option, as shown in the following example:
.sp
.if n \{\
.RS 4
.\}
.nf
\fB\-BjvmOptions=\-Xmx128m \-BjvmOptions=\-Xms128m\fR
 
.fi
.if n \{\
.RE
.\}
.RE
.PP
jvmProperties=\fIproperty\fR=\fIvalue\fR
.RS 4
Java System Property to be passed to the VM when the application is run\&. Any property that is valid for the
\fB\-D\fR
option of the
\fBjava\fR
command can be used\&. Specify both the property name and the value for the property\&. To pass more than one property, use multiple instances of the
\fB\-B\fR
option, as shown in the following example:
.sp
.if n \{\
.RS 4
.\}
.nf
\fB\-BjvmProperties=apiUserName=example \-BjvmProperties=apiKey=abcdef1234567890\fR
 
.fi
.if n \{\
.RE
.\}
.RE
.PP
mainJar=\fIfilename\fR
.RS 4
Name of the JAR file that contains the main class for the application\&. The file name is typically extracted from the JAR file manifest, and does not need to be set if you are using the other
\fBjavapackager\fR
commands\&.
.RE
.PP
preferencesID=\fInode\fR
.RS 4
Preferences node to examine to check for JVM options that the user can override\&. The node specified is passed to the application at run time as the option
\fB\-Dapp\&.preferences\&.id\fR\&. This argument is used with the
\fBuserJVMOptions\fR
argument\&.
.RE
.PP
runtime=\fIpath\fR
.RS 4
Location of the JRE or JDK to include in the package bundle\&. Provide a file path to the root folder of the JDK or JRE\&. To use the system default JRE, do not provide a path, as shown in the following example:
.sp
.if n \{\
.RS 4
.\}
.nf
\fB\-Bruntime=\fR
 
.fi
.if n \{\
.RE
.\}
.RE
.PP
userJvmOptions=\fIoption\fR=\fIvalue\fR
.RS 4
JVM options that users can override\&. Any option that is valid for the
\fBjava\fR
command can be used\&. Specify both the option name and the value for the option\&. To pass more than one option, use multiple instances of the
\fB\-B\fR
option, as shown in the following example:
.sp
.if n \{\
.RS 4
.\}
.nf
\fB\-BuserJvmOptions=\-Xmx=128m \-BuserJvmOptions=\-Xms=128m\fR
 
.fi
.if n \{\
.RE
.\}
.RE
.SS "OS X Application Bundler Arguments"
.PP
mac\&.category=\fIcategory\fR
.RS 4
Category for the application\&. The category must be in the list of categories found on the Apple Developer website\&.
.RE
.PP
mac\&.CFBundleIdentifier=\fIvalue\fR
.RS 4
Value stored in the info plist for
\fBCFBundleIdentifier\fR\&. This value must be globally unique and contain only letters, numbers, dots, and dashes\&. Reverse DNS order is recommended, for example,
\fBcom\&.example\&.application\&.my\-application\fR\&.
.RE
.PP
mac\&.CFBundleName=\fIname\fR
.RS 4
Name of the application as it appears on the OS X Menu Bar\&. A name of less than 16 characters is recommended\&. The default is the name attribute\&.
.RE
.PP
mac\&.CFBundleVersion=\fIvalue\fR
.RS 4
Version number for the application, used internally\&. The value must be at least one integer and no more than three integers separated by periods (\&.) for example, 1\&.3 or 2\&.0\&.1\&. The value can be different than the value for the
\fBappVersion\fR
argument\&. If the
\fBappVersion\fR
argument is specified with a valid value and the
\fBmac\&.CFBundleVersion\fR
argument is not specified, then the
\fBappVersion\fR
value is used\&. If neither argument is specified,
\fB100\fR
is used as the version number\&.
.RE
.PP
mac\&.signing\-key\-developer\-id\-app=\fIkey\fR
.RS 4
Name of the signing key used for Devleloper ID or Gatekeeper signing\&. If you imported a standard key from the Apple Developer Website, then that key is used by default\&. If no key can be identified, then the application is not signed\&.
.RE
.PP
mac\&.bundle\-id\-signing\-prefix=\fIprefix\fR
.RS 4
Prefix that is applied to the signed binary when binaries that lack plists or existing signatures are found inside the bundles\&.
.RE
.SS "OS X DMG (Disk Image) Bundler Arguments"
.PP
The OS X DMG installer shows the license file specified by
\fBlicenseFile\fR, if provided, before allowing the disk image to be mounted\&.
.PP
licenseFile=\fIpath\fR
.RS 4
Location of the End User License Agreement (EULA) to be presented or recorded by the bundler\&. The path is relative to the packaged application resources, for example,
\fB\-BlicenseFile=COPYING\fR\&.
.RE
.PP
systemWide=\fIboolean\fR
.RS 4
Flag that indicates which drag\-to\-install target to use\&. Set to
\fBtrue\fR
to show the Applications folder\&. Set to
\fBfalse\fR
to show the Desktop folder\&. The default is
\fBtrue\fR\&.
.RE
.PP
mac\&.CFBundleVersion=\fIvalue\fR
.RS 4
Version number for the application, used internally\&. The value must be at least one integer and no more than three integers separated by periods (\&.) for example, 1\&.3 or 2\&.0\&.1\&. The value can be different than the value for the
\fBappVersion\fR
argument\&. If the
\fBappVersion\fR
argument is specified with a valid value and the
\fBmac\&.CFBundleVersion\fR
argument is not specified, then the
\fBappVersion\fR
value is used\&. If neither argument is specified,
\fB100\fR
is used as the version number\&.
.RE
.PP
mac\&.dmg\&.simple=\fIboolean\fR
.RS 4
Flag that indicates if DMG customization steps that depend on executing AppleScript code are skipped\&. Set to
\fBtrue\fR
to skip the steps\&. When set to
\fBtrue\fR, the disk window does not have a background image, and the icons are not moved into place\&. If the
\fBsystemWide\fR
argument is also set to
\fBtrue\fR, then a symbolic link to the root Applications folder is added to the DMG file\&. If the
\fBsystemWide\fR
argument is set to
\fBfalse\fR, then only the application is added to the DMG file, no link to the desktop is added\&.
.RE
.SS "OS X PKG Bundler Arguments"
.PP
The OS X PKG installer presents a wizard and shows the license file specified by
\fBlicenseFile\fR
as one of the pages in the wizard\&. The user must accept the terms before installing the application\&.
.PP
licenseFile=\fIpath\fR
.RS 4
Location of the End User License Agreement (EULA) to be presented or recorded by the bundler\&. The path is relative to the packaged application resources, for example,
\fB\-BlicenseFile=COPYING\fR\&.
.RE
.PP
mac\&.signing\-key\-developer\-id\-installer=\fIkey\fR
.RS 4
Name of the signing key used for Developer ID or Gatekeeper signing\&. If you imported a standard key from the Apple Developer Website, then that key is used by default\&. If no key can be identified, then the application is not signed\&.
.RE
.PP
mac\&.CFBundleVersion=\fIvalue\fR
.RS 4
Version number for the application, used internally\&. The value must be at least one integer and no more than three integers separated by periods (\&.) for example, 1\&.3 or 2\&.0\&.1\&. The value can be different than the value for the
\fBappVersion\fR
argument\&. If the
\fBappVersion\fR
argument is specified with a valid value and the
\fBmac\&.CFBundleVersion\fR
argument is not specified, then the
\fBappVersion\fR
value is used\&. If neither argument is specified,
\fB100\fR
is used as the version number\&.
.RE
.SS "Mac App Store Bundler Arguments"
.PP
mac\&.app\-store\-entitlements=\fIpath\fR
.RS 4
Location of the file that contains the entitlements that the application operates under\&. The file must be in the format specified by Apple\&. The path to the file can be specified in absolute terms, or relative to the invocation of
\fBjavapackager\fR\&. If no entitlements are specified, then the application operates in a sandbox that is stricter than the typical applet sandbox, and access to network sockets and all files is prevented\&.
.RE
.PP
mac\&.signing\-key\-app=\fIkey\fR
.RS 4
Name of the application signing key for the Mac App Store\&. If you imported a standard key from the Apple Developer Website, then that key is used by default\&. If no key can be identified, then the application is not signed\&.
.RE
.PP
mac\&.signing\-key\-pkg=\fIkey\fR
.RS 4
Name of the installer signing key for the Mac App Store\&. If you imported a standard key from the Apple Developer Website, then that key is used by default\&. If no key can be identified, then the application is not signed\&.
.RE
.PP
mac\&.CFBundleVersion=\fIvalue\fR
.RS 4
Version number for the application, used internally\&. The value must be at least one integer and no more than three integers separated by periods (\&.) for example, 1\&.3 or 2\&.0\&.1\&. The value can be different than the value for the
\fBappVersion\fR
argument\&. If the
\fBappVersion\fR
argument is specified with a valid value and the
\fBmac\&.CFBundleVersion\fR
argument is not specified, then the
\fBappVersion\fR
value is used\&. If neither argument is specified,
\fB100\fR
is used as the version number\&. If this version is an upgrade for an existing application, the value must be greater than previous version number\&.
.RE
.SS "Linux Debian Bundler Arguments"
.PP
The license file specified by
\fBlicenseFile\fR
is not presented to the user in all cases, but the file is included in the application metadata\&.
.PP
category=\fIcategory\fR
.RS 4
Category for the application\&. See http://standards\&.freedesktop\&.org/menu\-spec/latest/apa\&.html for examples\&.
.RE
.PP
copyright=\fIstring\fR
.RS 4
Copyright string for the application\&. This argument is used in the Debian metadata\&.
.RE
.PP
email=\fIaddress\fR
.RS 4
Email address used in the Debian Maintainer field\&.
.RE
.PP
licenseFile=\fIpath\fR
.RS 4
Location of the End User License Agreement (EULA) to be presented or recorded by the bundler\&. The path is relative to the packaged application resources, for example,
\fB\-BlicenseFile=COPYING\fR\&.
.RE
.PP
licenseType=\fItype\fR
.RS 4
Short name of the license type, such as
\fB\-BlicenseType=Proprietary\fR, or
\fB"\-BlicenseType=GPL v2 + Classpath Exception"\fR\&.
.RE
.PP
vendor=\fIvalue\fR
.RS 4
Corporation, organization, or individual providing the application\&. This argument is used in the Debian Maintainer field\&.
.RE
.SS "Linux RPM Bundler Arguments"
.PP
category=\fIcategory\fR
.RS 4
Category for the application\&. See http://standards\&.freedesktop\&.org/menu\-spec/latest/apa\&.html for examples\&.
.RE
.PP
licenseFile=\fIpath\fR
.RS 4
Location of the End User License Agreement (EULA) to be presented or recorded by the bundler\&. The path is relative to the packaged application resources, for example,
\fB\-BlicenseFile=COPYING\fR\&.
.RE
.PP
licenseType=\fItype\fR
.RS 4
Short name of the license type, such as
\fB\-BlicenseType=Proprietary\fR, or
\fB"\-BlicenseType=GPL v2 + Classpath Exception"\fR\&.
.RE
.PP
vendor=\fIvalue\fR
.RS 4
Corporation, organization, or individual providing the application\&.
.RE
.SH "DEPRECATED OPTIONS"
.PP
The following options are no longer used by the packaging tool and are ignored if present\&.
.PP
\-runtimeversion \fIversion\fR
.RS 4
Version of the required JavaFX Runtime\&. Deprecated\&.
.RE
.PP
\-noembedlauncher
.RS 4
If present, the packager will not add the JavaFX launcher classes to the JAR file\&. Deprecated\&.
.RE
.SH "NOTES"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
A
\fB\-v \fRoption can be used with any task command to enable verbose output\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
When the
\fB\-srcdir\fR
option is allowed in a command, it can be used more than once\&. If the
\fB\-srcfiles\fR
option is specified, the files named in the argument will be looked for in the location specified in the preceding
\fBsrcdir\fR
option\&. If there is no
\fB\-srcdir\fR
preceding
\fB\-srcfiles\fR, the directory from which the
\fBjavapackager\fR
command is executed is used\&.
.RE
.SH "EXAMPLES"
.PP
\fBExample 1 \fRUsing the \-createjar Command
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
\fBjavapackager \-createjar \-appclass package\&.ClassName\fR
\fB  \-srcdir classes \-outdir out \-outfile outjar \-v\fR
 
.fi
.if n \{\
.RE
.\}
Packages the contents of the
\fBclasses\fR
directory to
\fBoutjar\&.jar\fR, sets the application class to
\fBpackage\&.ClassName\fR\&.
.RE
.PP
\fBExample 2 \fRUsing the \-deploy Command
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
\fBjavapackager \-deploy \-outdir outdir \-outfile outfile \-width 34 \-height 43 \fR
\fB  \-name AppName \-appclass package\&.ClassName \-v \-srcdir compiled\fR
 
.fi
.if n \{\
.RE
.\}
Generates
\fBoutfile\&.jnlp\fR
and the corresponding
\fBoutfile\&.html\fR
files in
\fBoutdir\fR
for application
\fBAppName\fR, which is started by
\fBpackage\&.ClassName\fR
and has dimensions of 34 by 43 pixels\&.
.RE
.PP
\fBExample 3 \fRUsing the \-makeall Command
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
\fBjavapackager \-makeall \-appclass brickbreaker\&.Main \-name BrickBreaker \-width 600\fR
\fB\-height 600\fR
 
.fi
.if n \{\
.RE
.\}
Does all the packaging work including compilation,
\fBcreatejar\fR, and
\fBdeploy\fR\&.
.RE
.PP
\fBExample 4 \fRUsing the \-signjar Command
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
\fBjavapackager \-signJar \-\-outdir dist \-keyStore sampleKeystore\&.jks \-storePass ****\fR
\fB\-alias duke \-keypass **** \-srcdir dist\fR
 
.fi
.if n \{\
.RE
.\}
Signs all of the JAR files in the
\fBdist\fR
directory, attaches a certificate with the specified alias,
\fBkeyStore\fR
and
\fBstorePass\fR, and puts the signed JAR files back into the
\fBdist\fR
directory\&.
.RE
.PP
\fBExample 5 \fRUsing the \-deploy Command with Bundler Arguments
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
\fBjavapackager \-deploy \-native deb \-Bcategory=Education \-BjvmOptions=\-Xmx128m \fR
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
\fB    \-BjvmOptions=\-Xms128m \-outdir packages \-outfile BrickBreaker \-srcdir dist \fR
\fB    \-srcfiles BrickBreaker\&.jar \-appclass brickbreaker\&.Main \-name BrickBreaker \fR
\fB    \-title "BrickBreaker demo"\fR
 
.fi
.if n \{\
.RE
.\}
Generates the native Linux Debian package for running the BrickBreaker application as a self\- contained application\&.
.RE
.br
'pl 8.5i
'bp