update changelog for manpage updates
[sven/java-package.git] / make-jpkg.1
1 .\"                                      Hey, EMACS: -*- nroff -*-
2 .\" First parameter, NAME, should be all caps
3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
4 .\" other parameters are allowed: see man(7), man(1)
5 .TH MAKE-JPKG 1 "September 10, 2016"
6 .\" Please adjust this date whenever revising the manpage.
7 .\"
8 .\" Some roff macros, for reference:
9 .\" .nh        disable hyphenation
10 .\" .hy        enable hyphenation
11 .\" .ad l      left justify
12 .\" .ad b      justify to both left and right margins
13 .\" .nf        disable filling
14 .\" .fi        enable filling
15 .\" .br        insert line break
16 .\" .sp <n>    insert n+1 empty lines
17 .\" for manpage-specific macros, see man(7)
18 .SH NAME
19 make-jpkg \- builds Debian packages from Java binary distributions
20 .SH SYNOPSIS
21 .B make-jpkg
22 [\fIOPTION\fR]... [\fIFILE\fR]
23 .SH DESCRIPTION
24 .\" TeX users may be more comfortable with the \fB<whatever>\fP and
25 .\" \fI<whatever>\fP escape sequences to invode bold face and italics,
26 .\" respectively.
27 .PP
28 \fBmake-jpkg\fP builds a Debian package from the given Java
29 distribution FILE.
30 .PP
31 Supported java binary distributions currently include:
32   * Oracle (http://www.oracle.com/technetwork/java/javase/downloads) :
33     - The Java Development Kit (JDK), version 6, 7 and 8
34     - The Java Runtime Environment (JRE), version 6, 7 and 8
35     - The Java API Javadoc, version 6, 7 and 8
36   (Choose tar.gz archives or self-extracting archives, do _not_ choose the RPM!)
37 .PP
38 The following options are recognized:
39 .TP
40 .B --full-name \fINAME\fR
41 full name used in the maintainer field of the package
42 .TP
43 .B --email \fIEMAIL\fR
44 email address used in the maintainer field of the package
45 .TP
46 .B --distribution \fIDISTRIBUTION\fR
47 distribution to use in the debian changelog for the resulting package
48 .TP
49 .B --changes
50 create a .changes file
51 .TP
52 .B --revision
53 add debian revision
54 .TP
55 .B --source
56 build a source package instead of a binary deb package
57 .TP
58 .B --with-system-certs
59 Replace the JVMs keystore with a softlink to the system's keystore,
60 (/etc/ssl/certs/java/cacerts) which is managed automatically by the
61 ca-certificates and ca-certificates-java packages.
62 .TP
63 .B --jce-policy \fIJCE_POLICY_FILE\fR
64 Replace cryptography files with versions
65 from the specified JCE_POLICY_FILE.
66 .B --help
67 display help text and exit
68 .TP
69 .B --version
70 output version information and exit
71 .PP
72 Download a supported JRE, JDK, API tar.gz or self-extracting archive from
73 .B http://www.oracle.com/technetwork/java/javase/downloads
74 and execute
75 .B make-jpkg
76 .I file
77 with the downloaded file. The program asks the user for additional
78 information and builds a Debian binary package in the current
79 directory.
80 .PP
81 The program requires about 400 MB free disk space in a temporary
82 directory. The temporary directory defaults to
83 .I /tmp
84 but you can specify an alternate directory by setting the environment
85 variable \fITMPDIR\fR.
86 .SH EXAMPLE
87 To install Oracle(TM) 8 Standard Edition JDK, download a release from http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html and invoke make-jpkg, for example:
88 .IP
89 make-jpkg <path_to_download_directory>/jdk-8u102-linux-x64.tar.gz
90 .PP
91 This generate a Debian package in the current directory, that can be installed using dpkg:
92 .IP
93 dpkg \-i oracle-java8-jdk_8u102_amd64.deb
94 .PP
95 When you're done, you can delete initial download as well as generated package:
96 .IP
97 rm <path_to_download_directory>/jdk-8u102-linux-x64.tar.gz oracle-java8-jdk_8u102_amd64.deb
98 .PP
99 .SH ENVIRONMENT
100 .TP
101 .SM TMPDIR
102 base directory used for temporary files (defaults to /tmp)
103 .TP
104 .SM J2SE_PACKAGE_FULL_NAME
105 full name used in the maintainer field of the package; if none is supplied
106 then the default of "Debian Java Maintainers" is used.
107 .TP
108 .SM J2SE_PACKAGE_EMAIL
109 email address used in the maintainer field of the package; if none is supplied
110 the default of "pkg-java-maintainers@lists.alioth.debian.org" is used.
111 .SH SEE ALSO
112 .BR update-java-alternatives(1)
113 .SH AUTHOR
114 This manual page was written by Hubert Schmid <j2se-package@z42.de>.
115
116 It is now maintained by the Debian Java Maintainers <pkg-java-maintainers@lists.alioth.debian.org>.